From 430eb40e8dbd3af34e27c03256ae7c63816df995 Mon Sep 17 00:00:00 2001 From: Arrestier Florian Date: Fri, 8 Mar 2019 10:18:51 +0100 Subject: [PATCH 0001/1291] (MEMORY) adding static allocators and generic dynamic allocator and units-tests. --- libspider/CMakeLists.txt | 221 ++++++++++++++ libspider/extras/ReadMe.md | 42 +++ libspider/libspider/common/LinkedList.h | 281 ++++++++++++++++++ libspider/libspider/common/List.h | 157 ++++++++++ libspider/libspider/common/Rational.h | 274 +++++++++++++++++ libspider/libspider/common/Set.h | 169 +++++++++++ libspider/libspider/common/SpiderException.h | 82 +++++ libspider/libspider/common/logger.cpp | 108 +++++++ libspider/libspider/common/logger.h | 69 +++++ .../common/memory/FreeListStaticAllocator.cpp | 226 ++++++++++++++ .../common/memory/FreeListStaticAllocator.h | 94 ++++++ .../common/memory/GenericAllocator.cpp | 93 ++++++ .../common/memory/GenericAllocator.h | 58 ++++ .../common/memory/LIFOStaticAllocator.cpp | 84 ++++++ .../common/memory/LIFOStaticAllocator.h | 59 ++++ .../common/memory/LinearStaticAllocator.cpp | 81 +++++ .../common/memory/LinearStaticAllocator.h | 61 ++++ .../libspider/common/memory/StackAllocator.h | 83 ++++++ .../common/memory/abstract/DynamicAllocator.h | 64 ++++ .../common/memory/abstract/SpiderAllocator.h | 168 +++++++++++ .../common/memory/abstract/StaticAllocator.h | 73 +++++ libspider/units-tests/install.sh | 7 + .../libSpider2-tests/memory/CMakeLists.txt | 48 +++ .../libSpider2-tests/memory/main.cpp | 44 +++ .../memory/run-memory-test.sh | 32 ++ .../memory/sources/LIFOAllocatorTest.cpp | 112 +++++++ .../memory/sources/LIFOAllocatorTest.h | 64 ++++ .../memory/sources/LinearAllocatorTest.cpp | 106 +++++++ .../memory/sources/LinearAllocatorTest.h | 61 ++++ libspider/units-tests/readme.md | 10 + 30 files changed, 3031 insertions(+) create mode 100644 libspider/CMakeLists.txt create mode 100644 libspider/extras/ReadMe.md create mode 100644 libspider/libspider/common/LinkedList.h create mode 100644 libspider/libspider/common/List.h create mode 100644 libspider/libspider/common/Rational.h create mode 100644 libspider/libspider/common/Set.h create mode 100644 libspider/libspider/common/SpiderException.h create mode 100644 libspider/libspider/common/logger.cpp create mode 100644 libspider/libspider/common/logger.h create mode 100644 libspider/libspider/common/memory/FreeListStaticAllocator.cpp create mode 100644 libspider/libspider/common/memory/FreeListStaticAllocator.h create mode 100644 libspider/libspider/common/memory/GenericAllocator.cpp create mode 100644 libspider/libspider/common/memory/GenericAllocator.h create mode 100644 libspider/libspider/common/memory/LIFOStaticAllocator.cpp create mode 100644 libspider/libspider/common/memory/LIFOStaticAllocator.h create mode 100644 libspider/libspider/common/memory/LinearStaticAllocator.cpp create mode 100644 libspider/libspider/common/memory/LinearStaticAllocator.h create mode 100644 libspider/libspider/common/memory/StackAllocator.h create mode 100644 libspider/libspider/common/memory/abstract/DynamicAllocator.h create mode 100644 libspider/libspider/common/memory/abstract/SpiderAllocator.h create mode 100644 libspider/libspider/common/memory/abstract/StaticAllocator.h create mode 100755 libspider/units-tests/install.sh create mode 100644 libspider/units-tests/libSpider2-tests/memory/CMakeLists.txt create mode 100644 libspider/units-tests/libSpider2-tests/memory/main.cpp create mode 100755 libspider/units-tests/libSpider2-tests/memory/run-memory-test.sh create mode 100644 libspider/units-tests/libSpider2-tests/memory/sources/LIFOAllocatorTest.cpp create mode 100644 libspider/units-tests/libSpider2-tests/memory/sources/LIFOAllocatorTest.h create mode 100644 libspider/units-tests/libSpider2-tests/memory/sources/LinearAllocatorTest.cpp create mode 100644 libspider/units-tests/libSpider2-tests/memory/sources/LinearAllocatorTest.h create mode 100644 libspider/units-tests/readme.md diff --git a/libspider/CMakeLists.txt b/libspider/CMakeLists.txt new file mode 100644 index 00000000..8b93fe8b --- /dev/null +++ b/libspider/CMakeLists.txt @@ -0,0 +1,221 @@ +cmake_minimum_required(VERSION 3.1) +set(CMAKE_CXX_STANDARD 11) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +if(${CROSS_COMPILE_MINGW}) + set(CMAKE_SYSTEM_NAME Windows) + set(TOOLCHAIN_PREFIX x86_64-w64-mingw32) + + # cross compilers to use for C and C++ + set(CMAKE_C_COMPILER ${TOOLCHAIN_PREFIX}-gcc) + set(CMAKE_CXX_COMPILER ${TOOLCHAIN_PREFIX}-g++) + set(CMAKE_Fortran_COMPILER ${TOOLCHAIN_PREFIX}-gfortran) + set(CMAKE_RC_COMPILER ${TOOLCHAIN_PREFIX}-windres) + + # target environment on the build host system + # set 1st to dir with the cross compiler's C/C++ headers/libs + set(CMAKE_FIND_ROOT_PATH /usr/${TOOLCHAIN_PREFIX}) + + # modify default behavior of FIND_XXX() commands to + # search for headers/libs in the target environment and + # search for programs in the build host environment + set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER) + set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY) + set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY) +endif() + + +# Macro to get short file name (vs full path) at compile time +# The additional / is important to remove the last character from the path. +# Note that it does not matter if the OS uses / or \, because we are only +# saving the path size. +string(LENGTH "${CMAKE_SOURCE_DIR}/" SOURCE_PATH_SIZE) +add_definitions("-DSOURCE_PATH_SIZE=${SOURCE_PATH_SIZE}") +add_definitions("-D__FILENAME__=(__FILE__ + ${SOURCE_PATH_SIZE})") + +# ******************************************* +# ************* CMake Content *************** +# ******************************************* +# This CMake create a workspace containing the following projects +# +# Programs +# - spider + +# IDE dependent config +if(${CMAKE_GENERATOR} MATCHES "Visual Studio.*") + MESSAGE("Add definition for ${CMAKE_GENERATOR}") + add_definitions( -D_CRT_SECURE_NO_WARNINGS ) +endif() + +if(${CMAKE_GENERATOR} MATCHES "MinGW Makefiles") + MESSAGE("Add definition for ${CMAKE_GENERATOR}") + #To prevent a redefinition conflict + add_definitions( -D_TIMESPEC_DEFINED ) +endif() + +# Add definition for relative path into project +add_definitions( -DPROJECT_ROOT_PATH="${CMAKE_CURRENT_SOURCE_DIR}") + +project(Spider2) + +# Set to 1 to activate debug compilation (0 for release) + +if(NOT ${CMAKE_GENERATOR} MATCHES "Visual Studio.*") + set(DEBUG 1) + + if(${DEBUG}) + MESSAGE("Generate Debug project") + set(CMAKE_BUILD_TYPE Debug) + set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/Debug) + set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g -pg -Wall -Wextra") + else() + MESSAGE("Generate Release project") + set(CMAKE_BUILD_TYPE Release) + set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/Release) + set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -O3 -Wall -Wextra") + endif() +else() + set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}) +endif() + +if(WIN32) + set(LIBS_DIR ${CMAKE_CURRENT_SOURCE_DIR}/extras/) +endif() +set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_SOURCE_DIR}/extras/cmake_modules/") + +# ******************************************* +# ************ Pthread LIBRARY ************** +# ******************************************* +if (WIN32 AND NOT MINGW) + set(THREADS_USE_PTHREADS_WIN32 true) + # pthread included AFTER Sdl to avoid unnecessary warnings + file(GLOB PTHREADDIR "${LIBS_DIR}/pthread-[\\.|0-9]*") + set(CMAKE_PREFIX_PATH ${CMAKE_PREFIX_PATH} ${PTHREADDIR}) + Find_Package ( Threads REQUIRED ) +else() + Find_Package ( Threads REQUIRED ) +endif() + +if(NOT THREADS_FOUND) + MESSAGE(FATAL_ERROR "Pthread not found !") +endif() + + +if (WIN32) + file(GLOB + PTHREADS_DLL + ${CMAKE_PREFIX_PATH}/lib/*.dll + ) + + MESSAGE("Copy Pthreads DLLs into ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}") + if(NOT ${CMAKE_GENERATOR} MATCHES "Visual Studio.*") + file(COPY ${PTHREADS_DLL} DESTINATION ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}) + else() + file(COPY ${PTHREADS_DLL} DESTINATION ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/Debug) + file(COPY ${PTHREADS_DLL} DESTINATION ${CMAKE_RUNTIME_OUTPUT_DIRECTORY}/Release) + endif() +endif() + +# ******************************************* +# ************ PAPI LIBRARY ***************** +# ******************************************* +set(SKIP_PAPI 1) + +if (${SKIP_PAPI}) + MESSAGE("Skipping Papi") +else() + find_package(PAPI) +endif() + +if (PAPI_FOUND) + add_definitions(-DPAPI_AVAILABLE) + set(papify_sources + libspider/papify/PapifyAction.cpp + libspider/papify/PapifyAction.h + libspider/papify/PapifyEventLib.cpp + libspider/papify/PapifyEventLib.h) +else() + set(PAPI_LIBRARIES "") + set(PAPI_INCLUDE_DIRS "") +endif() + + +# ******************************************* +# ************* spider.dll/a ************** +# ******************************************* +set(SPIDER_LIB_DIR "./libspider") + +include_directories( + ${PAPI_INCLUDE_DIRS} + ${PTHREADDIR}/include + ${SPIDER_LIB_DIR}/ +# ${SPIDER_LIB_DIR}/common +# ${SPIDER_LIB_DIR}/graphs +# ${SPIDER_LIB_DIR}/graphs-tools +# ${SPIDER_LIB_DIR}/monitoring +# ${SPIDER_LIB_DIR}/platform +# ${SPIDER_LIB_DIR}/scheduling +# ${SPIDER_LIB_DIR}/runtime +# ${SPIDER_LIB_DIR}/spider +) + +file( + GLOB_RECURSE + source_files + ${SPIDER_LIB_DIR}/common/*.cpp + ${SPIDER_LIB_DIR}/common/memory/*.cpp +# ${SPIDER_LIB_DIR}/graphs/pisdf/*.cpp +# ${SPIDER_LIB_DIR}/graphs/srdag/*.cpp +# ${SPIDER_LIB_DIR}/graphs-tools/brv/*.cpp +# ${SPIDER_LIB_DIR}/graphs-tools/transformation/*.cpp +# ${SPIDER_LIB_DIR}/memory/*.cpp +## ${SPIDER_LIB_DIR}/monitoring/papify/*.cpp +# ${SPIDER_LIB_DIR}/monitoring/generic/*.cpp +# ${SPIDER_LIB_DIR}/platform/archi/shared-memory/*.cpp +# ${SPIDER_LIB_DIR}/platform/pthread/*.cpp +# ${SPIDER_LIB_DIR}/scheduling/*.cpp +# ${SPIDER_LIB_DIR}/scheduling/allocator/*.cpp +# ${SPIDER_LIB_DIR}/scheduling/scheduler/*.cpp +# ${SPIDER_LIB_DIR}/runtime/*.cpp +# ${SPIDER_LIB_DIR}/spider/*.cpp +) + +file( + GLOB_RECURSE + header_files + ${SPIDER_LIB_DIR}/common/*.h + ${SPIDER_LIB_DIR}/common/memory/*.h + ${SPIDER_LIB_DIR}/common/memory/abstract/*.h +# ${SPIDER_LIB_DIR}/graphs/abstract/*.h +# ${SPIDER_LIB_DIR}/graphs/pisdf/*.h +# ${SPIDER_LIB_DIR}/graphs/srdag/*.h +# ${SPIDER_LIB_DIR}/graphs-tools/brv/*.h +# ${SPIDER_LIB_DIR}/graphs-tools/transformation/*.h +## ${SPIDER_LIB_DIR}/monitoring/papify/*.h +# ${SPIDER_LIB_DIR}/monitoring/generic/*.h +# ${SPIDER_LIB_DIR}/platform/abstract/*.h +# ${SPIDER_LIB_DIR}/platform/archi/abstract/*.h +# ${SPIDER_LIB_DIR}/platform/archi/shared-memory/*.h +# ${SPIDER_LIB_DIR}/platform/pthread/*.h +# ${SPIDER_LIB_DIR}/scheduling/*.h +# ${SPIDER_LIB_DIR}/scheduling/allocator/*.h +# ${SPIDER_LIB_DIR}/scheduling/scheduler/*.h +# ${SPIDER_LIB_DIR}/runtime/*.h +# ${SPIDER_LIB_DIR}/spider/*.h +) + + +add_library(Spider2 SHARED ${source_files} ${header_files}) +target_link_libraries(Spider2 ${CMAKE_THREAD_LIBS_INIT} ${PAPI_LIBRARIES}) +set(CMAKE_CXX_FLAGS "-fpermissive") + +if (NOT MINGW AND NOT ${CMAKE_GENERATOR} MATCHES "Visual Studio.*") + set(CMAKE_CXX_FLAGS "-fPIC") + if (${32BITS}) + set_target_properties(Spider2 PROPERTIES COMPILE_FLAGS "-m32" LINK_FLAGS "-m32") + else() + if(${64BITS}) + set_target_properties(Spider2 PROPERTIES COMPILE_FLAGS "-m64" LINK_FLAGS "-m64") + endif() + endif() +endif() diff --git a/libspider/extras/ReadMe.md b/libspider/extras/ReadMe.md new file mode 100644 index 00000000..06642b73 --- /dev/null +++ b/libspider/extras/ReadMe.md @@ -0,0 +1,42 @@ +# Guideline for Libraries Installation +## Content + +This file contains instructions to setup the libraries in order to compile the +given project files. + +Instructions have been tested for: + +* Windows 7 + * Visual Studio + * Code::Blocks (MinGW) + + +The project compilation requires the following libraries: + +* pthread + +## Regarding pthread library, only 2.8.0 is downloadable pre-compiled, 2.10.0 has to be compiled from source. + However, 2.8.0 doesn't support anything related to thread affinity. Consequently, if using the latter, + /libspider/platforms/platform_pthread/platformPThread.cpp needs to be edited to comment + static void setAffinity(int cpuId) function's body. + Moreover pthread-2.10.0 is compiled using Visual Studio + +## pthread-2.10.0 +1. Download source code from https://sourceforge.net/projects/pthreads4w/files/latest/download +2. Look for x86 Visual Studio command prompt in the Start menu/All Programs/Visual Studio 20XX/Visual Studio Tools +3. Navigate to pthread-2.10.0 uncompressed sources folder +4. Execute "nmake" to list available command and use the one that fits your needs (nmake clean VC) +5. Copy pthreadVC2.lib to /lib_spider/lib/pthread-2.10.0/lib + Copy pthreadVC2.dll to /lib_spider/lib/pthread-2.10.0/dll + Copy _ptw32.h to /lib_spider/lib/pthread-2.10.0/include + Copy pthread.h to /lib_spider/lib/pthread-2.10.0/include + Copy sched.h to /lib_spider/lib/pthread-2.10.0/include + Copy semaphore.h to /lib_spider/lib/pthread-2.10.0/include + + +## pthread-2.8.0 +1. Download the pthread library: + [pthread-w32-2-8-0-release.exe](ftp://sourceware.org/pub/pthreads-win32/pthreads-w32-2-8-0-release.exe) +2. Execute the downloaded executable to decompress its content in a temporary directory. +3. Copy the content of the decompressed /Pre-built.2/ directory into a folder named exactly as follows: + ```/lib_spider/lib/pthread-2.8.0/``` diff --git a/libspider/libspider/common/LinkedList.h b/libspider/libspider/common/LinkedList.h new file mode 100644 index 00000000..a4fc984e --- /dev/null +++ b/libspider/libspider/common/LinkedList.h @@ -0,0 +1,281 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2014 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Julien Heulot (2014 - 2015) + * Yaset Oliva (2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER_LINKEDLIST_H +#define SPIDER_LINKEDLIST_H + +#include +#include + +template +class LinkedList { +public: + typedef struct Node { + T val_; + Node *prev_; + Node *next_; + } Node; + + LinkedList(SpiderStack stackId, std::int32_t sizeMax); + + ~LinkedList(); + + T &operator[](int ix); + + /** + * @brief Return first node of the list. Current is unchanged. + * @return first node of the list + */ + inline Node *first() const; + + /** + * @brief Return last node of the list. Current is unchanged. + * @return last node of the list + */ + inline Node *last() const; + + /** + * @brief Return current node of the list + * @return current node of the list + */ + inline Node *current() const; + + /** + * @brief Set on next node of the list and return it + * @return next element of the list + */ + inline Node *next() const; + + /** + * @brief Set on previous node of the list and return it + * @return previous element of the list + */ + inline Node *previous() const; + + /** + * @brief set current as first + */ + void setOnFirst(); + + /** + * @brief set current as last + */ + void setOnLast(); + + inline std::int32_t size() const; + + void add(T e); + + void addLast(T e); + + T &del(Node *n); + + bool contains(T item); + +private: + SpiderStack stackId_; + Node *head_; + Node *current_; + Node *tail_; + std::int32_t size_; + std::int32_t sizeMax_; +}; + +template +inline LinkedList::LinkedList(SpiderStack stackId, std::int32_t sizeMax) { + stackId_ = stackId; + size_ = 0; + sizeMax_ = sizeMax; + head_ = nullptr; + current_ = nullptr; + tail_ = nullptr; +} + +template +inline LinkedList::~LinkedList() { + if (size_ > 0) { + setOnFirst(); + auto *n = current_; + while (n) { + del(n); + n = current_; + } + } +} + +template +inline T &LinkedList::operator[](int ix) { + if (ix < 0 || ix >= size_) { + throwSpiderException("Accesing unitialized element. Ix = %d -- Size = %d", ix, size_); + } + std::int32_t i = 0; + auto *current = head_; + while (i < ix) { + current = current->next_; + i++; + } + return current->val_; +} + +template +inline typename LinkedList::Node *LinkedList::first() const { + return head_; +} + +template +inline typename LinkedList::Node *LinkedList::last() const { + return tail_; +} + +template +inline typename LinkedList::Node *LinkedList::current() const { + return current_; +} + +template +inline typename LinkedList::Node *LinkedList::next() const { + current_ = current_->next_; + return current_; +} + +template +inline typename LinkedList::Node *LinkedList::previous() const { + current_ = current_->prev_; + return current_; +} + +template +inline void LinkedList::setOnFirst() { + current_ = head_; +} + +template +inline void LinkedList::setOnLast() { + current_ = tail_; +} + +template +inline std::int32_t LinkedList::size() const { + return size_; +} + +template +inline void LinkedList::add(T e) { + if (size_ >= sizeMax_) { + throwSpiderException("Can not add element, list is full."); + } + auto *newNode = CREATE_NA(stackId_, Node); + if (!head_) { + head_ = newNode; + tail_ = newNode; + } + newNode->val_ = e; + newNode->prev_ = tail_; + newNode->next_ = head_; + head_->prev_ = newNode; + tail_->next_ = newNode; + head_ = newNode; + size_++; +} + +template +inline void LinkedList::addLast(T e) { + if (size_ >= sizeMax_) { + throwSpiderException("Can not add element, list is full."); + } + auto *newNode = CREATE_NA(stackId_, Node); + if (!head_) { + head_ = newNode; + tail_ = newNode; + } + newNode->val_ = e; + newNode->prev_ = tail_; + newNode->next_ = head_; + head_->prev_ = newNode; + tail_->next_ = newNode; + tail_ = newNode; + size_++; +} + + +template +inline bool LinkedList::contains(T item) { + auto *current = head_; + while (current) { + if (current->val_ == item) { + return true; + } + current = current->next_; + } + return false; +} + +template +inline T &LinkedList::del(LinkedList::Node *n) { + if (n) { + size_--; + if (size_ < 0) { + throwSpiderException("Trying to remove node not in the list."); + } else if (size_ == 0) { + head_ = nullptr; + tail_ = nullptr; + current_ = nullptr; + } else { + auto *previousNode = n->prev_; + auto *nextNode = n->next_; + previousNode->next_ = nextNode; + nextNode->prev_ = previousNode; + if (n == current_) { + current_ = nextNode; + } + if (n == head_) { + head_ = nextNode; + } else if (n == tail_) { + tail_ = previousNode; + } + } + auto &val = n->val_; + StackMonitor::free(stackId_, n); + return val; + } else { + throwSpiderException("Trying to remove nullptr node."); + } +} + + +#endif/*LIST_H*/ diff --git a/libspider/libspider/common/List.h b/libspider/libspider/common/List.h new file mode 100644 index 00000000..bf2261c6 --- /dev/null +++ b/libspider/libspider/common/List.h @@ -0,0 +1,157 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2014 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Julien Heulot (2014 - 2015) + * Yaset Oliva (2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER_LIST_H +#define SPIDER_LIST_H + +#include + +template +class List { +public: + List(SpiderStack stackId, int size); + + ~List(); + + T &operator[](std::int32_t ix); + + int getNb(); + + void add(T e); + + void sort(int (*comp)(T, T)); + + bool isPresent(T item); + +private: + SpiderStack stackId_; + T *array_; + int nb; + int nbMax; + + void myqsort(int p, int r, int (*comp)(T, T)); + + int myqsort_part(int p, int r, int (*comp)(T, T)); +}; + +template +inline List::List(SpiderStack stackId, int size) { + stackId_ = stackId; + nb = 0; + nbMax = size; + if (size == 0) + array_ = nullptr; + else + array_ = CREATE_MUL(stackId_, size, T); +} + +template +inline List::~List() { + if (array_ != nullptr) + StackMonitor::free(stackId_, array_); +} + + +template +inline T &List::operator[](std::int32_t ix) { + if (ix < 0 || ix >= nb) { + throwSpiderException("Accesing unitialized element. Ix = %d -- Size = %d", ix, nb); + } + return array_[ix]; +} + +template +inline int List::getNb() { + return nb; +} + +template +inline void List::add(T e) { + if (nb >= nbMax) { + throwSpiderException("Can not add element, list is full."); + } + array_[nb] = e; + nb++; +} + +template +inline void List::sort(int (*comp)(T, T)) { + myqsort(0, nb - 1, comp); +} + +template +inline void List::myqsort(int p, int r, int (*comp)(T, T)) { + int q; + if (p < r) { + q = myqsort_part(p, r, comp); + myqsort(p, q, comp); + myqsort(q + 1, r, comp); + } +} + +template +inline int List::myqsort_part(int p, int r, int (*comp)(T, T)) { + T pivot = array_[p]; + int i = p - 1, j = r + 1; + T temp; + while (true) { + do + j--; + while (comp(array_[j], pivot) > 0); + do + i++; + while (comp(array_[i], pivot) < 0); + if (i < j) { + temp = array_[i]; + array_[i] = array_[j]; + array_[j] = temp; + } else + return j; + } +} + +template +inline bool List::isPresent(T item) { + for (int i = 0; i < nb; i++) { + if (item == array_[i]) + return true; + } + return false; +} + +#endif/*LIST_H*/ diff --git a/libspider/libspider/common/Rational.h b/libspider/libspider/common/Rational.h new file mode 100644 index 00000000..184b95d4 --- /dev/null +++ b/libspider/libspider/common/Rational.h @@ -0,0 +1,274 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2014 - 2018) : + * + * Antoine Morvan (2018) + * Florian Arrestier (2018) + * Julien Heulot (2014 - 2015) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef RATIONAL_H_ +#define RATIONAL_H_ + +#include + +class Rational { +private: + std::int64_t n_; + std::int64_t d_; + + inline void reduce(); + +public: + inline explicit Rational(std::int64_t n = 0, std::int64_t d = 1); + + inline Rational(const Rational &r); + + inline Rational &operator+=(const Rational &b); + + inline Rational &operator-=(const Rational &b); + + inline Rational &operator*=(const Rational &b); + + inline Rational &operator/=(const Rational &b); + + inline Rational operator+(const Rational &b) const; + + inline Rational operator-(const Rational &b) const; + + inline Rational operator*(const Rational &b) const; + + inline Rational operator/(const Rational &b) const; + + inline Rational operator+(const std::int64_t &b) const; + + inline Rational operator-(const std::int64_t &b) const; + + inline Rational operator*(const std::int64_t &b) const; + + inline Rational operator/(const std::int64_t &b) const; + + inline bool operator==(const Rational &b) const; + + inline bool operator==(const std::int64_t &a) const; + + inline bool operator!=(const Rational &b) const; + + inline bool operator!=(const std::int64_t &a) const; + + inline bool operator>(const Rational &b) const; + + inline bool operator<(const Rational &b) const; + + inline bool operator>=(const Rational &b) const; + + inline bool operator<=(const Rational &b) const; + + inline Rational abs() const; + + inline std::int64_t toInt64() const; + + inline std::int32_t toInt32() const; + + inline double toDouble() const; + + inline std::int64_t getDenominator() const; + + inline std::int64_t getNominator() const; + + static inline std::int64_t gcd(std::int64_t a, std::int64_t b); + + static inline std::int64_t abs(std::int64_t x); + + static inline std::int64_t compute_lcm(std::int64_t a, std::int64_t b); +}; + +Rational::Rational(int64_t n, int64_t d) : n_{n}, d_{d} { + if (d_ == 0) { + throwSpiderException("Fraction with zero denominator not allowed."); + } + reduce(); +} + +Rational::Rational(const Rational &r) : Rational{r.n_, r.d_} { + +} + +Rational &Rational::operator+=(const Rational &b) { + n_ = (n_ * b.d_) + (b.n_ * d_); + d_ *= b.d_; + reduce(); + return *this; +} + +Rational &Rational::operator-=(const Rational &b) { + n_ = (n_ * b.d_) - (b.n_ * d_); + d_ *= b.d_; + reduce(); + return *this; +} + +Rational &Rational::operator*=(const Rational &b) { + n_ *= b.n_; + d_ *= b.d_; + reduce(); + return *this; +} + +Rational &Rational::operator/=(const Rational &b) { + if (b.n_ == 0) { + throwSpiderException("Fraction with zero denominator not allowed."); + } + n_ *= b.d_; + d_ *= b.n_; + reduce(); + return *this; +} + +Rational Rational::operator+(const Rational &b) const { + return Rational{*this} += b; +} + +Rational Rational::operator-(const Rational &b) const { + return Rational{*this} -= b; +} + +Rational Rational::operator*(const Rational &b) const { + return Rational{*this} *= b; +} + +Rational Rational::operator/(const Rational &b) const { + return Rational{*this} /= b; +} + +Rational Rational::operator+(const std::int64_t &b) const { + return *this + Rational{b}; +} + +Rational Rational::operator-(const std::int64_t &b) const { + return *this - Rational{b}; +} + +Rational Rational::operator*(const std::int64_t &b) const { + return *this * Rational{b}; +} + +Rational Rational::operator/(const std::int64_t &b) const { + return *this / Rational{b}; +} + +bool Rational::operator==(const Rational &b) const { + return n_ == b.n_ && d_ == b.d_; +} + +bool Rational::operator==(const std::int64_t &a) const { + return (n_ / d_) == a; +} + +bool Rational::operator!=(const Rational &b) const { + return !(*this == b); +} + +bool Rational::operator!=(const std::int64_t &a) const { + return !(*this == a); +} + +bool Rational::operator>(const Rational &b) const { + auto diff = *this - b; + return diff.n_ > 0; +} + +bool Rational::operator<(const Rational &b) const { + auto diff = *this - b; + return diff.n_ < 0; +} + +bool Rational::operator>=(const Rational &b) const { + return !(*this < b); +} + +bool Rational::operator<=(const Rational &b) const { + return !(*this > b); +} + +std::int64_t Rational::toInt64() const { + return static_cast(n_ / d_); +} + +std::int32_t Rational::toInt32() const { + return static_cast(n_ / d_); +} + +double Rational::toDouble() const { + return static_cast(n_) / static_cast(d_); +} + +Rational Rational::abs() const { + return Rational{abs((*this).n_), abs((*this).d_)}; +} + +std::int64_t Rational::abs(std::int64_t x) { + return x < 0 ? -x : x; +} + +std::int64_t Rational::getDenominator() const { + return d_; +} + +std::int64_t Rational::getNominator() const { + return n_; +} + +void Rational::reduce() { + auto gcd = Rational::gcd(n_, d_); + n_ /= gcd; + d_ /= gcd; + if (d_ < 0) { + n_ = -n_; + d_ = -d_; + } +} + +std::int64_t Rational::gcd(std::int64_t a, std::int64_t b) { + std::int64_t t; + while (b != 0) { + t = b; + b = a % b; + a = t; + } + return a; +} + +std::int64_t Rational::compute_lcm(std::int64_t a, std::int64_t b) { + return abs(a * b) / gcd(a, b); +} + + +#endif /* RATIONAL_H_ */ diff --git a/libspider/libspider/common/Set.h b/libspider/libspider/common/Set.h new file mode 100644 index 00000000..a7e986d0 --- /dev/null +++ b/libspider/libspider/common/Set.h @@ -0,0 +1,169 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Julien Heulot (2013 - 2018) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER_SET_H +#define SPIDER_SET_H + +#include + +template +class Set { +public: + class SetElement { + public: + SetElement() : setIx_{-1} {}; + + ~SetElement() = default; + + inline void setSetIx(std::int32_t ix) { + setIx_ = ix; + } + + inline std::int32_t getSetIx() const { + return setIx_; + } + + private: + std::int32_t setIx_; + }; + + Set(std::int32_t sizeMax, int stackId) : size_{0}, sizeMax_{sizeMax}, stackId_{stackId} { + if (sizeMax_ > 0) { + //elements_ = CREATE_MUL(stackId, sizeMax_, TYPE); + elements_ = new TYPE[sizeMax_]; + } else { + elements_ = nullptr; + } + } + + ~Set() { + if (sizeMax_ != 0) { + //StackMonitor::free(stackId_, elements_); + delete[] elements_; + } + } + + inline void add(TYPE value); + + inline void del(TYPE value); + + inline bool contains(TYPE value); + + inline std::int32_t size() const; + + inline TYPE const *getElements() const; + + inline TYPE operator[](int ix); + + inline TYPE operator[](int ix) const; + + inline TYPE *begin(); + + inline TYPE *end(); + +private: + SetElement *elements_; + std::int32_t size_; + std::int32_t sizeMax_; + int stackId_; +}; + +template +inline void Set::add(TYPE value) { + if (size_ >= sizeMax_) { + throwSpiderException("Can not add element to set. Requested: %d -- Max: %d", size_ + 1, sizeMax_); + } + ((SetElement *) value)->setSetIx(size_); + elements_[size_++] = value; +} + +template +inline void Set::del(TYPE value) { + auto ix = ((SetElement *) value)->getSetIx(); + elements_[ix] = elements_[--size_]; + ((SetElement *) elements_[ix])->setSetIx(ix); +} + +template +inline bool Set::contains(TYPE value) { + bool found = false; + for (auto it = begin(); it != end() && !found; ++it) { + found |= (*it == value); + } + return found; +} + +template +inline std::int32_t Set::size() const { + return size_; +} + +template +inline TYPE const *Set::getElements() const { + return elements_; +} + +template +inline TYPE Set::operator[](int ix) { + if (size_ < 0 || ix >= size_) { + throwSpiderException("operator[] got bad index: %d -- Set size: %d", ix, size_); + } else { + return elements_[ix]; + } +} + +template +inline TYPE Set::operator[](int ix) const { + if (size_ < 0 || ix >= size_) { + throwSpiderException("operator[] got bad index: %d -- Set size: %d", ix, size_); + } else { + return elements_[ix]; + } +} + +template +inline TYPE *Set::begin() { + return &elements_[0]; +} + +template +inline TYPE *Set::end() { + return &elements_[size_ - 1]; +} + +#endif // SPIDER_SET_H diff --git a/libspider/libspider/common/SpiderException.h b/libspider/libspider/common/SpiderException.h new file mode 100644 index 00000000..4543eac4 --- /dev/null +++ b/libspider/libspider/common/SpiderException.h @@ -0,0 +1,82 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2018) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER_SPIDEREXCEPTION_H +#define SPIDER_SPIDEREXCEPTION_H + +#include +#include +#include + + + +// Size of 50 minimum is required for the error message associated +#define SPIDER_EXCEPTION_BUFFER_SIZE 300 + +#define throwHelper(msg, ...)\ + throw SpiderException("%s::%s:%d " msg, __FILENAME__, __func__, __LINE__, __VA_ARGS__) +#define throwSpiderException(...) throwHelper(__VA_ARGS__, '\0') + +class SpiderException : public std::exception { +public: + explicit SpiderException(const char *msg, ...) : exceptionMessage_{} { + va_list args; + va_start(args, msg); +#ifdef _WIN32 + int n = _vsnprintf(buffer, SPIDER_EXCEPTION_BUFFER_SIZE, msg, args); +#else + int n = vsnprintf(exceptionMessage_, SPIDER_EXCEPTION_BUFFER_SIZE, msg, args); +#endif + if (n > SPIDER_EXCEPTION_BUFFER_SIZE) { + fprintf(stderr, "SpiderException: ERROR: exception message too big.\n"); + fprintf(stderr, "Partially recovered exception: "); + fflush(stderr); + } + } + + const char *what() const noexcept override { + return exceptionMessage_; + } + +private: + char exceptionMessage_[SPIDER_EXCEPTION_BUFFER_SIZE]; +}; + + +#endif //SPIDER_SPIDEREXCEPTION_H diff --git a/libspider/libspider/common/logger.cpp b/libspider/libspider/common/logger.cpp new file mode 100644 index 00000000..bae843e4 --- /dev/null +++ b/libspider/libspider/common/logger.cpp @@ -0,0 +1,108 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2014 - 2018) : + * + * Antoine Morvan (2018) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2014 - 2018) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#include +#include +#include "logger.h" + +#define LOG_RED "\x1B[31m" +#define LOG_GRN "\x1B[32m" +#define LOG_YEL "\x1B[33m" +//#define BLU "\x1B[34m" +//#define MAG "\x1B[35m" +//#define CYN "\x1B[36m" +#define LOG_WHT "\x1B[37m" +#define LOG_NRM "\x1B[0m" + +static bool loggersState_[N_LOGGER]; + +static FILE *outStream_ = stderr; + +static const char *loggersLitteral[N_LOGGER] = { + "JOB", + "TIME", + "GENERAL", +}; + +static std::mutex lock; + +void Logger::init() { + loggersState_[LOG_JOB] = false; + loggersState_[LOG_TIME] = false; + loggersState_[LOG_GENERAL] = true; +} + +void Logger::enable(LoggerType type) { + std::lock_guard locker(lock); + loggersState_[type] = true; +} + +void Logger::disable(LoggerType type) { + std::lock_guard locker(lock); + loggersState_[type] = false; +} + +void Logger::setOutputStream(FILE *stream) { + std::lock_guard locker(lock); + outStream_ = stream; +} + +void Logger::print(LoggerType type, LoggerLevel level, const char *fmt, ...) { + if (loggersState_[type]) { + std::lock_guard locker(lock); + va_list l; + va_start(l, fmt); + fprintf(outStream_, "%s-", loggersLitteral[type]); + switch (level) { + case LOG_INFO: + fprintf(outStream_, LOG_WHT "INFO: "); + break; + case LOG_WARNING: + fprintf(outStream_, LOG_YEL "WARNING: "); + break; + case LOG_ERROR: + fprintf(outStream_, LOG_RED "ERROR: "); + break; + default: + fprintf(outStream_, LOG_GRN "UNDEFINED: "); + break; + } + vfprintf(outStream_, fmt, l); + fprintf(outStream_, LOG_NRM); + va_end(l); + } +} \ No newline at end of file diff --git a/libspider/libspider/common/logger.h b/libspider/libspider/common/logger.h new file mode 100644 index 00000000..13d61e0a --- /dev/null +++ b/libspider/libspider/common/logger.h @@ -0,0 +1,69 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2014 - 2018) : + * + * Antoine Morvan (2018) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2014 - 2018) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER_LOGGER_H +#define SPIDER_LOGGER_H + +#include + +#define N_LOGGER 3 + +typedef enum { + LOG_JOB = 0, + LOG_TIME = 1, + LOG_GENERAL = 2, +} LoggerType; + +typedef enum { + LOG_INFO, + LOG_WARNING, + LOG_ERROR +} LoggerLevel; + +namespace Logger { + void init(); + + void enable(LoggerType type); + + void disable(LoggerType type); + + void setOutputStream(FILE *stream); + + void print(LoggerType type, LoggerLevel level, const char *fmt, ...); +} + +#endif //SPIDER_LOGGER_H diff --git a/libspider/libspider/common/memory/FreeListStaticAllocator.cpp b/libspider/libspider/common/memory/FreeListStaticAllocator.cpp new file mode 100644 index 00000000..24273cda --- /dev/null +++ b/libspider/libspider/common/memory/FreeListStaticAllocator.cpp @@ -0,0 +1,226 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#include "common/SpiderException.h" +#include "FreeListStaticAllocator.h" + +FreeListStaticAllocator::FreeListStaticAllocator(const char *name, + std::uint64_t totalSize, + FreeListPolicy policy, + std::int32_t alignment) : + StaticAllocator(name, totalSize, alignment) { + if (alignment < 8) { + throwSpiderException("Memory alignment should be at least of size sizeof(std::int64_t) = 8 bytes."); + } + this->reset(); + if (policy == FIND_FIRST) { + method_ = FreeListStaticAllocator::findFirst; + } else { + method_ = FreeListStaticAllocator::findBest; + } +} + +void *FreeListStaticAllocator::alloc(std::uint64_t size) { + if (!size) { + return nullptr; + } + if ((std::size_t) size < sizeof(Node)) { + throwSpiderException("Can not allocate memory blocks inferior to Node size. Allocator: %s -- Requested: %d", + getName(), size); + } + std::int32_t padding = 0; + Node *baseNode = list_; + Node *memoryNode = nullptr; + /*!< Find first / best node fitting memory requirement */ + method_(size, padding, alignment_, baseNode, memoryNode); + std::int32_t paddingWithoutHeader = padding - sizeof(FreeListStaticAllocator::Header); + std::uint64_t requiredSize = size + padding; + std::uint64_t leftOverMemory = memoryNode->blockSize_ - requiredSize; + if (leftOverMemory) { + /*!< We split block to limit waste memory space */ + Node *freeNode = (Node *) (((char *) memoryNode) + requiredSize); + freeNode->blockSize_ = leftOverMemory; + insert(memoryNode, freeNode); + } + remove(baseNode, memoryNode); + baseNode->blockSize_ += paddingWithoutHeader; + /*! Computing header and data address */ + char *headerAddress = (char *) (memoryNode) + paddingWithoutHeader; + char *dataAddress = (char *) (memoryNode) + padding; + + /*!< Write header info */ + auto *header = (Header *) (headerAddress); + header->size_ = requiredSize; + header->padding_ = static_cast(paddingWithoutHeader); + + /*!< Updating usage stats */ + used_ += requiredSize; + peak_ = std::max(peak_, used_); + return dataAddress; +} + +void FreeListStaticAllocator::free(void *ptr) { + if (!ptr) { + return; + } + char *currentAddress = static_cast(ptr); + char *headerAddress = currentAddress - sizeof(FreeListStaticAllocator::Header); + + /*!< Read header info */ + auto *header = (Header *) (headerAddress); + Node *freeNode = (Node *) (headerAddress - header->padding_); + freeNode->blockSize_ = header->size_; + freeNode->next_ = nullptr; + + Node *it = list_; + Node *itPrev = nullptr; + while (it) { + if (ptr < it) { + insert(itPrev, freeNode); + break; + } + itPrev = it; + it = it->next_; + } + + /*!< Update internal usage */ + used_ -= freeNode->blockSize_; + + /*!< Look for contiguous block to merge (coalescence) */ + if (freeNode->next_ && ((char *) freeNode + freeNode->blockSize_) == ((char *) freeNode->next_)) { + freeNode->blockSize_ += freeNode->next_->blockSize_; + remove(freeNode, freeNode->next_); + } + if (itPrev && ((char *) itPrev + itPrev->blockSize_) == ((char *) freeNode)) { + itPrev->blockSize_ += freeNode->blockSize_; + remove(itPrev, freeNode); + } + +} + +void FreeListStaticAllocator::reset() { + averageUse_ += used_; + numberAverage_++; + used_ = 0; + list_ = (Node *) (startPtr_); + list_->blockSize_ = totalSize_; + list_->next_ = nullptr; +} + +void FreeListStaticAllocator::insert(Node *baseNode, Node *newNode) { + if (!baseNode) { + /*!< Insert node as first */ + newNode->next_ = list_ ? list_ : nullptr; + list_ = newNode; + } else { + /*!< Insert node as last if baseNode->next == nullptr */ + /*!< Insert node in middle else */ + newNode->next_ = baseNode->next_; + baseNode->next_ = newNode; + } +} + +void FreeListStaticAllocator::remove(Node *baseNode, Node *removedNode) { + if (!baseNode) { + /*!< Remove the first node */ + list_ = removedNode->next_; + } else { + /*!< Remove node in the list */ + baseNode->next_ = removedNode->next_; + } +} + +void +FreeListStaticAllocator::findFirst(std::uint64_t &size, std::int32_t &padding, std::int32_t &alignment, + Node *&baseNode, + Node *&foundNode) { + std::int32_t headerSize = sizeof(FreeListStaticAllocator::Header); + Node *it = baseNode; + baseNode = nullptr; + while (it) { + auto currentSize = (std::uint64_t) it; + padding = SpiderAllocator::computePadding(currentSize, alignment); + if (padding < headerSize) { + /*!< Find next aligned address to fit header */ + headerSize -= padding; + padding += alignment * (headerSize / alignment + (headerSize % alignment != 0)); + } + std::uint64_t requiredSize = size + padding; + if (it->blockSize_ > requiredSize) { + foundNode = it; + return; + } + baseNode = it; + it = it->next_; + } + throwSpiderException("Not enough memory available for requested size of %" + PRIu64 + "", size); +} + +void +FreeListStaticAllocator::findBest(std::uint64_t &size, std::int32_t &padding, std::int32_t &alignment, + Node *&baseNode, + Node *&foundNode) { + std::int32_t headerSize = sizeof(FreeListStaticAllocator::Header); + Node *it = baseNode; + baseNode = nullptr; + std::uint64_t minFit = UINT64_MAX; + while (it) { + auto currentSize = (std::uint64_t) it; + padding = SpiderAllocator::computePadding(currentSize, alignment); + if (padding < headerSize) { + /*!< Find next aligned address to fit header */ + headerSize -= padding; + padding += alignment * (headerSize / alignment + (headerSize % alignment != 0)); + } + std::uint64_t requiredSize = size + padding; + if (it->blockSize_ > requiredSize && (it->blockSize_ - requiredSize < minFit)) { + foundNode = it; + minFit = it->blockSize_ - requiredSize; + } + baseNode = it; + it = it->next_; + } + if (!foundNode) { + throwSpiderException("Not enough memory available for requested size of %" + PRIu64 + "", size); + } +} diff --git a/libspider/libspider/common/memory/FreeListStaticAllocator.h b/libspider/libspider/common/memory/FreeListStaticAllocator.h new file mode 100644 index 00000000..f5f45b17 --- /dev/null +++ b/libspider/libspider/common/memory/FreeListStaticAllocator.h @@ -0,0 +1,94 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER2_FREELISTSTATICALLOCATOR_H +#define SPIDER2_FREELISTSTATICALLOCATOR_H + +#include "abstract/StaticAllocator.h" + +typedef enum FreeListPolicy { + FIND_FIRST = 0, + FIND_BEST = 1 +} FreeListPolicy; + + +class FreeListStaticAllocator : public StaticAllocator { +public: + explicit FreeListStaticAllocator(const char *name, + std::uint64_t totalSize, + FreeListPolicy policy = FIND_FIRST, + std::int32_t alignment = sizeof(std::int64_t)); + + ~FreeListStaticAllocator() = default; + + void *alloc(std::uint64_t size) override; + + void free(void *ptr) override; + + void reset() override; + + typedef struct Node { + std::uint64_t blockSize_; + Node *next_; + } Node; + +private: + typedef struct Header { + std::uint64_t size_; + std::uint64_t padding_; + } Header; + + Node *list_; + + void insert(Node *baseNode, Node *newNode); + + void remove(Node *baseNode, Node *removedNode); + + using policyMethod = void (*)(std::uint64_t &, std::int32_t &, std::int32_t &, Node *&, Node *&); + + policyMethod method_; + + static void + findFirst(std::uint64_t &size, std::int32_t &padding, std::int32_t &alignment, Node *&baseNode, Node *&foundNode); + + static void + findBest(std::uint64_t &size, std::int32_t &padding, std::int32_t &alignment, Node *&baseNode, Node *&foundNode); +}; + +#endif //SPIDER2_FREELISTSTATICALLOCATOR_H diff --git a/libspider/libspider/common/memory/GenericAllocator.cpp b/libspider/libspider/common/memory/GenericAllocator.cpp new file mode 100644 index 00000000..488b4116 --- /dev/null +++ b/libspider/libspider/common/memory/GenericAllocator.cpp @@ -0,0 +1,93 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#include +#include +#include "GenericAllocator.h" + +GenericAllocator::GenericAllocator(const char *name, int32_t alignment) : DynamicAllocator(name, alignment) { + +} + +GenericAllocator::~GenericAllocator() { + if (used_ > 0) { + Logger::print(LOG_GENERAL, LOG_WARNING, "Allocator: %s -- Still has %" PRId64" %s in use.\n", + getName(), + SpiderAllocator::getByteNormalizedSize(used_), + SpiderAllocator::getByteUnitString(used_)); + } +} + +void *GenericAllocator::alloc(std::uint64_t size) { + if (!size) { + return nullptr; + } + std::uint64_t requiredSize = size + sizeof(std::uint64_t); + auto alignedSize = SpiderAllocator::computeAlignedSize(requiredSize, alignment_); + + auto *headerAddress = (char *) std::malloc(alignedSize); + if (!headerAddress) { + throwSpiderException("Failed to allocate %lf %s", + SpiderAllocator::getByteNormalizedSize(alignedSize), + SpiderAllocator::getByteUnitString(alignedSize)); + } + auto *header = (std::uint64_t *) (headerAddress); + (*header) = alignedSize; + used_ += alignedSize; + peak_ = std::max(peak_, used_); + return headerAddress + sizeof(std::uint64_t); +} + +void GenericAllocator::free(void *ptr) { + if (!ptr) { + return; + } + auto *headerAddress = ((char *) ptr) - sizeof(std::uint64_t); + auto *header = (std::uint64_t *) (headerAddress); + used_ -= (*header); + std::free(headerAddress); +} + +void GenericAllocator::reset() { + averageUse_ += used_; + numberAverage_++; + used_ = 0; +} + + diff --git a/libspider/libspider/common/memory/GenericAllocator.h b/libspider/libspider/common/memory/GenericAllocator.h new file mode 100644 index 00000000..8339e6da --- /dev/null +++ b/libspider/libspider/common/memory/GenericAllocator.h @@ -0,0 +1,58 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER2_GENERICALLOCATOR_H +#define SPIDER2_GENERICALLOCATOR_H + +#include "abstract/DynamicAllocator.h" + +class GenericAllocator : public DynamicAllocator { +public: + explicit GenericAllocator(const char *name, std::int32_t alignment = sizeof(std::uint64_t)); + + ~GenericAllocator(); + + void *alloc(std::uint64_t size) override; + + void free(void *ptr) override; + + void reset() override; +}; + +#endif //SPIDER2_GENERICALLOCATOR_H diff --git a/libspider/libspider/common/memory/LIFOStaticAllocator.cpp b/libspider/libspider/common/memory/LIFOStaticAllocator.cpp new file mode 100644 index 00000000..6c6e045c --- /dev/null +++ b/libspider/libspider/common/memory/LIFOStaticAllocator.cpp @@ -0,0 +1,84 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#include "common/SpiderException.h" +#include "LIFOStaticAllocator.h" + +LIFOStaticAllocator::LIFOStaticAllocator(const char *name, std::uint64_t totalSize) : + StaticAllocator(name, totalSize, sizeof(std::uint64_t)) { + +} + +void *LIFOStaticAllocator::alloc(std::uint64_t size) { + if (!size) { + return nullptr; + } + used_ += size; + /*!< We assume alignment on 64 bits */ + std::uint64_t alignedSize = SpiderAllocator::computeAlignedSize(used_, alignment_); + if (alignedSize > totalSize_) { + throwSpiderException("Memory request exceed memory available. Stack: %s -- Size: %" + PRIu64 + " -- Requested: %" + PRIu64 + "", getName(), totalSize_, alignedSize); + } + char *alignedAllocatedAddress = startPtr_ + used_ - size; + used_ = alignedSize; + peak_ = std::max(peak_, used_); + return alignedAllocatedAddress; +} + +void LIFOStaticAllocator::free(void *ptr) { + if (!ptr) { + return; + } + char *currentAddress = static_cast(ptr); + if (currentAddress > (used_ + startPtr_)) { + throwSpiderException("Allocator: %s -- LIFO allocator should free element in reverse order of allocation.", + getName()); + } + used_ = currentAddress - startPtr_; +} + +void LIFOStaticAllocator::reset() { + averageUse_ += used_; + numberAverage_++; + used_ = 0; +} diff --git a/libspider/libspider/common/memory/LIFOStaticAllocator.h b/libspider/libspider/common/memory/LIFOStaticAllocator.h new file mode 100644 index 00000000..76957ae8 --- /dev/null +++ b/libspider/libspider/common/memory/LIFOStaticAllocator.h @@ -0,0 +1,59 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER2_LIFOSTATICALLOCATOR_H +#define SPIDER2_LIFOSTATICALLOCATOR_H + +#include "abstract/StaticAllocator.h" + +class LIFOStaticAllocator : public StaticAllocator { +public: + + explicit LIFOStaticAllocator(const char *name, std::uint64_t totalSize); + + ~LIFOStaticAllocator() = default; + + void *alloc(std::uint64_t size) override; + + void free(void *ptr) override; + + void reset() override; +}; + +#endif //SPIDER2_LIFOSTATICALLOCATOR_H diff --git a/libspider/libspider/common/memory/LinearStaticAllocator.cpp b/libspider/libspider/common/memory/LinearStaticAllocator.cpp new file mode 100644 index 00000000..60219a1e --- /dev/null +++ b/libspider/libspider/common/memory/LinearStaticAllocator.cpp @@ -0,0 +1,81 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#include "common/SpiderException.h" +#include "LinearStaticAllocator.h" + +LinearStaticAllocator::LinearStaticAllocator(const char *name, std::uint64_t totalSize, std::int32_t alignment) : + StaticAllocator(name, totalSize, alignment) { + if (alignment < 8) { + throwSpiderException("Memory alignment should be at least of size sizeof(std::int64_t) = 8 bytes."); + } +} + +void *LinearStaticAllocator::alloc(std::uint64_t size) { + if (!size) { + return nullptr; + } + std::int32_t padding = 0; + if (alignment_ && used_ % alignment_ != 0) { + /*!< Compute next aligned address padding */ + padding = SpiderAllocator::computePadding(used_, alignment_); + } + + std::uint64_t requestedSize = used_ + padding + size; + if (requestedSize > totalSize_) { + throwSpiderException("Memory request exceed memory available. Stack: %s -- Size: %" + PRIu64 + " -- Requested: %" + PRIu64, getName(), totalSize_, requestedSize); + } + char *alignedAllocatedAddress = startPtr_ + used_ + padding; + used_ += (size + padding); + peak_ = std::max(peak_, used_); + return alignedAllocatedAddress; +} + +void LinearStaticAllocator::free(void *) { + /*!< LinearStaticAllocator does not free memory per block */ +} + +void LinearStaticAllocator::reset() { + averageUse_ += used_; + numberAverage_++; + used_ = 0; +} diff --git a/libspider/libspider/common/memory/LinearStaticAllocator.h b/libspider/libspider/common/memory/LinearStaticAllocator.h new file mode 100644 index 00000000..0cc9f07f --- /dev/null +++ b/libspider/libspider/common/memory/LinearStaticAllocator.h @@ -0,0 +1,61 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER2_LINEARSTATICALLOCATOR_H +#define SPIDER2_LINEARSTATICALLOCATOR_H + +#include "abstract/StaticAllocator.h" + +class LinearStaticAllocator : public StaticAllocator { +public: + + explicit LinearStaticAllocator(const char *name, std::uint64_t totalSize, + std::int32_t alignment = sizeof(std::int64_t)); + + ~LinearStaticAllocator() = default; + + void *alloc(std::uint64_t size) override; + + void free(void *ptr) override; + + void reset() override; + +}; + +#endif //SPIDER2_LINEARSTATICALLOCATOR_H diff --git a/libspider/libspider/common/memory/StackAllocator.h b/libspider/libspider/common/memory/StackAllocator.h new file mode 100644 index 00000000..c2efd1c5 --- /dev/null +++ b/libspider/libspider/common/memory/StackAllocator.h @@ -0,0 +1,83 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER_STACKALLOCATOR_H +#define SPIDER_STACKALLOCATOR_H + +#include + +typedef enum { + PISDF_STACK, + SRDAG_STACK, + ARCHI_STACK, + TRANSFO_STACK, + LRT_STACK, + STACK_COUNT +} SpiderStack; + + +#define CREATE(stackId, type) new(StackMonitor::alloc(stackId, sizeof(type), true)) type +#define CREATE_MUL(stackId, size, type) new(StackMonitor::alloc(stackId, (size)*sizeof(type), true)) type[size] + +#define CREATE_NA(stackId, type) new(StackMonitor::alloc(stackId, sizeof(type), false)) type +#define CREATE_MUL_NA(stackId, size, type) new(StackMonitor::alloc(stackId, (size)*sizeof(type), false)) type[size] + +namespace StackAllocator { + void initStack(SpiderStack id, SpiderStackConfig cfg); + + void clean(SpiderStack id); + + void cleanAllStack(); + + template + T *alloc(SpiderStack id, int size, bool pageAligned = true) { + return nullptr; + } + + void free(SpiderStack id, void *ptr); + + void freeAll(SpiderStack id, const char *function); + + void freeAll(SpiderStack id); + + void printStackStats(); +}; + +#endif /* SPIDER_STACKALLOCATOR_H */ + diff --git a/libspider/libspider/common/memory/abstract/DynamicAllocator.h b/libspider/libspider/common/memory/abstract/DynamicAllocator.h new file mode 100644 index 00000000..5b6b0be8 --- /dev/null +++ b/libspider/libspider/common/memory/abstract/DynamicAllocator.h @@ -0,0 +1,64 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER2_DYNAMICALLOCATOR_H +#define SPIDER2_DYNAMICALLOCATOR_H + +#include "SpiderAllocator.h" + +class DynamicAllocator : public SpiderAllocator { +public: + void *alloc(std::uint64_t size) override = 0; + + void free(void *ptr) override = 0; + + virtual void reset() = 0; + +protected: + + inline explicit DynamicAllocator(const char *name, std::int32_t alignment = 0); + + inline ~DynamicAllocator() = default; +}; + +DynamicAllocator::DynamicAllocator(const char *name, int32_t alignment) : SpiderAllocator(name, alignment) { + +} + +#endif //SPIDER2_DYNAMICALLOCATOR_H diff --git a/libspider/libspider/common/memory/abstract/SpiderAllocator.h b/libspider/libspider/common/memory/abstract/SpiderAllocator.h new file mode 100644 index 00000000..26f8db2d --- /dev/null +++ b/libspider/libspider/common/memory/abstract/SpiderAllocator.h @@ -0,0 +1,168 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER2_SPIDERALLOCATOR_H +#define SPIDER2_SPIDERALLOCATOR_H + +#include +#include +#include +#include "common/logger.h" + +class SpiderAllocator { +public: + explicit inline SpiderAllocator(const char *name, std::int32_t alignment); + + ~SpiderAllocator() = default; + + virtual void *alloc(std::uint64_t size) = 0; + + virtual void free(void *ptr) = 0; + + /** Setters **/ + /** + * @brief Set memory allocation alignment. + * All new allocation made after this call result in allocation aligned to new value. + * @param alignment New allocation value. + */ + inline void setAllocationAlignment(std::int32_t alignment); + + /** Getters **/ + /** + * @brief Fetch current memory allocation alignment + * @return current allocation alignment + */ + inline std::int32_t getAllocationAlignment() const; + + inline const char *getName() const; + + /** Methods **/ + inline void printStats() const; + +protected: + std::uint64_t used_; + std::uint64_t peak_; + std::uint64_t averageUse_; + std::uint64_t numberAverage_; + std::int32_t alignment_; + + static inline std::uint64_t computeAlignedSize(std::uint64_t &size, std::int32_t alignment); + + static inline std::uint64_t computeAlignedSize(std::uint64_t &size); + + static inline std::int32_t computePadding(std::uint64_t &base, std::int32_t alignment); + + static inline const char *getByteUnitString(std::uint64_t &size); + + static inline double getByteNormalizedSize(std::uint64_t &size); + +private: + const char *name_; +}; + +SpiderAllocator::SpiderAllocator(const char *name, std::int32_t alignment) : used_{0}, + peak_{0}, + averageUse_{0}, + numberAverage_{0}, + alignment_{alignment}, + name_{name} { + +} + +void SpiderAllocator::setAllocationAlignment(std::int32_t alignment) { + alignment_ = alignment; +} + +std::int32_t SpiderAllocator::getAllocationAlignment() const { + return alignment_; +} + +const char *SpiderAllocator::getName() const { + return name_; +} + +void SpiderAllocator::printStats() const { + Logger::print(LOG_GENERAL, LOG_INFO, "Allocator: %s\n", getName()); + Logger::print(LOG_GENERAL, LOG_INFO, " ==> max usage: %" PRIu64"\n", peak_); + Logger::print(LOG_GENERAL, LOG_INFO, " ==> avg usage: %" PRIu64"\n", averageUse_ / numberAverage_); +} + +std::uint64_t SpiderAllocator::computeAlignedSize(std::uint64_t &size, std::int32_t alignment) { + std::uint64_t alignFactor = size / alignment + (size % alignment != 0); // ceil(size / pageSize) + return alignFactor * alignment; +} + +std::uint64_t SpiderAllocator::computeAlignedSize(std::uint64_t &size) { + std::int32_t alignment = 4096; + return computeAlignedSize(size, alignment); +} + +std::int32_t SpiderAllocator::computePadding(std::uint64_t &base, std::int32_t alignment) { + return static_cast(computeAlignedSize(base, alignment) - base); +} + +const char *SpiderAllocator::getByteUnitString(std::uint64_t &size) { + const std::uint64_t sizeGB = 1024 * 1024 * 1024; + const std::uint64_t sizeMB = 1024 * 1024; + const std::uint64_t sizeKB = 1024; + if (size / sizeGB) { + return "GB"; + } else if (size / sizeMB) { + return "MB"; + } else if (size / sizeKB) { + return "KB"; + } + return "B"; +} + +double SpiderAllocator::getByteNormalizedSize(std::uint64_t &size) { + const double sizeGB = 1024 * 1024 * 1024; + const double sizeMB = 1024 * 1024; + const double sizeKB = 1024; + if (size / sizeGB >= 1.) { + return size / sizeGB; + } else if (size / sizeMB >= 1.) { + return size / sizeMB; + } else if (size / sizeKB >= 1.) { + return size / sizeKB; + } + return size; +} + +#endif //SPIDER2_SPIDERALLOCATOR_H diff --git a/libspider/libspider/common/memory/abstract/StaticAllocator.h b/libspider/libspider/common/memory/abstract/StaticAllocator.h new file mode 100644 index 00000000..d726272a --- /dev/null +++ b/libspider/libspider/common/memory/abstract/StaticAllocator.h @@ -0,0 +1,73 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER2_STATICALLOCATOR_H +#define SPIDER2_STATICALLOCATOR_H + +#include "SpiderAllocator.h" + +class StaticAllocator : public SpiderAllocator { +public: + void *alloc(std::uint64_t size) override = 0; + + void free(void *ptr) override = 0; + + virtual void reset() = 0; + +protected: + std::uint64_t totalSize_; + char *startPtr_; + + inline StaticAllocator(const char *name, std::uint64_t totalSize, std::int32_t alignment = 0); + + inline ~StaticAllocator(); +}; + +StaticAllocator::StaticAllocator(const char *name, std::uint64_t totalSize, std::int32_t alignment) : + SpiderAllocator(name, alignment), + totalSize_{totalSize}, + startPtr_{nullptr} { + startPtr_ = (char *) std::malloc(totalSize_); +} + +StaticAllocator::~StaticAllocator() { + std::free(startPtr_); +} + +#endif //SPIDER2_STATICALLOCATOR_H diff --git a/libspider/units-tests/install.sh b/libspider/units-tests/install.sh new file mode 100755 index 00000000..92f8e2b4 --- /dev/null +++ b/libspider/units-tests/install.sh @@ -0,0 +1,7 @@ +#!/bin/sh +sudo apt update +sudo apt install libgtest-dev lcov +cd /usr/src/gtest +cmake CMakeLists.txt +make +cp *.a /usr/lib diff --git a/libspider/units-tests/libSpider2-tests/memory/CMakeLists.txt b/libspider/units-tests/libSpider2-tests/memory/CMakeLists.txt new file mode 100644 index 00000000..ff66df83 --- /dev/null +++ b/libspider/units-tests/libSpider2-tests/memory/CMakeLists.txt @@ -0,0 +1,48 @@ +cmake_minimum_required(VERSION 3.1) +set(CMAKE_CXX_STANDARD 11) +set(CMAKE_CXX_STANDARD_REQUIRED ON) + +# Macro to get short file name (vs full path) at compile time +# The additional / is important to remove the last character from the path. +# Note that it does not matter if the OS uses / or \, because we are only +# saving the path size. +string(LENGTH "${CMAKE_SOURCE_DIR}/" SOURCE_PATH_SIZE) +add_definitions("-DSOURCE_PATH_SIZE=${SOURCE_PATH_SIZE}") +add_definitions("-D__FILENAME__=(__FILE__ + ${SOURCE_PATH_SIZE})") + +# Locate GTest +find_package(GTest REQUIRED) + +# Set flags +set(CMAKE_BUILD_TYPE Debug) +set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -pg -Wall -Wextra -coverage") + + +# Link runTests with what we want to test and the GTest and pthread library +set(SPIDER_LIB_DIR "../../../libspider") + +include_directories( + ${GTEST_INCLUDE_DIRS} + ${PTHREADDIR}/include + ${SPIDER_LIB_DIR}/ + sources +) + + +file(GLOB_RECURSE + source_files + ${SPIDER_LIB_DIR}/common/*.cpp + ${SPIDER_LIB_DIR}/common/memory/*.cpp + sources/*.cpp +) + +file(GLOB_RECURSE + header_files + ${SPIDER_LIB_DIR}/common/*.h + ${SPIDER_LIB_DIR}/common/memory/*.h + ${SPIDER_LIB_DIR}/common/memory/abstract/*.h + sources/*.h +) + +add_executable(test-memory main.cpp ${source_files} ${header_files}) +target_link_libraries(test-memory ${GTEST_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT}) diff --git a/libspider/units-tests/libSpider2-tests/memory/main.cpp b/libspider/units-tests/libSpider2-tests/memory/main.cpp new file mode 100644 index 00000000..3afb7760 --- /dev/null +++ b/libspider/units-tests/libSpider2-tests/memory/main.cpp @@ -0,0 +1,44 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2018) : + * + * Antoine Morvan (2018) + * Florian Arrestier (2018) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#include +#include "LinearAllocatorTest.h" + + + +int main(int argc, char **argv) { + testing::InitGoogleTest(&argc, argv); + return RUN_ALL_TESTS(); +} diff --git a/libspider/units-tests/libSpider2-tests/memory/run-memory-test.sh b/libspider/units-tests/libSpider2-tests/memory/run-memory-test.sh new file mode 100755 index 00000000..e645e853 --- /dev/null +++ b/libspider/units-tests/libSpider2-tests/memory/run-memory-test.sh @@ -0,0 +1,32 @@ +#!/bin/sh + +which lcov 1>/dev/null 2>&1 +if [ $? != 0 ] +then + echo "You need to have lcov installed in order to generate the test coverage report" + exit 1 +fi + +# Creates output binary folder +rm -rf bin +mkdir bin +cd bin + +# Configure project with cmake +cmake .. + +# Compile project +make -j$(nproc) + +# Run test +./test-memory + +# Generate html report +mv CMakeFiles/runtime.dir/main.gcda . +mv CMakeFiles/runtime.dir/main.gcno . +lcov --base-directory . --directory . -c -o memory_test.info +lcov --remove memory_test.info "/usr*" -o memory_test.info # remove output for external libraries +rm -rf ../report +genhtml -o ../report -t "libspider2 memory test coverage" --num-spaces 4 memory_test.info +# Clean work space +cd .. && rm -rf bin diff --git a/libspider/units-tests/libSpider2-tests/memory/sources/LIFOAllocatorTest.cpp b/libspider/units-tests/libSpider2-tests/memory/sources/LIFOAllocatorTest.cpp new file mode 100644 index 00000000..da65c07c --- /dev/null +++ b/libspider/units-tests/libSpider2-tests/memory/sources/LIFOAllocatorTest.cpp @@ -0,0 +1,112 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#include +#include +#include "LIFOAllocatorTest.h" + + +LIFOAllocatorTest::LIFOAllocatorTest() : allocator(ALLOCATOR_NAME, MAX_SIZE) { +} + +LIFOAllocatorTest::~LIFOAllocatorTest() { + +} + +void LIFOAllocatorTest::SetUp() { + +} + +void LIFOAllocatorTest::TearDown() { + +} + +TEST_F(LIFOAllocatorTest, GetName) { + EXPECT_STREQ(allocator.getName(), ALLOCATOR_NAME); +} + +TEST_F(LIFOAllocatorTest, ThrowSizeException) { + std::uint64_t size = MAX_SIZE + 1; + EXPECT_THROW(allocator.alloc(size), SpiderException); +} + +TEST_F(LIFOAllocatorTest, MemoryAlloc) { + auto *array = (double *) allocator.alloc(2 * sizeof(double)); + EXPECT_NE(array, nullptr); + array[0] = 1; + array[1] = 2; + EXPECT_EQ(array[0], 1); + EXPECT_EQ(array[1], 2); + EXPECT_EQ(nullptr, allocator.alloc(0)); + EXPECT_THROW(allocator.alloc(MAX_SIZE), SpiderException); + EXPECT_NO_THROW(allocator.reset()); + EXPECT_NO_THROW(allocator.alloc(MAX_SIZE)); + EXPECT_NO_THROW(allocator.free(array)); +} + +TEST_F(LIFOAllocatorTest, MemoryAllocAlignment) { + auto *charArray = (char *) allocator.alloc(9 * sizeof(char)); + EXPECT_NE(charArray, nullptr); + auto *dblArray = (double *) allocator.alloc(2 * sizeof(double)); + EXPECT_NE(dblArray, nullptr); + EXPECT_EQ(charArray + 2 * sizeof(std::uint64_t), (char*) dblArray); +} + +TEST_F(LIFOAllocatorTest, FreeNull) { + EXPECT_NO_THROW(allocator.free(nullptr)); +} + +TEST_F(LIFOAllocatorTest, FreeUnordered) { + auto *charArray = (char *) allocator.alloc(9 * sizeof(char)); + EXPECT_NE(charArray, nullptr); + auto *dblArray = (double *) allocator.alloc(2 * sizeof(double)); + EXPECT_NE(dblArray, nullptr); + EXPECT_NO_THROW(allocator.free(charArray)); + EXPECT_THROW(allocator.free(dblArray), SpiderException); +} + +TEST_F(LIFOAllocatorTest, FreeOrdered) { + EXPECT_NO_THROW(allocator.free(nullptr)); + auto *charArray = (char *) allocator.alloc(9 * sizeof(char)); + EXPECT_NE(charArray, nullptr); + auto *dblArray = (double *) allocator.alloc(2 * sizeof(double)); + EXPECT_NE(dblArray, nullptr); + EXPECT_NO_THROW(allocator.free(dblArray)); + EXPECT_NO_THROW(allocator.free(charArray)); +} \ No newline at end of file diff --git a/libspider/units-tests/libSpider2-tests/memory/sources/LIFOAllocatorTest.h b/libspider/units-tests/libSpider2-tests/memory/sources/LIFOAllocatorTest.h new file mode 100644 index 00000000..783f6741 --- /dev/null +++ b/libspider/units-tests/libSpider2-tests/memory/sources/LIFOAllocatorTest.h @@ -0,0 +1,64 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2013 - 2018) : + * + * Antoine Morvan (2018) + * Clément Guy (2014) + * Florian Arrestier (2018) + * Hugo Miomandre (2017) + * Julien Heulot (2013 - 2015) + * Yaset Oliva (2013 - 2014) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER2_MEMORY_TEST_LIFO_ALLOCATOR_H +#define SPIDER2_MEMORY_TEST_LIFO_ALLOCATOR_H + +#include +#include "common/memory/LIFOStaticAllocator.h" + +#define ALLOCATOR_NAME "my-allocator" + +#define MAX_SIZE 512 + +class LIFOAllocatorTest : public ::testing::Test { +public: + explicit LIFOAllocatorTest(); + + ~LIFOAllocatorTest() override; + + void SetUp() override; + + void TearDown() override; + +protected: + LIFOStaticAllocator allocator; +}; + +#endif //SPIDER2_MEMORY_TEST_LIFO_ALLOCATOR_H diff --git a/libspider/units-tests/libSpider2-tests/memory/sources/LinearAllocatorTest.cpp b/libspider/units-tests/libSpider2-tests/memory/sources/LinearAllocatorTest.cpp new file mode 100644 index 00000000..daea758d --- /dev/null +++ b/libspider/units-tests/libSpider2-tests/memory/sources/LinearAllocatorTest.cpp @@ -0,0 +1,106 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2018) : + * + * Antoine Morvan (2018) + * Florian Arrestier (2018) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#include "LinearAllocatorTest.h" +#include + +LinearAllocatorTest::LinearAllocatorTest() : allocator(ALLOCATOR_NAME, MAX_SIZE, sizeof(std::uint64_t)) { +} + +LinearAllocatorTest::~LinearAllocatorTest() { + +} + +void LinearAllocatorTest::SetUp() { + +} + +void LinearAllocatorTest::TearDown() { + +} + +TEST_F(LinearAllocatorTest, GetName) { + EXPECT_STREQ(allocator.getName(), ALLOCATOR_NAME); +} + +TEST_F(LinearAllocatorTest, ThrowSizeException) { + std::uint64_t size = MAX_SIZE + 1; + EXPECT_THROW(allocator.alloc(size), SpiderException); +} + +TEST_F(LinearAllocatorTest, MemoryAlloc) { + auto *array = (double *) allocator.alloc(2 * sizeof(double)); + EXPECT_NE(array, nullptr); + array[0] = 1; + array[1] = 2; + EXPECT_EQ(array[0], 1); + EXPECT_EQ(array[1], 2); + EXPECT_EQ(nullptr, allocator.alloc(0)); + EXPECT_THROW(allocator.alloc(MAX_SIZE), SpiderException); + EXPECT_NO_THROW(allocator.reset()); + EXPECT_NO_THROW(allocator.alloc(MAX_SIZE)); + EXPECT_NO_THROW(allocator.free(array)); +} + +TEST_F(LinearAllocatorTest, MemoryAllocDefaultAlignment) { + auto *charArray = (char *) allocator.alloc(9 * sizeof(char)); + EXPECT_NE(charArray, nullptr); + auto *dblArray = (double *) allocator.alloc(2 * sizeof(double)); + EXPECT_NE(dblArray, nullptr); + EXPECT_EQ(charArray + 2 * sizeof(std::uint64_t), (char*) dblArray); +} + +TEST(LinearStaticAllocatorTest, MemoryAllocUserAlignment) { + std::int32_t sizeAlign = 2* sizeof(std::uint64_t); + auto allocator = LinearStaticAllocator("", MAX_SIZE, sizeAlign); + auto *charArray = (char *) allocator.alloc(9 * sizeof(char)); + EXPECT_NE(charArray, nullptr); + auto *dblArray = (double *) allocator.alloc(2 * sizeof(double)); + EXPECT_NE(dblArray, nullptr); + EXPECT_EQ(charArray + sizeAlign, (char*) dblArray); +} + +TEST(LinearStaticAllocatorTest, MemoryAllocNoPaddingRequired) { + auto allocator = LinearStaticAllocator("", MAX_SIZE); + auto *charArray = (char *) allocator.alloc(8 * sizeof(char)); + EXPECT_NE(charArray, nullptr); + auto *dblArray = (double *) allocator.alloc(2 * sizeof(double)); + EXPECT_NE(dblArray, nullptr); + EXPECT_EQ(charArray + 8, (char*) dblArray); +} + +TEST(LinearStaticAllocatorTest, MinimumAlignment) { + EXPECT_THROW(LinearStaticAllocator("", 0, 2), SpiderException); +} \ No newline at end of file diff --git a/libspider/units-tests/libSpider2-tests/memory/sources/LinearAllocatorTest.h b/libspider/units-tests/libSpider2-tests/memory/sources/LinearAllocatorTest.h new file mode 100644 index 00000000..503638c4 --- /dev/null +++ b/libspider/units-tests/libSpider2-tests/memory/sources/LinearAllocatorTest.h @@ -0,0 +1,61 @@ +/** + * Copyright or © or Copr. IETR/INSA - Rennes (2018) : + * + * Antoine Morvan (2018) + * Florian Arrestier (2018) + * + * Spider is a dataflow based runtime used to execute dynamic PiSDF + * applications. The Preesm tool may be used to design PiSDF applications. + * + * This software is governed by the CeCILL license under French law and + * abiding by the rules of distribution of free software. You can use, + * modify and/ or redistribute the software under the terms of the CeCILL + * license as circulated by CEA, CNRS and INRIA at the following URL + * "http://www.cecill.info". + * + * As a counterpart to the access to the source code and rights to copy, + * modify and redistribute granted by the license, users are provided only + * with a limited warranty and the software's author, the holder of the + * economic rights, and the successive licensors have only limited + * liability. + * + * In this respect, the user's attention is drawn to the risks associated + * with loading, using, modifying and/or developing or reproducing the + * software by the user in light of its specific status of free software, + * that may mean that it is complicated to manipulate, and that also + * therefore means that it is reserved for developers and experienced + * professionals having in-depth computer knowledge. Users are therefore + * encouraged to load and test the software's suitability as regards their + * requirements in conditions enabling the security of their systems and/or + * data to be ensured and, more generally, to use and operate it in the + * same conditions as regards security. + * + * The fact that you are presently reading this means that you have had + * knowledge of the CeCILL license and that you accept its terms. + */ +#ifndef SPIDER2_MEMORY_TEST_LINEAR_ALLOCATOR_H +#define SPIDER2_MEMORY_TEST_LINEAR_ALLOCATOR_H + +#include +#include "common/memory/LinearStaticAllocator.h" + +#define ALLOCATOR_NAME "my-allocator" + +#define MAX_SIZE 512 + +class LinearAllocatorTest : public ::testing::Test { +public: + explicit LinearAllocatorTest(); + + ~LinearAllocatorTest() override; + + void SetUp() override; + + void TearDown() override; + +protected: + LinearStaticAllocator allocator; +}; + +#endif + diff --git a/libspider/units-tests/readme.md b/libspider/units-tests/readme.md new file mode 100644 index 00000000..e5fcb217 --- /dev/null +++ b/libspider/units-tests/readme.md @@ -0,0 +1,10 @@ +How to run SPIDER unitary tests +=== + +# Install GTest framework + +With root permissions run the **install.sh** script. + +# Run the test + +Run the **run-full-test.sh** script. From 854a1a5886b834dada296a2968f89f7e463cc8e5 Mon Sep 17 00:00:00 2001 From: Arrestier Florian Date: Fri, 8 Mar 2019 10:19:18 +0100 Subject: [PATCH 0002/1291] (GITIGNORE) updating .gitignore. --- .gitignore | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 8a420b9e..64bc6ec1 100644 --- a/.gitignore +++ b/.gitignore @@ -35,6 +35,11 @@ *.sql *.sqlite +# Doxygen files and xml # +###################### +*.html +*.xml + # OS generated files # ###################### .DS_Store @@ -76,11 +81,14 @@ aclocal.m4 compile config.h.in configure +*.cmake +*.make # Clion Project files # -master/.idea/* -master/cmake-build-release/* -master/cmake-build-debug/* +####################### +*/.idea/* +*/cmake-build-release/* +*/cmake-build-debug/* configure.scan depcomp install-sh From 21c69583f7207127b6db455bf9333ff31969240d Mon Sep 17 00:00:00 2001 From: Arrestier Florian Date: Fri, 8 Mar 2019 10:21:14 +0100 Subject: [PATCH 0003/1291] (EXTRAS) adding find*.cmake files. --- .gitignore | 1 - libspider/extras/cmake_modules/FindPAPI.cmake | 45 ++++ .../extras/cmake_modules/FindThreads.cmake | 246 ++++++++++++++++++ 3 files changed, 291 insertions(+), 1 deletion(-) create mode 100644 libspider/extras/cmake_modules/FindPAPI.cmake create mode 100644 libspider/extras/cmake_modules/FindThreads.cmake diff --git a/.gitignore b/.gitignore index 64bc6ec1..6aea8fcb 100644 --- a/.gitignore +++ b/.gitignore @@ -81,7 +81,6 @@ aclocal.m4 compile config.h.in configure -*.cmake *.make # Clion Project files # diff --git a/libspider/extras/cmake_modules/FindPAPI.cmake b/libspider/extras/cmake_modules/FindPAPI.cmake new file mode 100644 index 00000000..86cbf22a --- /dev/null +++ b/libspider/extras/cmake_modules/FindPAPI.cmake @@ -0,0 +1,45 @@ +# Try to find PAPI headers and libraries. +# +# Usage of this module as follows: +# +# find_package(PAPI) +# +# Variables used by this module, they can change the default behaviour and need +# to be set before calling find_package: +# +# PAPI_PREFIX Set this variable to the root installation of +# libpapi if the module has problems finding the +# proper installation path. +# +# Variables defined by this module: +# +# PAPI_FOUND System has PAPI libraries and headers +# PAPI_LIBRARIES The PAPI library +# PAPI_INCLUDE_DIRS The location of PAPI headers + +find_path(PAPI_PREFIX + NAMES include/papi.h +) + +find_library(PAPI_LIBRARIES + # Pick the static library first for easier run-time linking. + NAMES libpapi.so libpapi.a papi + HINTS ${PAPI_PREFIX}/lib ${HILTIDEPS}/lib +) + +find_path(PAPI_INCLUDE_DIRS + NAMES papi.h + HINTS ${PAPI_PREFIX}/include ${HILTIDEPS}/include +) + +include(FindPackageHandleStandardArgs) +find_package_handle_standard_args(PAPI DEFAULT_MSG + PAPI_LIBRARIES + PAPI_INCLUDE_DIRS +) + +mark_as_advanced( + PAPI_PREFIX_DIRS + PAPI_LIBRARIES + PAPI_INCLUDE_DIRS +) diff --git a/libspider/extras/cmake_modules/FindThreads.cmake b/libspider/extras/cmake_modules/FindThreads.cmake new file mode 100644 index 00000000..95f2dd97 --- /dev/null +++ b/libspider/extras/cmake_modules/FindThreads.cmake @@ -0,0 +1,246 @@ +# Updated FindThreads.cmake that supports pthread-win32 +# Downloaded from http://www.vtk.org/Bug/bug_view_advanced_page.php?bug_id=6399 + +# - This module determines the thread library of the system. +# +# The following variables are set +# CMAKE_THREAD_LIBS_INIT - the thread library +# CMAKE_USE_SPROC_INIT - are we using sproc? +# CMAKE_USE_WIN32_THREADS_INIT - using WIN32 threads? +# CMAKE_USE_PTHREADS_INIT - are we using pthreads +# CMAKE_HP_PTHREADS_INIT - are we using hp pthreads +# +# If use of pthreads-win32 is desired, the following variables +# can be set. +# +# THREADS_USE_PTHREADS_WIN32 - +# Setting this to true searches for the pthreads-win32 +# port (since CMake 2.8.0) +# +# THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME +# C = no exceptions (default) +# (NOTE: This is the default scheme on most POSIX thread +# implementations and what you should probably be using) +# CE = C++ Exception Handling +# SE = Structure Exception Handling (MSVC only) +# (NOTE: Changing this option from the default may affect +# the portability of your application. See pthreads-win32 +# documentation for more details.) +# +#====================================================== +# Example usage where threading library +# is provided by the system: +# +# find_package(Threads REQUIRED) +# add_executable(foo foo.cc) +# target_link_libraries(foo ${CMAKE_THREAD_LIBS_INIT}) +# +# Example usage if pthreads-win32 is desired on Windows +# or a system provided thread library: +# +# set(THREADS_USE_PTHREADS_WIN32 true) +# find_package(Threads REQUIRED) +# include_directories(${THREADS_PTHREADS_INCLUDE_DIR}) +# +# add_executable(foo foo.cc) +# target_link_libraries(foo ${CMAKE_THREAD_LIBS_INIT}) +# + +INCLUDE (CheckIncludeFiles) +INCLUDE (CheckLibraryExists) +SET(Threads_FOUND FALSE) + +IF(WIN32 AND NOT CYGWIN AND THREADS_USE_PTHREADS_WIN32) + SET(_Threads_ptwin32 true) +ENDIF() + +# Do we have sproc? +IF(CMAKE_SYSTEM MATCHES IRIX) + CHECK_INCLUDE_FILES("sys/types.h;sys/prctl.h" CMAKE_HAVE_SPROC_H) +ENDIF() + +IF(CMAKE_HAVE_SPROC_H) + # We have sproc + SET(CMAKE_USE_SPROC_INIT 1) + +ELSEIF(_Threads_ptwin32) + + IF(NOT DEFINED THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME) + # Assign the default scheme + SET(THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME "C") + ELSE() + # Validate the scheme specified by the user + IF(NOT THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME STREQUAL "C" AND + NOT THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME STREQUAL "CE" AND + NOT THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME STREQUAL "SE") + MESSAGE(FATAL_ERROR "See documentation for FindPthreads.cmake, only C, CE, and SE modes are allowed") + ENDIF() + IF(NOT MSVC AND THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME STREQUAL "SE") + MESSAGE(FATAL_ERROR "Structured Exception Handling is only allowed for MSVC") + ENDIF(NOT MSVC AND THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME STREQUAL "SE") + ENDIF() + + FIND_PATH(THREADS_PTHREADS_INCLUDE_DIR pthread.h) + + # Determine the library filename + IF(MSVC) + SET(_Threads_pthreads_libname + pthreadV${THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME}2) + ELSEIF(MINGW) + SET(_Threads_pthreads_libname + pthreadG${THREADS_PTHREADS_WIN32_EXCEPTION_SCHEME}2) + ELSE() + MESSAGE(FATAL_ERROR "This should never happen") + ENDIF() + + # Use the include path to help find the library if possible + SET(_Threads_lib_paths "") + IF(THREADS_PTHREADS_INCLUDE_DIR) + GET_FILENAME_COMPONENT(_Threads_root_dir + ${THREADS_PTHREADS_INCLUDE_DIR} PATH) + SET(_Threads_lib_paths ${_Threads_root_dir}/lib) + ENDIF() + FIND_LIBRARY(THREADS_PTHREADS_WIN32_LIBRARY + NAMES ${_Threads_pthreads_libname} + PATHS ${_Threads_lib_paths} + DOC "The Portable Threads Library for Win32" + NO_SYSTEM_PATH + ) + + IF(THREADS_PTHREADS_INCLUDE_DIR AND THREADS_PTHREADS_WIN32_LIBRARY) + MARK_AS_ADVANCED(THREADS_PTHREADS_INCLUDE_DIR) + SET(CMAKE_THREAD_LIBS_INIT ${THREADS_PTHREADS_WIN32_LIBRARY}) + SET(CMAKE_HAVE_THREADS_LIBRARY 1) + SET(Threads_FOUND TRUE) + ENDIF() + + MARK_AS_ADVANCED(THREADS_PTHREADS_WIN32_LIBRARY) + +ELSE() + # Do we have pthreads? + CHECK_INCLUDE_FILES("pthread.h" CMAKE_HAVE_PTHREAD_H) + IF(CMAKE_HAVE_PTHREAD_H) + + # + # We have pthread.h + # Let's check for the library now. + # + SET(CMAKE_HAVE_THREADS_LIBRARY) + IF(NOT THREADS_HAVE_PTHREAD_ARG) + + # Do we have -lpthreads + CHECK_LIBRARY_EXISTS(pthreads pthread_create "" CMAKE_HAVE_PTHREADS_CREATE) + IF(CMAKE_HAVE_PTHREADS_CREATE) + SET(CMAKE_THREAD_LIBS_INIT "-lpthreads") + SET(CMAKE_HAVE_THREADS_LIBRARY 1) + SET(Threads_FOUND TRUE) + ENDIF() + + # Ok, how about -lpthread + CHECK_LIBRARY_EXISTS(pthread pthread_create "" CMAKE_HAVE_PTHREAD_CREATE) + IF(CMAKE_HAVE_PTHREAD_CREATE) + SET(CMAKE_THREAD_LIBS_INIT "-lpthread") + SET(Threads_FOUND TRUE) + SET(CMAKE_HAVE_THREADS_LIBRARY 1) + ENDIF() + + IF(CMAKE_SYSTEM MATCHES "SunOS.*") + # On sun also check for -lthread + CHECK_LIBRARY_EXISTS(thread thr_create "" CMAKE_HAVE_THR_CREATE) + IF(CMAKE_HAVE_THR_CREATE) + SET(CMAKE_THREAD_LIBS_INIT "-lthread") + SET(CMAKE_HAVE_THREADS_LIBRARY 1) + SET(Threads_FOUND TRUE) + ENDIF() + ENDIF(CMAKE_SYSTEM MATCHES "SunOS.*") + + ENDIF(NOT THREADS_HAVE_PTHREAD_ARG) + + IF(NOT CMAKE_HAVE_THREADS_LIBRARY) + # If we did not found -lpthread, -lpthread, or -lthread, look for -pthread + IF("THREADS_HAVE_PTHREAD_ARG" MATCHES "^THREADS_HAVE_PTHREAD_ARG") + MESSAGE(STATUS "Check if compiler accepts -pthread") + TRY_RUN(THREADS_PTHREAD_ARG THREADS_HAVE_PTHREAD_ARG + ${CMAKE_BINARY_DIR} + ${CMAKE_ROOT}/Modules/CheckForPthreads.c + CMAKE_FLAGS -DLINK_LIBRARIES:STRING=-pthread + COMPILE_OUTPUT_VARIABLE OUTPUT) + + IF(THREADS_HAVE_PTHREAD_ARG) + IF(THREADS_PTHREAD_ARG MATCHES "^2$") + SET(Threads_FOUND TRUE) + MESSAGE(STATUS "Check if compiler accepts -pthread - yes") + ELSE() + MESSAGE(STATUS "Check if compiler accepts -pthread - no") + FILE(APPEND + ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log + "Determining if compiler accepts -pthread returned ${THREADS_PTHREAD_ARG} instead of 2. The compiler had the following output:\n${OUTPUT}\n\n") + ENDIF() + ELSE() + MESSAGE(STATUS "Check if compiler accepts -pthread - no") + FILE(APPEND + ${CMAKE_BINARY_DIR}${CMAKE_FILES_DIRECTORY}/CMakeError.log + "Determining if compiler accepts -pthread failed with the following output:\n${OUTPUT}\n\n") + ENDIF() + + ENDIF("THREADS_HAVE_PTHREAD_ARG" MATCHES "^THREADS_HAVE_PTHREAD_ARG") + + IF(THREADS_HAVE_PTHREAD_ARG) + SET(Threads_FOUND TRUE) + SET(CMAKE_THREAD_LIBS_INIT "-pthread") + ENDIF() + + ENDIF(NOT CMAKE_HAVE_THREADS_LIBRARY) + ENDIF(CMAKE_HAVE_PTHREAD_H) +ENDIF() + +IF(CMAKE_THREAD_LIBS_INIT) + SET(CMAKE_USE_PTHREADS_INIT 1) + SET(Threads_FOUND TRUE) +ENDIF() + +IF(CMAKE_SYSTEM MATCHES "Windows" + AND NOT THREADS_USE_PTHREADS_WIN32) + SET(CMAKE_USE_WIN32_THREADS_INIT 1) + SET(Threads_FOUND TRUE) +ENDIF() + +IF(CMAKE_USE_PTHREADS_INIT) + IF(CMAKE_SYSTEM MATCHES "HP-UX-*") + # Use libcma if it exists and can be used. It provides more + # symbols than the plain pthread library. CMA threads + # have actually been deprecated: + # http://docs.hp.com/en/B3920-90091/ch12s03.html#d0e11395 + # http://docs.hp.com/en/947/d8.html + # but we need to maintain compatibility here. + # The CMAKE_HP_PTHREADS setting actually indicates whether CMA threads + # are available. + CHECK_LIBRARY_EXISTS(cma pthread_attr_create "" CMAKE_HAVE_HP_CMA) + IF(CMAKE_HAVE_HP_CMA) + SET(CMAKE_THREAD_LIBS_INIT "-lcma") + SET(CMAKE_HP_PTHREADS_INIT 1) + SET(Threads_FOUND TRUE) + ENDIF(CMAKE_HAVE_HP_CMA) + SET(CMAKE_USE_PTHREADS_INIT 1) + ENDIF() + + IF(CMAKE_SYSTEM MATCHES "OSF1-V*") + SET(CMAKE_USE_PTHREADS_INIT 0) + SET(CMAKE_THREAD_LIBS_INIT ) + ENDIF() + + IF(CMAKE_SYSTEM MATCHES "CYGWIN_NT*") + SET(CMAKE_USE_PTHREADS_INIT 1) + SET(Threads_FOUND TRUE) + SET(CMAKE_THREAD_LIBS_INIT ) + SET(CMAKE_USE_WIN32_THREADS_INIT 0) + ENDIF() +ENDIF(CMAKE_USE_PTHREADS_INIT) + +INCLUDE(FindPackageHandleStandardArgs) +IF(_Threads_ptwin32) + FIND_PACKAGE_HANDLE_STANDARD_ARGS(Threads DEFAULT_MSG + THREADS_PTHREADS_WIN32_LIBRARY THREADS_PTHREADS_INCLUDE_DIR) +ELSE() + FIND_PACKAGE_HANDLE_STANDARD_ARGS(Threads DEFAULT_MSG Threads_FOUND) +ENDIF() \ No newline at end of file From 266361b506c25344cb75e44322f19ec75632f760 Mon Sep 17 00:00:00 2001 From: Arrestier Florian Date: Fri, 8 Mar 2019 11:13:47 +0100 Subject: [PATCH 0004/1291] (DOXYGEN) adding Doxyfile to spider. --- libspider/Doxyfile | 2494 +++++++++++++++++ libspider/libspider/common/LinkedList.h | 32 +- .../common/memory/abstract/SpiderAllocator.h | 25 +- 3 files changed, 2543 insertions(+), 8 deletions(-) create mode 100644 libspider/Doxyfile diff --git a/libspider/Doxyfile b/libspider/Doxyfile new file mode 100644 index 00000000..4631daf5 --- /dev/null +++ b/libspider/Doxyfile @@ -0,0 +1,2494 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Spider library -- IETR" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 2.0 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doxygen-output + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = libspider + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /