-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Add lint size_of_in_element_count #6394
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
b611306
Add lint unsafe_sizeof_count_copies
nico-abram 0f954ba
Make the unsafe_sizeof_count_copies lint find copy_{from,to} method c…
nico-abram 1b80990
Make the unsafe_sizeof_count_copies lint work with more functions
nico-abram 63a3c44
Remove unnecessary unsafe_size_count_copies tests
nico-abram af9685b
Rename unsafe_sizeof_count_copies to size_of_in_element_count
nico-abram c1a5329
Add more functions to size_of_in_element_count
nico-abram 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
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
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,146 @@ | ||
| //! Lint on use of `size_of` or `size_of_val` of T in an expression | ||
| //! expecting a count of T | ||
|
|
||
| use crate::utils::{match_def_path, paths, span_lint_and_help}; | ||
| use if_chain::if_chain; | ||
| use rustc_hir::BinOpKind; | ||
| use rustc_hir::{Expr, ExprKind}; | ||
| use rustc_lint::{LateContext, LateLintPass}; | ||
| use rustc_middle::ty::{self, Ty, TyS, TypeAndMut}; | ||
| use rustc_session::{declare_lint_pass, declare_tool_lint}; | ||
|
|
||
| declare_clippy_lint! { | ||
| /// **What it does:** Detects expressions where | ||
| /// size_of::<T> or size_of_val::<T> is used as a | ||
| /// count of elements of type T | ||
| /// | ||
| /// **Why is this bad?** These functions expect a count | ||
| /// of T and not a number of bytes | ||
| /// | ||
| /// **Known problems:** None. | ||
| /// | ||
| /// **Example:** | ||
| /// ```rust,no_run | ||
| /// # use std::ptr::copy_nonoverlapping; | ||
| /// # use std::mem::size_of; | ||
| /// | ||
| /// const SIZE: usize = 128; | ||
| /// let x = [2u8; SIZE]; | ||
| /// let mut y = [2u8; SIZE]; | ||
| /// unsafe { copy_nonoverlapping(x.as_ptr(), y.as_mut_ptr(), size_of::<u8>() * SIZE) }; | ||
| /// ``` | ||
| pub SIZE_OF_IN_ELEMENT_COUNT, | ||
| correctness, | ||
| "using size_of::<T> or size_of_val::<T> where a count of elements of T is expected" | ||
| } | ||
|
|
||
| declare_lint_pass!(SizeOfInElementCount => [SIZE_OF_IN_ELEMENT_COUNT]); | ||
|
|
||
| fn get_size_of_ty(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> Option<Ty<'tcx>> { | ||
| match expr.kind { | ||
| ExprKind::Call(count_func, _func_args) => { | ||
| if_chain! { | ||
| if let ExprKind::Path(ref count_func_qpath) = count_func.kind; | ||
| if let Some(def_id) = cx.qpath_res(count_func_qpath, count_func.hir_id).opt_def_id(); | ||
| if match_def_path(cx, def_id, &paths::MEM_SIZE_OF) | ||
| || match_def_path(cx, def_id, &paths::MEM_SIZE_OF_VAL); | ||
| then { | ||
| cx.typeck_results().node_substs(count_func.hir_id).types().next() | ||
| } else { | ||
| None | ||
| } | ||
| } | ||
| }, | ||
| ExprKind::Binary(op, left, right) if BinOpKind::Mul == op.node || BinOpKind::Div == op.node => { | ||
| get_size_of_ty(cx, left).or_else(|| get_size_of_ty(cx, right)) | ||
| }, | ||
| ExprKind::Cast(expr, _) => get_size_of_ty(cx, expr), | ||
| _ => None, | ||
| } | ||
| } | ||
|
|
||
| fn get_pointee_ty_and_count_expr(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> Option<(Ty<'tcx>, &'tcx Expr<'tcx>)> { | ||
| const FUNCTIONS: [&[&str]; 8] = [ | ||
| &paths::COPY_NONOVERLAPPING, | ||
| &paths::COPY, | ||
| &paths::WRITE_BYTES, | ||
| &paths::PTR_SWAP_NONOVERLAPPING, | ||
| &paths::PTR_SLICE_FROM_RAW_PARTS, | ||
| &paths::PTR_SLICE_FROM_RAW_PARTS_MUT, | ||
| &paths::SLICE_FROM_RAW_PARTS, | ||
| &paths::SLICE_FROM_RAW_PARTS_MUT, | ||
| ]; | ||
| const METHODS: [&str; 11] = [ | ||
| "write_bytes", | ||
| "copy_to", | ||
| "copy_from", | ||
| "copy_to_nonoverlapping", | ||
| "copy_from_nonoverlapping", | ||
| "add", | ||
| "wrapping_add", | ||
| "sub", | ||
| "wrapping_sub", | ||
| "offset", | ||
| "wrapping_offset", | ||
| ]; | ||
|
|
||
| if_chain! { | ||
| // Find calls to ptr::{copy, copy_nonoverlapping} | ||
| // and ptr::{swap_nonoverlapping, write_bytes}, | ||
| if let ExprKind::Call(func, [.., count]) = expr.kind; | ||
| if let ExprKind::Path(ref func_qpath) = func.kind; | ||
| if let Some(def_id) = cx.qpath_res(func_qpath, func.hir_id).opt_def_id(); | ||
| if FUNCTIONS.iter().any(|func_path| match_def_path(cx, def_id, func_path)); | ||
|
|
||
| // Get the pointee type | ||
| if let Some(pointee_ty) = cx.typeck_results().node_substs(func.hir_id).types().next(); | ||
| then { | ||
| return Some((pointee_ty, count)); | ||
| } | ||
| }; | ||
| if_chain! { | ||
| // Find calls to copy_{from,to}{,_nonoverlapping} and write_bytes methods | ||
| if let ExprKind::MethodCall(method_path, _, [ptr_self, .., count], _) = expr.kind; | ||
| let method_ident = method_path.ident.as_str(); | ||
| if METHODS.iter().any(|m| *m == &*method_ident); | ||
|
|
||
| // Get the pointee type | ||
| if let ty::RawPtr(TypeAndMut { ty: pointee_ty, .. }) = | ||
| cx.typeck_results().expr_ty(ptr_self).kind(); | ||
| then { | ||
| return Some((pointee_ty, count)); | ||
| } | ||
| }; | ||
| None | ||
| } | ||
|
|
||
| impl<'tcx> LateLintPass<'tcx> for SizeOfInElementCount { | ||
| fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) { | ||
| const HELP_MSG: &str = "use a count of elements instead of a count of bytes\ | ||
| , it already gets multiplied by the size of the type"; | ||
|
|
||
| const LINT_MSG: &str = "found a count of bytes \ | ||
| instead of a count of elements of T"; | ||
|
|
||
| if_chain! { | ||
| // Find calls to functions with an element count parameter and get | ||
| // the pointee type and count parameter expression | ||
| if let Some((pointee_ty, count_expr)) = get_pointee_ty_and_count_expr(cx, expr); | ||
|
|
||
| // Find a size_of call in the count parameter expression and | ||
| // check that it's the same type | ||
| if let Some(ty_used_for_size_of) = get_size_of_ty(cx, count_expr); | ||
| if TyS::same_type(pointee_ty, ty_used_for_size_of); | ||
| then { | ||
| span_lint_and_help( | ||
| cx, | ||
| SIZE_OF_IN_ELEMENT_COUNT, | ||
| count_expr.span, | ||
| LINT_MSG, | ||
| None, | ||
| HELP_MSG | ||
| ); | ||
| } | ||
| }; | ||
| } | ||
| } | ||
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
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,61 @@ | ||
| #![warn(clippy::size_of_in_element_count)] | ||
| #![allow(clippy::ptr_offset_with_cast)] | ||
|
|
||
| use std::mem::{size_of, size_of_val}; | ||
| use std::ptr::{ | ||
| copy, copy_nonoverlapping, slice_from_raw_parts, slice_from_raw_parts_mut, swap_nonoverlapping, write_bytes, | ||
| }; | ||
| use std::slice::{from_raw_parts, from_raw_parts_mut}; | ||
|
|
||
| fn main() { | ||
| const SIZE: usize = 128; | ||
| const HALF_SIZE: usize = SIZE / 2; | ||
| const DOUBLE_SIZE: usize = SIZE * 2; | ||
| let mut x = [2u8; SIZE]; | ||
| let mut y = [2u8; SIZE]; | ||
|
|
||
| // Count is size_of (Should trigger the lint) | ||
| unsafe { copy_nonoverlapping::<u8>(x.as_ptr(), y.as_mut_ptr(), size_of::<u8>()) }; | ||
| unsafe { copy_nonoverlapping(x.as_ptr(), y.as_mut_ptr(), size_of_val(&x[0])) }; | ||
|
|
||
| unsafe { x.as_ptr().copy_to(y.as_mut_ptr(), size_of::<u8>()) }; | ||
| unsafe { x.as_ptr().copy_to_nonoverlapping(y.as_mut_ptr(), size_of::<u8>()) }; | ||
| unsafe { y.as_mut_ptr().copy_from(x.as_ptr(), size_of::<u8>()) }; | ||
| unsafe { y.as_mut_ptr().copy_from_nonoverlapping(x.as_ptr(), size_of::<u8>()) }; | ||
|
|
||
| unsafe { copy(x.as_ptr(), y.as_mut_ptr(), size_of::<u8>()) }; | ||
| unsafe { copy(x.as_ptr(), y.as_mut_ptr(), size_of_val(&x[0])) }; | ||
|
|
||
| unsafe { y.as_mut_ptr().write_bytes(0u8, size_of::<u8>() * SIZE) }; | ||
| unsafe { write_bytes(y.as_mut_ptr(), 0u8, size_of::<u8>() * SIZE) }; | ||
|
|
||
| unsafe { swap_nonoverlapping(y.as_mut_ptr(), x.as_mut_ptr(), size_of::<u8>() * SIZE) }; | ||
|
|
||
| slice_from_raw_parts_mut(y.as_mut_ptr(), size_of::<u8>() * SIZE); | ||
| slice_from_raw_parts(y.as_ptr(), size_of::<u8>() * SIZE); | ||
|
|
||
| unsafe { from_raw_parts_mut(y.as_mut_ptr(), size_of::<u8>() * SIZE) }; | ||
| unsafe { from_raw_parts(y.as_ptr(), size_of::<u8>() * SIZE) }; | ||
|
|
||
| unsafe { y.as_mut_ptr().sub(size_of::<u8>()) }; | ||
| y.as_ptr().wrapping_sub(size_of::<u8>()); | ||
| unsafe { y.as_ptr().add(size_of::<u8>()) }; | ||
| y.as_mut_ptr().wrapping_add(size_of::<u8>()); | ||
| unsafe { y.as_ptr().offset(size_of::<u8>() as isize) }; | ||
| y.as_mut_ptr().wrapping_offset(size_of::<u8>() as isize); | ||
|
|
||
| // Count expression involving multiplication of size_of (Should trigger the lint) | ||
| unsafe { copy_nonoverlapping(x.as_ptr(), y.as_mut_ptr(), size_of::<u8>() * SIZE) }; | ||
|
|
||
| // Count expression involving nested multiplications of size_of (Should trigger the lint) | ||
| unsafe { copy_nonoverlapping(x.as_ptr(), y.as_mut_ptr(), HALF_SIZE * size_of_val(&x[0]) * 2) }; | ||
|
|
||
| // Count expression involving divisions of size_of (Should trigger the lint) | ||
| unsafe { copy(x.as_ptr(), y.as_mut_ptr(), DOUBLE_SIZE * size_of::<u8>() / 2) }; | ||
|
|
||
| // No size_of calls (Should not trigger the lint) | ||
| unsafe { copy(x.as_ptr(), y.as_mut_ptr(), SIZE) }; | ||
|
|
||
| // Different types for pointee and size_of (Should not trigger the lint) | ||
| unsafe { y.as_mut_ptr().write_bytes(0u8, size_of::<u16>() / 2 * SIZE) }; | ||
| } |
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.
Good catch!