added further file comments and restructured tests

spcl · Aug 10, 2023 · 7ec5e43 · 7ec5e43
1 parent c7f87b7
commit 7ec5e43
Show file tree

Hide file tree

Showing 126 changed files with 84 additions and 315 deletions.
diff --git a/lib/SDFG/Conversion/GenericToSDFG/ConvertGenericToSDFG.cpp b/lib/SDFG/Conversion/GenericToSDFG/ConvertGenericToSDFG.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file defines a converter from builtin dialects to the SDFG dialect.
+
 #include "SDFG/Conversion/GenericToSDFG/PassDetail.h"
 #include "SDFG/Conversion/GenericToSDFG/Passes.h"
 #include "SDFG/Dialect/Dialect.h"

diff --git a/lib/SDFG/Conversion/LinalgToSDFG/ConvertLinalgToSDFG.cpp b/lib/SDFG/Conversion/LinalgToSDFG/ConvertLinalgToSDFG.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file defines a converter from the linalg dialect to the SDFG dialect.
+
 #include "SDFG/Conversion/LinalgToSDFG/PassDetail.h"
 #include "SDFG/Conversion/LinalgToSDFG/Passes.h"
 #include "SDFG/Dialect/Dialect.h"

diff --git a/lib/SDFG/Conversion/SDFGToGeneric/ConvertSDFGToGeneric.cpp b/lib/SDFG/Conversion/SDFGToGeneric/ConvertSDFGToGeneric.cpp
@@ -1,31 +1,6 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
-#include "SDFG/Conversion/SDFGToGeneric/OpCreators.h"
-#include "SDFG/Conversion/SDFGToGeneric/PassDetail.h"
-#include "SDFG/Conversion/SDFGToGeneric/Passes.h"
-#include "SDFG/Conversion/SDFGToGeneric/SymbolicParser.h"
-#include "SDFG/Dialect/Dialect.h"
-#include "SDFG/Utils/Utils.h"
-#include "mlir/Dialect/ControlFlow/IR/ControlFlowOps.h"
-#include "mlir/Dialect/Func/IR/FuncOps.h"
-#include "mlir/Dialect/MemRef/IR/MemRef.h"
-#include "mlir/IR/AsmState.h"
-#include "mlir/IR/IRMapping.h"
-#include "mlir/Transforms/DialectConversion.h"
-
-using namespace mlir;
-using namespace sdfg;
-using namespace conversion;
-
-/// Maps state name to their generated block
-llvm::StringMap<Block *> blockMap;
-
-/// For each function scope, map symbols to values
-/// Function scope is determined by the function name
-llvm::StringMap<llvm::StringMap<Value>> symbolMap;
-
-// HACK: Keeps track of processed EdgeOps
-llvm::DenseSet<EdgeOp> processedEdges;
+/// This file defines a converter from the SDFG dialect to the builtin dialects.
 
 //
 // SDFG -> func.func
@@ -53,6 +28,33 @@ llvm::DenseSet<EdgeOp> processedEdges;
 // Consume -> TBD
 //
 
+#include "SDFG/Conversion/SDFGToGeneric/OpCreators.h"
+#include "SDFG/Conversion/SDFGToGeneric/PassDetail.h"
+#include "SDFG/Conversion/SDFGToGeneric/Passes.h"
+#include "SDFG/Conversion/SDFGToGeneric/SymbolicParser.h"
+#include "SDFG/Dialect/Dialect.h"
+#include "SDFG/Utils/Utils.h"
+#include "mlir/Dialect/ControlFlow/IR/ControlFlowOps.h"
+#include "mlir/Dialect/Func/IR/FuncOps.h"
+#include "mlir/Dialect/MemRef/IR/MemRef.h"
+#include "mlir/IR/AsmState.h"
+#include "mlir/IR/IRMapping.h"
+#include "mlir/Transforms/DialectConversion.h"
+
+using namespace mlir;
+using namespace sdfg;
+using namespace conversion;
+
+/// Maps state name to their generated block
+llvm::StringMap<Block *> blockMap;
+
+/// For each function scope, map symbols to values
+/// Function scope is determined by the function name
+llvm::StringMap<llvm::StringMap<Value>> symbolMap;
+
+// HACK: Keeps track of processed EdgeOps
+llvm::DenseSet<EdgeOp> processedEdges;
+
 //===----------------------------------------------------------------------===//
 // Target & Type Converter
 //===----------------------------------------------------------------------===//

diff --git a/lib/SDFG/Conversion/SDFGToGeneric/OpCreators.cpp b/lib/SDFG/Conversion/SDFGToGeneric/OpCreators.cpp
@@ -1,5 +1,8 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains convenience functions that build, create and insert
+/// various operations.
+
 #include "SDFG/Conversion/SDFGToGeneric/OpCreators.h"
 
 using namespace mlir;

diff --git a/lib/SDFG/Conversion/SDFGToGeneric/SymbolicParser.cpp b/lib/SDFG/Conversion/SDFGToGeneric/SymbolicParser.cpp
@@ -1,15 +1,9 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
-#include "SDFG/Conversion/SDFGToGeneric/SymbolicParser.h"
-#include "SDFG/Conversion/SDFGToGeneric/OpCreators.h"
-#include <regex>
-
-using namespace mlir;
-using namespace sdfg::conversion;
-
-// Implements a simple LL(1) parser for symbolic expressions
+/// This file implements a simple LL(1) parser for symbolic expressions.
 
 /*
+// Grammar
 stmt         ::= assignment | log_or_expr
 assignment   ::= IDENT ASSIGN log_or_expr
 
@@ -71,6 +65,13 @@ LETTER      ::= [_a-zA-Z];
 
 */
 
+#include "SDFG/Conversion/SDFGToGeneric/SymbolicParser.h"
+#include "SDFG/Conversion/SDFGToGeneric/OpCreators.h"
+#include <regex>
+
+using namespace mlir;
+using namespace sdfg::conversion;
+
 namespace mlir::sdfg::conversion {
 
 //===----------------------------------------------------------------------===//

diff --git a/lib/SDFG/Dialect/Dialect.cpp b/lib/SDFG/Dialect/Dialect.cpp
@@ -1,5 +1,8 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the SDFG dialect initializer and the type definitions,
+/// such as parsing, printing and utility functions.
+
 #include "SDFG/Dialect/Dialect.h"
 #include "mlir/IR/Builders.h"
 #include "llvm/ADT/TypeSwitch.h"

diff --git a/lib/SDFG/Dialect/Ops.cpp b/lib/SDFG/Dialect/Ops.cpp
@@ -1,5 +1,8 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains SDFG operation definitions, such as parsing, printing and
+/// utility functions.
+
 #include "SDFG/Dialect/Dialect.h"
 #include "SDFG/Utils/Utils.h"
 #include "mlir/Conversion/LLVMCommon/Pattern.h"

diff --git a/lib/SDFG/Translate/JsonEmitter.cpp b/lib/SDFG/Translate/JsonEmitter.cpp
@@ -1,5 +1,8 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains a JSON emitter, which constraints the generated output
+/// stream to valid JSON.
+
 #include "SDFG/Translate/JsonEmitter.h"
 #include "mlir/IR/Types.h"
 

diff --git a/lib/SDFG/Translate/Node.cpp b/lib/SDFG/Translate/Node.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the nodes of the internal IR used by the translator.
+
 #include "SDFG/Translate/Node.h"
 
 using namespace mlir;

diff --git a/lib/SDFG/Translate/liftToPython.cpp b/lib/SDFG/Translate/liftToPython.cpp
@@ -1,5 +1,8 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains a Python lifter, which lifts MLIR operations to Python
+/// code.
+
 #include "SDFG/Translate/liftToPython.h"
 #include "SDFG/Utils/Utils.h"
 

diff --git a/lib/SDFG/Translate/registration.cpp b/lib/SDFG/Translate/registration.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the translation pass registration.
+
 #include "SDFG/Translate/Translation.h"
 #include "mlir/InitAllDialects.h"
 #include "mlir/Tools/mlir-translate/Translation.h"

diff --git a/lib/SDFG/Translate/translateToSDFG.cpp b/lib/SDFG/Translate/translateToSDFG.cpp
@@ -1,5 +1,9 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains function to translate the SDFG dialect to the SDFG IR. It
+/// performs the translation in two passes. First it collects all operations and
+/// generates an internal IR, which in the second pass is used to generate JSON.
+
 #include "SDFG/Translate/Node.h"
 #include "SDFG/Translate/Translation.h"
 #include "SDFG/Translate/liftToPython.h"

diff --git a/lib/SDFG/Utils/AttributeToString.cpp b/lib/SDFG/Utils/AttributeToString.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the attribute to string utility functions.
+
 #include "SDFG/Utils/AttributeToString.h"
 #include "SDFG/Utils/Utils.h"
 

diff --git a/lib/SDFG/Utils/GetParents.cpp b/lib/SDFG/Utils/GetParents.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the parent utility functions.
+
 #include "SDFG/Utils/GetParents.h"
 
 namespace mlir::sdfg::utils {

diff --git a/lib/SDFG/Utils/GetSizedType.cpp b/lib/SDFG/Utils/GetSizedType.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the sized type utility functions.
+
 #include "SDFG/Utils/GetSizedType.h"
 
 namespace mlir::sdfg::utils {

diff --git a/lib/SDFG/Utils/IDGenerator.cpp b/lib/SDFG/Utils/IDGenerator.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the ID generator utility functions.
+
 #include "SDFG/Utils/IDGenerator.h"
 
 namespace mlir::sdfg::utils {

diff --git a/lib/SDFG/Utils/NameGenerator.cpp b/lib/SDFG/Utils/NameGenerator.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the name generator utility functions.
+
 #include "SDFG/Utils/NameGenerator.h"
 
 namespace mlir::sdfg::utils {

diff --git a/lib/SDFG/Utils/OperationToString.cpp b/lib/SDFG/Utils/OperationToString.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the operation to string utility functions.
+
 #include "SDFG/Utils/OperationToString.h"
 #include "SDFG/Utils/Utils.h"
 #include "mlir/IR/AsmState.h"

diff --git a/lib/SDFG/Utils/Sanitizer.cpp b/lib/SDFG/Utils/Sanitizer.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the sanitizer utility functions.
+
 #include "SDFG/Utils/Sanitizer.h"
 
 using namespace mlir;

diff --git a/lib/SDFG/Utils/ValueToString.cpp b/lib/SDFG/Utils/ValueToString.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the value to string utility functions.
+
 #include "SDFG/Utils/ValueToString.h"
 #include "SDFG/Utils/Utils.h"
 #include "mlir/IR/AsmState.h"

diff --git a/sdfg-opt/sdfg-opt.cpp b/sdfg-opt/sdfg-opt.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the SDFG optimizer with the conversion passes.
+
 #include "mlir/InitAllDialects.h"
 #include "mlir/InitAllPasses.h"
 #include "mlir/Pass/Pass.h"

diff --git a/sdfg-translate/sdfg-translate.cpp b/sdfg-translate/sdfg-translate.cpp
@@ -1,5 +1,7 @@
 // Copyright (c) 2021-2023, Scalable Parallel Computing Lab, ETH Zurich
 
+/// This file contains the SDFG translator with the translation passes.
+
 #include "mlir/InitAllTranslations.h"
 #include "mlir/Support/LogicalResult.h"
 #include "mlir/Tools/mlir-translate/MlirTranslateMain.h"

diff --git a/sdfg_gen/gen_all.sh b/sdfg_gen/gen_all.sh