Merge pull request #1138 from nnethercote/exact-include-exclude

Make `--include` and `--exclude` use exact matching.

Author: Mark-Simulacrum

collector/README.md

@@ -100,13 +100,13 @@ The following options alter the behaviour of the `bench_local` subcommand.
   supports postgres as a backend and the URL can be specified (beginning with
   `postgres://`), but this is unlikely to be useful for local collection.
 - `--exclude <EXCLUDE>`: this is used to run a subset of the benchmarks. The
-  argument is a comma-separated list of strings. When this option is specified,
-  a benchmark is excluded from the run if its name contains one or more of the
-  given strings.
+  argument is a comma-separated list of benchmark names. When this option is
+  specified, a benchmark is excluded from the run if its name matches one or
+  more of the given names.
 - `--include <INCLUDE>`: the inverse of `--exclude`. The argument is a
-  comma-separated list of strings. When this option is specified, a benchmark
-  is included in the run only if its name contains one or more of the given
-  strings.
+  comma-separated list of benchmark names. When this option is specified, a
+  benchmark is included in the run only if its name matches one or more of the
+  given names.
 - `--runs $RUNS`: the run kinds to be benchmarked. The possible choices are one
   or more (comma-separated) of `Full`, `IncrFull`, `IncrUnchanged`,
   `IncrPatched`, and `All`. The default is `All`. Note that `IncrFull` is

collector/src/main.rs

@@ -375,32 +375,52 @@ fn get_benchmarks(
     }
     paths.push((PathBuf::from("rustc"), String::from("rustc")));
 
-    'outer: for (path, name) in paths {
-        if let Some(include) = include {
-            if !include
-                .split(',')
-                .any(|to_include| name.contains(to_include))
-            {
+    let mut includes = include.map(|list| list.split(',').collect::<HashSet<_>>());
+    let mut excludes = exclude.map(|list| list.split(',').collect::<HashSet<_>>());
+
+    for (path, name) in paths {
+        let mut skip = false;
+        if let Some(includes) = includes.as_mut() {
+            if !includes.remove(name.as_str()) {
                 debug!(
-                    "benchmark {} - doesn't match --include argument, skipping",
+                    "benchmark {} - not named by --include argument, skipping",
                     name
                 );
-                continue 'outer;
+                skip = true;
             }
         }
 
-        if let Some(exclude) = exclude {
-            for exc in exclude.split(',') {
-                if name.contains(exc) {
-                    debug!("benchmark {} - matches --exclude argument, skipping", name);
-                    continue 'outer;
-                }
+        if let Some(excludes) = excludes.as_mut() {
+            if excludes.remove(name.as_str()) {
+                debug!("benchmark {} - named by --exclude argument, skipping", name);
+                skip = true;
             }
         }
+        if skip {
+            continue;
+        }
 
         debug!("benchmark `{}`- registered", name);
         benchmarks.push(Benchmark::new(name, path)?);
     }
+
+    if let Some(includes) = includes {
+        if !includes.is_empty() {
+            bail!(
+                "Warning: one or more invalid --include entries: {:?}",
+                includes
+            );
+        }
+    }
+    if let Some(excludes) = excludes {
+        if !excludes.is_empty() {
+            bail!(
+                "Warning: one or more invalid --exclude entries: {:?}",
+                excludes
+            );
+        }
+    }
+
     benchmarks.sort_by_key(|benchmark| benchmark.name.clone());
 
     if benchmarks.is_empty() {
@@ -717,10 +737,10 @@ fn main_result() -> anyhow::Result<i32> {
             (@arg CARGO:   --cargo   +takes_value "The path to the local Cargo to use")
             (@arg DB:      --db      +takes_value "Database output file")
             (@arg EXCLUDE: --exclude     +takes_value
-             "Exclude all benchmarks matching anything in\n\
+             "Exclude all benchmarks that are listed in\n\
              this comma-separated list of patterns")
             (@arg INCLUDE: --include     +takes_value
-             "Include only benchmarks matching something in\n\
+             "Include only benchmarks that are listed in\n\
              this comma-separated list of patterns")
             (@arg RUNS:    --runs    +takes_value
              "One or more (comma-separated) of: 'Full',\n\
@@ -769,10 +789,10 @@ fn main_result() -> anyhow::Result<i32> {
              'Debug', 'Doc', 'Opt', 'All'")
             (@arg CARGO:   --cargo       +takes_value "The path to the local Cargo to use")
             (@arg EXCLUDE: --exclude     +takes_value
-             "Exclude all benchmarks matching anything in\n\
+             "Exclude all benchmarks that are listed in\n\
              this comma-separated list of patterns")
             (@arg INCLUDE: --include     +takes_value
-             "Include only benchmarks matching something in\n\
+             "Include only benchmarks that are listed in\n\
              this comma-separated list of patterns")
             (@arg OUT_DIR: --("out-dir") +takes_value "Output directory")
             (@arg RUNS:    --runs        +takes_value
@@ -798,10 +818,10 @@ fn main_result() -> anyhow::Result<i32> {
              'Debug', 'Doc', 'Opt', 'All'")
             (@arg CARGO:   --cargo       +takes_value "The path to the local Cargo to use")
             (@arg EXCLUDE: --exclude     +takes_value
-             "Exclude all benchmarks matching anything in\n\
+             "Exclude all benchmarks that are listed in\n\
              this comma-separated list of patterns")
             (@arg INCLUDE: --include     +takes_value
-             "Include only benchmarks matching something in\n\
+             "Include only benchmarks that are listed in\n\
              this comma-separated list of patterns")
             (@arg OUT_DIR: --("out-dir") +takes_value "Output directory")
             (@arg RUNS:    --runs        +takes_value