[llvm] [memprof] Test the memprof-use pass with a YAML (PR #119779)

[Kazu Hirata via llvm-commits]

https://github.com/kazutakahirata updated https://github.com/llvm/llvm-project/pull/119779

>From 00eb087f25e18a4a6ebb77d119c99906f641b9a2 Mon Sep 17 00:00:00 2001
From: Kazu Hirata <kazu at google.com>
Date: Thu, 12 Dec 2024 11:21:56 -0800
Subject: [PATCH 1/2] [memprof] Test the memprof-use pass with a YAML

This patch adds a test to verify that the call site that allocates
cold bytes is annotated as such.  The test is the first of its kind
integrating the memprof-use pass and YAML.
---
 .../PGOProfile/memprof_annotate_yaml.test     | 45 +++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 llvm/test/Transforms/PGOProfile/memprof_annotate_yaml.test

diff --git a/llvm/test/Transforms/PGOProfile/memprof_annotate_yaml.test b/llvm/test/Transforms/PGOProfile/memprof_annotate_yaml.test
new file mode 100644
index 00000000000000..497665fe91d449
--- /dev/null
+++ b/llvm/test/Transforms/PGOProfile/memprof_annotate_yaml.test
@@ -0,0 +1,45 @@
+; Make sure that we can ingest the MemProf profile in YAML and
+; annotate a call to new as cold.
+
+; REQUIRES: x86_64-linux
+
+; RUN: split-file %s %t
+; RUN: llvm-profdata merge %t/memprof_annotate_yaml.yaml -o %t/memprof_annotate_yaml.memprofdata
+; RUN: opt < %t/memprof_annotate_yaml.ll -passes='memprof-use<profile-filename=%t/memprof_annotate_yaml.memprofdata>' -S 2>&1 | FileCheck %s
+
+;--- memprof_annotate_yaml.yaml
+---
+HeapProfileRecords:
+  - GUID:            _Z3foov
+    AllocSites:
+      - Callstack:
+          - { Function: _Z3foov, LineOffset: 0, Column: 22, IsInlineFrame: false }
+          - { Function: main, LineOffset: 2, Column: 5, IsInlineFrame: false }
+        MemInfoBlock:
+          TotalSize:                  400
+          AllocCount:                 1
+          TotalLifetimeAccessDensity: 1
+          TotalLifetime:              1000000
+    CallSites:       []
+...
+;--- memprof_annotate_yaml.ll
+define dso_local ptr @_Z3foov() !dbg !4 {
+entry:
+  %call = call ptr @_Znam(i64 4) #0, !dbg !5
+; CHECK: call ptr @_Znam(i64 4) [[ATTR:#[0-9]+]],
+  ret ptr %call
+}
+
+declare ptr @_Znam(i64)
+
+attributes #0 = { builtin allocsize(0) }
+; CHECK: attributes [[ATTR]] = {{.*}} "memprof"="cold"
+
+!llvm.module.flags = !{!2, !3}
+
+!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus_14, file: !1)
+!1 = !DIFile(filename: "t", directory: "/")
+!2 = !{i32 7, !"Dwarf Version", i32 5}
+!3 = !{i32 2, !"Debug Info Version", i32 3}
+!4 = distinct !DISubprogram(name: "foo", linkageName: "_Z3foov", scope: !1, file: !1, line: 1, unit: !0)
+!5 = !DILocation(line: 1, column: 22, scope: !4)

>From cf919dd76d19a9d7b4977e2833f4dae5f60c425f Mon Sep 17 00:00:00 2001
From: Kazu Hirata <kazu at google.com>
Date: Thu, 12 Dec 2024 14:40:45 -0800
Subject: [PATCH 2/2] Address comments.

---
 .../Transforms/PGOProfile/memprof_annotate_yaml.test   | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/llvm/test/Transforms/PGOProfile/memprof_annotate_yaml.test b/llvm/test/Transforms/PGOProfile/memprof_annotate_yaml.test
index 497665fe91d449..1ef963dec9e234 100644
--- a/llvm/test/Transforms/PGOProfile/memprof_annotate_yaml.test
+++ b/llvm/test/Transforms/PGOProfile/memprof_annotate_yaml.test
@@ -1,8 +1,8 @@
+; REQUIRES: x86_64-linux
+
 ; Make sure that we can ingest the MemProf profile in YAML and
 ; annotate a call to new as cold.
 
-; REQUIRES: x86_64-linux
-
 ; RUN: split-file %s %t
 ; RUN: llvm-profdata merge %t/memprof_annotate_yaml.yaml -o %t/memprof_annotate_yaml.memprofdata
 ; RUN: opt < %t/memprof_annotate_yaml.ll -passes='memprof-use<profile-filename=%t/memprof_annotate_yaml.memprofdata>' -S 2>&1 | FileCheck %s
@@ -16,6 +16,8 @@ HeapProfileRecords:
           - { Function: _Z3foov, LineOffset: 0, Column: 22, IsInlineFrame: false }
           - { Function: main, LineOffset: 2, Column: 5, IsInlineFrame: false }
         MemInfoBlock:
+          # With these numbers, llvm::memprof::getAllocType will determine that
+          # the call to new is cold.  See MemoryProfileInfo.cpp for details.
           TotalSize:                  400
           AllocCount:                 1
           TotalLifetimeAccessDensity: 1
@@ -26,14 +28,14 @@ HeapProfileRecords:
 define dso_local ptr @_Z3foov() !dbg !4 {
 entry:
   %call = call ptr @_Znam(i64 4) #0, !dbg !5
-; CHECK: call ptr @_Znam(i64 4) [[ATTR:#[0-9]+]],
+; CHECK: call ptr @_Znam(i64 4) #[[ATTR:[0-9]+]],
   ret ptr %call
 }
 
 declare ptr @_Znam(i64)
 
 attributes #0 = { builtin allocsize(0) }
-; CHECK: attributes [[ATTR]] = {{.*}} "memprof"="cold"
+; CHECK: attributes #[[ATTR]] = {{.*}} "memprof"="cold"
 
 !llvm.module.flags = !{!2, !3}