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
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
#![allow(clippy::module_name_repetitions)]
use std::result::Result;
use proc_macro::TokenStream;
use quote::quote;
use syn::{
parse::{Parse, ParseStream},
parse_macro_input,
punctuated::Punctuated,
Ident, ItemFn, Token,
};
#[derive(Default, PartialEq, Eq)]
pub enum ProfilingMode {
Runtime, // Check environment variable at runtime
#[default]
Enabled, // Always enabled
Disabled, // Always disabled
}
/// Configuration for `enable_profiling` attribute macro
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub enum ProfileType {
Time, // Wall clock/elapsed time
Memory,
#[default]
Both,
#[allow(dead_code)]
None, // This variant is used in the codebase even though the diagnostic says otherwise
}
// Function-level profiling arguments, similar to #[profiled] macro
#[derive(Default)]
#[allow(clippy::struct_excessive_bools)]
struct FunctionProfileArgs {
/// Flag for time profiling
time: bool,
/// Flag for memory summary profiling
mem_summary: bool,
/// Flag for detailed memory profiling
mem_detail: bool,
/// Flag for both time and memory profiling
both: bool,
/// Flag for using global profiling settings
global: bool,
/// Flag to suppress profiling of the current function
none: bool,
/// Flag for creating profile clone for testing
test: bool,
}
impl Parse for FunctionProfileArgs {
fn parse(input: ParseStream) -> Result<Self, syn::Error> {
let mut args = Self::default();
// Handle empty case
if input.is_empty() {
args.global = true; // Default to global if no args specified
return Ok(args);
}
// Parse as a list of flags
let flags = Punctuated::<Ident, Token![,]>::parse_terminated(input)?;
for flag in flags {
match flag.to_string().as_str() {
"time" => args.time = true,
"mem_summary" => args.mem_summary = true,
"mem_detail" => args.mem_detail = true,
"both" => args.both = true,
"global" => args.global = true,
"none" => args.none = true,
"test" => args.test = true,
_ => {
return Err(syn::Error::new(
flag.span(),
format!("unknown function profiling flag: {flag}"),
));
}
}
}
// If no profiling type was specified, default to global
if !args.none
&& !args.time
&& !args.mem_summary
&& !args.mem_detail
&& !args.both
&& !args.global
{
args.global = true;
}
Ok(args)
}
}
/// Configuration for `enable_profiling` attribute macro
#[derive(Default)]
struct ProfilingArgs {
mode: ProfilingMode,
profile_type: Option<ProfileType>,
function_args: Option<FunctionProfileArgs>,
}
impl Parse for ProfilingArgs {
fn parse(input: ParseStream) -> Result<Self, syn::Error> {
// Empty input means use default
#[cfg(not(feature = "full_profiling"))]
if input.is_empty() {
return Ok(Self {
mode: ProfilingMode::Enabled,
profile_type: Some(ProfileType::Time),
function_args: None,
});
}
#[cfg(feature = "full_profiling")]
if input.is_empty() {
return Ok(Self {
mode: ProfilingMode::Enabled,
profile_type: Some(ProfileType::Both),
function_args: None,
});
}
let mut result = Self::default();
let mut mode_set = false;
// Parse as a comma-separated list of parameters
while !input.is_empty() {
if !input.peek(Ident) {
return Err(syn::Error::new(input.span(), "Expected identifier"));
}
let ident: Ident = input.parse()?;
let param_name = ident.to_string();
if param_name == "function" {
// Parse function-level parameters in parentheses
let content;
syn::parenthesized!(content in input);
result.function_args = Some(content.parse()?);
} else {
// Handle global parameters
match param_name.as_str() {
"no" => {
result.mode = ProfilingMode::Disabled;
mode_set = true;
}
"runtime" => {
result.mode = ProfilingMode::Runtime;
mode_set = true;
}
"both" => {
result.profile_type = Some(ProfileType::Both);
if !mode_set {
result.mode = ProfilingMode::Enabled;
mode_set = true;
}
}
"yes" => {
result.mode = ProfilingMode::Enabled;
#[cfg(feature = "full_profiling")]
{
result.profile_type = Some(ProfileType::Both);
}
#[cfg(not(feature = "full_profiling"))]
{
result.profile_type = Some(ProfileType::Time);
}
mode_set = true;
}
"memory" => {
result.profile_type = Some(ProfileType::Memory);
if !mode_set {
result.mode = ProfilingMode::Enabled;
mode_set = true;
}
}
"time" => {
result.profile_type = Some(ProfileType::Time);
if !mode_set {
result.mode = ProfilingMode::Enabled;
mode_set = true;
}
}
_ => {
return Err(syn::Error::new(
ident.span(),
format!("Unknown parameter: {param_name}. Expected 'memory', 'time', 'both', 'runtime', 'yes', 'no' or 'function(...)'")
));
}
}
}
// Check for comma separator unless we're at the end
if !input.is_empty() {
input.parse::<Token![,]>()?;
}
}
Ok(result)
}
}
/// Detect if a function body appears to have been transformed by `tokio::main`
fn detect_tokio_main_expansion(body: &syn::Block) -> bool {
// Look for patterns like: let body = async { ... }
for stmt in &body.stmts {
if let syn::Stmt::Local(local) = stmt {
// Check if this is a "let body = ..." statement
if let syn::Pat::Ident(pat_ident) = &local.pat {
if pat_ident.ident == "body" {
// Check if it's assigned an async expression
if let Some(init) = &local.init {
if let syn::Expr::Async(_) = &*init.expr {
return true;
}
}
}
}
}
}
// Alternative approach: look for tokio runtime initialization
let body_str = quote!(#body).to_string();
body_str.contains("tokio::runtime")
|| body_str.contains("Runtime::new")
|| body_str.contains("let body = async") // Simpler string-based detection
}
#[allow(clippy::too_many_lines)]
pub fn enable_profiling_impl(attr: TokenStream, item: TokenStream) -> TokenStream {
assert!(cfg!(feature = "time_profiling"));
let args = parse_macro_input!(attr as ProfilingArgs);
// #[enabled(no)] specified
if args.mode == ProfilingMode::Disabled {
return item;
}
let input = parse_macro_input!(item as ItemFn);
// Check if the function is explicitly async
let is_explicitly_async = input.sig.asyncness.is_some();
// Check if the function body appears to have been transformed by tokio::main
let is_tokio_transformed = detect_tokio_main_expansion(&input.block);
// Function is async if it's either explicitly marked async or shows signs of tokio transformation
let is_async = is_explicitly_async || is_tokio_transformed;
// Get function details
let fn_name = &input.sig.ident;
let inputs = &input.sig.inputs;
let output = &input.sig.output;
let generics = &input.sig.generics;
let where_clause = &input.sig.generics.where_clause;
let vis = &input.vis;
let block = &input.block;
let attrs = &input.attrs;
for attr in attrs {
assert_ne!(
quote!(#attr).to_string().as_str(),
"#[async_std :: main]",
"#[async_std::main] if present must appear before #[enable_profiling] for correct expansion."
);
assert_ne!(
quote!(#attr).to_string().as_str(),
"#[tokio :: main]",
"#[tokio::main] if present must appear before #[enable_profiling] for correct expansion."
);
}
let fn_name_str = fn_name.to_string();
// Determine if detailed memory profiling is enabled from function args
let is_detailed_memory = args
.function_args
.as_ref()
.is_some_and(|fn_args| fn_args.mem_detail);
let profile_this_fn = args.function_args.as_ref().map_or_else(
|| {
// eprintln!("In default, returning true");
true
},
|fn_args| !fn_args.none,
);
// Function profiling type
#[allow(unused_variables)]
let function_profile_type = args.function_args.as_ref().map_or_else(
|| quote! { ::thag_profiler::get_global_profile_type() },
|fn_args| {
#[cfg(feature = "full_profiling")]
let profile_type =
if fn_args.both || (fn_args.time && (fn_args.mem_summary || fn_args.mem_detail)) {
quote! { ::thag_profiler::ProfileType::Both }
} else if fn_args.time {
quote! { ::thag_profiler::ProfileType::Time }
} else if fn_args.mem_summary || fn_args.mem_detail {
quote! { ::thag_profiler::ProfileType::Memory }
} else if fn_args.none {
quote! { ::thag_profiler::ProfileType::None }
} else {
// Default to global
quote! { ::thag_profiler::get_global_profile_type() }
};
// // When not using full_profiling, always use Time regardless of memory settings
// #[cfg(not(feature = "full_profiling"))]
// let profile_type = quote! { ::thag_profiler::ProfileType::Time };
// profile_type
// });
// When not using full_profiling, always use Time regardless of memory settings
#[cfg(not(feature = "full_profiling"))]
let profile_type = if profile_this_fn {
quote! { ::thag_profiler::ProfileType::Time }
} else {
quote! { ::thag_profiler::ProfileType::None }
};
profile_type
},
);
let profile_new = if profile_this_fn {
quote! {
::thag_profiler::Profile::new(None, Some(#fn_name_str), #function_profile_type, #is_async, #is_detailed_memory, file!(), None, None)
}
} else {
quote! {}
};
#[cfg(not(feature = "full_profiling"))]
let profile_drop = if profile_this_fn {
quote! {
drop(profile);
}
} else {
quote! {}
};
#[cfg(feature = "full_profiling")]
let profile_drop = if profile_this_fn {
quote! {
::thag_profiler::safe_alloc!(drop(profile););
}
} else {
quote! {}
};
#[cfg(not(feature = "full_profiling"))]
let profile_init = match args.mode {
ProfilingMode::Runtime => {
quote! {
use ::thag_profiler::{finalize_profiling, init_profiling, parse_env_profile_config, PROFILING_MUTEX};
let should_profile = std::env::var("THAG_PROFILER").ok().is_some();
// eprintln!("should_profile={should_profile}");
}
}
ProfilingMode::Enabled => {
quote! {
use thag_profiler::{disable_profiling, finalize_profiling, init_profiling, ProfileConfiguration, ProfileType, PROFILING_MUTEX};
}
}
ProfilingMode::Disabled => {
quote! {}
}
};
#[cfg(feature = "full_profiling")]
let profile_init = match args.mode {
ProfilingMode::Runtime => {
quote! {
use ::thag_profiler::{compare_exchange_using_system, finalize_profiling, init_profiling, mem_tracking, parse_env_profile_config, set_using_system, Allocator, PROFILING_MUTEX};
let should_profile = ::thag_profiler::safe_alloc! {
std::env::var("THAG_PROFILER").ok().is_some()
};
// ::thag_profiler::safe_alloc! {
// eprintln!("should_profile={should_profile}");
// };
}
}
ProfilingMode::Enabled => {
quote! {
use ::thag_profiler::{compare_exchange_using_system, disable_profiling, finalize_profiling, init_profiling, mem_tracking, profiled, set_using_system, Allocator, ProfileConfiguration, ProfileType, PROFILING_MUTEX};
}
}
ProfilingMode::Disabled => {
quote! {}
}
};
let profile_finalize = match args.mode {
ProfilingMode::Runtime => {
quote! {
if should_profile {
// Drop the profile explicitly at the end
if let Some(profile) = maybe_profile {
#profile_drop
}
// Finalize profiling
finalize_profiling(); // Already uses safe_alloc(... internally
}
}
}
ProfilingMode::Enabled => {
quote! {
// Drop the profile explicitly at the end
#profile_drop
// Finalize profiling
finalize_profiling(); // Already uses safe_alloc(... internally
}
}
ProfilingMode::Disabled => {
quote! {}
}
};
let async_token = if is_async && !(fn_name == "main" && is_tokio_transformed) {
quote!(async)
} else {
quote!()
};
let wrapped_block = if is_async && !(fn_name == "main" && is_tokio_transformed) {
quote! {
// For async functions, we need to use an async block
let result = async {
#block
}.await;
}
} else {
quote! {
let result = (|| {
#block
})();
}
};
// Verbosity is the price we pay for having to replicate the enum.
let profile_type = match args.profile_type {
Some(ProfileType::Both) => quote! {
Some(ProfileType::Both)
},
Some(ProfileType::Memory) => quote! {
Some(ProfileType::Memory)
},
Some(ProfileType::Time) => quote! {
Some(ProfileType::Time)
},
Some(ProfileType::None) | None => quote! {
None
},
};
#[cfg(not(feature = "full_profiling"))]
let wrapped_block = match args.mode {
ProfilingMode::Runtime => quote! {
let _guard = if should_profile {
// Acquire the mutex to ensure only one instance can be profiling at a time
Some(PROFILING_MUTEX.lock())
} else {None};
if should_profile {
let profile_config = parse_env_profile_config().expect("Error parsing environment variable THAG_PROFILER");
// eprintln!("Calling init_profiling({}, {:?})", module_path!(), profile_config.profile_type));
// let profile_type = profile_config.profile_type.expect("Error parsing profile type from environment variable THAG_PROFILER");
init_profiling(module_path!(), profile_config.profile_type());
}
let maybe_profile = if should_profile {
#profile_new
} else {
None
};
#wrapped_block
},
ProfilingMode::Enabled => {
let profile_clause = if profile_this_fn {
quote! {
let profile = #profile_new;
}
} else {
quote! {}
};
quote! {
// Acquire the mutex to ensure only one instance can be profiling at a time
let _guard = PROFILING_MUTEX.lock();
// Initialize profiling
let mut profile_config = ProfileConfiguration::default();
profile_config.set_profile_type(#profile_type);
init_profiling(module_path!(), #profile_type);
#profile_clause
#wrapped_block
}
}
ProfilingMode::Disabled => unreachable!(),
};
#[cfg(feature = "full_profiling")]
let wrapped_block = match args.mode {
ProfilingMode::Runtime => quote! {
let _guard = ::thag_profiler::safe_alloc! {
if should_profile {
// Acquire the mutex to ensure only one instance can be profiling at a time
Some(PROFILING_MUTEX.lock())
} else {None}
};
if should_profile {
let profile_config = parse_env_profile_config().expect("Error parsing environment variable THAG_PROFILER");
// let profile_type = profile_config.profile_type.expect("Error parsing profile type from environment variable THAG_PROFILER");
init_profiling(module_path!(), profile_config.profile_type());
}
let maybe_profile = ::thag_profiler::safe_alloc! {
if should_profile {
#profile_new
} else {
None
}
};
#wrapped_block
},
ProfilingMode::Enabled => {
let profile_clause = if profile_this_fn {
quote! {
let profile = ::thag_profiler::safe_alloc! {
#profile_new
};
}
} else {
quote! {}
};
quote! {
// Acquire the mutex to ensure only one instance can be profiling at a time
let _guard = ::thag_profiler::safe_alloc! {
PROFILING_MUTEX.lock()
};
// Initialize profiling
let profile_config = ::thag_profiler::safe_alloc! {
// ProfileConfiguration { profile_type: #profile_type, ..Default::default() };
let mut profile_config = ProfileConfiguration::default();
profile_config.set_profile_type(#profile_type);
profile_config
};
init_profiling(module_path!(), #profile_type); // Already uses ::thag_profiler::safe_alloc!(... internally
#profile_clause
#wrapped_block
}
}
ProfilingMode::Disabled => unreachable!(),
};
let result = quote! {
#(#attrs)*
#vis #async_token fn #fn_name #generics(#inputs) #output #where_clause {
#profile_init
#wrapped_block
#profile_finalize
result
}
};
result.into()
}