branches 0.4.5

Branch hinting prediction and control functions for stable Rust including likely, unlikely, assume and abort, plus read and write cpu prefetch functions to help algorithm optimization
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

//! Instantiates every public function of the crate.
//!
//! Generic functions are only fully checked (including their inline assembly)
//! when they are monomorphized, so cross-compilation CI builds this example to
//! make sure the architecture-specific code paths actually assemble on every
//! supported target.

use branches::{assume, likely, mark_unlikely, unlikely};

fn main() {
    let flag = std::env::args().count() > 1;
    if likely(!flag) {
        println!("expected path");
    }
    if unlikely(flag) {
        mark_unlikely();
        println!("unexpected path");
    }
    unsafe { assume(usize::MAX > 0) };

    // Reference abort() without calling it.
    let _abort: extern "C" fn() -> ! = branches::abort;

    #[cfg(feature = "prefetch")]
    {
        let buf = [0u8; 64];
        let p = buf.as_ptr();
        branches::prefetch_read_data::<_, 0>(p);
        branches::prefetch_read_data::<_, 1>(p);
        branches::prefetch_read_data::<_, 2>(p);
        branches::prefetch_read_data::<_, 3>(p);
        branches::prefetch_read_data::<_, { -1 }>(p);
        branches::prefetch_write_data::<_, 0>(p);
        branches::prefetch_write_data::<_, 1>(p);
        branches::prefetch_write_data::<_, 2>(p);
        branches::prefetch_write_data::<_, 3>(p);
        branches::prefetch_write_data::<_, { -1 }>(p);
    }
}