crc32: mark some unsafe functions properly, add some safety documentation #236
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.
Some small nits I encountered in reviewing this code. Shoudn't be any actual functional changes.
Any function/method that invokes an intrinsic on aarch64 or x86_64 is unsafe, because it has the precondition of ensuring the runtime processor supports the instructions, otherwise the result is UB.
Results in a bit of an annoying proliferation of
unsafe
inpclmuqdg::Accumulator
. There may be some fiddling that can be done to reduce theunsafe
footprint, but it doesn't seem like a big deal for internal code.I set
warn(unsafe_op_in_unsafe_fn)
, since otherwise unsafe operations can "hide" in unsafe blocks and thus not receive scrutiny.Added a couple of SAFETY comments. I eschewed safety comments for things that struck me as obvious, e.g. taking pointer to a slice that's just fed into an intrinsic.
(@folkertdev let me know if this kind of PR helps. This is all just techniques I was doing to review anyway, so figured they would be useful upstream too).