src/driver/aot.rs

   1 //! The AOT driver uses [`cranelift_object`] to write object files suitable for linking into a
   2 //! standalone executable.
   3
   4 use std::path::PathBuf;
   5
   6 use rustc_codegen_ssa::back::linker::LinkerInfo;
   7 use rustc_codegen_ssa::{CodegenResults, CompiledModule, CrateInfo, ModuleKind};
   8 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
   9 use rustc_middle::dep_graph::{WorkProduct, WorkProductId};
  10 use rustc_middle::middle::cstore::EncodedMetadata;
  11 use rustc_middle::mir::mono::CodegenUnit;
  12 use rustc_session::cgu_reuse_tracker::CguReuse;
  13 use rustc_session::config::{DebugInfo, OutputType};
  14
  15 use cranelift_object::{ObjectModule, ObjectProduct};
  16
  17 use crate::prelude::*;
  18
  19 use crate::backend::AddConstructor;
  20
  21 fn new_module(tcx: TyCtxt<'_>, name: String) -> ObjectModule {
  22     let module = crate::backend::make_module(tcx.sess, name);
  23     assert_eq!(pointer_ty(tcx), module.target_config().pointer_type());
  24     module
  25 }
  26
  27 struct ModuleCodegenResult(CompiledModule, Option<(WorkProductId, WorkProduct)>);
  28
  29 impl<HCX> HashStable<HCX> for ModuleCodegenResult {
  30     fn hash_stable(&self, _: &mut HCX, _: &mut StableHasher) {
  31         // do nothing
  32     }
  33 }
  34
  35 fn emit_module(
  36     tcx: TyCtxt<'_>,
  37     name: String,
  38     kind: ModuleKind,
  39     module: ObjectModule,
  40     debug: Option<DebugContext<'_>>,
  41     unwind_context: UnwindContext<'_>,
  42     map_product: impl FnOnce(ObjectProduct) -> ObjectProduct,
  43 ) -> ModuleCodegenResult {
  44     let mut product = module.finish();
  45
  46     if let Some(mut debug) = debug {
  47         debug.emit(&mut product);
  48     }
  49
  50     unwind_context.emit(&mut product);
  51
  52     let product = map_product(product);
  53
  54     let tmp_file = tcx
  55         .output_filenames(LOCAL_CRATE)
  56         .temp_path(OutputType::Object, Some(&name));
  57     let obj = product.object.write().unwrap();
  58     if let Err(err) = std::fs::write(&tmp_file, obj) {
  59         tcx.sess
  60             .fatal(&format!("error writing object file: {}", err));
  61     }
  62
  63     let work_product = if std::env::var("CG_CLIF_INCR_CACHE_DISABLED").is_ok() {
  64         None
  65     } else {
  66         rustc_incremental::copy_cgu_workproduct_to_incr_comp_cache_dir(
  67             tcx.sess,
  68             &name,
  69             &Some(tmp_file.clone()),
  70         )
  71     };
  72
  73     ModuleCodegenResult(
  74         CompiledModule {
  75             name,
  76             kind,
  77             object: Some(tmp_file),
  78             bytecode: None,
  79         },
  80         work_product,
  81     )
  82 }
  83
  84 fn reuse_workproduct_for_cgu(
  85     tcx: TyCtxt<'_>,
  86     cgu: &CodegenUnit<'_>,
  87     work_products: &mut FxHashMap<WorkProductId, WorkProduct>,
  88 ) -> CompiledModule {
  89     let incr_comp_session_dir = tcx.sess.incr_comp_session_dir();
  90     let mut object = None;
  91     let work_product = cgu.work_product(tcx);
  92     if let Some(saved_file) = &work_product.saved_file {
  93         let obj_out = tcx
  94             .output_filenames(LOCAL_CRATE)
  95             .temp_path(OutputType::Object, Some(&cgu.name().as_str()));
  96         object = Some(obj_out.clone());
  97         let source_file = rustc_incremental::in_incr_comp_dir(&incr_comp_session_dir, &saved_file);
  98         if let Err(err) = rustc_fs_util::link_or_copy(&source_file, &obj_out) {
  99             tcx.sess.err(&format!(
 100                 "unable to copy {} to {}: {}",
 101                 source_file.display(),
 102                 obj_out.display(),
 103                 err
 104             ));
 105         }
 106     }
 107
 108     work_products.insert(cgu.work_product_id(), work_product);
 109
 110     CompiledModule {
 111         name: cgu.name().to_string(),
 112         kind: ModuleKind::Regular,
 113         object,
 114         bytecode: None,
 115     }
 116 }
 117
 118 fn module_codegen(tcx: TyCtxt<'_>, cgu_name: rustc_span::Symbol) -> ModuleCodegenResult {
 119     let cgu = tcx.codegen_unit(cgu_name);
 120     let mono_items = cgu.items_in_deterministic_order(tcx);
 121
 122     let mut module = new_module(tcx, cgu_name.as_str().to_string());
 123
 124     // Initialize the global atomic mutex using a constructor for proc-macros.
 125     // FIXME implement atomic instructions in Cranelift.
 126     let mut init_atomics_mutex_from_constructor = None;
 127     if tcx
 128         .sess
 129         .crate_types()
 130         .contains(&rustc_session::config::CrateType::ProcMacro)
 131     {
 132         if mono_items.iter().any(|(mono_item, _)| match mono_item {
 133             rustc_middle::mir::mono::MonoItem::Static(def_id) => tcx
 134                 .symbol_name(Instance::mono(tcx, *def_id))
 135                 .name
 136                 .contains("__rustc_proc_macro_decls_"),
 137             _ => false,
 138         }) {
 139             init_atomics_mutex_from_constructor =
 140                 Some(crate::atomic_shim::init_global_lock_constructor(
 141                     &mut module,
 142                     &format!("{}_init_atomics_mutex", cgu_name.as_str()),
 143                 ));
 144         }
 145     }
 146
 147     let mut cx = crate::CodegenCx::new(tcx, module, tcx.sess.opts.debuginfo != DebugInfo::None);
 148     super::codegen_mono_items(&mut cx, mono_items);
 149     let (mut module, global_asm, debug, mut unwind_context) =
 150         tcx.sess.time("finalize CodegenCx", || cx.finalize());
 151     crate::main_shim::maybe_create_entry_wrapper(tcx, &mut module, &mut unwind_context, false);
 152
 153     let codegen_result = emit_module(
 154         tcx,
 155         cgu.name().as_str().to_string(),
 156         ModuleKind::Regular,
 157         module,
 158         debug,
 159         unwind_context,
 160         |mut product| {
 161             if let Some(func_id) = init_atomics_mutex_from_constructor {
 162                 product.add_constructor(func_id);
 163             }
 164
 165             product
 166         },
 167     );
 168
 169     codegen_global_asm(tcx, &cgu.name().as_str(), &global_asm);
 170
 171     codegen_result
 172 }
 173
 174 pub(super) fn run_aot(
 175     tcx: TyCtxt<'_>,
 176     metadata: EncodedMetadata,
 177     need_metadata_module: bool,
 178 ) -> Box<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>)> {
 179     let mut work_products = FxHashMap::default();
 180
 181     let cgus = if tcx.sess.opts.output_types.should_codegen() {
 182         tcx.collect_and_partition_mono_items(LOCAL_CRATE).1
 183     } else {
 184         // If only `--emit metadata` is used, we shouldn't perform any codegen.
 185         // Also `tcx.collect_and_partition_mono_items` may panic in that case.
 186         &[]
 187     };
 188
 189     if tcx.dep_graph.is_fully_enabled() {
 190         for cgu in &*cgus {
 191             tcx.ensure().codegen_unit(cgu.name());
 192         }
 193     }
 194
 195     let modules = super::time(tcx, "codegen mono items", || {
 196         cgus.iter()
 197             .map(|cgu| {
 198                 let cgu_reuse = determine_cgu_reuse(tcx, cgu);
 199                 tcx.sess
 200                     .cgu_reuse_tracker
 201                     .set_actual_reuse(&cgu.name().as_str(), cgu_reuse);
 202
 203                 match cgu_reuse {
 204                     _ if std::env::var("CG_CLIF_INCR_CACHE_DISABLED").is_ok() => {}
 205                     CguReuse::No => {}
 206                     CguReuse::PreLto => {
 207                         return reuse_workproduct_for_cgu(tcx, &*cgu, &mut work_products);
 208                     }
 209                     CguReuse::PostLto => unreachable!(),
 210                 }
 211
 212                 let dep_node = cgu.codegen_dep_node(tcx);
 213                 let (ModuleCodegenResult(module, work_product), _) = tcx.dep_graph.with_task(
 214                     dep_node,
 215                     tcx,
 216                     cgu.name(),
 217                     module_codegen,
 218                     rustc_middle::dep_graph::hash_result,
 219                 );
 220
 221                 if let Some((id, product)) = work_product {
 222                     work_products.insert(id, product);
 223                 }
 224
 225                 module
 226             })
 227             .collect::<Vec<_>>()
 228     });
 229
 230     tcx.sess.abort_if_errors();
 231
 232     let mut allocator_module = new_module(tcx, "allocator_shim".to_string());
 233     let mut allocator_unwind_context = UnwindContext::new(tcx, allocator_module.isa());
 234     let created_alloc_shim =
 235         crate::allocator::codegen(tcx, &mut allocator_module, &mut allocator_unwind_context);
 236
 237     let allocator_module = if created_alloc_shim {
 238         let ModuleCodegenResult(module, work_product) = emit_module(
 239             tcx,
 240             "allocator_shim".to_string(),
 241             ModuleKind::Allocator,
 242             allocator_module,
 243             None,
 244             allocator_unwind_context,
 245             |product| product,
 246         );
 247         if let Some((id, product)) = work_product {
 248             work_products.insert(id, product);
 249         }
 250         Some(module)
 251     } else {
 252         None
 253     };
 254
 255     rustc_incremental::assert_dep_graph(tcx);
 256     rustc_incremental::save_dep_graph(tcx);
 257
 258     let metadata_module = if need_metadata_module {
 259         let _timer = tcx.prof.generic_activity("codegen crate metadata");
 260         let (metadata_cgu_name, tmp_file) = tcx.sess.time("write compressed metadata", || {
 261             use rustc_middle::mir::mono::CodegenUnitNameBuilder;
 262
 263             let cgu_name_builder = &mut CodegenUnitNameBuilder::new(tcx);
 264             let metadata_cgu_name = cgu_name_builder
 265                 .build_cgu_name(LOCAL_CRATE, &["crate"], Some("metadata"))
 266                 .as_str()
 267                 .to_string();
 268
 269             let tmp_file = tcx
 270                 .output_filenames(LOCAL_CRATE)
 271                 .temp_path(OutputType::Metadata, Some(&metadata_cgu_name));
 272
 273             let obj = crate::backend::with_object(tcx.sess, &metadata_cgu_name, |object| {
 274                 crate::metadata::write_metadata(tcx, object);
 275             });
 276
 277             if let Err(err) = std::fs::write(&tmp_file, obj) {
 278                 tcx.sess
 279                     .fatal(&format!("error writing metadata object file: {}", err));
 280             }
 281
 282             (metadata_cgu_name, tmp_file)
 283         });
 284
 285         Some(CompiledModule {
 286             name: metadata_cgu_name,
 287             kind: ModuleKind::Metadata,
 288             object: Some(tmp_file),
 289             bytecode: None,
 290         })
 291     } else {
 292         None
 293     };
 294
 295     if tcx.sess.opts.output_types.should_codegen() {
 296         rustc_incremental::assert_module_sources::assert_module_sources(tcx);
 297     }
 298
 299     Box::new((
 300         CodegenResults {
 301             crate_name: tcx.crate_name(LOCAL_CRATE),
 302             modules,
 303             allocator_module,
 304             metadata_module,
 305             metadata,
 306             windows_subsystem: None, // Windows is not yet supported
 307             linker_info: LinkerInfo::new(tcx),
 308             crate_info: CrateInfo::new(tcx),
 309         },
 310         work_products,
 311     ))
 312 }
 313
 314 fn codegen_global_asm(tcx: TyCtxt<'_>, cgu_name: &str, global_asm: &str) {
 315     use std::io::Write;
 316     use std::process::{Command, Stdio};
 317
 318     if global_asm.is_empty() {
 319         return;
 320     }
 321
 322     if cfg!(not(feature = "inline_asm"))
 323         || tcx.sess.target.is_like_osx
 324         || tcx.sess.target.is_like_windows
 325     {
 326         if global_asm.contains("__rust_probestack") {
 327             return;
 328         }
 329
 330         // FIXME fix linker error on macOS
 331         if cfg!(not(feature = "inline_asm")) {
 332             tcx.sess.fatal(
 333                 "asm! and global_asm! support is disabled while compiling rustc_codegen_cranelift",
 334             );
 335         } else {
 336             tcx.sess
 337                 .fatal("asm! and global_asm! are not yet supported on macOS and Windows");
 338         }
 339     }
 340
 341     let assembler = crate::toolchain::get_toolchain_binary(tcx.sess, "as");
 342     let linker = crate::toolchain::get_toolchain_binary(tcx.sess, "ld");
 343
 344     // Remove all LLVM style comments
 345     let global_asm = global_asm
 346         .lines()
 347         .map(|line| {
 348             if let Some(index) = line.find("//") {
 349                 &line[0..index]
 350             } else {
 351                 line
 352             }
 353         })
 354         .collect::<Vec<_>>()
 355         .join("\n");
 356
 357     let output_object_file = tcx
 358         .output_filenames(LOCAL_CRATE)
 359         .temp_path(OutputType::Object, Some(cgu_name));
 360
 361     // Assemble `global_asm`
 362     let global_asm_object_file = add_file_stem_postfix(output_object_file.clone(), ".asm");
 363     let mut child = Command::new(assembler)
 364         .arg("-o")
 365         .arg(&global_asm_object_file)
 366         .stdin(Stdio::piped())
 367         .spawn()
 368         .expect("Failed to spawn `as`.");
 369     child
 370         .stdin
 371         .take()
 372         .unwrap()
 373         .write_all(global_asm.as_bytes())
 374         .unwrap();
 375     let status = child.wait().expect("Failed to wait for `as`.");
 376     if !status.success() {
 377         tcx.sess
 378             .fatal(&format!("Failed to assemble `{}`", global_asm));
 379     }
 380
 381     // Link the global asm and main object file together
 382     let main_object_file = add_file_stem_postfix(output_object_file.clone(), ".main");
 383     std::fs::rename(&output_object_file, &main_object_file).unwrap();
 384     let status = Command::new(linker)
 385         .arg("-r") // Create a new object file
 386         .arg("-o")
 387         .arg(output_object_file)
 388         .arg(&main_object_file)
 389         .arg(&global_asm_object_file)
 390         .status()
 391         .unwrap();
 392     if !status.success() {
 393         tcx.sess.fatal(&format!(
 394             "Failed to link `{}` and `{}` together",
 395             main_object_file.display(),
 396             global_asm_object_file.display(),
 397         ));
 398     }
 399
 400     std::fs::remove_file(global_asm_object_file).unwrap();
 401     std::fs::remove_file(main_object_file).unwrap();
 402 }
 403
 404 fn add_file_stem_postfix(mut path: PathBuf, postfix: &str) -> PathBuf {
 405     let mut new_filename = path.file_stem().unwrap().to_owned();
 406     new_filename.push(postfix);
 407     if let Some(extension) = path.extension() {
 408         new_filename.push(".");
 409         new_filename.push(extension);
 410     }
 411     path.set_file_name(new_filename);
 412     path
 413 }
 414
 415 // Adapted from https://github.com/rust-lang/rust/blob/303d8aff6092709edd4dbd35b1c88e9aa40bf6d8/src/librustc_codegen_ssa/base.rs#L922-L953
 416 fn determine_cgu_reuse<'tcx>(tcx: TyCtxt<'tcx>, cgu: &CodegenUnit<'tcx>) -> CguReuse {
 417     if !tcx.dep_graph.is_fully_enabled() {
 418         return CguReuse::No;
 419     }
 420
 421     let work_product_id = &cgu.work_product_id();
 422     if tcx
 423         .dep_graph
 424         .previous_work_product(work_product_id)
 425         .is_none()
 426     {
 427         // We don't have anything cached for this CGU. This can happen
 428         // if the CGU did not exist in the previous session.
 429         return CguReuse::No;
 430     }
 431
 432     // Try to mark the CGU as green. If it we can do so, it means that nothing
 433     // affecting the LLVM module has changed and we can re-use a cached version.
 434     // If we compile with any kind of LTO, this means we can re-use the bitcode
 435     // of the Pre-LTO stage (possibly also the Post-LTO version but we'll only
 436     // know that later). If we are not doing LTO, there is only one optimized
 437     // version of each module, so we re-use that.
 438     let dep_node = cgu.codegen_dep_node(tcx);
 439     assert!(
 440         !tcx.dep_graph.dep_node_exists(&dep_node),
 441         "CompileCodegenUnit dep-node for CGU `{}` already exists before marking.",
 442         cgu.name()
 443     );
 444
 445     if tcx.dep_graph.try_mark_green(tcx, &dep_node).is_some() {
 446         CguReuse::PreLto
 447     } else {
 448         CguReuse::No
 449     }
 450 }