1 //! Mono Item Collection
2 //! ===========================
4 //! This module is responsible for discovering all items that will contribute to
5 //! to code generation of the crate. The important part here is that it not only
6 //! needs to find syntax-level items (functions, structs, etc) but also all
7 //! their monomorphized instantiations. Every non-generic, non-const function
8 //! maps to one LLVM artifact. Every generic function can produce
9 //! from zero to N artifacts, depending on the sets of type arguments it
10 //! is instantiated with.
11 //! This also applies to generic items from other crates: A generic definition
12 //! in crate X might produce monomorphizations that are compiled into crate Y.
13 //! We also have to collect these here.
15 //! The following kinds of "mono items" are handled here:
23 //! The following things also result in LLVM artifacts, but are not collected
24 //! here, since we instantiate them locally on demand when needed in a given
34 //! Let's define some terms first:
36 //! - A "mono item" is something that results in a function or global in
37 //! the LLVM IR of a codegen unit. Mono items do not stand on their
38 //! own, they can reference other mono items. For example, if function
39 //! `foo()` calls function `bar()` then the mono item for `foo()`
40 //! references the mono item for function `bar()`. In general, the
41 //! definition for mono item A referencing a mono item B is that
42 //! the LLVM artifact produced for A references the LLVM artifact produced
45 //! - Mono items and the references between them form a directed graph,
46 //! where the mono items are the nodes and references form the edges.
47 //! Let's call this graph the "mono item graph".
49 //! - The mono item graph for a program contains all mono items
50 //! that are needed in order to produce the complete LLVM IR of the program.
52 //! The purpose of the algorithm implemented in this module is to build the
53 //! mono item graph for the current crate. It runs in two phases:
55 //! 1. Discover the roots of the graph by traversing the HIR of the crate.
56 //! 2. Starting from the roots, find neighboring nodes by inspecting the MIR
57 //! representation of the item corresponding to a given node, until no more
58 //! new nodes are found.
60 //! ### Discovering roots
62 //! The roots of the mono item graph correspond to the non-generic
63 //! syntactic items in the source code. We find them by walking the HIR of the
64 //! crate, and whenever we hit upon a function, method, or static item, we
65 //! create a mono item consisting of the items DefId and, since we only
66 //! consider non-generic items, an empty type-substitution set.
68 //! ### Finding neighbor nodes
69 //! Given a mono item node, we can discover neighbors by inspecting its
70 //! MIR. We walk the MIR and any time we hit upon something that signifies a
71 //! reference to another mono item, we have found a neighbor. Since the
72 //! mono item we are currently at is always monomorphic, we also know the
73 //! concrete type arguments of its neighbors, and so all neighbors again will be
74 //! monomorphic. The specific forms a reference to a neighboring node can take
75 //! in MIR are quite diverse. Here is an overview:
77 //! #### Calling Functions/Methods
78 //! The most obvious form of one mono item referencing another is a
79 //! function or method call (represented by a CALL terminator in MIR). But
80 //! calls are not the only thing that might introduce a reference between two
81 //! function mono items, and as we will see below, they are just a
82 //! specialized of the form described next, and consequently will don't get any
83 //! special treatment in the algorithm.
85 //! #### Taking a reference to a function or method
86 //! A function does not need to actually be called in order to be a neighbor of
87 //! another function. It suffices to just take a reference in order to introduce
88 //! an edge. Consider the following example:
91 //! fn print_val<T: Display>(x: T) {
92 //! println!("{}", x);
95 //! fn call_fn(f: &Fn(i32), x: i32) {
100 //! let print_i32 = print_val::<i32>;
101 //! call_fn(&print_i32, 0);
104 //! The MIR of none of these functions will contain an explicit call to
105 //! `print_val::<i32>`. Nonetheless, in order to mono this program, we need
106 //! an instance of this function. Thus, whenever we encounter a function or
107 //! method in operand position, we treat it as a neighbor of the current
108 //! mono item. Calls are just a special case of that.
111 //! In a way, closures are a simple case. Since every closure object needs to be
112 //! constructed somewhere, we can reliably discover them by observing
113 //! `RValue::Aggregate` expressions with `AggregateKind::Closure`. This is also
114 //! true for closures inlined from other crates.
117 //! Drop glue mono items are introduced by MIR drop-statements. The
118 //! generated mono item will again have drop-glue item neighbors if the
119 //! type to be dropped contains nested values that also need to be dropped. It
120 //! might also have a function item neighbor for the explicit `Drop::drop`
121 //! implementation of its type.
123 //! #### Unsizing Casts
124 //! A subtle way of introducing neighbor edges is by casting to a trait object.
125 //! Since the resulting fat-pointer contains a reference to a vtable, we need to
126 //! instantiate all object-save methods of the trait, as we need to store
127 //! pointers to these functions even if they never get called anywhere. This can
128 //! be seen as a special case of taking a function reference.
131 //! Since `Box` expression have special compiler support, no explicit calls to
132 //! `exchange_malloc()` and `box_free()` may show up in MIR, even if the
133 //! compiler will generate them. We have to observe `Rvalue::Box` expressions
134 //! and Box-typed drop-statements for that purpose.
137 //! Interaction with Cross-Crate Inlining
138 //! -------------------------------------
139 //! The binary of a crate will not only contain machine code for the items
140 //! defined in the source code of that crate. It will also contain monomorphic
141 //! instantiations of any extern generic functions and of functions marked with
143 //! The collection algorithm handles this more or less mono. If it is
144 //! about to create a mono item for something with an external `DefId`,
145 //! it will take a look if the MIR for that item is available, and if so just
146 //! proceed normally. If the MIR is not available, it assumes that the item is
147 //! just linked to and no node is created; which is exactly what we want, since
148 //! no machine code should be generated in the current crate for such an item.
150 //! Eager and Lazy Collection Mode
151 //! ------------------------------
152 //! Mono item collection can be performed in one of two modes:
154 //! - Lazy mode means that items will only be instantiated when actually
155 //! referenced. The goal is to produce the least amount of machine code
158 //! - Eager mode is meant to be used in conjunction with incremental compilation
159 //! where a stable set of mono items is more important than a minimal
160 //! one. Thus, eager mode will instantiate drop-glue for every drop-able type
161 //! in the crate, even of no drop call for that type exists (yet). It will
162 //! also instantiate default implementations of trait methods, something that
163 //! otherwise is only done on demand.
168 //! Some things are not yet fully implemented in the current version of this
172 //! Ideally, no mono item should be generated for const fns unless there
173 //! is a call to them that cannot be evaluated at compile time. At the moment
174 //! this is not implemented however: a mono item will be produced
175 //! regardless of whether it is actually needed or not.
177 use rustc::hir::{self, CodegenFnAttrFlags};
178 use rustc::hir::itemlikevisit::ItemLikeVisitor;
180 use rustc::hir::def_id::{DefId, LOCAL_CRATE};
181 use rustc::mir::interpret::{AllocId, ConstValue};
182 use rustc::middle::lang_items::{ExchangeMallocFnLangItem, StartFnLangItem};
183 use rustc::ty::subst::{InternalSubsts, SubstsRef};
184 use rustc::ty::{self, TypeFoldable, Ty, TyCtxt, GenericParamDefKind};
185 use rustc::ty::adjustment::CustomCoerceUnsized;
186 use rustc::session::config::EntryFnType;
187 use rustc::mir::{self, Location, Promoted};
188 use rustc::mir::visit::Visitor as MirVisitor;
189 use rustc::mir::mono::MonoItem;
190 use rustc::mir::interpret::{Scalar, GlobalId, AllocKind, ErrorHandled};
192 use crate::monomorphize::{self, Instance};
193 use rustc::util::nodemap::{FxHashSet, FxHashMap, DefIdMap};
194 use rustc::util::common::time;
196 use crate::monomorphize::item::{MonoItemExt, DefPathBasedNames, InstantiationMode};
198 use rustc_data_structures::bit_set::GrowableBitSet;
199 use rustc_data_structures::sync::{MTRef, MTLock, ParallelIterator, par_iter};
203 #[derive(PartialEq, Eq, Hash, Clone, Copy, Debug)]
204 pub enum MonoItemCollectionMode {
209 /// Maps every mono item to all mono items it references in its
211 pub struct InliningMap<'tcx> {
212 // Maps a source mono item to the range of mono items
214 // The two numbers in the tuple are the start (inclusive) and
215 // end index (exclusive) within the `targets` vecs.
216 index: FxHashMap<MonoItem<'tcx>, (usize, usize)>,
217 targets: Vec<MonoItem<'tcx>>,
219 // Contains one bit per mono item in the `targets` field. That bit
220 // is true if that mono item needs to be inlined into every CGU.
221 inlines: GrowableBitSet<usize>,
224 impl<'tcx> InliningMap<'tcx> {
226 fn new() -> InliningMap<'tcx> {
228 index: FxHashMap::default(),
230 inlines: GrowableBitSet::with_capacity(1024),
234 fn record_accesses<I>(&mut self,
235 source: MonoItem<'tcx>,
237 where I: Iterator<Item=(MonoItem<'tcx>, bool)> + ExactSizeIterator
239 assert!(!self.index.contains_key(&source));
241 let start_index = self.targets.len();
242 let new_items_count = new_targets.len();
243 let new_items_count_total = new_items_count + self.targets.len();
245 self.targets.reserve(new_items_count);
246 self.inlines.ensure(new_items_count_total);
248 for (i, (target, inline)) in new_targets.enumerate() {
249 self.targets.push(target);
251 self.inlines.insert(i + start_index);
255 let end_index = self.targets.len();
256 self.index.insert(source, (start_index, end_index));
259 // Internally iterate over all items referenced by `source` which will be
260 // made available for inlining.
261 pub fn with_inlining_candidates<F>(&self, source: MonoItem<'tcx>, mut f: F)
262 where F: FnMut(MonoItem<'tcx>)
264 if let Some(&(start_index, end_index)) = self.index.get(&source) {
265 for (i, candidate) in self.targets[start_index .. end_index]
268 if self.inlines.contains(start_index + i) {
275 // Internally iterate over all items and the things each accesses.
276 pub fn iter_accesses<F>(&self, mut f: F)
277 where F: FnMut(MonoItem<'tcx>, &[MonoItem<'tcx>])
279 for (&accessor, &(start_index, end_index)) in &self.index {
280 f(accessor, &self.targets[start_index .. end_index])
285 pub fn collect_crate_mono_items<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
286 mode: MonoItemCollectionMode)
287 -> (FxHashSet<MonoItem<'tcx>>,
289 let roots = time(tcx.sess, "collecting roots", || {
290 collect_roots(tcx, mode)
293 debug!("Building mono item graph, beginning at roots");
295 let mut visited = MTLock::new(FxHashSet::default());
296 let mut inlining_map = MTLock::new(InliningMap::new());
299 let visited: MTRef<'_, _> = &mut visited;
300 let inlining_map: MTRef<'_, _> = &mut inlining_map;
302 time(tcx.sess, "collecting mono items", || {
303 par_iter(roots).for_each(|root| {
304 let mut recursion_depths = DefIdMap::default();
305 collect_items_rec(tcx,
308 &mut recursion_depths,
314 (visited.into_inner(), inlining_map.into_inner())
317 // Find all non-generic items by walking the HIR. These items serve as roots to
318 // start monomorphizing from.
319 fn collect_roots<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
320 mode: MonoItemCollectionMode)
321 -> Vec<MonoItem<'tcx>> {
322 debug!("Collecting roots");
323 let mut roots = Vec::new();
326 let entry_fn = tcx.entry_fn(LOCAL_CRATE);
328 debug!("collect_roots: entry_fn = {:?}", entry_fn);
330 let mut visitor = RootCollector {
337 tcx.hir().krate().visit_all_item_likes(&mut visitor);
339 visitor.push_extra_entry_roots();
342 // We can only codegen items that are instantiable - items all of
343 // whose predicates hold. Luckily, items that aren't instantiable
344 // can't actually be used, so we can just skip codegenning them.
345 roots.retain(|root| root.is_instantiable(tcx));
350 // Collect all monomorphized items reachable from `starting_point`
351 fn collect_items_rec<'a, 'tcx: 'a>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
352 starting_point: MonoItem<'tcx>,
353 visited: MTRef<'_, MTLock<FxHashSet<MonoItem<'tcx>>>>,
354 recursion_depths: &mut DefIdMap<usize>,
355 inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>) {
356 if !visited.lock_mut().insert(starting_point.clone()) {
357 // We've been here already, no need to search again.
360 debug!("BEGIN collect_items_rec({})", starting_point.to_string(tcx, true));
362 let mut neighbors = Vec::new();
363 let recursion_depth_reset;
365 match starting_point {
366 MonoItem::Static(def_id) => {
367 let instance = Instance::mono(tcx, def_id);
369 // Sanity check whether this ended up being collected accidentally
370 debug_assert!(should_monomorphize_locally(tcx, &instance));
372 let ty = instance.ty(tcx);
373 visit_drop_use(tcx, ty, true, &mut neighbors);
375 recursion_depth_reset = None;
381 let param_env = ty::ParamEnv::reveal_all();
383 if let Ok(val) = tcx.const_eval(param_env.and(cid)) {
384 collect_const(tcx, val, InternalSubsts::empty(), &mut neighbors);
387 MonoItem::Fn(instance) => {
388 // Sanity check whether this ended up being collected accidentally
389 debug_assert!(should_monomorphize_locally(tcx, &instance));
391 // Keep track of the monomorphization recursion depth
392 recursion_depth_reset = Some(check_recursion_limit(tcx,
395 check_type_length_limit(tcx, instance);
397 collect_neighbours(tcx, instance, &mut neighbors);
399 MonoItem::GlobalAsm(..) => {
400 recursion_depth_reset = None;
404 record_accesses(tcx, starting_point, &neighbors[..], inlining_map);
406 for neighbour in neighbors {
407 collect_items_rec(tcx, neighbour, visited, recursion_depths, inlining_map);
410 if let Some((def_id, depth)) = recursion_depth_reset {
411 recursion_depths.insert(def_id, depth);
414 debug!("END collect_items_rec({})", starting_point.to_string(tcx, true));
417 fn record_accesses<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
418 caller: MonoItem<'tcx>,
419 callees: &[MonoItem<'tcx>],
420 inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>) {
421 let is_inlining_candidate = |mono_item: &MonoItem<'tcx>| {
422 mono_item.instantiation_mode(tcx) == InstantiationMode::LocalCopy
425 let accesses = callees.into_iter()
427 (*mono_item, is_inlining_candidate(mono_item))
430 inlining_map.lock_mut().record_accesses(caller, accesses);
433 fn check_recursion_limit<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
434 instance: Instance<'tcx>,
435 recursion_depths: &mut DefIdMap<usize>)
437 let def_id = instance.def_id();
438 let recursion_depth = recursion_depths.get(&def_id).cloned().unwrap_or(0);
439 debug!(" => recursion depth={}", recursion_depth);
441 let recursion_depth = if Some(def_id) == tcx.lang_items().drop_in_place_fn() {
442 // HACK: drop_in_place creates tight monomorphization loops. Give
449 // Code that needs to instantiate the same function recursively
450 // more than the recursion limit is assumed to be causing an
451 // infinite expansion.
452 if recursion_depth > *tcx.sess.recursion_limit.get() {
453 let error = format!("reached the recursion limit while instantiating `{}`",
455 if let Some(hir_id) = tcx.hir().as_local_hir_id(def_id) {
456 tcx.sess.span_fatal(tcx.hir().span_by_hir_id(hir_id), &error);
458 tcx.sess.fatal(&error);
462 recursion_depths.insert(def_id, recursion_depth + 1);
464 (def_id, recursion_depth)
467 fn check_type_length_limit<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
468 instance: Instance<'tcx>)
470 let type_length = instance.substs.types().flat_map(|ty| ty.walk()).count();
471 let const_length = instance.substs.consts().flat_map(|ct| ct.ty.walk()).count();
472 debug!(" => type length={}, const length={}", type_length, const_length);
474 // Rust code can easily create exponentially-long types using only a
475 // polynomial recursion depth. Even with the default recursion
476 // depth, you can easily get cases that take >2^60 steps to run,
477 // which means that rustc basically hangs.
479 // Bail out in these cases to avoid that bad user experience.
480 let type_length_limit = *tcx.sess.type_length_limit.get();
481 // We include the const length in the type length, as it's better
482 // to be overly conservative.
483 if type_length + const_length > type_length_limit {
484 // The instance name is already known to be too long for rustc.
485 // Show only the first and last 32 characters to avoid blasting
486 // the user's terminal with thousands of lines of type-name.
487 let shrink = |s: String, before: usize, after: usize| {
488 // An iterator of all byte positions including the end of the string.
489 let positions = || s.char_indices().map(|(i, _)| i).chain(iter::once(s.len()));
491 let shrunk = format!(
492 "{before}...{after}",
493 before = &s[..positions().nth(before).unwrap_or(s.len())],
494 after = &s[positions().rev().nth(after).unwrap_or(0)..],
497 // Only use the shrunk version if it's really shorter.
498 // This also avoids the case where before and after slices overlap.
499 if shrunk.len() < s.len() {
505 let msg = format!("reached the type-length limit while instantiating `{}`",
506 shrink(instance.to_string(), 32, 32));
507 let mut diag = tcx.sess.struct_span_fatal(tcx.def_span(instance.def_id()), &msg);
509 "consider adding a `#![type_length_limit=\"{}\"]` attribute to your crate",
512 tcx.sess.abort_if_errors();
516 struct MirNeighborCollector<'a, 'tcx: 'a> {
517 tcx: TyCtxt<'a, 'tcx, 'tcx>,
518 mir: &'a mir::Mir<'tcx>,
519 output: &'a mut Vec<MonoItem<'tcx>>,
520 param_substs: SubstsRef<'tcx>,
523 impl<'a, 'tcx> MirVisitor<'tcx> for MirNeighborCollector<'a, 'tcx> {
525 fn visit_rvalue(&mut self, rvalue: &mir::Rvalue<'tcx>, location: Location) {
526 debug!("visiting rvalue {:?}", *rvalue);
529 // When doing an cast from a regular pointer to a fat pointer, we
530 // have to instantiate all methods of the trait being cast to, so we
531 // can build the appropriate vtable.
532 mir::Rvalue::Cast(mir::CastKind::Unsize, ref operand, target_ty) => {
533 let target_ty = self.tcx.subst_and_normalize_erasing_regions(
535 ty::ParamEnv::reveal_all(),
538 let source_ty = operand.ty(self.mir, self.tcx);
539 let source_ty = self.tcx.subst_and_normalize_erasing_regions(
541 ty::ParamEnv::reveal_all(),
544 let (source_ty, target_ty) = find_vtable_types_for_unsizing(self.tcx,
547 // This could also be a different Unsize instruction, like
548 // from a fixed sized array to a slice. But we are only
549 // interested in things that produce a vtable.
550 if target_ty.is_trait() && !source_ty.is_trait() {
551 create_mono_items_for_vtable_methods(self.tcx,
557 mir::Rvalue::Cast(mir::CastKind::ReifyFnPointer, ref operand, _) => {
558 let fn_ty = operand.ty(self.mir, self.tcx);
559 let fn_ty = self.tcx.subst_and_normalize_erasing_regions(
561 ty::ParamEnv::reveal_all(),
564 visit_fn_use(self.tcx, fn_ty, false, &mut self.output);
566 mir::Rvalue::Cast(mir::CastKind::ClosureFnPointer, ref operand, _) => {
567 let source_ty = operand.ty(self.mir, self.tcx);
568 let source_ty = self.tcx.subst_and_normalize_erasing_regions(
570 ty::ParamEnv::reveal_all(),
573 match source_ty.sty {
574 ty::Closure(def_id, substs) => {
575 let instance = monomorphize::resolve_closure(
576 self.tcx, def_id, substs, ty::ClosureKind::FnOnce);
577 if should_monomorphize_locally(self.tcx, &instance) {
578 self.output.push(create_fn_mono_item(instance));
584 mir::Rvalue::NullaryOp(mir::NullOp::Box, _) => {
586 let exchange_malloc_fn_def_id = tcx
588 .require(ExchangeMallocFnLangItem)
589 .unwrap_or_else(|e| tcx.sess.fatal(&e));
590 let instance = Instance::mono(tcx, exchange_malloc_fn_def_id);
591 if should_monomorphize_locally(tcx, &instance) {
592 self.output.push(create_fn_mono_item(instance));
595 _ => { /* not interesting */ }
598 self.super_rvalue(rvalue, location);
601 fn visit_const(&mut self, constant: &&'tcx ty::Const<'tcx>, location: Location) {
602 debug!("visiting const {:?} @ {:?}", *constant, location);
604 collect_const(self.tcx, **constant, self.param_substs, self.output);
606 self.super_const(constant);
609 fn visit_terminator_kind(&mut self,
610 block: mir::BasicBlock,
611 kind: &mir::TerminatorKind<'tcx>,
612 location: Location) {
613 debug!("visiting terminator {:?} @ {:?}", kind, location);
617 mir::TerminatorKind::Call { ref func, .. } => {
618 let callee_ty = func.ty(self.mir, tcx);
619 let callee_ty = tcx.subst_and_normalize_erasing_regions(
621 ty::ParamEnv::reveal_all(),
624 visit_fn_use(self.tcx, callee_ty, true, &mut self.output);
626 mir::TerminatorKind::Drop { ref location, .. } |
627 mir::TerminatorKind::DropAndReplace { ref location, .. } => {
628 let ty = location.ty(self.mir, self.tcx)
630 let ty = tcx.subst_and_normalize_erasing_regions(
632 ty::ParamEnv::reveal_all(),
635 visit_drop_use(self.tcx, ty, true, self.output);
637 mir::TerminatorKind::Goto { .. } |
638 mir::TerminatorKind::SwitchInt { .. } |
639 mir::TerminatorKind::Resume |
640 mir::TerminatorKind::Abort |
641 mir::TerminatorKind::Return |
642 mir::TerminatorKind::Unreachable |
643 mir::TerminatorKind::Assert { .. } => {}
644 mir::TerminatorKind::GeneratorDrop |
645 mir::TerminatorKind::Yield { .. } |
646 mir::TerminatorKind::FalseEdges { .. } |
647 mir::TerminatorKind::FalseUnwind { .. } => bug!(),
650 self.super_terminator_kind(block, kind, location);
653 fn visit_static(&mut self,
654 static_: &mir::Static<'tcx>,
655 context: mir::visit::PlaceContext<'tcx>,
656 location: Location) {
657 debug!("visiting static {:?} @ {:?}", static_.def_id, location);
660 let instance = Instance::mono(tcx, static_.def_id);
661 if should_monomorphize_locally(tcx, &instance) {
662 self.output.push(MonoItem::Static(static_.def_id));
665 self.super_static(static_, context, location);
669 fn visit_drop_use<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
671 is_direct_call: bool,
672 output: &mut Vec<MonoItem<'tcx>>)
674 let instance = monomorphize::resolve_drop_in_place(tcx, ty);
675 visit_instance_use(tcx, instance, is_direct_call, output);
678 fn visit_fn_use<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
680 is_direct_call: bool,
681 output: &mut Vec<MonoItem<'tcx>>)
683 if let ty::FnDef(def_id, substs) = ty.sty {
684 let instance = ty::Instance::resolve(tcx,
685 ty::ParamEnv::reveal_all(),
688 visit_instance_use(tcx, instance, is_direct_call, output);
692 fn visit_instance_use<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
693 instance: ty::Instance<'tcx>,
694 is_direct_call: bool,
695 output: &mut Vec<MonoItem<'tcx>>)
697 debug!("visit_item_use({:?}, is_direct_call={:?})", instance, is_direct_call);
698 if !should_monomorphize_locally(tcx, &instance) {
703 ty::InstanceDef::Intrinsic(def_id) => {
705 bug!("intrinsic {:?} being reified", def_id);
708 ty::InstanceDef::VtableShim(..) |
709 ty::InstanceDef::Virtual(..) |
710 ty::InstanceDef::DropGlue(_, None) => {
711 // don't need to emit shim if we are calling directly.
713 output.push(create_fn_mono_item(instance));
716 ty::InstanceDef::DropGlue(_, Some(_)) => {
717 output.push(create_fn_mono_item(instance));
719 ty::InstanceDef::ClosureOnceShim { .. } |
720 ty::InstanceDef::Item(..) |
721 ty::InstanceDef::FnPtrShim(..) |
722 ty::InstanceDef::CloneShim(..) => {
723 output.push(create_fn_mono_item(instance));
728 // Returns true if we should codegen an instance in the local crate.
729 // Returns false if we can just link to the upstream crate and therefore don't
731 fn should_monomorphize_locally<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, instance: &Instance<'tcx>)
733 let def_id = match instance.def {
734 ty::InstanceDef::Item(def_id) => def_id,
735 ty::InstanceDef::VtableShim(..) |
736 ty::InstanceDef::ClosureOnceShim { .. } |
737 ty::InstanceDef::Virtual(..) |
738 ty::InstanceDef::FnPtrShim(..) |
739 ty::InstanceDef::DropGlue(..) |
740 ty::InstanceDef::Intrinsic(_) |
741 ty::InstanceDef::CloneShim(..) => return true
744 if tcx.is_foreign_item(def_id) {
745 // We can always link to foreign items
749 if def_id.is_local() {
750 // local items cannot be referred to locally without monomorphizing them locally
754 if tcx.is_reachable_non_generic(def_id) ||
755 is_available_upstream_generic(tcx, def_id, instance.substs) {
756 // We can link to the item in question, no instance needed
761 if !tcx.is_mir_available(def_id) {
762 bug!("Cannot create local mono-item for {:?}", def_id)
766 fn is_available_upstream_generic<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
768 substs: SubstsRef<'tcx>)
770 debug_assert!(!def_id.is_local());
772 // If we are not in share generics mode, we don't link to upstream
773 // monomorphizations but always instantiate our own internal versions
775 if !tcx.sess.opts.share_generics() {
779 // If this instance has non-erasable parameters, it cannot be a shared
780 // monomorphization. Non-generic instances are already handled above
781 // by `is_reachable_non_generic()`
782 if substs.non_erasable_generics().next().is_none() {
786 // Take a look at the available monomorphizations listed in the metadata
787 // of upstream crates.
788 tcx.upstream_monomorphizations_for(def_id)
789 .map(|set| set.contains_key(substs))
794 /// For given pair of source and target type that occur in an unsizing coercion,
795 /// this function finds the pair of types that determines the vtable linking
798 /// For example, the source type might be `&SomeStruct` and the target type\
799 /// might be `&SomeTrait` in a cast like:
801 /// let src: &SomeStruct = ...;
802 /// let target = src as &SomeTrait;
804 /// Then the output of this function would be (SomeStruct, SomeTrait) since for
805 /// constructing the `target` fat-pointer we need the vtable for that pair.
807 /// Things can get more complicated though because there's also the case where
808 /// the unsized type occurs as a field:
811 /// struct ComplexStruct<T: ?Sized> {
818 /// In this case, if `T` is sized, `&ComplexStruct<T>` is a thin pointer. If `T`
819 /// is unsized, `&SomeStruct` is a fat pointer, and the vtable it points to is
820 /// for the pair of `T` (which is a trait) and the concrete type that `T` was
821 /// originally coerced from:
823 /// let src: &ComplexStruct<SomeStruct> = ...;
824 /// let target = src as &ComplexStruct<SomeTrait>;
826 /// Again, we want this `find_vtable_types_for_unsizing()` to provide the pair
827 /// `(SomeStruct, SomeTrait)`.
829 /// Finally, there is also the case of custom unsizing coercions, e.g., for
830 /// smart pointers such as `Rc` and `Arc`.
831 fn find_vtable_types_for_unsizing<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
834 -> (Ty<'tcx>, Ty<'tcx>) {
835 let ptr_vtable = |inner_source: Ty<'tcx>, inner_target: Ty<'tcx>| {
836 let type_has_metadata = |ty: Ty<'tcx>| -> bool {
837 use syntax_pos::DUMMY_SP;
838 if ty.is_sized(tcx.at(DUMMY_SP), ty::ParamEnv::reveal_all()) {
841 let tail = tcx.struct_tail(ty);
843 ty::Foreign(..) => false,
844 ty::Str | ty::Slice(..) | ty::Dynamic(..) => true,
845 _ => bug!("unexpected unsized tail: {:?}", tail),
848 if type_has_metadata(inner_source) {
849 (inner_source, inner_target)
851 tcx.struct_lockstep_tails(inner_source, inner_target)
855 match (&source_ty.sty, &target_ty.sty) {
859 &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) |
860 (&ty::RawPtr(ty::TypeAndMut { ty: a, .. }),
861 &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) => {
864 (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
865 ptr_vtable(source_ty.boxed_ty(), target_ty.boxed_ty())
868 (&ty::Adt(source_adt_def, source_substs),
869 &ty::Adt(target_adt_def, target_substs)) => {
870 assert_eq!(source_adt_def, target_adt_def);
873 monomorphize::custom_coerce_unsize_info(tcx, source_ty, target_ty);
875 let coerce_index = match kind {
876 CustomCoerceUnsized::Struct(i) => i
879 let source_fields = &source_adt_def.non_enum_variant().fields;
880 let target_fields = &target_adt_def.non_enum_variant().fields;
882 assert!(coerce_index < source_fields.len() &&
883 source_fields.len() == target_fields.len());
885 find_vtable_types_for_unsizing(tcx,
886 source_fields[coerce_index].ty(tcx,
888 target_fields[coerce_index].ty(tcx,
891 _ => bug!("find_vtable_types_for_unsizing: invalid coercion {:?} -> {:?}",
897 fn create_fn_mono_item<'a, 'tcx>(instance: Instance<'tcx>) -> MonoItem<'tcx> {
898 debug!("create_fn_mono_item(instance={})", instance);
899 MonoItem::Fn(instance)
902 /// Creates a `MonoItem` for each method that is referenced by the vtable for
903 /// the given trait/impl pair.
904 fn create_mono_items_for_vtable_methods<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
907 output: &mut Vec<MonoItem<'tcx>>) {
908 assert!(!trait_ty.needs_subst() && !trait_ty.has_escaping_bound_vars() &&
909 !impl_ty.needs_subst() && !impl_ty.has_escaping_bound_vars());
911 if let ty::Dynamic(ref trait_ty, ..) = trait_ty.sty {
912 if let Some(principal) = trait_ty.principal() {
913 let poly_trait_ref = principal.with_self_ty(tcx, impl_ty);
914 assert!(!poly_trait_ref.has_escaping_bound_vars());
916 // Walk all methods of the trait, including those of its supertraits
917 let methods = tcx.vtable_methods(poly_trait_ref);
918 let methods = methods.iter().cloned().filter_map(|method| method)
919 .map(|(def_id, substs)| ty::Instance::resolve_for_vtable(
921 ty::ParamEnv::reveal_all(),
924 .filter(|&instance| should_monomorphize_locally(tcx, &instance))
925 .map(|instance| create_fn_mono_item(instance));
926 output.extend(methods);
929 // Also add the destructor
930 visit_drop_use(tcx, impl_ty, false, output);
934 //=-----------------------------------------------------------------------------
936 //=-----------------------------------------------------------------------------
938 struct RootCollector<'b, 'a: 'b, 'tcx: 'a + 'b> {
939 tcx: TyCtxt<'a, 'tcx, 'tcx>,
940 mode: MonoItemCollectionMode,
941 output: &'b mut Vec<MonoItem<'tcx>>,
942 entry_fn: Option<(DefId, EntryFnType)>,
945 impl<'b, 'a, 'v> ItemLikeVisitor<'v> for RootCollector<'b, 'a, 'v> {
946 fn visit_item(&mut self, item: &'v hir::Item) {
948 hir::ItemKind::ExternCrate(..) |
949 hir::ItemKind::Use(..) |
950 hir::ItemKind::ForeignMod(..) |
951 hir::ItemKind::Ty(..) |
952 hir::ItemKind::Trait(..) |
953 hir::ItemKind::TraitAlias(..) |
954 hir::ItemKind::Existential(..) |
955 hir::ItemKind::Mod(..) => {
956 // Nothing to do, just keep recursing...
959 hir::ItemKind::Impl(..) => {
960 if self.mode == MonoItemCollectionMode::Eager {
961 create_mono_items_for_default_impls(self.tcx,
967 hir::ItemKind::Enum(_, ref generics) |
968 hir::ItemKind::Struct(_, ref generics) |
969 hir::ItemKind::Union(_, ref generics) => {
970 if generics.params.is_empty() {
971 if self.mode == MonoItemCollectionMode::Eager {
972 let def_id = self.tcx.hir().local_def_id_from_hir_id(item.hir_id);
973 debug!("RootCollector: ADT drop-glue for {}",
974 def_id_to_string(self.tcx, def_id));
976 let ty = Instance::new(def_id, InternalSubsts::empty()).ty(self.tcx);
977 visit_drop_use(self.tcx, ty, true, self.output);
981 hir::ItemKind::GlobalAsm(..) => {
982 debug!("RootCollector: ItemKind::GlobalAsm({})",
983 def_id_to_string(self.tcx,
984 self.tcx.hir().local_def_id_from_hir_id(item.hir_id)));
985 self.output.push(MonoItem::GlobalAsm(item.hir_id));
987 hir::ItemKind::Static(..) => {
988 let def_id = self.tcx.hir().local_def_id_from_hir_id(item.hir_id);
989 debug!("RootCollector: ItemKind::Static({})",
990 def_id_to_string(self.tcx, def_id));
991 self.output.push(MonoItem::Static(def_id));
993 hir::ItemKind::Const(..) => {
994 // const items only generate mono items if they are
995 // actually used somewhere. Just declaring them is insufficient.
997 // but even just declaring them must collect the items they refer to
998 let def_id = self.tcx.hir().local_def_id_from_hir_id(item.hir_id);
1000 let instance = Instance::mono(self.tcx, def_id);
1001 let cid = GlobalId {
1005 let param_env = ty::ParamEnv::reveal_all();
1007 if let Ok(val) = self.tcx.const_eval(param_env.and(cid)) {
1008 collect_const(self.tcx, val, InternalSubsts::empty(), &mut self.output);
1011 hir::ItemKind::Fn(..) => {
1012 let def_id = self.tcx.hir().local_def_id_from_hir_id(item.hir_id);
1013 self.push_if_root(def_id);
1018 fn visit_trait_item(&mut self, _: &'v hir::TraitItem) {
1019 // Even if there's a default body with no explicit generics,
1020 // it's still generic over some `Self: Trait`, so not a root.
1023 fn visit_impl_item(&mut self, ii: &'v hir::ImplItem) {
1025 hir::ImplItemKind::Method(hir::MethodSig { .. }, _) => {
1026 let def_id = self.tcx.hir().local_def_id_from_hir_id(ii.hir_id);
1027 self.push_if_root(def_id);
1029 _ => { /* Nothing to do here */ }
1034 impl<'b, 'a, 'v> RootCollector<'b, 'a, 'v> {
1035 fn is_root(&self, def_id: DefId) -> bool {
1036 !item_has_type_parameters(self.tcx, def_id) && match self.mode {
1037 MonoItemCollectionMode::Eager => {
1040 MonoItemCollectionMode::Lazy => {
1041 self.entry_fn.map(|(id, _)| id) == Some(def_id) ||
1042 self.tcx.is_reachable_non_generic(def_id) ||
1043 self.tcx.codegen_fn_attrs(def_id).flags.contains(
1044 CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL)
1049 /// If `def_id` represents a root, then push it onto the list of
1050 /// outputs. (Note that all roots must be monomorphic.)
1051 fn push_if_root(&mut self, def_id: DefId) {
1052 if self.is_root(def_id) {
1053 debug!("RootCollector::push_if_root: found root def_id={:?}", def_id);
1055 let instance = Instance::mono(self.tcx, def_id);
1056 self.output.push(create_fn_mono_item(instance));
1060 /// As a special case, when/if we encounter the
1061 /// `main()` function, we also have to generate a
1062 /// monomorphized copy of the start lang item based on
1063 /// the return type of `main`. This is not needed when
1064 /// the user writes their own `start` manually.
1065 fn push_extra_entry_roots(&mut self) {
1066 let main_def_id = match self.entry_fn {
1067 Some((def_id, EntryFnType::Main)) => def_id,
1071 let start_def_id = match self.tcx.lang_items().require(StartFnLangItem) {
1073 Err(err) => self.tcx.sess.fatal(&err),
1075 let main_ret_ty = self.tcx.fn_sig(main_def_id).output();
1077 // Given that `main()` has no arguments,
1078 // then its return type cannot have
1079 // late-bound regions, since late-bound
1080 // regions must appear in the argument
1082 let main_ret_ty = self.tcx.erase_regions(
1083 &main_ret_ty.no_bound_vars().unwrap(),
1086 let start_instance = Instance::resolve(
1088 ty::ParamEnv::reveal_all(),
1090 self.tcx.intern_substs(&[main_ret_ty.into()])
1093 self.output.push(create_fn_mono_item(start_instance));
1097 fn item_has_type_parameters<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> bool {
1098 let generics = tcx.generics_of(def_id);
1099 generics.requires_monomorphization(tcx)
1102 fn create_mono_items_for_default_impls<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1103 item: &'tcx hir::Item,
1104 output: &mut Vec<MonoItem<'tcx>>) {
1106 hir::ItemKind::Impl(_, _, _, ref generics, .., ref impl_item_refs) => {
1107 for param in &generics.params {
1109 hir::GenericParamKind::Lifetime { .. } => {}
1110 hir::GenericParamKind::Type { .. } |
1111 hir::GenericParamKind::Const { .. } => {
1117 let impl_def_id = tcx.hir().local_def_id_from_hir_id(item.hir_id);
1119 debug!("create_mono_items_for_default_impls(item={})",
1120 def_id_to_string(tcx, impl_def_id));
1122 if let Some(trait_ref) = tcx.impl_trait_ref(impl_def_id) {
1123 let overridden_methods: FxHashSet<_> =
1124 impl_item_refs.iter()
1125 .map(|iiref| iiref.ident.modern())
1127 for method in tcx.provided_trait_methods(trait_ref.def_id) {
1128 if overridden_methods.contains(&method.ident.modern()) {
1132 let counts = tcx.generics_of(method.def_id).own_counts();
1133 if counts.types + counts.consts != 0 {
1137 let substs = InternalSubsts::for_item(tcx, method.def_id, |param, _| {
1139 GenericParamDefKind::Lifetime => tcx.types.re_erased.into(),
1140 GenericParamDefKind::Type { .. } |
1141 GenericParamDefKind::Const => {
1142 trait_ref.substs[param.index as usize]
1147 let instance = ty::Instance::resolve(tcx,
1148 ty::ParamEnv::reveal_all(),
1152 let mono_item = create_fn_mono_item(instance);
1153 if mono_item.is_instantiable(tcx)
1154 && should_monomorphize_locally(tcx, &instance) {
1155 output.push(mono_item);
1166 /// Scan the miri alloc in order to find function calls, closures, and drop-glue
1167 fn collect_miri<'a, 'tcx>(
1168 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1170 output: &mut Vec<MonoItem<'tcx>>,
1172 let alloc_kind = tcx.alloc_map.lock().get(alloc_id);
1174 Some(AllocKind::Static(did)) => {
1175 let instance = Instance::mono(tcx, did);
1176 if should_monomorphize_locally(tcx, &instance) {
1177 trace!("collecting static {:?}", did);
1178 output.push(MonoItem::Static(did));
1181 Some(AllocKind::Memory(alloc)) => {
1182 trace!("collecting {:?} with {:#?}", alloc_id, alloc);
1183 for &((), inner) in alloc.relocations.values() {
1184 collect_miri(tcx, inner, output);
1187 Some(AllocKind::Function(fn_instance)) => {
1188 if should_monomorphize_locally(tcx, &fn_instance) {
1189 trace!("collecting {:?} with {:#?}", alloc_id, fn_instance);
1190 output.push(create_fn_mono_item(fn_instance));
1193 None => bug!("alloc id without corresponding allocation: {}", alloc_id),
1197 /// Scan the MIR in order to find function calls, closures, and drop-glue
1198 fn collect_neighbours<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1199 instance: Instance<'tcx>,
1200 output: &mut Vec<MonoItem<'tcx>>)
1202 let mir = tcx.instance_mir(instance.def);
1204 MirNeighborCollector {
1208 param_substs: instance.substs,
1210 let param_env = ty::ParamEnv::reveal_all();
1211 for i in 0..mir.promoted.len() {
1212 use rustc_data_structures::indexed_vec::Idx;
1213 let i = Promoted::new(i);
1214 let cid = GlobalId {
1218 match tcx.const_eval(param_env.and(cid)) {
1219 Ok(val) => collect_const(tcx, val, instance.substs, output),
1220 Err(ErrorHandled::Reported) => {},
1221 Err(ErrorHandled::TooGeneric) => span_bug!(
1222 mir.promoted[i].span, "collection encountered polymorphic constant",
1228 fn def_id_to_string<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1231 let mut output = String::new();
1232 let printer = DefPathBasedNames::new(tcx, false, false);
1233 printer.push_def_path(def_id, &mut output);
1237 fn collect_const<'a, 'tcx>(
1238 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1239 constant: ty::Const<'tcx>,
1240 param_substs: SubstsRef<'tcx>,
1241 output: &mut Vec<MonoItem<'tcx>>,
1243 debug!("visiting const {:?}", constant);
1245 match constant.val {
1246 ConstValue::Slice(Scalar::Ptr(ptr), _) |
1247 ConstValue::Scalar(Scalar::Ptr(ptr)) =>
1248 collect_miri(tcx, ptr.alloc_id, output),
1249 ConstValue::ByRef(_ptr, alloc) => {
1250 for &((), id) in alloc.relocations.values() {
1251 collect_miri(tcx, id, output);
1254 ConstValue::Unevaluated(did, substs) => {
1255 let param_env = ty::ParamEnv::reveal_all();
1256 let substs = tcx.subst_and_normalize_erasing_regions(
1261 let instance = ty::Instance::resolve(tcx,
1266 let cid = GlobalId {
1270 match tcx.const_eval(param_env.and(cid)) {
1271 Ok(val) => collect_const(tcx, val, param_substs, output),
1272 Err(ErrorHandled::Reported) => {},
1273 Err(ErrorHandled::TooGeneric) => span_bug!(
1274 tcx.def_span(did), "collection encountered polymorphic constant",