Gather compilation statistics

benches/compile_time.rs

@@ -15,7 +15,7 @@ pub fn bench_compile_time(c: &mut Criterion) {
                 b.iter(|| {
                     let native_context = NativeContext::new();
                     native_context
-                        .compile(program, false, Some(Default::default()))
+                        .compile(program, false, Some(Default::default()), None)
                         .unwrap();
                     // pass manager internally verifies the MLIR output is correct.
                 })
@@ -32,7 +32,7 @@ pub fn bench_compile_time(c: &mut Criterion) {
             c.bench_with_input(BenchmarkId::new(filename, 1), &program, |b, program| {
                 b.iter(|| {
                     native_context
-                        .compile(program, false, Some(Default::default()))
+                        .compile(program, false, Some(Default::default()), None)
                         .unwrap();
                     // pass manager internally verifies the MLIR output is correct.
                 })
@@ -48,9 +48,9 @@ pub fn bench_compile_time(c: &mut Criterion) {
                 b.iter(|| {
                     let native_context = NativeContext::new();
                     let module = native_context
-                        .compile(black_box(program), false, Some(Default::default()))
+                        .compile(black_box(program), false, Some(Default::default()), None)
                         .unwrap();
-                    let object = module_to_object(module.module(), OptLevel::None)
+                    let object = module_to_object(module.module(), OptLevel::None, None)
                         .expect("to compile correctly to a object file");
                     black_box(object)
                 })
@@ -67,9 +67,9 @@ pub fn bench_compile_time(c: &mut Criterion) {
             c.bench_with_input(BenchmarkId::new(filename, 1), &program, |b, program| {
                 b.iter(|| {
                     let module = native_context
-                        .compile(black_box(program), false, Some(Default::default()))
+                        .compile(black_box(program), false, Some(Default::default()), None)
                         .unwrap();
-                    let object = module_to_object(module.module(), OptLevel::None)
+                    let object = module_to_object(module.module(), OptLevel::None, None)
                         .expect("to compile correctly to a object file");
                     black_box(object)
                 })
@@ -86,9 +86,9 @@ pub fn bench_compile_time(c: &mut Criterion) {
             c.bench_with_input(BenchmarkId::new(filename, 1), &program, |b, program| {
                 b.iter(|| {
                     let module = native_context
-                        .compile(black_box(program), false, Some(Default::default()))
+                        .compile(black_box(program), false, Some(Default::default()), None)
                         .unwrap();
-                    let object = module_to_object(module.module(), OptLevel::Aggressive)
+                    let object = module_to_object(module.module(), OptLevel::Aggressive, None)
                         .expect("to compile correctly to a object file");
                     black_box(object)
                 })

benches/libfuncs.rs

@@ -55,7 +55,7 @@ pub fn bench_libfuncs(c: &mut Criterion) {
                     let native_context = NativeContext::new();
                     b.iter(|| {
                         let module = native_context
-                            .compile(program, false, Some(Default::default()))
+                            .compile(program, false, Some(Default::default()), None)
                             .unwrap();
                         // pass manager internally verifies the MLIR output is correct.
                         let native_executor =
@@ -77,7 +77,7 @@ pub fn bench_libfuncs(c: &mut Criterion) {
                 |b, program| {
                     let native_context = NativeContext::new();
                     let module = native_context
-                        .compile(program, false, Some(Default::default()))
+                        .compile(program, false, Some(Default::default()), None)
                         .unwrap();
                     // pass manager internally verifies the MLIR output is correct.
                     let native_executor =
@@ -108,7 +108,7 @@ pub fn bench_libfuncs(c: &mut Criterion) {
                     let native_context = NativeContext::new();
                     b.iter(|| {
                         let module = native_context
-                            .compile(program, false, Some(Default::default()))
+                            .compile(program, false, Some(Default::default()), None)
                             .unwrap();
                         // pass manager internally verifies the MLIR output is correct.
                         let native_executor =
@@ -130,7 +130,7 @@ pub fn bench_libfuncs(c: &mut Criterion) {
                 |b, program| {
                     let native_context = NativeContext::new();
                     let module = native_context
-                        .compile(program, false, Some(Default::default()))
+                        .compile(program, false, Some(Default::default()), None)
                         .unwrap();
                     // pass manager internally verifies the MLIR output is correct.
                     let native_executor =

examples/easy_api.rs

@@ -16,7 +16,7 @@ fn main() {
 
     // Compile the sierra program into a MLIR module.
     let native_program = native_context
-        .compile(&sierra_program, false, Some(Default::default()))
+        .compile(&sierra_program, false, Some(Default::default()), None)
         .unwrap();
 
     // The parameters of the entry point.

examples/erc20.rs

@@ -322,7 +322,7 @@ fn main() {
     let native_context = NativeContext::new();
 
     let native_program = native_context
-        .compile(&sierra_program, false, Some(Default::default()))
+        .compile(&sierra_program, false, Some(Default::default()), None)
         .unwrap();
 
     let entry_point_fn =

examples/invoke.rs

@@ -21,7 +21,7 @@ fn main() {
     let native_context = NativeContext::new();
 
     let native_program = native_context
-        .compile(&sierra_program, false, Some(Default::default()))
+        .compile(&sierra_program, false, Some(Default::default()), None)
         .unwrap();
 
     // Call the echo function from the contract using the generated wrapper.

examples/starknet.rs

@@ -456,7 +456,7 @@ fn main() {
     let native_context = NativeContext::new();
 
     let native_program = native_context
-        .compile(&sierra_program, false, Some(Default::default()))
+        .compile(&sierra_program, false, Some(Default::default()), None)
         .unwrap();
 
     // Call the echo function from the contract using the generated wrapper.

src/bin/cairo-native-compile.rs

@@ -56,7 +56,7 @@ fn main() -> anyhow::Result<()> {
 
     // Compile the sierra program into a MLIR module.
     let native_module = native_context
-        .compile(&sierra_program, false, Some(Default::default()))
+        .compile(&sierra_program, false, Some(Default::default()), None)
         .unwrap();
 
     let output_mlir = args
@@ -79,9 +79,10 @@ fn main() -> anyhow::Result<()> {
         })
     });
 
-    let object_data = module_to_object(native_module.module(), args.opt_level.into())
+    let object_data = module_to_object(native_module.module(), args.opt_level.into(), None)
         .context("Failed to convert module to object.")?;
-    object_to_shared_lib(&object_data, &output_lib).context("Failed to write shared library.")?;
+    object_to_shared_lib(&object_data, &output_lib, None)
+        .context("Failed to write shared library.")?;
 
     Ok(())
 }

src/bin/cairo-native-dump.rs

@@ -35,7 +35,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
     let program = load_program(Path::new(&args.input), args.starknet)?;
 
     // Compile the program.
-    let module = context.compile(&program, false, Some(Default::default()))?;
+    let module = context.compile(&program, false, Some(Default::default()), None)?;
 
     // Write the output.
     let output_str = module

src/bin/cairo-native-run.rs

@@ -92,7 +92,7 @@ fn main() -> anyhow::Result<()> {
 
     // Compile the sierra program into a MLIR module.
     let native_module = native_context
-        .compile(&sierra_program, false, Some(Default::default()))
+        .compile(&sierra_program, false, Some(Default::default()), None)
         .unwrap();
 
     let native_executor: Box<dyn Fn(_, _, _, &mut StubSyscallHandler) -> _> = match args.run_mode {

src/bin/cairo-native-stress/main.rs

@@ -280,7 +280,7 @@ where
     ) -> Arc<AotNativeExecutor> {
         let native_module = self
             .context
-            .compile(program, false, Some(Default::default()))
+            .compile(program, false, Some(Default::default()), None)
             .expect("failed to compile program");
 
         let registry = ProgramRegistry::new(program).expect("failed to get program registry");
@@ -291,15 +291,15 @@ where
             .expect("module should have gas metadata");
 
         let shared_library = {
-            let object_data = module_to_object(native_module.module(), opt_level)
+            let object_data = module_to_object(native_module.module(), opt_level, None)
                 .expect("failed to convert MLIR to object");
 
             let shared_library_dir = Path::new(AOT_CACHE_DIR);
             create_dir_all(shared_library_dir).expect("failed to create shared library directory");
             let shared_library_name = format!("lib{key}{SHARED_LIBRARY_EXT}");
             let shared_library_path = shared_library_dir.join(shared_library_name);
 
-            object_to_shared_lib(&object_data, &shared_library_path)
+            object_to_shared_lib(&object_data, &shared_library_path, None)
                 .expect("failed to link object into shared library");
 
             unsafe {

src/bin/scarb-native-dump.rs

@@ -41,6 +41,7 @@ fn main() -> anyhow::Result<()> {
                         &compiled.into_v1().unwrap().program,
                         false,
                         Some(Default::default()),
+                        None,
                     )
                     .unwrap();
 

src/bin/utils/test.rs

@@ -138,7 +138,7 @@ pub fn run_tests(
 
     // Compile the sierra program into a MLIR module.
     let native_module = native_context
-        .compile(&sierra_program, false, Some(Default::default()))
+        .compile(&sierra_program, false, Some(Default::default()), None)
         .unwrap();
 
     let native_executor: Box<dyn Fn(_, _, _, &mut StubSyscallHandler) -> _> = match args.run_mode {

src/cache/aot.rs

@@ -47,18 +47,18 @@ where
             mut metadata,
         } = self
             .context
-            .compile(program, false, Some(Default::default()))?;
+            .compile(program, false, Some(Default::default()), None)?;
 
         // Compile module into an object.
-        let object_data = crate::ffi::module_to_object(&module, opt_level)?;
+        let object_data = crate::ffi::module_to_object(&module, opt_level, None)?;
 
         // Compile object into a shared library.
         let shared_library_path = tempfile::Builder::new()
             .prefix("lib")
             .suffix(SHARED_LIBRARY_EXT)
             .tempfile()?
             .into_temp_path();
-        crate::ffi::object_to_shared_lib(&object_data, &shared_library_path)?;
+        crate::ffi::object_to_shared_lib(&object_data, &shared_library_path, None)?;
 
         let shared_library = unsafe { Library::new(shared_library_path)? };
         let executor = AotNativeExecutor::new(

src/cache/jit.rs

@@ -48,7 +48,7 @@ where
     ) -> Result<Arc<JitNativeExecutor<'a>>> {
         let module = self
             .context
-            .compile(program, false, Some(Default::default()))?;
+            .compile(program, false, Some(Default::default()), None)?;
         let executor = JitNativeExecutor::from_native_module(module, opt_level)?;
 
         let executor = Arc::new(executor);

src/context.rs

@@ -4,6 +4,7 @@ use crate::{
     metadata::{gas::GasMetadata, runtime_bindings::RuntimeBindingsMeta, MetadataStorage},
     module::NativeModule,
     native_assert,
+    statistics::Statistics,
     utils::run_pass_manager,
 };
 use cairo_lang_sierra::{
@@ -32,7 +33,6 @@ use mlir_sys::{
     MlirLLVMDINameTableKind_MlirLLVMDINameTableKindDefault,
 };
 use std::{sync::OnceLock, time::Instant};
-use tracing::trace;
 
 /// Context of IRs, dialects and passes for Cairo programs compilation.
 #[derive(Debug, Eq, PartialEq)]
@@ -69,10 +69,8 @@ impl NativeContext {
         program: &Program,
         ignore_debug_names: bool,
         gas_metadata_config: Option<MetadataComputationConfig>,
+        stats: Option<&mut Statistics>,
     ) -> Result<NativeModule, Error> {
-        trace!("starting sierra to mlir compilation");
-        let pre_sierra_compilation_instant = Instant::now();
-
         static INITIALIZED: OnceLock<()> = OnceLock::new();
         INITIALIZED.get_or_init(|| unsafe {
             LLVM_InitializeAllTargets();
@@ -167,6 +165,7 @@ impl NativeContext {
         // Create the Sierra program registry
         let registry = ProgramRegistry::<CoreType, CoreLibfunc>::new(program)?;
 
+        let pre_sierra_to_mlir_instant = Instant::now();
         crate::compile(
             &self.context,
             &module,
@@ -176,12 +175,10 @@ impl NativeContext {
             unsafe { Attribute::from_raw(di_unit_id) },
             ignore_debug_names,
         )?;
-
-        let sierra_compilation_time = pre_sierra_compilation_instant.elapsed().as_millis();
-        trace!(
-            time = sierra_compilation_time,
-            "sierra to mlir compilation finished"
-        );
+        let sierra_to_mlir_time = pre_sierra_to_mlir_instant.elapsed().as_millis();
+        if let Some(&mut ref mut stats) = stats {
+            stats.compilation_sierra_to_mlir_time_ms = Some(sierra_to_mlir_time);
+        }
 
         if let Ok(x) = std::env::var("NATIVE_DEBUG_DUMP") {
             if x == "1" || x == "true" {
@@ -201,11 +198,12 @@ impl NativeContext {
             }
         }
 
-        trace!("starting mlir passes");
-        let pre_passes_instant = Instant::now();
+        let pre_mlir_passes_instant = Instant::now();
         run_pass_manager(&self.context, &mut module)?;
-        let passes_time = pre_passes_instant.elapsed().as_millis();
-        trace!(time = passes_time, "mlir passes finished");
+        let mlir_passes_time = pre_mlir_passes_instant.elapsed().as_millis();
+        if let Some(&mut ref mut stats) = stats {
+            stats.compilation_mlir_passes_time_ms = Some(mlir_passes_time);
+        }
 
         if let Ok(x) = std::env::var("NATIVE_DEBUG_DUMP") {
             if x == "1" || x == "true" {

src/executor.rs

@@ -720,7 +720,7 @@ mod tests {
     fn test_invoke_dynamic_aot_native_executor(program: Program) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&program, false, Some(Default::default()))
+            .compile(&program, false, Some(Default::default()), None)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, OptLevel::default()).unwrap();
 
@@ -738,7 +738,7 @@ mod tests {
     fn test_invoke_dynamic_jit_native_executor(program: Program) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&program, false, None)
+            .compile(&program, false, None, None)
             .expect("failed to compile context");
         let executor = JitNativeExecutor::from_native_module(module, OptLevel::default()).unwrap();
 
@@ -756,7 +756,7 @@ mod tests {
     fn test_invoke_contract_dynamic_aot(starknet_program: Program) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&starknet_program, false, Some(Default::default()))
+            .compile(&starknet_program, false, Some(Default::default()), None)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, OptLevel::default()).unwrap();
 
@@ -788,7 +788,7 @@ mod tests {
     fn test_invoke_contract_dynamic_jit(starknet_program: Program) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&starknet_program, false, Some(Default::default()))
+            .compile(&starknet_program, false, Some(Default::default()), None)
             .expect("failed to compile context");
         let executor = JitNativeExecutor::from_native_module(module, OptLevel::default()).unwrap();
 

src/executor/aot.rs

@@ -76,8 +76,8 @@ impl AotNativeExecutor {
             .keep()
             .map_err(io::Error::from)?;
 
-        let object_data = crate::module_to_object(&module, opt_level)?;
-        crate::object_to_shared_lib(&object_data, &library_path)?;
+        let object_data = crate::module_to_object(&module, opt_level, None)?;
+        crate::object_to_shared_lib(&object_data, &library_path, None)?;
 
         Ok(Self::new(
             unsafe { Library::new(&library_path)? },
@@ -257,7 +257,7 @@ mod tests {
     fn test_invoke_dynamic(program: Program, #[case] optlevel: OptLevel) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&program, false, Some(Default::default()))
+            .compile(&program, false, Some(Default::default()), None)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, optlevel).unwrap();
 
@@ -278,7 +278,7 @@ mod tests {
     fn test_invoke_dynamic_with_syscall_handler(program: Program, #[case] optlevel: OptLevel) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&program, false, Some(Default::default()))
+            .compile(&program, false, Some(Default::default()), None)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, optlevel).unwrap();
 
@@ -317,7 +317,7 @@ mod tests {
     fn test_invoke_contract_dynamic(starknet_program: Program, #[case] optlevel: OptLevel) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&starknet_program, false, Some(Default::default()))
+            .compile(&starknet_program, false, Some(Default::default()), None)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, optlevel).unwrap();