rust/clippy_lints/src/non_send_field_in_send_ty.rs

233 lines
9.3 KiB
Rust
Raw Normal View History

use clippy_utils::diagnostics::span_lint_and_then;
use clippy_utils::is_lint_allowed;
2021-09-23 02:51:10 -05:00
use clippy_utils::ty::{implements_trait, is_copy};
use rustc_ast::ImplPolarity;
use rustc_hir::def_id::DefId;
2021-09-23 02:51:10 -05:00
use rustc_hir::{Item, ItemKind};
use rustc_lint::{LateContext, LateLintPass};
use rustc_middle::ty::{self, subst::GenericArgKind, Ty};
use rustc_session::{declare_tool_lint, impl_lint_pass};
use rustc_span::symbol::Symbol;
use rustc_span::{sym, Span};
2021-09-23 02:51:10 -05:00
declare_clippy_lint! {
/// ### What it does
/// Warns about a field in a `Send` struct that is neither `Send` nor `Copy`.
///
/// ### Why is this bad?
2021-09-28 12:46:13 -05:00
/// Sending the struct to another thread will transfer the ownership to
/// the new thread by dropping in the current thread during the transfer.
/// This causes soundness issues for non-`Send` fields, as they are also
/// dropped and might not be set up to handle this.
///
/// See:
/// * [*The Rustonomicon* about *Send and Sync*](https://doc.rust-lang.org/nomicon/send-and-sync.html)
/// * [The documentation of `Send`](https://doc.rust-lang.org/std/marker/trait.Send.html)
2021-09-23 02:51:10 -05:00
///
/// ### Known Problems
/// Data structures that contain raw pointers may cause false positives.
/// They are sometimes safe to be sent across threads but do not implement
/// the `Send` trait. This lint has a heuristic to filter out basic cases
2021-09-28 12:46:13 -05:00
/// such as `Vec<*const T>`, but it's not perfect. Feel free to create an
/// issue if you have a suggestion on how this heuristic can be improved.
2021-09-23 02:51:10 -05:00
///
/// ### Example
2021-09-28 12:46:13 -05:00
/// ```rust,ignore
/// struct ExampleStruct<T> {
/// rc_is_not_send: Rc<String>,
/// unbounded_generic_field: T,
2021-09-23 02:51:10 -05:00
/// }
2021-09-28 12:46:13 -05:00
///
/// // This impl is unsound because it allows sending `!Send` types through `ExampleStruct`
/// unsafe impl<T> Send for ExampleStruct<T> {}
2021-09-23 02:51:10 -05:00
/// ```
2021-09-28 12:46:13 -05:00
/// Use thread-safe types like [`std::sync::Arc`](https://doc.rust-lang.org/std/sync/struct.Arc.html)
2021-10-01 11:47:54 -05:00
/// or specify correct bounds on generic type parameters (`T: Send`).
2021-09-23 02:51:10 -05:00
pub NON_SEND_FIELD_IN_SEND_TY,
nursery,
2021-09-23 05:45:24 -05:00
"there is field that does not implement `Send` in a `Send` struct"
2021-09-23 02:51:10 -05:00
}
#[derive(Copy, Clone)]
pub struct NonSendFieldInSendTy {
enable_raw_pointer_heuristic: bool,
}
impl NonSendFieldInSendTy {
pub fn new(enable_raw_pointer_heuristic: bool) -> Self {
Self {
enable_raw_pointer_heuristic,
}
}
}
impl_lint_pass!(NonSendFieldInSendTy => [NON_SEND_FIELD_IN_SEND_TY]);
2021-09-23 02:51:10 -05:00
impl<'tcx> LateLintPass<'tcx> for NonSendFieldInSendTy {
fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'_>) {
let ty_allowed_in_send = if self.enable_raw_pointer_heuristic {
ty_allowed_with_raw_pointer_heuristic
} else {
ty_implements_send_or_copy
};
2021-09-23 05:45:24 -05:00
// Checks if we are in `Send` impl item.
// We start from `Send` impl instead of `check_field_def()` because
// single `AdtDef` may have multiple `Send` impls due to generic
// parameters, and the lint is much easier to implement in this way.
2021-09-23 02:51:10 -05:00
if_chain! {
2021-09-23 05:45:24 -05:00
if let Some(send_trait) = cx.tcx.get_diagnostic_item(sym::send_trait);
2021-09-23 02:51:10 -05:00
if let ItemKind::Impl(hir_impl) = &item.kind;
if let Some(trait_ref) = &hir_impl.of_trait;
if let Some(trait_id) = trait_ref.trait_def_id();
if send_trait == trait_id;
if let ImplPolarity::Positive = hir_impl.polarity;
if let Some(ty_trait_ref) = cx.tcx.impl_trait_ref(item.def_id);
if let self_ty = ty_trait_ref.self_ty();
if let ty::Adt(adt_def, impl_trait_substs) = self_ty.kind();
then {
let mut non_send_fields = Vec::new();
let hir_map = cx.tcx.hir();
2021-09-23 02:51:10 -05:00
for variant in &adt_def.variants {
for field in &variant.fields {
if_chain! {
if let Some(field_hir_id) = field
.did
.as_local()
.map(|local_def_id| hir_map.local_def_id_to_hir_id(local_def_id));
if !is_lint_allowed(cx, NON_SEND_FIELD_IN_SEND_TY, field_hir_id);
if let field_ty = field.ty(cx.tcx, impl_trait_substs);
if !ty_allowed_in_send(cx, field_ty, send_trait);
if let Some(field_span) = hir_map.span_if_local(field.did);
then {
non_send_fields.push(NonSendField {
name: hir_map.name(field_hir_id),
span: field_span,
ty: field_ty,
generic_params: collect_generic_params(cx, field_ty),
})
}
2021-09-23 02:51:10 -05:00
}
}
}
2021-09-23 02:51:10 -05:00
if !non_send_fields.is_empty() {
span_lint_and_then(
cx,
NON_SEND_FIELD_IN_SEND_TY,
item.span,
&format!(
"this implementation is unsound, as some fields in `{}` are `!Send`",
self_ty
),
|diag| {
for field in non_send_fields {
diag.span_note(
field.span,
2021-10-01 11:47:54 -05:00
&format!("the field `{}` has type `{}` which is `!Send`", field.name, field.ty),
2021-09-23 05:45:24 -05:00
);
match field.generic_params.len() {
0 => diag.help("use a thread-safe type that implements `Send`"),
1 if is_ty_param(field.ty) => diag.help(&format!("add `{}: Send` bound in `Send` impl", field.ty)),
_ => diag.help(&format!(
"add bounds on type parameter{} `{}` that satisfy `{}: Send`",
if field.generic_params.len() > 1 { "s" } else { "" },
field.generic_params_string(),
field.ty
)),
};
2021-09-23 02:51:10 -05:00
}
},
);
2021-09-23 02:51:10 -05:00
}
}
}
}
}
struct NonSendField<'tcx> {
name: Symbol,
span: Span,
ty: Ty<'tcx>,
generic_params: Vec<Ty<'tcx>>,
}
impl<'tcx> NonSendField<'tcx> {
fn generic_params_string(&self) -> String {
self.generic_params
.iter()
.map(ToString::to_string)
.collect::<Vec<_>>()
.join(", ")
}
}
/// Given a type, collect all of its generic parameters.
2021-10-01 11:47:54 -05:00
/// Example: `MyStruct<P, Box<Q, R>>` => `vec![P, Q, R]`
fn collect_generic_params<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> Vec<Ty<'tcx>> {
ty.walk(cx.tcx)
.filter_map(|inner| match inner.unpack() {
GenericArgKind::Type(inner_ty) => Some(inner_ty),
_ => None,
})
.filter(|&inner_ty| is_ty_param(inner_ty))
.collect()
}
/// Determine if the given type is `Send` or `Copy`
fn ty_implements_send_or_copy(cx: &LateContext<'tcx>, ty: Ty<'tcx>, send_trait: DefId) -> bool {
implements_trait(cx, ty, send_trait, &[]) || is_copy(cx, ty)
}
/// Heuristic to allow cases like `Vec<*const u8>`
fn ty_allowed_with_raw_pointer_heuristic<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>, send_trait: DefId) -> bool {
if ty_implements_send_or_copy(cx, ty, send_trait) {
2021-10-01 11:47:54 -05:00
return true;
}
// The type is known to be `!Send` and `!Copy`
match ty.kind() {
ty::Tuple(_) => ty
.tuple_fields()
.all(|ty| ty_allowed_with_raw_pointer_heuristic(cx, ty, send_trait)),
ty::Array(ty, _) | ty::Slice(ty) => ty_allowed_with_raw_pointer_heuristic(cx, ty, send_trait),
ty::Adt(_, substs) => {
if contains_raw_pointer(cx, ty) {
// descends only if ADT contains any raw pointers
substs.iter().all(|generic_arg| match generic_arg.unpack() {
GenericArgKind::Type(ty) => ty_allowed_with_raw_pointer_heuristic(cx, ty, send_trait),
// Lifetimes and const generics are not solid part of ADT and ignored
GenericArgKind::Lifetime(_) | GenericArgKind::Const(_) => true,
})
} else {
false
}
},
// Raw pointers are `!Send` but allowed by the heuristic
ty::RawPtr(_) => true,
_ => false,
}
}
2021-10-01 11:47:54 -05:00
/// Checks if the type contains any raw pointers in substs (including nested ones).
fn contains_raw_pointer<'tcx>(cx: &LateContext<'tcx>, target_ty: Ty<'tcx>) -> bool {
2021-09-23 02:51:10 -05:00
for ty_node in target_ty.walk(cx.tcx) {
if_chain! {
if let GenericArgKind::Type(inner_ty) = ty_node.unpack();
if let ty::RawPtr(_) = inner_ty.kind();
then {
return true;
}
}
}
false
}
/// Returns `true` if the type is a type parameter such as `T`.
2021-09-23 05:45:24 -05:00
fn is_ty_param(target_ty: Ty<'_>) -> bool {
2021-09-23 02:51:10 -05:00
matches!(target_ty.kind(), ty::Param(_))
}