feat(InsertTracePoint): support insert trace point (#128)

Author: HerrCai0907

docs/.vitepress/config.ts

@@ -42,6 +42,11 @@ export default defineConfig({
             link: "/lower/index",
             items: listItems("docs", "lower"),
           },
+          {
+            text: "Builtin Transform",
+            link: "/transform/index",
+            items: listItems("docs", "transform"),
+          },
           {
             text: "Optimization Passes",
             link: "/opt/index",

docs/index.md

@@ -9,6 +9,9 @@ hero:
     - theme: brand
       text: Lowering Pass
       link: /lower/index.md
+    - theme: brand
+      text: Builtin Transform
+      link: /transform/index.md
     - theme: brand
       text: Optimization Pass
       link: /opt/index.md

docs/transform/index.md

@@ -0,0 +1 @@
+WARPO integrates some common used transforms.

docs/transform/insert_trace_point.md

@@ -0,0 +1,17 @@
+WARP support tracing by `builtin.tracePoint` API.
+
+This transform will insert calling `builtin.tracePoint` to statistic execution status of each function.
+
+- For the normal functions, calling `builtin.tracePoint` will be inserted before and after function.
+- For the import functions, calling `builtin.tracePoint` will be inserted before and after calling.
+
+### options
+
+#### `--trace-point-mapping-file <file path>`
+
+Enable transform by providing mapping file path.
+The trace point mapped function name will be outputted in the mapping file with following format.
+
+```
+<trace point number> ' ' <function name>
+```

include/warpo/support/Opt.hpp

@@ -8,9 +8,10 @@ namespace warpo::cli {
 
 enum class Category : uint32_t {
   None = 0,
-  Frontend = 1 << 1,
-  Optimization = 1 << 2,
-  OnlyForTest = 1 << 3,
+  OnlyForTest = 1 << 1,
+  Frontend = 1 << 2,
+  Optimization = 1 << 3,
+  Transformation = 1 << 4,
   All = static_cast<uint32_t>(-1),
 };
 

include/warpo/support/StatisticsKinds.def

@@ -6,6 +6,7 @@
 #endif
 
 PERF_ITEM_KIND_TOP(CompilationHIR)
+PERF_ITEM_KIND_TOP(Instrument)
 PERF_ITEM_KIND_TOP(Optimization)
 PERF_ITEM_KIND_TOP(Validation)
 PERF_ITEM_KIND_TOP(Lowering)