The final push

Signed-off-by: Alex Saveau <[email protected]>

.github/workflows/test.yml

@@ -4,23 +4,24 @@ on: [push, pull_request]
 
 env:
   CARGO_TERM_COLOR: always
-  DOC_LLVM_FEATURE: llvm16-0
-  DOC_LLVM_VERSION: '16.0'
+  DOC_LLVM_FEATURE: llvm17-0
+  DOC_LLVM_VERSION: '17.0'
   DOC_PATH: target/doc
 
 jobs:
   typos:
     name: Typos
     runs-on: ubuntu-latest
     steps:
+      - name: Install Rust Stable
+        run: rustup toolchain install stable
       - name: Install typos
         run: cargo install typos-cli
       - name: Run typos
         run: typos .
   tests:
     name: "LLVM ${{ matrix.llvm-version[0] }}: ${{ matrix.os }}"
     runs-on: ${{ matrix.os }}
-    needs: typos
     strategy:
       matrix:
         llvm-version:
@@ -37,11 +38,14 @@ jobs:
           - ["14.0", "14-0"]
           - ["15.0", "15-0"]
           - ["16.0", "16-0"]
+          - ["17.0", "17-0"]
         # only use ubuntu-22.04 for llvm 16 and higher
         include:
           - os: ubuntu-20.04
           - os: ubuntu-22.04
             llvm-version: ["16.0", "16-0"]
+          - os: ubuntu-22.04
+            llvm-version: ["17.0", "17-0"]
     steps:
       - name: Checkout Repo
         uses: actions/checkout@v3
@@ -58,7 +62,7 @@ jobs:
   doc:
     name: Documentation
     runs-on: ubuntu-latest
-    needs: tests
+    needs: [typos, tests]
     if: github.event_name == 'push' && github.ref == 'refs/heads/master'
     steps:
     - uses: actions/checkout@v3

Cargo.toml

@@ -143,7 +143,7 @@ llvm-sys-130 = { package = "llvm-sys", version = "130.0.4", optional = true }
 llvm-sys-140 = { package = "llvm-sys", version = "140.0.2", optional = true }
 llvm-sys-150 = { package = "llvm-sys", version = "150.0.3", optional = true }
 llvm-sys-160 = { package = "llvm-sys", version = "160.1.0", optional = true }
-llvm-sys-170 = { package = "llvm-sys", version = "170.0.0", optional = true }
+llvm-sys-170 = { package = "llvm-sys", version = "170.0.1", optional = true }
 once_cell = "1.16"
 static-alloc = { version = "0.2", optional = true }
 thiserror = "1.0.48"

README.md

@@ -14,7 +14,7 @@ Inkwell aims to help you pen your own programming languages by safely wrapping l
 ## Requirements
 
 * Rust 1.56+ (Stable, Beta, or Nightly)
-* LLVM 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.0, 13.0, 14.0, 15.0, or 16.0
+* One of LLVM 4-17
 
 ## Usage
 
@@ -23,26 +23,11 @@ branch with a corresponding LLVM feature flag:
 
 ```toml
 [dependencies]
-inkwell = { git = "https://github.com/TheDan64/inkwell", branch = "master", features = ["llvm12-0"] }
+inkwell = { git = "https://github.com/TheDan64/inkwell", branch = "master", features = ["llvm17-0"] }
 ```
 
 Supported versions:
-
-| LLVM Version | Cargo Feature Flag |
-| :----------: | :-----------: |
-| 4.0.x        | llvm4-0       |
-| 5.0.x        | llvm5-0       |
-| 6.0.x        | llvm6-0       |
-| 7.0.x        | llvm7-0       |
-| 8.0.x        | llvm8-0       |
-| 9.0.x        | llvm9-0       |
-| 10.0.x       | llvm10-0      |
-| 11.0.x       | llvm11-0      |
-| 12.0.x       | llvm12-0      |
-| 13.0.x       | llvm13-0      |
-| 14.0.x       | llvm14-0      |
-| 15.0.x       | llvm15-0      |
-| 16.0.x       | llvm16-0      |
+LLVM 4-17 mapping to a cargo feature flag `llvmM-0` where `M` corresponds to the LLVM major version.
 
 Please be aware that we may make breaking changes on master from time to time since we are
 pre-v1.0.0, in compliance with semver. Please prefer a crates.io release whenever possible!

src/builder.rs

@@ -2738,7 +2738,7 @@ impl<'ctx> Builder<'ctx> {
     ///     feature = "llvm14-0"
     /// ))]
     /// let array = builder.build_load(array_alloca, "array_load").unwrap().into_array_value();
-    /// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    /// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     /// let array = builder.build_load(i32_type, array_alloca, "array_load").unwrap().into_array_value();
     ///
     /// let const_int1 = i32_type.const_int(2, false);
@@ -2821,7 +2821,7 @@ impl<'ctx> Builder<'ctx> {
     ///     feature = "llvm14-0"
     /// ))]
     /// let array = builder.build_load(array_alloca, "array_load").unwrap().into_array_value();
-    /// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    /// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     /// let array = builder.build_load(i32_type, array_alloca, "array_load").unwrap().into_array_value();
     ///
     /// let const_int1 = i32_type.const_int(2, false);

src/passes.rs

@@ -14,7 +14,7 @@ use llvm_sys::initialization::{
 use llvm_sys::initialization::{LLVMInitializeInstrumentation, LLVMInitializeObjCARCOpts};
 use llvm_sys::prelude::LLVMPassManagerRef;
 #[llvm_versions(4.0..=16.0)]
-use llvm_sys::prelude::LLVMPassRegistry;
+use llvm_sys::prelude::LLVMPassRegistryRef;
 #[llvm_versions(10.0..=16.0)]
 use llvm_sys::transforms::ipo::LLVMAddMergeFunctionsPass;
 #[llvm_versions(4.0..=15.0)]

tests/all/main.rs

@@ -15,6 +15,7 @@ mod test_instruction_values;
 mod test_intrinsics;
 mod test_module;
 mod test_object_file;
+#[cfg(not(any(feature = "llvm17-0")))]
 mod test_passes;
 mod test_targets;
 mod test_tari_example;

tests/all/test_builder.rs

@@ -70,7 +70,7 @@ fn test_build_call() {
         feature = "llvm14-0"
     ))]
     let load = builder.build_load(alloca, "load").unwrap().into_pointer_value();
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     let load = builder
         .build_load(fn_ptr_type, alloca, "load")
         .unwrap()
@@ -94,7 +94,7 @@ fn test_build_call() {
         let callable_value = CallableValue::try_from(load).unwrap();
         builder.build_call(callable_value, &[], "call").unwrap();
     }
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     builder.build_indirect_call(fn_type2, load, &[], "call");
     builder.build_return(None).unwrap();
 
@@ -394,7 +394,7 @@ fn test_null_checked_ptr_ops() {
         feature = "llvm14-0"
     ))]
     let index1 = builder.build_load(new_ptr, "deref").unwrap();
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     let index1 = builder.build_load(i8_ptr_type, new_ptr, "deref").unwrap();
 
     builder.build_return(Some(&index1)).unwrap();
@@ -448,7 +448,7 @@ fn test_null_checked_ptr_ops() {
         feature = "llvm14-0"
     ))]
     let index1 = builder.build_load(new_ptr, "deref").unwrap();
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     let index1 = builder.build_load(i8_ptr_type, new_ptr, "deref").unwrap();
 
     builder.build_return(Some(&index1)).unwrap();
@@ -984,7 +984,7 @@ fn test_insert_value() {
         .build_load(array_alloca, "array_load")
         .unwrap()
         .into_array_value();
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     let array = builder
         .build_load(array_type, array_alloca, "array_load")
         .unwrap()
@@ -1038,7 +1038,7 @@ fn test_insert_value() {
         .build_load(struct_alloca, "struct_load")
         .unwrap()
         .into_struct_value();
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     let struct_value = builder
         .build_load(struct_type, struct_alloca, "struct_load")
         .unwrap()
@@ -1207,7 +1207,7 @@ fn run_memcpy_on<'ctx>(
             feature = "llvm14-0"
         ))]
         let elem_ptr = unsafe { builder.build_in_bounds_gep(array_ptr, &[index_val], "index") }.unwrap();
-        #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+        #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
         let elem_ptr = unsafe {
             builder
                 .build_in_bounds_gep(element_type, array_ptr, &[index_val], "index")
@@ -1237,7 +1237,7 @@ fn run_memcpy_on<'ctx>(
         feature = "llvm14-0"
     ))]
     let dest_ptr = unsafe { builder.build_in_bounds_gep(array_ptr, &[index_val], "index") }.unwrap();
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     let dest_ptr = unsafe {
         builder
             .build_in_bounds_gep(element_type, array_ptr, &[index_val], "index")
@@ -1317,7 +1317,7 @@ fn run_memmove_on<'ctx>(
             feature = "llvm14-0"
         ))]
         let elem_ptr = unsafe { builder.build_in_bounds_gep(array_ptr, &[index_val], "index") }.unwrap();
-        #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+        #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
         let elem_ptr = unsafe {
             builder
                 .build_in_bounds_gep(element_type, array_ptr, &[index_val], "index")
@@ -1347,7 +1347,7 @@ fn run_memmove_on<'ctx>(
         feature = "llvm14-0"
     ))]
     let dest_ptr = unsafe { builder.build_in_bounds_gep(array_ptr, &[index_val], "index") }.unwrap();
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     let dest_ptr = unsafe {
         builder
             .build_in_bounds_gep(element_type, array_ptr, &[index_val], "index")
@@ -1434,7 +1434,7 @@ fn run_memset_on<'ctx>(
         feature = "llvm14-0"
     ))]
     let part_2 = unsafe { builder.build_in_bounds_gep(array_ptr, &[index], "index") }.unwrap();
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     let part_2 = unsafe {
         builder
             .build_in_bounds_gep(element_type, array_ptr, &[index], "index")
@@ -1798,7 +1798,7 @@ fn test_safe_struct_gep() {
         assert!(builder.build_struct_gep(struct_ptr, 1, "struct_gep").is_ok());
         assert!(builder.build_struct_gep(struct_ptr, 2, "struct_gep").is_err());
     }
-    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0"))]
+    #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0"))]
     {
         assert!(builder.build_struct_gep(i32_ty, i32_ptr, 0, "struct_gep").is_err());
         assert!(builder.build_struct_gep(i32_ty, i32_ptr, 10, "struct_gep").is_err());