fixup: first draft divan

Author: GuillaumeLagrange

Cargo.lock

@@ -4,7 +4,9 @@ members = [
     "crates/bencher_compat",
     "crates/criterion_compat",
     "crates/cargo-codspeed",
+
     "crates/divan_compat",
     "crates/divan_compat/macros",
+    "crates/divan_compat/examples",
 ]
 resolver = "2"

Cargo.toml

@@ -11,9 +11,9 @@ repository = "https://github.com/CodSpeedHQ/codspeed-rust"
 homepage = "https://codspeed.io"
 license = "MIT OR Apache-2.0"
 categories = [
-    "development-tools",
-    "development-tools::profiling",
-    "development-tools::testing",
+  "development-tools",
+  "development-tools::profiling",
+  "development-tools::testing",
 ]
 keywords = ["codspeed", "benchmark", "divan"]
 

crates/divan_compat/Cargo.toml

@@ -1,5 +1,3 @@
-use codspeed_divan_compat as divan;
-
 fn fibo(n: i32) -> i32 {
     let mut a = 0;
     let mut b = 1;
@@ -13,17 +11,16 @@ fn fibo(n: i32) -> i32 {
     a
 }
 
-#[divan::bench]
+#[codspeed_divan_compat::bench]
 fn fibo_500() -> i32 {
-    divan::black_box(fibo(500))
+    codspeed_divan_compat::black_box(fibo(500))
 }
 
-#[divan::bench]
-fn fibo_100() -> i32 {
-    divan::black_box(fibo(10))
+#[codspeed_divan_compat::bench]
+fn fibo_10() -> i32 {
+    codspeed_divan_compat::black_box(fibo(10))
 }
 
 fn main() {
-    // Run `add` benchmark:
-    divan::main();
+    codspeed_divan_compat::main();
 }

crates/divan_compat/benches/basic_example.rs

@@ -11,9 +11,9 @@ repository = "https://github.com/CodSpeedHQ/codspeed-rust"
 homepage = "https://codspeed.io"
 license = "MIT OR Apache-2.0"
 categories = [
-    "development-tools",
-    "development-tools::profiling",
-    "development-tools::testing",
+  "development-tools",
+  "development-tools::profiling",
+  "development-tools::testing",
 ]
 keywords = ["codspeed", "benchmark", "divan"]
 
@@ -22,7 +22,11 @@ proc-macro = true
 
 [dependencies]
 divan-macros = { version = "=0.1.17" }
+proc-macro-crate = "3.2.0"
 proc-macro2 = "1"
 quote = { version = "1", default-features = false }
 # Versions prior to *.18 fail to parse empty attribute metadata.
-syn = { version = "^2.0.18", default-features = false, features = ["full", "clone-impls", "parsing", "printing", "proc-macro"] }
+# syn = { version = "^2.0.18", default-features = false, features = ["full", "clone-impls", "parsing", "printing", "proc-macro"] }
+syn = { version = "^2.0.18", default-features = true, features = [
+  "extra-traits",
+] }

crates/divan_compat/macros/Cargo.toml

@@ -1,7 +1,13 @@
 use proc_macro::TokenStream;
-use quote::quote;
+use proc_macro_crate::{crate_name, FoundCrate};
+use quote::{format_ident, quote};
 use syn::{
-    parse::Parse, parse_macro_input, punctuated::Punctuated, ItemFn, Meta, MetaNameValue, Token,
+    parse::Parse,
+    parse_macro_input,
+    punctuated::Punctuated,
+    ItemFn,
+    Meta::{self, NameValue},
+    MetaNameValue, Token,
 };
 
 struct MyBenchArgs {
@@ -25,21 +31,45 @@ pub fn bench_compat(attr: TokenStream, item: TokenStream) -> TokenStream {
 
     for arg in parsed_args.args {
         match &arg {
-            Meta::NameValue(MetaNameValue { path, .. }) if path.is_ident("crate") => {
+            NameValue(MetaNameValue { path, .. }) if path.is_ident("crate") => {
                 return quote! {
-                    compile_error!("crate argument is not supported with codspeed_divan_compat");
+                    compile_error!("`crate` argument is not supported with codspeed_divan_compat");
                 }
                 .into();
             }
+            NameValue(MetaNameValue { path, .. }) if path.is_ident("types") => {
+                return quote! {
+                    compile_error!("`type` argument is not yet supported with codspeed_divan_compat");
+                }
+                .into();
+            }
+            NameValue(MetaNameValue { path, .. })
+                if path.is_ident("min_time")
+                    || path.is_ident("max_time")
+                    || path.is_ident("sample_size")
+                    || path.is_ident("sample_count")
+                    || path.is_ident("skip_ext_time") =>
+            {
+                // These arguments are ignored in instrumented mode
+            }
             _ => filtered_args.push(arg),
         }
     }
 
-    filtered_args.push(syn::parse_quote!(crate = ::codspeed_divan_compat));
+    let codspeed_divan_crate_ident = format_ident!(
+        "{}",
+        crate_name("codspeed-divan-compat")
+            .map(|found_crate| match found_crate {
+                FoundCrate::Itself => "crate".to_string(),
+                FoundCrate::Name(name) => name,
+            })
+            .unwrap_or("codspeed_divan_compat".to_string())
+    );
 
+    filtered_args.push(syn::parse_quote!(crate = ::#codspeed_divan_crate_ident));
     // Important: keep macro name in sync with re-exported macro name in divan-compat lib
     let expanded = quote! {
-        #[::codspeed_divan_compat::bench_original(#(#filtered_args),*)]
+        #[::#codspeed_divan_crate_ident::bench_original(#(#filtered_args),*)]
         #input
     };
 

crates/divan_compat/macros/src/lib.rs

@@ -8,7 +8,10 @@ use std::{
     },
 };
 
-use super::bench::{BenchOptions, Bencher};
+use super::{
+    bench::{BenchOptions, Bencher},
+    BenchArgsRunner,
+};
 
 /// Benchmark entries generated by `#[divan::bench]`.
 ///
@@ -21,8 +24,8 @@ pub static BENCH_ENTRIES: EntryList<BenchEntry> = EntryList::root();
 pub enum BenchEntryRunner {
     /// Benchmark without arguments.
     Plain(fn(Bencher)),
-    // /// Benchmark with runtime arguments.
-    // Args(fn() -> BenchArgsRunner),
+    /// Benchmark with runtime arguments.
+    Args(fn() -> BenchArgsRunner),
 }
 
 /// Compile-time entry for a benchmark, generated by `#[divan::bench]`.
@@ -50,7 +53,7 @@ pub struct EntryMeta {
     /// Where the entry was defined.
     pub location: EntryLocation,
     /// Configures the benchmarker via attribute options.
-    pub bench_options: Option<LazyLock<BenchOptions<'static>>>,
+    pub bench_options: Option<LazyLock<BenchOptions>>,
 }
 
 /// Where an entry is located.