https://github.com/OCHyams created https://github.com/llvm/llvm-project/pull/134635
[KeyInstr][Clang] Agg init atom This patch is part of a stack that teaches Clang to generate Key Instructions metadata for C and C++. The Key Instructions project is introduced, including a "quick summary" section at the top which adds context for this PR, here: https://discourse.llvm.org/t/rfc-improving-is-stmt-placement-for-better-interactive-debugging/82668 The feature is only functional in LLVM if LLVM is built with CMake flag LLVM_EXPERIMENTAL_KEY_INSTRUCTIONs. Eventually that flag will be removed. The Clang-side work is demoed here: https://github.com/llvm/llvm-project/pull/130943 shouldUseBZeroPlusStoresToInitialize [KeyInstr] init-agg pattern [KeyInstr][Clang] Init pattern atom >From 06b9688ecb5d25d47fc2d2cbd40f257dfb9edea6 Mon Sep 17 00:00:00 2001 From: Orlando Cazalet-Hyams <orlando.hy...@sony.com> Date: Tue, 1 Apr 2025 15:40:58 +0100 Subject: [PATCH 1/4] [KeyInstr][Clang] Agg init atom This patch is part of a stack that teaches Clang to generate Key Instructions metadata for C and C++. The Key Instructions project is introduced, including a "quick summary" section at the top which adds context for this PR, here: https://discourse.llvm.org/t/rfc-improving-is-stmt-placement-for-better-interactive-debugging/82668 The feature is only functional in LLVM if LLVM is built with CMake flag LLVM_EXPERIMENTAL_KEY_INSTRUCTIONs. Eventually that flag will be removed. The Clang-side work is demoed here: https://github.com/llvm/llvm-project/pull/130943 --- clang/lib/CodeGen/CGDecl.cpp | 2 ++ clang/test/KeyInstructions/init-agg.cpp | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 clang/test/KeyInstructions/init-agg.cpp diff --git a/clang/lib/CodeGen/CGDecl.cpp b/clang/lib/CodeGen/CGDecl.cpp index 6aa9f3fa27c87..045ac7361cf5c 100644 --- a/clang/lib/CodeGen/CGDecl.cpp +++ b/clang/lib/CodeGen/CGDecl.cpp @@ -1263,6 +1263,8 @@ void CodeGenFunction::emitStoresForConstant(const VarDecl &D, Address Loc, createUnnamedGlobalForMemcpyFrom( CGM, D, Builder, constant, Loc.getAlignment()), SizeVal, isVolatile); + addInstToCurrentSourceAtom(I, nullptr); + if (IsAutoInit) I->addAnnotationMetadata("auto-init"); } diff --git a/clang/test/KeyInstructions/init-agg.cpp b/clang/test/KeyInstructions/init-agg.cpp new file mode 100644 index 0000000000000..b96256b532f3e --- /dev/null +++ b/clang/test/KeyInstructions/init-agg.cpp @@ -0,0 +1,22 @@ + +// RUN: %clang -gkey-instructions %s -gmlt -S -emit-llvm -o - \ +// RUN: | FileCheck %s --implicit-check-not atomGroup --implicit-check-not atomRank + +// The implicit-check-not is important; we don't want the GEPs created for the +// store locations to be included in the atom group. + +int g; +void a() { +// CHECK: _Z1av() +// CHECK: call void @llvm.memcpy{{.*}}, !dbg [[G1R1:!.*]] + int A[] = { 1, 2, 3 }; +// CHECK: store i32 1, ptr %{{.*}}, !dbg [[G2R1:!.*]] +// CHECK: store i32 2, ptr %{{.*}}, !dbg [[G2R1]] +// CHECK: %0 = load i32, ptr @g{{.*}}, !dbg [[G2R2:!.*]] +// CHECK: store i32 %0, ptr %{{.*}}, !dbg [[G2R1]] + int B[] = { 1, 2, g }; +} + +// CHECK: [[G1R1]] = !DILocation({{.*}}, atomGroup: 1, atomRank: 1) +// CHECK: [[G2R1]] = !DILocation({{.*}}, atomGroup: 2, atomRank: 1) +// CHECK: [[G2R2]] = !DILocation({{.*}}, atomGroup: 2, atomRank: 2) >From 1f1f1d5d88b26177614d7a9abbe7200528895e6a Mon Sep 17 00:00:00 2001 From: Orlando Cazalet-Hyams <orlando.hy...@sony.com> Date: Tue, 1 Apr 2025 16:45:47 +0100 Subject: [PATCH 2/4] shouldUseBZeroPlusStoresToInitialize --- clang/lib/CodeGen/CGDecl.cpp | 3 +++ clang/test/KeyInstructions/init-agg.cpp | 12 +++++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/clang/lib/CodeGen/CGDecl.cpp b/clang/lib/CodeGen/CGDecl.cpp index 045ac7361cf5c..c43c547efbcaa 100644 --- a/clang/lib/CodeGen/CGDecl.cpp +++ b/clang/lib/CodeGen/CGDecl.cpp @@ -938,6 +938,7 @@ void CodeGenFunction::emitStoresForInitAfterBZero(llvm::Constant *Init, isa<llvm::ConstantVector>(Init) || isa<llvm::BlockAddress>(Init) || isa<llvm::ConstantExpr>(Init)) { auto *I = Builder.CreateStore(Init, Loc, isVolatile); + addInstToCurrentSourceAtom(I, nullptr); if (IsAutoInit) I->addAnnotationMetadata("auto-init"); return; @@ -1193,6 +1194,8 @@ void CodeGenFunction::emitStoresForConstant(const VarDecl &D, Address Loc, if (shouldUseBZeroPlusStoresToInitialize(constant, ConstantSize)) { auto *I = Builder.CreateMemSet(Loc, llvm::ConstantInt::get(CGM.Int8Ty, 0), SizeVal, isVolatile); + addInstToCurrentSourceAtom(I, nullptr); + if (IsAutoInit) I->addAnnotationMetadata("auto-init"); diff --git a/clang/test/KeyInstructions/init-agg.cpp b/clang/test/KeyInstructions/init-agg.cpp index b96256b532f3e..854af3237ed98 100644 --- a/clang/test/KeyInstructions/init-agg.cpp +++ b/clang/test/KeyInstructions/init-agg.cpp @@ -1,22 +1,32 @@ -// RUN: %clang -gkey-instructions %s -gmlt -S -emit-llvm -o - \ +// RUN: %clang -gkey-instructions %s -gmlt -gno-column-info -S -emit-llvm -o - \ // RUN: | FileCheck %s --implicit-check-not atomGroup --implicit-check-not atomRank // The implicit-check-not is important; we don't want the GEPs created for the // store locations to be included in the atom group. int g; +char gc; void a() { // CHECK: _Z1av() // CHECK: call void @llvm.memcpy{{.*}}, !dbg [[G1R1:!.*]] int A[] = { 1, 2, 3 }; + // CHECK: store i32 1, ptr %{{.*}}, !dbg [[G2R1:!.*]] // CHECK: store i32 2, ptr %{{.*}}, !dbg [[G2R1]] // CHECK: %0 = load i32, ptr @g{{.*}}, !dbg [[G2R2:!.*]] // CHECK: store i32 %0, ptr %{{.*}}, !dbg [[G2R1]] int B[] = { 1, 2, g }; + +// CHECK: call void @llvm.memset{{.*}}, !dbg [[G3R1:!.*]] +// CHECK: store i8 97{{.*}}, !dbg [[G3R1]] +// CHECK: store i8 98{{.*}}, !dbg [[G3R1]] +// CHECK: store i8 99{{.*}}, !dbg [[G3R1]] +// CHECK: store i8 100{{.*}}, !dbg [[G3R1]] + char big[65536] = { 'a', 'b', 'c', 'd' }; } // CHECK: [[G1R1]] = !DILocation({{.*}}, atomGroup: 1, atomRank: 1) // CHECK: [[G2R1]] = !DILocation({{.*}}, atomGroup: 2, atomRank: 1) // CHECK: [[G2R2]] = !DILocation({{.*}}, atomGroup: 2, atomRank: 2) +// CHECK: [[G3R1]] = !DILocation({{.*}}, atomGroup: 3, atomRank: 1) \ No newline at end of file >From 3eae9188c3c68d50d481d312eebdf3f876fc8df7 Mon Sep 17 00:00:00 2001 From: Orlando Cazalet-Hyams <orlando.hy...@sony.com> Date: Tue, 1 Apr 2025 17:08:43 +0100 Subject: [PATCH 3/4] [KeyInstr] init-agg pattern --- clang/lib/CodeGen/CGDecl.cpp | 1 + clang/test/KeyInstructions/init-agg.cpp | 7 +++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/clang/lib/CodeGen/CGDecl.cpp b/clang/lib/CodeGen/CGDecl.cpp index c43c547efbcaa..3a4864a1cacf6 100644 --- a/clang/lib/CodeGen/CGDecl.cpp +++ b/clang/lib/CodeGen/CGDecl.cpp @@ -1220,6 +1220,7 @@ void CodeGenFunction::emitStoresForConstant(const VarDecl &D, Address Loc, } auto *I = Builder.CreateMemSet( Loc, llvm::ConstantInt::get(CGM.Int8Ty, Value), SizeVal, isVolatile); + addInstToCurrentSourceAtom(I, nullptr); if (IsAutoInit) I->addAnnotationMetadata("auto-init"); return; diff --git a/clang/test/KeyInstructions/init-agg.cpp b/clang/test/KeyInstructions/init-agg.cpp index 854af3237ed98..e2f12d73a4ecd 100644 --- a/clang/test/KeyInstructions/init-agg.cpp +++ b/clang/test/KeyInstructions/init-agg.cpp @@ -6,7 +6,6 @@ // store locations to be included in the atom group. int g; -char gc; void a() { // CHECK: _Z1av() // CHECK: call void @llvm.memcpy{{.*}}, !dbg [[G1R1:!.*]] @@ -24,9 +23,13 @@ void a() { // CHECK: store i8 99{{.*}}, !dbg [[G3R1]] // CHECK: store i8 100{{.*}}, !dbg [[G3R1]] char big[65536] = { 'a', 'b', 'c', 'd' }; + +// CHECK: call void @llvm.memset{{.*}}, !dbg [[G4R1:!.*]] + char arr[] = { 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, }; } // CHECK: [[G1R1]] = !DILocation({{.*}}, atomGroup: 1, atomRank: 1) // CHECK: [[G2R1]] = !DILocation({{.*}}, atomGroup: 2, atomRank: 1) // CHECK: [[G2R2]] = !DILocation({{.*}}, atomGroup: 2, atomRank: 2) -// CHECK: [[G3R1]] = !DILocation({{.*}}, atomGroup: 3, atomRank: 1) \ No newline at end of file +// CHECK: [[G3R1]] = !DILocation({{.*}}, atomGroup: 3, atomRank: 1) +// CHECK: [[G4R1]] = !DILocation({{.*}}, atomGroup: 4, atomRank: 1) >From eef73d31b628df8a271ec7f40cb3632d7a0586e9 Mon Sep 17 00:00:00 2001 From: Orlando Cazalet-Hyams <orlando.hy...@sony.com> Date: Wed, 2 Apr 2025 09:54:30 +0100 Subject: [PATCH 4/4] [KeyInstr][Clang] Init pattern atom --- clang/lib/CodeGen/CGDecl.cpp | 1 + clang/test/KeyInstructions/init-agg.cpp | 6 +++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/clang/lib/CodeGen/CGDecl.cpp b/clang/lib/CodeGen/CGDecl.cpp index 3a4864a1cacf6..9860ab0b033bb 100644 --- a/clang/lib/CodeGen/CGDecl.cpp +++ b/clang/lib/CodeGen/CGDecl.cpp @@ -1182,6 +1182,7 @@ void CodeGenFunction::emitStoresForConstant(const VarDecl &D, Address Loc, Ty->isPtrOrPtrVectorTy() || Ty->isFPOrFPVectorTy(); if (canDoSingleStore) { auto *I = Builder.CreateStore(constant, Loc, isVolatile); + addInstToCurrentSourceAtom(I, nullptr); if (IsAutoInit) I->addAnnotationMetadata("auto-init"); return; diff --git a/clang/test/KeyInstructions/init-agg.cpp b/clang/test/KeyInstructions/init-agg.cpp index e2f12d73a4ecd..f0cc67e659d95 100644 --- a/clang/test/KeyInstructions/init-agg.cpp +++ b/clang/test/KeyInstructions/init-agg.cpp @@ -1,5 +1,5 @@ -// RUN: %clang -gkey-instructions %s -gmlt -gno-column-info -S -emit-llvm -o - \ +// RUN: %clang -gkey-instructions %s -gmlt -gno-column-info -S -emit-llvm -o - -ftrivial-auto-var-init=pattern \ // RUN: | FileCheck %s --implicit-check-not atomGroup --implicit-check-not atomRank // The implicit-check-not is important; we don't want the GEPs created for the @@ -26,6 +26,9 @@ void a() { // CHECK: call void @llvm.memset{{.*}}, !dbg [[G4R1:!.*]] char arr[] = { 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, 42, }; + +// CHECK: store i8 -86, ptr %uninit{{.*}}, !dbg [[G5R1:!.*]], !annotation + char uninit; // -ftrivial-auto-var-init=pattern } // CHECK: [[G1R1]] = !DILocation({{.*}}, atomGroup: 1, atomRank: 1) @@ -33,3 +36,4 @@ void a() { // CHECK: [[G2R2]] = !DILocation({{.*}}, atomGroup: 2, atomRank: 2) // CHECK: [[G3R1]] = !DILocation({{.*}}, atomGroup: 3, atomRank: 1) // CHECK: [[G4R1]] = !DILocation({{.*}}, atomGroup: 4, atomRank: 1) +// CHECK: [[G5R1]] = !DILocation({{.*}}, atomGroup: 5, atomRank: 1) _______________________________________________ llvm-branch-commits mailing list llvm-branch-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-branch-commits
