Improve opaque pointer support. (#337)

Author: maleadt

deps/LLVMExtra/include/LLVMExtra.h

@@ -169,5 +169,11 @@ LLVMBool LLVMContextSupportsTypedPointers(LLVMContextRef C);
 // constant data
 LLVMValueRef LLVMConstDataArray(LLVMTypeRef ElementTy, const void *Data, unsigned NumElements);
 
+// missing opaque pointer APIs
+#if LLVM_VERSION_MAJOR >= 13 && LLVM_VERSION_MAJOR < 15
+LLVMBool LLVMPointerTypeIsOpaque(LLVMTypeRef Ty);
+LLVMTypeRef LLVMPointerTypeInContext(LLVMContextRef C, unsigned AddressSpace);
+#endif
+
 LLVM_C_EXTERN_C_END
 #endif

deps/LLVMExtra/lib/llvm-api.cpp

@@ -518,24 +518,14 @@ LLVMValueRef LLVMBuildCallWithOpBundle(LLVMBuilderRef B, LLVMValueRef Fn,
                                        LLVMValueRef *Args, unsigned NumArgs,
                                        LLVMOperandBundleDefRef *Bundles, unsigned NumBundles,
                                        const char *Name) {
-
-    // TODO make opaque pointer compatibly
-    Value *V = unwrap(Fn);
-    #if LLVM_VERSION_MAJOR <= 14
-        FunctionType *FnT =
-            cast<FunctionType>(cast<PointerType>(V->getType())->getElementType());
-    #else
-        FunctionType *FnT =
-            cast<FunctionType>(cast<PointerType>(V->getType())->getPointerElementType()); // deprecated
-    #endif
-
     SmallVector<OperandBundleDef, 1> BundleArray;
     for (auto *Bundle : makeArrayRef(Bundles, NumBundles))
         BundleArray.push_back(*unwrap<OperandBundleDef>(Bundle));
 
     llvm::IRBuilder<> *Builder = unwrap(B);
     llvm::ArrayRef<llvm::Value*> args = makeArrayRef(unwrap(Args), NumArgs);
 
+    FunctionType *FnT = unwrap<Function>(Fn)->getFunctionType();
     llvm::CallInst *CI = Builder->CreateCall(FnT, unwrap(Fn), args ,BundleArray, Name);
     return wrap(CI);
 }
@@ -576,3 +566,12 @@ LLVMTypeRef LLVMGetGlobalValueType(LLVMValueRef GV) {
     auto Ftype = unwrap<GlobalValue>(GV)->getValueType();
     return wrap(Ftype);
 }
+
+#if LLVM_VERSION_MAJOR >= 13 && LLVM_VERSION_MAJOR < 15
+LLVMBool LLVMPointerTypeIsOpaque(LLVMTypeRef Ty) {
+  return unwrap(Ty)->isOpaquePointerTy();
+}
+LLVMTypeRef LLVMPointerTypeInContext(LLVMContextRef C, unsigned AddressSpace) {
+  return wrap(PointerType::get(*unwrap(C), AddressSpace));
+}
+#endif

lib/libLLVM_extra.jl

@@ -432,3 +432,12 @@ end
 function LLVMGetBuilderContext(B)
     ccall((:LLVMGetBuilderContext, libLLVMExtra), LLVMContextRef, (LLVMBuilderRef,), B)
 end
+
+if v"13" <= version() < v"15"
+function LLVMPointerTypeIsOpaque(Ty)
+    ccall((:LLVMPointerTypeIsOpaque, libLLVMExtra), LLVMBool, (LLVMTypeRef,), Ty)
+end
+function LLVMPointerTypeInContext(C, AddressSpace)
+    ccall((:LLVMPointerTypeInContext, libLLVMExtra), LLVMTypeRef, (LLVMContextRef, Cuint), C, AddressSpace)
+end
+end

src/core/type.jl

@@ -134,7 +134,7 @@ abstract type CompositeType <: LLVMType end
 
 ## sequential types
 
-export addrspace
+export addrspace, is_opaque
 
 abstract type SequentialType <: CompositeType end
 
@@ -150,12 +150,20 @@ function PointerType(eltyp::LLVMType, addrspace=0)
     return PointerType(API.LLVMPointerType(eltyp, addrspace))
 end
 
-if version() >= v"15"
-    function PointerType(ctx::Context, addrspace=0)
-        return PointerType(API.LLVMPointerTypeInContext(ctx, addrspace))
-    end
+function PointerType(addrspace=0; ctx::Context)
+    return PointerType(API.LLVMPointerTypeInContext(ctx, addrspace))
+end
 
-    Base.eltype(typ::PointerType) = throw(error("Taking the type of an opaque pointer is illegal"))
+if version() >= v"13"
+    is_opaque(ptrtyp::PointerType) =
+        convert(Core.Bool, API.LLVMPointerTypeIsOpaque(ptrtyp))
+
+    function Base.eltype(typ::PointerType)
+        is_opaque(typ) && throw(error("Taking the type of an opaque pointer is illegal"))
+        invoke(eltype, Tuple{SequentialType}, typ)
+    end
+else
+    is_opaque(ptrtyp::PointerType) = false
 end
 
 addrspace(ptrtyp::PointerType) =

test/core.jl

@@ -27,9 +27,9 @@ Context() do ctx end
 
 @dispose ctx=Context() begin
     @test supports_typed_pointers(ctx) isa Bool
-    if LLVM.version() > v"15"
+    if LLVM.version() > v"17"
         @test supports_typed_pointers(ctx) == false
-    else
+    elseif LLVM.version() < v"13"
         @test supports_typed_pointers(ctx) == true
     end
 end
@@ -90,7 +90,7 @@ end
     eltyp = LLVM.Int32Type(ctx)
 
     ptrtyp = LLVM.PointerType(eltyp)
-    if supports_typed_ptrs
+    if supports_typed_pointers(ctx)
         @test eltype(ptrtyp) == eltyp
     end
 
@@ -545,7 +545,7 @@ end
     @testset "constant expressions" begin
 
     # inline assembly
-    if supports_typed_ptrs
+    if supports_typed_pointers(ctx)
         let
             ft = LLVM.FunctionType(LLVM.VoidType(ctx))
             asm = InlineAsm(ft, "nop", "", false)
@@ -587,7 +587,7 @@ end
             ce = f(val, other_val)::LLVM.Constant
             @check_ir ce "i32 84"
         end
-        if supports_typed_ptrs
+        if supports_typed_pointers(ctx)
             for f in [const_udiv, const_sdiv]
                 ce = f(val, other_val)::LLVM.Constant
                 @check_ir ce "i32 21"
@@ -655,7 +655,7 @@ end
         @check_ir ce "float -4.200000e+01"
 
         other_val = LLVM.ConstantFP(Float32(2.); ctx)
-        if supports_typed_ptrs
+        if supports_typed_pointers(ctx)
             ce = const_fadd(val, other_val)::LLVM.Constant
             @check_ir ce "float 4.400000e+01"
 
@@ -698,15 +698,15 @@ end
         @check_ir ce "i32 0"
 
         ce = const_inttoptr(ce, value_type(ptr))::LLVM.Constant
-        if supports_typed_ptrs
+        if supports_typed_pointers(ctx)
             @check_ir ce "i32* null"
         else
             @check_ir ce "ptr null"
         end
         @test isempty(uses(ptr))
         for f in [const_addrspacecast, const_pointercast]
             ce = f(ptr, LLVM.PointerType(LLVM.Int32Type(ctx), 1))::LLVM.Constant
-            if supports_typed_ptrs
+            if supports_typed_pointers(ctx)
                 @check_ir ce "i32 addrspace(1)* addrspacecast (i32* null to i32 addrspace(1)*)"
             else
                 @check_ir ce "ptr addrspace(1) addrspacecast (ptr null to ptr addrspace(1))"
@@ -1167,7 +1167,7 @@ end
     fn = LLVM.Function(mod, intr)
     @test fn isa LLVM.Function
 
-    if supports_typed_ptrs
+    if supports_typed_pointers(ctx)
         @test eltype(value_type(fn)) == ft
     end
     @test isintrinsic(fn)
@@ -1194,7 +1194,7 @@ end
 
     fn = LLVM.Function(mod, intr, [LLVM.DoubleType(ctx)])
     @test fn isa LLVM.Function
-    if supports_typed_ptrs
+    if supports_typed_pointers(ctx)
         @test eltype(value_type(fn)) == ft
     end
     @test isintrinsic(fn)

test/helpers.jl

@@ -4,9 +4,3 @@ macro check_ir(inst, str)
         @test occursin($(str), inst)
     end
 end
-
-const supports_typed_ptrs = begin
-    @dispose ctx=Context() begin
-        supports_typed_pointers(ctx)
-    end
-end