-
Notifications
You must be signed in to change notification settings - Fork 13.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Use memchr for str::find(char) #46735
Merged
Merged
Changes from 13 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
2bf0df7
Move rust memchr impl to libcore
Manishearth f8f2888
Use memchr in [u8]::contains
Manishearth 1d818a4
Support 16 bit platforms
Manishearth 4550ea7
Remove the unused ascii_only field in CharEqSearcher
Manishearth 72cab5e
Split out char searcher from MultiCharSearcher
Manishearth 585ad9f
Move CharSearcher to its own section in the file
Manishearth d9dc44a
Fill in forward searcher impl for char
Manishearth f865164
Fill in reverse searcher impl for char
Manishearth 75c07a3
Add memchr search support for multibyte characters
Manishearth efcc447
Add simple test for pattern API
Manishearth bc55355
Add simple search test for pattern API
Manishearth 9b92a44
Add stresstests for shared bytes for pattern API
Manishearth 85919a0
Pass tidy for tests
Manishearth 5cf5516
handle overflow/underflow in index offsets
Manishearth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,230 @@ | ||
// 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 | ||
|
||
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 = "16")] | ||
#[inline] | ||
fn repeat_byte(b: u8) -> usize { | ||
(b as usize) << 8 | b as usize | ||
} | ||
|
||
#[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..])); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
a
is meant to bex
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, fixing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
someone fixed it already