From db9b4f48b0e7d1574711466a32b5dacefd86c22d Mon Sep 17 00:00:00 2001
From: Ofek <ofekshilon@gmail.com>
Date: Sun, 6 Nov 2022 19:22:47 +0200
Subject: [PATCH] Add `Hide metadata` option to LLVM pipeline (#4243)

---
 lib/parsers/llvm-pass-dump-parser.ts          | 12 ++++++++-
 static/panes/llvm-opt-pipeline.ts             |  2 ++
 test/llvm-pass-dump-parser-tests.js           | 26 +++++++++++++++++++
 .../llvm-opt-pipeline-output.interfaces.ts    |  1 +
 views/templates/panes/llvm-opt-pipeline.pug   |  5 ++--
 5 files changed, 43 insertions(+), 3 deletions(-)

diff --git a/lib/parsers/llvm-pass-dump-parser.ts b/lib/parsers/llvm-pass-dump-parser.ts
index 5e1704e84f8..ef4ae12b97a 100644
--- a/lib/parsers/llvm-pass-dump-parser.ts
+++ b/lib/parsers/llvm-pass-dump-parser.ts
@@ -84,6 +84,7 @@ export class LlvmPassDumpParser {
     lineFilters: RegExp[];
     debugInfoFilters: RegExp[];
     debugInfoLineFilters: RegExp[];
+    metadataLineFilters: RegExp[];
     irDumpHeader: RegExp;
     machineCodeDumpHeader: RegExp;
     functionDefine: RegExp;
@@ -119,6 +120,12 @@ export class LlvmPassDumpParser {
         ];
         this.debugInfoLineFilters = [
             /,? !dbg !\d+/, // instruction/function debug metadata
+            /,? debug-location !\d+/, // Direct source locations like 'example.cpp:8:1' not filtered
+        ];
+
+        // Conditionally enabled by `filterIRMetadata`
+        this.metadataLineFilters = [
+            /,?(?: ![\d.A-Za-z]+){2}/, // any instruction metadata
         ];
 
         // Ir dump headers look like "*** IR Dump After XYZ ***"
@@ -454,13 +461,16 @@ export class LlvmPassDumpParser {
     }
 
     applyIrFilters(ir: ResultLine[], llvmOptPipelineOptions: LLVMOptPipelineBackendOptions) {
-        // Additional filters conditionally enabled by `filterDebugInfo`
+        // Additional filters conditionally enabled by `filterDebugInfo`/`filterIRMetadata`
         let filters = this.filters;
         let lineFilters = this.lineFilters;
         if (llvmOptPipelineOptions.filterDebugInfo) {
             filters = filters.concat(this.debugInfoFilters);
             lineFilters = lineFilters.concat(this.debugInfoLineFilters);
         }
+        if (llvmOptPipelineOptions.filterIRMetadata) {
+            lineFilters = lineFilters.concat(this.metadataLineFilters);
+        }
 
         return (
             ir
diff --git a/static/panes/llvm-opt-pipeline.ts b/static/panes/llvm-opt-pipeline.ts
index 0367ea6935e..8ca27ee135c 100644
--- a/static/panes/llvm-opt-pipeline.ts
+++ b/static/panes/llvm-opt-pipeline.ts
@@ -64,6 +64,7 @@ export class LLVMOptPipeline extends MonacoPane<monaco.editor.IStandaloneDiffEdi
     state: LLVMOptPipelineViewState;
     lastOptions: LLVMOptPipelineBackendOptions = {
         filterDebugInfo: true,
+        filterIRMetadata: false,
         fullModule: false,
         noDiscardValueNames: true,
         demangle: true,
@@ -195,6 +196,7 @@ export class LLVMOptPipeline extends MonacoPane<monaco.editor.IStandaloneDiffEdi
         const newOptions: LLVMOptPipelineBackendOptions = {
             //'filter-inconsequential-passes': options['filter-inconsequential-passes'],
             filterDebugInfo: filters['filter-debug-info'],
+            filterIRMetadata: filters['filter-instruction-metadata'],
             fullModule: options['dump-full-module'],
             noDiscardValueNames: options['-fno-discard-value-names'],
             demangle: options['demangle-symbols'],
diff --git a/test/llvm-pass-dump-parser-tests.js b/test/llvm-pass-dump-parser-tests.js
index 57f5ea1fabe..810e56084ff 100644
--- a/test/llvm-pass-dump-parser-tests.js
+++ b/test/llvm-pass-dump-parser-tests.js
@@ -66,4 +66,30 @@ describe('llvm-pass-dump-parser filter', function () {
                 {text: '  ret void'},
             ]);
     });
+
+    it('should filter out instruction metadata and object attribute group, leave debug instructions in place', function () {
+        // 'hide IR metadata' aims to decrease more visual noise than `hide debug info`
+        const options = {filterDebugInfo: false, filterIRMetadata: true};
+        // prettier-ignore
+        llvmPassDumpParser
+            .applyIrFilters(deepCopy(rawFuncIR), options)
+            .should.deep.equal([
+                {text: '  # Machine code for function f(S1&, S2 const&): NoPHIs, TracksLiveness, TiedOpsRewritten'},
+                {text: 'define dso_local void @f(S1&, S2 const&)(%struct.S1* noundef nonnull align 8 dereferenceable(16) %s1, %struct.S2* noundef nonnull align 8 dereferenceable(16) %s2) {'},
+                {text: 'entry:'},
+                {text: '  %s1.addr = alloca %struct.S1*, align 8'},
+                {text: '  store %struct.S1* %s1, %struct.S1** %s1.addr, align 8'},
+                {text: '  call void @llvm.dbg.declare(metadata %struct.S1** %s1.addr, metadata !30, metadata !DIExpression())'},
+                {text: '  call void @llvm.dbg.value(metadata %struct.S1* %s1, metadata !30, metadata !DIExpression())'},
+                {text: '  DBG_VALUE $rdi, $noreg, !"s1", !DIExpression(), debug-location !32; example.cpp:0 line no:7'},
+                {text: '  store %struct.S2* %s2, %struct.S2** %s2.addr, align 8'},
+                {text: '  %0 = load %struct.S2*, %struct.S2** %s2.addr, align 8'},
+                {text: '  %a = getelementptr inbounds %struct.S2, %struct.S2* %0, i32 0, i32 0'},
+                {text: '  %1 = load i64, i64* %t, align 8'},
+                {text: '  %2 = load %struct.S1*, %struct.S1** %s1.addr, align 8'},
+                {text: '  store i64 %1, i64* %t2, align 8'},
+                {text: '  %t3 = getelementptr inbounds %struct.Wrapper2, %struct.Wrapper2* %b, i32 0, i32 0'},
+                {text: '  ret void'},
+            ]);
+    });
 });
diff --git a/types/compilation/llvm-opt-pipeline-output.interfaces.ts b/types/compilation/llvm-opt-pipeline-output.interfaces.ts
index cf7c345a508..9f200ff14ff 100644
--- a/types/compilation/llvm-opt-pipeline-output.interfaces.ts
+++ b/types/compilation/llvm-opt-pipeline-output.interfaces.ts
@@ -42,6 +42,7 @@ export type LLVMOptPipelineOutput = {
 
 export type LLVMOptPipelineBackendOptions = {
     filterDebugInfo: boolean;
+    filterIRMetadata: boolean;
     fullModule: boolean;
     noDiscardValueNames: boolean;
     demangle: boolean;
diff --git a/views/templates/panes/llvm-opt-pipeline.pug b/views/templates/panes/llvm-opt-pipeline.pug
index 4fdc1e4527b..7a0e8cf815e 100644
--- a/views/templates/panes/llvm-opt-pipeline.pug
+++ b/views/templates/panes/llvm-opt-pipeline.pug
@@ -20,8 +20,9 @@ mixin optionButton(bind, isActive, text, title)
         span.fas.fa-filter
         span.hideable Filters
       .dropdown-menu
-        +optionButton("filter-inconsequential-passes", false, "Filter Inconsequential Passes", "Filter passes which do not make changes")
-        +optionButton("filter-debug-info", true, "Filter Debug Info", "Filter debug info intrinsics")
+        +optionButton("filter-inconsequential-passes", false, "Hide Inconsequential Passes", "Filter passes which do not make changes")
+        +optionButton("filter-debug-info", true, "Hide Debug Info", "Filter debug info intrinsics")
+        +optionButton("filter-instruction-metadata", true, "Hide Instruction Metadata", "Filter all IR metadata")
         //- +optionButton("library-functions", true, "Filter Library Functions", "Filter library functions")
     .btn-group.btn-group-sm
       .input-group.input-group-sm.mb-auto