Merge branch 'aurora_offloading_prototype' of git.rwth-aachen.de:NEC-RWTH-Projects/clang into aurora_offloading_prototype

Author: timcramer

clang/tools/nec-aurora-build/compiler.cpp

@@ -68,7 +68,6 @@ int runTargetCompiler(const std::string &InputPath, const std::string &Args) {
   int ret = system(CmdLine.str().c_str());
 
   if (!KeepTransformedFilesDir) {
-    std::cout << "Removing tmpfil" << std::endl;
     std::remove(InputPath.c_str());
   }
 

clang/tools/sotoc/Doxyfile

@@ -733,7 +733,7 @@ WARN_LOGFILE           =
 # spaces.
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = src
+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
@@ -869,7 +869,7 @@ FILTER_SOURCE_PATTERNS =
 # (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 =
+USE_MDFILE_AS_MAINPAGE = docs/main.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

clang/tools/sotoc/docs/main.md

@@ -0,0 +1,19 @@
+sotoc - Source Transformation for OpenMP Code (suggestions for a better name are greatly appreciated) {#mainpage}
+=====================================================================================================
+
+`sotoc` is written as a Clang tool and makes use of the Clang tooling
+infrastructure to parse C source files, search for target regions and other
+code that will be offloaded to a target device, and then extract and transform
+this code into new C code that can then be compiled by a target compiler into
+a target image to be used as a OpenMP device binary.
+The tool is part of this Clang repository and is automatically build together
+with clang.
+
+The tool comes with a regression test suite that uses `llvm-lit`.
+The tests can be run using the CMake generated build script when the CMake
+option `SOTOC_ENABLE_TESTS` is set to `ON` by running
+
+    $ make check-sotoc
+
+To run the tests, make sure that LLVM's `FileCheck` tool is in the path.
+

clang/tools/sotoc/src/OmpPragma.cpp

@@ -1,3 +1,18 @@
+//===-- sotoc/src/TargetCode ------------------------ ---------------------===//
+//
+//                     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 the class OmpPragma, which is used to generate repla-
+/// cement pragmas for teams and team combined constructs.
+///
+//===----------------------------------------------------------------------===//
+
 #include "clang/AST/PrettyPrinter.h"
 
 #include "OmpPragma.h"

clang/tools/sotoc/src/OmpPragma.h

@@ -16,6 +16,20 @@
 
 #include "TargetCodeFragment.h"
 
+/// A helper class to rewrite some "pragma omp" (mostly teams and similar
+/// combined constructs), which are not supported by sotoc.
+/// We currently only support one team to be run on the target because ncc does
+/// not support 'freestanding' teams. So we need to remove teams and
+/// distribute constructs from the generated target code. But teams constructs
+/// can also appear in combined constructs. These combined constructs cannot
+/// simply be removed, they must be replace by "non-team" equivalents to
+/// preserve correctness.
+/// This class provides helper functions that finds a suitable replacement for
+/// omp pragmas that contain teams constructs.
+/// It is used during code generation: The omp pragma of each target region
+/// that is declared as part of a combined construct and each pragma found
+/// during pretty printing is encapsulated by an object of this class which is
+/// then used to generate a replacement.
 class OmpPragma {
   clang::PrintingPolicy PP;
   llvm::ArrayRef<clang::OMPClause *> Clauses;
@@ -28,7 +42,10 @@ class OmpPragma {
   OmpPragma(clang::OMPExecutableDirective *Directive, clang::PrintingPolicy PP)
       : PP(PP), Clauses(Directive->clauses()),
         Kind(Directive->getDirectiveKind()){};
+  /// Returns true if the omp pragma encapsulated, needs to be followed by a
+  /// structured block (i.e. {...}).
   bool needsStructuredBlock();
+  /// Prints a replacement omp pragma for the encapsulated pragma onto \p Out.
   void printReplacement(llvm::raw_ostream &Out);
 
 private: