feat: expose region profiling in DSL

Add `startProfiling` and `stopProfiling` with region names to DSL and
runtime kernels.
Update the profiling pass default region, and consolidate profiling docs.

Author: philipportner

doc/Profiling.md

@@ -16,23 +16,31 @@ limitations under the License.
 
 # Profiling DAPHNE Using PAPI
 
-You can profile your DaphneDSL script by using the `--enable-profiling` CLI
-switch.
+You can profile specific regions of your DaphneDSL script by inserting
+`startProfiling` and `stopProfiling` calls with a string region name.
 Note that profiling is only available if DAPHNE was built *without* the `--no-papi` flag.
 
 DAPHNE supports profiling via the [PAPI](https://github.com/icl-utk-edu/papi)
 profiling library, specifically the
 [high-level (HL) PAPI API](https://github.com/icl-utk-edu/papi/wiki/PAPI-HL).
 
-When run with profiling enabled, the DAPHNE compiler will generate code that
-automatically starts and stops profiling (via PAPI) at the start and end of the
-DaphneDSL script.
+For example, you can mark a region like this:
+
+```r
+startProfiling("train");
+# ... computation ...
+stopProfiling("train");
+```
+The region name must match between the start and stop calls.
+
+If you pass `--enable-profiling` and do not insert explicit profiling calls,
+the compiler will wrap the entire script in a default region named `script`.
 
 You can configure which events to profile via the `PAPI_EVENTS`
 environment variable, e.g.:
 
 ```bash
-$ PAPI_EVENTS="perf::CYCLES,perf::INSTRUCTIONS,perf::CACHE-REFERENCES,perf::CACHE MISSES,perf::BRANCHES,perf::BRANCH-MI SSES" PAPI_REPORT=1 bin/daphne --enable-profiling script.daph
+$ PAPI_EVENTS="perf::CYCLES,perf::INSTRUCTIONS,perf::CACHE-REFERENCES,perf::CACHE MISSES,perf::BRANCHES,perf::BRANCH-MI SSES" PAPI_REPORT=1 bin/daphne script.daph
 ```
 
 For more details about the supported events as well as other PAPI-HL configuration

doc/README.md

@@ -56,7 +56,7 @@ limitations under the License.
 - [Building DAPHNE with the build.sh script](/doc/development/BuildingDaphne.md)
 - [Building in Unsupported Environments](/doc/BuildEnvironment.md)
 - [Logging in DAPHNE](/doc/development/Logging.md)
-- [Profiling in DAPHNE](/doc/development/Profiling.md)
+- [Profiling in DAPHNE](/doc/Profiling.md)
 - [Testing](/doc/development/Testing.md)
 - [Installing Python Libraries in the `daphne-dev` Container](/doc/development/InstallPythonLibsInContainer.md)
 

doc/development/Profiling.md

@@ -80,7 +80,6 @@ nav:
     - development/ExtendingSchedulingKnobs.md
     - development/HandlingPRs.md
     - development/ImplementBuiltinKernel.md
-    - development/Profiling.md
     - development/WriteDocs.md
     - development/Testing.md
     - development/InstallPythonLibsInContainer.md

mkdocs.yml

@@ -33,14 +33,28 @@ struct ProfilingPass : public PassWrapper<ProfilingPass, OperationPass<func::Fun
 
 void ProfilingPass::runOnOperation() {
     func::FuncOp f = getOperation();
+    bool hasProfilingOps = false;
+    f.walk([&](Operation *op) {
+        if (isa<daphne::StartProfilingOp, daphne::StopProfilingOp>(op)) {
+            hasProfilingOps = true;
+            return WalkResult::interrupt();
+        }
+        return WalkResult::advance();
+    });
+
+    if (hasProfilingOps)
+        return;
+
     Block &b = f.getBody().front();
 
     OpBuilder builder(&b, b.begin());
     Location loc = builder.getUnknownLoc();
 
-    builder.create<daphne::StartProfilingOp>(loc);
+    auto regionName =
+        builder.create<daphne::ConstantOp>(loc, builder.getType<daphne::StringType>(), builder.getStringAttr("script"));
+    builder.create<daphne::StartProfilingOp>(loc, regionName);
     builder.setInsertionPoint(b.getTerminator());
-    builder.create<daphne::StopProfilingOp>(loc);
+    builder.create<daphne::StopProfilingOp>(loc, regionName);
 }
 
 std::unique_ptr<Pass> daphne::createProfilingPass() { return std::make_unique<ProfilingPass>(); }

src/compiler/lowering/ProfilingPass.cpp

@@ -1987,16 +1987,16 @@ def Daphne_DecRefOp : Daphne_Op<"decRef"> {
 // ****************************************************************************
 
 def Daphne_StartProfilingOp : Daphne_Op<"startProfiling"> {
-    let summary = "Starts profiling";
+    let summary = "Starts profiling for the given region name";
 
-    let arguments = (ins); // no arguments
+    let arguments = (ins StrScalar:$regionName);
     let results = (outs); // no results
 }
 
 def Daphne_StopProfilingOp : Daphne_Op<"stopProfiling"> {
-    let summary = "Stops profiling";
+    let summary = "Stops profiling for the given region name";
 
-    let arguments = (ins); //no arguments
+    let arguments = (ins StrScalar:$regionName);
     let results = (outs); // no results
 }
 

src/ir/daphneir/DaphneOps.td

@@ -92,6 +92,8 @@ const std::unordered_map<std::string, BuiltinParamInfo> &builtinParamInfos() {
         {"readFrame", {{"filename"}, 1}},
         {"receiveFromNumpy", {{"address", "rows", "cols", "valueType"}, 4}},
         {"stop", {{"message"}, 0}},
+        {"startProfiling", {{"region"}, 1}},
+        {"stopProfiling", {{"region"}, 1}},
         {"openFile", {{"filename"}, 1}},
         {"openDevice", {{"device"}, 1}},
         {"openFileOnTarget", {{"target", "filename"}, 2}},
@@ -1350,6 +1352,17 @@ antlrcpp::Any DaphneDSLBuiltins::build(mlir::Location loc, const std::string &fu
         return builder.create<StopOp>(loc, message).getOperation();
     }
 
+    if (func == "startProfiling") {
+        checkNumArgsExact(loc, func, numArgs, 1);
+        mlir::Value regionName = args[0];
+        return builder.create<StartProfilingOp>(loc, regionName).getOperation();
+    }
+    if (func == "stopProfiling") {
+        checkNumArgsExact(loc, func, numArgs, 1);
+        mlir::Value regionName = args[0];
+        return builder.create<StopProfilingOp>(loc, regionName).getOperation();
+    }
+
     // --------------------------------------------------------------------
     // Low-level
     // --------------------------------------------------------------------

src/parser/daphnedsl/DaphneDSLBuiltins.cpp

@@ -26,9 +26,9 @@
 // Convenience function
 // ****************************************************************************
 
-void startProfiling(DCTX(ctx)) {
+inline void startProfiling(const char *regionName, DCTX(ctx)) {
 #ifdef USE_PAPI
-    PAPI_hl_region_begin("fixme");
+    PAPI_hl_region_begin(regionName);
 #else
     throw std::runtime_error("daphne was built without support for PAPI");
 #endif

src/runtime/local/kernels/StartProfiling.h

@@ -26,9 +26,9 @@
 // Convenience function
 // ****************************************************************************
 
-void stopProfiling(DCTX(ctx)) {
+inline void stopProfiling(const char *regionName, DCTX(ctx)) {
 #ifdef USE_PAPI
-    PAPI_hl_region_end("fixme");
+    PAPI_hl_region_end(regionName);
 #else
     throw std::runtime_error("daphne was built without support for PAPI");
 #endif

src/runtime/local/kernels/StopProfiling.h

@@ -6177,7 +6177,12 @@
             "opName": "startProfiling",
             "returnType": "void",
             "templateParams": [],
-            "runtimeParams": []
+            "runtimeParams": [
+                {
+                    "type": "const char *",
+                    "name": "regionName"
+                }
+            ]
         },
         "instantiations": [[]]
     },
@@ -6187,7 +6192,12 @@
             "opName": "stopProfiling",
             "returnType": "void",
             "templateParams": [],
-            "runtimeParams": []
+            "runtimeParams": [
+                {
+                    "type": "const char *",
+                    "name": "regionName"
+                }
+            ]
         },
         "instantiations": [[]]
     },