[llvm] 1717c18 - Intrinsics: Allow tablegen to mark parameters with dereferenceable

[Matt Arsenault via llvm-commits]

Author: Matt Arsenault
Date: 2023-06-21T21:36:22-04:00
New Revision: 1717c18664d5880f78db85eb0075a2c1379df2d9

URL: https://github.com/llvm/llvm-project/commit/1717c18664d5880f78db85eb0075a2c1379df2d9
DIFF: https://github.com/llvm/llvm-project/commit/1717c18664d5880f78db85eb0075a2c1379df2d9.diff

LOG: Intrinsics: Allow tablegen to mark parameters with dereferenceable

Added: 
    llvm/test/TableGen/intrinsic-attrs.td

Modified: 
    llvm/include/llvm/IR/Intrinsics.td
    llvm/utils/TableGen/CodeGenIntrinsics.cpp
    llvm/utils/TableGen/CodeGenIntrinsics.h
    llvm/utils/TableGen/IntrinsicEmitter.cpp

Removed: 
    llvm/test/TableGen/intrin-side-effects.td


################################################################################
diff  --git a/llvm/include/llvm/IR/Intrinsics.td b/llvm/include/llvm/IR/Intrinsics.td
index c03eafea2438b..40cc2d7207a8c 100644
--- a/llvm/include/llvm/IR/Intrinsics.td
+++ b/llvm/include/llvm/IR/Intrinsics.td
@@ -94,6 +94,11 @@ class Align<AttrIndex idx, int align> : IntrinsicProperty {
   int Align = align;
 }
 
+class Dereferenceable<AttrIndex idx, int bytes> : IntrinsicProperty {
+  int ArgNo = idx.Value;
+  int Bytes = bytes;
+}
+
 // Returned - The specified argument is always the return value of the
 // intrinsic.
 class Returned<AttrIndex idx> : IntrinsicProperty {

diff  --git a/llvm/test/TableGen/intrin-side-effects.td b/llvm/test/TableGen/intrinsic-attrs.td
similarity index 57%
rename from llvm/test/TableGen/intrin-side-effects.td
rename to llvm/test/TableGen/intrinsic-attrs.td
index 35b7dc9bd8fb4..22019b8fb8714 100644
--- a/llvm/test/TableGen/intrin-side-effects.td
+++ b/llvm/test/TableGen/intrinsic-attrs.td
@@ -9,7 +9,16 @@ class LLVMType<ValueType vt> {
   int isAny = 0;
 }
 
-def llvm_i32_ty        : LLVMType<i32>;
+def llvm_i32_ty     : LLVMType<i32>;
+def llvm_ptr_ty     : LLVMType<iPTR>;
+
+class AttrIndex<int idx> {
+  int Value = idx;
+}
+
+def FuncIndex : AttrIndex<-1>;
+def RetIndex : AttrIndex<0>;
+class ArgIndex<int argNo> : AttrIndex<!add(argNo, 1)>;
 
 class IntrinsicProperty<bit is_default = 0> {
   bit IsDefault = is_default;
@@ -17,6 +26,10 @@ class IntrinsicProperty<bit is_default = 0> {
 
 def IntrNoMem : IntrinsicProperty;
 def IntrHasSideEffects : IntrinsicProperty;
+class Dereferenceable<AttrIndex idx, int bytes> : IntrinsicProperty {
+  int ArgNo = idx.Value;
+  int Bytes = bytes;
+}
 
 class Intrinsic<list<LLVMType> ret_types,
                 list<LLVMType> param_types = [],
@@ -40,12 +53,33 @@ class Intrinsic<list<LLVMType> ret_types,
 // ... this intrinsic.
 def int_random_gen   : Intrinsic<[llvm_i32_ty], [], [IntrNoMem, IntrHasSideEffects]>;
 
+def int_deref_ptr_ret : Intrinsic<[llvm_ptr_ty], [], [Dereferenceable<RetIndex, 16>]>;
+
+// CHECK: static AttributeSet getIntrinsicArgAttributeSet(LLVMContext &C, unsigned ID) {
+// CHECK-NEXT:   switch (ID) {
+// CHECK-NEXT: default: llvm_unreachable("Invalid attribute set number");
+// CHECK-NEXT: case 0:
+// CHECK-NEXT:     return AttributeSet::get(C, {
+// CHECK-NEXT: Attribute::get(C, Attribute::Dereferenceable, 16),
+// CHECK-NEXT: });
+// CHECK-NEXT: }
+// CHECK-NEXT: }
+
 // CHECK: static AttributeSet getIntrinsicFnAttributeSet(
 // CHECK: case 0:
 // CHECK-NEXT: return AttributeSet::get(C, {
 // CHECK-NEXT: Attribute::get(C, Attribute::NoUnwind),
 // CHECK-NEXT: });
 
-// CHECK: 1, // llvm.random.gen
+
+// CHECK: 1, // llvm.deref.ptr.ret
+// CHECK: 2, // llvm.random.gen
+
 // CHECK: case 1:
-// CHECK-NEXT: AS[0] = {AttributeList::FunctionIndex, getIntrinsicFnAttributeSet(C, 0)};
+// CHECK-NEXT: AS[0] = {0, getIntrinsicArgAttributeSet(C, 0)};
+// CHECK-NEXT: AS[1] = {AttributeList::FunctionIndex, getIntrinsicFnAttributeSet(C, 0)};
+// CHECK-NEXT: NumAttrs = 2;
+
+// CHECK: case 2:
+// CHECK-NEXT: AS[0] = {AttributeList::FunctionIndex, getIntrinsicFnAttributeSet(C, 1)};
+// CHECK-NEXT: NumAttrs = 1;

diff  --git a/llvm/utils/TableGen/CodeGenIntrinsics.cpp b/llvm/utils/TableGen/CodeGenIntrinsics.cpp
index 3be73d5a5e2ba..f2c2688f6bdf6 100644
--- a/llvm/utils/TableGen/CodeGenIntrinsics.cpp
+++ b/llvm/utils/TableGen/CodeGenIntrinsics.cpp
@@ -234,6 +234,10 @@ void CodeGenIntrinsic::setProperty(Record *R) {
     unsigned ArgNo = R->getValueAsInt("ArgNo");
     uint64_t Align = R->getValueAsInt("Align");
     addArgAttribute(ArgNo, Alignment, Align);
+  } else if (R->isSubClassOf("Dereferenceable")) {
+    unsigned ArgNo = R->getValueAsInt("ArgNo");
+    uint64_t Bytes = R->getValueAsInt("Bytes");
+    addArgAttribute(ArgNo, Dereferenceable, Bytes);
   } else
     llvm_unreachable("Unknown property!");
 }

diff  --git a/llvm/utils/TableGen/CodeGenIntrinsics.h b/llvm/utils/TableGen/CodeGenIntrinsics.h
index f2bab0127e090..c446e8102b69e 100644
--- a/llvm/utils/TableGen/CodeGenIntrinsics.h
+++ b/llvm/utils/TableGen/CodeGenIntrinsics.h
@@ -113,7 +113,8 @@ struct CodeGenIntrinsic {
     WriteOnly,
     ReadNone,
     ImmArg,
-    Alignment
+    Alignment,
+    Dereferenceable
   };
 
   struct ArgAttribute {

diff  --git a/llvm/utils/TableGen/IntrinsicEmitter.cpp b/llvm/utils/TableGen/IntrinsicEmitter.cpp
index bd3445513715b..25564d0f2f22b 100644
--- a/llvm/utils/TableGen/IntrinsicEmitter.cpp
+++ b/llvm/utils/TableGen/IntrinsicEmitter.cpp
@@ -474,6 +474,10 @@ void IntrinsicEmitter::EmitAttributes(const CodeGenIntrinsicTable &Ints,
           OS << "      Attribute::get(C, Attribute::Alignment, "
              << Attr.Value << "),\n";
           break;
+        case CodeGenIntrinsic::Dereferenceable:
+          OS << "      Attribute::get(C, Attribute::Dereferenceable, "
+             << Attr.Value << "),\n";
+          break;
         }
       }
       OS << "    });\n";