1use std::iter;
2use std::ops::ControlFlow;
34use bitflags::bitflags;
5use rustc_abi::VariantIdx;
6use rustc_data_structures::fx::FxHashSet;
7use rustc_errors::{DiagMessage, msg};
8use rustc_hir::def::CtorKind;
9use rustc_hir::intravisit::VisitorExt;
10use rustc_hir::{selfas hir, AmbigArg};
11use rustc_middle::bug;
12use rustc_middle::ty::{
13self, Adt, AdtDef, AdtKind, GenericArgsRef, Ty, TyCtxt, TypeSuperVisitable, TypeVisitable,
14TypeVisitableExt, Unnormalized,
15};
16use rustc_session::{declare_lint, declare_lint_pass};
17use rustc_span::def_id::LocalDefId;
18use rustc_span::{Span, sym};
19use rustc_target::spec::Os;
20use tracing::debug;
2122use super::repr_nullable_ptr;
23use crate::lints::{ImproperCTypes, UsesPowerAlignment};
24use crate::{LateContext, LateLintPass, LintContext};
2526#[doc =
r" The `improper_ctypes` lint detects incorrect use of types in foreign"]
#[doc = r" modules."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r#" unsafe extern "C" {"#]
#[doc = r" static STATIC: String;"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" The compiler has several checks to verify that types used in `extern`"]
#[doc = r" blocks are safe and follow certain rules to ensure proper"]
#[doc =
r" compatibility with the foreign interfaces. This lint is issued when it"]
#[doc =
r" detects a probable mistake in a definition. The lint usually should"]
#[doc =
r" provide a description of the issue, along with possibly a hint on how"]
#[doc = r" to resolve it."]
static IMPROPER_CTYPES: &::rustc_lint_defs::Lint =
&::rustc_lint_defs::Lint {
name: "IMPROPER_CTYPES",
default_level: ::rustc_lint_defs::Warn,
desc: "proper use of libc types in foreign modules",
is_externally_loaded: false,
..::rustc_lint_defs::Lint::default_fields_for_macro()
};declare_lint! {
27/// The `improper_ctypes` lint detects incorrect use of types in foreign
28 /// modules.
29 ///
30 /// ### Example
31 ///
32 /// ```rust
33 /// unsafe extern "C" {
34 /// static STATIC: String;
35 /// }
36 /// ```
37 ///
38 /// {{produces}}
39 ///
40 /// ### Explanation
41 ///
42 /// The compiler has several checks to verify that types used in `extern`
43 /// blocks are safe and follow certain rules to ensure proper
44 /// compatibility with the foreign interfaces. This lint is issued when it
45 /// detects a probable mistake in a definition. The lint usually should
46 /// provide a description of the issue, along with possibly a hint on how
47 /// to resolve it.
48IMPROPER_CTYPES,
49 Warn,
50"proper use of libc types in foreign modules"
51}5253#[doc = r" The `improper_ctypes_definitions` lint detects incorrect use of"]
#[doc = r" [`extern` function] definitions."]
#[doc = r""]
#[doc =
r" [`extern` function]: https://doc.rust-lang.org/reference/items/functions.html#extern-function-qualifier"]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust"]
#[doc = r" # #![allow(unused)]"]
#[doc = r#" pub extern "C" fn str_type(p: &str) { }"#]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" {{produces}}"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc =
r" There are many parameter and return types that may be specified in an"]
#[doc =
r" `extern` function that are not compatible with the given ABI. This"]
#[doc =
r" lint is an alert that these types should not be used. The lint usually"]
#[doc =
r" should provide a description of the issue, along with possibly a hint"]
#[doc = r" on how to resolve it."]
static IMPROPER_CTYPES_DEFINITIONS: &::rustc_lint_defs::Lint =
&::rustc_lint_defs::Lint {
name: "IMPROPER_CTYPES_DEFINITIONS",
default_level: ::rustc_lint_defs::Warn,
desc: "proper use of libc types in foreign item definitions",
is_externally_loaded: false,
..::rustc_lint_defs::Lint::default_fields_for_macro()
};declare_lint! {
54/// The `improper_ctypes_definitions` lint detects incorrect use of
55 /// [`extern` function] definitions.
56 ///
57 /// [`extern` function]: https://doc.rust-lang.org/reference/items/functions.html#extern-function-qualifier
58 ///
59 /// ### Example
60 ///
61 /// ```rust
62 /// # #![allow(unused)]
63 /// pub extern "C" fn str_type(p: &str) { }
64 /// ```
65 ///
66 /// {{produces}}
67 ///
68 /// ### Explanation
69 ///
70 /// There are many parameter and return types that may be specified in an
71 /// `extern` function that are not compatible with the given ABI. This
72 /// lint is an alert that these types should not be used. The lint usually
73 /// should provide a description of the issue, along with possibly a hint
74 /// on how to resolve it.
75IMPROPER_CTYPES_DEFINITIONS,
76 Warn,
77"proper use of libc types in foreign item definitions"
78}7980#[doc = r" The `uses_power_alignment` lint detects specific `repr(C)`"]
#[doc = r" aggregates on AIX."]
#[doc =
r#" In its platform C ABI, AIX uses the "power" (as in PowerPC) alignment"#]
#[doc =
r" rule (detailed in https://www.ibm.com/docs/en/xl-c-and-cpp-aix/16.1?topic=data-using-alignment-modes#alignment),"]
#[doc = r" which can also be set for XLC by `#pragma align(power)` or"]
#[doc = r" `-qalign=power`. Aggregates with a floating-point type as the"]
#[doc =
r#" recursively first field (as in "at offset 0") modify the layout of"#]
#[doc =
r" *subsequent* fields of the associated structs to use an alignment value"]
#[doc = r" where the floating-point type is aligned on a 4-byte boundary."]
#[doc = r""]
#[doc =
r" Effectively, subsequent floating-point fields act as-if they are `repr(packed(4))`. This"]
#[doc =
r" would be unsound to do in a `repr(C)` type without all the restrictions that come with"]
#[doc =
r" `repr(packed)`. Rust instead chooses a layout that maintains soundness of Rust code, at the"]
#[doc = r" expense of incompatibility with C code."]
#[doc = r""]
#[doc = r" ### Example"]
#[doc = r""]
#[doc = r" ```rust,ignore (fails on non-powerpc64-ibm-aix)"]
#[doc = r" #[repr(C)]"]
#[doc = r" pub struct Floats {"]
#[doc = r" a: f64,"]
#[doc = r" b: u8,"]
#[doc = r" c: f64,"]
#[doc = r" }"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" This will produce:"]
#[doc = r""]
#[doc = r" ```text"]
#[doc =
r" warning: repr(C) does not follow the power alignment rule. This may affect platform C ABI compatibility for this type"]
#[doc = r" --> <source>:5:3"]
#[doc = r" |"]
#[doc = r" 5 | c: f64,"]
#[doc = r" | ^^^^^^"]
#[doc = r" |"]
#[doc = r" = note: `#[warn(uses_power_alignment)]` on by default"]
#[doc = r" ```"]
#[doc = r""]
#[doc = r" ### Explanation"]
#[doc = r""]
#[doc = r" The power alignment rule specifies that the above struct has the"]
#[doc = r" following alignment:"]
#[doc = r" - offset_of!(Floats, a) == 0"]
#[doc = r" - offset_of!(Floats, b) == 8"]
#[doc = r" - offset_of!(Floats, c) == 12"]
#[doc = r""]
#[doc =
r" However, Rust currently aligns `c` at `offset_of!(Floats, c) == 16`."]
#[doc =
r" Using offset 12 would be unsound since `f64` generally must be 8-aligned on this target."]
#[doc = r" Thus, a warning is produced for the above struct."]
static USES_POWER_ALIGNMENT: &::rustc_lint_defs::Lint =
&::rustc_lint_defs::Lint {
name: "USES_POWER_ALIGNMENT",
default_level: ::rustc_lint_defs::Warn,
desc: "Structs do not follow the power alignment rule under repr(C)",
is_externally_loaded: false,
..::rustc_lint_defs::Lint::default_fields_for_macro()
};declare_lint! {
81/// The `uses_power_alignment` lint detects specific `repr(C)`
82 /// aggregates on AIX.
83 /// In its platform C ABI, AIX uses the "power" (as in PowerPC) alignment
84 /// rule (detailed in https://www.ibm.com/docs/en/xl-c-and-cpp-aix/16.1?topic=data-using-alignment-modes#alignment),
85 /// which can also be set for XLC by `#pragma align(power)` or
86 /// `-qalign=power`. Aggregates with a floating-point type as the
87 /// recursively first field (as in "at offset 0") modify the layout of
88 /// *subsequent* fields of the associated structs to use an alignment value
89 /// where the floating-point type is aligned on a 4-byte boundary.
90 ///
91 /// Effectively, subsequent floating-point fields act as-if they are `repr(packed(4))`. This
92 /// would be unsound to do in a `repr(C)` type without all the restrictions that come with
93 /// `repr(packed)`. Rust instead chooses a layout that maintains soundness of Rust code, at the
94 /// expense of incompatibility with C code.
95 ///
96 /// ### Example
97 ///
98 /// ```rust,ignore (fails on non-powerpc64-ibm-aix)
99 /// #[repr(C)]
100 /// pub struct Floats {
101 /// a: f64,
102 /// b: u8,
103 /// c: f64,
104 /// }
105 /// ```
106 ///
107 /// This will produce:
108 ///
109 /// ```text
110 /// warning: repr(C) does not follow the power alignment rule. This may affect platform C ABI compatibility for this type
111 /// --> <source>:5:3
112 /// |
113 /// 5 | c: f64,
114 /// | ^^^^^^
115 /// |
116 /// = note: `#[warn(uses_power_alignment)]` on by default
117 /// ```
118 ///
119 /// ### Explanation
120 ///
121 /// The power alignment rule specifies that the above struct has the
122 /// following alignment:
123 /// - offset_of!(Floats, a) == 0
124 /// - offset_of!(Floats, b) == 8
125 /// - offset_of!(Floats, c) == 12
126 ///
127 /// However, Rust currently aligns `c` at `offset_of!(Floats, c) == 16`.
128 /// Using offset 12 would be unsound since `f64` generally must be 8-aligned on this target.
129 /// Thus, a warning is produced for the above struct.
130USES_POWER_ALIGNMENT,
131 Warn,
132"Structs do not follow the power alignment rule under repr(C)"
133}134135pub struct ImproperCTypesLint;
#[automatically_derived]
impl ::core::marker::Copy for ImproperCTypesLint { }
#[automatically_derived]
#[doc(hidden)]
unsafe impl ::core::clone::TrivialClone for ImproperCTypesLint { }
#[automatically_derived]
impl ::core::clone::Clone for ImproperCTypesLint {
#[inline]
fn clone(&self) -> ImproperCTypesLint { *self }
}
impl ::rustc_lint_defs::LintPass for ImproperCTypesLint {
fn name(&self) -> &'static str { "ImproperCTypesLint" }
fn get_lints(&self) -> ::rustc_lint_defs::LintVec {
::alloc::boxed::box_assume_init_into_vec_unsafe(::alloc::intrinsics::write_box_via_move(::alloc::boxed::Box::new_uninit(),
[IMPROPER_CTYPES, IMPROPER_CTYPES_DEFINITIONS,
USES_POWER_ALIGNMENT]))
}
}
impl ImproperCTypesLint {
#[allow(unused)]
pub fn lint_vec() -> ::rustc_lint_defs::LintVec {
::alloc::boxed::box_assume_init_into_vec_unsafe(::alloc::intrinsics::write_box_via_move(::alloc::boxed::Box::new_uninit(),
[IMPROPER_CTYPES, IMPROPER_CTYPES_DEFINITIONS,
USES_POWER_ALIGNMENT]))
}
}declare_lint_pass!(ImproperCTypesLint => [
136 IMPROPER_CTYPES,
137 IMPROPER_CTYPES_DEFINITIONS,
138 USES_POWER_ALIGNMENT
139]);
140141/// A common pattern in this lint is to attempt normalize_erasing_regions,
142/// but keep the original type if it were to fail.
143/// This may or may not be supported in the logic behind the `Unnormalized` wrapper,
144/// (FIXME?)
145/// but it should be enough for non-wrapped types to be as normalised as this lint needs them to be.
146fn maybe_normalize_erasing_regions<'tcx>(
147 cx: &LateContext<'tcx>,
148 value: Unnormalized<'tcx, Ty<'tcx>>,
149) -> Ty<'tcx> {
150// Use `TypingMode::Borrowck` so the new solver doesn't reveal opaque types since we're now
151 // past hir typeck. If we were to attempt to reveal more opaque types, dropping the
152 // `InferCtxt` would ICE (see #156352).
153let typing_env = if let Some(body_id) = cx.enclosing_body {
154let body_def_id = cx.tcx.hir_enclosing_body_owner(body_id.hir_id);
155 ty::TypingEnv::new(cx.param_env, ty::TypingMode::borrowck(cx.tcx, body_def_id))
156 } else {
157cx.typing_env()
158 };
159cx.tcx.try_normalize_erasing_regions(typing_env, value).unwrap_or(value.skip_norm_wip())
160}
161162/// Check a variant of a non-exhaustive enum for improper ctypes
163///
164/// We treat `#[non_exhaustive] enum` as "ensure that code will compile if new variants are added".
165/// This includes linting, on a best-effort basis. There are valid additions that are unlikely.
166///
167/// Adding a data-carrying variant to an existing C-like enum that is passed to C is "unlikely",
168/// so we don't need the lint to account for it.
169/// e.g. going from enum Foo { A, B, C } to enum Foo { A, B, C, D(u32) }.
170pub(crate) fn check_non_exhaustive_variant(
171 non_exhaustive_variant_list: bool,
172 variant: &ty::VariantDef,
173) -> ControlFlow<DiagMessage, ()> {
174// non_exhaustive suggests it is possible that someone might break ABI
175 // see: https://github.com/rust-lang/rust/issues/44109#issuecomment-537583344
176 // so warn on complex enums being used outside their crate
177if non_exhaustive_variant_list {
178// which is why we only warn about really_tagged_union reprs from https://rust.tf/rfc2195
179 // with an enum like `#[repr(u8)] enum Enum { A(DataA), B(DataB), }`
180 // but exempt enums with unit ctors like C's (e.g. from rust-bindgen)
181if variant_has_complex_ctor(variant) {
182return ControlFlow::Break(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this enum is non-exhaustive"))msg!("this enum is non-exhaustive"));
183 }
184 }
185186if variant.field_list_has_applicable_non_exhaustive() {
187return ControlFlow::Break(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this enum has non-exhaustive variants"))msg!("this enum has non-exhaustive variants"));
188 }
189190 ControlFlow::Continue(())
191}
192193fn variant_has_complex_ctor(variant: &ty::VariantDef) -> bool {
194// CtorKind::Const means a "unit" ctor
195 !#[allow(non_exhaustive_omitted_patterns)] match variant.ctor_kind() {
Some(CtorKind::Const) => true,
_ => false,
}matches!(variant.ctor_kind(), Some(CtorKind::Const))196}
197198/// Per-struct-field function that checks if a struct definition follows
199/// the Power alignment Rule (see the `check_struct_for_power_alignment` function).
200fn check_arg_for_power_alignment<'tcx>(cx: &LateContext<'tcx>, ty: Ty<'tcx>) -> bool {
201let tcx = cx.tcx;
202if !(tcx.sess.target.os == Os::Aix) {
::core::panicking::panic("assertion failed: tcx.sess.target.os == Os::Aix")
};assert!(tcx.sess.target.os == Os::Aix);
203204// Structs (under repr(C)) follow the power alignment rule if:
205 // - the first field of the struct is a floating-point type that
206 // is greater than 4-bytes, or
207 // - the first field of the struct is an aggregate whose
208 // recursively first field is a floating-point type greater than
209 // 4 bytes.
210if ty.is_floating_point() && ty.primitive_size(tcx).bytes() > 4 {
211return true;
212 } else if let Adt(adt_def, _) = ty.kind()
213 && adt_def.is_struct()
214 && adt_def.repr().c()
215 && !adt_def.repr().packed()
216 && adt_def.repr().align.is_none()
217 {
218let struct_variant = adt_def.variant(VariantIdx::ZERO);
219// Within a nested struct, all fields are examined to correctly
220 // report if any fields after the nested struct within the
221 // original struct are misaligned.
222for struct_field in &struct_variant.fields {
223let field_ty = tcx.type_of(struct_field.did).instantiate_identity().skip_norm_wip();
224if check_arg_for_power_alignment(cx, field_ty) {
225return true;
226 }
227 }
228 }
229return false;
230}
231232/// Check a struct definition for respect of the Power alignment Rule (as in PowerPC),
233/// which should be respected in the "aix" target OS.
234/// To do so, we must follow one of the two following conditions:
235/// - The first field of the struct must be floating-point type that
236/// is greater than 4-bytes.
237/// - The first field of the struct must be an aggregate whose
238/// recursively first field is a floating-point type greater than
239/// 4 bytes.
240fn check_struct_for_power_alignment<'tcx>(
241 cx: &LateContext<'tcx>,
242 item: &'tcx hir::Item<'tcx>,
243 adt_def: AdtDef<'tcx>,
244) {
245let tcx = cx.tcx;
246247// Only consider structs (not enums or unions) on AIX.
248if tcx.sess.target.os != Os::Aix || !adt_def.is_struct() {
249return;
250 }
251252// The struct must be repr(C), but ignore it if it explicitly specifies its alignment with
253 // either `align(N)` or `packed(N)`.
254if adt_def.repr().c() && !adt_def.repr().packed() && adt_def.repr().align.is_none() {
255let struct_variant_data = item.expect_struct().2;
256for field_def in struct_variant_data.fields().iter().skip(1) {
257// Struct fields (after the first field) are checked for the
258 // power alignment rule, as fields after the first are likely
259 // to be the fields that are misaligned.
260let ty = tcx.type_of(field_def.def_id).instantiate_identity().skip_norm_wip();
261if check_arg_for_power_alignment(cx, ty) {
262 cx.emit_span_lint(USES_POWER_ALIGNMENT, field_def.span, UsesPowerAlignment);
263 }
264 }
265 }
266}
267268/// Annotates whether we are in the context of an item *defined* in rust
269/// and exposed to an FFI boundary,
270/// or the context of an item from elsewhere, whose interface is re-*declared* in rust.
271#[derive(#[automatically_derived]
impl ::core::clone::Clone for CItemKind {
#[inline]
fn clone(&self) -> CItemKind { *self }
}Clone, #[automatically_derived]
impl ::core::marker::Copy for CItemKind { }Copy)]
272enum CItemKind {
273 Declaration,
274 Definition,
275}
276277/// Annotates whether we are in the context of a function's argument types or return type.
278#[derive(#[automatically_derived]
impl ::core::clone::Clone for FnPos {
#[inline]
fn clone(&self) -> FnPos { *self }
}Clone, #[automatically_derived]
impl ::core::marker::Copy for FnPos { }Copy)]
279enum FnPos {
280 Arg,
281 Ret,
282}
283284enum FfiResult<'tcx> {
285 FfiSafe,
286 FfiPhantom(Ty<'tcx>),
287 FfiUnsafe { ty: Ty<'tcx>, reason: DiagMessage, help: Option<DiagMessage> },
288}
289290/// The result when a type has been checked but perhaps not completely. `None` indicates that
291/// FFI safety/unsafety has not yet been determined, `Some(res)` indicates that the safety/unsafety
292/// in the `FfiResult` is final.
293type PartialFfiResult<'tcx> = Option<FfiResult<'tcx>>;
294295/// What type indirection points to a given type.
296#[derive(#[automatically_derived]
impl ::core::clone::Clone for IndirectionKind {
#[inline]
fn clone(&self) -> IndirectionKind { *self }
}Clone, #[automatically_derived]
impl ::core::marker::Copy for IndirectionKind { }Copy)]
297enum IndirectionKind {
298/// Box (valid non-null pointer, owns pointee).
299Box,
300/// Ref (valid non-null pointer, borrows pointee).
301Ref,
302/// Raw pointer (not necessarily non-null or valid. no info on ownership).
303RawPtr,
304}
305306bitflags! {
307/// VisitorState flags that are linked with the root type's use.
308 /// (These are the permanent part of the state, kept when visiting new Ty.)
309#[derive(#[automatically_derived]
impl ::core::clone::Clone for RootUseFlags {
#[inline]
fn clone(&self) -> RootUseFlags {
let _:
::core::clone::AssertParamIsClone<<RootUseFlags as
::bitflags::__private::PublicFlags>::Internal>;
*self
}
}
impl RootUseFlags {
#[doc = r" For use in (externally-linked) static variables."]
#[allow(deprecated, non_upper_case_globals,)]
pub const STATIC: Self = Self::from_bits_retain(0b000001);
#[doc = r" For use in functions in general."]
#[allow(deprecated, non_upper_case_globals,)]
pub const FUNC: Self = Self::from_bits_retain(0b000010);
#[doc =
r" For variables in function returns (implicitly: not for static variables)."]
#[allow(deprecated, non_upper_case_globals,)]
pub const FN_RETURN: Self = Self::from_bits_retain(0b000100);
#[doc =
r" For variables in functions/variables which are defined in rust."]
#[allow(deprecated, non_upper_case_globals,)]
pub const DEFINED: Self = Self::from_bits_retain(0b001000);
#[doc = r" For times where we are only defining the type of something"]
#[doc = r" (struct/enum/union definitions, FnPtrs)."]
#[allow(deprecated, non_upper_case_globals,)]
pub const THEORETICAL: Self = Self::from_bits_retain(0b010000);
}
impl ::bitflags::Flags for RootUseFlags {
const FLAGS: &'static [::bitflags::Flag<RootUseFlags>] =
&[{
#[allow(deprecated, non_upper_case_globals,)]
::bitflags::Flag::new("STATIC", RootUseFlags::STATIC)
},
{
#[allow(deprecated, non_upper_case_globals,)]
::bitflags::Flag::new("FUNC", RootUseFlags::FUNC)
},
{
#[allow(deprecated, non_upper_case_globals,)]
::bitflags::Flag::new("FN_RETURN", RootUseFlags::FN_RETURN)
},
{
#[allow(deprecated, non_upper_case_globals,)]
::bitflags::Flag::new("DEFINED", RootUseFlags::DEFINED)
},
{
#[allow(deprecated, non_upper_case_globals,)]
::bitflags::Flag::new("THEORETICAL",
RootUseFlags::THEORETICAL)
}];
type Bits = u8;
fn bits(&self) -> u8 { RootUseFlags::bits(self) }
fn from_bits_retain(bits: u8) -> RootUseFlags {
RootUseFlags::from_bits_retain(bits)
}
}
#[allow(dead_code, deprecated, unused_doc_comments, unused_attributes,
unused_mut, unused_imports, non_upper_case_globals, clippy ::
assign_op_pattern, clippy :: indexing_slicing, clippy :: same_name_method,
clippy :: iter_without_into_iter,)]
const _: () =
{
#[repr(transparent)]
struct InternalBitFlags(u8);
#[automatically_derived]
#[doc(hidden)]
unsafe impl ::core::clone::TrivialClone for InternalBitFlags { }
#[automatically_derived]
impl ::core::clone::Clone for InternalBitFlags {
#[inline]
fn clone(&self) -> InternalBitFlags {
let _: ::core::clone::AssertParamIsClone<u8>;
*self
}
}
#[automatically_derived]
impl ::core::marker::Copy for InternalBitFlags { }
#[automatically_derived]
impl ::core::marker::StructuralPartialEq for InternalBitFlags { }
#[automatically_derived]
impl ::core::cmp::PartialEq for InternalBitFlags {
#[inline]
fn eq(&self, other: &InternalBitFlags) -> bool {
self.0 == other.0
}
}
#[automatically_derived]
impl ::core::cmp::Eq for InternalBitFlags {
#[inline]
#[doc(hidden)]
#[coverage(off)]
fn assert_fields_are_eq(&self) {
let _: ::core::cmp::AssertParamIsEq<u8>;
}
}
#[automatically_derived]
impl ::core::cmp::PartialOrd for InternalBitFlags {
#[inline]
fn partial_cmp(&self, other: &InternalBitFlags)
-> ::core::option::Option<::core::cmp::Ordering> {
::core::option::Option::Some(::core::cmp::Ord::cmp(self,
other))
}
}
#[automatically_derived]
impl ::core::cmp::Ord for InternalBitFlags {
#[inline]
fn cmp(&self, other: &InternalBitFlags) -> ::core::cmp::Ordering {
::core::cmp::Ord::cmp(&self.0, &other.0)
}
}
#[automatically_derived]
impl ::core::hash::Hash for InternalBitFlags {
#[inline]
fn hash<__H: ::core::hash::Hasher>(&self, state: &mut __H) {
::core::hash::Hash::hash(&self.0, state)
}
}
impl ::bitflags::__private::PublicFlags for RootUseFlags {
type Primitive = u8;
type Internal = InternalBitFlags;
}
impl ::bitflags::__private::core::default::Default for
InternalBitFlags {
#[inline]
fn default() -> Self { InternalBitFlags::empty() }
}
impl ::bitflags::__private::core::fmt::Debug for InternalBitFlags {
fn fmt(&self,
f: &mut ::bitflags::__private::core::fmt::Formatter<'_>)
-> ::bitflags::__private::core::fmt::Result {
if self.is_empty() {
f.write_fmt(format_args!("{0:#x}",
<u8 as ::bitflags::Bits>::EMPTY))
} else {
::bitflags::__private::core::fmt::Display::fmt(self, f)
}
}
}
impl ::bitflags::__private::core::fmt::Display for InternalBitFlags {
fn fmt(&self,
f: &mut ::bitflags::__private::core::fmt::Formatter<'_>)
-> ::bitflags::__private::core::fmt::Result {
::bitflags::parser::to_writer(&RootUseFlags(*self), f)
}
}
impl ::bitflags::__private::core::str::FromStr for InternalBitFlags {
type Err = ::bitflags::parser::ParseError;
fn from_str(s: &str)
->
::bitflags::__private::core::result::Result<Self,
Self::Err> {
::bitflags::parser::from_str::<RootUseFlags>(s).map(|flags|
flags.0)
}
}
impl ::bitflags::__private::core::convert::AsRef<u8> for
InternalBitFlags {
fn as_ref(&self) -> &u8 { &self.0 }
}
impl ::bitflags::__private::core::convert::From<u8> for
InternalBitFlags {
fn from(bits: u8) -> Self { Self::from_bits_retain(bits) }
}
#[allow(dead_code, deprecated, unused_attributes)]
impl InternalBitFlags {
/// Get a flags value with all bits unset.
#[inline]
pub const fn empty() -> Self {
Self(<u8 as ::bitflags::Bits>::EMPTY)
}
/// Get a flags value with all known bits set.
#[inline]
pub const fn all() -> Self {
let mut truncated = <u8 as ::bitflags::Bits>::EMPTY;
let mut i = 0;
{
{
let flag =
<RootUseFlags as
::bitflags::Flags>::FLAGS[i].value().bits();
truncated = truncated | flag;
i += 1;
}
};
{
{
let flag =
<RootUseFlags as
::bitflags::Flags>::FLAGS[i].value().bits();
truncated = truncated | flag;
i += 1;
}
};
{
{
let flag =
<RootUseFlags as
::bitflags::Flags>::FLAGS[i].value().bits();
truncated = truncated | flag;
i += 1;
}
};
{
{
let flag =
<RootUseFlags as
::bitflags::Flags>::FLAGS[i].value().bits();
truncated = truncated | flag;
i += 1;
}
};
{
{
let flag =
<RootUseFlags as
::bitflags::Flags>::FLAGS[i].value().bits();
truncated = truncated | flag;
i += 1;
}
};
let _ = i;
Self(truncated)
}
/// Get the underlying bits value.
///
/// The returned value is exactly the bits set in this flags value.
#[inline]
pub const fn bits(&self) -> u8 { self.0 }
/// Convert from a bits value.
///
/// This method will return `None` if any unknown bits are set.
#[inline]
pub const fn from_bits(bits: u8)
-> ::bitflags::__private::core::option::Option<Self> {
let truncated = Self::from_bits_truncate(bits).0;
if truncated == bits {
::bitflags::__private::core::option::Option::Some(Self(bits))
} else { ::bitflags::__private::core::option::Option::None }
}
/// Convert from a bits value, unsetting any unknown bits.
#[inline]
pub const fn from_bits_truncate(bits: u8) -> Self {
Self(bits & Self::all().0)
}
/// Convert from a bits value exactly.
#[inline]
pub const fn from_bits_retain(bits: u8) -> Self { Self(bits) }
/// Get a flags value with the bits of a flag with the given name set.
///
/// This method will return `None` if `name` is empty or doesn't
/// correspond to any named flag.
#[inline]
pub fn from_name(name: &str)
-> ::bitflags::__private::core::option::Option<Self> {
{
if name == "STATIC" {
return ::bitflags::__private::core::option::Option::Some(Self(RootUseFlags::STATIC.bits()));
}
};
;
{
if name == "FUNC" {
return ::bitflags::__private::core::option::Option::Some(Self(RootUseFlags::FUNC.bits()));
}
};
;
{
if name == "FN_RETURN" {
return ::bitflags::__private::core::option::Option::Some(Self(RootUseFlags::FN_RETURN.bits()));
}
};
;
{
if name == "DEFINED" {
return ::bitflags::__private::core::option::Option::Some(Self(RootUseFlags::DEFINED.bits()));
}
};
;
{
if name == "THEORETICAL" {
return ::bitflags::__private::core::option::Option::Some(Self(RootUseFlags::THEORETICAL.bits()));
}
};
;
let _ = name;
::bitflags::__private::core::option::Option::None
}
/// Whether all bits in this flags value are unset.
#[inline]
pub const fn is_empty(&self) -> bool {
self.0 == <u8 as ::bitflags::Bits>::EMPTY
}
/// Whether all known bits in this flags value are set.
#[inline]
pub const fn is_all(&self) -> bool {
Self::all().0 | self.0 == self.0
}
/// Whether any set bits in a source flags value are also set in a target flags value.
#[inline]
pub const fn intersects(&self, other: Self) -> bool {
self.0 & other.0 != <u8 as ::bitflags::Bits>::EMPTY
}
/// Whether all set bits in a source flags value are also set in a target flags value.
#[inline]
pub const fn contains(&self, other: Self) -> bool {
self.0 & other.0 == other.0
}
/// The bitwise or (`|`) of the bits in two flags values.
#[inline]
pub fn insert(&mut self, other: Self) {
*self = Self(self.0).union(other);
}
/// The intersection of a source flags value with the complement of a target flags
/// value (`&!`).
///
/// This method is not equivalent to `self & !other` when `other` has unknown bits set.
/// `remove` won't truncate `other`, but the `!` operator will.
#[inline]
pub fn remove(&mut self, other: Self) {
*self = Self(self.0).difference(other);
}
/// The bitwise exclusive-or (`^`) of the bits in two flags values.
#[inline]
pub fn toggle(&mut self, other: Self) {
*self = Self(self.0).symmetric_difference(other);
}
/// Call `insert` when `value` is `true` or `remove` when `value` is `false`.
#[inline]
pub fn set(&mut self, other: Self, value: bool) {
if value { self.insert(other); } else { self.remove(other); }
}
/// The bitwise and (`&`) of the bits in two flags values.
#[inline]
#[must_use]
pub const fn intersection(self, other: Self) -> Self {
Self(self.0 & other.0)
}
/// The bitwise or (`|`) of the bits in two flags values.
#[inline]
#[must_use]
pub const fn union(self, other: Self) -> Self {
Self(self.0 | other.0)
}
/// The intersection of a source flags value with the complement of a target flags
/// value (`&!`).
///
/// This method is not equivalent to `self & !other` when `other` has unknown bits set.
/// `difference` won't truncate `other`, but the `!` operator will.
#[inline]
#[must_use]
pub const fn difference(self, other: Self) -> Self {
Self(self.0 & !other.0)
}
/// The bitwise exclusive-or (`^`) of the bits in two flags values.
#[inline]
#[must_use]
pub const fn symmetric_difference(self, other: Self) -> Self {
Self(self.0 ^ other.0)
}
/// The bitwise negation (`!`) of the bits in a flags value, truncating the result.
#[inline]
#[must_use]
pub const fn complement(self) -> Self {
Self::from_bits_truncate(!self.0)
}
}
impl ::bitflags::__private::core::fmt::Binary for InternalBitFlags {
fn fmt(&self, f: &mut ::bitflags::__private::core::fmt::Formatter)
-> ::bitflags::__private::core::fmt::Result {
let inner = self.0;
::bitflags::__private::core::fmt::Binary::fmt(&inner, f)
}
}
impl ::bitflags::__private::core::fmt::Octal for InternalBitFlags {
fn fmt(&self, f: &mut ::bitflags::__private::core::fmt::Formatter)
-> ::bitflags::__private::core::fmt::Result {
let inner = self.0;
::bitflags::__private::core::fmt::Octal::fmt(&inner, f)
}
}
impl ::bitflags::__private::core::fmt::LowerHex for InternalBitFlags {
fn fmt(&self, f: &mut ::bitflags::__private::core::fmt::Formatter)
-> ::bitflags::__private::core::fmt::Result {
let inner = self.0;
::bitflags::__private::core::fmt::LowerHex::fmt(&inner, f)
}
}
impl ::bitflags::__private::core::fmt::UpperHex for InternalBitFlags {
fn fmt(&self, f: &mut ::bitflags::__private::core::fmt::Formatter)
-> ::bitflags::__private::core::fmt::Result {
let inner = self.0;
::bitflags::__private::core::fmt::UpperHex::fmt(&inner, f)
}
}
impl ::bitflags::__private::core::ops::BitOr for InternalBitFlags {
type Output = Self;
/// The bitwise or (`|`) of the bits in two flags values.
#[inline]
fn bitor(self, other: InternalBitFlags) -> Self {
self.union(other)
}
}
impl ::bitflags::__private::core::ops::BitOrAssign for
InternalBitFlags {
/// The bitwise or (`|`) of the bits in two flags values.
#[inline]
fn bitor_assign(&mut self, other: Self) { self.insert(other); }
}
impl ::bitflags::__private::core::ops::BitXor for InternalBitFlags {
type Output = Self;
/// The bitwise exclusive-or (`^`) of the bits in two flags values.
#[inline]
fn bitxor(self, other: Self) -> Self {
self.symmetric_difference(other)
}
}
impl ::bitflags::__private::core::ops::BitXorAssign for
InternalBitFlags {
/// The bitwise exclusive-or (`^`) of the bits in two flags values.
#[inline]
fn bitxor_assign(&mut self, other: Self) { self.toggle(other); }
}
impl ::bitflags::__private::core::ops::BitAnd for InternalBitFlags {
type Output = Self;
/// The bitwise and (`&`) of the bits in two flags values.
#[inline]
fn bitand(self, other: Self) -> Self { self.intersection(other) }
}
impl ::bitflags::__private::core::ops::BitAndAssign for
InternalBitFlags {
/// The bitwise and (`&`) of the bits in two flags values.
#[inline]
fn bitand_assign(&mut self, other: Self) {
*self =
Self::from_bits_retain(self.bits()).intersection(other);
}
}
impl ::bitflags::__private::core::ops::Sub for InternalBitFlags {
type Output = Self;
/// The intersection of a source flags value with the complement of a target flags value (`&!`).
///
/// This method is not equivalent to `self & !other` when `other` has unknown bits set.
/// `difference` won't truncate `other`, but the `!` operator will.
#[inline]
fn sub(self, other: Self) -> Self { self.difference(other) }
}
impl ::bitflags::__private::core::ops::SubAssign for InternalBitFlags
{
/// The intersection of a source flags value with the complement of a target flags value (`&!`).
///
/// This method is not equivalent to `self & !other` when `other` has unknown bits set.
/// `difference` won't truncate `other`, but the `!` operator will.
#[inline]
fn sub_assign(&mut self, other: Self) { self.remove(other); }
}
impl ::bitflags::__private::core::ops::Not for InternalBitFlags {
type Output = Self;
/// The bitwise negation (`!`) of the bits in a flags value, truncating the result.
#[inline]
fn not(self) -> Self { self.complement() }
}
impl ::bitflags::__private::core::iter::Extend<InternalBitFlags> for
InternalBitFlags {
/// The bitwise or (`|`) of the bits in each flags value.
fn extend<T: ::bitflags::__private::core::iter::IntoIterator<Item
= Self>>(&mut self, iterator: T) {
for item in iterator { self.insert(item) }
}
}
impl ::bitflags::__private::core::iter::FromIterator<InternalBitFlags>
for InternalBitFlags {
/// The bitwise or (`|`) of the bits in each flags value.
fn from_iter<T: ::bitflags::__private::core::iter::IntoIterator<Item
= Self>>(iterator: T) -> Self {
use ::bitflags::__private::core::iter::Extend;
let mut result = Self::empty();
result.extend(iterator);
result
}
}
impl InternalBitFlags {
/// Yield a set of contained flags values.
///
/// Each yielded flags value will correspond to a defined named flag. Any unknown bits
/// will be yielded together as a final flags value.
#[inline]
pub const fn iter(&self) -> ::bitflags::iter::Iter<RootUseFlags> {
::bitflags::iter::Iter::__private_const_new(<RootUseFlags as
::bitflags::Flags>::FLAGS,
RootUseFlags::from_bits_retain(self.bits()),
RootUseFlags::from_bits_retain(self.bits()))
}
/// Yield a set of contained named flags values.
///
/// This method is like [`iter`](#method.iter), except only yields bits in contained named flags.
/// Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
#[inline]
pub const fn iter_names(&self)
-> ::bitflags::iter::IterNames<RootUseFlags> {
::bitflags::iter::IterNames::__private_const_new(<RootUseFlags
as ::bitflags::Flags>::FLAGS,
RootUseFlags::from_bits_retain(self.bits()),
RootUseFlags::from_bits_retain(self.bits()))
}
}
impl ::bitflags::__private::core::iter::IntoIterator for
InternalBitFlags {
type Item = RootUseFlags;
type IntoIter = ::bitflags::iter::Iter<RootUseFlags>;
fn into_iter(self) -> Self::IntoIter { self.iter() }
}
impl InternalBitFlags {
/// Returns a mutable reference to the raw value of the flags currently stored.
#[inline]
pub fn bits_mut(&mut self) -> &mut u8 { &mut self.0 }
}
#[allow(dead_code, deprecated, unused_attributes)]
impl RootUseFlags {
/// Get a flags value with all bits unset.
#[inline]
pub const fn empty() -> Self { Self(InternalBitFlags::empty()) }
/// Get a flags value with all known bits set.
#[inline]
pub const fn all() -> Self { Self(InternalBitFlags::all()) }
/// Get the underlying bits value.
///
/// The returned value is exactly the bits set in this flags value.
#[inline]
pub const fn bits(&self) -> u8 { self.0.bits() }
/// Convert from a bits value.
///
/// This method will return `None` if any unknown bits are set.
#[inline]
pub const fn from_bits(bits: u8)
-> ::bitflags::__private::core::option::Option<Self> {
match InternalBitFlags::from_bits(bits) {
::bitflags::__private::core::option::Option::Some(bits) =>
::bitflags::__private::core::option::Option::Some(Self(bits)),
::bitflags::__private::core::option::Option::None =>
::bitflags::__private::core::option::Option::None,
}
}
/// Convert from a bits value, unsetting any unknown bits.
#[inline]
pub const fn from_bits_truncate(bits: u8) -> Self {
Self(InternalBitFlags::from_bits_truncate(bits))
}
/// Convert from a bits value exactly.
#[inline]
pub const fn from_bits_retain(bits: u8) -> Self {
Self(InternalBitFlags::from_bits_retain(bits))
}
/// Get a flags value with the bits of a flag with the given name set.
///
/// This method will return `None` if `name` is empty or doesn't
/// correspond to any named flag.
#[inline]
pub fn from_name(name: &str)
-> ::bitflags::__private::core::option::Option<Self> {
match InternalBitFlags::from_name(name) {
::bitflags::__private::core::option::Option::Some(bits) =>
::bitflags::__private::core::option::Option::Some(Self(bits)),
::bitflags::__private::core::option::Option::None =>
::bitflags::__private::core::option::Option::None,
}
}
/// Whether all bits in this flags value are unset.
#[inline]
pub const fn is_empty(&self) -> bool { self.0.is_empty() }
/// Whether all known bits in this flags value are set.
#[inline]
pub const fn is_all(&self) -> bool { self.0.is_all() }
/// Whether any set bits in a source flags value are also set in a target flags value.
#[inline]
pub const fn intersects(&self, other: Self) -> bool {
self.0.intersects(other.0)
}
/// Whether all set bits in a source flags value are also set in a target flags value.
#[inline]
pub const fn contains(&self, other: Self) -> bool {
self.0.contains(other.0)
}
/// The bitwise or (`|`) of the bits in two flags values.
#[inline]
pub fn insert(&mut self, other: Self) { self.0.insert(other.0) }
/// The intersection of a source flags value with the complement of a target flags
/// value (`&!`).
///
/// This method is not equivalent to `self & !other` when `other` has unknown bits set.
/// `remove` won't truncate `other`, but the `!` operator will.
#[inline]
pub fn remove(&mut self, other: Self) { self.0.remove(other.0) }
/// The bitwise exclusive-or (`^`) of the bits in two flags values.
#[inline]
pub fn toggle(&mut self, other: Self) { self.0.toggle(other.0) }
/// Call `insert` when `value` is `true` or `remove` when `value` is `false`.
#[inline]
pub fn set(&mut self, other: Self, value: bool) {
self.0.set(other.0, value)
}
/// The bitwise and (`&`) of the bits in two flags values.
#[inline]
#[must_use]
pub const fn intersection(self, other: Self) -> Self {
Self(self.0.intersection(other.0))
}
/// The bitwise or (`|`) of the bits in two flags values.
#[inline]
#[must_use]
pub const fn union(self, other: Self) -> Self {
Self(self.0.union(other.0))
}
/// The intersection of a source flags value with the complement of a target flags
/// value (`&!`).
///
/// This method is not equivalent to `self & !other` when `other` has unknown bits set.
/// `difference` won't truncate `other`, but the `!` operator will.
#[inline]
#[must_use]
pub const fn difference(self, other: Self) -> Self {
Self(self.0.difference(other.0))
}
/// The bitwise exclusive-or (`^`) of the bits in two flags values.
#[inline]
#[must_use]
pub const fn symmetric_difference(self, other: Self) -> Self {
Self(self.0.symmetric_difference(other.0))
}
/// The bitwise negation (`!`) of the bits in a flags value, truncating the result.
#[inline]
#[must_use]
pub const fn complement(self) -> Self {
Self(self.0.complement())
}
}
impl ::bitflags::__private::core::fmt::Binary for RootUseFlags {
fn fmt(&self, f: &mut ::bitflags::__private::core::fmt::Formatter)
-> ::bitflags::__private::core::fmt::Result {
let inner = self.0;
::bitflags::__private::core::fmt::Binary::fmt(&inner, f)
}
}
impl ::bitflags::__private::core::fmt::Octal for RootUseFlags {
fn fmt(&self, f: &mut ::bitflags::__private::core::fmt::Formatter)
-> ::bitflags::__private::core::fmt::Result {
let inner = self.0;
::bitflags::__private::core::fmt::Octal::fmt(&inner, f)
}
}
impl ::bitflags::__private::core::fmt::LowerHex for RootUseFlags {
fn fmt(&self, f: &mut ::bitflags::__private::core::fmt::Formatter)
-> ::bitflags::__private::core::fmt::Result {
let inner = self.0;
::bitflags::__private::core::fmt::LowerHex::fmt(&inner, f)
}
}
impl ::bitflags::__private::core::fmt::UpperHex for RootUseFlags {
fn fmt(&self, f: &mut ::bitflags::__private::core::fmt::Formatter)
-> ::bitflags::__private::core::fmt::Result {
let inner = self.0;
::bitflags::__private::core::fmt::UpperHex::fmt(&inner, f)
}
}
impl ::bitflags::__private::core::ops::BitOr for RootUseFlags {
type Output = Self;
/// The bitwise or (`|`) of the bits in two flags values.
#[inline]
fn bitor(self, other: RootUseFlags) -> Self { self.union(other) }
}
impl ::bitflags::__private::core::ops::BitOrAssign for RootUseFlags {
/// The bitwise or (`|`) of the bits in two flags values.
#[inline]
fn bitor_assign(&mut self, other: Self) { self.insert(other); }
}
impl ::bitflags::__private::core::ops::BitXor for RootUseFlags {
type Output = Self;
/// The bitwise exclusive-or (`^`) of the bits in two flags values.
#[inline]
fn bitxor(self, other: Self) -> Self {
self.symmetric_difference(other)
}
}
impl ::bitflags::__private::core::ops::BitXorAssign for RootUseFlags {
/// The bitwise exclusive-or (`^`) of the bits in two flags values.
#[inline]
fn bitxor_assign(&mut self, other: Self) { self.toggle(other); }
}
impl ::bitflags::__private::core::ops::BitAnd for RootUseFlags {
type Output = Self;
/// The bitwise and (`&`) of the bits in two flags values.
#[inline]
fn bitand(self, other: Self) -> Self { self.intersection(other) }
}
impl ::bitflags::__private::core::ops::BitAndAssign for RootUseFlags {
/// The bitwise and (`&`) of the bits in two flags values.
#[inline]
fn bitand_assign(&mut self, other: Self) {
*self =
Self::from_bits_retain(self.bits()).intersection(other);
}
}
impl ::bitflags::__private::core::ops::Sub for RootUseFlags {
type Output = Self;
/// The intersection of a source flags value with the complement of a target flags value (`&!`).
///
/// This method is not equivalent to `self & !other` when `other` has unknown bits set.
/// `difference` won't truncate `other`, but the `!` operator will.
#[inline]
fn sub(self, other: Self) -> Self { self.difference(other) }
}
impl ::bitflags::__private::core::ops::SubAssign for RootUseFlags {
/// The intersection of a source flags value with the complement of a target flags value (`&!`).
///
/// This method is not equivalent to `self & !other` when `other` has unknown bits set.
/// `difference` won't truncate `other`, but the `!` operator will.
#[inline]
fn sub_assign(&mut self, other: Self) { self.remove(other); }
}
impl ::bitflags::__private::core::ops::Not for RootUseFlags {
type Output = Self;
/// The bitwise negation (`!`) of the bits in a flags value, truncating the result.
#[inline]
fn not(self) -> Self { self.complement() }
}
impl ::bitflags::__private::core::iter::Extend<RootUseFlags> for
RootUseFlags {
/// The bitwise or (`|`) of the bits in each flags value.
fn extend<T: ::bitflags::__private::core::iter::IntoIterator<Item
= Self>>(&mut self, iterator: T) {
for item in iterator { self.insert(item) }
}
}
impl ::bitflags::__private::core::iter::FromIterator<RootUseFlags> for
RootUseFlags {
/// The bitwise or (`|`) of the bits in each flags value.
fn from_iter<T: ::bitflags::__private::core::iter::IntoIterator<Item
= Self>>(iterator: T) -> Self {
use ::bitflags::__private::core::iter::Extend;
let mut result = Self::empty();
result.extend(iterator);
result
}
}
impl RootUseFlags {
/// Yield a set of contained flags values.
///
/// Each yielded flags value will correspond to a defined named flag. Any unknown bits
/// will be yielded together as a final flags value.
#[inline]
pub const fn iter(&self) -> ::bitflags::iter::Iter<RootUseFlags> {
::bitflags::iter::Iter::__private_const_new(<RootUseFlags as
::bitflags::Flags>::FLAGS,
RootUseFlags::from_bits_retain(self.bits()),
RootUseFlags::from_bits_retain(self.bits()))
}
/// Yield a set of contained named flags values.
///
/// This method is like [`iter`](#method.iter), except only yields bits in contained named flags.
/// Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
#[inline]
pub const fn iter_names(&self)
-> ::bitflags::iter::IterNames<RootUseFlags> {
::bitflags::iter::IterNames::__private_const_new(<RootUseFlags
as ::bitflags::Flags>::FLAGS,
RootUseFlags::from_bits_retain(self.bits()),
RootUseFlags::from_bits_retain(self.bits()))
}
}
impl ::bitflags::__private::core::iter::IntoIterator for RootUseFlags
{
type Item = RootUseFlags;
type IntoIter = ::bitflags::iter::Iter<RootUseFlags>;
fn into_iter(self) -> Self::IntoIter { self.iter() }
}
};Clone, #[automatically_derived]
impl ::core::marker::Copy for RootUseFlags { }Copy, #[automatically_derived]
impl ::core::fmt::Debug for RootUseFlags {
#[inline]
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
::core::fmt::Formatter::debug_tuple_field1_finish(f, "RootUseFlags",
&&self.0)
}
}Debug, #[automatically_derived]
impl ::core::cmp::PartialEq for RootUseFlags {
#[inline]
fn eq(&self, other: &RootUseFlags) -> bool { self.0 == other.0 }
}PartialEq, #[automatically_derived]
impl ::core::cmp::Eq for RootUseFlags {
#[inline]
#[doc(hidden)]
#[coverage(off)]
fn assert_fields_are_eq(&self) {
let _:
::core::cmp::AssertParamIsEq<<RootUseFlags as
::bitflags::__private::PublicFlags>::Internal>;
}
}Eq)]
310struct RootUseFlags: u8 {
311/// For use in (externally-linked) static variables.
312const STATIC = 0b000001;
313/// For use in functions in general.
314const FUNC = 0b000010;
315/// For variables in function returns (implicitly: not for static variables).
316const FN_RETURN = 0b000100;
317/// For variables in functions/variables which are defined in rust.
318const DEFINED = 0b001000;
319/// For times where we are only defining the type of something
320 /// (struct/enum/union definitions, FnPtrs).
321const THEORETICAL = 0b010000;
322 }
323}
324325/// Description of the relationship between current Ty and
326/// the type (or lack thereof) immediately containing it
327#[derive(#[automatically_derived]
impl ::core::marker::Copy for OuterTyKind { }Copy, #[automatically_derived]
impl ::core::clone::Clone for OuterTyKind {
#[inline]
fn clone(&self) -> OuterTyKind { *self }
}Clone, #[automatically_derived]
impl ::core::fmt::Debug for OuterTyKind {
#[inline]
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
::core::fmt::Formatter::write_str(f,
match self {
OuterTyKind::None => "None",
OuterTyKind::NoneThroughFnPtr => "NoneThroughFnPtr",
OuterTyKind::Other => "Other",
})
}
}Debug, #[automatically_derived]
impl ::core::cmp::PartialEq for OuterTyKind {
#[inline]
fn eq(&self, other: &OuterTyKind) -> bool {
let __self_discr = ::core::intrinsics::discriminant_value(self);
let __arg1_discr = ::core::intrinsics::discriminant_value(other);
__self_discr == __arg1_discr
}
}PartialEq, #[automatically_derived]
impl ::core::cmp::Eq for OuterTyKind {
#[inline]
#[doc(hidden)]
#[coverage(off)]
fn assert_fields_are_eq(&self) {}
}Eq)]
328enum OuterTyKind {
329None,
330/// A variant that should not exist,
331 /// but is needed because we don't change the lint's behavior yet
332NoneThroughFnPtr,
333/// Placeholder for properties that will be used eventually
334Other,
335}
336337impl OuterTyKind {
338/// Computes the relationship by providing the containing Ty itself
339fn from_ty<'tcx>(ty: Ty<'tcx>) -> Self {
340match ty.kind() {
341 ty::FnPtr(..) => Self::NoneThroughFnPtr,
342 ty::RawPtr(..)
343 | ty::Ref(..)
344 | ty::Adt(..)
345 | ty::Tuple(..)
346 | ty::Array(..)
347 | ty::Slice(_) => OuterTyKind::Other,
348_ => ::rustc_middle::util::bug::bug_fmt(format_args!("Unexpected outer type {0:?}",
ty))bug!("Unexpected outer type {ty:?}"),
349 }
350 }
351}
352353#[derive(#[automatically_derived]
impl ::core::marker::Copy for VisitorState { }Copy, #[automatically_derived]
impl ::core::clone::Clone for VisitorState {
#[inline]
fn clone(&self) -> VisitorState {
let _: ::core::clone::AssertParamIsClone<RootUseFlags>;
let _: ::core::clone::AssertParamIsClone<OuterTyKind>;
let _: ::core::clone::AssertParamIsClone<usize>;
*self
}
}Clone, #[automatically_derived]
impl ::core::fmt::Debug for VisitorState {
#[inline]
fn fmt(&self, f: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
::core::fmt::Formatter::debug_struct_field3_finish(f, "VisitorState",
"root_use_flags", &self.root_use_flags, "outer_ty_kind",
&self.outer_ty_kind, "depth", &&self.depth)
}
}Debug, #[automatically_derived]
impl ::core::cmp::PartialEq for VisitorState {
#[inline]
fn eq(&self, other: &VisitorState) -> bool {
self.root_use_flags == other.root_use_flags &&
self.outer_ty_kind == other.outer_ty_kind &&
self.depth == other.depth
}
}PartialEq, #[automatically_derived]
impl ::core::cmp::Eq for VisitorState {
#[inline]
#[doc(hidden)]
#[coverage(off)]
fn assert_fields_are_eq(&self) {
let _: ::core::cmp::AssertParamIsEq<RootUseFlags>;
let _: ::core::cmp::AssertParamIsEq<OuterTyKind>;
let _: ::core::cmp::AssertParamIsEq<usize>;
}
}Eq)]
354struct VisitorState {
355/// Flags describing both the overall context in which the current Ty is,
356 /// linked to how the Visitor's original Ty was used.
357root_use_flags: RootUseFlags,
358/// Flags describing both the immediate context in which the current Ty is,
359 /// linked to how it relates to its parent Ty (or lack thereof).
360outer_ty_kind: OuterTyKind,
361/// Type recursion depth, to prevent infinite recursion
362depth: usize,
363}
364365impl RootUseFlags {
366// The values that can be set.
367const STATIC_TY: Self = Self::STATIC;
368const ARGUMENT_TY_IN_DEFINITION: Self =
369Self::from_bits(Self::FUNC.bits() | Self::DEFINED.bits()).unwrap();
370const RETURN_TY_IN_DEFINITION: Self =
371Self::from_bits(Self::FUNC.bits() | Self::FN_RETURN.bits() | Self::DEFINED.bits()).unwrap();
372const ARGUMENT_TY_IN_DECLARATION: Self = Self::FUNC;
373const RETURN_TY_IN_DECLARATION: Self =
374Self::from_bits(Self::FUNC.bits() | Self::FN_RETURN.bits()).unwrap();
375const ARGUMENT_TY_IN_FNPTR: Self =
376Self::from_bits(Self::FUNC.bits() | Self::THEORETICAL.bits()).unwrap();
377const RETURN_TY_IN_FNPTR: Self =
378Self::from_bits(Self::FUNC.bits() | Self::THEORETICAL.bits() | Self::FN_RETURN.bits())
379 .unwrap();
380}
381382impl VisitorState {
383/// From an existing state, compute the state of any subtype of the current type.
384 /// (General case. For the case where the current type is a function pointer, see `next_in_fnptr`.)
385fn next(&self, current_ty: Ty<'_>) -> Self {
386if !!#[allow(non_exhaustive_omitted_patterns)] match current_ty.kind() {
ty::FnPtr(..) => true,
_ => false,
} {
::core::panicking::panic("assertion failed: !matches!(current_ty.kind(), ty::FnPtr(..))")
};assert!(!matches!(current_ty.kind(), ty::FnPtr(..)));
387VisitorState {
388 root_use_flags: self.root_use_flags,
389 outer_ty_kind: OuterTyKind::from_ty(current_ty),
390 depth: self.depth + 1,
391 }
392 }
393394/// From an existing state, compute the state of any subtype of the current type.
395 /// (Case where the current type is a function pointer,
396 /// meaning we need to specify if the subtype is an argument or the return.)
397fn next_in_fnptr(&self, current_ty: Ty<'_>, fn_pos: FnPos) -> Self {
398if !#[allow(non_exhaustive_omitted_patterns)] match current_ty.kind() {
ty::FnPtr(..) => true,
_ => false,
} {
::core::panicking::panic("assertion failed: matches!(current_ty.kind(), ty::FnPtr(..))")
};assert!(matches!(current_ty.kind(), ty::FnPtr(..)));
399VisitorState {
400 root_use_flags: match fn_pos {
401 FnPos::Ret => RootUseFlags::RETURN_TY_IN_FNPTR,
402 FnPos::Arg => RootUseFlags::ARGUMENT_TY_IN_FNPTR,
403 },
404 outer_ty_kind: OuterTyKind::from_ty(current_ty),
405 depth: self.depth + 1,
406 }
407 }
408409/// Get the proper visitor state for a given function's arguments or return type.
410fn fn_entry_point(fn_mode: CItemKind, fn_pos: FnPos) -> Self {
411let p_flags = match (fn_mode, fn_pos) {
412 (CItemKind::Definition, FnPos::Ret) => RootUseFlags::RETURN_TY_IN_DEFINITION,
413 (CItemKind::Declaration, FnPos::Ret) => RootUseFlags::RETURN_TY_IN_DECLARATION,
414 (CItemKind::Definition, FnPos::Arg) => RootUseFlags::ARGUMENT_TY_IN_DEFINITION,
415 (CItemKind::Declaration, FnPos::Arg) => RootUseFlags::ARGUMENT_TY_IN_DECLARATION,
416 };
417VisitorState { root_use_flags: p_flags, outer_ty_kind: OuterTyKind::None, depth: 0 }
418 }
419420/// Get the proper visitor state for a static variable's type
421fn static_entry_point() -> Self {
422VisitorState {
423 root_use_flags: RootUseFlags::STATIC_TY,
424 outer_ty_kind: OuterTyKind::None,
425 depth: 0,
426 }
427 }
428429/// Whether the type is used in a function.
430fn is_in_function(&self) -> bool {
431let ret = self.root_use_flags.contains(RootUseFlags::FUNC);
432if ret {
433if true {
if !!self.root_use_flags.contains(RootUseFlags::STATIC) {
::core::panicking::panic("assertion failed: !self.root_use_flags.contains(RootUseFlags::STATIC)")
};
};debug_assert!(!self.root_use_flags.contains(RootUseFlags::STATIC));
434 }
435ret436 }
437438/// Whether the type is used (directly or not) in a function, in return position.
439fn is_in_function_return(&self) -> bool {
440let ret = self.root_use_flags.contains(RootUseFlags::FN_RETURN);
441if ret {
442if true {
if !self.is_in_function() {
::core::panicking::panic("assertion failed: self.is_in_function()")
};
};debug_assert!(self.is_in_function());
443 }
444ret445 }
446447/// Whether the type is used (directly or not) in a defined function.
448 /// In other words, whether or not we allow non-FFI-safe types behind a C pointer,
449 /// to be treated as an opaque type on the other side of the FFI boundary.
450fn is_in_defined_function(&self) -> bool {
451self.root_use_flags.contains(RootUseFlags::DEFINED) && self.is_in_function()
452 }
453454/// Whether the type is used (directly or not) in a function pointer type.
455 /// Here, we also allow non-FFI-safe types behind a C pointer,
456 /// to be treated as an opaque type on the other side of the FFI boundary.
457fn is_in_fnptr(&self) -> bool {
458self.root_use_flags.contains(RootUseFlags::THEORETICAL) && self.is_in_function()
459 }
460461/// Whether we can expect type parameters and co in a given type.
462fn can_expect_ty_params(&self) -> bool {
463// rust-defined functions, as well as FnPtrs
464self.root_use_flags.contains(RootUseFlags::THEORETICAL) || self.is_in_defined_function()
465 }
466}
467468/// Visitor used to recursively traverse MIR types and evaluate FFI-safety.
469/// It uses ``check_*`` methods as entrypoints to be called elsewhere,
470/// and ``visit_*`` methods to recurse.
471struct ImproperCTypesVisitor<'a, 'tcx> {
472 cx: &'a LateContext<'tcx>,
473/// To prevent problems with recursive types,
474 /// add a types-in-check cache.
475cache: FxHashSet<Ty<'tcx>>,
476/// The original type being checked, before we recursed
477 /// to any other types it contains.
478base_ty: Ty<'tcx>,
479 base_fn_mode: CItemKind,
480}
481482impl<'a, 'tcx> ImproperCTypesVisitor<'a, 'tcx> {
483fn new(
484 cx: &'a LateContext<'tcx>,
485 base_ty: Unnormalized<'tcx, Ty<'tcx>>,
486 base_fn_mode: CItemKind,
487 ) -> Self {
488// Skip normalization for opaques: even in `TypingMode::Borrowck` the body's own
489 // defining opaques still get revealed, leaving entries in `OpaqueTypeStorage` that
490 // ICE on `InferCtxt` drop (issue #156352).
491let base_ty = if base_ty.skip_norm_wip().has_opaque_types() {
492base_ty.skip_norm_wip()
493 } else {
494maybe_normalize_erasing_regions(cx, base_ty)
495 };
496ImproperCTypesVisitor { cx, base_ty, base_fn_mode, cache: FxHashSet::default() }
497 }
498499/// Checks if the given indirection (box,ref,pointer) is "ffi-safe".
500fn visit_indirection(
501&mut self,
502 state: VisitorState,
503 ty: Ty<'tcx>,
504 inner_ty: Ty<'tcx>,
505 indirection_kind: IndirectionKind,
506 ) -> FfiResult<'tcx> {
507use FfiResult::*;
508let tcx = self.cx.tcx;
509510match indirection_kind {
511 IndirectionKind::Box => {
512// FIXME(ctypes): this logic is broken, but it still fits the current tests:
513 // - for some reason `Box<_>`es in `extern "ABI" {}` blocks
514 // (including within FnPtr:s)
515 // are not treated as pointers but as FFI-unsafe structs
516 // - otherwise, treat the box itself correctly, and follow pointee safety logic
517 // as described in the other `indirection_type` match branch.
518if state.is_in_defined_function()
519 || (state.is_in_fnptr() && #[allow(non_exhaustive_omitted_patterns)] match self.base_fn_mode {
CItemKind::Definition => true,
_ => false,
}matches!(self.base_fn_mode, CItemKind::Definition))
520 {
521if inner_ty.is_sized(tcx, self.cx.typing_env()) {
522return FfiSafe;
523 } else {
524return FfiUnsafe {
525ty,
526 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("box cannot be represented as a single pointer"))msg!("box cannot be represented as a single pointer"),
527 help: None,
528 };
529 }
530 } else {
531// (mid-retcon-commit-chain comment:)
532 // this is the original fallback behavior, which is wrong
533if let ty::Adt(def, args) = ty.kind() {
534self.visit_struct_or_union(state, ty, *def, args)
535 } else if truecfg!(debug_assertions) {
536::rustc_middle::util::bug::bug_fmt(format_args!("ImproperCTypes: this retcon commit was badly written"))bug!("ImproperCTypes: this retcon commit was badly written")537 } else {
538FfiSafe539 }
540 }
541 }
542 IndirectionKind::Ref | IndirectionKind::RawPtr => {
543// Weird behaviour for pointee safety. the big question here is
544 // "if you have a FFI-unsafe pointee behind a FFI-safe pointer type, is it ok?"
545 // The answer until now is:
546 // "It's OK for rust-defined functions and callbacks, we'll assume those are
547 // meant to be opaque types on the other side of the FFI boundary".
548 //
549 // Reasoning:
550 // For extern function declarations, the actual definition of the function is
551 // written somewhere else, meaning the declaration is free to express this
552 // opaqueness with an extern type (opaque caller-side) or a std::ffi::c_void
553 // (opaque callee-side). For extern function definitions, however, in the case
554 // where the type is opaque caller-side, it is not opaque callee-side,
555 // and having the full type information is necessary to compile the function.
556 //
557 // It might be better to rething this, or even ignore pointee safety for a first
558 // batch of behaviour changes. See the discussion that ends with
559 // https://github.com/rust-lang/rust/pull/134697#issuecomment-2692610258
560if (state.is_in_defined_function() || state.is_in_fnptr())
561 && inner_ty.is_sized(self.cx.tcx, self.cx.typing_env())
562 {
563FfiSafe564 } else {
565self.visit_type(state.next(ty), inner_ty)
566 }
567 }
568 }
569 }
570571/// Checks if the given `VariantDef`'s field types are "ffi-safe".
572fn visit_variant_fields(
573&mut self,
574 state: VisitorState,
575 ty: Ty<'tcx>,
576 def: AdtDef<'tcx>,
577 variant: &ty::VariantDef,
578 args: GenericArgsRef<'tcx>,
579 ) -> FfiResult<'tcx> {
580use FfiResult::*;
581582let transparent_with_all_zst_fields = if def.repr().transparent() {
583if let Some(field) = super::transparent_newtype_field(self.cx.tcx, variant) {
584// Transparent newtypes have at most one non-ZST field which needs to be checked..
585let field_ty =
586maybe_normalize_erasing_regions(self.cx, field.ty(self.cx.tcx, args));
587match self.visit_type(state.next(ty), field_ty) {
588FfiUnsafe { ty, .. } if ty.is_unit() => (),
589 r => return r,
590 }
591592false
593} else {
594// ..or have only ZST fields, which is FFI-unsafe (unless those fields are all
595 // `PhantomData`).
596true
597}
598 } else {
599false
600};
601602// We can't completely trust `repr(C)` markings, so make sure the fields are actually safe.
603let mut all_phantom = !variant.fields.is_empty();
604for field in &variant.fields {
605let field_ty = maybe_normalize_erasing_regions(self.cx, field.ty(self.cx.tcx, args));
606 all_phantom &= match self.visit_type(state.next(ty), field_ty) {
607 FfiSafe => false,
608// `()` fields are FFI-safe!
609FfiUnsafe { ty, .. } if ty.is_unit() => false,
610 FfiPhantom(..) => true,
611 r @ FfiUnsafe { .. } => return r,
612 }
613 }
614615if all_phantom {
616FfiPhantom(ty)
617 } else if transparent_with_all_zst_fields {
618FfiUnsafe {
619ty,
620 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this struct contains only zero-sized fields"))msg!("this struct contains only zero-sized fields"),
621 help: None,
622 }
623 } else {
624FfiSafe625 }
626 }
627628fn visit_struct_or_union(
629&mut self,
630 state: VisitorState,
631 ty: Ty<'tcx>,
632 def: AdtDef<'tcx>,
633 args: GenericArgsRef<'tcx>,
634 ) -> FfiResult<'tcx> {
635if true {
if !#[allow(non_exhaustive_omitted_patterns)] match def.adt_kind() {
AdtKind::Struct | AdtKind::Union => true,
_ => false,
} {
::core::panicking::panic("assertion failed: matches!(def.adt_kind(), AdtKind::Struct | AdtKind::Union)")
};
};debug_assert!(matches!(def.adt_kind(), AdtKind::Struct | AdtKind::Union));
636use FfiResult::*;
637638if !def.repr().c() && !def.repr().transparent() {
639return FfiUnsafe {
640ty,
641 reason: if def.is_struct() {
642rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this struct has unspecified layout"))msg!("this struct has unspecified layout")643 } else {
644rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this union has unspecified layout"))msg!("this union has unspecified layout")645 },
646 help: if def.is_struct() {
647Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider adding a `#[repr(C)]` or `#[repr(transparent)]` attribute to this struct"))msg!(
648"consider adding a `#[repr(C)]` or `#[repr(transparent)]` attribute to this struct"
649))
650 } else {
651// FIXME(#60405): confirm that this makes sense for unions once #60405 / RFC2645 stabilises
652Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider adding a `#[repr(C)]` or `#[repr(transparent)]` attribute to this union"))msg!(
653"consider adding a `#[repr(C)]` or `#[repr(transparent)]` attribute to this union"
654))
655 },
656 };
657 }
658659if def.non_enum_variant().field_list_has_applicable_non_exhaustive() {
660return FfiUnsafe {
661ty,
662 reason: if def.is_struct() {
663rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this struct is non-exhaustive"))msg!("this struct is non-exhaustive")664 } else {
665rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this union is non-exhaustive"))msg!("this union is non-exhaustive")666 },
667 help: None,
668 };
669 }
670671if def.non_enum_variant().fields.is_empty() {
672FfiUnsafe {
673ty,
674 reason: if def.is_struct() {
675rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this struct has no fields"))msg!("this struct has no fields")676 } else {
677rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this union has no fields"))msg!("this union has no fields")678 },
679 help: if def.is_struct() {
680Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider adding a member to this struct"))msg!("consider adding a member to this struct"))
681 } else {
682Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider adding a member to this union"))msg!("consider adding a member to this union"))
683 },
684 }
685 } else {
686self.visit_variant_fields(state, ty, def, def.non_enum_variant(), args)
687 }
688 }
689690fn visit_enum(
691&mut self,
692 state: VisitorState,
693 ty: Ty<'tcx>,
694 def: AdtDef<'tcx>,
695 args: GenericArgsRef<'tcx>,
696 ) -> FfiResult<'tcx> {
697if true {
if !#[allow(non_exhaustive_omitted_patterns)] match def.adt_kind() {
AdtKind::Enum => true,
_ => false,
} {
::core::panicking::panic("assertion failed: matches!(def.adt_kind(), AdtKind::Enum)")
};
};debug_assert!(matches!(def.adt_kind(), AdtKind::Enum));
698use FfiResult::*;
699700if def.variants().is_empty() {
701// Empty enums are okay... although sort of useless.
702return FfiSafe;
703 }
704// Check for a repr() attribute to specify the size of the
705 // discriminant.
706if !def.repr().c() && !def.repr().transparent() && def.repr().int.is_none() {
707// Special-case types like `Option<extern fn()>` and `Result<extern fn(), ()>`
708if let Some(inner_ty) = repr_nullable_ptr(self.cx.tcx, self.cx.typing_env(), ty) {
709return self.visit_type(state.next(ty), inner_ty);
710 }
711712return FfiUnsafe {
713ty,
714 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("enum has no representation hint"))msg!("enum has no representation hint"),
715 help: Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider adding a `#[repr(C)]`, `#[repr(transparent)]`, or integer `#[repr(...)]` attribute to this enum"))msg!(
716"consider adding a `#[repr(C)]`, `#[repr(transparent)]`, or integer `#[repr(...)]` attribute to this enum"
717)),
718 };
719 }
720721let non_exhaustive = def.variant_list_has_applicable_non_exhaustive();
722// Check the contained variants.
723let ret = def.variants().iter().try_for_each(|variant| {
724 check_non_exhaustive_variant(non_exhaustive, variant)
725 .map_break(|reason| FfiUnsafe { ty, reason, help: None })?;
726727match self.visit_variant_fields(state, ty, def, variant, args) {
728FfiSafe => ControlFlow::Continue(()),
729 r => ControlFlow::Break(r),
730 }
731 });
732if let ControlFlow::Break(result) = ret {
733return result;
734 }
735736FfiSafe737 }
738739/// Checks if the given type is "ffi-safe" (has a stable, well-defined
740 /// representation which can be exported to C code).
741fn visit_type(&mut self, state: VisitorState, ty: Ty<'tcx>) -> FfiResult<'tcx> {
742use FfiResult::*;
743744let tcx = self.cx.tcx;
745746// Protect against infinite recursion, for example
747 // `struct S(*mut S);`.
748if !(self.cache.insert(ty) && self.cx.tcx.recursion_limit().value_within_limit(state.depth))
749 {
750return FfiSafe;
751 }
752753match *ty.kind() {
754 ty::Adt(def, args) => {
755if let Some(inner_ty) = ty.boxed_ty() {
756return self.visit_indirection(state, ty, inner_ty, IndirectionKind::Box);
757 }
758if def.is_phantom_data() {
759return FfiPhantom(ty);
760 }
761match def.adt_kind() {
762 AdtKind::Struct | AdtKind::Union => {
763if let Some(sym::cstring_type | sym::cstr_type) =
764tcx.get_diagnostic_name(def.did())
765 && !self.base_ty.is_mutable_ptr()
766 {
767return FfiUnsafe {
768ty,
769 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("`CStr`/`CString` do not have a guaranteed layout"))msg!("`CStr`/`CString` do not have a guaranteed layout"),
770 help: Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider passing a `*const std::ffi::c_char` instead, and use `CStr::as_ptr()`"))msg!(
771"consider passing a `*const std::ffi::c_char` instead, and use `CStr::as_ptr()`"
772)),
773 };
774 }
775self.visit_struct_or_union(state, ty, def, args)
776 }
777 AdtKind::Enum => self.visit_enum(state, ty, def, args),
778 }
779 }
780781// Pattern types are just extra invariants on the type that you need to uphold,
782 // but only the base type is relevant for being representable in FFI.
783 // (note: this lint was written when pattern types could only be integers constrained to ranges)
784 // (also note: the lack of ".next(ty)" on the state is on purpose)
785ty::Pat(pat_ty, _) => self.visit_type(state, pat_ty),
786787// types which likely have a stable representation, if the target architecture defines those
788 // note: before rust 1.77, 128-bit ints were not FFI-safe on x86_64
789ty::Int(..) | ty::Uint(..) | ty::Float(..) => FfiResult::FfiSafe,
790791 ty::Bool => FfiResult::FfiSafe,
792793 ty::Char => FfiResult::FfiUnsafe {
794ty,
795 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("the `char` type has no C equivalent"))msg!("the `char` type has no C equivalent"),
796 help: Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider using `u32` or `libc::wchar_t` instead"))msg!("consider using `u32` or `libc::wchar_t` instead")),
797 },
798799 ty::Slice(_) => FfiUnsafe {
800ty,
801 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("slices have no C equivalent"))msg!("slices have no C equivalent"),
802 help: Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider using a raw pointer instead"))msg!("consider using a raw pointer instead")),
803 },
804805 ty::Dynamic(..) => {
806FfiUnsafe { ty, reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("trait objects have no C equivalent"))msg!("trait objects have no C equivalent"), help: None }
807 }
808809 ty::Str => FfiUnsafe {
810ty,
811 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("string slices have no C equivalent"))msg!("string slices have no C equivalent"),
812 help: Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider using `*const u8` and a length instead"))msg!("consider using `*const u8` and a length instead")),
813 },
814815 ty::Tuple(tuple) => {
816if tuple.is_empty()
817 && state.is_in_function_return()
818 && #[allow(non_exhaustive_omitted_patterns)] match state.outer_ty_kind {
OuterTyKind::None | OuterTyKind::NoneThroughFnPtr => true,
_ => false,
}matches!(
819 state.outer_ty_kind,
820 OuterTyKind::None | OuterTyKind::NoneThroughFnPtr
821 )822 {
823// C functions can return void
824FfiSafe825 } else {
826FfiUnsafe {
827ty,
828 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("tuples have unspecified layout"))msg!("tuples have unspecified layout"),
829 help: Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider using a struct instead"))msg!("consider using a struct instead")),
830 }
831 }
832 }
833834 ty::RawPtr(ty, _)
835if match ty.kind() {
836 ty::Tuple(tuple) => tuple.is_empty(),
837_ => false,
838 } =>
839 {
840FfiSafe841 }
842843 ty::RawPtr(inner_ty, _) => {
844return self.visit_indirection(state, ty, inner_ty, IndirectionKind::RawPtr);
845 }
846 ty::Ref(_, inner_ty, _) => {
847return self.visit_indirection(state, ty, inner_ty, IndirectionKind::Ref);
848 }
849850 ty::Array(inner_ty, _) => {
851if state.is_in_function()
852// FIXME(ctypes): VVV-this-VVV shouldn't make a difference between ::None and ::NoneThroughFnPtr
853 && #[allow(non_exhaustive_omitted_patterns)] match state.outer_ty_kind {
OuterTyKind::None => true,
_ => false,
}matches!(state.outer_ty_kind, OuterTyKind::None)854 {
855// C doesn't really support passing arrays by value - the only way to pass an array by value
856 // is through a struct.
857FfiResult::FfiUnsafe {
858ty,
859 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("passing raw arrays by value is not FFI-safe"))msg!("passing raw arrays by value is not FFI-safe"),
860 help: Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider passing a pointer to the array"))msg!("consider passing a pointer to the array")),
861 }
862 } else {
863// let's allow phantoms to go through,
864 // since an array of 1-ZSTs is also a 1-ZST
865self.visit_type(state.next(ty), inner_ty)
866 }
867 }
868869 ty::FnPtr(sig_tys, hdr) => {
870let sig = sig_tys.with(hdr);
871if sig.abi().is_rustic_abi() {
872return FfiUnsafe {
873ty,
874 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("this function pointer has Rust-specific calling convention"))msg!("this function pointer has Rust-specific calling convention"),
875 help: Some(rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("consider using an `extern fn(...) -> ...` function pointer instead"))msg!(
876"consider using an `extern fn(...) -> ...` function pointer instead"
877)),
878 };
879 }
880881let sig = tcx.instantiate_bound_regions_with_erased(sig);
882for arg in sig.inputs() {
883match self.visit_type(state.next_in_fnptr(ty, FnPos::Arg), *arg) {
884 FfiSafe => {}
885 r => return r,
886 }
887 }
888889let ret_ty = sig.output();
890self.visit_type(state.next_in_fnptr(ty, FnPos::Ret), ret_ty)
891 }
892893 ty::Foreign(..) => FfiSafe,
894895 ty::Never => FfiSafe,
896897// While opaque types are checked for earlier, if a projection in a struct field
898 // normalizes to an opaque type, then it will reach this branch.
899ty::Alias(_, ty::AliasTy { kind: ty::Opaque { .. }, .. }) => {
900FfiUnsafe { ty, reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("opaque types have no C equivalent"))msg!("opaque types have no C equivalent"), help: None }
901 }
902903// `extern "C" fn` functions can have type parameters, which may or may not be FFI-safe,
904 // so they are currently ignored for the purposes of this lint.
905ty::Param(..)
906 | ty::Alias(_, ty::AliasTy { kind: ty::Projection { .. } | ty::Inherent { .. }, .. })
907if state.can_expect_ty_params() =>
908 {
909FfiSafe910 }
911912 ty::UnsafeBinder(_) => FfiUnsafe {
913ty,
914 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("unsafe binders are incompatible with foreign function interfaces"))msg!("unsafe binders are incompatible with foreign function interfaces"),
915 help: None,
916 },
917918// Safety net for when normalization reveals a body's own defining opaque
919 // (e.g. `async extern fn`'s `impl Future` → `Coroutine`); the nicer
920 // "opaque types have no C equivalent" message comes from `visit_for_opaque_ty`
921 // in `check_type` before normalization (issue #156352).
922ty::Closure(..)
923 | ty::CoroutineClosure(..)
924 | ty::Coroutine(..)
925 | ty::CoroutineWitness(..) => FfiUnsafe {
926ty,
927 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("closures and coroutines are not FFI-safe"))msg!("closures and coroutines are not FFI-safe"),
928 help: None,
929 },
930931 ty::Param(..)
932 | ty::Alias(
933_,
934 ty::AliasTy {
935 kind: ty::Projection { .. } | ty::Inherent { .. } | ty::Free { .. },
936 ..
937 },
938 )
939 | ty::Infer(..)
940 | ty::Bound(..)
941 | ty::Error(_)
942 | ty::Placeholder(..)
943 | ty::FnDef(..) => ::rustc_middle::util::bug::bug_fmt(format_args!("unexpected type in foreign function: {0:?}",
ty))bug!("unexpected type in foreign function: {:?}", ty),
944 }
945 }
946947fn visit_for_opaque_ty(&mut self, ty: Ty<'tcx>) -> PartialFfiResult<'tcx> {
948struct ProhibitOpaqueTypes;
949impl<'tcx> ty::TypeVisitor<TyCtxt<'tcx>> for ProhibitOpaqueTypes {
950type Result = ControlFlow<Ty<'tcx>>;
951952fn visit_ty(&mut self, ty: Ty<'tcx>) -> Self::Result {
953if !ty.has_opaque_types() {
954return ControlFlow::Continue(());
955 }
956957if let ty::Alias(_, ty::AliasTy { kind: ty::Opaque { .. }, .. }) = ty.kind() {
958 ControlFlow::Break(ty)
959 } else {
960ty.super_visit_with(self)
961 }
962 }
963 }
964965ty.visit_with(&mut ProhibitOpaqueTypes).break_value().map(|ty| FfiResult::FfiUnsafe {
966ty,
967 reason: rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("opaque types have no C equivalent"))msg!("opaque types have no C equivalent"),
968 help: None,
969 })
970 }
971972fn check_type(
973&mut self,
974 state: VisitorState,
975 ty: Unnormalized<'tcx, Ty<'tcx>>,
976 ) -> FfiResult<'tcx> {
977// Catch opaques before normalization so the new solver doesn't reveal them
978 // (e.g. `async extern fn` return → `Coroutine`) and we get the nicer
979 // "opaque types have no C equivalent" message.
980if let Some(res) = self.visit_for_opaque_ty(ty.skip_norm_wip()) {
981return res;
982 }
983let ty = maybe_normalize_erasing_regions(self.cx, ty);
984if let Some(res) = self.visit_for_opaque_ty(ty) {
985return res;
986 }
987988self.visit_type(state, ty)
989 }
990}
991992impl<'tcx> ImproperCTypesLint {
993/// Find any fn-ptr types with external ABIs in `ty`, and FFI-checks them.
994 /// For example, `Option<extern "C" fn()>` FFI-checks `extern "C" fn()`.
995fn check_type_for_external_abi_fnptr(
996&mut self,
997 cx: &LateContext<'tcx>,
998 state: VisitorState,
999 hir_ty: &hir::Ty<'tcx>,
1000 ty: Ty<'tcx>,
1001 fn_mode: CItemKind,
1002 ) {
1003struct FnPtrFinder<'tcx> {
1004 current_depth: usize,
1005 depths: Vec<usize>,
1006 spans: Vec<Span>,
1007 tys: Vec<Ty<'tcx>>,
1008 }
10091010impl<'tcx> hir::intravisit::Visitor<'_> for FnPtrFinder<'tcx> {
1011fn visit_ty(&mut self, ty: &'_ hir::Ty<'_, AmbigArg>) {
1012{
use ::tracing::__macro_support::Callsite as _;
static __CALLSITE: ::tracing::callsite::DefaultCallsite =
{
static META: ::tracing::Metadata<'static> =
{
::tracing_core::metadata::Metadata::new("event compiler/rustc_lint/src/types/improper_ctypes.rs:1012",
"rustc_lint::types::improper_ctypes",
::tracing::Level::DEBUG,
::tracing_core::__macro_support::Option::Some("compiler/rustc_lint/src/types/improper_ctypes.rs"),
::tracing_core::__macro_support::Option::Some(1012u32),
::tracing_core::__macro_support::Option::Some("rustc_lint::types::improper_ctypes"),
::tracing_core::field::FieldSet::new(&["ty"],
::tracing_core::callsite::Identifier(&__CALLSITE)),
::tracing::metadata::Kind::EVENT)
};
::tracing::callsite::DefaultCallsite::new(&META)
};
let enabled =
::tracing::Level::DEBUG <= ::tracing::level_filters::STATIC_MAX_LEVEL
&&
::tracing::Level::DEBUG <=
::tracing::level_filters::LevelFilter::current() &&
{
let interest = __CALLSITE.interest();
!interest.is_never() &&
::tracing::__macro_support::__is_enabled(__CALLSITE.metadata(),
interest)
};
if enabled {
(|value_set: ::tracing::field::ValueSet|
{
let meta = __CALLSITE.metadata();
::tracing::Event::dispatch(meta, &value_set);
;
})({
#[allow(unused_imports)]
use ::tracing::field::{debug, display, Value};
let mut iter = __CALLSITE.metadata().fields().iter();
__CALLSITE.metadata().fields().value_set(&[(&::tracing::__macro_support::Iterator::next(&mut iter).expect("FieldSet corrupted (this is a bug)"),
::tracing::__macro_support::Option::Some(&debug(&ty) as
&dyn Value))])
});
} else { ; }
};debug!(?ty);
1013self.current_depth += 1;
1014if let hir::TyKind::FnPtr(hir::FnPtrTy { abi, .. }) = ty.kind
1015 && !abi.is_rustic_abi()
1016 {
1017self.depths.push(self.current_depth);
1018self.spans.push(ty.span);
1019 }
10201021 hir::intravisit::walk_ty(self, ty);
1022self.current_depth -= 1;
1023 }
1024 }
10251026impl<'tcx> ty::TypeVisitor<TyCtxt<'tcx>> for FnPtrFinder<'tcx> {
1027type Result = ();
10281029fn visit_ty(&mut self, ty: Ty<'tcx>) -> Self::Result {
1030if let ty::FnPtr(_, hdr) = ty.kind()
1031 && !hdr.abi().is_rustic_abi()
1032 {
1033self.tys.push(ty);
1034 }
10351036ty.super_visit_with(self)
1037 }
1038 }
10391040let mut visitor = FnPtrFinder {
1041 spans: Vec::new(),
1042 tys: Vec::new(),
1043 depths: Vec::new(),
1044 current_depth: 0,
1045 };
1046ty.visit_with(&mut visitor);
1047visitor.visit_ty_unambig(hir_ty);
10481049let all_types = iter::zip(
1050visitor.depths.drain(..),
1051 iter::zip(visitor.tys.drain(..), visitor.spans.drain(..)),
1052 );
1053for (depth, (fn_ptr_ty, span)) in all_types {
1054let fn_ptr_ty = Unnormalized::new_wip(fn_ptr_ty);
1055let mut visitor = ImproperCTypesVisitor::new(cx, fn_ptr_ty, fn_mode);
1056let bridge_state = VisitorState { depth, ..state };
1057// FIXME(ctypes): make a check_for_fnptr
1058let ffi_res = visitor.check_type(bridge_state, fn_ptr_ty);
10591060self.process_ffi_result(cx, span, ffi_res, fn_mode);
1061 }
1062 }
10631064/// Regardless of a function's need to be "ffi-safe", look for fn-ptr argument/return types
1065 /// that need to be checked for ffi-safety.
1066fn check_fn_for_external_abi_fnptr(
1067&mut self,
1068 cx: &LateContext<'tcx>,
1069 fn_mode: CItemKind,
1070 def_id: LocalDefId,
1071 decl: &'tcx hir::FnDecl<'_>,
1072 ) {
1073let sig = cx.tcx.fn_sig(def_id).instantiate_identity().skip_norm_wip();
1074let sig = cx.tcx.instantiate_bound_regions_with_erased(sig);
10751076for (input_ty, input_hir) in iter::zip(sig.inputs(), decl.inputs) {
1077let state = VisitorState::fn_entry_point(fn_mode, FnPos::Arg);
1078self.check_type_for_external_abi_fnptr(cx, state, input_hir, *input_ty, fn_mode);
1079 }
10801081if let hir::FnRetTy::Return(ret_hir) = decl.output {
1082let state = VisitorState::fn_entry_point(fn_mode, FnPos::Ret);
1083self.check_type_for_external_abi_fnptr(cx, state, ret_hir, sig.output(), fn_mode);
1084 }
1085 }
10861087/// For a local definition of a #[repr(C)] struct/enum/union, check that it is indeed FFI-safe.
1088fn check_reprc_adt(
1089&mut self,
1090 cx: &LateContext<'tcx>,
1091 item: &'tcx hir::Item<'tcx>,
1092 adt_def: AdtDef<'tcx>,
1093 ) {
1094if true {
if !(adt_def.repr().c() && !adt_def.repr().packed() &&
adt_def.repr().align.is_none()) {
::core::panicking::panic("assertion failed: adt_def.repr().c() && !adt_def.repr().packed() &&\n adt_def.repr().align.is_none()")
};
};debug_assert!(
1095 adt_def.repr().c() && !adt_def.repr().packed() && adt_def.repr().align.is_none()
1096 );
10971098// FIXME(ctypes): this following call is awkward.
1099 // is there a way to perform its logic in MIR space rather than HIR space?
1100 // (so that its logic can be absorbed into visitor.visit_struct_or_union)
1101check_struct_for_power_alignment(cx, item, adt_def);
1102 }
11031104fn check_foreign_static(&mut self, cx: &LateContext<'tcx>, id: hir::OwnerId, span: Span) {
1105let ty = cx.tcx.type_of(id).instantiate_identity();
1106let mut visitor = ImproperCTypesVisitor::new(cx, ty, CItemKind::Declaration);
1107let ffi_res = visitor.check_type(VisitorState::static_entry_point(), ty);
1108self.process_ffi_result(cx, span, ffi_res, CItemKind::Declaration);
1109 }
11101111/// Check if a function's argument types and result type are "ffi-safe".
1112fn check_foreign_fn(
1113&mut self,
1114 cx: &LateContext<'tcx>,
1115 fn_mode: CItemKind,
1116 def_id: LocalDefId,
1117 decl: &'tcx hir::FnDecl<'_>,
1118 ) {
1119let sig = cx.tcx.fn_sig(def_id).instantiate_identity().skip_norm_wip();
1120let sig = cx.tcx.instantiate_bound_regions_with_erased(sig);
11211122for (input_ty, input_hir) in iter::zip(sig.inputs(), decl.inputs) {
1123let input_ty = Unnormalized::new_wip(*input_ty);
1124let state = VisitorState::fn_entry_point(fn_mode, FnPos::Arg);
1125let mut visitor = ImproperCTypesVisitor::new(cx, input_ty, fn_mode);
1126let ffi_res = visitor.check_type(state, input_ty);
1127self.process_ffi_result(cx, input_hir.span, ffi_res, fn_mode);
1128 }
11291130if let hir::FnRetTy::Return(ret_hir) = decl.output {
1131let output_ty = Unnormalized::new_wip(sig.output());
1132let state = VisitorState::fn_entry_point(fn_mode, FnPos::Ret);
1133let mut visitor = ImproperCTypesVisitor::new(cx, output_ty, fn_mode);
1134let ffi_res = visitor.check_type(state, output_ty);
1135self.process_ffi_result(cx, ret_hir.span, ffi_res, fn_mode);
1136 }
1137 }
11381139fn process_ffi_result(
1140&self,
1141 cx: &LateContext<'tcx>,
1142 sp: Span,
1143 res: FfiResult<'tcx>,
1144 fn_mode: CItemKind,
1145 ) {
1146match res {
1147 FfiResult::FfiSafe => {}
1148 FfiResult::FfiPhantom(ty) => {
1149self.emit_ffi_unsafe_type_lint(
1150cx,
1151ty,
1152sp,
1153rustc_errors::DiagMessage::Inline(std::borrow::Cow::Borrowed("composed only of `PhantomData`"))msg!("composed only of `PhantomData`"),
1154None,
1155fn_mode,
1156 );
1157 }
1158 FfiResult::FfiUnsafe { ty, reason, help } => {
1159self.emit_ffi_unsafe_type_lint(cx, ty, sp, reason, help, fn_mode);
1160 }
1161 }
1162 }
11631164fn emit_ffi_unsafe_type_lint(
1165&self,
1166 cx: &LateContext<'tcx>,
1167 ty: Ty<'tcx>,
1168 sp: Span,
1169 note: DiagMessage,
1170 help: Option<DiagMessage>,
1171 fn_mode: CItemKind,
1172 ) {
1173let lint = match fn_mode {
1174 CItemKind::Declaration => IMPROPER_CTYPES,
1175 CItemKind::Definition => IMPROPER_CTYPES_DEFINITIONS,
1176 };
1177let desc = match fn_mode {
1178 CItemKind::Declaration => "block",
1179 CItemKind::Definition => "fn",
1180 };
1181let span_note = if let ty::Adt(def, _) = ty.kind()
1182 && let Some(sp) = cx.tcx.hir_span_if_local(def.did())
1183 {
1184Some(sp)
1185 } else {
1186None1187 };
1188cx.emit_span_lint(lint, sp, ImproperCTypes { ty, desc, label: sp, help, note, span_note });
1189 }
1190}
11911192/// `ImproperCTypesDefinitions` checks items outside of foreign items (e.g. stuff that isn't in
1193/// `extern "C" { }` blocks):
1194///
1195/// - `extern "<abi>" fn` definitions are checked in the same way as the
1196/// `ImproperCtypesDeclarations` visitor checks functions if `<abi>` is external (e.g. "C").
1197/// - All other items which contain types (e.g. other functions, struct definitions, etc) are
1198/// checked for extern fn-ptrs with external ABIs.
1199impl<'tcx> LateLintPass<'tcx> for ImproperCTypesLint {
1200fn check_foreign_item(&mut self, cx: &LateContext<'tcx>, it: &hir::ForeignItem<'tcx>) {
1201let abi = cx.tcx.hir_get_foreign_abi(it.hir_id());
12021203match it.kind {
1204 hir::ForeignItemKind::Fn(sig, _, _) => {
1205// fnptrs are a special case, they always need to be treated as
1206 // "the element rendered unsafe" because their unsafety doesn't affect
1207 // their surroundings, and their type is often declared inline
1208if !abi.is_rustic_abi() {
1209self.check_foreign_fn(cx, CItemKind::Declaration, it.owner_id.def_id, sig.decl);
1210 } else {
1211self.check_fn_for_external_abi_fnptr(
1212cx,
1213 CItemKind::Declaration,
1214it.owner_id.def_id,
1215sig.decl,
1216 );
1217 }
1218 }
1219 hir::ForeignItemKind::Static(ty, _, _) if !abi.is_rustic_abi() => {
1220self.check_foreign_static(cx, it.owner_id, ty.span);
1221 }
1222 hir::ForeignItemKind::Static(..) | hir::ForeignItemKind::Type => (),
1223 }
1224 }
12251226fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::Item<'tcx>) {
1227match item.kind {
1228 hir::ItemKind::Static(_, _, ty, _)
1229 | hir::ItemKind::Const(_, _, ty, _)
1230 | hir::ItemKind::TyAlias(_, _, ty) => {
1231self.check_type_for_external_abi_fnptr(
1232cx,
1233VisitorState::static_entry_point(),
1234ty,
1235cx.tcx.type_of(item.owner_id).instantiate_identity().skip_norm_wip(),
1236 CItemKind::Definition,
1237 );
1238 }
1239// See `check_fn` for declarations, `check_foreign_items` for definitions in extern blocks
1240hir::ItemKind::Fn { .. } => {}
1241 hir::ItemKind::Struct(..) | hir::ItemKind::Union(..) | hir::ItemKind::Enum(..) => {
1242// looking for extern FnPtr:s is delegated to `check_field_def`.
1243let adt_def: AdtDef<'tcx> = cx.tcx.adt_def(item.owner_id.to_def_id());
12441245if adt_def.repr().c() && !adt_def.repr().packed() && adt_def.repr().align.is_none()
1246 {
1247self.check_reprc_adt(cx, item, adt_def);
1248 }
1249 }
12501251// Doesn't define something that can contain a external type to be checked.
1252hir::ItemKind::Impl(..)
1253 | hir::ItemKind::TraitAlias(..)
1254 | hir::ItemKind::Trait { .. }
1255 | hir::ItemKind::GlobalAsm { .. }
1256 | hir::ItemKind::ForeignMod { .. }
1257 | hir::ItemKind::Mod(..)
1258 | hir::ItemKind::Macro(..)
1259 | hir::ItemKind::Use(..)
1260 | hir::ItemKind::ExternCrate(..) => {}
1261 }
1262 }
12631264fn check_field_def(&mut self, cx: &LateContext<'tcx>, field: &'tcx hir::FieldDef<'tcx>) {
1265self.check_type_for_external_abi_fnptr(
1266cx,
1267VisitorState::static_entry_point(),
1268field.ty,
1269cx.tcx.type_of(field.def_id).instantiate_identity().skip_norm_wip(),
1270 CItemKind::Definition,
1271 );
1272 }
12731274fn check_fn(
1275&mut self,
1276 cx: &LateContext<'tcx>,
1277 kind: hir::intravisit::FnKind<'tcx>,
1278 decl: &'tcx hir::FnDecl<'_>,
1279_: &'tcx hir::Body<'_>,
1280_: Span,
1281 id: LocalDefId,
1282 ) {
1283use hir::intravisit::FnKind;
12841285let abi = match kind {
1286 FnKind::ItemFn(_, _, header, ..) => header.abi,
1287 FnKind::Method(_, sig, ..) => sig.header.abi,
1288_ => return,
1289 };
12901291// fnptrs are a special case, they always need to be treated as
1292 // "the element rendered unsafe" because their unsafety doesn't affect
1293 // their surroundings, and their type is often declared inline
1294if !abi.is_rustic_abi() {
1295self.check_foreign_fn(cx, CItemKind::Definition, id, decl);
1296 } else {
1297self.check_fn_for_external_abi_fnptr(cx, CItemKind::Definition, id, decl);
1298 }
1299 }
1300}