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     "library/std/src/panic.rs",   // fuchsia-specific panic backtrace handling
  62 ];
  63
  64 pub fn check(path: &Path, bad: &mut bool) {
  65     // Sanity check that the complex parsing here works.
  66     let mut saw_target_arch = false;
  67     let mut saw_cfg_bang = false;
  68     super::walk(path, &mut super::filter_dirs, &mut |entry, contents| {
  69         let file = entry.path();
  70         let filestr = file.to_string_lossy().replace("\\", "/");
  71         if !filestr.ends_with(".rs") {
  72             return;
  73         }
  74
  75         let is_exception_path = EXCEPTION_PATHS.iter().any(|s| filestr.contains(&**s));
  76         if is_exception_path {
  77             return;
  78         }
  79
  80         // exclude tests and benchmarks as some platforms do not support all tests
  81         if filestr.contains("tests") || filestr.contains("benches") {
  82             return;
  83         }
  84
  85         check_cfgs(contents, &file, bad, &mut saw_target_arch, &mut saw_cfg_bang);
  86     });
  87
  88     assert!(saw_target_arch);
  89     assert!(saw_cfg_bang);
  90 }
  91
  92 fn check_cfgs(
  93     contents: &str,
  94     file: &Path,
  95     bad: &mut bool,
  96     saw_target_arch: &mut bool,
  97     saw_cfg_bang: &mut bool,
  98 ) {
  99     // Pull out all `cfg(...)` and `cfg!(...)` strings.
 100     let cfgs = parse_cfgs(contents);
 101
 102     let mut line_numbers: Option<Vec<usize>> = None;
 103     let mut err = |idx: usize, cfg: &str| {
 104         if line_numbers.is_none() {
 105             line_numbers = Some(contents.match_indices('\n').map(|(i, _)| i).collect());
 106         }
 107         let line_numbers = line_numbers.as_ref().expect("");
 108         let line = match line_numbers.binary_search(&idx) {
 109             Ok(_) => unreachable!(),
 110             Err(i) => i + 1,
 111         };
 112         tidy_error!(bad, "{}:{}: platform-specific cfg: {}", file.display(), line, cfg);
 113     };
 114
 115     for (idx, cfg) in cfgs {
 116         // Sanity check that the parsing here works.
 117         if !*saw_target_arch && cfg.contains("target_arch") {
 118             *saw_target_arch = true
 119         }
 120         if !*saw_cfg_bang && cfg.contains("cfg!") {
 121             *saw_cfg_bang = true
 122         }
 123
 124         let contains_platform_specific_cfg = cfg.contains("target_os")
 125             || cfg.contains("target_env")
 126             || cfg.contains("target_abi")
 127             || cfg.contains("target_vendor")
 128             || cfg.contains("unix")
 129             || cfg.contains("windows");
 130
 131         if !contains_platform_specific_cfg {
 132             continue;
 133         }
 134
 135         let preceeded_by_doc_comment = {
 136             let pre_contents = &contents[..idx];
 137             let pre_newline = pre_contents.rfind('\n');
 138             let pre_doc_comment = pre_contents.rfind("///");
 139             match (pre_newline, pre_doc_comment) {
 140                 (Some(n), Some(c)) => n < c,
 141                 (None, Some(_)) => true,
 142                 (_, None) => false,
 143             }
 144         };
 145
 146         if preceeded_by_doc_comment {
 147             continue;
 148         }
 149
 150         // exclude tests as some platforms do not support all tests
 151         if cfg.contains("test") {
 152             continue;
 153         }
 154
 155         err(idx, cfg);
 156     }
 157 }
 158
 159 fn parse_cfgs(contents: &str) -> Vec<(usize, &str)> {
 160     let candidate_cfgs = contents.match_indices("cfg");
 161     let candidate_cfg_idxs = candidate_cfgs.map(|(i, _)| i);
 162     // This is puling out the indexes of all "cfg" strings
 163     // that appear to be tokens followed by a parenthesis.
 164     let cfgs = candidate_cfg_idxs.filter(|i| {
 165         let pre_idx = i.saturating_sub(1);
 166         let succeeds_non_ident = !contents
 167             .as_bytes()
 168             .get(pre_idx)
 169             .cloned()
 170             .map(char::from)
 171             .map(char::is_alphanumeric)
 172             .unwrap_or(false);
 173         let contents_after = &contents[*i..];
 174         let first_paren = contents_after.find('(');
 175         let paren_idx = first_paren.map(|ip| i + ip);
 176         let preceeds_whitespace_and_paren = paren_idx
 177             .map(|ip| {
 178                 let maybe_space = &contents[*i + "cfg".len()..ip];
 179                 maybe_space.chars().all(|c| char::is_whitespace(c) || c == '!')
 180             })
 181             .unwrap_or(false);
 182
 183         succeeds_non_ident && preceeds_whitespace_and_paren
 184     });
 185
 186     cfgs.flat_map(|i| {
 187         let mut depth = 0;
 188         let contents_from = &contents[i..];
 189         for (j, byte) in contents_from.bytes().enumerate() {
 190             match byte {
 191                 b'(' => {
 192                     depth += 1;
 193                 }
 194                 b')' => {
 195                     depth -= 1;
 196                     if depth == 0 {
 197                         return Some((i, &contents_from[..=j]));
 198                     }
 199                 }
 200                 _ => {}
 201             }
 202         }
 203
 204         // if the parentheses are unbalanced just ignore this cfg -- it'll be caught when attempting
 205         // to run the compiler, and there's no real reason to lint it separately here
 206         None
 207     })
 208     .collect()
 209 }