lzfse_rust 0.2.1

A pure Rust LZFSE library.
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

/// Zero the most significant `n_bits` of `lhs`.
/// Results when `n_bits >= size_of::<usize>()` are undefined.
#[cfg(target_feature = "bmi2")]
#[inline(always)]
pub fn mask(lhs: usize, n_bits: usize) -> usize {
    // Leverage BMI2 BZHI instructions.
    mask_shift(lhs, n_bits)
}

#[cfg(not(target_feature = "bmi2"))]
#[inline(always)]
pub fn mask(lhs: usize, n_bits: usize) -> usize {
    // Avoid slow x86/ x64 SHL instructions using a lookup table.
    // Assumes that the function is invoked with sufficient regularity to maintain table data
    // entries in L1 cache.
    mask_table(lhs, n_bits)
}

#[allow(dead_code)]
#[inline(always)]
fn mask_table(lhs: usize, n_bits: usize) -> usize {
    lhs & MASK_TABLE[n_bits & (MASK_TABLE_LEN - 1)]
}

#[allow(dead_code)]
#[inline(always)]
fn mask_shift(lhs: usize, n_bits: usize) -> usize {
    // TODO consider `unchecked_shl` when stable.
    lhs & ((1 << n_bits) - 1)
}

#[cfg(target_pointer_width = "64")]
pub const MASK_TABLE_LEN: usize = 64;

#[cfg(target_pointer_width = "64")]
pub const MASK_TABLE: [usize; MASK_TABLE_LEN] = [
    0x0000_0000_0000_0000,
    0x0000_0000_0000_0001,
    0x0000_0000_0000_0003,
    0x0000_0000_0000_0007,
    0x0000_0000_0000_000F,
    0x0000_0000_0000_001F,
    0x0000_0000_0000_003F,
    0x0000_0000_0000_007F,
    0x0000_0000_0000_00FF,
    0x0000_0000_0000_01FF,
    0x0000_0000_0000_03FF,
    0x0000_0000_0000_07FF,
    0x0000_0000_0000_0FFF,
    0x0000_0000_0000_1FFF,
    0x0000_0000_0000_3FFF,
    0x0000_0000_0000_7FFF,
    0x0000_0000_0000_FFFF,
    0x0000_0000_0001_FFFF,
    0x0000_0000_0003_FFFF,
    0x0000_0000_0007_FFFF,
    0x0000_0000_000F_FFFF,
    0x0000_0000_001F_FFFF,
    0x0000_0000_003F_FFFF,
    0x0000_0000_007F_FFFF,
    0x0000_0000_00FF_FFFF,
    0x0000_0000_01FF_FFFF,
    0x0000_0000_03FF_FFFF,
    0x0000_0000_07FF_FFFF,
    0x0000_0000_0FFF_FFFF,
    0x0000_0000_1FFF_FFFF,
    0x0000_0000_3FFF_FFFF,
    0x0000_0000_7FFF_FFFF,
    0x0000_0000_FFFF_FFFF,
    0x0000_0001_FFFF_FFFF,
    0x0000_0003_FFFF_FFFF,
    0x0000_0007_FFFF_FFFF,
    0x0000_000F_FFFF_FFFF,
    0x0000_001F_FFFF_FFFF,
    0x0000_003F_FFFF_FFFF,
    0x0000_007F_FFFF_FFFF,
    0x0000_00FF_FFFF_FFFF,
    0x0000_01FF_FFFF_FFFF,
    0x0000_03FF_FFFF_FFFF,
    0x0000_07FF_FFFF_FFFF,
    0x0000_0FFF_FFFF_FFFF,
    0x0000_1FFF_FFFF_FFFF,
    0x0000_3FFF_FFFF_FFFF,
    0x0000_7FFF_FFFF_FFFF,
    0x0000_FFFF_FFFF_FFFF,
    0x0001_FFFF_FFFF_FFFF,
    0x0003_FFFF_FFFF_FFFF,
    0x0007_FFFF_FFFF_FFFF,
    0x000F_FFFF_FFFF_FFFF,
    0x001F_FFFF_FFFF_FFFF,
    0x003F_FFFF_FFFF_FFFF,
    0x007F_FFFF_FFFF_FFFF,
    0x00FF_FFFF_FFFF_FFFF,
    0x01FF_FFFF_FFFF_FFFF,
    0x03FF_FFFF_FFFF_FFFF,
    0x07FF_FFFF_FFFF_FFFF,
    0x0FFF_FFFF_FFFF_FFFF,
    0x1FFF_FFFF_FFFF_FFFF,
    0x3FFF_FFFF_FFFF_FFFF,
    0x7FFF_FFFF_FFFF_FFFF,
];

#[cfg(target_pointer_width = "32")]
pub const MASK_TABLE_LEN: usize = 32;

#[cfg(target_pointer_width = "32")]
pub const MASK_TABLE: [usize; MASK_TABLE_LEN] = [
    0x0000_0000,
    0x0000_0001,
    0x0000_0003,
    0x0000_0007,
    0x0000_000F,
    0x0000_001F,
    0x0000_003F,
    0x0000_007F,
    0x0000_00FF,
    0x0000_01FF,
    0x0000_03FF,
    0x0000_07FF,
    0x0000_0FFF,
    0x0000_1FFF,
    0x0000_3FFF,
    0x0000_7FFF,
    0x0000_FFFF,
    0x0001_FFFF,
    0x0003_FFFF,
    0x0007_FFFF,
    0x000F_FFFF,
    0x001F_FFFF,
    0x003F_FFFF,
    0x007F_FFFF,
    0x00FF_FFFF,
    0x01FF_FFFF,
    0x03FF_FFFF,
    0x07FF_FFFF,
    0x0FFF_FFFF,
    0x1FFF_FFFF,
    0x3FFF_FFFF,
    0x7FFF_FFFF,
];

#[cfg(test)]
mod tests {
    use super::*;
    use std::mem;

    #[test]
    fn bit_mask() {
        let lhs = (-1isize) as usize;
        for n_bits in 0..mem::size_of::<usize>() * 8 {
            assert_eq!(mask_shift(lhs, n_bits), mask_table(lhs, n_bits));
        }
    }
}