memchr.rs.html -- source
Description: Source to the Rust file `src/libstd/sys_common/memchr.rs`.
Keywords: rust, rustlang, rust-lang

      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
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227

    // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
    // file at the top-level directory of this distribution and at
    // http://rust-lang.org/COPYRIGHT.
    //
    // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
    // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
    // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
    // option. This file may not be copied, modified, or distributed
    // except according to those terms.
    //
    // Original implementation taken from rust-memchr
    // Copyright 2015 Andrew Gallant, bluss and Nicolas Koch

    #[allow(dead_code)]
    pub mod fallback {
        use cmp;
        use mem;

        const LO_U64: u64 = 0x0101010101010101;
        const HI_U64: u64 = 0x8080808080808080;

        // use truncation
        const LO_USIZE: usize = LO_U64 as usize;
        const HI_USIZE: usize = HI_U64 as usize;

        /// Return `true` if `x` contains any zero byte.
        ///
        /// From *Matters Computational*, J. Arndt
        ///
        /// "The idea is to subtract one from each of the bytes and then look for
        /// bytes where the borrow propagated all the way to the most significant
        /// bit."
        #[inline]
        fn contains_zero_byte(x: usize) -> bool {
            x.wrapping_sub(LO_USIZE) & !x & HI_USIZE != 0
        }

        #[cfg(target_pointer_width = "32")]
        #[inline]
        fn repeat_byte(b: u8) -> usize {
            let mut rep = (b as usize) << 8 | b as usize;
            rep = rep << 16 | rep;
            rep
        }

        #[cfg(target_pointer_width = "64")]
        #[inline]
        fn repeat_byte(b: u8) -> usize {
            let mut rep = (b as usize) << 8 | b as usize;
            rep = rep << 16 | rep;
            rep = rep << 32 | rep;
            rep
        }

        /// Return the first index matching the byte `a` in `text`.
        pub fn memchr(x: u8, text: &[u8]) -> Option<usize> {
            // Scan for a single byte value by reading two `usize` words at a time.
            //
            // Split `text` in three parts
            // - unaligned initial part, before the first word aligned address in text
            // - body, scan by 2 words at a time
            // - the last remaining part, < 2 word size
            let len = text.len();
            let ptr = text.as_ptr();
            let usize_bytes = mem::size_of::<usize>();

            // search up to an aligned boundary
            let mut offset = ptr.align_offset(usize_bytes);
            if offset > 0 {
                offset = cmp::min(offset, len);
                if let Some(index) = text[..offset].iter().position(|elt| *elt == x) {
                    return Some(index);
                }
            }

            // search the body of the text
            let repeated_x = repeat_byte(x);

            if len >= 2 * usize_bytes {
                while offset <= len - 2 * usize_bytes {
                    unsafe {
                        let u = *(ptr.offset(offset as isize) as *const usize);
                        let v = *(ptr.offset((offset + usize_bytes) as isize) as *const usize);

                        // break if there is a matching byte
                        let zu = contains_zero_byte(u ^ repeated_x);
                        let zv = contains_zero_byte(v ^ repeated_x);
                        if zu || zv {
                            break;
                        }
                    }
                    offset += usize_bytes * 2;
                }
            }

            // find the byte after the point the body loop stopped
            text[offset..].iter().position(|elt| *elt == x).map(|i| offset + i)
        }

        /// Return the last index matching the byte `a` in `text`.
        pub fn memrchr(x: u8, text: &[u8]) -> Option<usize> {
            // Scan for a single byte value by reading two `usize` words at a time.
            //
            // Split `text` in three parts
            // - unaligned tail, after the last word aligned address in text
            // - body, scan by 2 words at a time
            // - the first remaining bytes, < 2 word size
            let len = text.len();
            let ptr = text.as_ptr();
            let usize_bytes = mem::size_of::<usize>();

            // search to an aligned boundary
            let end_align = (ptr as usize + len) & (usize_bytes - 1);
            let mut offset;
            if end_align > 0 {
                offset = if end_align >= len { 0 } else { len - end_align };
                if let Some(index) = text[offset..].iter().rposition(|elt| *elt == x) {
                    return Some(offset + index);
                }
            } else {
                offset = len;
            }

            // search the body of the text
            let repeated_x = repeat_byte(x);

            while offset >= 2 * usize_bytes {
                unsafe {
                    let u = *(ptr.offset(offset as isize - 2 * usize_bytes as isize) as *const usize);
                    let v = *(ptr.offset(offset as isize - usize_bytes as isize) as *const usize);

                    // break if there is a matching byte
                    let zu = contains_zero_byte(u ^ repeated_x);
                    let zv = contains_zero_byte(v ^ repeated_x);
                    if zu || zv {
                        break;
                    }
                }
                offset -= 2 * usize_bytes;
            }

            // find the byte before the point the body loop stopped
            text[..offset].iter().rposition(|elt| *elt == x)
        }

        // test fallback implementations on all platforms
        #[test]
        fn matches_one() {
            assert_eq!(Some(0), memchr(b'a', b"a"));
        }

        #[test]
        fn matches_begin() {
            assert_eq!(Some(0), memchr(b'a', b"aaaa"));
        }

        #[test]
        fn matches_end() {
            assert_eq!(Some(4), memchr(b'z', b"aaaaz"));
        }

        #[test]
        fn matches_nul() {
            assert_eq!(Some(4), memchr(b'\x00', b"aaaa\x00"));
        }

        #[test]
        fn matches_past_nul() {
            assert_eq!(Some(5), memchr(b'z', b"aaaa\x00z"));
        }

        #[test]
        fn no_match_empty() {
            assert_eq!(None, memchr(b'a', b""));
        }

        #[test]
        fn no_match() {
            assert_eq!(None, memchr(b'a', b"xyz"));
        }

        #[test]
        fn matches_one_reversed() {
            assert_eq!(Some(0), memrchr(b'a', b"a"));
        }

        #[test]
        fn matches_begin_reversed() {
            assert_eq!(Some(3), memrchr(b'a', b"aaaa"));
        }

        #[test]
        fn matches_end_reversed() {
            assert_eq!(Some(0), memrchr(b'z', b"zaaaa"));
        }

        #[test]
        fn matches_nul_reversed() {
            assert_eq!(Some(4), memrchr(b'\x00', b"aaaa\x00"));
        }

        #[test]
        fn matches_past_nul_reversed() {
            assert_eq!(Some(0), memrchr(b'z', b"z\x00aaaa"));
        }

        #[test]
        fn no_match_empty_reversed() {
            assert_eq!(None, memrchr(b'a', b""));
        }

        #[test]
        fn no_match_reversed() {
            assert_eq!(None, memrchr(b'a', b"xyz"));
        }

        #[test]
        fn each_alignment_reversed() {
            let mut data = [1u8; 64];
            let needle = 2;
            let pos = 40;
            data[pos] = needle;
            for start in 0..16 {
                assert_eq!(Some(pos - start), memrchr(needle, &data[start..]));
            }
        }
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)