src/tools/tidy/src/pal.rs

   1 //! Tidy check to enforce rules about platform-specific code in std.
   2 //!
   3 //! This is intended to maintain existing standards of code
   4 //! organization in hopes that the standard library will continue to
   5 //! be refactored to isolate platform-specific bits, making porting
   6 //! easier; where "standard library" roughly means "all the
   7 //! dependencies of the std and test crates".
   8 //!
   9 //! This generally means placing restrictions on where `cfg(unix)`,
  10 //! `cfg(windows)`, `cfg(target_os)` and `cfg(target_env)` may appear,
  11 //! the basic objective being to isolate platform-specific code to the
  12 //! platform-specific `std::sys` modules, and to the allocation,
  13 //! unwinding, and libc crates.
  14 //!
  15 //! Following are the basic rules, though there are currently
  16 //! exceptions:
  17 //!
  18 //! - core may not have platform-specific code.
  19 //! - libpanic_abort may have platform-specific code.
  20 //! - libpanic_unwind may have platform-specific code.
  21 //! - libunwind may have platform-specific code.
  22 //! - other crates in the std facade may not.
  23 //! - std may have platform-specific code in the following places:
  24 //!   - `sys/`
  25 //!   - `os/`
  26 //!
  27 //! `std/sys_common` should _not_ contain platform-specific code.
  28 //! Finally, because std contains tests with platform-specific
  29 //! `ignore` attributes, once the parser encounters `mod tests`,
  30 //! platform-specific cfgs are allowed. Not sure yet how to deal with
  31 //! this in the long term.
  32
  33 use std::iter::Iterator;
  34 use std::path::Path;
  35
  36 // Paths that may contain platform-specific code.
  37 const EXCEPTION_PATHS: &[&str] = &[
  38     "library/panic_abort",
  39     "library/panic_unwind",
  40     "library/unwind",
  41     "library/rtstartup", // Not sure what to do about this. magic stuff for mingw
  42     "library/term",      // Not sure how to make this crate portable, but test crate needs it.
  43     "library/test",      // Probably should defer to unstable `std::sys` APIs.
  44     // The `VaList` implementation must have platform specific code.
  45     // The Windows implementation of a `va_list` is always a character
  46     // pointer regardless of the target architecture. As a result,
  47     // we must use `#[cfg(windows)]` to conditionally compile the
  48     // correct `VaList` structure for windows.
  49     "library/core/src/ffi.rs",
  50     "library/std/src/sys/", // Platform-specific code for std lives here.
  51     "library/std/src/os",   // Platform-specific public interfaces
  52     // Temporary `std` exceptions
  53     // FIXME: platform-specific code should be moved to `sys`
  54     "library/std/src/io/copy.rs",
  55     "library/std/src/io/stdio.rs",
  56     "library/std/src/f32.rs",
  57     "library/std/src/f64.rs",
  58     "library/std/src/path.rs",
  59     "library/std/src/sys_common", // Should only contain abstractions over platforms
  60     "library/std/src/net/test.rs", // Utility helpers for tests
  61 ];
  62
  63 pub fn check(path: &Path, bad: &mut bool) {
  64     // Sanity check that the complex parsing here works.
  65     let mut saw_target_arch = false;
  66     let mut saw_cfg_bang = false;
  67     super::walk(path, &mut super::filter_dirs, &mut |entry, contents| {
  68         let file = entry.path();
  69         let filestr = file.to_string_lossy().replace("\\", "/");
  70         if !filestr.ends_with(".rs") {
  71             return;
  72         }
  73
  74         let is_exception_path = EXCEPTION_PATHS.iter().any(|s| filestr.contains(&**s));
  75         if is_exception_path {
  76             return;
  77         }
  78
  79         // exclude tests and benchmarks as some platforms do not support all tests
  80         if filestr.contains("tests") || filestr.contains("benches") {
  81             return;
  82         }
  83
  84         check_cfgs(contents, &file, bad, &mut saw_target_arch, &mut saw_cfg_bang);
  85     });
  86
  87     assert!(saw_target_arch);
  88     assert!(saw_cfg_bang);
  89 }
  90
  91 fn check_cfgs(
  92     contents: &str,
  93     file: &Path,
  94     bad: &mut bool,
  95     saw_target_arch: &mut bool,
  96     saw_cfg_bang: &mut bool,
  97 ) {
  98     // Pull out all `cfg(...)` and `cfg!(...)` strings.
  99     let cfgs = parse_cfgs(contents);
 100
 101     let mut line_numbers: Option<Vec<usize>> = None;
 102     let mut err = |idx: usize, cfg: &str| {
 103         if line_numbers.is_none() {
 104             line_numbers = Some(contents.match_indices('\n').map(|(i, _)| i).collect());
 105         }
 106         let line_numbers = line_numbers.as_ref().expect("");
 107         let line = match line_numbers.binary_search(&idx) {
 108             Ok(_) => unreachable!(),
 109             Err(i) => i + 1,
 110         };
 111         tidy_error!(bad, "{}:{}: platform-specific cfg: {}", file.display(), line, cfg);
 112     };
 113
 114     for (idx, cfg) in cfgs {
 115         // Sanity check that the parsing here works.
 116         if !*saw_target_arch && cfg.contains("target_arch") {
 117             *saw_target_arch = true
 118         }
 119         if !*saw_cfg_bang && cfg.contains("cfg!") {
 120             *saw_cfg_bang = true
 121         }
 122
 123         let contains_platform_specific_cfg = cfg.contains("target_os")
 124             || cfg.contains("target_env")
 125             || cfg.contains("target_abi")
 126             || cfg.contains("target_vendor")
 127             || cfg.contains("unix")
 128             || cfg.contains("windows");
 129
 130         if !contains_platform_specific_cfg {
 131             continue;
 132         }
 133
 134         let preceeded_by_doc_comment = {
 135             let pre_contents = &contents[..idx];
 136             let pre_newline = pre_contents.rfind('\n');
 137             let pre_doc_comment = pre_contents.rfind("///");
 138             match (pre_newline, pre_doc_comment) {
 139                 (Some(n), Some(c)) => n < c,
 140                 (None, Some(_)) => true,
 141                 (_, None) => false,
 142             }
 143         };
 144
 145         if preceeded_by_doc_comment {
 146             continue;
 147         }
 148
 149         // exclude tests as some platforms do not support all tests
 150         if cfg.contains("test") {
 151             continue;
 152         }
 153
 154         err(idx, cfg);
 155     }
 156 }
 157
 158 fn parse_cfgs(contents: &str) -> Vec<(usize, &str)> {
 159     let candidate_cfgs = contents.match_indices("cfg");
 160     let candidate_cfg_idxs = candidate_cfgs.map(|(i, _)| i);
 161     // This is puling out the indexes of all "cfg" strings
 162     // that appear to be tokens followed by a parenthesis.
 163     let cfgs = candidate_cfg_idxs.filter(|i| {
 164         let pre_idx = i.saturating_sub(1);
 165         let succeeds_non_ident = !contents
 166             .as_bytes()
 167             .get(pre_idx)
 168             .cloned()
 169             .map(char::from)
 170             .map(char::is_alphanumeric)
 171             .unwrap_or(false);
 172         let contents_after = &contents[*i..];
 173         let first_paren = contents_after.find('(');
 174         let paren_idx = first_paren.map(|ip| i + ip);
 175         let preceeds_whitespace_and_paren = paren_idx
 176             .map(|ip| {
 177                 let maybe_space = &contents[*i + "cfg".len()..ip];
 178                 maybe_space.chars().all(|c| char::is_whitespace(c) || c == '!')
 179             })
 180             .unwrap_or(false);
 181
 182         succeeds_non_ident && preceeds_whitespace_and_paren
 183     });
 184
 185     cfgs.flat_map(|i| {
 186         let mut depth = 0;
 187         let contents_from = &contents[i..];
 188         for (j, byte) in contents_from.bytes().enumerate() {
 189             match byte {
 190                 b'(' => {
 191                     depth += 1;
 192                 }
 193                 b')' => {
 194                     depth -= 1;
 195                     if depth == 0 {
 196                         return Some((i, &contents_from[..=j]));
 197                     }
 198                 }
 199                 _ => {}
 200             }
 201         }
 202
 203         // if the parentheses are unbalanced just ignore this cfg -- it'll be caught when attempting
 204         // to run the compiler, and there's no real reason to lint it separately here
 205         None
 206     })
 207     .collect()
 208 }