Add option to never have debug names in functions and enable it on ContractExecutor, fix danling temp library file (#794)

edg-l · pefontana · web-flow · commit 0eb9d45d07b5 · 2024-09-19T13:25:22.000Z
Co-authored-by: Pedro Fontana &lt;fontana.pedro93@gmail.com&gt;
diff --git a/benches/compile_time.rs b/benches/compile_time.rs
@@ -14,7 +14,7 @@ pub fn bench_compile_time(c: &mut Criterion) {
             c.bench_with_input(BenchmarkId::new(filename, 1), &program, |b, program| {
                 b.iter(|| {
                     let native_context = NativeContext::new();
-                    native_context.compile(program).unwrap();
+                    native_context.compile(program, false).unwrap();
                     // pass manager internally verifies the MLIR output is correct.
                 })
             });
@@ -29,7 +29,7 @@ pub fn bench_compile_time(c: &mut Criterion) {
         for (program, filename) in &programs {
             c.bench_with_input(BenchmarkId::new(filename, 1), &program, |b, program| {
                 b.iter(|| {
-                    native_context.compile(program).unwrap();
+                    native_context.compile(program, false).unwrap();
                     // pass manager internally verifies the MLIR output is correct.
                 })
             });
@@ -43,7 +43,7 @@ pub fn bench_compile_time(c: &mut Criterion) {
             c.bench_with_input(BenchmarkId::new(filename, 1), &program, |b, program| {
                 b.iter(|| {
                     let native_context = NativeContext::new();
-                    let module = native_context.compile(black_box(program)).unwrap();
+                    let module = native_context.compile(black_box(program), false).unwrap();
                     let object = module_to_object(module.module(), OptLevel::None)
                         .expect("to compile correctly to a object file");
                     black_box(object)
@@ -60,7 +60,7 @@ pub fn bench_compile_time(c: &mut Criterion) {
         for (program, filename) in &programs {
             c.bench_with_input(BenchmarkId::new(filename, 1), &program, |b, program| {
                 b.iter(|| {
-                    let module = native_context.compile(black_box(program)).unwrap();
+                    let module = native_context.compile(black_box(program), false).unwrap();
                     let object = module_to_object(module.module(), OptLevel::None)
                         .expect("to compile correctly to a object file");
                     black_box(object)
diff --git a/benches/libfuncs.rs b/benches/libfuncs.rs
@@ -50,7 +50,7 @@ pub fn bench_libfuncs(c: &mut Criterion) {
                 |b, program| {
                     let native_context = NativeContext::new();
                     b.iter(|| {
-                        let module = native_context.compile(program).unwrap();
+                        let module = native_context.compile(program, false).unwrap();
                         // pass manager internally verifies the MLIR output is correct.
                         let native_executor =
                             JitNativeExecutor::from_native_module(module, Default::default());
@@ -69,7 +69,7 @@ pub fn bench_libfuncs(c: &mut Criterion) {
                 program,
                 |b, program| {
                     let native_context = NativeContext::new();
-                    let module = native_context.compile(program).unwrap();
+                    let module = native_context.compile(program, false).unwrap();
                     // pass manager internally verifies the MLIR output is correct.
                     let native_executor =
                         JitNativeExecutor::from_native_module(module, Default::default());
diff --git a/examples/easy_api.rs b/examples/easy_api.rs
@@ -15,7 +15,7 @@ fn main() {
     let sierra_program = cairo_to_sierra(program_path);
 
     // Compile the sierra program into a MLIR module.
-    let native_program = native_context.compile(&sierra_program).unwrap();
+    let native_program = native_context.compile(&sierra_program, false).unwrap();
 
     // The parameters of the entry point.
     let params = &[JitValue::Felt252(Felt::from_bytes_be_slice(b"user"))];
diff --git a/examples/erc20.rs b/examples/erc20.rs
@@ -305,7 +305,7 @@ fn main() {
 
     let native_context = NativeContext::new();
 
-    let native_program = native_context.compile(&sierra_program).unwrap();
+    let native_program = native_context.compile(&sierra_program, false).unwrap();
 
     let entry_point_fn =
         find_entry_point_by_idx(&sierra_program, entry_point.function_idx).unwrap();
diff --git a/examples/invoke.rs b/examples/invoke.rs
@@ -20,7 +20,7 @@ fn main() {
 
     let native_context = NativeContext::new();
 
-    let native_program = native_context.compile(&sierra_program).unwrap();
+    let native_program = native_context.compile(&sierra_program, false).unwrap();
 
     // Call the echo function from the contract using the generated wrapper.
 
diff --git a/examples/starknet.rs b/examples/starknet.rs
@@ -433,7 +433,7 @@ fn main() {
 
     let native_context = NativeContext::new();
 
-    let native_program = native_context.compile(&sierra_program).unwrap();
+    let native_program = native_context.compile(&sierra_program, false).unwrap();
 
     // Call the echo function from the contract using the generated wrapper.
 
diff --git a/src/bin/cairo-native-compile.rs b/src/bin/cairo-native-compile.rs
@@ -55,7 +55,7 @@ fn main() -> anyhow::Result<()> {
     let sierra_program = cairo_to_sierra(&args.path);
 
     // Compile the sierra program into a MLIR module.
-    let native_module = native_context.compile(&sierra_program).unwrap();
+    let native_module = native_context.compile(&sierra_program, false).unwrap();
 
     let output_mlir = args
         .output_mlir
diff --git a/src/bin/cairo-native-dump.rs b/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)?;
+    let module = context.compile(&program, false)?;
 
     // Write the output.
     let output_str = module
diff --git a/src/bin/cairo-native-run.rs b/src/bin/cairo-native-run.rs
@@ -72,7 +72,7 @@ fn main() -> anyhow::Result<()> {
     let native_context = NativeContext::new();
 
     // Compile the sierra program into a MLIR module.
-    let native_module = native_context.compile(&sierra_program).unwrap();
+    let native_module = native_context.compile(&sierra_program, false).unwrap();
 
     let native_executor: NativeExecutor = match args.run_mode {
         RunMode::Aot => {
diff --git a/src/bin/cairo-native-stress/main.rs b/src/bin/cairo-native-stress/main.rs
@@ -275,7 +275,7 @@ where
     ) -> Arc<AotNativeExecutor> {
         let native_module = self
             .context
-            .compile(program)
+            .compile(program, false)
             .expect("failed to compile program");
 
         let registry = ProgramRegistry::new(program).expect("failed to get program registry");
diff --git a/src/bin/scarb-native-dump.rs b/src/bin/scarb-native-dump.rs
@@ -39,7 +39,7 @@ fn main() -> anyhow::Result<()> {
 
                 // Compile the sierra program into a MLIR module.
                 let native_module = native_context
-                    .compile(&compiled.into_v1().unwrap().program)
+                    .compile(&compiled.into_v1().unwrap().program, false)
                     .unwrap();
 
                 // Write the output.
diff --git a/src/bin/utils/test.rs b/src/bin/utils/test.rs
@@ -138,7 +138,7 @@ pub fn run_tests(
     let native_context = NativeContext::new();
 
     // Compile the sierra program into a MLIR module.
-    let native_module = native_context.compile(&sierra_program).unwrap();
+    let native_module = native_context.compile(&sierra_program, false).unwrap();
 
     let native_executor: NativeExecutor = match args.run_mode {
         RunMode::Aot => {
diff --git a/src/cache/aot.rs b/src/cache/aot.rs
@@ -44,7 +44,10 @@ where
             module,
             registry,
             metadata,
-        } = self.context.compile(program).expect("should compile");
+        } = self
+            .context
+            .compile(program, false)
+            .expect("should compile");
 
         // Compile module into an object.
         let object_data = crate::ffi::module_to_object(&module, opt_level).unwrap();
diff --git a/src/cache/jit.rs b/src/cache/jit.rs
@@ -45,7 +45,10 @@ where
         program: &Program,
         opt_level: OptLevel,
     ) -> Arc<JitNativeExecutor<'a>> {
-        let module = self.context.compile(program).expect("should compile");
+        let module = self
+            .context
+            .compile(program, false)
+            .expect("should compile");
         let executor = JitNativeExecutor::from_native_module(module, opt_level);
 
         let executor = Arc::new(executor);
diff --git a/src/compiler.rs b/src/compiler.rs
@@ -127,6 +127,7 @@ pub fn compile(
     registry: &ProgramRegistry<CoreType, CoreLibfunc>,
     metadata: &mut MetadataStorage,
     di_compile_unit_id: Attribute,
+    ignore_debug_names: bool,
 ) -> Result<(), Error> {
     if let Ok(x) = std::env::var("NATIVE_DEBUG_DUMP") {
         if x == "1" || x == "true" {
@@ -155,6 +156,7 @@ pub fn compile(
             metadata,
             di_compile_unit_id,
             sierra_stmt_start_offset,
+            ignore_debug_names,
         )?;
     }
 
@@ -168,6 +170,8 @@ pub fn compile(
 /// and name. Check out [compile](self::compile) for a description of the other arguments.
 ///
 /// The [module docs](self) contain more information about the compilation process.
+///
+/// If [`ignore_debug_names`] is true, then the function name will always be `f{id}` without any debug name info if it ever exists.
 #[allow(clippy::too_many_arguments)]
 fn compile_func(
     context: &Context,
@@ -178,6 +182,7 @@ fn compile_func(
     metadata: &mut MetadataStorage,
     di_compile_unit_id: Attribute,
     sierra_stmt_start_offset: usize,
+    ignore_debug_names: bool,
 ) -> Result<(), Error> {
     let fn_location = Location::new(
         context,
@@ -278,7 +283,10 @@ fn compile_func(
         None
     };
 
-    let function_name = generate_function_name(&function.id);
+    let function_name = generate_function_name(&function.id, ignore_debug_names);
+    // Don't care about whether it is for the contract executor for inner impls
+    // so we don't have to pass the boolean to the function call libfunc.
+    let function_name_for_inner = generate_function_name(&function.id, false);
 
     let di_subprogram = unsafe {
         // Various DWARF debug attributes for this function.
@@ -876,7 +884,7 @@ fn compile_func(
         pre_entry_block.append_operation(cf::br(&entry_block, &arg_values, fn_location));
     }
 
-    let inner_function_name = format!("impl${function_name}");
+    let inner_function_name = format!("impl${function_name_for_inner}");
     module.body().append_operation(llvm::func(
         context,
         StringAttribute::new(context, &inner_function_name),
diff --git a/src/context.rs b/src/context.rs
@@ -62,7 +62,14 @@ impl NativeContext {
 
     /// Compiles a sierra program into MLIR and then lowers to LLVM.
     /// Returns the corresponding NativeModule struct.
-    pub fn compile(&self, program: &Program) -> Result<NativeModule, Error> {
+    ///
+    /// If `ignore_debug_names` is true then debug names will not be added to function names.
+    /// Mainly useful for the ContractExecutor.
+    pub fn compile(
+        &self,
+        program: &Program,
+        ignore_debug_names: bool,
+    ) -> Result<NativeModule, Error> {
         static INITIALIZED: OnceLock<()> = OnceLock::new();
         INITIALIZED.get_or_init(|| unsafe {
             LLVM_InitializeAllTargets();
@@ -170,6 +177,7 @@ impl NativeContext {
             &registry,
             &mut metadata,
             unsafe { Attribute::from_raw(di_unit_id) },
+            ignore_debug_names,
         )?;
 
         if let Ok(x) = std::env::var("NATIVE_DEBUG_DUMP") {
diff --git a/src/executor.rs b/src/executor.rs
@@ -705,7 +705,7 @@ mod tests {
     fn test_invoke_dynamic_aot_native_executor(program: Program) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&program)
+            .compile(&program, false)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, OptLevel::default());
 
@@ -725,7 +725,7 @@ mod tests {
     fn test_invoke_dynamic_jit_native_executor(program: Program) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&program)
+            .compile(&program, false)
             .expect("failed to compile context");
         let executor = JitNativeExecutor::from_native_module(module, OptLevel::default());
 
@@ -745,7 +745,7 @@ mod tests {
     fn test_invoke_contract_dynamic_aot(starknet_program: Program) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&starknet_program)
+            .compile(&starknet_program, false)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, OptLevel::default());
 
@@ -774,7 +774,7 @@ mod tests {
     fn test_invoke_contract_dynamic_jit(starknet_program: Program) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&starknet_program)
+            .compile(&starknet_program, false)
             .expect("failed to compile context");
         let executor = JitNativeExecutor::from_native_module(module, OptLevel::default());
 
diff --git a/src/executor/aot.rs b/src/executor/aot.rs
@@ -139,7 +139,7 @@ impl AotNativeExecutor {
     }
 
     pub fn find_function_ptr(&self, function_id: &FunctionId) -> *mut c_void {
-        let function_name = generate_function_name(function_id);
+        let function_name = generate_function_name(function_id, false);
         let function_name = format!("_mlir_ciface_{function_name}");
 
         // Arguments and return values are hardcoded since they'll be handled by the trampoline.
@@ -215,7 +215,7 @@ mod tests {
     fn test_invoke_dynamic(program: Program, #[case] optlevel: OptLevel) {
         let native_context = NativeContext::new();
         let module = native_context
-            .compile(&program)
+            .compile(&program, false)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, optlevel);
 
@@ -236,7 +236,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)
+            .compile(&program, false)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, optlevel);
 
@@ -275,7 +275,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)
+            .compile(&starknet_program, false)
             .expect("failed to compile context");
         let executor = AotNativeExecutor::from_native_module(module, optlevel);
 
diff --git a/src/executor/contract.rs b/src/executor/contract.rs
diff --git a/src/executor/jit.rs b/src/executor/jit.rs
diff --git a/src/libfuncs/enum.rs b/src/libfuncs/enum.rs
diff --git a/src/libfuncs/function_call.rs b/src/libfuncs/function_call.rs
diff --git a/src/utils.rs b/src/utils.rs
diff --git a/tests/common.rs b/tests/common.rs
diff --git a/tests/tests/compile_library.rs b/tests/tests/compile_library.rs
diff --git a/tests/tests/trampoline.rs b/tests/tests/trampoline.rs
