compiler/rustc_codegen_cranelift/src/lib.rs

   1 #![feature(rustc_private)]
   2 // Note: please avoid adding other feature gates where possible
   3 #![warn(rust_2018_idioms)]
   4 #![warn(unused_lifetimes)]
   5 #![warn(unreachable_pub)]
   6
   7 #[macro_use]
   8 extern crate rustc_middle;
   9 extern crate rustc_ast;
  10 extern crate rustc_codegen_ssa;
  11 extern crate rustc_data_structures;
  12 extern crate rustc_errors;
  13 extern crate rustc_fs_util;
  14 extern crate rustc_hir;
  15 extern crate rustc_incremental;
  16 extern crate rustc_index;
  17 extern crate rustc_interface;
  18 extern crate rustc_metadata;
  19 extern crate rustc_session;
  20 extern crate rustc_span;
  21 extern crate rustc_target;
  22
  23 // This prevents duplicating functions and statics that are already part of the host rustc process.
  24 #[allow(unused_extern_crates)]
  25 extern crate rustc_driver;
  26
  27 use std::any::Any;
  28 use std::cell::Cell;
  29
  30 use rustc_codegen_ssa::traits::CodegenBackend;
  31 use rustc_codegen_ssa::CodegenResults;
  32 use rustc_errors::ErrorGuaranteed;
  33 use rustc_metadata::EncodedMetadata;
  34 use rustc_middle::dep_graph::{WorkProduct, WorkProductId};
  35 use rustc_session::config::OutputFilenames;
  36 use rustc_session::Session;
  37 use rustc_span::Symbol;
  38
  39 use cranelift_codegen::isa::TargetIsa;
  40 use cranelift_codegen::settings::{self, Configurable};
  41
  42 pub use crate::config::*;
  43 use crate::prelude::*;
  44
  45 mod abi;
  46 mod allocator;
  47 mod analyze;
  48 mod archive;
  49 mod base;
  50 mod cast;
  51 mod codegen_i128;
  52 mod common;
  53 mod compiler_builtins;
  54 mod config;
  55 mod constant;
  56 mod debuginfo;
  57 mod discriminant;
  58 mod driver;
  59 mod inline_asm;
  60 mod intrinsics;
  61 mod linkage;
  62 mod main_shim;
  63 mod num;
  64 mod optimize;
  65 mod pointer;
  66 mod pretty_clif;
  67 mod toolchain;
  68 mod trap;
  69 mod unsize;
  70 mod value_and_place;
  71 mod vtable;
  72
  73 mod prelude {
  74     pub(crate) use rustc_span::{FileNameDisplayPreference, Span};
  75
  76     pub(crate) use rustc_hir::def_id::{DefId, LOCAL_CRATE};
  77     pub(crate) use rustc_middle::bug;
  78     pub(crate) use rustc_middle::mir::{self, *};
  79     pub(crate) use rustc_middle::ty::layout::{self, LayoutOf, TyAndLayout};
  80     pub(crate) use rustc_middle::ty::{
  81         self, FloatTy, Instance, InstanceDef, IntTy, ParamEnv, Ty, TyCtxt, TypeAndMut,
  82         TypeFoldable, UintTy,
  83     };
  84     pub(crate) use rustc_target::abi::{Abi, Scalar, Size, VariantIdx};
  85
  86     pub(crate) use rustc_data_structures::fx::FxHashMap;
  87
  88     pub(crate) use rustc_index::vec::Idx;
  89
  90     pub(crate) use cranelift_codegen::ir::condcodes::{FloatCC, IntCC};
  91     pub(crate) use cranelift_codegen::ir::function::Function;
  92     pub(crate) use cranelift_codegen::ir::types;
  93     pub(crate) use cranelift_codegen::ir::{
  94         AbiParam, Block, ExternalName, FuncRef, Inst, InstBuilder, MemFlags, Signature, SourceLoc,
  95         StackSlot, StackSlotData, StackSlotKind, TrapCode, Type, Value,
  96     };
  97     pub(crate) use cranelift_codegen::isa::{self, CallConv};
  98     pub(crate) use cranelift_codegen::Context;
  99     pub(crate) use cranelift_frontend::{FunctionBuilder, FunctionBuilderContext, Variable};
 100     pub(crate) use cranelift_module::{self, DataContext, FuncId, Linkage, Module};
 101
 102     pub(crate) use crate::abi::*;
 103     pub(crate) use crate::base::{codegen_operand, codegen_place};
 104     pub(crate) use crate::cast::*;
 105     pub(crate) use crate::common::*;
 106     pub(crate) use crate::debuginfo::{DebugContext, UnwindContext};
 107     pub(crate) use crate::pointer::Pointer;
 108     pub(crate) use crate::value_and_place::{CPlace, CPlaceInner, CValue};
 109 }
 110
 111 struct PrintOnPanic<F: Fn() -> String>(F);
 112 impl<F: Fn() -> String> Drop for PrintOnPanic<F> {
 113     fn drop(&mut self) {
 114         if ::std::thread::panicking() {
 115             println!("{}", (self.0)());
 116         }
 117     }
 118 }
 119
 120 /// The codegen context holds any information shared between the codegen of individual functions
 121 /// inside a single codegen unit with the exception of the Cranelift [`Module`](cranelift_module::Module).
 122 struct CodegenCx<'tcx> {
 123     tcx: TyCtxt<'tcx>,
 124     global_asm: String,
 125     inline_asm_index: Cell<usize>,
 126     cached_context: Context,
 127     debug_context: Option<DebugContext<'tcx>>,
 128     unwind_context: UnwindContext,
 129     cgu_name: Symbol,
 130 }
 131
 132 impl<'tcx> CodegenCx<'tcx> {
 133     fn new(
 134         tcx: TyCtxt<'tcx>,
 135         backend_config: BackendConfig,
 136         isa: &dyn TargetIsa,
 137         debug_info: bool,
 138         cgu_name: Symbol,
 139     ) -> Self {
 140         assert_eq!(pointer_ty(tcx), isa.pointer_type());
 141
 142         let unwind_context =
 143             UnwindContext::new(isa, matches!(backend_config.codegen_mode, CodegenMode::Aot));
 144         let debug_context = if debug_info { Some(DebugContext::new(tcx, isa)) } else { None };
 145         CodegenCx {
 146             tcx,
 147             global_asm: String::new(),
 148             inline_asm_index: Cell::new(0),
 149             cached_context: Context::new(),
 150             debug_context,
 151             unwind_context,
 152             cgu_name,
 153         }
 154     }
 155 }
 156
 157 pub struct CraneliftCodegenBackend {
 158     pub config: Option<BackendConfig>,
 159 }
 160
 161 impl CodegenBackend for CraneliftCodegenBackend {
 162     fn init(&self, sess: &Session) {
 163         use rustc_session::config::Lto;
 164         match sess.lto() {
 165             Lto::No | Lto::ThinLocal => {}
 166             Lto::Thin | Lto::Fat => sess.warn("LTO is not supported. You may get a linker error."),
 167         }
 168     }
 169
 170     fn target_features(&self, _sess: &Session) -> Vec<rustc_span::Symbol> {
 171         vec![]
 172     }
 173
 174     fn print_version(&self) {
 175         println!("Cranelift version: {}", cranelift_codegen::VERSION);
 176     }
 177
 178     fn codegen_crate(
 179         &self,
 180         tcx: TyCtxt<'_>,
 181         metadata: EncodedMetadata,
 182         need_metadata_module: bool,
 183     ) -> Box<dyn Any> {
 184         tcx.sess.abort_if_errors();
 185         let config = if let Some(config) = self.config.clone() {
 186             config
 187         } else {
 188             if !tcx.sess.unstable_options() && !tcx.sess.opts.cg.llvm_args.is_empty() {
 189                 tcx.sess.fatal("`-Z unstable-options` must be passed to allow configuring cg_clif");
 190             }
 191             BackendConfig::from_opts(&tcx.sess.opts.cg.llvm_args)
 192                 .unwrap_or_else(|err| tcx.sess.fatal(&err))
 193         };
 194         match config.codegen_mode {
 195             CodegenMode::Aot => driver::aot::run_aot(tcx, config, metadata, need_metadata_module),
 196             CodegenMode::Jit | CodegenMode::JitLazy => {
 197                 #[cfg(feature = "jit")]
 198                 driver::jit::run_jit(tcx, config);
 199
 200                 #[cfg(not(feature = "jit"))]
 201                 tcx.sess.fatal("jit support was disabled when compiling rustc_codegen_cranelift");
 202             }
 203         }
 204     }
 205
 206     fn join_codegen(
 207         &self,
 208         ongoing_codegen: Box<dyn Any>,
 209         _sess: &Session,
 210         _outputs: &OutputFilenames,
 211     ) -> Result<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>), ErrorGuaranteed> {
 212         Ok(*ongoing_codegen
 213             .downcast::<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>)>()
 214             .unwrap())
 215     }
 216
 217     fn link(
 218         &self,
 219         sess: &Session,
 220         codegen_results: CodegenResults,
 221         outputs: &OutputFilenames,
 222     ) -> Result<(), ErrorGuaranteed> {
 223         use rustc_codegen_ssa::back::link::link_binary;
 224
 225         link_binary::<crate::archive::ArArchiveBuilder<'_>>(sess, &codegen_results, outputs)
 226     }
 227 }
 228
 229 fn target_triple(sess: &Session) -> target_lexicon::Triple {
 230     match sess.target.llvm_target.parse() {
 231         Ok(triple) => triple,
 232         Err(err) => sess.fatal(&format!("target not recognized: {}", err)),
 233     }
 234 }
 235
 236 fn build_isa(sess: &Session, backend_config: &BackendConfig) -> Box<dyn isa::TargetIsa + 'static> {
 237     use target_lexicon::BinaryFormat;
 238
 239     let target_triple = crate::target_triple(sess);
 240
 241     let mut flags_builder = settings::builder();
 242     flags_builder.enable("is_pic").unwrap();
 243     flags_builder.set("enable_probestack", "false").unwrap(); // __cranelift_probestack is not provided
 244     let enable_verifier = if backend_config.enable_verifier { "true" } else { "false" };
 245     flags_builder.set("enable_verifier", enable_verifier).unwrap();
 246
 247     let tls_model = match target_triple.binary_format {
 248         BinaryFormat::Elf => "elf_gd",
 249         BinaryFormat::Macho => "macho",
 250         BinaryFormat::Coff => "coff",
 251         _ => "none",
 252     };
 253     flags_builder.set("tls_model", tls_model).unwrap();
 254
 255     flags_builder.set("enable_simd", "true").unwrap();
 256
 257     flags_builder.set("enable_llvm_abi_extensions", "true").unwrap();
 258
 259     flags_builder.set("regalloc", &backend_config.regalloc).unwrap();
 260
 261     use rustc_session::config::OptLevel;
 262     match sess.opts.optimize {
 263         OptLevel::No => {
 264             flags_builder.set("opt_level", "none").unwrap();
 265         }
 266         OptLevel::Less | OptLevel::Default => {}
 267         OptLevel::Size | OptLevel::SizeMin | OptLevel::Aggressive => {
 268             flags_builder.set("opt_level", "speed_and_size").unwrap();
 269         }
 270     }
 271
 272     let flags = settings::Flags::new(flags_builder);
 273
 274     let isa_builder = match sess.opts.cg.target_cpu.as_deref() {
 275         Some("native") => {
 276             let builder = cranelift_native::builder_with_options(true).unwrap();
 277             builder
 278         }
 279         Some(value) => {
 280             let mut builder =
 281                 cranelift_codegen::isa::lookup(target_triple.clone()).unwrap_or_else(|err| {
 282                     sess.fatal(&format!("can't compile for {}: {}", target_triple, err));
 283                 });
 284             if let Err(_) = builder.enable(value) {
 285                 sess.fatal("the specified target cpu isn't currently supported by Cranelift.");
 286             }
 287             builder
 288         }
 289         None => {
 290             let mut builder =
 291                 cranelift_codegen::isa::lookup(target_triple.clone()).unwrap_or_else(|err| {
 292                     sess.fatal(&format!("can't compile for {}: {}", target_triple, err));
 293                 });
 294             if target_triple.architecture == target_lexicon::Architecture::X86_64 {
 295                 // Don't use "haswell" as the default, as it implies `has_lzcnt`.
 296                 // macOS CI is still at Ivy Bridge EP, so `lzcnt` is interpreted as `bsr`.
 297                 builder.enable("nehalem").unwrap();
 298             }
 299             builder
 300         }
 301     };
 302
 303     match isa_builder.finish(flags) {
 304         Ok(target_isa) => target_isa,
 305         Err(err) => sess.fatal(&format!("failed to build TargetIsa: {}", err)),
 306     }
 307 }
 308
 309 /// This is the entrypoint for a hot plugged rustc_codegen_cranelift
 310 #[no_mangle]
 311 pub fn __rustc_codegen_backend() -> Box<dyn CodegenBackend> {
 312     Box::new(CraneliftCodegenBackend { config: None })
 313 }