Update for llvm-bitcode-linker

Author: juntyr

.github/workflows/ci.yml

@@ -0,0 +1,103 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - '*'
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  check:
+    name: Check
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        rust: [nightly]
+
+      - name: Checkout the Repository
+        uses: actions/checkout@v2
+      
+      - name: Install the Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.rust }}
+          profile: minimal
+          target: nvptx64-nvidia-cuda
+          components: llvm-bitcode-linker, llvm-tools
+          override: true
+
+      - name: Check all workspace targets
+        run: cargo check --workspace --all-targets
+
+  test:
+    name: Test Suite
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        rust: [nightly]
+
+    steps:
+      - name: Checkout the Repository
+        uses: actions/checkout@v2
+      
+      - name: Install the Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.rust }}
+          profile: minimal
+          target: nvptx64-nvidia-cuda
+          components: llvm-bitcode-linker, llvm-tools
+          override: true
+      
+      - name: Run the test-suite
+        run: cargo test --workspace --no-fail-fast
+
+  fmt:
+    name: Rustfmt
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the Repository
+        uses: actions/checkout@v2
+
+      - name: Install the Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          profile: minimal
+          components: rustfmt
+          override: true
+
+      - name: Check the code formatting
+        run: cargo fmt --all -- --check
+
+  clippy:
+    name: Clippy
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        rust: [nightly]
+
+    steps:
+      - name: Checkout the Repository
+        uses: actions/checkout@v2
+      
+      - name: Install the Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.rust }}
+          profile: minimal
+          components: clippy
+          components: llvm-bitcode-linker, llvm-tools
+          override: true
+
+      - name: Check all workspace targets
+        run: cargo clippy --workspace --all-targets -- -D warnings

.github/workflows/rustdoc.yml

@@ -0,0 +1,39 @@
+name: rustdoc to gh-pages
+
+on:
+  push:
+    branches:
+      - main
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  release:
+    name: GitHub Pages
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout the Repository
+        uses: actions/checkout@v2
+      
+      - name: Install the Rust toolchain
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: nightly
+          profile: minimal
+          override: true
+
+      - name: Build the Documentation
+        run: |
+          RUSTDOCFLAGS="\
+            --enable-index-page \
+            -Zunstable-options \
+          " cargo doc --no-deps
+
+      - name: Deploy the Documentation
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: ./target/doc

.travis.yml

@@ -1,9 +1,10 @@
 [package]
 name = "ptx-builder"
-version = "0.5.3"
-authors = ["Denys Zariaiev <denys.zariaiev@gmail.com>"]
+version = "0.6.0"
+authors = ["Denys Zariaiev <denys.zariaiev@gmail.com>", "Juniper Tyree <juniper.tyree@helsinki.fi>"]
 license = "MIT"
-edition = "2018"
+edition = "2021"
+rust-version = "1.79" # nightly
 
 readme = "README.md"
 description = "NVPTX build helper"
@@ -28,8 +29,3 @@ libc = "0.2"
 
 [dev-dependencies]
 antidote = "1.0"
-
-[badges]
-appveyor = { repository = "denzp/rust-ptx-builder", branch = "master", service = "github" }
-travis-ci = { repository = "denzp/rust-ptx-builder", branch = "master" }
-maintenance = { status = "passively-maintained" }

Cargo.toml

@@ -1,6 +1,7 @@
 MIT License
 
-Copyright (c) 2018 Denys Zariaiev
+Copyright (c) 2018-2020 Denys Zariaiev
+Copyright (c) 2021- Juniper Tyree
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE

@@ -1,79 +1,14 @@
-# Rust PTX Builder
-[![Build Status](https://travis-ci.org/denzp/rust-ptx-builder.svg?branch=master)](https://travis-ci.org/denzp/rust-ptx-builder)
-[![Current Version](https://img.shields.io/crates/v/ptx-builder.svg)](https://crates.io/crates/ptx-builder)
-[![Docs](https://docs.rs/ptx-builder/badge.svg)](https://docs.rs/ptx-builder)
+# ptx-builder   [![CI Status]][workflow] [![MSRV]][repo] [![Rust Doc]][docs]
 
-## New Release: 0.5 🎉
-### Say goodbye to proxy crate approach
-This allows us to use single-source CUDA in **binary**-only crates (ones without `lib.rs`).
+[CI Status]: https://img.shields.io/github/actions/workflow/status/juntyr/rust-ptx-builder/ci.yml?branch=main
+[workflow]: https://github.com/juntyr/rust-ptx-builder/actions/workflows/ci.yml?query=branch%3Amain
 
-### Development breaking changes
-The crate does not provide a default `panic_handler` anymore.
-From now on, it either up to a user, or other crates (e.g. coming soon [`ptx-support` crate](https://github.com/denzp/rust-ptx-support)).
+[MSRV]: https://img.shields.io/badge/MSRV-1.79.0--nightly-orange
+[repo]: https://github.com/juntyr/rust-ptx-builder
 
-Next workaround should work in common cases,
-although it doesn't provide any panic details in runtime:
-``` rust
-#![feature(core_intrinsics)]
+[Rust Doc]: https://img.shields.io/badge/docs-main-blue
+[docs]: https://juntyr.github.io/rust-ptx-builder/
 
-#[panic_handler]
-unsafe fn breakpoint_panic_handler(_: &::core::panic::PanicInfo) -> ! {
-    core::intrinsics::breakpoint();
-    core::hint::unreachable_unchecked();
-}
-```
+## License
 
-### API Breaking Changes - less boilerplate code
-`build.rs` script was never so compact and clear before:
-``` rust
-use ptx_builder::error::Result;
-use ptx_builder::prelude::*;
-
-fn main() -> Result<()> {
-    let builder = Builder::new(".")?;
-    CargoAdapter::with_env_var("KERNEL_PTX_PATH").build(builder);
-}
-```
-
-### Documentation improvements
-This release comes with a significant documentation improvement! [Check it out](https://docs.rs/ptx-builder) :)
-
-## Purpose
-The library should facilitate CUDA development with Rust.
-It can be used in a [cargo build script](http://doc.crates.io/build-script.html) of a host crate, and take responsibility for building device crates.
-
-## Features
-1. Obviously, device crates building.
-2. Announcing device crates sources to cargo, so it can automatically rebuild after changes.
-3. Reporting about missing tools, for example:
-```
-[PTX] Unable to get target details
-[PTX]
-[PTX] caused by:
-[PTX]   Command not found in PATH: 'rust-ptx-linker'. You can install it with: 'cargo install ptx-linker'.
-```
-
-## Prerequirements
-The library depends on a fresh Nightly and [ptx-linker](https://crates.io/crates/ptx-linker).
-The latter can be installed from crates.io:
-```
-cargo install ptx-linker
-```
-
-## Usage
-First, you need to specify a build script in host crate's `Cargo.toml` and declare the library as a *build-dependency*:
-``` toml
-[build-dependencies]
-ptx-builder = "0.5"
-```
-
-Then, typical `build.rs` might look like:
-``` rust
-use ptx_builder::error::Result;
-use ptx_builder::prelude::*;
-
-fn main() -> Result<()> {
-    let builder = Builder::new(".")?;
-    CargoAdapter::with_env_var("KERNEL_PTX_PATH").build(builder);
-}
-```
+Licensed under the MIT license ([LICENSE](LICENSE) or http://opensource.org/licenses/MIT).

README.md

@@ -1,4 +1,4 @@
 [toolchain]
 channel = "nightly"
-components = [ "rustfmt", "clippy" ]
+components = [ "rustfmt", "clippy", "llvm-bitcode-linker", "llvm-tools" ]
 targets = [ "x86_64-unknown-linux-gnu", "nvptx64-nvidia-cuda" ]

rust-toolchain

@@ -10,7 +10,7 @@ use regex::Regex;
 
 use crate::{
     error::{BuildErrorKind, Error, Result, ResultExt},
-    executable::{Cargo, ExecutableRunner, Linker},
+    executable::{Cargo, ExecutableRunner},
     source::Crate,
 };
 
@@ -249,9 +249,6 @@ impl Builder {
             return Ok(BuildStatus::NotNeeded);
         }
 
-        // Verify `ptx-linker` version.
-        ExecutableRunner::new(Linker).with_args(vec!["-V"]).run()?;
-
         let mut cargo = ExecutableRunner::new(Cargo);
         let mut args = vec!["rustc"];
 
@@ -372,8 +369,8 @@ impl Builder {
                 .trim_matches('\n')
                 .split('\n')
                 .find(|line| {
-                    line.contains(&format!("--crate-name {}", crate_name))
-                        && line.contains(&format!("--crate-type {}", crate_type))
+                    line.contains(&format!("--crate-name {crate_name}"))
+                        && line.contains(&format!("--crate-type {crate_type}"))
                 })
                 .map(|line| BuildCommand::Realtime(line.to_string()))
                 .or_else(|| Self::load_cached_build_command(&output_path, &self.prefix))
@@ -419,15 +416,15 @@ impl Builder {
     }
 
     fn load_cached_build_command(output_path: &Path, prefix: &str) -> Option<BuildCommand> {
-        match read_to_string(output_path.join(format!("{}.{}", LAST_BUILD_CMD, prefix))) {
+        match read_to_string(output_path.join(format!("{LAST_BUILD_CMD}.{prefix}"))) {
             Ok(contents) => Some(BuildCommand::Cached(contents)),
             Err(_) => None,
         }
     }
 
     fn store_cached_build_command(output_path: &Path, prefix: &str, command: &str) -> Result<()> {
         write(
-            output_path.join(format!("{}.{}", LAST_BUILD_CMD, prefix)),
+            output_path.join(format!("{LAST_BUILD_CMD}.{prefix}")),
             command.as_bytes(),
         )
         .context(BuildErrorKind::OtherError)?;
@@ -535,7 +532,7 @@ impl<'a> BuildOutput<'a> {
             .trim()
             .split(' ')
             .map(|item| PathBuf::from(item.trim()))
-            .chain(cargo_deps.into_iter())
+            .chain(cargo_deps)
             .collect())
     }
 

src/builder.rs

@@ -33,9 +33,6 @@ pub trait Executable {
 /// `cargo` command.
 pub struct Cargo;
 
-/// `ptx-linker` command.
-pub struct Linker;
-
 impl Executable for Cargo {
     fn get_name(&self) -> String {
         String::from("cargo")
@@ -63,21 +60,3 @@ impl Executable for Cargo {
         })
     }
 }
-
-impl Executable for Linker {
-    fn get_name(&self) -> String {
-        String::from("rust-ptx-linker")
-    }
-
-    fn get_verification_hint(&self) -> String {
-        String::from("You can install it with: 'cargo install ptx-linker'")
-    }
-
-    fn get_version_hint(&self) -> String {
-        String::from("You can update it with: 'cargo install -f ptx-linker'")
-    }
-
-    fn get_required_version(&self) -> Option<VersionReq> {
-        Some(VersionReq::parse(">= 0.9.0").unwrap())
-    }
-}