rust-clippy/clippy_lints/src/ptr_offset_with_cast.rs

151 lines
4.6 KiB
Rust
Raw Normal View History

2020-02-18 13:28:18 +00:00
use crate::utils::{snippet_opt, span_lint, span_lint_and_sugg};
use rustc_errors::Applicability;
2020-01-06 16:39:50 +00:00
use rustc_hir::{Expr, ExprKind};
2020-01-12 06:08:41 +00:00
use rustc_lint::{LateContext, LateLintPass};
2020-01-11 11:37:08 +00:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
2018-08-29 12:40:00 +00:00
use std::fmt;
declare_clippy_lint! {
/// **What it does:** Checks for usage of the `offset` pointer method with a `usize` casted to an
/// `isize`.
///
/// **Why is this bad?** If were always increasing the pointer address, we can avoid the numeric
/// cast by using the `add` method instead.
///
/// **Known problems:** None
///
/// **Example:**
/// ```rust
/// let vec = vec![b'a', b'b', b'c'];
/// let ptr = vec.as_ptr();
/// let offset = 1_usize;
///
/// unsafe {
/// ptr.offset(offset as isize);
/// }
/// ```
///
/// Could be written:
///
/// ```rust
/// let vec = vec![b'a', b'b', b'c'];
/// let ptr = vec.as_ptr();
/// let offset = 1_usize;
///
/// unsafe {
/// ptr.add(offset);
/// }
/// ```
pub PTR_OFFSET_WITH_CAST,
complexity,
"unneeded pointer offset cast"
}
2019-04-08 20:43:55 +00:00
declare_lint_pass!(PtrOffsetWithCast => [PTR_OFFSET_WITH_CAST]);
impl<'tcx> LateLintPass<'tcx> for PtrOffsetWithCast {
fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
2018-08-29 12:40:00 +00:00
// Check if the expressions is a ptr.offset or ptr.wrapping_offset method call
let (receiver_expr, arg_expr, method) = match expr_as_ptr_offset_call(cx, expr) {
Some(call_arg) => call_arg,
None => return,
};
2018-08-29 12:40:00 +00:00
// Check if the argument to the method call is a cast from usize
let cast_lhs_expr = match expr_as_cast_from_usize(cx, arg_expr) {
Some(cast_lhs_expr) => cast_lhs_expr,
None => return,
};
2018-08-29 12:40:00 +00:00
let msg = format!("use of `{}` with a `usize` casted to an `isize`", method);
if let Some(sugg) = build_suggestion(cx, method, receiver_expr, cast_lhs_expr) {
2020-02-18 13:28:18 +00:00
span_lint_and_sugg(
cx,
PTR_OFFSET_WITH_CAST,
expr.span,
&msg,
"try",
sugg,
Applicability::MachineApplicable,
);
2018-08-29 12:12:22 +00:00
} else {
2020-02-18 13:28:18 +00:00
span_lint(cx, PTR_OFFSET_WITH_CAST, expr.span, &msg);
2018-08-29 12:12:22 +00:00
}
}
}
// If the given expression is a cast from a usize, return the lhs of the cast
fn expr_as_cast_from_usize<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
2019-09-27 15:16:06 +00:00
if let ExprKind::Cast(ref cast_lhs_expr, _) = expr.kind {
if is_expr_ty_usize(cx, &cast_lhs_expr) {
return Some(cast_lhs_expr);
}
}
None
}
2018-08-29 12:40:00 +00:00
// If the given expression is a ptr::offset or ptr::wrapping_offset method call, return the
// receiver, the arg of the method call, and the method.
fn expr_as_ptr_offset_call<'tcx>(
cx: &LateContext<'tcx>,
2019-12-27 07:12:26 +00:00
expr: &'tcx Expr<'_>,
) -> Option<(&'tcx Expr<'tcx>, &'tcx Expr<'tcx>, Method)> {
2020-06-09 21:44:04 +00:00
if let ExprKind::MethodCall(ref path_segment, _, ref args, _) = expr.kind {
2018-08-29 12:40:00 +00:00
if is_expr_ty_raw_ptr(cx, &args[0]) {
2019-05-17 21:53:54 +00:00
if path_segment.ident.name == sym!(offset) {
2018-08-29 12:40:00 +00:00
return Some((&args[0], &args[1], Method::Offset));
}
2019-05-17 21:53:54 +00:00
if path_segment.ident.name == sym!(wrapping_offset) {
2018-08-29 12:40:00 +00:00
return Some((&args[0], &args[1], Method::WrappingOffset));
}
}
}
None
}
// Is the type of the expression a usize?
fn is_expr_ty_usize<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) -> bool {
2020-07-17 08:47:04 +00:00
cx.typeck_results().expr_ty(expr) == cx.tcx.types.usize
}
// Is the type of the expression a raw pointer?
fn is_expr_ty_raw_ptr<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) -> bool {
2020-07-17 08:47:04 +00:00
cx.typeck_results().expr_ty(expr).is_unsafe_ptr()
}
fn build_suggestion<'tcx>(
cx: &LateContext<'tcx>,
2018-08-29 12:40:00 +00:00
method: Method,
2019-12-27 07:12:26 +00:00
receiver_expr: &Expr<'_>,
cast_lhs_expr: &Expr<'_>,
2018-08-29 12:12:22 +00:00
) -> Option<String> {
2020-02-18 13:28:18 +00:00
let receiver = snippet_opt(cx, receiver_expr.span)?;
let cast_lhs = snippet_opt(cx, cast_lhs_expr.span)?;
2018-08-29 12:42:43 +00:00
Some(format!("{}.{}({})", receiver, method.suggestion(), cast_lhs))
}
2018-08-29 12:40:00 +00:00
2018-08-29 13:01:05 +00:00
#[derive(Copy, Clone)]
2018-08-29 12:40:00 +00:00
enum Method {
Offset,
WrappingOffset,
}
impl Method {
#[must_use]
2018-08-29 13:27:32 +00:00
fn suggestion(self) -> &'static str {
2018-08-29 13:59:38 +00:00
match self {
Self::Offset => "add",
Self::WrappingOffset => "wrapping_add",
2018-08-29 12:40:00 +00:00
}
}
}
impl fmt::Display for Method {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2018-08-29 13:59:38 +00:00
match self {
Self::Offset => write!(f, "offset"),
Self::WrappingOffset => write!(f, "wrapping_offset"),
2018-08-29 12:40:00 +00:00
}
}
2018-08-29 12:43:40 +00:00
}