Support for module metadata (#150)

maleadt · web-flow · commit c478a8975c71 · 2019-07-18T09:43:27.000+02:00
diff --git a/.appveyor.yml b/.appveyor.yml
@@ -1,7 +1,7 @@
 environment:
   matrix:
-  - julia_version: 0.7
   - julia_version: 1.0
+  - julia_version: 1.1
   - julia_version: latest
 
 platform:
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -5,6 +5,7 @@ include:
   - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v4/common.yml'
   - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v4/test_v1.0.yml'
   - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v4/test_v1.1.yml'
+  - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v4/test_v1.2.yml'
   - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v4/test_dev.yml'
   - 'https://raw.githubusercontent.com/JuliaGPU/gitlab-ci/master/templates/v4/coverage_v1.1.yml'
 
diff --git a/.travis.yml b/.travis.yml
@@ -5,8 +5,8 @@ os:
   - osx
 
 julia:
-  - 0.7
   - 1.0
+  - 1.1
   - nightly
 
 notifications:
diff --git a/lib/8.0/libLLVM_common.jl b/lib/8.0/libLLVM_common.jl
@@ -483,26 +483,6 @@ const LLVMErrorSuccess = 0
 mutable struct LLVMOpaqueError end
 const LLVMErrorRef = Ptr{LLVMOpaqueError}
 const LLVMErrorTypeId = Ptr{Cvoid}
-# const LLVM_DEFAULT_TARGET_TRIPLE = "x86_64-linux-gnu"
-# const LLVM_ENABLE_THREADS = 1
-# const LLVM_HAS_ATOMICS = 1
-# const LLVM_HOST_TRIPLE = "x86_64-linux-gnu"
-# const LLVM_NATIVE_ARCH = X86
-# const LLVM_NATIVE_ASMPARSER = LLVMInitializeX86AsmParser
-# const LLVM_NATIVE_ASMPRINTER = LLVMInitializeX86AsmPrinter
-# const LLVM_NATIVE_DISASSEMBLER = LLVMInitializeX86Disassembler
-# const LLVM_NATIVE_TARGET = LLVMInitializeX86Target
-# const LLVM_NATIVE_TARGETINFO = LLVMInitializeX86TargetInfo
-# const LLVM_NATIVE_TARGETMC = LLVMInitializeX86TargetMC
-# const LLVM_ON_UNIX = 1
-# const LLVM_USE_INTEL_JITEVENTS = 0
-# const LLVM_USE_OPROFILE = 0
-# const LLVM_USE_PERF = 0
-# const LLVM_VERSION_MAJOR = 8
-# const LLVM_VERSION_MINOR = 0
-# const LLVM_VERSION_PATCH = 0
-# const LLVM_VERSION_STRING = "8.0.0"
-# const LLVM_FORCE_ENABLE_STATS = 0
 
 # Skipping MacroDefinition: LLVM_TARGET ( TargetName ) void LLVMInitialize ## TargetName ## TargetInfo ( void ) ;
 # Skipping MacroDefinition: LLVM_TARGET ( TargetName ) void LLVMInitialize ## TargetName ## Target ( void ) ;
diff --git a/lib/libLLVM_extra.jl b/lib/libLLVM_extra.jl
@@ -94,7 +94,7 @@ end
 
 else
 
-if LLVM.libllvm_version < v"8.0.0"
+if libllvm_version < v"8.0"
 
 function LLVMAddNVVMReflectPass(PM::LLVMPassManagerRef, smversion)
     @apicall(:LLVMExtraAddNVVMReflectPass,Cvoid,(LLVMPassManagerRef,), PM)
@@ -161,3 +161,12 @@ function LLVMGetSourceLocation(V::LLVMValueRef, index, Name, Filename, Line, Col
 end
 
 end
+
+if libllvm_version >= v"8.0"
+    @cenum(LLVMDebugEmissionKind,
+        LLVMDebugEmissionKindNoDebug = 0,
+        LLVMDebugEmissionKindFullDebug = 1,
+        LLVMDebugEmissionKindLineTablesOnly = 2,
+        LLVMDebugEmissionKindDebugDirectivesOnly = 3,
+    )
+end
diff --git a/src/core/instructions.jl b/src/core/instructions.jl
@@ -45,6 +45,7 @@ predicate_real(inst::Instruction) = API.LLVMGetFCmpPredicate(ref(inst))
 
 
 ## metadata iteration
+# TODO: doesn't actually iterate, since we can't list the available keys
 
 @enum(MD, MD_dbg = 0,
           MD_tbaa = 1,
@@ -72,8 +73,6 @@ predicate_real(inst::Instruction) = API.LLVMGetFCmpPredicate(ref(inst))
 
 export InstructionMetadataDict
 
-# doesn't print, because we don't have length. we can't iterate keys?
-
 struct InstructionMetadataDict <: AbstractDict{MD,MetadataAsValue}
     inst::Instruction
 end
diff --git a/src/core/metadata.jl b/src/core/metadata.jl
@@ -1,4 +1,4 @@
-export MDString, MDNode, operands
+export MDString, MDNode, operands, Metadata
 
 @checked struct MetadataAsValue <: Value
     ref::reftype(Value)
@@ -12,7 +12,7 @@ const MDString = MetadataAsValue
 
 MDString(val::String) = MDString(API.LLVMMDString(val, Cuint(length(val))))
 
-MDString(val::String, ctx::Context) = 
+MDString(val::String, ctx::Context) =
     MDString(API.LLVMMDStringInContext(ref(ctx), val, Cuint(length(val))))
 
 function Base.convert(::Type{String}, md::MDString)
@@ -38,3 +38,17 @@ function operands(md::MDNode)
     API.LLVMGetMDNodeOperands(ref(md), ops)
     return Value[Value(op) for op in ops]
 end
+
+
+@checked struct Metadata
+    ref::API.LLVMMetadataRef
+end
+reftype(::Type{Metadata}) = API.LLVMMetadataRef
+
+function Metadata(val::Value)
+    return Metadata(LLVM.API.LLVMValueAsMetadata(ref(val)))
+end
+
+function Value(md::Metadata, ctx::Context)
+    return MetadataAsValue(API.LLVMMetadataAsValue(ref(ctx), ref(md)))
+end
diff --git a/src/core/module.jl b/src/core/module.jl
@@ -176,3 +176,31 @@ function Base.getindex(iter::ModuleFunctionSet, name::String)
     objref == C_NULL && throw(KeyError(name))
     return Function(objref)
 end
+
+
+## module flag iteration
+# TODO: doesn't actually iterate, since we can't list the available keys
+
+if libllvm_version >= v"8.0"
+
+export flags
+
+struct ModuleFlagDict <: AbstractDict{String,Metadata}
+    mod::Module
+end
+
+flags(mod::Module) = ModuleFlagDict(mod)
+
+Base.haskey(iter::ModuleFlagDict, name::String) =
+    API.LLVMGetModuleFlag(ref(iter.mod), name, length(name)) != C_NULL
+
+function Base.getindex(iter::ModuleFlagDict, name::String)
+    objref = API.LLVMGetModuleFlag(ref(iter.mod), name, length(name))
+    objref == C_NULL && throw(KeyError(name))
+    return Metadata(objref)
+end
+
+Base.push!(iter::ModuleFlagDict, behavior::LLVM.API.LLVMModuleFlagBehavior, name::String, val::Metadata) =
+    API.LLVMAddModuleFlag(ref(iter.mod), behavior, name, length(name), ref(val))
+
+end
diff --git a/src/core/value/constant.jl b/src/core/value/constant.jl
@@ -151,7 +151,7 @@ export GlobalValue,
        unnamed_addr, unnamed_addr!,
        alignment, alignment!
 
-parent(val::GlobalValue) = LLVM.Module(API.LLVMGetGlobalParent(ref(val)))
+parent(val::GlobalValue) = Module(API.LLVMGetGlobalParent(ref(val)))
 
 isdeclaration(val::GlobalValue) = convert(Core.Bool, API.LLVMIsDeclaration(ref(val)))
 
diff --git a/src/debuginfo.jl b/src/debuginfo.jl
@@ -3,3 +3,8 @@ export DEBUG_METADATA_VERSION, strip_debuginfo!
 DEBUG_METADATA_VERSION() = API.LLVMDebugMetadataVersion()
 
 strip_debuginfo!(mod::Module) = API.LLVMStripModuleDebugInfo(ref(mod))
+
+if libllvm_version >= v"8.0"
+set_subprogram!(func::Function, sp::Metadata) = LLVM.API.LLVMSetSubprogram(ref(func), ref(sp))
+get_subprogram(func::Function) = Metadata(LLVM.API.LLVMGetSubprogram(ref(func)))
+end
diff --git a/src/pass.jl b/src/pass.jl
@@ -16,7 +16,7 @@ export ModulePass
 
     function ModulePass(name::String, runner::Core.Function)
         function callback(ptr::Ptr{Cvoid})::Core.Bool
-            mod = LLVM.Module(convert(reftype(Module), ptr))
+            mod = Module(convert(reftype(Module), ptr))
             return runner(mod)::Core.Bool
         end
 
@@ -38,7 +38,7 @@ export FunctionPass
 
     function FunctionPass(name::String, runner::Core.Function)
         function callback(ptr::Ptr{Cvoid})::Core.Bool
-            fn = LLVM.Function(convert(reftype(Function), ptr))
+            fn = Function(convert(reftype(Function), ptr))
             return runner(fn)::Core.Bool
         end
 
diff --git a/src/passmanager.jl b/src/passmanager.jl
@@ -32,7 +32,7 @@ function ModulePassManager(f::Core.Function, args...)
 end
 
 run!(mpm::ModulePassManager, mod::Module) =
-    LLVM.convert(Core.Bool, API.LLVMRunPassManager(ref(mpm), ref(mod)))
+    convert(Core.Bool, API.LLVMRunPassManager(ref(mpm), ref(mod)))
 
 
 
@@ -65,4 +65,4 @@ finalize!(fpm::FunctionPassManager) =
     convert(Core.Bool, API.LLVMFinalizeFunctionPassManager(ref(fpm)))
 
 run!(fpm::FunctionPassManager, f::Function) =
-    LLVM.convert(Core.Bool, API.LLVMRunFunctionPassManager(ref(fpm), ref(f)))
+    convert(Core.Bool, API.LLVMRunFunctionPassManager(ref(fpm), ref(f)))
diff --git a/test/core.jl b/test/core.jl
@@ -528,6 +528,19 @@ LLVM.Module("SomeModule", ctx) do mod
     dummyLayout = "e-p:64:64:64"
     datalayout!(mod, dummyLayout)
     @test convert(String, datalayout(mod)) == dummyLayout
+
+    if LLVM.version() >= v"8.0"
+        md = Metadata(ConstantInt(42, ctx))
+
+        mod_flags = flags(mod)
+        push!(mod_flags, LLVM.API.LLVMModuleFlagBehaviorError, "foobar", md)
+
+        @test occursin("!llvm.module.flags = !{!0}", sprint(io->show(io,mod)))
+        @test occursin(r"!0 = !\{i\d+ 1, !\"foobar\", i\d+ 42\}", sprint(io->show(io,mod)))
+
+        @test mod_flags["foobar"] == md
+        @test_throws KeyError mod_flags["foobaz"]
+    end
 end
 end
 
@@ -929,6 +942,10 @@ LLVM.Module("SomeModule", ctx) do mod
         @test isempty(md)
         @test !haskey(md, LLVM.MD_dbg)
     end
+    let val = ConstantInt(42, ctx)
+        md = Metadata(val)
+        @test first(operands(LLVM.Value(md, ctx))) == val
+    end
 
     @test retinst in instructions(bb3)
     delete!(bb3, retinst)
diff --git a/test/debuginfo.jl b/test/debuginfo.jl
@@ -3,7 +3,7 @@
 DEBUG_METADATA_VERSION()
 
 Context() do ctx
-    if LLVM.libllvm_version < v"8.0.0"
+    if LLVM.version() < v"8.0"
         mod = parse(LLVM.Module,  """
             define void @fun() !dbg !5 {
             top:
diff --git a/test/transform.jl b/test/transform.jl
@@ -68,7 +68,7 @@ ModulePassManager() do pm
     scoped_no_alias_aa!(pm)
     basic_alias_analysis!(pm)
 
-    if LLVM.libllvm_version < v"8.0.0"
+    if LLVM.version() < v"8.0"
         bbvectorize!(pm)
     end
     loop_vectorize!(pm)

-Original file line number
+Diff line change
   - osx
 julia:
 -  - 0.7
   - 1.0
 +  - 1.1
   - nightly
 notifications: