src/lib.rs

   1 #![feature(rustc_private, decl_macro, type_alias_impl_trait, associated_type_bounds, never_type)]
   2 #![allow(intra_doc_link_resolution_failure)]
   3 #![warn(rust_2018_idioms)]
   4 #![warn(unused_lifetimes)]
   5
   6 extern crate flate2;
   7 #[cfg(feature = "jit")]
   8 extern crate libc;
   9 extern crate rustc_middle;
  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_mir;
  18 extern crate rustc_session;
  19 extern crate rustc_span;
  20 extern crate rustc_symbol_mangling;
  21 extern crate rustc_target;
  22 extern crate rustc_ast;
  23
  24 // This prevents duplicating functions and statics that are already part of the host rustc process.
  25 #[allow(unused_extern_crates)]
  26 extern crate rustc_driver;
  27
  28 use std::any::Any;
  29
  30 use rustc_errors::ErrorReported;
  31 use rustc_middle::dep_graph::{DepGraph, WorkProduct, WorkProductId};
  32 use rustc_middle::middle::cstore::{EncodedMetadata, MetadataLoader};
  33 use rustc_session::Session;
  34 use rustc_session::config::OutputFilenames;
  35 use rustc_middle::ty::query::Providers;
  36 use rustc_codegen_ssa::CodegenResults;
  37 use rustc_codegen_ssa::traits::CodegenBackend;
  38
  39 use cranelift_codegen::settings::{self, Configurable};
  40
  41 use crate::constant::ConstantCx;
  42 use crate::prelude::*;
  43
  44 mod abi;
  45 mod allocator;
  46 mod analyze;
  47 mod archive;
  48 mod atomic_shim;
  49 mod base;
  50 mod backend;
  51 mod cast;
  52 mod codegen_i128;
  53 mod common;
  54 mod constant;
  55 mod debuginfo;
  56 mod discriminant;
  57 mod driver;
  58 mod inline_asm;
  59 mod intrinsics;
  60 mod linkage;
  61 mod main_shim;
  62 mod metadata;
  63 mod num;
  64 mod optimize;
  65 mod pointer;
  66 mod pretty_clif;
  67 mod target_features_whitelist;
  68 mod toolchain;
  69 mod trap;
  70 mod unsize;
  71 mod value_and_place;
  72 mod vtable;
  73
  74 mod prelude {
  75     pub(crate) use std::convert::{TryFrom, TryInto};
  76
  77     pub(crate) use rustc_ast::ast::{FloatTy, IntTy, UintTy};
  78     pub(crate) use rustc_span::Span;
  79
  80     pub(crate) use rustc_middle::bug;
  81     pub(crate) use rustc_hir::def_id::{DefId, LOCAL_CRATE};
  82     pub(crate) use rustc_middle::mir::{self, *};
  83     pub(crate) use rustc_middle::ty::layout::{self, TyAndLayout};
  84     pub(crate) use rustc_target::abi::{Abi, LayoutOf, Scalar, Size, VariantIdx};
  85     pub(crate) use rustc_middle::ty::{
  86         self, FnSig, Instance, InstanceDef, ParamEnv, Ty, TyCtxt, TypeAndMut, TypeFoldable,
  87     };
  88
  89     pub(crate) use rustc_data_structures::fx::FxHashMap;
  90
  91     pub(crate) use rustc_index::vec::Idx;
  92
  93     pub(crate) use cranelift_codegen::Context;
  94     pub(crate) use cranelift_codegen::entity::EntitySet;
  95     pub(crate) use cranelift_codegen::ir::{AbiParam, Block, ExternalName, FuncRef, Inst, InstBuilder, MemFlags, Signature, SourceLoc, StackSlot, StackSlotData, StackSlotKind, TrapCode, Type, Value};
  96     pub(crate) use cranelift_codegen::ir::condcodes::{FloatCC, IntCC};
  97     pub(crate) use cranelift_codegen::ir::function::Function;
  98     pub(crate) use cranelift_codegen::ir::types;
  99     pub(crate) use cranelift_codegen::isa::{self, CallConv};
 100     pub(crate) use cranelift_frontend::{FunctionBuilder, FunctionBuilderContext, Variable};
 101     pub(crate) use cranelift_module::{
 102         self, Backend, DataContext, DataId, FuncId, Linkage, Module,
 103     };
 104
 105     pub(crate) use crate::abi::*;
 106     pub(crate) use crate::base::{trans_operand, trans_place};
 107     pub(crate) use crate::cast::*;
 108     pub(crate) use crate::common::*;
 109     pub(crate) use crate::debuginfo::{DebugContext, UnwindContext};
 110     pub(crate) use crate::pointer::Pointer;
 111     pub(crate) use crate::trap::*;
 112     pub(crate) use crate::value_and_place::{CPlace, CPlaceInner, CValue};
 113 }
 114
 115 struct PrintOnPanic<F: Fn() -> String>(F);
 116 impl<F: Fn() -> String> Drop for PrintOnPanic<F> {
 117     fn drop(&mut self) {
 118         if ::std::thread::panicking() {
 119             println!("{}", (self.0)());
 120         }
 121     }
 122 }
 123
 124 struct CodegenCx<'tcx, B: Backend + 'static> {
 125     tcx: TyCtxt<'tcx>,
 126     module: Module<B>,
 127     global_asm: String,
 128     constants_cx: ConstantCx,
 129     cached_context: Context,
 130     vtables: FxHashMap<(Ty<'tcx>, Option<ty::PolyExistentialTraitRef<'tcx>>), DataId>,
 131     debug_context: Option<DebugContext<'tcx>>,
 132     unwind_context: UnwindContext<'tcx>,
 133 }
 134
 135 impl<'tcx, B: Backend + 'static> CodegenCx<'tcx, B> {
 136     fn new(
 137         tcx: TyCtxt<'tcx>,
 138         module: Module<B>,
 139         debug_info: bool,
 140     ) -> Self {
 141         let unwind_context = UnwindContext::new(tcx, module.isa());
 142         let debug_context = if debug_info {
 143             Some(DebugContext::new(
 144                 tcx,
 145                 module.isa(),
 146             ))
 147         } else {
 148             None
 149         };
 150         CodegenCx {
 151             tcx,
 152             module,
 153             global_asm: String::new(),
 154             constants_cx: ConstantCx::default(),
 155             cached_context: Context::new(),
 156             vtables: FxHashMap::default(),
 157             debug_context,
 158             unwind_context,
 159         }
 160     }
 161
 162     fn finalize(mut self) -> (Module<B>, String, Option<DebugContext<'tcx>>, UnwindContext<'tcx>) {
 163         self.constants_cx.finalize(self.tcx, &mut self.module);
 164         (self.module, self.global_asm, self.debug_context, self.unwind_context)
 165     }
 166 }
 167
 168 struct CraneliftCodegenBackend;
 169
 170 impl CodegenBackend for CraneliftCodegenBackend {
 171     fn init(&self, sess: &Session) {
 172         if sess.lto() != rustc_session::config::Lto::No && sess.opts.cg.embed_bitcode {
 173             sess.warn("LTO is not supported. You may get a linker error.");
 174         }
 175     }
 176
 177     fn metadata_loader(&self) -> Box<dyn MetadataLoader + Sync> {
 178         Box::new(crate::metadata::CraneliftMetadataLoader)
 179     }
 180
 181     fn provide(&self, providers: &mut Providers<'_>) {
 182         providers.target_features_whitelist = |tcx, cnum| {
 183             assert_eq!(cnum, LOCAL_CRATE);
 184             if tcx.sess.opts.actually_rustdoc {
 185                 // rustdoc needs to be able to document functions that use all the features, so
 186                 // whitelist them all
 187                 target_features_whitelist::all_known_features()
 188                     .chain(Some(("cg_clif", None)))
 189                     .map(|(a, b)| (a.to_string(), b))
 190                     .collect()
 191             } else {
 192                 target_features_whitelist::target_feature_whitelist(tcx.sess)
 193                     .iter()
 194                     .chain(&Some(("cg_clif", None)))
 195                     .map(|&(a, b)| (a.to_string(), b))
 196                     .collect()
 197             }
 198         };
 199     }
 200     fn provide_extern(&self, _providers: &mut Providers<'_>) {}
 201
 202     fn target_features(&self, _sess: &Session) -> Vec<rustc_span::Symbol> {
 203         vec![rustc_span::Symbol::intern("cg_clif")]
 204     }
 205
 206     fn codegen_crate<'tcx>(
 207         &self,
 208         tcx: TyCtxt<'tcx>,
 209         metadata: EncodedMetadata,
 210         need_metadata_module: bool,
 211     ) -> Box<dyn Any> {
 212         let res = driver::codegen_crate(tcx, metadata, need_metadata_module);
 213
 214         rustc_symbol_mangling::test::report_symbol_names(tcx);
 215
 216         res
 217     }
 218
 219     fn join_codegen(
 220         &self,
 221         ongoing_codegen: Box<dyn Any>,
 222         sess: &Session,
 223         dep_graph: &DepGraph,
 224     ) -> Result<Box<dyn Any>, ErrorReported> {
 225         let (codegen_results, work_products) = *ongoing_codegen.downcast::<(CodegenResults, FxHashMap<WorkProductId, WorkProduct>)>().unwrap();
 226
 227         sess.time("serialize_work_products", move || {
 228             rustc_incremental::save_work_product_index(sess, &dep_graph, work_products)
 229         });
 230
 231         Ok(Box::new(codegen_results))
 232     }
 233
 234     fn link(
 235         &self,
 236         sess: &Session,
 237         res: Box<dyn Any>,
 238         outputs: &OutputFilenames,
 239     ) -> Result<(), ErrorReported> {
 240         use rustc_codegen_ssa::back::link::link_binary;
 241
 242         sess.abort_if_errors();
 243
 244         let codegen_results = *res
 245             .downcast::<CodegenResults>()
 246             .expect("Expected CraneliftCodegenBackend's CodegenResult, found Box<Any>");
 247
 248         let _timer = sess.prof.generic_activity("link_crate");
 249
 250         sess.time("linking", || {
 251             let target_cpu = crate::target_triple(sess).to_string();
 252             link_binary::<crate::archive::ArArchiveBuilder<'_>>(
 253                 sess,
 254                 &codegen_results,
 255                 outputs,
 256                 &codegen_results.crate_name.as_str(),
 257                 &target_cpu,
 258             );
 259         });
 260
 261         rustc_incremental::finalize_session_directory(sess, codegen_results.crate_hash);
 262
 263         Ok(())
 264     }
 265 }
 266
 267 fn target_triple(sess: &Session) -> target_lexicon::Triple {
 268     sess.target.target.llvm_target.parse().unwrap()
 269 }
 270
 271 fn build_isa(sess: &Session, enable_pic: bool) -> Box<dyn isa::TargetIsa + 'static> {
 272     use target_lexicon::BinaryFormat;
 273
 274     let target_triple = crate::target_triple(sess);
 275
 276     let mut flags_builder = settings::builder();
 277     if enable_pic {
 278         flags_builder.enable("is_pic").unwrap();
 279     } else {
 280         flags_builder.set("is_pic", "false").unwrap();
 281     }
 282     flags_builder.set("enable_probestack", "false").unwrap(); // __cranelift_probestack is not provided
 283     flags_builder
 284         .set(
 285             "enable_verifier",
 286             if cfg!(debug_assertions) {
 287                 "true"
 288             } else {
 289                 "false"
 290             },
 291         )
 292         .unwrap();
 293
 294     let tls_model = match target_triple.binary_format {
 295         BinaryFormat::Elf => "elf_gd",
 296         BinaryFormat::Macho => "macho",
 297         BinaryFormat::Coff => "coff",
 298         _ => "none",
 299     };
 300     flags_builder.set("tls_model", tls_model).unwrap();
 301
 302     // FIXME(CraneStation/cranelift#732) fix LICM in presence of jump tables
 303     /*
 304     use rustc_session::config::OptLevel;
 305     match sess.opts.optimize {
 306         OptLevel::No => {
 307             flags_builder.set("opt_level", "none").unwrap();
 308         }
 309         OptLevel::Less | OptLevel::Default => {}
 310         OptLevel::Aggressive => {
 311             flags_builder.set("opt_level", "speed_and_size").unwrap();
 312         }
 313         OptLevel::Size | OptLevel::SizeMin => {
 314             sess.warn("Optimizing for size is not supported. Just ignoring the request");
 315         }
 316     }*/
 317
 318     let flags = settings::Flags::new(flags_builder);
 319     cranelift_codegen::isa::lookup(target_triple)
 320         .unwrap()
 321         .finish(flags)
 322 }
 323
 324 /// This is the entrypoint for a hot plugged rustc_codegen_cranelift
 325 #[no_mangle]
 326 pub fn __rustc_codegen_backend() -> Box<dyn CodegenBackend> {
 327     Box::new(CraneliftCodegenBackend)
 328 }