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

clippy_utils/
msrvs.rs
