First pass at (incomplete) LLVM 3.8 support

Author: TheDan64

.travis.yml

@@ -55,6 +55,17 @@ matrix:
           packages:
             - *BASE_PACKAGES
             - llvm-3.7-dev
+    - env:
+        - LLVM_VERSION="3.8"
+      <<: *BASE
+      addons:
+        apt:
+          sources:
+            - *BASE_SOURCES
+            - llvm-toolchain-precise-3.8
+          packages:
+            - *BASE_PACKAGES
+            - llvm-3.8-dev
     - deploy: # Documentation build; Only latest supported LLVM version for now
         provider: pages
         skip-cleanup: true

Cargo.toml

@@ -14,12 +14,13 @@ categories = ["development-tools::ffi"]
 default = []
 llvm3-6 = []
 llvm3-7 = []
+llvm3-8 = []
 
 [dependencies]
 either = "1.4.0"
 enum-methods = "0.0.8"
 libc = "*"
-llvm-sys = "37"
+llvm-sys = "38"
 
 [[example]]
 name = "kaleidoscope"

src/lib.rs

@@ -20,18 +20,21 @@ pub mod types;
 pub mod values;
 
 use llvm_sys::{LLVMIntPredicate, LLVMRealPredicate, LLVMVisibility, LLVMThreadLocalMode, LLVMDLLStorageClass};
-use llvm_sys::core::LLVMResetFatalErrorHandler;
 use llvm_sys::support::LLVMLoadLibraryPermanently;
 
 use std::ffi::CString;
 
-#[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+
+
+#[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7", feature = "llvm3-8")))]
 compile_error!("A LLVM feature flag must be provided. See the README for more details.");
 
 // TODO: Probably move into error handling module
 pub fn enable_llvm_pretty_stack_trace() {
-    // use llvm_sys::error_handling::LLVMEnablePrettyStackTrace; // v3.8
+    #[cfg(any(feature = "llvm3-6", feature = "llvm3-7"))]
     use llvm_sys::core::LLVMEnablePrettyStackTrace;
+    #[cfg(feature = "llvm3-8")]
+    use llvm_sys::error_handling::LLVMEnablePrettyStackTrace;
 
     unsafe {
         LLVMEnablePrettyStackTrace()
@@ -88,6 +91,11 @@ pub fn shutdown_llvm() {
 
 /// Resets LLVM's fatal error handler back to the default
 pub fn reset_fatal_error_handler() {
+    #[cfg(any(feature = "llvm3-6", feature = "llvm3-7"))]
+    use llvm_sys::core::LLVMResetFatalErrorHandler;
+    #[cfg(feature = "llvm3-8")]
+    use llvm_sys::error_handling::LLVMResetFatalErrorHandler;
+
     unsafe {
         LLVMResetFatalErrorHandler()
     }

src/types/enums.rs

@@ -61,7 +61,8 @@ impl AnyTypeEnum {
             LLVMTypeKind::LLVMVectorTypeKind => AnyTypeEnum::VectorType(VectorType::new(type_)),
             LLVMTypeKind::LLVMMetadataTypeKind => panic!("FIXME: Unsupported type: Metadata"),
             LLVMTypeKind::LLVMX86_MMXTypeKind => panic!("FIXME: Unsupported type: MMX"),
-            // LLVMTypeKind::LLVMTokenTypeKind => panic!("FIXME: Unsupported type: Token"), // Different version?
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            LLVMTypeKind::LLVMTokenTypeKind => panic!("FIXME: Unsupported type: Token"),
         }
     }
 }
@@ -89,6 +90,8 @@ impl BasicTypeEnum {
             LLVMTypeKind::LLVMLabelTypeKind => unreachable!("Unsupported type: Label"),
             LLVMTypeKind::LLVMVoidTypeKind => unreachable!("Unsupported type: VoidType"),
             LLVMTypeKind::LLVMFunctionTypeKind => unreachable!("Unsupported type: FunctionType"),
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            LLVMTypeKind::LLVMTokenTypeKind => panic!("FIXME: Unsupported type: Token"),
         }
     }
 }

src/values/instruction_value.rs

@@ -22,12 +22,16 @@ pub enum InstructionOpcode {
     BitCast,
     Br,
     Call,
-    // Later versions:
-    // CatchPad,
-    // CatchRet,
-    // CatchSwitch,
-    // CleanupPad,
-    // CleanupRet,
+    #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+    CatchPad,
+    #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+    CatchRet,
+    #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+    CatchSwitch,
+    #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+    CleanupPad,
+    #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+    CleanupRet,
     ExtractElement,
     ExtractValue,
     FAdd,
@@ -92,12 +96,16 @@ impl InstructionOpcode {
             LLVMOpcode::LLVMBitCast => InstructionOpcode::BitCast,
             LLVMOpcode::LLVMBr => InstructionOpcode::Br,
             LLVMOpcode::LLVMCall => InstructionOpcode::Call,
-            // Newer versions:
-            // LLVMOpcode::LLVMCatchPad => InstructionOpcode::CatchPad,
-            // LLVMOpcode::LLVMCatchRet => InstructionOpcode::CatchRet,
-            // LLVMOpcode::LLVMCatchSwitch => InstructionOpcode::CatchSwitch,
-            // LLVMOpcode::LLVMCleanupPad => InstructionOpcode::CleanupPad,
-            // LLVMOpcode::LLVMCleanupRet => InstructionOpcode::CleanupRet,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            LLVMOpcode::LLVMCatchPad => InstructionOpcode::CatchPad,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            LLVMOpcode::LLVMCatchRet => InstructionOpcode::CatchRet,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            LLVMOpcode::LLVMCatchSwitch => InstructionOpcode::CatchSwitch,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            LLVMOpcode::LLVMCleanupPad => InstructionOpcode::CleanupPad,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            LLVMOpcode::LLVMCleanupRet => InstructionOpcode::CleanupRet,
             LLVMOpcode::LLVMExtractElement => InstructionOpcode::ExtractElement,
             LLVMOpcode::LLVMExtractValue => InstructionOpcode::ExtractValue,
             LLVMOpcode::LLVMFAdd => InstructionOpcode::FAdd,
@@ -162,12 +170,16 @@ impl InstructionOpcode {
             InstructionOpcode::BitCast => LLVMOpcode::LLVMBitCast,
             InstructionOpcode::Br => LLVMOpcode::LLVMBr,
             InstructionOpcode::Call => LLVMOpcode::LLVMCall,
-            // Newer versions:
-            // InstructionOpcode::CatchPad => LLVMOpcode::LLVMCatchPad,
-            // InstructionOpcode::CatchRet => LLVMOpcode::LLVMCatchRet,
-            // InstructionOpcode::CatchSwitch => LLVMOpcode::LLVMCatchSwitch,
-            // InstructionOpcode::CleanupPad => LLVMOpcode::LLVMCleanupPad,
-            // InstructionOpcode::CleanupRet => LLVMOpcode::LLVMCleanupRet,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            InstructionOpcode::CatchPad => LLVMOpcode::LLVMCatchPad,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            InstructionOpcode::CatchRet => LLVMOpcode::LLVMCatchRet,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            InstructionOpcode::CatchSwitch => LLVMOpcode::LLVMCatchSwitch,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            InstructionOpcode::CleanupPad => LLVMOpcode::LLVMCleanupPad,
+            #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+            InstructionOpcode::CleanupRet => LLVMOpcode::LLVMCleanupRet,
             InstructionOpcode::ExtractElement => LLVMOpcode::LLVMExtractElement,
             InstructionOpcode::ExtractValue => LLVMOpcode::LLVMExtractValue,
             InstructionOpcode::FAdd => LLVMOpcode::LLVMFAdd,

src/values/metadata_value.rs

@@ -14,6 +14,8 @@ use std::slice::from_raw_parts;
 pub const FIRST_CUSTOM_METADATA_KIND_ID: u32 = 12;
 #[cfg(feature = "llvm3-7")]
 pub const FIRST_CUSTOM_METADATA_KIND_ID: u32 = 14;
+#[cfg(feature = "llvm3-8")]
+pub const FIRST_CUSTOM_METADATA_KIND_ID: u32 = 20; // FIXME
 
 #[derive(PartialEq, Eq, Clone, Copy)]
 pub struct MetadataValue {

tests/test_builder.rs

@@ -440,7 +440,10 @@ fn test_no_builder_double_free2() {
     builder.position_at_end(&entry);
     builder.build_unreachable();
 
+    #[cfg(any(feature = "llvm3-6", feature = "llvm3-7"))]
     assert_eq!(module.print_to_string(), &*CString::new("; ModuleID = \'my_mod\'\n\ndefine void @my_fn() {\nentry:\n  unreachable\n}\n").unwrap());
+    #[cfg(not(any(feature = "llvm3-6", feature = "llvm3-7")))]
+    assert_eq!(module.print_to_string(), &*CString::new("; ModuleID = \'my_mod\'\nsource_filename = \"my_mod\"\n\ndefine void @my_fn() {\nentry:\n  unreachable\n}\n").unwrap());
 
     // 2nd Context drops fine
     // Builds drops fine

tests/test_execution_engine.rs

@@ -4,9 +4,12 @@ use self::inkwell::OptimizationLevel;
 use self::inkwell::context::Context;
 use self::inkwell::execution_engine::FunctionLookupError;
 use self::inkwell::targets::{InitializationConfig, Target};
+use self::inkwell::enable_llvm_pretty_stack_trace;
 
 #[test]
 fn test_get_function_address() {
+    enable_llvm_pretty_stack_trace();
+
     let context = Context::create();
     // let module = context.create_module("errors_abound");
     let builder = context.create_builder();