1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
//! Macros for [Divan](https://github.com/nvzqz/divan), a statistically-comfy
//! benchmarking library brought to you by [Nikolai Vazquez](https://hachyderm.io/@nikolai).
//!
//! See [`divan`](https://docs.rs/divan) crate for documentation.
use proc_macro::TokenStream;
use quote::{quote, ToTokens};
mod attr_options;
use attr_options::*;
use syn::Expr;
#[derive(Clone, Copy)]
enum Macro<'a> {
Bench { fn_sig: &'a syn::Signature },
BenchGroup,
}
impl Macro<'_> {
fn name(&self) -> &'static str {
match self {
Self::Bench { .. } => "bench",
Self::BenchGroup => "bench_group",
}
}
}
#[proc_macro_attribute]
pub fn bench(options: TokenStream, item: TokenStream) -> TokenStream {
let fn_item = item.clone();
let fn_item = syn::parse_macro_input!(fn_item as syn::ItemFn);
let fn_sig = &fn_item.sig;
let options = match AttrOptions::parse(options, Macro::Bench { fn_sig }) {
Ok(options) => options,
Err(compile_error) => return compile_error,
};
// Items needed by generated code.
let AttrOptions { private_mod, linkme_crate, .. } = &options;
let fn_ident = &fn_sig.ident;
let fn_name = fn_ident.to_string();
let fn_name_pretty = fn_name.strip_prefix("r#").unwrap_or(&fn_name);
// Find any `#[ignore]` attribute so that we can use its span to help
// compiler diagnostics.
let ignore_attr_ident =
fn_item.attrs.iter().map(|attr| attr.meta.path()).find(|path| path.is_ident("ignore"));
// If the function is `extern "ABI"`, it is wrapped in a Rust-ABI function.
let is_extern_abi = fn_sig.abi.is_some();
let fn_args = &fn_sig.inputs;
let type_param: Option<(usize, &syn::TypeParam)> = fn_sig
.generics
.params
.iter()
.enumerate()
.filter_map(|(i, param)| match param {
syn::GenericParam::Type(param) => Some((i, param)),
_ => None,
})
.next();
let const_param: Option<(usize, &syn::ConstParam)> = fn_sig
.generics
.params
.iter()
.enumerate()
.filter_map(|(i, param)| match param {
syn::GenericParam::Const(param) => Some((i, param)),
_ => None,
})
.next();
let is_type_before_const = match (type_param, const_param) {
(Some((t, _)), Some((c, _))) => t < c,
_ => false,
};
// Prefixed with "__" to prevent IDEs from recommending using this symbol.
//
// The static is local to intentionally cause a compile error if this
// attribute is used multiple times on the same function.
let static_ident = syn::Ident::new(
&format!("__DIVAN_BENCH_{}", fn_name_pretty.to_uppercase()),
fn_ident.span(),
);
let meta = entry_meta_expr(&fn_name, &options, ignore_attr_ident);
// Creates a function expr for the benchmarking function, optionally
// monomorphized with generic parameters.
let make_bench_fn = |generics: &[&dyn ToTokens]| {
let fn_expr = if generics.is_empty() {
fn_ident.to_token_stream()
} else {
quote! { #fn_ident::< #(#generics),* > }
};
match (is_extern_abi, fn_args.is_empty()) {
(false, false) => fn_expr,
(false, true) => quote! { |divan| divan.bench(#fn_expr) },
(true, false) => quote! { |divan| #fn_expr(divan) },
(true, true) => quote! { |divan| divan.bench(|| #fn_expr()) },
}
};
let option_none = quote! { #private_mod::None };
let option_some = quote! { #private_mod::Some };
// Creates a `GroupEntry` static for generic benchmarks.
let make_generic_group = |generic_benches: proc_macro2::TokenStream| {
let entry = quote! {
#private_mod::GroupEntry {
meta: #meta,
generic_benches: #option_some({ #generic_benches }),
}
};
quote! {
// Use a distributed slice via `linkme` by default.
#[cfg(not(windows))]
#[#linkme_crate::distributed_slice(#private_mod::GROUP_ENTRIES)]
#[linkme(crate = #linkme_crate)]
#[doc(hidden)]
static #static_ident: #private_mod::GroupEntry = #entry;
// On other platforms we push this static into `GROUP_ENTRIES`
// before `main` is called.
#[cfg(windows)]
static #static_ident: #private_mod::GroupEntry = {
{
// Add `push` to the initializer section.
#[used]
#[link_section = ".CRT$XCU"]
static PUSH: extern "C" fn() = push;
extern "C" fn push() {
static NODE: #private_mod::EntryList<#private_mod::GroupEntry>
= #private_mod::EntryList::new(&#static_ident);
#private_mod::GROUP_ENTRIES.push(&NODE);
}
}
#entry
};
}
};
// Creates a `GenericBenchEntry` expr for a generic benchmark instance.
let make_generic_bench_entry =
|ty: Option<&dyn ToTokens>, const_value: Option<&dyn ToTokens>| {
let generic_const_value = const_value.map(|const_value| quote!({ #const_value }));
let generics: Vec<&dyn ToTokens> = {
let mut generics = Vec::new();
generics.extend(generic_const_value.as_ref().map(|t| t as &dyn ToTokens));
generics.extend(ty);
if is_type_before_const {
generics.reverse();
}
generics
};
let bench_fn = make_bench_fn(&generics);
let type_value = match ty {
Some(ty) => quote! {
#option_some(#private_mod::EntryType::new::<#ty>())
},
None => option_none.clone(),
};
let const_value = match const_value {
Some(const_value) => quote! {
#option_some(#private_mod::EntryConst::new(&#const_value))
},
None => option_none.clone(),
};
quote! {
#private_mod::GenericBenchEntry {
group: &#static_ident,
bench: #bench_fn,
ty: #type_value,
const_value: #const_value,
}
}
};
let generated_items: proc_macro2::TokenStream = match &options.generic.consts {
// Only specified `types = []` or `consts = []`; generate nothing.
_ if options.generic.is_empty() => Default::default(),
None => match &options.generic.types {
// No generics; generate a simple benchmark entry.
None => {
let bench_fn = make_bench_fn(&[]);
let entry = quote! {
#private_mod::BenchEntry {
meta: #meta,
bench: #bench_fn,
}
};
quote! {
// Use a distributed slice via `linkme` by default.
#[cfg(not(windows))]
#[#linkme_crate::distributed_slice(#private_mod::BENCH_ENTRIES)]
#[linkme(crate = #linkme_crate)]
#[doc(hidden)]
static #static_ident: #private_mod::BenchEntry = #entry;
// On other platforms we push this static into
// `BENCH_ENTRIES` before `main` is called.
#[cfg(windows)]
static #static_ident: #private_mod::BenchEntry = {
{
// Add `push` to the initializer section.
#[used]
#[link_section = ".CRT$XCU"]
static PUSH: extern "C" fn() = push;
extern "C" fn push() {
static NODE: #private_mod::EntryList<#private_mod::BenchEntry>
= #private_mod::EntryList::new(&#static_ident);
#private_mod::BENCH_ENTRIES.push(&NODE);
}
}
#entry
};
}
}
// Generate a benchmark group entry with generic benchmark entries.
Some(GenericTypes::List(generic_types)) => {
let generic_benches =
generic_types.iter().map(|ty| make_generic_bench_entry(Some(&ty), None));
make_generic_group(quote! {
&[&[#(#generic_benches),*]]
})
}
},
// Generate a benchmark group entry with generic benchmark entries.
Some(Expr::Array(generic_consts)) => {
let consts_count = generic_consts.elems.len();
let const_type = &const_param.unwrap().1.ty;
let generic_benches = options.generic.types_iter().map(|ty| {
let generic_benches = (0..consts_count).map(move |i| {
let const_value = quote! { __DIVAN_CONSTS[#i] };
make_generic_bench_entry(ty, Some(&const_value))
});
// `static` is necessary because `EntryConst` uses interior
// mutability to cache the `ToString` result.
quote! {
static __DIVAN_GENERIC_BENCHES: [#private_mod::GenericBenchEntry; #consts_count] = [#(#generic_benches),*];
&__DIVAN_GENERIC_BENCHES
}
});
make_generic_group(quote! {
// We refer to our own slice because it:
// - Type-checks values, even if `generic_benches` is empty
// because the user set `types = []`
// - Prevents re-computing constants, which can slightly improve
// compile time given that Miri is slow
const __DIVAN_CONSTS: &[#const_type] = &#generic_consts;
&[#({ #generic_benches }),*]
})
}
// Generate a benchmark group entry with generic benchmark entries over
// an expression of constants.
//
// This is limited to a maximum of 20 because we need some constant to
// instantiate each function instance.
Some(generic_consts) => {
// The maximum number of elements for non-array expressions.
const MAX_EXTERN_COUNT: usize = 20;
let const_type = &const_param.unwrap().1.ty;
let generic_benches = options.generic.types_iter().map(|ty| {
let generic_benches = (0..MAX_EXTERN_COUNT).map(move |i| {
let const_value = quote! {
// Fallback to the first constant if out of bounds.
__DIVAN_CONSTS[if #i < __DIVAN_CONST_COUNT { #i } else { 0 }]
};
make_generic_bench_entry(ty, Some(&const_value))
});
// `static` is necessary because `EntryConst` uses interior
// mutability to cache the `ToString` result.
quote! {
static __DIVAN_GENERIC_BENCHES: [#private_mod::GenericBenchEntry; __DIVAN_CONST_COUNT]
= match #private_mod::shrink_array([#(#generic_benches),*]) {
#private_mod::Some(array) => array,
_ => panic!("external 'consts' cannot contain more than 20 values"),
};
&__DIVAN_GENERIC_BENCHES
}
});
make_generic_group(quote! {
const __DIVAN_CONST_COUNT: usize = __DIVAN_CONSTS.len();
const __DIVAN_CONSTS: &[#const_type] = &#generic_consts;
&[#({ #generic_benches }),*]
})
}
};
// Append our generated code to the existing token stream.
let mut result = item;
result.extend(TokenStream::from(generated_items));
result
}
#[proc_macro_attribute]
pub fn bench_group(options: TokenStream, item: TokenStream) -> TokenStream {
let options = match AttrOptions::parse(options, Macro::BenchGroup) {
Ok(options) => options,
Err(compile_error) => return compile_error,
};
// Items needed by generated code.
let AttrOptions { private_mod, linkme_crate, .. } = &options;
// TODO: Make module parsing cheaper by parsing only the necessary parts.
let mod_item = item.clone();
let mod_item = syn::parse_macro_input!(mod_item as syn::ItemMod);
let mod_ident = &mod_item.ident;
let mod_name = mod_ident.to_string();
let mod_name_pretty = mod_name.strip_prefix("r#").unwrap_or(&mod_name);
// Find any `#[ignore]` attribute so that we can use its span to help
// compiler diagnostics.
//
// TODO: Fix `unused_attributes` warning when using `#[ignore]` on a module.
let ignore_attr_ident =
mod_item.attrs.iter().map(|attr| attr.meta.path()).find(|path| path.is_ident("ignore"));
// Prefixed with "__" to prevent IDEs from recommending using this symbol.
//
// By having the static be local, we cause a compile error if this attribute
// is used multiple times on the same function.
let static_ident = syn::Ident::new(
&format!("__DIVAN_GROUP_{}", mod_name_pretty.to_uppercase()),
mod_ident.span(),
);
let meta = entry_meta_expr(&mod_name, &options, ignore_attr_ident);
let entry_static = quote! {
static #static_ident: #private_mod::GroupEntry = #private_mod::GroupEntry {
meta: #meta,
generic_benches: #private_mod::None,
};
};
let generated_items = quote! {
// Use a distributed slice via `linkme` by default.
#[cfg(not(windows))]
#[#linkme_crate::distributed_slice(#private_mod::GROUP_ENTRIES)]
#[linkme(crate = #linkme_crate)]
#[doc(hidden)]
#entry_static
// On other platforms we push this static into `GROUP_ENTRIES` before
// `main` is called.
#[cfg(windows)]
static #static_ident: #private_mod::EntryList<#private_mod::GroupEntry> = {
{
// Add `push` to the initializer section.
#[used]
#[link_section = ".CRT$XCU"]
static PUSH: extern "C" fn() = push;
extern "C" fn push() {
#private_mod::GROUP_ENTRIES.push(&#static_ident);
}
}
#private_mod::EntryList::new({
#entry_static
&#static_ident
})
};
};
// Append our generated code to the existing token stream.
let mut result = item;
result.extend(TokenStream::from(generated_items));
result
}
/// Constructs an `EntryMeta` expression.
fn entry_meta_expr(
raw_name: &str,
options: &AttrOptions,
ignore_attr_ident: Option<&syn::Path>,
) -> proc_macro2::TokenStream {
let AttrOptions { private_mod, std_crate, .. } = &options;
let raw_name_pretty = raw_name.strip_prefix("r#").unwrap_or(raw_name);
let display_name: &dyn ToTokens = match &options.name_expr {
Some(name) => name,
None => &raw_name_pretty,
};
let bench_options_fn = options.bench_options_fn(ignore_attr_ident);
quote! {
#private_mod::EntryMeta {
raw_name: #raw_name,
display_name: #display_name,
module_path: #std_crate::module_path!(),
// `Span` location info is nightly-only, so use macros.
location: #private_mod::EntryLocation {
file: #std_crate::file!(),
line: #std_crate::line!(),
col: #std_crate::column!(),
},
get_bench_options: #bench_options_fn,
cached_bench_options: #private_mod::OnceLock::new(),
}
}
}