git.bitcoin.ninja Git - rust-lightning/blob - ci/check-cfg-flags.py

   1 #!/usr/bin/env python3
   2 # Rust is fairly relaxed in checking the validity of arguments passed to #[cfg].
   3 # While it should probably be more strict when checking features, it cannot be
   4 # strict when checking loose cfg tags, because those can be anything and are
   5 # simply passed to rustc via unconstrained arguments.
   6 #
   7 # Thus, we do it for rustc manually, but scanning all our source and checking
   8 # that all our cfg tags match a known cfg tag.
   9 import sys, glob, re
  10
  11 def check_feature(feature):
  12     if feature == "std":
  13         pass
  14     elif feature == "no-std":
  15         pass
  16     elif feature == "hashbrown":
  17         pass
  18     elif feature == "backtrace":
  19         pass
  20     elif feature == "grind_signatures":
  21         pass
  22     elif feature == "unsafe_revoked_tx_signing":
  23         pass
  24     elif feature == "futures":
  25         pass
  26     elif feature == "tokio":
  27         pass
  28     elif feature == "rest-client":
  29         pass
  30     elif feature == "rpc-client":
  31         pass
  32     elif feature == "serde":
  33         pass
  34     elif feature == "esplora-blocking":
  35         pass
  36     elif feature == "esplora-async":
  37         pass
  38     elif feature == "async-interface":
  39         pass
  40     elif feature == "electrum":
  41         pass
  42     elif feature == "time":
  43         pass
  44     elif feature == "_test_utils":
  45         pass
  46     elif feature == "_test_vectors":
  47         pass
  48     elif feature == "afl":
  49         pass
  50     elif feature == "honggfuzz":
  51         pass
  52     elif feature == "libfuzzer_fuzz":
  53         pass
  54     elif feature == "stdin_fuzz":
  55         pass
  56     elif feature == "max_level_off":
  57         pass
  58     elif feature == "max_level_error":
  59         pass
  60     elif feature == "max_level_warn":
  61         pass
  62     elif feature == "max_level_info":
  63         pass
  64     elif feature == "max_level_debug":
  65         pass
  66     elif feature == "max_level_trace":
  67         pass
  68     else:
  69         print("Bad feature: " + feature)
  70         assert False
  71
  72 def check_target_os(os):
  73     if os == "windows":
  74         pass
  75     else:
  76         assert False
  77
  78 def check_cfg_tag(cfg):
  79     if cfg == "fuzzing":
  80         pass
  81     elif cfg == "test":
  82         pass
  83     elif cfg == "debug_assertions":
  84         pass
  85     elif cfg == "c_bindings":
  86         pass
  87     elif cfg == "ldk_bench":
  88         pass
  89     elif cfg == "taproot":
  90         pass
  91     elif cfg == "async_signing":
  92         pass
  93     elif cfg == "require_route_graph_test":
  94         pass
  95     else:
  96         print("Bad cfg tag: " + cfg)
  97         assert False
  98
  99 def check_cfg_args(cfg):
 100     if cfg.startswith("all(") or cfg.startswith("any(") or cfg.startswith("not("):
 101         brackets = 1
 102         pos = 4
 103         while pos < len(cfg):
 104             if cfg[pos] == "(":
 105                 brackets += 1
 106             elif cfg[pos] == ")":
 107                 brackets -= 1
 108                 if brackets == 0:
 109                     check_cfg_args(cfg[4:pos])
 110                     if pos + 1 != len(cfg):
 111                         assert cfg[pos + 1] == ","
 112                         check_cfg_args(cfg[pos + 2:].strip())
 113                     return
 114             pos += 1
 115         assert False
 116         assert(cfg.endswith(")"))
 117         check_cfg_args(cfg[4:len(cfg)-1])
 118     else:
 119         parts = [part.strip() for part in cfg.split(",", 1)]
 120         if len(parts) > 1:
 121             for part in parts:
 122                 check_cfg_args(part)
 123         elif cfg.startswith("feature") or cfg.startswith("target_os") or cfg.startswith("target_pointer_width"):
 124             arg = cfg
 125             if cfg.startswith("feature"):
 126                 arg = arg[7:].strip()
 127             elif cfg.startswith("target_os"):
 128                 arg = arg[9:].strip()
 129             else:
 130                 arg = arg[20:].strip()
 131             assert arg.startswith("=")
 132             arg = arg[1:].strip()
 133             assert arg.startswith("\"")
 134             assert arg.endswith("\"")
 135             arg = arg[1:len(arg)-1]
 136             assert not "\"" in arg
 137             if cfg.startswith("feature"):
 138                 check_feature(arg)
 139             elif cfg.startswith("target_os"):
 140                 check_target_os(arg)
 141             else:
 142                 assert arg == "32" or arg == "64"
 143         else:
 144             check_cfg_tag(cfg.strip())
 145
 146 cfg_regex = re.compile("#\[cfg\((.*)\)\]")
 147 for path in glob.glob(sys.path[0] + "/../**/*.rs", recursive = True):
 148     with open(path, "r") as file:
 149         while True:
 150             line = file.readline()
 151             if not line:
 152                 break
 153             if "#[cfg(" in line:
 154                 if not line.strip().startswith("//"):
 155                     cfg_part = cfg_regex.match(line.strip()).group(1)
 156                     check_cfg_args(cfg_part)