Skip to content
Safe cross-platform linker shenanigans
Rust
Branch: master
Clone or download
Latest commit a4041e1 Aug 31, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
impl Release 0.1.6 Aug 31, 2019
src Release 0.1.6 Aug 31, 2019
tests Add 2018 and 2015 tests for module exports Aug 31, 2019
.gitignore
.travis.yml Raise minimum rustc version to 1.32 Aug 31, 2019
Cargo.toml Release 0.1.6 Aug 31, 2019
LICENSE-APACHE Library for safe cross-platform linker shenanigans Jan 27, 2019
LICENSE-MIT
README.md Raise minimum rustc version to 1.32 Aug 31, 2019

README.md

Linkme: safe cross-platform linker shenanigans

Build Status Latest Version Rust Documentation

Component Linux macOS Windows Other...
Distributed slice ✔️ ✔️ ✔️

We welcome PRs adding support for any platforms not listed here.

[dependencies]
linkme = "0.1"

Supports rustc 1.32+


Distributed slice

A distributed slice is a collection of static elements that are gathered into a contiguous section of the binary by the linker. Slice elements may be defined individually from anywhere in the dependency graph of the final binary.

The implementation is based on link_section attributes and platform-specific linker support. It does not involve life-before-main or any other runtime initialization on any platform. This is a zero-cost safe abstraction that operates entirely during compilation and linking.

Declaration

A static distributed slice is declared by writing #[distributed_slice] on a static item whose type is [T] for some type T. The initializer expression must be [..] to indicate that elements come from elsewhere.

use linkme::distributed_slice;

#[distributed_slice]
pub static BENCHMARKS: [fn(&mut Bencher)] = [..];

Elements

Slice elements may be registered into a distributed slice by a #[distributed_slice(...)] attribute in which the path to the distributed slice is given in the parentheses. The initializer is required to be a const expression.

use linkme::distributed_slice;
use other_crate::BENCHMARKS;

#[distributed_slice(BENCHMARKS)]
static BENCH_DESERIALIZE: fn(&mut Bencher) = bench_deserialize;

fn bench_deserialize(b: &mut Bencher) {
    /* ... */
}

Elements may be defined in the same crate that declares the distributed slice, or in any downstream crate. Elements across all crates linked into the final binary will be observed to be present in the slice at runtime.

The distributed slice behaves in all ways like &'static [T].

fn main() {
    // Iterate the elements.
    for bench in BENCHMARKS {
        /* ... */
    }

    // Index into the elements.
    let first = BENCHMARKS[0];

    // Slice the elements.
    let except_first = &BENCHMARKS[1..];

    // Invoke methods on the underlying slice.
    let len = BENCHMARKS.len();
}

The compiler will require that the static element type matches with the element type of the distributed slice. If the two do not match, the program will not compile:

#[distributed_slice(BENCHMARKS)]
static BENCH_WTF: usize = 999;
error[E0308]: mismatched types
  --> src/distributed_slice.rs:65:19
   |
17 | static BENCH_WTF: usize = 999;
   |                   ^^^^^ expected fn pointer, found usize
   |
   = note: expected type `fn(&mut other_crate::Bencher)`
              found type `usize`

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
You can’t perform that action at this time.