diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/README.md b/README.md index 15da30276508..919eee0d3cbb 100644 --- a/README.md +++ b/README.md @@ -50,8 +50,6 @@ This is an example work-flow and configuration to get and build the LLVM source: * ``cd llvm-project`` - * ``cmake -S llvm -B build -G [options]`` - Some common build system generators are: * ``Ninja`` --- for generating [Ninja](https://ninja-build.org) diff --git a/clang/.gitignore b/clang/.gitignore index 3004923c22af..5d78688689a5 100644 --- a/clang/.gitignore +++ b/clang/.gitignore @@ -22,6 +22,8 @@ cscope.files cscope.out /tags +/TAGS +.ftpconfig #==============================================================================# # Directories to ignore (do not add trailing '/'s, they skip symlinks). diff --git a/clang/cmake/caches/VectorEngine-Stage-1.cmake b/clang/cmake/caches/VectorEngine-Stage-1.cmake deleted file mode 100644 index 5d169c1fd0b3..000000000000 --- a/clang/cmake/caches/VectorEngine-Stage-1.cmake +++ /dev/null @@ -1,122 +0,0 @@ -# Build Clang for VH and VE using compiler-rt builtins. - -set(CMAKE_BUILD_TYPE "Release" CACHE STRING "") -set (LLVM_TARGETS_TO_BUILD "X86;VE" CACHE STRING "") - -# TODO set (LLVM_EXPERIMENTAL_TARGETS_TO_BUILD "VE" CACHE STRING "") - -# Use stage 1 Clang. -# set(CMAKE_C_COMPILER "/home/smoll/devspace/install/bin/clang" CACHE STRING "") -# set(CMAKE_CXX_COMPILER "/home/smoll/devspace/install/bin/clang++" CACHE STRING "") -set(CMAKE_C_COMPILER "gcc" CACHE STRING "") -set(CMAKE_CXX_COMPILER "g++" CACHE STRING "") - -# Select projects & runtimes. -set(LLVM_ENABLE_PROJECTS "clang" CACHE STRING "") -set(LLVM_ENABLE_RUNTIMES "compiler-rt;libunwind;libcxxabi;libcxx" CACHE STRING "") -# set(LLVM_ENABLE_RUNTIMES "compiler-rt" CACHE STRING "") -set(LLVM_ENABLE_PER_TARGET_RUNTIME_DIR True CACHE BOOL "") - -# ZLIB missing on VE (TODO make this target specific) -set(LLVM_ENABLE_ZLIB False CACHE BOOL "") - -# Clang defaults (FIXME except compiler-rt, really VE defaults) -# set(CLANG_DEFAULT_RTLIB "compiler-rt" CACHE STRING "") -# set(CLANG_DEFAULT_UNWINDLIB "libunwind" CACHE STRING "") -# set(CLANG_DEFAULT_CXX_STDLIB "libc++" CACHE STRING "") -# set(CLANG_UNWIND_LIB "libunwind" CACHE STRING "") - -# FIXME Disable RV or we get a cyclic dependency. -set (LLVM_TOOL_RV_BUILD OFF CACHE STRING "") - -set(LLVM_OPTIMIZED_TABLEGEN ON CACHE BOOL "") - -# Configure targets and flags. -set(VE_TARGET "ve-linux") -set(VH_TARGET "x86_64-unknown-linux-gnu") - -# Build a complete compiler environment for VE. Use defaults for VH. -foreach(target ${VE_TARGET}) - list(APPEND BUILTIN_TARGETS "${target}") - list(APPEND RUNTIME_TARGETS "${target}") - - # Compiler RT. - set(RUNTIMES_${target}_COMPILER_RT_DEFAULT_TARGET_TRIPLE "${target}" CACHE STRING "") - set(RUNTIMES_${target}_COMPILER_RT_DEFAULT_TARGET_ONLY OFF CACHE BOOL "") - - set(RUNTIMES_${target}_COMPILER_RT_USE_BUILTINS_LIBRARY On CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_USE_LIBCXX:BOOL Off CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_BUILTINS ON CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_CRT ON CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_LIBFUZZER OFF CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_PROFILE OFF CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_SANITIZERS OFF CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_XRAY OFF CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_INCLUDE_TESTS OFF CACHE BOOL "") - - # libunwind. - set(RUNTIMES_${target}_LIBUNWIND_USE_COMPILER_RT True CACHE BOOL "") - set(RUNTIMES_${target}_LIBUNWIND_ENABLE_SHARED False CACHE BOOL "") # Unsupported runtime dependency on libcxxabi. - set(RUNTIMES_${target}_LIBUNWIND_HERMETIC_STATIC_LIBRARY True CACHE BOOL "") - - # libcxxabi. - set(RUNTIMES_${target}_LIBCXXABI_USE_COMPILER_RT True CACHE BOOL "") - set(RUNTIMES_${target}_LIBCXXABI_ENABLE_STATIC_UNWINDER True CACHE BOOL "") - set(RUNTIMES_${target}_LIBCXXABI_USE_LLVM_UNWINDER True CACHE BOOL "") - - # libcxx. - set(RUNTIMES_${target}_LIBCXX_USE_COMPILER_RT True CACHE BOOL "") - set(RUNTIMES_${target}_LIBCXX_CXX_ABI libcxxabi CACHE STRING "") - set(RUNTIMES_${target}_LIBCXX_ENABLE_STATIC_ABI_LIBRARY True CACHE BOOL "") - set(RUNTIMES_${target}_LIBCXX_ENABLE_STATIC True CACHE BOOL "") - - # FIXME Re-activate once issues with dynamic libc++.so are resolved. - set(RUNTIMES_${target}_LIBCXX_ENABLE_SHARED False CACHE BOOL "") - set(RUNTIMES_${target}_LIBCXXABI_LINK_TESTS_WITH_SHARED_LIBCXX False CACHE BOOL "") - - # libopenmp. - set(RUNTIMES_${target}_LIBOMP_TSAN_SUPPORT False CACHE BOOL "") - set(RUNTIMES_${target}_OPENMP_ENABLE_LIBOMPTARGET True CACHE BOOL "") - set(RUNTIMES_${target}_OPENMP_ENABLE_OMPT_TOOLS False CACHE BOOL "") - - # FIXME We only actually want this for compiler-rt.... - set(RUNTIMES_${target}_CMAKE_CXX_FLAGS "-nostdlib++" CACHE STRING "") - set(RUNTIMES_${target}_CMAKE_C_FLAGS "-nostdlib" CACHE STRING "") -endforeach() -set(LLVM_BUILTIN_TARGETS "${BUILTIN_TARGETS}" CACHE STRING "") -set(LLVM_RUNTIME_TARGETS "${RUNTIME_TARGETS}" CACHE STRING "") - -# OpenMP (target specific). -# set(RUNTIMES_${VE_TARGET}_LIBOMP_ARCH "ve" CACHE STRING "") -# set(RUNTIMES_${VH_TARGET}_LIBOMP_ARCH "x86_64" CACHE STRING "") - -# Point to libunwind.so install location.. -# set(VH_EXTRA_LIB_DIR "${CMAKE_CURRENT_BINARY_DIR}/lib/x86_64-unknown-linux-gnu/c++") -# set(VE_EXTRA_LIB_DIR "${CMAKE_CURRENT_BINARY_DIR}/lib/ve-linux/c++") - -# VH configuration -# set(RUNTIMES_${VH_TARGET}_CMAKE_C_FLAGS "-march=native" CACHE STRING "") -# set(RUNTIMES_${VH_TARGET}_CMAKE_CXX_FLAGS "-march=native" CACHE STRING "") -# set(RUNTIMES_${VH_TARGET}_CMAKE_ASM_FLAGS "-march=native" CACHE STRING "") - -# VE configuration -# Stage 2. -# set(RUNTIMES_${VE_TARGET}_CMAKE_C_FLAGS "-L${VE_EXTRA_LIB_DIR}" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_CMAKE_CXX_FLAGS "-L${VE_EXTRA_LIB_DIR}" CACHE STRING "") - - -# Stage 1. -# libcxx,libcxxabi, etc not available yet - -# set(RUNTIMES_${VE_TARGET}_COMPILER_RT_CMAKE_CXX_FLAGS "-nostdlib++" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_COMPILER_RT_CMAKE_C_FLAGS "-nostdlib++" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBUNWIND_CMAKE_CXX_FLAGS "-nostdlib" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBUNWIND_CMAKE_C_FLAGS "-nostdlib" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBCXXABI_CMAKE_CXX_FLAGS "-nostdlib++" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBCXXABI_CMAKE_C_FLAGS "-nostdlib" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBCXX_CMAKE_CXX_FLAGS "--stdlib -nostdlib++" CACHE STRING "") # FIXME link rtlib but not stdlib++.. -# set(RUNTIMES_${VE_TARGET}_CMAKE_ASM_FLAGS "--target=${VE_TARGET}" CACHE STRING "") - -# DEBUGGING: `libunwind.so` getting build but not found in feature test macros.. -# set(RUNTIMES_${VH_TARGET}_CMAKE_EXE_LINKER_FLAGS "-L${VH_EXTRA_LIB_DIR}") -# set(RUNTIMES_${VE_TARGET}_CMAKE_EXE_LINKER_FLAGS "-L${VE_EXTRA_LIB_DIR}") diff --git a/clang/cmake/caches/VectorEngine-Stage-2.cmake b/clang/cmake/caches/VectorEngine-Stage-2.cmake deleted file mode 100644 index b26bdeead55c..000000000000 --- a/clang/cmake/caches/VectorEngine-Stage-2.cmake +++ /dev/null @@ -1,124 +0,0 @@ -# Build Clang for VH and VE using compiler-rt builtins. - -set(CMAKE_BUILD_TYPE "Release" CACHE STRING "") -set (LLVM_TARGETS_TO_BUILD "X86;VE" CACHE STRING "") -set(BUILD_SHARED_LIBS On CACHE BOOL "") - -# TODO set (LLVM_EXPERIMENTAL_TARGETS_TO_BUILD "VE" CACHE STRING "") - -if(NOT BOOTSTRAP_PREFIX) - message(FATAL_ERROR "Define -DBOOTSTRAP_PREIFX=") -endif() - -# Use stage 1 binaries. -set(LLVM_TABLEGEN "${BOOTSTRAP_PREFIX}/bin/llvm-tblgen" CACHE STRING "" FORCE) -set(CMAKE_C_COMPILER "${BOOTSTRAP_PREFIX}/bin/clang" CACHE STRING "" FORCE) -set(CMAKE_CXX_COMPILER "${BOOTSTRAP_PREFIX}/bin/clang++" CACHE STRING "" FORCE) -set(LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN True CACHE BOOL "") # FIXME Stage 1 uses stdc++ for VH. - -# set(CMAKE_C_COMPILER "gcc" CACHE STRING "") -# set(CMAKE_CXX_COMPILER "g++" CACHE STRING "") - -# Select projects & runtimes. -set(LLVM_ENABLE_PROJECTS "clang;openmp" CACHE STRING "") -# set(LLVM_ENABLE_RUNTIMES "libunwind;libcxxabi;libcxx" CACHE STRING "") -# set(LLVM_ENABLE_RUNTIMES "compiler-rt" CACHE STRING "") -set(LLVM_ENABLE_PER_TARGET_RUNTIME_DIR True CACHE BOOL "") - -# ZLIB missing on VE (TODO make this target specific) -set(LLVM_ENABLE_ZLIB False CACHE BOOL "") - -# Clang defaults (FIXME really VE defaults) -# set(CLANG_DEFAULT_UNWINDLIB "libunwind" CACHE STRING "") -# set(CLANG_DEFAULT_RTLIB "compiler-rt" CACHE STRING "") -# set(CLANG_DEFAULT_CXX_STDLIB "libc++" CACHE STRING "") -# set(CLANG_UNWIND_LIB "libunwind" CACHE STRING "") - -# Region vectorizer -set (LLVM_TOOL_RV_BUILD ON CACHE STRING "") -set (LLVM_RVPLUG_LINK_INTO_TOOLS On CACHE STRING "") - -# Configure targets and flags. -set(VE_TARGET "ve-linux") -set(VH_TARGET "x86_64-unknown-linux-gnu") - -# Build a complete compiler environment for VE. Use defaults for VH. -foreach(target ${VE_TARGET}) - list(APPEND BUILTIN_TARGETS "${target}") - list(APPEND RUNTIME_TARGETS "${target}") - - # Compiler RT. - set(RUNTIMES_${target}_COMPILER_RT_DEFAULT_TARGET_TRIPLE "${target}" CACHE STRING "") - set(RUNTIMES_${target}_COMPILER_RT_DEFAULT_TARGET_ONLY OFF CACHE BOOL "") - - set(RUNTIMES_${target}_COMPILER_RT_USE_BUILTINS_LIBRARY On CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_USE_LIBCXX:BOOL Off CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_BUILTINS ON CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_CRT ON CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_LIBFUZZER OFF CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_PROFILE OFF CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_SANITIZERS OFF CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_BUILD_XRAY OFF CACHE BOOL "") - set(RUNTIMES_${target}_COMPILER_RT_INCLUDE_TESTS OFF CACHE BOOL "") - - # libunwind. - set(RUNTIMES_${target}_LIBUNWIND_USE_COMPILER_RT True CACHE BOOL "") - set(RUNTIMES_${target}_LIBUNWIND_ENABLE_SHARED True CACHE BOOL "") # Unsupported runtime dependency on libcxxabi. - set(RUNTIMES_${target}_LIBUNWIND_HERMETIC_STATIC_LIBRARY True CACHE BOOL "") - - # libcxxabi. - set(RUNTIMES_${target}_LIBCXXABI_USE_COMPILER_RT True CACHE BOOL "") - set(RUNTIMES_${target}_LIBCXXABI_ENABLE_STATIC_UNWINDER True CACHE BOOL "") - set(RUNTIMES_${target}_LIBCXXABI_USE_LLVM_UNWINDER True CACHE BOOL "") - - # libcxx. - set(RUNTIMES_${target}_LIBCXX_USE_COMPILER_RT True CACHE BOOL "") - set(RUNTIMES_${target}_LIBCXX_CXX_ABI libcxxabi CACHE STRING "") - set(RUNTIMES_${target}_LIBCXX_ENABLE_STATIC_ABI_LIBRARY True CACHE BOOL "") - - # libopenmp. - set(RUNTIMES_${target}_LIBOMP_TSAN_SUPPORT False CACHE BOOL "") - set(RUNTIMES_${target}_OPENMP_ENABLE_LIBOMPTARGET True CACHE BOOL "") - set(RUNTIMES_${target}_OPENMP_ENABLE_OMPT_TOOLS False CACHE BOOL "") - - # FIXME We only actually want this for compiler-rt.... - # set(RUNTIMES_${target}_CMAKE_CXX_FLAGS "-nostdlib++" CACHE STRING "") - # set(RUNTIMES_${target}_CMAKE_C_FLAGS "-nostdlib" CACHE STRING "") -endforeach() -set(LLVM_BUILTIN_TARGETS "${BUILTIN_TARGETS}" CACHE STRING "") -set(LLVM_RUNTIME_TARGETS "${RUNTIME_TARGETS}" CACHE STRING "") - -# OpenMP (target specific). -# set(RUNTIMES_${VE_TARGET}_LIBOMP_ARCH "ve" CACHE STRING "") -# set(RUNTIMES_${VH_TARGET}_LIBOMP_ARCH "x86_64" CACHE STRING "") - -# Point to libunwind.so install location.. -# set(VH_EXTRA_LIB_DIR "${CMAKE_CURRENT_BINARY_DIR}/lib/x86_64-unknown-linux-gnu/c++") -# set(VE_EXTRA_LIB_DIR "${CMAKE_CURRENT_BINARY_DIR}/lib/ve-linux/c++") - -# VH configuration -# set(RUNTIMES_${VH_TARGET}_CMAKE_C_FLAGS "-march=native" CACHE STRING "") -# set(RUNTIMES_${VH_TARGET}_CMAKE_CXX_FLAGS "-march=native" CACHE STRING "") -# set(RUNTIMES_${VH_TARGET}_CMAKE_ASM_FLAGS "-march=native" CACHE STRING "") - -# VE configuration -# Stage 2. -# set(RUNTIMES_${VE_TARGET}_CMAKE_C_FLAGS "-L${VE_EXTRA_LIB_DIR}" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_CMAKE_CXX_FLAGS "-L${VE_EXTRA_LIB_DIR}" CACHE STRING "") - - -# Stage 1. -# libcxx,libcxxabi, etc not available yet - -# set(RUNTIMES_${VE_TARGET}_COMPILER_RT_CMAKE_CXX_FLAGS "-nostdlib++" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_COMPILER_RT_CMAKE_C_FLAGS "-nostdlib++" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBUNWIND_CMAKE_CXX_FLAGS "-nostdlib" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBUNWIND_CMAKE_C_FLAGS "-nostdlib" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBCXXABI_CMAKE_CXX_FLAGS "-nostdlib++" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBCXXABI_CMAKE_C_FLAGS "-nostdlib" CACHE STRING "") -# set(RUNTIMES_${VE_TARGET}_LIBCXX_CMAKE_CXX_FLAGS "--stdlib -nostdlib++" CACHE STRING "") # FIXME link rtlib but not stdlib++.. -# set(RUNTIMES_${VE_TARGET}_CMAKE_ASM_FLAGS "--target=${VE_TARGET}" CACHE STRING "") - -# DEBUGGING: `libunwind.so` getting build but not found in feature test macros.. -# set(RUNTIMES_${VH_TARGET}_CMAKE_EXE_LINKER_FLAGS "-L${VH_EXTRA_LIB_DIR}") -# set(RUNTIMES_${VE_TARGET}_CMAKE_EXE_LINKER_FLAGS "-L${VE_EXTRA_LIB_DIR}") diff --git a/clang/cmake/modules/FindNECAURORA_LIBELF.cmake b/clang/cmake/modules/FindNECAURORA_LIBELF.cmake new file mode 100644 index 000000000000..f6b40f68c132 --- /dev/null +++ b/clang/cmake/modules/FindNECAURORA_LIBELF.cmake @@ -0,0 +1,47 @@ +# +#//===----------------------------------------------------------------------===// +#// +#// The LLVM Compiler Infrastructure +#// +#// This file is dual licensed under the MIT and the University of Illinois Open +#// Source Licenses. See LICENSE.txt for details. +#// +#//===----------------------------------------------------------------------===// +# + +find_path ( + NECAURORA_LIBELF_INCLUDE_DIR + NAMES + libelf.h + PATHS + /usr/include + /usr/local/include + /opt/local/include + /sw/include + ENV CPATH + PATH_SUFFIXES + libelf) + +find_library ( + NECAURORA_LIBELF_LIBRARIES + NAMES + elf + PATHS + /usr/lib + /usr/local/lib + /opt/local/lib + /sw/lib + ENV LIBRARY_PATH + ENV LD_LIBRARY_PATH) + +include(FindPackageHandleStandardArgs) +FIND_PACKAGE_HANDLE_STANDARD_ARGS( + NECAURORA_LIBELF + DEFAULT_MSG + NECAURORA_LIBELF_LIBRARIES + NECAURORA_LIBELF_INCLUDE_DIR) + +mark_as_advanced( + NECAURORA_LIBELF_INCLUDE_DIR + NECAURORA_LIBELF_LIBRARIES) + diff --git a/clang/include/clang/AST/DeclBase.h b/clang/include/clang/AST/DeclBase.h index a89f776248c1..6b7b96763f26 100644 --- a/clang/include/clang/AST/DeclBase.h +++ b/clang/include/clang/AST/DeclBase.h @@ -54,6 +54,7 @@ class Module; class NamedDecl; class ObjCContainerDecl; class ObjCMethodDecl; +class PrinterHelper; struct PrintingPolicy; class RecordDecl; class SourceManager; @@ -1171,7 +1172,8 @@ class alignas(8) Decl { void print(raw_ostream &Out, unsigned Indentation = 0, bool PrintInstantiation = false) const; void print(raw_ostream &Out, const PrintingPolicy &Policy, - unsigned Indentation = 0, bool PrintInstantiation = false) const; + unsigned Indentation = 0, bool PrintInstantiation = false, + PrinterHelper *StmtHelper=nullptr) const; static void printGroup(Decl** Begin, unsigned NumDecls, raw_ostream &Out, const PrintingPolicy &Policy, unsigned Indentation = 0); diff --git a/clang/include/clang/Driver/Options.td b/clang/include/clang/Driver/Options.td index 86aa47dae782..b1d8a5fb095d 100644 --- a/clang/include/clang/Driver/Options.td +++ b/clang/include/clang/Driver/Options.td @@ -2457,6 +2457,8 @@ def fopenmp_cuda_force_full_runtime : Flag<["-"], "fopenmp-cuda-force-full-runti Flags<[CC1Option, NoArgumentUnused, HelpHidden]>; def fno_openmp_cuda_force_full_runtime : Flag<["-"], "fno-openmp-cuda-force-full-runtime">, Group, Flags<[NoArgumentUnused, HelpHidden]>; +def fopenmp_nec_compiler_EQ : Joined<["-"], "fopenmp-nec-compiler=">, Group, + Flags<[CC1Option, NoArgumentUnused]>, HelpText<"Offloading compiler for NEC SX-Aurora ('clang' [default],'rvclang' or 'ncc')">; def fopenmp_cuda_number_of_sm_EQ : Joined<["-"], "fopenmp-cuda-number-of-sm=">, Group, Flags<[CC1Option, NoArgumentUnused, HelpHidden]>; def fopenmp_cuda_blocks_per_sm_EQ : Joined<["-"], "fopenmp-cuda-blocks-per-sm=">, Group, diff --git a/clang/lib/AST/Decl.cpp b/clang/lib/AST/Decl.cpp index 030da7f55fac..f3d4874b83a8 100644 --- a/clang/lib/AST/Decl.cpp +++ b/clang/lib/AST/Decl.cpp @@ -913,6 +913,16 @@ LinkageComputer::getLVForNamespaceScopeDecl(const NamedDecl *D, if (!isExternallyVisible(LV.getLinkage())) return LinkageInfo(LV.getLinkage(), DefaultVisibility, false); + // FIXME: This is a workaround to have visible globals in `#pragma omp declare target` on VE. + bool VisibleTargetGlobals = + Context.getAuxTargetInfo() && + (Context.getTargetInfo().getTriple().getArch() != + Context.getAuxTargetInfo()->getTriple().getArch()); + + // Mark the symbols as hidden when compiling for the device. + if (!VisibleTargetGlobals && Context.getLangOpts().OpenMP && Context.getLangOpts().OpenMPIsDevice) + LV.mergeVisibility(HiddenVisibility, /*newExplicit=*/false); + return LV; } diff --git a/clang/lib/AST/DeclPrinter.cpp b/clang/lib/AST/DeclPrinter.cpp index c3f1d1544f79..7866eb0120e4 100644 --- a/clang/lib/AST/DeclPrinter.cpp +++ b/clang/lib/AST/DeclPrinter.cpp @@ -31,6 +31,7 @@ namespace { const ASTContext &Context; unsigned Indentation; bool PrintInstantiation; + PrinterHelper *StmtHelper; raw_ostream& Indent() { return Indent(Indentation); } raw_ostream& Indent(unsigned Indentation); @@ -52,9 +53,10 @@ namespace { public: DeclPrinter(raw_ostream &Out, const PrintingPolicy &Policy, const ASTContext &Context, unsigned Indentation = 0, - bool PrintInstantiation = false) + bool PrintInstantiation = false, + PrinterHelper *StmtHelper = nullptr) : Out(Out), Policy(Policy), Context(Context), Indentation(Indentation), - PrintInstantiation(PrintInstantiation) {} + PrintInstantiation(PrintInstantiation), StmtHelper(StmtHelper) {} void VisitDeclContext(DeclContext *DC, bool Indent = true); @@ -127,9 +129,10 @@ void Decl::print(raw_ostream &Out, unsigned Indentation, } void Decl::print(raw_ostream &Out, const PrintingPolicy &Policy, - unsigned Indentation, bool PrintInstantiation) const { + unsigned Indentation, bool PrintInstantiation, + PrinterHelper *StmtHelper) const { DeclPrinter Printer(Out, Policy, getASTContext(), Indentation, - PrintInstantiation); + PrintInstantiation, StmtHelper); Printer.Visit(const_cast(this)); } @@ -347,7 +350,7 @@ void DeclPrinter::PrintConstructorInitializers(CXXConstructorDecl *CDecl, SimpleInit = Init; if (SimpleInit) - SimpleInit->printPretty(Out, nullptr, Policy, Indentation, "\n", + SimpleInit->printPretty(Out, StmtHelper, Policy, Indentation, "\n", &Context); else { for (unsigned I = 0; I != NumArgs; ++I) { @@ -357,7 +360,7 @@ void DeclPrinter::PrintConstructorInitializers(CXXConstructorDecl *CDecl, if (I) Out << ", "; - Args[I]->printPretty(Out, nullptr, Policy, Indentation, "\n", + Args[I]->printPretty(Out, StmtHelper, Policy, Indentation, "\n", &Context); } } @@ -571,7 +574,7 @@ void DeclPrinter::VisitEnumConstantDecl(EnumConstantDecl *D) { prettyPrintAttributes(D); if (Expr *Init = D->getInitExpr()) { Out << " = "; - Init->printPretty(Out, nullptr, Policy, Indentation, "\n", &Context); + Init->printPretty(Out, StmtHelper, Policy, Indentation, "\n", &Context); } } @@ -784,7 +787,7 @@ void DeclPrinter::VisitFunctionDecl(FunctionDecl *D) { } if (D->getBody()) - D->getBody()->printPrettyControlled(Out, nullptr, SubPolicy, Indentation, "\n", + D->getBody()->printPretty(Out, StmtHelper, SubPolicy, Indentation, "\n", &Context); } else { if (!Policy.TerseOutput && isa(*D)) @@ -830,7 +833,7 @@ void DeclPrinter::VisitFieldDecl(FieldDecl *D) { if (D->isBitField()) { Out << " : "; - D->getBitWidth()->printPretty(Out, nullptr, Policy, Indentation, "\n", + D->getBitWidth()->printPretty(Out, StmtHelper, Policy, Indentation, "\n", &Context); } @@ -840,7 +843,7 @@ void DeclPrinter::VisitFieldDecl(FieldDecl *D) { Out << " "; else Out << " = "; - Init->printPretty(Out, nullptr, Policy, Indentation, "\n", &Context); + Init->printPretty(Out, StmtHelper, Policy, Indentation, "\n", &Context); } prettyPrintAttributes(D); } @@ -908,7 +911,7 @@ void DeclPrinter::VisitVarDecl(VarDecl *D) { PrintingPolicy SubPolicy(Policy); SubPolicy.SuppressSpecifiers = false; SubPolicy.IncludeTagDefinition = false; - Init->printPretty(Out, nullptr, SubPolicy, Indentation, "\n", &Context); + Init->printPretty(Out, StmtHelper, SubPolicy, Indentation, "\n", &Context); if ((D->getInitStyle() == VarDecl::CallInit) && !isa(Init)) Out << ")"; } @@ -922,7 +925,7 @@ void DeclPrinter::VisitParmVarDecl(ParmVarDecl *D) { void DeclPrinter::VisitFileScopeAsmDecl(FileScopeAsmDecl *D) { Out << "__asm ("; - D->getAsmString()->printPretty(Out, nullptr, Policy, Indentation, "\n", + D->getAsmString()->printPretty(Out, StmtHelper, Policy, Indentation, "\n", &Context); Out << ")"; } @@ -938,7 +941,7 @@ void DeclPrinter::VisitStaticAssertDecl(StaticAssertDecl *D) { &Context); if (StringLiteral *SL = D->getMessage()) { Out << ", "; - SL->printPretty(Out, nullptr, Policy, Indentation, "\n", &Context); + SL->printPretty(Out, StmtHelper, Policy, Indentation, "\n", &Context); } Out << ")"; } @@ -1304,7 +1307,7 @@ void DeclPrinter::VisitObjCMethodDecl(ObjCMethodDecl *OMD) { if (OMD->getBody() && !Policy.TerseOutput) { Out << ' '; - OMD->getBody()->printPretty(Out, nullptr, Policy, Indentation, "\n", + OMD->getBody()->printPretty(Out, StmtHelper, Policy, Indentation, "\n", &Context); } else if (Policy.PolishForDeclaration) @@ -1690,7 +1693,7 @@ void DeclPrinter::VisitOMPDeclareReductionDecl(OMPDeclareReductionDecl *D) { Out << " : "; D->getType().print(Out, Policy); Out << " : "; - D->getCombiner()->printPretty(Out, nullptr, Policy, 0, "\n", &Context); + D->getCombiner()->printPretty(Out, StmtHelper, Policy, 0, "\n", &Context); Out << ")"; if (auto *Init = D->getInitializer()) { Out << " initializer("; @@ -1704,7 +1707,7 @@ void DeclPrinter::VisitOMPDeclareReductionDecl(OMPDeclareReductionDecl *D) { case OMPDeclareReductionDecl::CallInit: break; } - Init->printPretty(Out, nullptr, Policy, 0, "\n", &Context); + Init->printPretty(Out, StmtHelper, Policy, 0, "\n", &Context); if (D->getInitializerKind() == OMPDeclareReductionDecl::DirectInit) Out << ")"; Out << ")"; @@ -1732,7 +1735,7 @@ void DeclPrinter::VisitOMPDeclareMapperDecl(OMPDeclareMapperDecl *D) { } void DeclPrinter::VisitOMPCapturedExprDecl(OMPCapturedExprDecl *D) { - D->getInit()->printPretty(Out, nullptr, Policy, Indentation, "\n", &Context); + D->getInit()->printPretty(Out, StmtHelper, Policy, Indentation, "\n", &Context); } void DeclPrinter::VisitTemplateTypeParmDecl(const TemplateTypeParmDecl *TTP) { diff --git a/clang/lib/CodeGen/CGOpenMPRuntime.cpp b/clang/lib/CodeGen/CGOpenMPRuntime.cpp index 0d611c2e343d..b1dcb144b24b 100644 --- a/clang/lib/CodeGen/CGOpenMPRuntime.cpp +++ b/clang/lib/CodeGen/CGOpenMPRuntime.cpp @@ -11632,6 +11632,59 @@ emitX86DeclareSimdFunction(const FunctionDecl *FD, llvm::Function *Fn, } } +static void +emitVEDeclareSimdFunction(const FunctionDecl *FD, llvm::Function *Fn, + const llvm::APSInt &VLENVal, + ArrayRef ParamAttrs, + OMPDeclareSimdDeclAttr::BranchStateTy State) { + struct ISADataTy { + char ISA; + unsigned VecRegSize; + }; + uint64_t VectorWidth = VLENVal > 0 ? VLENVal.getZExtValue() : 256; + llvm::SmallVector Masked; + switch (State) { + case OMPDeclareSimdDeclAttr::BS_Undefined: + Masked.push_back('N'); + Masked.push_back('M'); + break; + case OMPDeclareSimdDeclAttr::BS_Notinbranch: + Masked.push_back('N'); + break; + case OMPDeclareSimdDeclAttr::BS_Inbranch: + Masked.push_back('M'); + break; + } + for (char Mask : Masked) { + SmallString<256> Buffer; + llvm::raw_svector_ostream Out(Buffer); + char VECode = 'v'; + Out << "_ZGV" << VECode << Mask << VectorWidth; + for (const ParamAttrTy &ParamAttr : ParamAttrs) { + switch (ParamAttr.Kind){ + case LinearWithVarStride: + Out << 's' << ParamAttr.StrideOrArg; + break; + case Linear: + Out << 'l'; + if (ParamAttr.StrideOrArg != 1) + Out << ParamAttr.StrideOrArg; + break; + case Uniform: + Out << 'u'; + break; + case Vector: + Out << 'v'; + break; + } + if (!!ParamAttr.Alignment) + Out << 'a' << ParamAttr.Alignment; + } + Out << '_' << Fn->getName(); + Fn->addFnAttr(Out.str()); + } +} + // This are the Functions that are needed to mangle the name of the // vector functions generated by the compiler, according to the rules // defined in the "Vector Function ABI specifications for AArch64", @@ -12051,6 +12104,8 @@ void CGOpenMPRuntime::emitDeclareSimdFunction(const FunctionDecl *FD, if (CGM.getTarget().hasFeature("neon")) emitAArch64DeclareSimdFunction(CGM, FD, VLEN, ParamAttrs, State, MangledName, 'n', 128, Fn, ExprLoc); + } else if (CGM.getTriple().getArch() == llvm::Triple::ve) { + emitVEDeclareSimdFunction(FD, Fn, VLENVal, ParamAttrs, State); } } FD = FD->getPreviousDecl(); diff --git a/clang/lib/Driver/CMakeLists.txt b/clang/lib/Driver/CMakeLists.txt index 78e8fd185284..206799541dd1 100644 --- a/clang/lib/Driver/CMakeLists.txt +++ b/clang/lib/Driver/CMakeLists.txt @@ -66,6 +66,7 @@ add_clang_library(clangDriver ToolChains/MSVC.cpp ToolChains/Myriad.cpp ToolChains/NaCl.cpp + ToolChains/NECAuroraOffload.cpp ToolChains/NetBSD.cpp ToolChains/OpenBSD.cpp ToolChains/PS4CPU.cpp diff --git a/clang/lib/Driver/Compilation.cpp b/clang/lib/Driver/Compilation.cpp index 67d941c6c2ab..0d931a8398c9 100644 --- a/clang/lib/Driver/Compilation.cpp +++ b/clang/lib/Driver/Compilation.cpp @@ -69,7 +69,7 @@ Compilation::getArgsForToolChain(const ToolChain *TC, StringRef BoundArch, SmallVector AllocatedArgs; DerivedArgList *OpenMPArgs = nullptr; // Translate OpenMP toolchain arguments provided via the -Xopenmp-target flags. - if (DeviceOffloadKind == Action::OFK_OpenMP) { + if (DeviceOffloadKind == Action::OFK_OpenMP && TC->getArch() != llvm::Triple::aurora) { const ToolChain *HostTC = getSingleOffloadToolChain(); bool SameTripleAsHost = (TC->getTriple() == HostTC->getTriple()); OpenMPArgs = TC->TranslateOpenMPTargetArgs( diff --git a/clang/lib/Driver/Driver.cpp b/clang/lib/Driver/Driver.cpp index 0ffedf2645af..4d4038e90ce5 100644 --- a/clang/lib/Driver/Driver.cpp +++ b/clang/lib/Driver/Driver.cpp @@ -37,6 +37,7 @@ #include "ToolChains/MipsLinux.h" #include "ToolChains/Myriad.h" #include "ToolChains/NaCl.h" +#include "ToolChains/NECAuroraOffload.h" #include "ToolChains/NetBSD.h" #include "ToolChains/OpenBSD.h" #include "ToolChains/PPCFreeBSD.h" @@ -806,10 +807,11 @@ void Driver::CreateOffloadingDeviceToolChains(Compilation &C, std::string NormalizedName = TT.normalize(); // Always use the 've-linux' triple for OpenMP offloading - // FIXME: In clean code, ToolChains would do this normalization - // themselves - if (TT.getArch() == llvm::Triple::ve) - TT.setOS(llvm::Triple::Linux); + // FIXME: In clean code, ToolChains would do this normalization themselves + if (TT.getArch() == llvm::Triple::ve) { + TT.setVendor(llvm::Triple::UnknownVendor); + TT.setOS(llvm::Triple::Linux); + } // Make sure we don't have a duplicate triple. auto Duplicate = FoundNormalizedTriples.find(NormalizedName); @@ -828,9 +830,21 @@ void Driver::CreateOffloadingDeviceToolChains(Compilation &C, Diag(clang::diag::err_drv_invalid_omp_target) << Val; else { const ToolChain *TC; + //MR_MARKER: TODO: use Arch + OS (not Environment) + if (TT.getArch() == llvm::Triple::aurora) { + const ToolChain *HostTC = + C.getSingleOffloadToolChain(); + assert(HostTC && "Host toolchain should be always defined."); + auto &AuroraTC = + ToolChains[TT.str() + "/" + HostTC->getTriple().normalize()]; + if (!AuroraTC) + AuroraTC = std::make_unique( + *this, TT, *HostTC, C.getInputArgs()); + TC = AuroraTC.get(); + } // Device toolchains have to be selected differently. They pair host // and device in their implementation. - if (TT.isNVPTX() || TT.isAMDGCN()) { + else if (TT.isNVPTX() || TT.isAMDGCN()) { const ToolChain *HostTC = C.getSingleOffloadToolChain(); assert(HostTC && "Host toolchain should be always defined."); diff --git a/clang/lib/Driver/ToolChains/Arch/VE.cpp b/clang/lib/Driver/ToolChains/Arch/VE.cpp index 2411346dc777..ba81dde55262 100644 --- a/clang/lib/Driver/ToolChains/Arch/VE.cpp +++ b/clang/lib/Driver/ToolChains/Arch/VE.cpp @@ -57,45 +57,50 @@ void ve::getVETargetFeatures(const Driver &D, const ArgList &Args, if (FloatABI == ve::FloatABI::Soft) Features.push_back("+soft-float"); - // Defaults. - bool EnableVPU = true; - bool EnablePacked = true; + // Optional Clang -ve-* flags override the LLVM target defaults. + Optional EnableVPU; + Optional EnablePacked; bool EnableSIMD = false; // Whether to enable v256 VPU registers and isel. - if (auto *A = Args.getLastArg(options::OPT_mvevpu, options::OPT_mno_vevpu)) { - if (A->getOption().matches(options::OPT_mno_vevpu)) - EnableVPU = false; - } + if (auto *A = Args.getLastArg(options::OPT_mvevpu, options::OPT_mno_vevpu)) + EnableVPU = A->getOption().matches(options::OPT_mvevpu); // Whether to enable v512 VPU registers and isel. if (auto *A = - Args.getLastArg(options::OPT_mvepacked, options::OPT_mno_vepacked)) { - if (A->getOption().matches(options::OPT_mno_vepacked)) - EnablePacked = false; - } + Args.getLastArg(options::OPT_mvepacked, options::OPT_mno_vepacked)) + EnablePacked = A->getOption().matches(options::OPT_mvepacked); - // Whether to enable fixed-SIMD patterns + // Whether to enable legacy fixed-SIMD patterns. if (auto *A = Args.getLastArg(options::OPT_mvesimd, options::OPT_mno_vesimd)) { - if (A->getOption().matches(options::OPT_mvesimd)) { - EnableSIMD = true; - EnableVPU = false; - EnablePacked = false; - } + EnableSIMD = A->getOption().matches(options::OPT_mvesimd); } - // Fixed SIMD + // Fixed SIMD. + // Disable VVP ISel. if (EnableSIMD) { - Features.push_back("-vpu"); - Features.push_back("-packed"); Features.push_back("+simd"); - return; + EnableVPU = false; + EnablePacked = false; } - // VVP - if (EnableVPU) - Features.push_back("+vpu"); - if (EnableVPU && EnablePacked) - Features.push_back("+packed"); + // VVP ISel. + // Turning off VPU implies no packed mode. + if (EnableVPU) { + if (*EnableVPU) + Features.push_back("+vpu"); + else { + Features.push_back("-vpu"); + EnablePacked = false; + } + } + + // VVP Packed-register ISel. + if (EnablePacked) { + if (*EnablePacked) + Features.push_back("+packed"); + else + Features.push_back("-packed"); + } } diff --git a/clang/lib/Driver/ToolChains/NECAuroraOffload.cpp b/clang/lib/Driver/ToolChains/NECAuroraOffload.cpp new file mode 100644 index 000000000000..407ef0ad259e --- /dev/null +++ b/clang/lib/Driver/ToolChains/NECAuroraOffload.cpp @@ -0,0 +1,208 @@ +#include "NECAuroraOffload.h" +#include "CommonArgs.h" +#include "clang/Driver/Compilation.h" +#include "clang/Driver/Driver.h" +#include "clang/Driver/DriverDiagnostic.h" +#include "clang/Driver/Options.h" +#include "llvm/Option/ArgList.h" +#include + +using namespace clang; +using namespace clang::driver; +using namespace clang::driver::tools; +using namespace llvm::opt; + +void necauroratools::Common::ConstructJob(Compilation &C, const JobAction &JA, + const InputInfo &Output, + const InputInfoList &Inputs, + const llvm::opt::ArgList &Args, + const char *LinkingOutput) const { + ArgStringList CmdArgs; + std::vector PPargs; + std::vector XOTargs; + + // We need to pass the input source, one file at a time, as first argument to + // the compiler wrapper. + // We just hope that the we get only one source file from clang and that it's + // the first input + for (const auto &II : Inputs) { + // Don't try to pass LLVM or AST inputs to a generic compiler. + // We get this info anyway because we are an offload compiler, so + // we just ignore it + if (types::isLLVMIR(II.getType())) + continue; + else if (II.getType() == types::TY_AST) + continue; + else if (II.getType() == types::TY_ModuleFile) + continue; + + if (II.isFilename()) + CmdArgs.push_back(II.getFilename()); + else { + const Arg &A = II.getInputArg(); + + // Don't render as input, we need ncc/gcc to do the translations. + A.render(Args, CmdArgs); + } + } + + // Uses the default specified in the sotoc offload wrapper (tools/) + const char* compilerName = NULL; + + for (const auto &A : Args) { + if (A->getOption().getKind() != Option::InputClass && + !A->getOption().hasFlag(options::NoXarchOption) && + !A->getOption().hasFlag(options::LinkerInput)) { + + // Don't forward any -g arguments to assembly steps. + if (isa(JA) && + A->getOption().matches(options::OPT_g_Group)) + continue; + + // Don't forward any -W arguments to assembly and link steps. + if ((isa(JA) || isa(JA)) && + A->getOption().matches(options::OPT_W_Group)) + continue; + + // Don't forward -fopenmp-targets + if (A->getOption().matches(options::OPT_fopenmp_targets_EQ)) { + continue; + } + + // Handle Preprocessor Args seperatly + if (A->getOption().matches(options::OPT_Preprocessor_Group)) { + PPargs.push_back(A); + continue; + } + + if (A->getOption().matches(options::OPT_fopenmp_nec_compiler_EQ)) { + const char *RawTxt = A->getNumValues() != 1 ? nullptr : A->getValue(0); + if (RawTxt) { + compilerName = RawTxt; + } + continue; + } + + // Mark and claim Xopenmp-target + if (A->getOption().getName() == "Xopenmp-target") { + XOTargs.push_back(A); + A->claim(); + continue; + } + + A->render(Args, CmdArgs); + } + } + + for (auto &A : XOTargs) { + std::string mark = "XOT"; + for (uint i = 0; i < A->getNumValues(); ++i) { + std::string arg = mark; + for (const char* c = A->getValue(i); *c; c++) { + if (strncmp(c, " ", 1) != 0) { + arg.push_back(*c); + } else { + CmdArgs.push_back(Args.MakeArgString(arg)); + arg = mark; + } + } + CmdArgs.push_back(Args.MakeArgString(arg)); + } + } + + for (auto &A : PPargs) { + for (uint i = 0; i < A->getNumValues(); ++i) { + CmdArgs.push_back(Args.MakeArgString( + ("-" + std::string(A->getOption().getName()) + A->getValue(i)) + .c_str())); + } + } + + + RenderExtraToolArgs(JA, CmdArgs); + + // Keep this in sync with the compiler option in necaurora-ofld-wrapper.cpp (FIXME) + if (compilerName) { + CmdArgs.push_back("--nec-target-compiler"); + CmdArgs.push_back(compilerName); + } + + if (Output.isFilename()) { + CmdArgs.push_back("-o"); + CmdArgs.push_back(Output.getFilename()); + } else { + assert(Output.isNothing() && "Unexpected output"); + CmdArgs.push_back("-fsyntax-only"); + } + + const char *Exec = + Args.MakeArgString(getToolChain().GetProgramPath(ToolName)); + C.addCommand(std::make_unique(JA, *this, + ResponseFileSupport::AtFileCurCP(), + Exec, CmdArgs, Inputs)); +} + +void necauroratools::Common::anchor() {} + +void necauroratools::Linker::RenderExtraToolArgs( + const JobAction &JA, llvm::opt::ArgStringList &CmdArgs) const { + // no extra args, just hope for the best +} + +void necauroratools::OffloadCompilerWrapper::RenderExtraToolArgs( + const JobAction &JA, llvm::opt::ArgStringList &CmdArgs) const { + // the same as for Gnu + const Driver &D = getToolChain().getDriver(); + + switch (JA.getType()) { + // If -flto, etc. are present then make sure not to force assembly output. + case types::TY_LLVM_IR: + case types::TY_LTO_IR: + case types::TY_LLVM_BC: + case types::TY_LTO_BC: + CmdArgs.push_back("-c"); + break; + case types::TY_Object: + CmdArgs.push_back("-c"); + break; + case types::TY_PP_C: + CmdArgs.push_back("-E"); + break; + case types::TY_PP_Asm: + CmdArgs.push_back("-S"); + break; + case types::TY_Nothing: + CmdArgs.push_back("-fsyntax-only"); + break; + default: + D.Diag(diag::err_drv_invalid_gcc_output_type) << getTypeName(JA.getType()); + } +} + +void necauroratools::Assembler::RenderExtraToolArgs( + const JobAction &JA, llvm::opt::ArgStringList &CmdArgs) const { + CmdArgs.push_back("-S"); +} + +Tool * +toolchains::NECAuroraOffloadToolChain::SelectTool(const JobAction &JA) const { + switch (JA.getKind()) { + case Action::PreprocessJobClass: + case Action::CompileJobClass: + if (!Compiler) + Compiler.reset(new necauroratools::OffloadCompilerWrapper(*this)); + return Compiler.get(); + default: + return getTool(JA.getKind()); + } +} + +Tool *toolchains::NECAuroraOffloadToolChain::buildLinker() const { + return new necauroratools::Linker(*this); +} + +Tool *toolchains::NECAuroraOffloadToolChain::buildAssembler() const { + return new necauroratools::Assembler(*this); +} + +void toolchains::NECAuroraOffloadToolChain::anchor() {} diff --git a/clang/lib/Driver/ToolChains/NECAuroraOffload.h b/clang/lib/Driver/ToolChains/NECAuroraOffload.h new file mode 100644 index 000000000000..3c7a04575130 --- /dev/null +++ b/clang/lib/Driver/ToolChains/NECAuroraOffload.h @@ -0,0 +1,123 @@ +#ifndef LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_NECAURORAOFFLOAD_H +#define LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_NECAURORAOFFLOAD_H + +#include "Gnu.h" +#include "Linux.h" +#include "clang/Driver/Tool.h" +#include "clang/Driver/ToolChain.h" + +namespace clang { +namespace driver { + +namespace tools { +namespace necauroratools { + +// we will use ncc (and for testing purposes gcc) for everything, +// so, like gcc, we can create a common base class +class LLVM_LIBRARY_VISIBILITY Common : public Tool { + virtual void anchor(); + +public: + Common(const char *Name, const char *ShortName, const ToolChain &TC) + : Tool(Name, ShortName, TC), ToolName("necaurora-ofld-wrapper") {} + + bool hasIntegratedAssembler() const override { return true; } + + void ConstructJob(Compilation &C, const JobAction &JA, + const InputInfo &Output, const InputInfoList &Inputs, + const llvm::opt::ArgList &Args, + const char *LinkingOutput) const override; + + // Extra flags for the particular tool + virtual void RenderExtraToolArgs(const JobAction &JA, + llvm::opt::ArgStringList &CmdArgs) const = 0; + +private: + // the name of the tool actually used + // at the end we use ncc (or gcc) for everything, but for the compile step we + // need to transform the source code first. We use a wrapper which takes the + // code, put it into the source transformation tool and then pipe it to the + // real compiler. + const char *ToolName; +}; + +class LLVM_LIBRARY_VISIBILITY Linker : public Common { +public: + Linker(const ToolChain &TC) + : Common("NECAurora::Linker", "Linker (via ncc)", TC) {} + + bool hasIntegratedCPP() const override { return false; } + bool isLinkJob() const override { return true; } + + void RenderExtraToolArgs(const JobAction &JA, + llvm::opt::ArgStringList &CmdArgs) const override; +}; + +class LLVM_LIBRARY_VISIBILITY OffloadCompilerWrapper : public Common { +public: + OffloadCompilerWrapper(const ToolChain &TC) + : Common("NECAurora::OffloadCompiler", "Offload Compiler (via ncc)", TC) { + } + + void RenderExtraToolArgs(const JobAction &JA, + llvm::opt::ArgStringList &CmdArgs) const override; + + bool hasIntegratedCPP() const override { return true; } + + bool hasIntegratedAssembler() const override { return true; } +}; + +class LLVM_LIBRARY_VISIBILITY Assembler : public Common { +public: + Assembler(const ToolChain &TC) + : Common("NECAurora::Assembler", "Assembler (via ncc)", TC) {} + + bool hasIntegratedCPP() const override { return false; } //? + + void RenderExtraToolArgs(const JobAction &JA, + llvm::opt::ArgStringList &CmdArgs) const override; +}; + +} // namespace necauroratools +} // namespace tools + +namespace toolchains { + +class LLVM_LIBRARY_VISIBILITY NECAuroraOffloadToolChain : public Generic_ELF { + virtual void anchor(); + +public: + NECAuroraOffloadToolChain(const Driver &D, const llvm::Triple &Triple, + const ToolChain &HostTC, + const llvm::opt::ArgList &Args) + : Generic_ELF(D, Triple, Args), HostTC(HostTC) {} + + const llvm::Triple *getAuxTriple() const override { + return &HostTC.getTriple(); + } + + Tool *SelectTool(const JobAction &JA) const override; + + bool useIntegratedAs() const override { return true; } + bool isCrossCompiling() const override { return true; } + bool isPICDefault() const override { return false; } + bool isPICDefaultForced() const override { return false; } + bool SupportsProfiling() const override { return false; } + bool IsMathErrnoDefault() const override { return false; } + + const ToolChain &HostTC; + +private: + mutable std::unique_ptr Compiler; + mutable std::unique_ptr Assembler; + +protected: + Tool *buildLinker() const override; + Tool *buildAssembler() const override; +}; + +} // namespace toolchains +} // namespace driver +} // namespace clang + +#endif // LLVM_CLANG_LIB_DRIVER_TOOLCHAINS_NECAURORAOFFLOAD_H diff --git a/clang/lib/Driver/ToolChains/VEToolchain.cpp b/clang/lib/Driver/ToolChains/VEToolchain.cpp index 7337672bf365..b60a5c7760e5 100644 --- a/clang/lib/Driver/ToolChains/VEToolchain.cpp +++ b/clang/lib/Driver/ToolChains/VEToolchain.cpp @@ -16,6 +16,8 @@ #include "llvm/Support/Path.h" #include // ::getenv +#include "llvm/Support/VirtualFileSystem.h" + using namespace clang::driver; using namespace clang::driver::toolchains; using namespace clang; @@ -64,10 +66,6 @@ Tool *VEToolChain::buildLinker() const { bool VEToolChain::isPICDefault() const { return false; } -bool VEToolChain::isPIEDefault(const llvm::opt::ArgList &Args) const { - return false; -} - bool VEToolChain::isPICDefaultForced() const { return false; } bool VEToolChain::SupportsProfiling() const { return false; } diff --git a/clang/lib/Driver/ToolChains/VEToolchain.h b/clang/lib/Driver/ToolChains/VEToolchain.h index 964b0d0dd8d4..16fad1a76db0 100644 --- a/clang/lib/Driver/ToolChains/VEToolchain.h +++ b/clang/lib/Driver/ToolChains/VEToolchain.h @@ -28,7 +28,6 @@ class LLVM_LIBRARY_VISIBILITY VEToolChain : public Linux { public: bool IsIntegratedAssemblerDefault() const override { return true; } bool isPICDefault() const override; - bool isPIEDefault(const llvm::opt::ArgList &Args) const override; bool isPICDefaultForced() const override; bool SupportsProfiling() const override; bool hasBlocksRuntime() const override; diff --git a/clang/lib/Frontend/CompilerInvocation.cpp b/clang/lib/Frontend/CompilerInvocation.cpp index f80d1dee3f64..415aad1d5512 100644 --- a/clang/lib/Frontend/CompilerInvocation.cpp +++ b/clang/lib/Frontend/CompilerInvocation.cpp @@ -3237,7 +3237,7 @@ void CompilerInvocation::setLangDefaults(LangOptions &Opts, InputKind IK, // FP contract option is used to allow fuse across statements in frontend // whereas respecting contract flag in backend. Opts.setDefaultFPContractMode(LangOptions::FPM_FastHonorPragmas); - } else if (Opts.CUDA) { + } else if (Opts.CUDA || T.getArch() == llvm::Triple::ve) { // Allow fuse across statements disregarding pragmas. Opts.setDefaultFPContractMode(LangOptions::FPM_Fast); } @@ -3964,7 +3964,8 @@ bool CompilerInvocation::ParseLangArgs(LangOptions &Opts, ArgList &Args, TT.getArch() == llvm::Triple::amdgcn || TT.getArch() == llvm::Triple::x86 || TT.getArch() == llvm::Triple::x86_64 || - TT.getArch() == llvm::Triple::ve)) + TT.getArch() == llvm::Triple::ve || + TT.getArch() == llvm::Triple::aurora)) Diags.Report(diag::err_drv_invalid_omp_target) << A->getValue(i); else if (getArchPtrSize(T) != getArchPtrSize(TT)) Diags.Report(diag::err_drv_incompatible_omp_arch) diff --git a/clang/lib/Sema/SemaExprCXX.cpp b/clang/lib/Sema/SemaExprCXX.cpp index 0608cf71c6bf..bcefb3f728d4 100644 --- a/clang/lib/Sema/SemaExprCXX.cpp +++ b/clang/lib/Sema/SemaExprCXX.cpp @@ -6049,12 +6049,14 @@ static bool ConvertForConditional(Sema &Self, ExprResult &E, QualType T) { // extension. static bool isValidVectorForConditionalCondition(ASTContext &Ctx, QualType CondTy) { - if (!CondTy->isVectorType() && !CondTy->isExtVectorType()) + const auto *VecVT = CondTy->getAs(); + if (!VecVT || (VecVT->isExtVectorType() && !VecVT->isExtVectorBoolType())) return false; const QualType EltTy = cast(CondTy.getCanonicalType())->getElementType(); + assert(!EltTy->isEnumeralType() && "Vectors cant be enum types"); - return EltTy->isIntegralType(Ctx); + return EltTy->isIntegralType(Ctx) || EltTy->isBooleanType(); } QualType Sema::CheckVectorConditionalTypes(ExprResult &Cond, ExprResult &LHS, diff --git a/clang/test/Driver/Inputs/basic_cross_linux_tree/usr/x86_64-unknown-linux-gnu/bin/ld.lld b/clang/test/Driver/Inputs/basic_cross_linux_tree/usr/x86_64-unknown-linux-gnu/bin/ld.lld old mode 100755 new mode 100644 diff --git a/clang/test/Driver/ve-features.c b/clang/test/Driver/ve-features.c index f74296c228af..14d45128fac4 100644 --- a/clang/test/Driver/ve-features.c +++ b/clang/test/Driver/ve-features.c @@ -6,8 +6,8 @@ // RUN: %clang -target ve-unknown-linux -### %s 2>&1 | FileCheck %s -check-prefix=DEFAULT // VEVPU: "-target-feature" "+vpu" -// NO-VEVPU-NOT: "-target-feature" "+vpu" +// NO-VEVPU: "-target-feature" "-vpu" // VEPACKED: "-target-feature" "+packed" -// NO-VEPACKED-NOT: "-target-feature" "+packed" -// VESIMD: "-target-feature" "-vpu" "-target-feature" "-packed" "-target-feature" "+simd" -// DEFAULT: "-target-feature" "+vpu" "-target-feature" "+packed" +// NO-VEPACKED: "-target-feature" "-packed" +// VESIMD: "-target-feature" "+simd" "-target-feature" "-vpu" "-target-feature" "-packed" +// DEFAULT-NOT: "-target-feature" diff --git a/clang/tools/CMakeLists.txt b/clang/tools/CMakeLists.txt index 2ccd4bc5f0a1..145a834d3119 100644 --- a/clang/tools/CMakeLists.txt +++ b/clang/tools/CMakeLists.txt @@ -13,6 +13,9 @@ add_clang_subdirectory(clang-linker-wrapper) add_clang_subdirectory(clang-offload-bundler) add_clang_subdirectory(clang-offload-wrapper) add_clang_subdirectory(clang-scan-deps) +add_clang_subdirectory(vars-script) +add_clang_subdirectory(nec-aurora-build) +add_clang_subdirectory(sotoc) add_clang_subdirectory(clang-repl) add_clang_subdirectory(clang-pseudo) add_clang_subdirectory(driver-rvclang) diff --git a/clang/tools/driver-rvclang/CMakeLists.txt b/clang/tools/driver-rvclang/CMakeLists.txt deleted file mode 100644 index 30de541e739a..000000000000 --- a/clang/tools/driver-rvclang/CMakeLists.txt +++ /dev/null @@ -1,7 +0,0 @@ -install(PROGRAMS rvclang - DESTINATION bin - COMPONENT driver-rvclang) - -install(PROGRAMS rvclang++ - DESTINATION bin - COMPONENT driver-rvclang) diff --git a/clang/tools/driver-rvclang/rvclang b/clang/tools/driver-rvclang/rvclang deleted file mode 100644 index 7dc39e1ece04..000000000000 --- a/clang/tools/driver-rvclang/rvclang +++ /dev/null @@ -1,7 +0,0 @@ -# !/usr/bin/env bash - -SELF_PATH=$(dirname $(readlink -f $0)) -LIB_PATH=${SELF_PATH}/../lib -FLAGS="-mllvm -rv -Wunused-command-line-argument" - -${SELF_PATH}/clang ${FLAGS} $@ diff --git a/clang/tools/driver-rvclang/rvclang++ b/clang/tools/driver-rvclang/rvclang++ deleted file mode 100644 index 93fc38907ac0..000000000000 --- a/clang/tools/driver-rvclang/rvclang++ +++ /dev/null @@ -1,7 +0,0 @@ -# !/usr/bin/env bash - -SELF_PATH=$(dirname $(readlink -f $0)) -LIB_PATH=${SELF_PATH}/../lib -FLAGS="-mllvm -rv -Wunused-command-line-argument" - -${SELF_PATH}/clang++ ${FLAGS} $@ diff --git a/clang/tools/nec-aurora-build/CMakeLists.txt b/clang/tools/nec-aurora-build/CMakeLists.txt new file mode 100644 index 000000000000..526d2986a6c9 --- /dev/null +++ b/clang/tools/nec-aurora-build/CMakeLists.txt @@ -0,0 +1,113 @@ +if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) + cmake_minimum_required(VERSION 2.8.8) + project("NEC Aurora Offloading Build Wrapper Tools" CXX) +endif() + +# Find NEC target compiler. +find_program(NECAURORA_TARGET_COMPILER_NCC + NAMES + ncc + ncc-3.1.0 + ncc-3.0.8 + ncc-3.0.7 + ncc-3.0.6 + ncc-3.0.4 + ncc-3.0.1 + ncc-2.5.1 + ncc-2.4.1 + ncc-2.3.1 + ncc-2.3.0 + DOC "NEC target compiler." + PATHS + "/opt/nec/ve/bin/" + ENV PATH) +# It is okay if we do not find ncc, we can fallback to Clang or RVCLang and +# will handlle the missing ncc in code. +if (NECAURORA_TARGET_COMPILER_NCC) + set(TARGET_COMPILER_NCC "${NECAURORA_TARGET_COMPILER_NCC}") +else() + set(TARGET_COMPILER_NCC "/opt/nec/ve/bin/ncc") + message(WARNING "- sotoc: Could not find ncc compiler. Defaulting to path ${TARGET_COMPILER_NCC}") +endif() + +# Set Clang and RVClang target compiler variables +set(NECAURORA_TARGET_COMPILER_CLANG + "${CMAKE_INSTALL_PREFIX}/bin/clang" + CACHE + FILEPATH + "Path to clang used as VE target compiler") +set(NECAURORA_TARGET_COMPILER_RVCLANG + "${CMAKE_INSTALL_PREFIX}/bin/rvclang" + CACHE FILEPATH + "Path to rvclang used as VE target compiler") + +set(NECAURORA_DEFAULT_TARGET_COMPILER + "ncc" + CACHE STRING + "Default target compiler for NEC OpenMP target (-fopenmp-nec-compiler=)") +message("- sotoc: Using the default target compiler option \"${NECAURORA_DEFAULT_TARGET_COMPILER}\"" ) + + find_library( + NECAURORA_LIBAVEOVE_STATIC + NAMES + libaveoVE.a + PATHS + /usr/lib + /usr/local/lib + /opt/lcoal/lib + /sw/lib + /opt/nec/ve/lib + ENV LIBRARY_PATH) + +find_library( + NECAURORA_LIBURPCVE_STATIC + NAMES + liburpcVE_omp.a + PATHS + /usr/lib + /usr/local/lib + /opt/lcoal/lib + /sw/lib + /opt/nec/ve/lib + ENV LIBRARY_PATH) + +find_library( + NECAURORA_LIBVEIO + NAMES + libveio.so + PATHS + /usr/lib + /usr/local/lib + /opt/lcoal/lib + /sw/lib + /opt/nec/ve/lib + ENV LIBRARY_PATH) + +# We have all libraries: We can have the wrapper statically link stuff +if(NECAURORA_LIBAVEOVE_STATIC AND NECAURORA_LIBURPCVE_STATIC AND NECAURORA_LIBVEIO) + get_filename_component(LIBVEIO_DIR ${NECAURORA_LIBVEIO} DIRECTORY) + set(STATIC_LIBRARY_PATHS "${NECAURORA_LIBAVEOVE_STATIC}") + set(STATIC_LIBRARY_PATHS "${STATIC_LIBRARY_PATHS} ${NECAURORA_LIBURPCVE_STATIC}") + set(STATIC_LIBRARY_PATHS "${STATIC_LIBRARY_PATHS} -Wl,-rpath,${LIBVEIO_DIR} -lveio") +else() + unset(STATIC_LIBRARY_PATHS) +endif() + +find_package(NECAURORA_LIBELF) +if(NOT NECAURORA_LIBELF_FOUND) + message(FATAL_ERROR "- sotoc: LIBELF not found.") +endif() + +configure_file(config.h.in config.h @ONLY) +include_directories(${CMAKE_CURRENT_BINARY_DIR}) + +add_executable(necaurora-ofld-wrapper + necaurora-ofld-wrapper.cpp + compiler.cpp + linker.cpp + utils.cpp) + +target_link_libraries(necaurora-ofld-wrapper + ${NECAURORA_LIBELF_LIBRARIES}) + +install(TARGETS necaurora-ofld-wrapper DESTINATION bin) diff --git a/clang/tools/nec-aurora-build/compiler.cpp b/clang/tools/nec-aurora-build/compiler.cpp new file mode 100644 index 000000000000..79e45e88466c --- /dev/null +++ b/clang/tools/nec-aurora-build/compiler.cpp @@ -0,0 +1,75 @@ +#include +#include +#include + +#include "necaurora-ofld-wrapper.h" + +int runSourceTransformation(const std::string &InputPath, + const std::string &SotocPath, + std::string &OutputPath, + const std::string &ArgsString) { + std::stringstream CmdLine; + + // find last '/' in string so we can get just the filename + size_t PosLastSlashInPath = InputPath.rfind("/"); + + if (PosLastSlashInPath == InputPath.length()) { + PosLastSlashInPath = 0; + } + + // find last '.' in string so we can get the filename extension + size_t PosLastDotInPath = InputPath.rfind("."); + if (PosLastDotInPath == std::string::npos) { + std::cerr + << "necaurora-ofld-cc1-wrapper: Input file has no file extension (1)" + << " (neeeds to be .c or .cpp or .i)" << std::endl; + return -1; + } + + // Input file name without extension + std::string InputFileNameWE(InputPath, PosLastSlashInPath + 1, + (PosLastDotInPath - (PosLastSlashInPath + 1))); + + std::string InputFileExt(InputPath, PosLastDotInPath); + + if (InputFileExt != ".c" && InputFileExt != ".cpp" && InputFileExt != ".i") { + std::cerr << "necaurora-ofld-cc1-wrapper: Input file has no file extension" + << std::endl; + return -1; + } + + // We create an empty temp file + std::string Content = ""; + std::string TmpFile = writeTmpFile(Content, InputFileNameWE + ".sotoc-transformed", InputFileExt); + if (TmpFile == "") + return -1; + + CmdLine << SotocPath << " " << InputPath << " -- " << ArgsString << " > " + << TmpFile; + + if (Verbose) { + std::cout << " \"" << CmdLine.str() << "\"\n"; + } + + OutputPath = TmpFile; + return system(CmdLine.str().c_str()); +} + +int runTargetCompiler(const std::string &InputPath, const std::string &Args) { + + std::stringstream CmdLine; + + CmdLine << getTargetCompiler() << " -c " << InputPath << " " << Args; + + if (Verbose) { + std::cout << " \"" << CmdLine.str() << "\"" << std::endl; + } + + int ret = system(CmdLine.str().c_str()); + + if (!KeepTransformedFilesDir) { + std::remove(InputPath.c_str()); + } + + return ret; +} diff --git a/clang/tools/nec-aurora-build/config.h.in b/clang/tools/nec-aurora-build/config.h.in new file mode 100644 index 000000000000..5a06f5d13952 --- /dev/null +++ b/clang/tools/nec-aurora-build/config.h.in @@ -0,0 +1,6 @@ +#define DEFAULT_TARGET_COMPILER_OPTION "@NECAURORA_DEFAULT_TARGET_COMPILER@" +#define TARGET_COMPILER_CLANG "@NECAURORA_TARGET_COMPILER_CLANG@" +#define TARGET_COMPILER_RVCLANG "@NECAURORA_TARGET_COMPILER_RVCLANG@" +#cmakedefine TARGET_COMPILER_NCC "@TARGET_COMPILER_NCC@" + +#cmakedefine STATIC_LIBRARY_PATHS "@STATIC_LIBRARY_PATHS@" diff --git a/clang/tools/nec-aurora-build/linker.cpp b/clang/tools/nec-aurora-build/linker.cpp new file mode 100644 index 000000000000..075f51d61139 --- /dev/null +++ b/clang/tools/nec-aurora-build/linker.cpp @@ -0,0 +1,134 @@ +#include "necaurora-ofld-wrapper.h" + +#include +#include +#include +#include +#include +#include +#include +#include + +void getSymsFromELFObj(char *elfObject, std::vector &symbols) { + int fd; + Elf *e; + Elf_Scn *scn = NULL; + size_t shstrndx; + char *name; + GElf_Shdr shdr; + Elf_Data *data; + + if (elf_version(EV_CURRENT) == EV_NONE) { + err(EXIT_FAILURE, "ELF library too old"); + } + + if ((fd = open(elfObject, O_RDONLY, 0)) < 0) { + err(EXIT_FAILURE, "Open %s failed", elfObject); + } + + if ((e = elf_begin(fd, ELF_C_READ, NULL)) == NULL) + errx(EXIT_FAILURE, "elf_begin() failed: %s.", elf_errmsg(-1)); + + if (elf_kind(e) != ELF_K_ELF) + errx(EXIT_FAILURE, "%s is not an ELF object .", elfObject); + + // Retrive section index of the ELF section containing the string table + // of section names. + if (elf_getshdrstrndx(e, &shstrndx) != 0) + errx(EXIT_FAILURE, "elf_getshdrstrndx () failed : %s.", elf_errmsg(-1)); + + // Iterate all sections + while ((scn = elf_nextscn(e, scn)) != NULL) { + if (gelf_getshdr(scn, &shdr) != &shdr) + errx(EXIT_FAILURE, "getshdr() failed : %s.", elf_errmsg(-1)); + + if ((name = elf_strptr(e, shstrndx, shdr.sh_name)) == NULL) + errx(EXIT_FAILURE, "elf_strptr() failed: %s.", elf_errmsg(-1)); + + // We only care about symbols in ".symtab" + if (shdr.sh_type == SHT_SYMTAB) { + data = elf_getdata(scn, NULL); + int symCount = shdr.sh_size / shdr.sh_entsize; + for (int i = 0; i < symCount; i++) { + GElf_Sym sym; + gelf_getsym(data, i, &sym); + + // We need all global functions and global variables in the link table + if (GELF_ST_BIND(sym.st_info) == STB_GLOBAL && + (GELF_ST_TYPE(sym.st_info) == STT_FUNC || + GELF_ST_TYPE(sym.st_info) == STT_OBJECT)) { + char *symName; + + // if the sh_type equals SHT_SYMTAB, then sh_link holds the + // information for the section header index of the associated string + // table. + if ((symName = elf_strptr(e, shdr.sh_link, sym.st_name)) == NULL) + errx(EXIT_FAILURE, "elf_strptr() failed: %s.", elf_errmsg(-1)); + symbols.push_back(symName); + } + } + } + } + + elf_end(e); + close(fd); +} + +// Generates the code which initializes the symbol table for static linking +// and returns the path to the written C file. +std::string generateSymTabCode(const std::vector &symbols) { + std::stringstream out; + out << "#include \n"; + out << "#include \n"; + + for (std::string s : symbols) { + out << "extern unsigned long " << s << ";\n"; + } + + out << "typedef struct { const char *n; void *v; } static_sym_t;\n"; + out << "static_sym_t _veo_static_symtable[] = {\n"; + + for (auto s : symbols) { + out << " { .n = \"" << s << "\", .v = &" << s << " },\n"; + } + out << "{ .n = 0, .v = 0 },\n"; + out << "};\n"; + + return writeTmpFile(out.str(), "veorun", ".c"); +} + +int runStaticLinker(const std::vector &ObjectFiles, + const std::string &Args, const std::string &OutputFile) { +#ifndef STATIC_LIBRARY_PATHS + std::cerr << "necaurora-ofld-wrapper: Static linking not supported" + << std::endl; + return EXIT_FAILURE; +#else + std::stringstream CmdLine; + std::vector SymbolNames; + + for (auto ObjFile : ObjectFiles) { + getSymsFromELFObj((char *)ObjFile, SymbolNames); + } + + std::string SymTabPath = generateSymTabCode(SymbolNames); + + CmdLine << getTargetCompiler() << " "; + for (auto ObjFile: ObjectFiles) { + CmdLine << ObjFile << " "; + } + CmdLine << SymTabPath << " " + << STATIC_LIBRARY_PATHS + << " -lnc++ -fopenmp -o " << OutputFile; + if (Verbose) { + std::cerr << " \"" << CmdLine.str() << "\"" << std::endl; + } + + int ret = std::system(CmdLine.str().c_str()); + + if (!KeepTransformedFilesDir) { + std::remove(SymTabPath.c_str()); + } + return ret; +#endif +} diff --git a/clang/tools/nec-aurora-build/necaurora-ofld-wrapper.cpp b/clang/tools/nec-aurora-build/necaurora-ofld-wrapper.cpp new file mode 100644 index 000000000000..c224436aff63 --- /dev/null +++ b/clang/tools/nec-aurora-build/necaurora-ofld-wrapper.cpp @@ -0,0 +1,243 @@ +//===-- nec-aurora-build/necaurora-ofld-cc1-wrapper.cpp -------------------===// +// +// The LLVM Compiler Infrastructure +// +// This file is distributed under the University of Illinois Open Source +// License. See LICENSE.TXT for details. +// +//===----------------------------------------------------------------------===// +/// +/// \file +/// This file implements a build wrapper for offloading to NEC Aurora TSUABASA. +/// It calls the sotoc to outline the OpenMP target regions and calls the +/// offloading compiler (e.g., ncc). +/// +//===----------------------------------------------------------------------===// + +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include "necaurora-ofld-wrapper.h" + +bool Verbose = false; +const char *KeepTransformedFilesDir; +bool SaveTemps = false; + +enum class ToolMode { + Unknown, + Compiler, + StaticLinker, + Preprocessor, + Passthrough, +}; + +/* + Parse command line arguments and decide which to pass to the device compiler and which to + sotoc. + e.g.: Add defines to sotoc and ncc +*/ + +int parseCmdline(int argc, char **argv, ToolMode &Mode, std::string &SotocPath, + std::string &InputFile, std::string &cArgs, std::string &sArgs, bool &Verbose, + bool &SaveTemps, std::vector &ObjectFiles, + std::string &OutputFile) { + std::stringstream cArgsStream, sArgsStream; + Mode = ToolMode::Unknown; + bool StaticLinkerFlag = false; + bool SharedFlag = false; + bool SaveTempsFlag = false; + bool OFlag = false; + SotocPath = "sotoc"; + InputFile = argv[1]; + if (strcmp(argv[1] + strlen(argv[1]) -2, ".o") == 0) { + ObjectFiles.push_back(argv[1]); + } + + for (int i = 2; i < argc; ++i) { + if (strcmp(argv[i], "--nec-target-compiler") == 0) { + ++i; + if (i == argc) + return EXIT_FAILURE; + int ret = configureTargetCompiler(std::string(argv[i])); + if (ret) return EXIT_FAILURE; // invalid compiler flag! + continue; + } + if (strcmp(argv[i], "-c") == 0) { + if (Mode != ToolMode::Unknown) { + std::cerr << "necaurora-ofld-cc1-wrapper: WARNING: more than one " + << "option \"-c\" or \"-v\" set\n"; + } + Mode = ToolMode::Compiler; + continue; + } else if (strcmp(argv[i], "-E") == 0) { + if (Mode != ToolMode::Unknown) { + std::cerr << "necaurora-ofld-cc1-wrapper: WARNING: more than one " + << "option \"-c\" or \"-v\" set\n"; + } + Mode = ToolMode::Preprocessor; + continue; + } else if (strcmp(argv[i], "-p") == 0) { + ++i; + SotocPath = argv[i]; + continue; + } else if (strcmp(argv[i], "-v") == 0) { + Verbose = true; + continue; + } else if (strcmp(argv[i], "-shared") == 0) { + SharedFlag = true; + continue; + } else if (strcmp(argv[i], "-save-temps") == 0) { + SaveTempsFlag = true; + continue; + } else if (strcmp(argv[i] + strlen(argv[i]) - 2, ".o") == 0) { + cArgsStream << argv[i] << " "; + ObjectFiles.push_back(argv[i]); + continue; + } else if (strcmp(argv[i], "-o") == 0) { + cArgsStream << argv[i] << " "; + OutputFile = std::string(argv[i+1]); + cArgsStream << OutputFile << " "; + i += 2; + continue; + } else if (strcmp(argv[i], "-fopenmp") == 0) { + cArgsStream << argv[i] << " "; + sArgsStream << argv[i] << " "; + continue; + } else if (strncmp(argv[i], "-D", 2) == 0) { + cArgsStream << argv[i] << " "; + sArgsStream << argv[i] << " "; + continue; + // check for Xopenmp-target args and strip marker + } else if (strncmp(argv[i], "XOT", 3) == 0) { + argv[i] = (argv[i]+3); + if (strncmp(argv[i], "-O", 2) == 0) { + OFlag = true; + } else if (strcmp(argv[i], "-Xlinker") == 0 + && strcmp(argv[i+1]+3, "-fopenmp-static") == 0) { + StaticLinkerFlag = true; + } else if (strncmp(argv[i], "--sotoc-path=", strlen("--sotoc-path=")) == + 0) { + SotocPath = argv[i] + strlen("--sotoc-path="); + continue; + } else if (strcmp(argv[i], "-v") == 0) { + Verbose = true; + continue; + } + cArgsStream << argv[i] << " "; + continue; + } else if (strncmp(argv[i], "-O", 2) == 0) { + if (!OFlag) { + cArgsStream << argv[i] << " "; + } + sArgsStream << argv[i] << " "; + continue; + } else { + sArgsStream << argv[i] << " "; + } + } + + if (SaveTempsFlag && !KeepTransformedFilesDir) { + KeepTransformedFilesDir = get_current_dir_name(); + } + + if (Mode == ToolMode::Unknown) { + + if (StaticLinkerFlag) { + Mode = ToolMode::StaticLinker; + } else { + Mode = ToolMode::Passthrough; + if (SharedFlag) { + cArgsStream << "-shared"; + } + } + } + + if (Mode == ToolMode::Passthrough || Mode == ToolMode::StaticLinker) { + sArgs = InputFile + " " + sArgsStream.str(); + cArgs = InputFile + " " + cArgsStream.str(); + } else { + sArgs = sArgsStream.str(); + cArgs = cArgsStream.str(); + } + + return 0; +} + +int runPassthrough(const std::string &Args) { + std::stringstream CmdLine; + CmdLine << getTargetCompiler() << " " << Args; + if (Verbose) { + std::cerr << " \"" << CmdLine.str() << "\"\n"; + } + return std::system(CmdLine.str().c_str()); +} + +int main(int argc, char **argv) { + + int rc; + + ToolMode Mode; + std::string SotocPath; + std::string InputFile; + std::string SotocOutputPath; + std::string cArgs, sArgs; + std::vector ObjectFiles; + std::string OutputFile; + + KeepTransformedFilesDir = std::getenv("NECAURORA_KEEP_FILES_DIR"); + + rc = parseCmdline(argc, argv, Mode, SotocPath, InputFile, cArgs, sArgs, Verbose, + SaveTemps, ObjectFiles, OutputFile); + if (rc != 0) { + std::cerr << "necaurora-ofld-cc1-wraper: failed parsing the command " + << "line\n"; + } + if (Mode == ToolMode::Preprocessor) { + std::cerr << "necaurora-ofld-wrapper: preprocessor pass not supported\n"; + return EXIT_FAILURE; + // rc = runPreprocessor(InputFile, Args); + } else if (Mode == ToolMode::Compiler) { + rc = runSourceTransformation(InputFile, SotocPath, SotocOutputPath, sArgs); + if (rc != 0) { + std::cerr << "necaurora-ofld-cc1-wrapper: " + << "source code transformation failed\n"; + return EXIT_FAILURE; + } + + rc = runTargetCompiler(SotocOutputPath, cArgs); + + if (rc != 0) { + std::cerr << "necaurora-ofld-wrapper: " + << "execution of target compiler failed with code " << rc + << "\n"; + return EXIT_FAILURE; + } + } else if (Mode == ToolMode::StaticLinker) { + rc = runStaticLinker(ObjectFiles, cArgs, OutputFile); + if (rc != 0) { + std::cerr << "necaurora-ofld-wrapper: static linking failed " + << "with code " << rc << "\n"; + return EXIT_FAILURE; + } + } else if (Mode == ToolMode::Passthrough) { + rc = runPassthrough(cArgs); + if (rc != 0) { + std::cerr << "necaurora-ofld-wrapper: execution of target compiler " + << "failed with code " << rc << "\n"; + return EXIT_FAILURE; + } + } else { + std::cerr << "necaurora-ofld-wrapper: " + << "could not find out what to do\n"; + return EXIT_FAILURE; + } + return EXIT_SUCCESS; +} diff --git a/clang/tools/nec-aurora-build/necaurora-ofld-wrapper.h b/clang/tools/nec-aurora-build/necaurora-ofld-wrapper.h new file mode 100644 index 000000000000..16570a25dee2 --- /dev/null +++ b/clang/tools/nec-aurora-build/necaurora-ofld-wrapper.h @@ -0,0 +1,34 @@ +#ifndef NECAURORA_OFLD_WRAPPER_H +#define NECAURORA_OFLD_WRAPPER_H + +#include +#include + +#include "config.h" + +extern bool Verbose; + +extern const char *KeepTransformedFilesDir; + +int runSourceTransformation(const std::string &InputPath, + const std::string &SotocPath, + std::string &OutputPath, + const std::string &ArgsString); + +int runTargetCompiler(const std::string &InputPath, const std::string &Args); + +int runStaticLinker(const std::vector &ObjectFiles, + const std::string &Args, + const std::string &OutputFile); + +int runPassthrough(const std::string &Args); + +const char *getTmpDir(); + +int configureTargetCompiler(const std::string&); +const char *getTargetCompiler(); + +std::string writeTmpFile(const std::string &Content, const std::string &Prefix, + const std::string &Extension, bool RealTmpfile=true); + +#endif /*NECAURORA_OFLD_WRAPPER_H*/ diff --git a/clang/tools/nec-aurora-build/utils.cpp b/clang/tools/nec-aurora-build/utils.cpp new file mode 100644 index 000000000000..2252fbbe8af1 --- /dev/null +++ b/clang/tools/nec-aurora-build/utils.cpp @@ -0,0 +1,109 @@ +#include +#include +#include +#include +#include +#include +#include + +#include "necaurora-ofld-wrapper.h" + +const std::string ClangCompilerCmd = TARGET_COMPILER_CLANG " --target=ve-linux"; +const std::string RVClangCompilerCmd = TARGET_COMPILER_RVCLANG " --target=ve-linux"; +const std::string NCCCompilerCmd = TARGET_COMPILER_NCC; + +std::string CompilerCmd; + +int configureTargetCompiler(const std::string& CompilerName) { + if (CompilerName.find("path:") == 0) { + CompilerCmd = CompilerName.substr(5); + //Small sanity check whether there is actually a path + if (CompilerCmd.length() > 0) { + return 0; + } + std::cerr << "nec-aurora-build: -fopenmp-nec-compiler=path: empty" + << std::endl; + + } + if (CompilerName == "clang") { CompilerCmd = ClangCompilerCmd; return 0; } + if (CompilerName == "rvclang") { CompilerCmd = RVClangCompilerCmd; return 0; } + if (CompilerName == "ncc") { CompilerCmd = NCCCompilerCmd; return 0; } + std::cerr << "nec-aurora-build: -fopenmp-nec-compiler=" << CompilerCmd + << " not recognized" + << std::endl; + return 1; +} + + +const char *getTargetCompiler() { + // If no option was specified on the command line chose the builtin default + if (CompilerCmd.empty()) { +#ifndef DEFAULT_TARGET_COMPILER_OPTION +#error "DEFAULT_TARGET_COMPILER_OPTION not specified during build!" +#endif + configureTargetCompiler(DEFAULT_TARGET_COMPILER_OPTION); + } + return CompilerCmd.c_str(); +} + +const char *getTmpDir() { + const char *TmpDir = std::getenv("TMPDIR"); + + if (!TmpDir) { + TmpDir = std::getenv("TEMP"); + } + + if (!TmpDir) { + TmpDir = std::getenv("TMP"); + } + + if (!TmpDir) { + TmpDir = "/tmp"; + } + + return TmpDir; +} + +std::string writeTmpFile(const std::string &Content, const std::string &Prefix, + const std::string &Extension, bool RealTmpfile) { + std::string TmpPath; + if (KeepTransformedFilesDir) { + TmpPath = KeepTransformedFilesDir; + } else { + TmpPath = getTmpDir(); + } + + // because mkstemp wants the last n chars to be 'X', we have to add the + // extension laster + std::stringstream TmpFilePathTemplate; + TmpFilePathTemplate << TmpPath << "/" << Prefix; + if (RealTmpfile) { + TmpFilePathTemplate << "-XXXXXX"; + } + TmpFilePathTemplate << Extension; + + std::string TmpFilePathTemplateStr = TmpFilePathTemplate.str(); + + std::vector TmpFilePath(TmpFilePathTemplateStr.begin(), + TmpFilePathTemplateStr.end()); + TmpFilePath.push_back('\0'); + + int fd; + if (RealTmpfile) { + // generate tmp name + fd = mkstemps(&TmpFilePath[0], Extension.length()); + } else { + fd = open(&TmpFilePath[0], O_RDWR); + } + + if (fd < 0) { + std::cerr << "necaurora-ofld-cc1-wrapper: mkstemp(" << &TmpFilePath[0] + << ") failed with message: \"" << strerror(errno) << "\"" + << std::endl; + return ""; + } + write(fd, Content.c_str(), Content.length()); + close(fd); // we get a warning for mktemp so we use mkstemp + + return TmpFilePath.data(); +} diff --git a/clang/tools/sotoc/.gitignore b/clang/tools/sotoc/.gitignore new file mode 100644 index 000000000000..aee96fd0ed7b --- /dev/null +++ b/clang/tools/sotoc/.gitignore @@ -0,0 +1,10 @@ +CMakeCache.txt +CMakeFiles +CMakeScripts +Testing +Makefile +cmake_install.cmake +install_manifest.txt +compile_commands.json +CTestTestfile.cmake +doxygen diff --git a/clang/tools/sotoc/CMakeLists.txt b/clang/tools/sotoc/CMakeLists.txt new file mode 100644 index 000000000000..4a3d3c67ae7e --- /dev/null +++ b/clang/tools/sotoc/CMakeLists.txt @@ -0,0 +1,81 @@ +if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) +# this is a standalone build + cmake_minimum_required(VERSION 2.8.8) + set(SOTOC_STANDALONE_BUILD True) +endif() + +################################################################################ +# Base config +################################################################################ + +set(SOTOC_PROJECT_NAME sotoc) + +set(USE_CLANG_LIBS clangFrontend + LLVMSupport + clangRewrite + clangDriver + clangSerialization + clangParse + clangRewriteFrontend + clangSema + clangAnalysis + clangEdit + clangAST + clangLex + clangBasic + clangTooling) + +set(SOTOC_SOURCES src/main.cpp + src/TargetCode.cpp + src/TargetCodeFragment.cpp + src/TargetRegionVariable.cpp + src/Visitors.cpp + src/DeclResolver.cpp + src/OmpPragma.cpp) + + +################################################################################ +# Standalone build +################################################################################ + +#TODO: Remove standalone build? +if (SOTOC_STANDALONE_BUILD) + project(${SOTOC_PROJECT_NAME} C CXX) + # Find Clang and set definitions and include directories accordingly + if($ENV{CLANG_ROOT}) + set(CLANG_CONFIG_HINT HINTS $ENV{CLANG_ROOT}/lib/cmake/clang) + endif() + + find_package(Clang REQUIRED CONFIG HINTS ${CLANG_CONFIG_HINT}) + + #TODO: Check which flags are really required, make more generic + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++ -std=c++11 -Wno-unused-parameter -fno-strict-aliasing -fno-exceptions -fno-rtti") + + add_executable(${SOTOC_PROJECT_NAME} ${SOTOC_SOURCES}) + +################################################################################ +# In-tree build +################################################################################ + +else() + add_clang_executable(${SOTOC_PROJECT_NAME} ${SOTOC_SOURCES}) +endif() + +set(SOTOC_DEBUG_OUTPUT OFF CACHE BOOL "Compiles sotoc with possible debug output") +if (SOTOC_DEBUG_OUTPUT) + add_definitions(-DSOTOC_DEBUG) +endif() + +################################################################################ +# Link, install and tests +################################################################################ + +clang_target_link_libraries(${SOTOC_PROJECT_NAME} PRIVATE ${USE_LLVM_LIBS} ${USE_CLANG_LIBS}) + +install(TARGETS ${SOTOC_PROJECT_NAME} DESTINATION bin) + +option(SOTOC_ENABLE_TESTS OFF) + +if(SOTOC_ENABLE_TESTS) + add_subdirectory(test) +endif() diff --git a/clang/tools/sotoc/Doxyfile b/clang/tools/sotoc/Doxyfile new file mode 100644 index 000000000000..2e71e3d08a4e --- /dev/null +++ b/clang/tools/sotoc/Doxyfile @@ -0,0 +1,2280 @@ +# Doxyfile 1.8.5 + +# 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 = "Aurora OpenMP Offloading" + +# 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 = + +# 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 an logo or 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 + +# 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 + +# 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, Brazilian, Catalan, Chinese, Chinese- +# Traditional, Croatian, Czech, Danish, Dutch, English, Esperanto, Farsi, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en, +# Korean, Korean-en, Latvian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, 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 = + +# 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 = YES + +# 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, 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 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 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 + +# 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 = YES + +# 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 = NO + +# This flag is only useful for Objective-C code. When 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 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 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. +# 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. Do not use file names with spaces, bibtex cannot handle them. 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 + +# 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. +# Note: If this tag is empty the current directory is searched. + +INPUT = docs/main.md src + +# 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. 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, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = + +# 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 = NO + +# 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. + +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. + +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 = docs/main.md + +#--------------------------------------------------------------------------- +# 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 + +#--------------------------------------------------------------------------- +# 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 an additional user- +# defined cascading style sheet that is 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 therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. 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 stylesheet 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 NO can help when comparing the output of multiple runs. +# The default value is: YES. +# 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. +# 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 stylesheets (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 + +# When 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 prerendered 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 +# , /