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