-
Notifications
You must be signed in to change notification settings - Fork 13.3k
Added compile time optimization for bytewise slice comparison #39422
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
Closed
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
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 hidden or 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
This file contains hidden or 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,90 @@ | ||
// Copyright 2012-2014 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. | ||
|
||
//! Code generation for bytewise slice comparison. Target is to provide a compile time optimization | ||
//! within a single macro which looks like: | ||
//! | ||
//! ``` | ||
//! macro_rules! slice_compare ( | ||
//! ($a:expr, $b:expr, $len:expr) => {{ | ||
//! match $len { | ||
//! 1 => cmp!($a, $b, u8, 0), | ||
//! 2 => cmp!($a, $b, u16, 0), | ||
//! 3 => cmp!($a, $b, u16, 0) && cmp!($a, $b, u8, 2), | ||
//! 4 => cmp!($a, $b, u32, 0), | ||
//! ... | ||
//! } | ||
//! }} | ||
//! ); | ||
//! ``` | ||
//! | ||
//! The supported slice length can be set by changing the `OPT_LEN` variable. | ||
|
||
static OPT_LEN: usize = 256; | ||
|
||
use std::{env, iter, io}; | ||
use std::fs::File; | ||
use std::io::Write; | ||
use std::path::Path; | ||
use std::error::Error; | ||
|
||
// Generates the code for the compile time optimization for bytewise slice comparison | ||
pub fn main() { | ||
run().expect("Could not generate slice comparison source code."); | ||
} | ||
|
||
fn fill(indent: usize) -> String { | ||
iter::repeat(' ').take(indent).collect() | ||
} | ||
|
||
fn run() -> Result<(), Box<Error>> { | ||
let out_dir = env::var("OUT_DIR")?; | ||
let dest_path = Path::new(&out_dir).join("memcmp_optimization.rs"); | ||
let mut f = File::create(&dest_path)?; | ||
|
||
// Generate the slice comparison source code | ||
writeln!(f, "macro_rules! slice_compare (")?; | ||
writeln!(f, "{}($a:expr, $b:expr, $len:expr) => {{{{", fill(4))?; | ||
writeln!(f, "{}match $len {{", fill(8))?; | ||
|
||
for i in 1..OPT_LEN + 1 { | ||
let mut bits = i * 8 as usize; | ||
let mut sizes = vec![8, 16, 32, 64]; | ||
let mut offset = 0; | ||
|
||
write!(f, "{}{} => ", fill(12), i)?; | ||
while !sizes.is_empty() { | ||
let size = sizes.last().ok_or(io::Error::from(io::ErrorKind::Other))?.clone(); | ||
if bits >= size { | ||
if offset > 0 { | ||
write!(f, " && ")?; | ||
} | ||
write!(f, "cmp!($a, $b, u{}, {})", size, offset)?; | ||
bits = bits.checked_sub(size).ok_or(io::Error::from(io::ErrorKind::Other))?; | ||
offset += size / 8; | ||
} else { | ||
sizes.pop(); | ||
} | ||
if bits == 0 { | ||
break; | ||
} | ||
} | ||
writeln!(f, ",")?; | ||
} | ||
|
||
writeln!(f, | ||
"{}_ => unsafe {{ memcmp($a, $b, $len) == 0 }},", | ||
fill(12))?; | ||
|
||
writeln!(f, "{}}}", fill(8))?; | ||
writeln!(f, "{}}}}}", fill(4))?; | ||
writeln!(f, ");")?; | ||
Ok(()) | ||
} |
This file contains hidden or 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
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.
This is a possibly unaligned load (for example
*const u64
used that is not necessarily well aligned foru64
. We can't merge the code like this, because it is not portable and will crash on certain platforms.)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.
Fixing this issue will likely have an impact on the performance. In order to get the best possible performance on platforms which allow unaligned memory access we might need/want to perform this optimisation at a lower level (i.e. replace the implementation of
memcmp
and/or the strategy used in LLVM to replacememcmp
with inline comparisons).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.
I am currently not sure how to fix this unaligned loads here. Is there something like
get_unaligned
in the compiler?