bit_arch 0.1.0

High-level zero-cost bit manipulation
Documentation
arch_specific!(
#[doc = "Performs a bitwise logical `!a & b` in one instruction."]
inverted_and_u32(a: u32, b: u32) -> u32 {
    !a & b
}, "bmi1" = core::arch::x86_64::_andn_u32);

arch_specific!(
#[doc = "Performs a bitwise logical `!a & b` in one instruction."]
inverted_and_u64(a: u64, b: u64) -> u64 {
    !a & b
}, "bmi1" = core::arch::x86_64::_andn_u64);

arch_specific!(
#[doc = "Extracts and isolates the lowest set bit from `x`. Algorithm: `x & -x`"]
isolate_lowest_set_u32(x: u32) -> u32 {
    x & x.wrapping_neg()
}, "bmi1" = core::arch::x86_64::_blsi_u32);

arch_specific!(
#[doc = "Extracts and isolates the lowest set bit from `x`. Algorithm: `x & -x`"]
isolate_lowest_set_u64(x: u64) -> u64 {
    x & x.wrapping_neg()
}, "bmi1" = core::arch::x86_64::_blsi_u64);

arch_specific!(
#[doc = "Extracts and clears the lowest set bit from `x`. Algorithm: `x & (x - 1)`"]
clear_lowest_set_u32(x: u32) -> u32 {
    x & x.wrapping_sub(1)
}, "bmi1" = core::arch::x86_64::_blsr_u32);

arch_specific!(
#[doc = "Extracts and clears the lowest set bit from `x`. Algorithm: `x & (x - 1)`"]
clear_lowest_set_u64(x: u64) -> u64 {
    x & x.wrapping_sub(1)
}, "bmi1" = core::arch::x86_64::_blsr_u64);

arch_specific!(
#[doc = "Mask up to the lowest set bit from `x`. Algorithm: `x ^ (x - 1)`"]
through_lowest_set_u32(x: u32) -> u32 {
    x ^ x.wrapping_sub(1)
}, "bmi1" = core::arch::x86_64::_blsmsk_u32);

arch_specific!(
#[doc = "Mask up to the lowest set bit from `x`. Algorithm: `x ^ (x - 1)`"]
through_lowest_set_u64(x: u64) -> u64 {
    x ^ x.wrapping_sub(1)
}, "bmi1" = core::arch::x86_64::_blsmsk_u64);

arch_specific!(
#[doc = "Extracts a bitfield at index `start` of size `len` of `x`."]
extract_bitfield_u32(x: u32, start: u32, len: u32) -> u32 {
    if start > 31 || len == 0 {
        return 0;
    }

    let available = 32 - start;
    let len = len.min(available);

    x >> start & u32::MAX >> (32 - len)
}, "bmi1", "tbm" = core::arch::x86_64::_bextr_u32);

arch_specific!(
#[doc = "Extracts a bitfield at index `start` of size `len` of `x`."]
extract_bitfield_u64(x: u64, start: u32, len: u32) -> u64 {
    if start > 63 || len == 0 {
        return 0;
    }

    let available = 64 - start;
    let len = len.min(available);

    x >> start & u64::MAX >> (64 - len)
}, "bmi1", "tbm" = core::arch::x86_64::_bextr_u64);

arch_specific!(
#[doc = "Extracts a bitfield from `x` provided the start index in bits `7..0` and length bits in `15..8`."]
extract_bitfield_control_u32(x: u32, control: u32) -> u32 {
    let start = control & 0xff;
    let len = (control >> 8) & 0xff;

    if start > 31 || len == 0 {
        0
    } else {
        let len = len.min(32 - start);
        (x >> start) & (u32::MAX >> (32 - len))
    }
}, "bmi1", "tbm" = core::arch::x86_64::_bextr2_u32);

arch_specific!(
#[doc = "Extracts a bitfield from `x` provided the start index in bits `7..0` and length bits in `15..8`."]
extract_bitfield_control_u64(x: u64, control: u64) -> u64 {
    let start = control & 0xff;
    let len = (control >> 8) & 0xff;

    if start > 63 || len == 0 {
        0
    } else {
        let len = len.min(64 - start);
        (x >> start) & (u64::MAX >> (64 - len))
    }
}, "bmi1", "tbm" = core::arch::x86_64::_bextr2_u64);

arch_specific!(
#[doc = "Counts trailing zeros of `x`."]
trailing_zeros_u16(x: u16) -> u16 {
    x.trailing_zeros() as u16
}, "bmi1" = core::arch::x86_64::_tzcnt_u16);

arch_specific!(
#[doc = "Counts trailing zeros of `x`."]
trailing_zeros_u32(x: u32) -> u32 {
    x.trailing_zeros()
}, "bmi1" = core::arch::x86_64::_tzcnt_u32);

arch_specific!(
#[doc = "Counts trailing zeros of `x`."]
trailing_zeros_u64(x: u64) -> u64 {
    x.trailing_zeros() as u64
}, "bmi1" = core::arch::x86_64::_tzcnt_u64);