clippy_utils/
msrvs.rs

1use crate::sym;
2use rustc_ast::Attribute;
3use rustc_ast::attr::AttributeExt;
4use rustc_attr_parsing::parse_version;
5use rustc_data_structures::smallvec::SmallVec;
6use rustc_hir::RustcVersion;
7use rustc_lint::LateContext;
8use rustc_session::Session;
9use rustc_span::Symbol;
10use serde::Deserialize;
11use std::iter::once;
12use std::sync::atomic::{AtomicBool, Ordering};
13
14macro_rules! msrv_aliases {
15    ($($major:literal,$minor:literal,$patch:literal {
16        $($name:ident),* $(,)?
17    })*) => {
18        $($(
19        pub const $name: RustcVersion = RustcVersion { major: $major, minor :$minor, patch: $patch };
20        )*)*
21    };
22}
23
24// names may refer to stabilized feature flags or library items
25msrv_aliases! {
26    1,91,0 { DURATION_FROM_MINUTES_HOURS }
27    1,88,0 { LET_CHAINS }
28    1,87,0 { OS_STR_DISPLAY, INT_MIDPOINT, CONST_CHAR_IS_DIGIT, UNSIGNED_IS_MULTIPLE_OF, INTEGER_SIGN_CAST }
29    1,85,0 { UINT_FLOAT_MIDPOINT, CONST_SIZE_OF_VAL }
30    1,84,0 { CONST_OPTION_AS_SLICE, MANUAL_DANGLING_PTR }
31    1,83,0 { CONST_EXTERN_FN, CONST_FLOAT_BITS_CONV, CONST_FLOAT_CLASSIFY, CONST_MUT_REFS, CONST_UNWRAP }
32    1,82,0 { IS_NONE_OR, REPEAT_N, RAW_REF_OP, SPECIALIZED_TO_STRING_FOR_REFS }
33    1,81,0 { LINT_REASONS_STABILIZATION, ERROR_IN_CORE, EXPLICIT_SELF_TYPE_ELISION, DURATION_ABS_DIFF }
34    1,80,0 { BOX_INTO_ITER, LAZY_CELL }
35    1,79,0 { CONST_BLOCKS, CSTR_COUNT_BYTES }
36    1,77,0 { C_STR_LITERALS }
37    1,76,0 { PTR_FROM_REF, OPTION_RESULT_INSPECT }
38    1,75,0 { OPTION_AS_SLICE }
39    1,74,0 { REPR_RUST, IO_ERROR_OTHER }
40    1,73,0 { DIV_CEIL }
41    1,71,0 { TUPLE_ARRAY_CONVERSIONS, BUILD_HASHER_HASH_ONE }
42    1,70,0 { OPTION_RESULT_IS_VARIANT_AND, BINARY_HEAP_RETAIN }
43    1,68,0 { PATH_MAIN_SEPARATOR_STR }
44    1,67,0 { ILOG2 }
45    1,65,0 { LET_ELSE, POINTER_CAST_CONSTNESS }
46    1,63,0 { CLONE_INTO, CONST_SLICE_FROM_REF }
47    1,62,0 { BOOL_THEN_SOME, DEFAULT_ENUM_ATTRIBUTE, CONST_EXTERN_C_FN }
48    1,61,0 { CONST_FN_TRAIT_BOUND }
49    1,60,0 { ABS_DIFF }
50    1,59,0 { THREAD_LOCAL_CONST_INIT }
51    1,58,0 { FORMAT_ARGS_CAPTURE, PATTERN_TRAIT_CHAR_ARRAY, CONST_RAW_PTR_DEREF }
52    1,57,0 { MAP_WHILE, CONST_PANIC }
53    1,56,0 { CONST_FN_UNION }
54    1,55,0 { SEEK_REWIND }
55    1,54,0 { INTO_KEYS }
56    1,53,0 { OR_PATTERNS, INTEGER_BITS, BTREE_MAP_RETAIN, BTREE_SET_RETAIN, ARRAY_INTO_ITERATOR }
57    1,52,0 { STR_SPLIT_ONCE, REM_EUCLID_CONST }
58    1,51,0 { BORROW_AS_PTR, SEEK_FROM_CURRENT, UNSIGNED_ABS }
59    1,50,0 { BOOL_THEN, CLAMP, SLICE_FILL }
60    1,47,0 { TAU, IS_ASCII_DIGIT_CONST, ARRAY_IMPL_ANY_LEN, SATURATING_SUB_CONST }
61    1,46,0 { CONST_IF_MATCH }
62    1,45,0 { STR_STRIP_PREFIX }
63    1,43,0 { LOG2_10, LOG10_2, NUMERIC_ASSOCIATED_CONSTANTS }
64    1,42,0 { MATCHES_MACRO, SLICE_PATTERNS, PTR_SLICE_RAW_PARTS }
65    1,41,0 { RE_REBALANCING_COHERENCE, RESULT_MAP_OR, RESULT_MAP_OR_ELSE }
66    1,40,0 { MEM_TAKE, NON_EXHAUSTIVE, OPTION_AS_DEREF }
67    1,38,0 { POINTER_CAST, REM_EUCLID }
68    1,37,0 { TYPE_ALIAS_ENUM_VARIANTS }
69    1,36,0 { ITERATOR_COPIED }
70    1,35,0 { OPTION_COPIED, RANGE_CONTAINS }
71    1,34,0 { TRY_FROM }
72    1,33,0 { UNDERSCORE_IMPORTS }
73    1,32,0 { CONST_IS_POWER_OF_TWO, CONST_DURATION_FROM_NANOS_MICROS_MILLIS_SECS }
74    1,31,0 { OPTION_REPLACE }
75    1,30,0 { ITERATOR_FIND_MAP, TOOL_ATTRIBUTES }
76    1,29,0 { ITER_FLATTEN }
77    1,28,0 { FROM_BOOL, REPEAT_WITH, SLICE_FROM_REF }
78    1,27,0 { ITERATOR_TRY_FOLD, DOUBLE_ENDED_ITERATOR_RFIND, DURATION_FROM_NANOS_MICROS }
79    1,26,0 { RANGE_INCLUSIVE, STRING_RETAIN, POINTER_ADD_SUB_METHODS }
80    1,24,0 { IS_ASCII_DIGIT, PTR_NULL }
81    1,18,0 { HASH_MAP_RETAIN, HASH_SET_RETAIN }
82    1,17,0 { FIELD_INIT_SHORTHAND, STATIC_IN_CONST, EXPECT_ERR }
83    1,16,0 { STR_REPEAT, RESULT_UNWRAP_OR_DEFAULT }
84    1,15,0 { MAYBE_BOUND_IN_WHERE }
85    1,13,0 { QUESTION_MARK_OPERATOR }
86    1,3,0 { DURATION_FROM_MILLIS_SECS }
87}
88
89/// `#[clippy::msrv]` attributes are rarely used outside of Clippy's test suite, as a basic
90/// optimization we can skip traversing the HIR in [`Msrv::meets`] if we never saw an MSRV attribute
91/// during the early lint passes
92static SEEN_MSRV_ATTR: AtomicBool = AtomicBool::new(false);
93
94/// Tracks the current MSRV from `clippy.toml`, `Cargo.toml` or set via `#[clippy::msrv]` in late
95/// lint passes, use [`MsrvStack`] for early passes
96#[derive(Copy, Clone, Debug, Default)]
97pub struct Msrv(Option<RustcVersion>);
98
99impl<'de> Deserialize<'de> for Msrv {
100    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
101    where
102        D: serde::Deserializer<'de>,
103    {
104        let v = String::deserialize(deserializer)?;
105        parse_version(Symbol::intern(&v))
106            .map(|v| Self(Some(v)))
107            .ok_or_else(|| serde::de::Error::custom("not a valid Rust version"))
108    }
109}
110
111impl Msrv {
112    /// Returns the MSRV at the current node
113    ///
114    /// If the crate being linted uses an `#[clippy::msrv]` attribute this will search the parent
115    /// nodes for that attribute, prefer to run this check after cheaper pattern matching operations
116    pub fn current(self, cx: &LateContext<'_>) -> Option<RustcVersion> {
117        if SEEN_MSRV_ATTR.load(Ordering::Relaxed) {
118            let start = cx.last_node_with_lint_attrs;
119            if let Some(msrv_attr) = once(start)
120                .chain(cx.tcx.hir_parent_id_iter(start))
121                .find_map(|id| parse_attrs(cx.tcx.sess, cx.tcx.hir_attrs(id)))
122            {
123                return Some(msrv_attr);
124            }
125        }
126
127        self.0
128    }
129
130    /// Checks if a required version from [this module](self) is met at the current node
131    ///
132    /// If the crate being linted uses an `#[clippy::msrv]` attribute this will search the parent
133    /// nodes for that attribute, prefer to run this check after cheaper pattern matching operations
134    pub fn meets(self, cx: &LateContext<'_>, required: RustcVersion) -> bool {
135        self.current(cx).is_none_or(|msrv| msrv >= required)
136    }
137
138    pub fn read_cargo(&mut self, sess: &Session) {
139        let cargo_msrv = std::env::var("CARGO_PKG_RUST_VERSION")
140            .ok()
141            .and_then(|v| parse_version(Symbol::intern(&v)));
142
143        match (self.0, cargo_msrv) {
144            (None, Some(cargo_msrv)) => self.0 = Some(cargo_msrv),
145            (Some(clippy_msrv), Some(cargo_msrv)) => {
146                if clippy_msrv != cargo_msrv {
147                    sess.dcx().warn(format!(
148                        "the MSRV in `clippy.toml` and `Cargo.toml` differ; using `{clippy_msrv}` from `clippy.toml`"
149                    ));
150                }
151            },
152            _ => {},
153        }
154    }
155}
156
157/// Tracks the current MSRV from `clippy.toml`, `Cargo.toml` or set via `#[clippy::msrv]` in early
158/// lint passes, use [`Msrv`] for late passes
159#[derive(Debug, Clone)]
160pub struct MsrvStack {
161    stack: SmallVec<[RustcVersion; 2]>,
162}
163
164impl MsrvStack {
165    pub fn new(initial: Msrv) -> Self {
166        Self {
167            stack: SmallVec::from_iter(initial.0),
168        }
169    }
170
171    pub fn current(&self) -> Option<RustcVersion> {
172        self.stack.last().copied()
173    }
174
175    pub fn meets(&self, required: RustcVersion) -> bool {
176        self.current().is_none_or(|msrv| msrv >= required)
177    }
178
179    pub fn check_attributes(&mut self, sess: &Session, attrs: &[Attribute]) {
180        if let Some(version) = parse_attrs(sess, attrs) {
181            SEEN_MSRV_ATTR.store(true, Ordering::Relaxed);
182            self.stack.push(version);
183        }
184    }
185
186    pub fn check_attributes_post(&mut self, sess: &Session, attrs: &[Attribute]) {
187        if parse_attrs(sess, attrs).is_some() {
188            self.stack.pop();
189        }
190    }
191}
192
193fn parse_attrs(sess: &Session, attrs: &[impl AttributeExt]) -> Option<RustcVersion> {
194    let mut msrv_attrs = attrs.iter().filter(|attr| attr.path_matches(&[sym::clippy, sym::msrv]));
195
196    let msrv_attr = msrv_attrs.next()?;
197
198    if let Some(duplicate) = msrv_attrs.next_back() {
199        sess.dcx()
200            .struct_span_err(duplicate.span(), "`clippy::msrv` is defined multiple times")
201            .with_span_note(msrv_attr.span(), "first definition found here")
202            .emit();
203    }
204
205    let Some(msrv) = msrv_attr.value_str() else {
206        sess.dcx().span_err(msrv_attr.span(), "bad clippy attribute");
207        return None;
208    };
209
210    let Some(version) = parse_version(msrv) else {
211        sess.dcx()
212            .span_err(msrv_attr.span(), format!("`{msrv}` is not a valid Rust version"));
213        return None;
214    };
215
216    Some(version)
217}
clippy_utils/msrvs.rs

clippy_utils/
msrvs.rs
