src/tools/tidy/src/features.rs

   1 //! Tidy check to ensure that unstable features are all in order.
   2 //!
   3 //! This check will ensure properties like:
   4 //!
   5 //! * All stability attributes look reasonably well formed.
   6 //! * The set of library features is disjoint from the set of language features.
   7 //! * Library features have at most one stability level.
   8 //! * Library features have at most one `since` value.
   9 //! * All unstable lang features have tests to ensure they are actually unstable.
  10 //! * Language features in a group are sorted by feature name.
  11
  12 use std::collections::HashMap;
  13 use std::fmt;
  14 use std::fs;
  15 use std::num::NonZeroU32;
  16 use std::path::Path;
  17
  18 use regex::Regex;
  19
  20 #[cfg(test)]
  21 mod tests;
  22
  23 mod version;
  24 use version::Version;
  25
  26 const FEATURE_GROUP_START_PREFIX: &str = "// feature-group-start";
  27 const FEATURE_GROUP_END_PREFIX: &str = "// feature-group-end";
  28
  29 #[derive(Debug, PartialEq, Clone)]
  30 pub enum Status {
  31     Stable,
  32     Removed,
  33     Unstable,
  34 }
  35
  36 impl fmt::Display for Status {
  37     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  38         let as_str = match *self {
  39             Status::Stable => "stable",
  40             Status::Unstable => "unstable",
  41             Status::Removed => "removed",
  42         };
  43         fmt::Display::fmt(as_str, f)
  44     }
  45 }
  46
  47 #[derive(Debug, Clone)]
  48 pub struct Feature {
  49     pub level: Status,
  50     pub since: Option<Version>,
  51     pub has_gate_test: bool,
  52     pub tracking_issue: Option<NonZeroU32>,
  53 }
  54 impl Feature {
  55     fn tracking_issue_display(&self) -> impl fmt::Display {
  56         match self.tracking_issue {
  57             None => "none".to_string(),
  58             Some(x) => x.to_string(),
  59         }
  60     }
  61 }
  62
  63 pub type Features = HashMap<String, Feature>;
  64
  65 pub struct CollectedFeatures {
  66     pub lib: Features,
  67     pub lang: Features,
  68 }
  69
  70 // Currently only used for unstable book generation
  71 pub fn collect_lib_features(base_src_path: &Path) -> Features {
  72     let mut lib_features = Features::new();
  73
  74     map_lib_features(base_src_path, &mut |res, _, _| {
  75         if let Ok((name, feature)) = res {
  76             lib_features.insert(name.to_owned(), feature);
  77         }
  78     });
  79     lib_features
  80 }
  81
  82 pub fn check(
  83     src_path: &Path,
  84     compiler_path: &Path,
  85     lib_path: &Path,
  86     bad: &mut bool,
  87     verbose: bool,
  88 ) -> CollectedFeatures {
  89     let mut features = collect_lang_features(compiler_path, bad);
  90     assert!(!features.is_empty());
  91
  92     let lib_features = get_and_check_lib_features(lib_path, bad, &features);
  93     assert!(!lib_features.is_empty());
  94
  95     super::walk_many(
  96         &[
  97             &src_path.join("test/ui"),
  98             &src_path.join("test/ui-fulldeps"),
  99             &src_path.join("test/rustdoc-ui"),
 100             &src_path.join("test/rustdoc"),
 101         ],
 102         &mut |path| super::filter_dirs(path),
 103         &mut |entry, contents| {
 104             let file = entry.path();
 105             let filename = file.file_name().unwrap().to_string_lossy();
 106             if !filename.ends_with(".rs")
 107                 || filename == "features.rs"
 108                 || filename == "diagnostic_list.rs"
 109             {
 110                 return;
 111             }
 112
 113             let filen_underscore = filename.replace('-', "_").replace(".rs", "");
 114             let filename_is_gate_test = test_filen_gate(&filen_underscore, &mut features);
 115
 116             for (i, line) in contents.lines().enumerate() {
 117                 let mut err = |msg: &str| {
 118                     tidy_error!(bad, "{}:{}: {}", file.display(), i + 1, msg);
 119                 };
 120
 121                 let gate_test_str = "gate-test-";
 122
 123                 let feature_name = match line.find(gate_test_str) {
 124                     // NB: the `splitn` always succeeds, even if the delimiter is not present.
 125                     Some(i) => line[i + gate_test_str.len()..].splitn(2, ' ').next().unwrap(),
 126                     None => continue,
 127                 };
 128                 match features.get_mut(feature_name) {
 129                     Some(f) => {
 130                         if filename_is_gate_test {
 131                             err(&format!(
 132                                 "The file is already marked as gate test \
 133                                       through its name, no need for a \
 134                                       'gate-test-{}' comment",
 135                                 feature_name
 136                             ));
 137                         }
 138                         f.has_gate_test = true;
 139                     }
 140                     None => {
 141                         err(&format!(
 142                             "gate-test test found referencing a nonexistent feature '{}'",
 143                             feature_name
 144                         ));
 145                     }
 146                 }
 147             }
 148         },
 149     );
 150
 151     // Only check the number of lang features.
 152     // Obligatory testing for library features is dumb.
 153     let gate_untested = features
 154         .iter()
 155         .filter(|&(_, f)| f.level == Status::Unstable)
 156         .filter(|&(_, f)| !f.has_gate_test)
 157         .collect::<Vec<_>>();
 158
 159     for &(name, _) in gate_untested.iter() {
 160         println!("Expected a gate test for the feature '{name}'.");
 161         println!(
 162             "Hint: create a failing test file named 'feature-gate-{}.rs'\
 163                 \n      in the 'ui' test suite, with its failures due to\
 164                 \n      missing usage of `#![feature({})]`.",
 165             name, name
 166         );
 167         println!(
 168             "Hint: If you already have such a test and don't want to rename it,\
 169                 \n      you can also add a // gate-test-{} line to the test file.",
 170             name
 171         );
 172     }
 173
 174     if !gate_untested.is_empty() {
 175         tidy_error!(bad, "Found {} features without a gate test.", gate_untested.len());
 176     }
 177
 178     let (version, channel) = get_version_and_channel(src_path);
 179
 180     let all_features_iter = features
 181         .iter()
 182         .map(|feat| (feat, "lang"))
 183         .chain(lib_features.iter().map(|feat| (feat, "lib")));
 184     for ((feature_name, feature), kind) in all_features_iter {
 185         let since = if let Some(since) = feature.since { since } else { continue };
 186         if since > version && since != Version::CurrentPlaceholder {
 187             tidy_error!(
 188                 bad,
 189                 "The stabilization version {since} of {kind} feature `{feature_name}` is newer than the current {version}"
 190             );
 191         }
 192         if channel == "nightly" && since == version {
 193             tidy_error!(
 194                 bad,
 195                 "The stabilization version {since} of {kind} feature `{feature_name}` is written out but should be {}",
 196                 version::VERSION_PLACEHOLDER
 197             );
 198         }
 199         if channel != "nightly" && since == Version::CurrentPlaceholder {
 200             tidy_error!(
 201                 bad,
 202                 "The placeholder use of {kind} feature `{feature_name}` is not allowed on the {} channel",
 203                 version::VERSION_PLACEHOLDER
 204             );
 205         }
 206     }
 207
 208     if *bad {
 209         return CollectedFeatures { lib: lib_features, lang: features };
 210     }
 211
 212     if verbose {
 213         let mut lines = Vec::new();
 214         lines.extend(format_features(&features, "lang"));
 215         lines.extend(format_features(&lib_features, "lib"));
 216
 217         lines.sort();
 218         for line in lines {
 219             println!("* {line}");
 220         }
 221     } else {
 222         println!("* {} features", features.len());
 223     }
 224
 225     CollectedFeatures { lib: lib_features, lang: features }
 226 }
 227
 228 fn get_version_and_channel(src_path: &Path) -> (Version, String) {
 229     let version_str = t!(std::fs::read_to_string(src_path.join("version")));
 230     let version_str = version_str.trim();
 231     let version = t!(std::str::FromStr::from_str(&version_str).map_err(|e| format!("{e:?}")));
 232     let channel_str = t!(std::fs::read_to_string(src_path.join("ci").join("channel")));
 233     (version, channel_str.trim().to_owned())
 234 }
 235
 236 fn format_features<'a>(
 237     features: &'a Features,
 238     family: &'a str,
 239 ) -> impl Iterator<Item = String> + 'a {
 240     features.iter().map(move |(name, feature)| {
 241         format!(
 242             "{:<32} {:<8} {:<12} {:<8}",
 243             name,
 244             family,
 245             feature.level,
 246             feature.since.map_or("None".to_owned(), |since| since.to_string())
 247         )
 248     })
 249 }
 250
 251 fn find_attr_val<'a>(line: &'a str, attr: &str) -> Option<&'a str> {
 252     lazy_static::lazy_static! {
 253         static ref ISSUE: Regex = Regex::new(r#"issue\s*=\s*"([^"]*)""#).unwrap();
 254         static ref FEATURE: Regex = Regex::new(r#"feature\s*=\s*"([^"]*)""#).unwrap();
 255         static ref SINCE: Regex = Regex::new(r#"since\s*=\s*"([^"]*)""#).unwrap();
 256     }
 257
 258     let r = match attr {
 259         "issue" => &*ISSUE,
 260         "feature" => &*FEATURE,
 261         "since" => &*SINCE,
 262         _ => unimplemented!("{attr} not handled"),
 263     };
 264
 265     r.captures(line).and_then(|c| c.get(1)).map(|m| m.as_str())
 266 }
 267
 268 fn test_filen_gate(filen_underscore: &str, features: &mut Features) -> bool {
 269     let prefix = "feature_gate_";
 270     if filen_underscore.starts_with(prefix) {
 271         for (n, f) in features.iter_mut() {
 272             // Equivalent to filen_underscore == format!("feature_gate_{n}")
 273             if &filen_underscore[prefix.len()..] == n {
 274                 f.has_gate_test = true;
 275                 return true;
 276             }
 277         }
 278     }
 279     false
 280 }
 281
 282 pub fn collect_lang_features(base_compiler_path: &Path, bad: &mut bool) -> Features {
 283     let mut all = collect_lang_features_in(base_compiler_path, "active.rs", bad);
 284     all.extend(collect_lang_features_in(base_compiler_path, "accepted.rs", bad));
 285     all.extend(collect_lang_features_in(base_compiler_path, "removed.rs", bad));
 286     all
 287 }
 288
 289 fn collect_lang_features_in(base: &Path, file: &str, bad: &mut bool) -> Features {
 290     let path = base.join("rustc_feature").join("src").join(file);
 291     let contents = t!(fs::read_to_string(&path));
 292
 293     // We allow rustc-internal features to omit a tracking issue.
 294     // To make tidy accept omitting a tracking issue, group the list of features
 295     // without one inside `// no-tracking-issue` and `// no-tracking-issue-end`.
 296     let mut next_feature_omits_tracking_issue = false;
 297
 298     let mut in_feature_group = false;
 299     let mut prev_names = vec![];
 300
 301     contents
 302         .lines()
 303         .zip(1..)
 304         .filter_map(|(line, line_number)| {
 305             let line = line.trim();
 306
 307             // Within -start and -end, the tracking issue can be omitted.
 308             match line {
 309                 "// no-tracking-issue-start" => {
 310                     next_feature_omits_tracking_issue = true;
 311                     return None;
 312                 }
 313                 "// no-tracking-issue-end" => {
 314                     next_feature_omits_tracking_issue = false;
 315                     return None;
 316                 }
 317                 _ => {}
 318             }
 319
 320             if line.starts_with(FEATURE_GROUP_START_PREFIX) {
 321                 if in_feature_group {
 322                     tidy_error!(
 323                         bad,
 324                         "{}:{}: \
 325                         new feature group is started without ending the previous one",
 326                         path.display(),
 327                         line_number,
 328                     );
 329                 }
 330
 331                 in_feature_group = true;
 332                 prev_names = vec![];
 333                 return None;
 334             } else if line.starts_with(FEATURE_GROUP_END_PREFIX) {
 335                 in_feature_group = false;
 336                 prev_names = vec![];
 337                 return None;
 338             }
 339
 340             let mut parts = line.split(',');
 341             let level = match parts.next().map(|l| l.trim().trim_start_matches('(')) {
 342                 Some("active") => Status::Unstable,
 343                 Some("incomplete") => Status::Unstable,
 344                 Some("removed") => Status::Removed,
 345                 Some("accepted") => Status::Stable,
 346                 _ => return None,
 347             };
 348             let name = parts.next().unwrap().trim();
 349
 350             let since_str = parts.next().unwrap().trim().trim_matches('"');
 351             let since = match since_str.parse() {
 352                 Ok(since) => Some(since),
 353                 Err(err) => {
 354                     tidy_error!(
 355                         bad,
 356                         "{}:{}: failed to parse since: {} ({:?})",
 357                         path.display(),
 358                         line_number,
 359                         since_str,
 360                         err,
 361                     );
 362                     None
 363                 }
 364             };
 365             if in_feature_group {
 366                 if prev_names.last() > Some(&name) {
 367                     // This assumes the user adds the feature name at the end of the list, as we're
 368                     // not looking ahead.
 369                     let correct_index = match prev_names.binary_search(&name) {
 370                         Ok(_) => {
 371                             // This only occurs when the feature name has already been declared.
 372                             tidy_error!(
 373                                 bad,
 374                                 "{}:{}: duplicate feature {}",
 375                                 path.display(),
 376                                 line_number,
 377                                 name,
 378                             );
 379                             // skip any additional checks for this line
 380                             return None;
 381                         }
 382                         Err(index) => index,
 383                     };
 384
 385                     let correct_placement = if correct_index == 0 {
 386                         "at the beginning of the feature group".to_owned()
 387                     } else if correct_index == prev_names.len() {
 388                         // I don't believe this is reachable given the above assumption, but it
 389                         // doesn't hurt to be safe.
 390                         "at the end of the feature group".to_owned()
 391                     } else {
 392                         format!(
 393                             "between {} and {}",
 394                             prev_names[correct_index - 1],
 395                             prev_names[correct_index],
 396                         )
 397                     };
 398
 399                     tidy_error!(
 400                         bad,
 401                         "{}:{}: feature {} is not sorted by feature name (should be {})",
 402                         path.display(),
 403                         line_number,
 404                         name,
 405                         correct_placement,
 406                     );
 407                 }
 408                 prev_names.push(name);
 409             }
 410
 411             let issue_str = parts.next().unwrap().trim();
 412             let tracking_issue = if issue_str.starts_with("None") {
 413                 if level == Status::Unstable && !next_feature_omits_tracking_issue {
 414                     tidy_error!(
 415                         bad,
 416                         "{}:{}: no tracking issue for feature {}",
 417                         path.display(),
 418                         line_number,
 419                         name,
 420                     );
 421                 }
 422                 None
 423             } else {
 424                 let s = issue_str.split('(').nth(1).unwrap().split(')').next().unwrap();
 425                 Some(s.parse().unwrap())
 426             };
 427             Some((name.to_owned(), Feature { level, since, has_gate_test: false, tracking_issue }))
 428         })
 429         .collect()
 430 }
 431
 432 fn get_and_check_lib_features(
 433     base_src_path: &Path,
 434     bad: &mut bool,
 435     lang_features: &Features,
 436 ) -> Features {
 437     let mut lib_features = Features::new();
 438     map_lib_features(base_src_path, &mut |res, file, line| match res {
 439         Ok((name, f)) => {
 440             let mut check_features = |f: &Feature, list: &Features, display: &str| {
 441                 if let Some(ref s) = list.get(name) {
 442                     if f.tracking_issue != s.tracking_issue && f.level != Status::Stable {
 443                         tidy_error!(
 444                             bad,
 445                             "{}:{}: `issue` \"{}\" mismatches the {} `issue` of \"{}\"",
 446                             file.display(),
 447                             line,
 448                             f.tracking_issue_display(),
 449                             display,
 450                             s.tracking_issue_display(),
 451                         );
 452                     }
 453                 }
 454             };
 455             check_features(&f, &lang_features, "corresponding lang feature");
 456             check_features(&f, &lib_features, "previous");
 457             lib_features.insert(name.to_owned(), f);
 458         }
 459         Err(msg) => {
 460             tidy_error!(bad, "{}:{}: {}", file.display(), line, msg);
 461         }
 462     });
 463     lib_features
 464 }
 465
 466 fn map_lib_features(
 467     base_src_path: &Path,
 468     mf: &mut dyn FnMut(Result<(&str, Feature), &str>, &Path, usize),
 469 ) {
 470     super::walk(
 471         base_src_path,
 472         &mut |path| super::filter_dirs(path) || path.ends_with("src/test"),
 473         &mut |entry, contents| {
 474             let file = entry.path();
 475             let filename = file.file_name().unwrap().to_string_lossy();
 476             if !filename.ends_with(".rs")
 477                 || filename == "features.rs"
 478                 || filename == "diagnostic_list.rs"
 479                 || filename == "error_codes.rs"
 480             {
 481                 return;
 482             }
 483
 484             // This is an early exit -- all the attributes we're concerned with must contain this:
 485             // * rustc_const_unstable(
 486             // * unstable(
 487             // * stable(
 488             if !contents.contains("stable(") {
 489                 return;
 490             }
 491
 492             let handle_issue_none = |s| match s {
 493                 "none" => None,
 494                 issue => {
 495                     let n = issue.parse().expect("issue number is not a valid integer");
 496                     assert_ne!(n, 0, "\"none\" should be used when there is no issue, not \"0\"");
 497                     NonZeroU32::new(n)
 498                 }
 499             };
 500             let mut becoming_feature: Option<(&str, Feature)> = None;
 501             let mut iter_lines = contents.lines().enumerate().peekable();
 502             while let Some((i, line)) = iter_lines.next() {
 503                 macro_rules! err {
 504                     ($msg:expr) => {{
 505                         mf(Err($msg), file, i + 1);
 506                         continue;
 507                     }};
 508                 }
 509
 510                 lazy_static::lazy_static! {
 511                     static ref COMMENT_LINE: Regex = Regex::new(r"^\s*//").unwrap();
 512                 }
 513                 // exclude commented out lines
 514                 if COMMENT_LINE.is_match(line) {
 515                     continue;
 516                 }
 517
 518                 if let Some((ref name, ref mut f)) = becoming_feature {
 519                     if f.tracking_issue.is_none() {
 520                         f.tracking_issue = find_attr_val(line, "issue").and_then(handle_issue_none);
 521                     }
 522                     if line.ends_with(']') {
 523                         mf(Ok((name, f.clone())), file, i + 1);
 524                     } else if !line.ends_with(',') && !line.ends_with('\\') && !line.ends_with('"')
 525                     {
 526                         // We need to bail here because we might have missed the
 527                         // end of a stability attribute above because the ']'
 528                         // might not have been at the end of the line.
 529                         // We could then get into the very unfortunate situation that
 530                         // we continue parsing the file assuming the current stability
 531                         // attribute has not ended, and ignoring possible feature
 532                         // attributes in the process.
 533                         err!("malformed stability attribute");
 534                     } else {
 535                         continue;
 536                     }
 537                 }
 538                 becoming_feature = None;
 539                 if line.contains("rustc_const_unstable(") {
 540                     // `const fn` features are handled specially.
 541                     let feature_name = match find_attr_val(line, "feature") {
 542                         Some(name) => name,
 543                         None => err!("malformed stability attribute: missing `feature` key"),
 544                     };
 545                     let feature = Feature {
 546                         level: Status::Unstable,
 547                         since: None,
 548                         has_gate_test: false,
 549                         tracking_issue: find_attr_val(line, "issue").and_then(handle_issue_none),
 550                     };
 551                     mf(Ok((feature_name, feature)), file, i + 1);
 552                     continue;
 553                 }
 554                 let level = if line.contains("[unstable(") {
 555                     Status::Unstable
 556                 } else if line.contains("[stable(") {
 557                     Status::Stable
 558                 } else {
 559                     continue;
 560                 };
 561                 let feature_name = match find_attr_val(line, "feature")
 562                     .or_else(|| iter_lines.peek().and_then(|next| find_attr_val(next.1, "feature")))
 563                 {
 564                     Some(name) => name,
 565                     None => err!("malformed stability attribute: missing `feature` key"),
 566                 };
 567                 let since = match find_attr_val(line, "since").map(|x| x.parse()) {
 568                     Some(Ok(since)) => Some(since),
 569                     Some(Err(_err)) => {
 570                         err!("malformed stability attribute: can't parse `since` key");
 571                     }
 572                     None if level == Status::Stable => {
 573                         err!("malformed stability attribute: missing the `since` key");
 574                     }
 575                     None => None,
 576                 };
 577                 let tracking_issue = find_attr_val(line, "issue").and_then(handle_issue_none);
 578
 579                 let feature = Feature { level, since, has_gate_test: false, tracking_issue };
 580                 if line.contains(']') {
 581                     mf(Ok((feature_name, feature)), file, i + 1);
 582                 } else {
 583                     becoming_feature = Some((feature_name, feature));
 584                 }
 585             }
 586         },
 587     );
 588 }