[C API] Add getters for Target Extension Types to C API #71291

Benjins · 2023-11-04T19:42:20Z

These types were added in LLVM-16, and the C API supports constructing them, but not getting information back from them

This change adds getters for them to the C API, updates the echo test to be able to clone Target Extension Types, and adds some usage of them to the echo.ll test to confirm that they work

These types were added in LLVM-16, and the C API supports constructing them, but not getting information back from them This change adds getters for them to the C API, updates the echo test to be able to clone Target Extension Types, and adds some usage of them to the echo.ll test to confirm that they work

llvmbot · 2023-11-04T19:42:49Z

@llvm/pr-subscribers-llvm-ir

Author: Benji Smith (Benjins)

Changes

These types were added in LLVM-16, and the C API supports constructing them, but not getting information back from them

This change adds getters for them to the C API, updates the echo test to be able to clone Target Extension Types, and adds some usage of them to the echo.ll test to confirm that they work

Full diff: https://github.com/llvm/llvm-project/pull/71291.diff

4 Files Affected:

(modified) llvm/include/llvm-c/Core.h (+33)
(modified) llvm/lib/IR/Core.cpp (+32)
(modified) llvm/test/Bindings/llvm-c/echo.ll (+17)
(modified) llvm/tools/llvm-c-test/echo.cpp (+36-2)

diff --git a/llvm/include/llvm-c/Core.h b/llvm/include/llvm-c/Core.h
index 4fc88b2b64eacea..2d95f198f64958f 100644
--- a/llvm/include/llvm-c/Core.h
+++ b/llvm/include/llvm-c/Core.h
@@ -1654,6 +1654,39 @@ LLVMTypeRef LLVMTargetExtTypeInContext(LLVMContextRef C, const char *Name,
                                        unsigned *IntParams,
                                        unsigned IntParamCount);
 
+/**
+ * Obtain the name for this target extension type
+ */
+const char *LLVMGetTargetExtTypeName(LLVMTypeRef TargetExtTy);
+
+/**
+ * Obtain the number of type parameters for this target extension type
+ */
+unsigned LLVMCountTargetExtTypeTypeParams(LLVMTypeRef TargetExtTy);
+
+/**
+ * Obtain the values of a target extension type's type parameters, output to
+ * the passed-in pointer. The pointer should have enough space for all type
+ * params for the given target extension type
+ *
+ * @see LLVMCountTargetExtTypeTypeParams
+ */
+void LLVMGetTargetExtTypeTypeParams(LLVMTypeRef TargetExtTy, LLVMTypeRef *Dest);
+
+/**
+ * Obtain the number of int parameters for this target extension type
+ */
+unsigned LLVMCountTargetExtTypeIntParams(LLVMTypeRef TargetExtTy);
+
+/**
+ * Obtain the int values of a target extension type's int parameters, output to
+ * the passed-in pointer. The pointer should have enough space for all int
+ * params for the given target extension type
+ *
+ * @see LLVMCountTargetExtTypeIntParams
+ */
+void LLVMGetTargetExtTypeIntParams(LLVMTypeRef TargetExtTy, unsigned *Dest);
+
 /**
  * @}
  */
diff --git a/llvm/lib/IR/Core.cpp b/llvm/lib/IR/Core.cpp
index 076d1089582fe7e..eb1cda55288e334 100644
--- a/llvm/lib/IR/Core.cpp
+++ b/llvm/lib/IR/Core.cpp
@@ -924,6 +924,38 @@ LLVMTypeRef LLVMTargetExtTypeInContext(LLVMContextRef C, const char *Name,
       TargetExtType::get(*unwrap(C), Name, TypeParamArray, IntParamArray));
 }
 
+const char *LLVMGetTargetExtTypeName(LLVMTypeRef TargetExtTy) {
+  TargetExtType *Type = unwrap<TargetExtType>(TargetExtTy);
+  return Type->getName().data();
+}
+
+unsigned LLVMCountTargetExtTypeTypeParams(LLVMTypeRef TargetExtTy) {
+  TargetExtType *Type = unwrap<TargetExtType>(TargetExtTy);
+  return Type->getNumTypeParameters();
+}
+
+void LLVMGetTargetExtTypeTypeParams(LLVMTypeRef TargetExtTy,
+                                    LLVMTypeRef *Dest) {
+  TargetExtType *Type = unwrap<TargetExtType>(TargetExtTy);
+
+  for (unsigned int i = 0; i < Type->getNumTypeParameters(); i++) {
+    Dest[i] = wrap(Type->getTypeParameter(i));
+  }
+}
+
+unsigned LLVMCountTargetExtTypeIntParams(LLVMTypeRef TargetExtTy) {
+  TargetExtType *Type = unwrap<TargetExtType>(TargetExtTy);
+  return Type->getNumIntParameters();
+}
+
+void LLVMGetTargetExtTypeIntParams(LLVMTypeRef TargetExtTy, unsigned *Dest) {
+  TargetExtType *Type = unwrap<TargetExtType>(TargetExtTy);
+
+  for (unsigned int i = 0; i < Type->getNumIntParameters(); i++) {
+    Dest[i] = Type->getIntParameter(i);
+  }
+}
+
 /*===-- Operations on values ----------------------------------------------===*/
 
 /*--.. Operations on all values ............................................--*/
diff --git a/llvm/test/Bindings/llvm-c/echo.ll b/llvm/test/Bindings/llvm-c/echo.ll
index 5daa238bfb8e533..e62670424112d51 100644
--- a/llvm/test/Bindings/llvm-c/echo.ll
+++ b/llvm/test/Bindings/llvm-c/echo.ll
@@ -66,6 +66,23 @@ define void @types() {
   ret void
 }
 
+; Target extension types:
+define target("target.ext.1") @target_ext_01(target("target.ext.1") %0) {
+	ret target("target.ext.1") %0
+}
+
+define target("target.ext.2", i8, i1) @target_ext_02(target("target.ext.2", i8, i1) %0) {
+	ret target("target.ext.2", i8, i1) %0
+}
+
+define target("target.ext.3", 7) @target_ext_03(target("target.ext.3", 7) %0) {
+	ret target("target.ext.3", 7) %0
+}
+
+define target("target.ext.4", i1, i32, 7) @target_ext_04(target("target.ext.4", i1, i32, 7) %0) {
+	ret target("target.ext.4", i1, i32, 7) %0
+}
+
 define i32 @iops(i32 %a, i32 %b) {
   %1 = add i32 %a, %b
   %2 = mul i32 %a, %1
diff --git a/llvm/tools/llvm-c-test/echo.cpp b/llvm/tools/llvm-c-test/echo.cpp
index 06966ce528eae4d..8ff7bc1ed0bf485 100644
--- a/llvm/tools/llvm-c-test/echo.cpp
+++ b/llvm/tools/llvm-c-test/echo.cpp
@@ -157,8 +157,42 @@ struct TypeCloner {
         return LLVMX86MMXTypeInContext(Ctx);
       case LLVMTokenTypeKind:
         return LLVMTokenTypeInContext(Ctx);
-      case LLVMTargetExtTypeKind:
-        assert(false && "Implement me");
+      case LLVMTargetExtTypeKind: {
+        const char *Name = LLVMGetTargetExtTypeName(Src);
+        unsigned TypeParamCount = LLVMCountTargetExtTypeTypeParams(Src);
+        unsigned IntParamCount = LLVMCountTargetExtTypeIntParams(Src);
+
+        LLVMTypeRef *TypeParams = nullptr;
+        unsigned *IntParams = nullptr;
+
+        // If we have type params, get them from Src and clone them individually
+        if (TypeParamCount > 0) {
+          TypeParams = static_cast<LLVMTypeRef *>(
+              safe_malloc(TypeParamCount * sizeof(LLVMTypeRef)));
+          LLVMGetTargetExtTypeTypeParams(Src, TypeParams);
+
+          for (unsigned i = 0; i < TypeParamCount; i++)
+            TypeParams[i] = Clone(TypeParams[i]);
+        }
+
+        // If we have integer params, get them from Src
+        if (IntParamCount > 0) {
+          IntParams = static_cast<unsigned *>(
+              safe_malloc(IntParamCount * sizeof(unsigned)));
+          LLVMGetTargetExtTypeIntParams(Src, IntParams);
+        }
+
+        LLVMTypeRef TargtExtTy = LLVMTargetExtTypeInContext(
+            Ctx, Name, TypeParams, TypeParamCount, IntParams, IntParamCount);
+
+        if (TypeParams)
+          free(TypeParams);
+
+        if (IntParams)
+          free(IntParams);
+
+        return TargtExtTy;
+      }
     }
 
     fprintf(stderr, "%d is not a supported typekind\n", Kind);

jcranmer-intel

This needs mentioning in the release notes.

Benjins · 2023-11-06T22:25:51Z

This needs mentioning in the release notes.

Gotcha. I've added a section to the release notes for it in another commit: let me know if it's okay

Benjins · 2023-11-13T15:14:14Z

Bumping this for review

jcranmer-intel

Looking at the other methods, I think it would also help to have a get I'th type/integer parameter method too in the API.

jcranmer-intel · 2023-11-15T16:37:36Z

llvm/tools/llvm-c-test/echo.cpp

+        LLVMTypeRef *TypeParams = nullptr;
+        unsigned *IntParams = nullptr;


These types should be SmallVector<LLVMTypeRef, 4> and SmallVector<unsigned, 4>, respectively...

… instead of raw pointers

…cessors

Benjins · 2023-11-20T23:32:18Z

Looking at the other methods, I think it would also help to have a get I'th type/integer parameter method too in the API.
These types should be SmallVector<LLVMTypeRef, 4> and SmallVector<unsigned, 4>, respectively...

These should both be taken care of after the couple commits I pushed just now

Benjins · 2023-11-30T12:20:10Z

Bumping this for review, after merging from main and resolving the conflicts

Benjins · 2024-06-24T00:35:54Z

Superseded by #96447

Accessors for the name, type parameters, and integer parameters are added. A test is added to echo.ll This was originally done in #71291 but that has been stale for several months. This re-applies the changes, but with some tweaks. e.g. removing the bulk getters in favour of a simple get-by-index approach for the type/integer parameters. The latter is more in line with the rest of the API

Accessors for the name, type parameters, and integer parameters are added. A test is added to echo.ll This was originally done in llvm#71291 but that has been stale for several months. This re-applies the changes, but with some tweaks. e.g. removing the bulk getters in favour of a simple get-by-index approach for the type/integer parameters. The latter is more in line with the rest of the API

llvmbot added the llvm:ir label Nov 4, 2023

jcranmer-intel reviewed Nov 6, 2023

View reviewed changes

Add C API changes for Target Extension Types to Release Notes

05d1b8c

Benjins requested a review from jcranmer-intel November 16, 2023 16:53

jcranmer-intel reviewed Nov 20, 2023

View reviewed changes

Benjins added 2 commits November 20, 2023 18:01

Refactor Target Extension Type cloning in echo.cpp to use SmallVector…

b211279

… instead of raw pointers

Add LLVMGetTargetExtTypeTypeParam and LLVMGetTargetExtTypeIntParam ac…

5bd2b4b

…cessors

Merge branch 'main' into bns-target-ext-types-c-api

9d3a407

Benjins requested a review from jcranmer-intel December 4, 2023 14:34

Benjins mentioned this pull request Jun 24, 2024

[C API] Add getters for Target Extension Types to C API #96447

Merged

Benjins closed this Jun 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[C API] Add getters for Target Extension Types to C API #71291

[C API] Add getters for Target Extension Types to C API #71291

Benjins commented Nov 4, 2023

llvmbot commented Nov 4, 2023

jcranmer-intel left a comment

Benjins commented Nov 6, 2023

Benjins commented Nov 13, 2023

jcranmer-intel left a comment

jcranmer-intel Nov 15, 2023

Benjins commented Nov 20, 2023

Benjins commented Nov 30, 2023

Benjins commented Jun 24, 2024

		LLVMTypeRef *TypeParams = nullptr;
		unsigned *IntParams = nullptr;

[C API] Add getters for Target Extension Types to C API #71291

[C API] Add getters for Target Extension Types to C API #71291

Conversation

Benjins commented Nov 4, 2023

llvmbot commented Nov 4, 2023

jcranmer-intel left a comment

Choose a reason for hiding this comment

Benjins commented Nov 6, 2023

Benjins commented Nov 13, 2023

jcranmer-intel left a comment

Choose a reason for hiding this comment

jcranmer-intel Nov 15, 2023

Choose a reason for hiding this comment

Benjins commented Nov 20, 2023

Benjins commented Nov 30, 2023

Benjins commented Jun 24, 2024