1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Mono Item Collection
12 //! ===========================
14 //! This module is responsible for discovering all items that will contribute to
15 //! to code generation of the crate. The important part here is that it not only
16 //! needs to find syntax-level items (functions, structs, etc) but also all
17 //! their monomorphized instantiations. Every non-generic, non-const function
18 //! maps to one LLVM artifact. Every generic function can produce
19 //! from zero to N artifacts, depending on the sets of type arguments it
20 //! is instantiated with.
21 //! This also applies to generic items from other crates: A generic definition
22 //! in crate X might produce monomorphizations that are compiled into crate Y.
23 //! We also have to collect these here.
25 //! The following kinds of "mono items" are handled here:
33 //! The following things also result in LLVM artifacts, but are not collected
34 //! here, since we instantiate them locally on demand when needed in a given
44 //! Let's define some terms first:
46 //! - A "mono item" is something that results in a function or global in
47 //! the LLVM IR of a codegen unit. Mono items do not stand on their
48 //! own, they can reference other mono items. For example, if function
49 //! `foo()` calls function `bar()` then the mono item for `foo()`
50 //! references the mono item for function `bar()`. In general, the
51 //! definition for mono item A referencing a mono item B is that
52 //! the LLVM artifact produced for A references the LLVM artifact produced
55 //! - Mono items and the references between them form a directed graph,
56 //! where the mono items are the nodes and references form the edges.
57 //! Let's call this graph the "mono item graph".
59 //! - The mono item graph for a program contains all mono items
60 //! that are needed in order to produce the complete LLVM IR of the program.
62 //! The purpose of the algorithm implemented in this module is to build the
63 //! mono item graph for the current crate. It runs in two phases:
65 //! 1. Discover the roots of the graph by traversing the HIR of the crate.
66 //! 2. Starting from the roots, find neighboring nodes by inspecting the MIR
67 //! representation of the item corresponding to a given node, until no more
68 //! new nodes are found.
70 //! ### Discovering roots
72 //! The roots of the mono item graph correspond to the non-generic
73 //! syntactic items in the source code. We find them by walking the HIR of the
74 //! crate, and whenever we hit upon a function, method, or static item, we
75 //! create a mono item consisting of the items DefId and, since we only
76 //! consider non-generic items, an empty type-substitution set.
78 //! ### Finding neighbor nodes
79 //! Given a mono item node, we can discover neighbors by inspecting its
80 //! MIR. We walk the MIR and any time we hit upon something that signifies a
81 //! reference to another mono item, we have found a neighbor. Since the
82 //! mono item we are currently at is always monomorphic, we also know the
83 //! concrete type arguments of its neighbors, and so all neighbors again will be
84 //! monomorphic. The specific forms a reference to a neighboring node can take
85 //! in MIR are quite diverse. Here is an overview:
87 //! #### Calling Functions/Methods
88 //! The most obvious form of one mono item referencing another is a
89 //! function or method call (represented by a CALL terminator in MIR). But
90 //! calls are not the only thing that might introduce a reference between two
91 //! function mono items, and as we will see below, they are just a
92 //! specialized of the form described next, and consequently will don't get any
93 //! special treatment in the algorithm.
95 //! #### Taking a reference to a function or method
96 //! A function does not need to actually be called in order to be a neighbor of
97 //! another function. It suffices to just take a reference in order to introduce
98 //! an edge. Consider the following example:
101 //! fn print_val<T: Display>(x: T) {
102 //! println!("{}", x);
105 //! fn call_fn(f: &Fn(i32), x: i32) {
110 //! let print_i32 = print_val::<i32>;
111 //! call_fn(&print_i32, 0);
114 //! The MIR of none of these functions will contain an explicit call to
115 //! `print_val::<i32>`. Nonetheless, in order to mono this program, we need
116 //! an instance of this function. Thus, whenever we encounter a function or
117 //! method in operand position, we treat it as a neighbor of the current
118 //! mono item. Calls are just a special case of that.
121 //! In a way, closures are a simple case. Since every closure object needs to be
122 //! constructed somewhere, we can reliably discover them by observing
123 //! `RValue::Aggregate` expressions with `AggregateKind::Closure`. This is also
124 //! true for closures inlined from other crates.
127 //! Drop glue mono items are introduced by MIR drop-statements. The
128 //! generated mono item will again have drop-glue item neighbors if the
129 //! type to be dropped contains nested values that also need to be dropped. It
130 //! might also have a function item neighbor for the explicit `Drop::drop`
131 //! implementation of its type.
133 //! #### Unsizing Casts
134 //! A subtle way of introducing neighbor edges is by casting to a trait object.
135 //! Since the resulting fat-pointer contains a reference to a vtable, we need to
136 //! instantiate all object-save methods of the trait, as we need to store
137 //! pointers to these functions even if they never get called anywhere. This can
138 //! be seen as a special case of taking a function reference.
141 //! Since `Box` expression have special compiler support, no explicit calls to
142 //! `exchange_malloc()` and `exchange_free()` may show up in MIR, even if the
143 //! compiler will generate them. We have to observe `Rvalue::Box` expressions
144 //! and Box-typed drop-statements for that purpose.
147 //! Interaction with Cross-Crate Inlining
148 //! -------------------------------------
149 //! The binary of a crate will not only contain machine code for the items
150 //! defined in the source code of that crate. It will also contain monomorphic
151 //! instantiations of any extern generic functions and of functions marked with
153 //! The collection algorithm handles this more or less mono. If it is
154 //! about to create a mono item for something with an external `DefId`,
155 //! it will take a look if the MIR for that item is available, and if so just
156 //! proceed normally. If the MIR is not available, it assumes that the item is
157 //! just linked to and no node is created; which is exactly what we want, since
158 //! no machine code should be generated in the current crate for such an item.
160 //! Eager and Lazy Collection Mode
161 //! ------------------------------
162 //! Mono item collection can be performed in one of two modes:
164 //! - Lazy mode means that items will only be instantiated when actually
165 //! referenced. The goal is to produce the least amount of machine code
168 //! - Eager mode is meant to be used in conjunction with incremental compilation
169 //! where a stable set of mono items is more important than a minimal
170 //! one. Thus, eager mode will instantiate drop-glue for every drop-able type
171 //! in the crate, even of no drop call for that type exists (yet). It will
172 //! also instantiate default implementations of trait methods, something that
173 //! otherwise is only done on demand.
178 //! Some things are not yet fully implemented in the current version of this
181 //! ### Initializers of Constants and Statics
182 //! Since no MIR is constructed yet for initializer expressions of constants and
183 //! statics we cannot inspect these properly.
186 //! Ideally, no mono item should be generated for const fns unless there
187 //! is a call to them that cannot be evaluated at compile time. At the moment
188 //! this is not implemented however: a mono item will be produced
189 //! regardless of whether it is actually needed or not.
191 use rustc::hir::{self, CodegenFnAttrFlags};
192 use rustc::hir::itemlikevisit::ItemLikeVisitor;
194 use rustc::hir::Node;
195 use rustc::hir::def_id::DefId;
196 use rustc::mir::interpret::{AllocId, ConstValue};
197 use rustc::middle::lang_items::{ExchangeMallocFnLangItem, StartFnLangItem};
198 use rustc::ty::subst::Substs;
199 use rustc::ty::{self, TypeFoldable, Ty, TyCtxt, GenericParamDefKind};
200 use rustc::ty::adjustment::CustomCoerceUnsized;
201 use rustc::session::config;
202 use rustc::mir::{self, Location, Promoted};
203 use rustc::mir::visit::Visitor as MirVisitor;
204 use rustc::mir::mono::MonoItem;
205 use rustc::mir::interpret::{Scalar, GlobalId, AllocType, ErrorHandled};
207 use monomorphize::{self, Instance};
208 use rustc::util::nodemap::{FxHashSet, FxHashMap, DefIdMap};
209 use rustc::util::common::time;
211 use monomorphize::item::{MonoItemExt, DefPathBasedNames, InstantiationMode};
213 use rustc_data_structures::bit_set::GrowableBitSet;
214 use rustc_data_structures::sync::{MTRef, MTLock, ParallelIterator, par_iter};
216 #[derive(PartialEq, Eq, Hash, Clone, Copy, Debug)]
217 pub enum MonoItemCollectionMode {
222 /// Maps every mono item to all mono items it references in its
224 pub struct InliningMap<'tcx> {
225 // Maps a source mono item to the range of mono items
227 // The two numbers in the tuple are the start (inclusive) and
228 // end index (exclusive) within the `targets` vecs.
229 index: FxHashMap<MonoItem<'tcx>, (usize, usize)>,
230 targets: Vec<MonoItem<'tcx>>,
232 // Contains one bit per mono item in the `targets` field. That bit
233 // is true if that mono item needs to be inlined into every CGU.
234 inlines: GrowableBitSet<usize>,
237 impl<'tcx> InliningMap<'tcx> {
239 fn new() -> InliningMap<'tcx> {
241 index: FxHashMap::default(),
243 inlines: GrowableBitSet::with_capacity(1024),
247 fn record_accesses<I>(&mut self,
248 source: MonoItem<'tcx>,
250 where I: Iterator<Item=(MonoItem<'tcx>, bool)> + ExactSizeIterator
252 assert!(!self.index.contains_key(&source));
254 let start_index = self.targets.len();
255 let new_items_count = new_targets.len();
256 let new_items_count_total = new_items_count + self.targets.len();
258 self.targets.reserve(new_items_count);
259 self.inlines.ensure(new_items_count_total);
261 for (i, (target, inline)) in new_targets.enumerate() {
262 self.targets.push(target);
264 self.inlines.insert(i + start_index);
268 let end_index = self.targets.len();
269 self.index.insert(source, (start_index, end_index));
272 // Internally iterate over all items referenced by `source` which will be
273 // made available for inlining.
274 pub fn with_inlining_candidates<F>(&self, source: MonoItem<'tcx>, mut f: F)
275 where F: FnMut(MonoItem<'tcx>)
277 if let Some(&(start_index, end_index)) = self.index.get(&source) {
278 for (i, candidate) in self.targets[start_index .. end_index]
281 if self.inlines.contains(start_index + i) {
288 // Internally iterate over all items and the things each accesses.
289 pub fn iter_accesses<F>(&self, mut f: F)
290 where F: FnMut(MonoItem<'tcx>, &[MonoItem<'tcx>])
292 for (&accessor, &(start_index, end_index)) in &self.index {
293 f(accessor, &self.targets[start_index .. end_index])
298 pub fn collect_crate_mono_items<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
299 mode: MonoItemCollectionMode)
300 -> (FxHashSet<MonoItem<'tcx>>,
302 let roots = time(tcx.sess, "collecting roots", || {
303 collect_roots(tcx, mode)
306 debug!("Building mono item graph, beginning at roots");
308 let mut visited = MTLock::new(FxHashSet::default());
309 let mut inlining_map = MTLock::new(InliningMap::new());
312 let visited: MTRef<'_, _> = &mut visited;
313 let inlining_map: MTRef<'_, _> = &mut inlining_map;
315 time(tcx.sess, "collecting mono items", || {
316 par_iter(roots).for_each(|root| {
317 let mut recursion_depths = DefIdMap();
318 collect_items_rec(tcx,
321 &mut recursion_depths,
327 (visited.into_inner(), inlining_map.into_inner())
330 // Find all non-generic items by walking the HIR. These items serve as roots to
331 // start monomorphizing from.
332 fn collect_roots<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
333 mode: MonoItemCollectionMode)
334 -> Vec<MonoItem<'tcx>> {
335 debug!("Collecting roots");
336 let mut roots = Vec::new();
339 let entry_fn = tcx.sess.entry_fn.borrow().map(|(node_id, _, _)| {
340 tcx.hir.local_def_id(node_id)
343 debug!("collect_roots: entry_fn = {:?}", entry_fn);
345 let mut visitor = RootCollector {
352 tcx.hir.krate().visit_all_item_likes(&mut visitor);
354 visitor.push_extra_entry_roots();
357 // We can only codegen items that are instantiable - items all of
358 // whose predicates hold. Luckily, items that aren't instantiable
359 // can't actually be used, so we can just skip codegenning them.
360 roots.retain(|root| root.is_instantiable(tcx));
365 // Collect all monomorphized items reachable from `starting_point`
366 fn collect_items_rec<'a, 'tcx: 'a>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
367 starting_point: MonoItem<'tcx>,
368 visited: MTRef<'_, MTLock<FxHashSet<MonoItem<'tcx>>>>,
369 recursion_depths: &mut DefIdMap<usize>,
370 inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>) {
371 if !visited.lock_mut().insert(starting_point.clone()) {
372 // We've been here already, no need to search again.
375 debug!("BEGIN collect_items_rec({})", starting_point.to_string(tcx));
377 let mut neighbors = Vec::new();
378 let recursion_depth_reset;
380 match starting_point {
381 MonoItem::Static(def_id) => {
382 let instance = Instance::mono(tcx, def_id);
384 // Sanity check whether this ended up being collected accidentally
385 debug_assert!(should_monomorphize_locally(tcx, &instance));
387 let ty = instance.ty(tcx);
388 visit_drop_use(tcx, ty, true, &mut neighbors);
390 recursion_depth_reset = None;
396 let param_env = ty::ParamEnv::reveal_all();
398 if let Ok(val) = tcx.const_eval(param_env.and(cid)) {
399 collect_const(tcx, val, instance.substs, &mut neighbors);
402 MonoItem::Fn(instance) => {
403 // Sanity check whether this ended up being collected accidentally
404 debug_assert!(should_monomorphize_locally(tcx, &instance));
406 // Keep track of the monomorphization recursion depth
407 recursion_depth_reset = Some(check_recursion_limit(tcx,
410 check_type_length_limit(tcx, instance);
412 collect_neighbours(tcx, instance, &mut neighbors);
414 MonoItem::GlobalAsm(..) => {
415 recursion_depth_reset = None;
419 record_accesses(tcx, starting_point, &neighbors[..], inlining_map);
421 for neighbour in neighbors {
422 collect_items_rec(tcx, neighbour, visited, recursion_depths, inlining_map);
425 if let Some((def_id, depth)) = recursion_depth_reset {
426 recursion_depths.insert(def_id, depth);
429 debug!("END collect_items_rec({})", starting_point.to_string(tcx));
432 fn record_accesses<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
433 caller: MonoItem<'tcx>,
434 callees: &[MonoItem<'tcx>],
435 inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>) {
436 let is_inlining_candidate = |mono_item: &MonoItem<'tcx>| {
437 mono_item.instantiation_mode(tcx) == InstantiationMode::LocalCopy
440 let accesses = callees.into_iter()
442 (*mono_item, is_inlining_candidate(mono_item))
445 inlining_map.lock_mut().record_accesses(caller, accesses);
448 fn check_recursion_limit<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
449 instance: Instance<'tcx>,
450 recursion_depths: &mut DefIdMap<usize>)
452 let def_id = instance.def_id();
453 let recursion_depth = recursion_depths.get(&def_id).cloned().unwrap_or(0);
454 debug!(" => recursion depth={}", recursion_depth);
456 let recursion_depth = if Some(def_id) == tcx.lang_items().drop_in_place_fn() {
457 // HACK: drop_in_place creates tight monomorphization loops. Give
464 // Code that needs to instantiate the same function recursively
465 // more than the recursion limit is assumed to be causing an
466 // infinite expansion.
467 if recursion_depth > *tcx.sess.recursion_limit.get() {
468 let error = format!("reached the recursion limit while instantiating `{}`",
470 if let Some(node_id) = tcx.hir.as_local_node_id(def_id) {
471 tcx.sess.span_fatal(tcx.hir.span(node_id), &error);
473 tcx.sess.fatal(&error);
477 recursion_depths.insert(def_id, recursion_depth + 1);
479 (def_id, recursion_depth)
482 fn check_type_length_limit<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
483 instance: Instance<'tcx>)
485 let type_length = instance.substs.types().flat_map(|ty| ty.walk()).count();
486 debug!(" => type length={}", type_length);
488 // Rust code can easily create exponentially-long types using only a
489 // polynomial recursion depth. Even with the default recursion
490 // depth, you can easily get cases that take >2^60 steps to run,
491 // which means that rustc basically hangs.
493 // Bail out in these cases to avoid that bad user experience.
494 let type_length_limit = *tcx.sess.type_length_limit.get();
495 if type_length > type_length_limit {
496 // The instance name is already known to be too long for rustc. Use
497 // `{:.64}` to avoid blasting the user's terminal with thousands of
498 // lines of type-name.
499 let instance_name = instance.to_string();
500 let msg = format!("reached the type-length limit while instantiating `{:.64}...`",
502 let mut diag = if let Some(node_id) = tcx.hir.as_local_node_id(instance.def_id()) {
503 tcx.sess.struct_span_fatal(tcx.hir.span(node_id), &msg)
505 tcx.sess.struct_fatal(&msg)
509 "consider adding a `#![type_length_limit=\"{}\"]` attribute to your crate",
510 type_length_limit*2));
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: &'tcx Substs<'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::Virtual(..) |
709 ty::InstanceDef::DropGlue(_, None) => {
710 // don't need to emit shim if we are calling directly.
712 output.push(create_fn_mono_item(instance));
715 ty::InstanceDef::DropGlue(_, Some(_)) => {
716 output.push(create_fn_mono_item(instance));
718 ty::InstanceDef::ClosureOnceShim { .. } |
719 ty::InstanceDef::Item(..) |
720 ty::InstanceDef::FnPtrShim(..) |
721 ty::InstanceDef::CloneShim(..) => {
722 output.push(create_fn_mono_item(instance));
727 // Returns true if we should codegen an instance in the local crate.
728 // Returns false if we can just link to the upstream crate and therefore don't
730 fn should_monomorphize_locally<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, instance: &Instance<'tcx>)
732 let def_id = match instance.def {
733 ty::InstanceDef::Item(def_id) => def_id,
734 ty::InstanceDef::ClosureOnceShim { .. } |
735 ty::InstanceDef::Virtual(..) |
736 ty::InstanceDef::FnPtrShim(..) |
737 ty::InstanceDef::DropGlue(..) |
738 ty::InstanceDef::Intrinsic(_) |
739 ty::InstanceDef::CloneShim(..) => return true
742 return match tcx.hir.get_if_local(def_id) {
743 Some(Node::ForeignItem(..)) => {
744 false // foreign items are linked against, not codegened.
748 if tcx.is_reachable_non_generic(def_id) ||
749 tcx.is_foreign_item(def_id) ||
750 is_available_upstream_generic(tcx, def_id, instance.substs)
752 // We can link to the item in question, no instance needed
756 if !tcx.is_mir_available(def_id) {
757 bug!("Cannot create local mono-item for {:?}", def_id)
764 fn is_available_upstream_generic<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
766 substs: &'tcx Substs<'tcx>)
768 debug_assert!(!def_id.is_local());
770 // If we are not in share generics mode, we don't link to upstream
771 // monomorphizations but always instantiate our own internal versions
773 if !tcx.sess.opts.share_generics() {
777 // If this instance has no type parameters, it cannot be a shared
778 // monomorphization. Non-generic instances are already handled above
779 // by `is_reachable_non_generic()`
780 if substs.types().next().is_none() {
784 // Take a look at the available monomorphizations listed in the metadata
785 // of upstream crates.
786 tcx.upstream_monomorphizations_for(def_id)
787 .map(|set| set.contains_key(substs))
792 /// For given pair of source and target type that occur in an unsizing coercion,
793 /// this function finds the pair of types that determines the vtable linking
796 /// For example, the source type might be `&SomeStruct` and the target type\
797 /// might be `&SomeTrait` in a cast like:
799 /// let src: &SomeStruct = ...;
800 /// let target = src as &SomeTrait;
802 /// Then the output of this function would be (SomeStruct, SomeTrait) since for
803 /// constructing the `target` fat-pointer we need the vtable for that pair.
805 /// Things can get more complicated though because there's also the case where
806 /// the unsized type occurs as a field:
809 /// struct ComplexStruct<T: ?Sized> {
816 /// In this case, if `T` is sized, `&ComplexStruct<T>` is a thin pointer. If `T`
817 /// is unsized, `&SomeStruct` is a fat pointer, and the vtable it points to is
818 /// for the pair of `T` (which is a trait) and the concrete type that `T` was
819 /// originally coerced from:
821 /// let src: &ComplexStruct<SomeStruct> = ...;
822 /// let target = src as &ComplexStruct<SomeTrait>;
824 /// Again, we want this `find_vtable_types_for_unsizing()` to provide the pair
825 /// `(SomeStruct, SomeTrait)`.
827 /// Finally, there is also the case of custom unsizing coercions, e.g. for
828 /// smart pointers such as `Rc` and `Arc`.
829 fn find_vtable_types_for_unsizing<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
832 -> (Ty<'tcx>, Ty<'tcx>) {
833 let ptr_vtable = |inner_source: Ty<'tcx>, inner_target: Ty<'tcx>| {
834 let type_has_metadata = |ty: Ty<'tcx>| -> bool {
835 use syntax_pos::DUMMY_SP;
836 if ty.is_sized(tcx.at(DUMMY_SP), ty::ParamEnv::reveal_all()) {
839 let tail = tcx.struct_tail(ty);
841 ty::Foreign(..) => false,
842 ty::Str | ty::Slice(..) | ty::Dynamic(..) => true,
843 _ => bug!("unexpected unsized tail: {:?}", tail.sty),
846 if type_has_metadata(inner_source) {
847 (inner_source, inner_target)
849 tcx.struct_lockstep_tails(inner_source, inner_target)
853 match (&source_ty.sty, &target_ty.sty) {
857 &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) |
858 (&ty::RawPtr(ty::TypeAndMut { ty: a, .. }),
859 &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) => {
862 (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
863 ptr_vtable(source_ty.boxed_ty(), target_ty.boxed_ty())
866 (&ty::Adt(source_adt_def, source_substs),
867 &ty::Adt(target_adt_def, target_substs)) => {
868 assert_eq!(source_adt_def, target_adt_def);
871 monomorphize::custom_coerce_unsize_info(tcx, source_ty, target_ty);
873 let coerce_index = match kind {
874 CustomCoerceUnsized::Struct(i) => i
877 let source_fields = &source_adt_def.non_enum_variant().fields;
878 let target_fields = &target_adt_def.non_enum_variant().fields;
880 assert!(coerce_index < source_fields.len() &&
881 source_fields.len() == target_fields.len());
883 find_vtable_types_for_unsizing(tcx,
884 source_fields[coerce_index].ty(tcx,
886 target_fields[coerce_index].ty(tcx,
889 _ => bug!("find_vtable_types_for_unsizing: invalid coercion {:?} -> {:?}",
895 fn create_fn_mono_item<'a, 'tcx>(instance: Instance<'tcx>) -> MonoItem<'tcx> {
896 debug!("create_fn_mono_item(instance={})", instance);
897 MonoItem::Fn(instance)
900 /// Creates a `MonoItem` for each method that is referenced by the vtable for
901 /// the given trait/impl pair.
902 fn create_mono_items_for_vtable_methods<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
905 output: &mut Vec<MonoItem<'tcx>>) {
906 assert!(!trait_ty.needs_subst() && !trait_ty.has_escaping_regions() &&
907 !impl_ty.needs_subst() && !impl_ty.has_escaping_regions());
909 if let ty::Dynamic(ref trait_ty, ..) = trait_ty.sty {
910 let poly_trait_ref = trait_ty.principal().with_self_ty(tcx, impl_ty);
911 assert!(!poly_trait_ref.has_escaping_regions());
913 // Walk all methods of the trait, including those of its supertraits
914 let methods = tcx.vtable_methods(poly_trait_ref);
915 let methods = methods.iter().cloned().filter_map(|method| method)
916 .map(|(def_id, substs)| ty::Instance::resolve(
918 ty::ParamEnv::reveal_all(),
921 .filter(|&instance| should_monomorphize_locally(tcx, &instance))
922 .map(|instance| create_fn_mono_item(instance));
923 output.extend(methods);
924 // Also add the destructor
925 visit_drop_use(tcx, impl_ty, false, output);
929 //=-----------------------------------------------------------------------------
931 //=-----------------------------------------------------------------------------
933 struct RootCollector<'b, 'a: 'b, 'tcx: 'a + 'b> {
934 tcx: TyCtxt<'a, 'tcx, 'tcx>,
935 mode: MonoItemCollectionMode,
936 output: &'b mut Vec<MonoItem<'tcx>>,
937 entry_fn: Option<DefId>,
940 impl<'b, 'a, 'v> ItemLikeVisitor<'v> for RootCollector<'b, 'a, 'v> {
941 fn visit_item(&mut self, item: &'v hir::Item) {
943 hir::ItemKind::ExternCrate(..) |
944 hir::ItemKind::Use(..) |
945 hir::ItemKind::ForeignMod(..) |
946 hir::ItemKind::Ty(..) |
947 hir::ItemKind::Trait(..) |
948 hir::ItemKind::TraitAlias(..) |
949 hir::ItemKind::Existential(..) |
950 hir::ItemKind::Mod(..) => {
951 // Nothing to do, just keep recursing...
954 hir::ItemKind::Impl(..) => {
955 if self.mode == MonoItemCollectionMode::Eager {
956 create_mono_items_for_default_impls(self.tcx,
962 hir::ItemKind::Enum(_, ref generics) |
963 hir::ItemKind::Struct(_, ref generics) |
964 hir::ItemKind::Union(_, ref generics) => {
965 if generics.params.is_empty() {
966 if self.mode == MonoItemCollectionMode::Eager {
967 let def_id = self.tcx.hir.local_def_id(item.id);
968 debug!("RootCollector: ADT drop-glue for {}",
969 def_id_to_string(self.tcx, def_id));
971 let ty = Instance::new(def_id, Substs::empty()).ty(self.tcx);
972 visit_drop_use(self.tcx, ty, true, self.output);
976 hir::ItemKind::GlobalAsm(..) => {
977 debug!("RootCollector: ItemKind::GlobalAsm({})",
978 def_id_to_string(self.tcx,
979 self.tcx.hir.local_def_id(item.id)));
980 self.output.push(MonoItem::GlobalAsm(item.id));
982 hir::ItemKind::Static(..) => {
983 let def_id = self.tcx.hir.local_def_id(item.id);
984 debug!("RootCollector: ItemKind::Static({})",
985 def_id_to_string(self.tcx, def_id));
986 self.output.push(MonoItem::Static(def_id));
988 hir::ItemKind::Const(..) => {
989 // const items only generate mono items if they are
990 // actually used somewhere. Just declaring them is insufficient.
992 // but even just declaring them must collect the items they refer to
993 let def_id = self.tcx.hir.local_def_id(item.id);
995 let instance = Instance::mono(self.tcx, def_id);
1000 let param_env = ty::ParamEnv::reveal_all();
1002 if let Ok(val) = self.tcx.const_eval(param_env.and(cid)) {
1003 collect_const(self.tcx, val, instance.substs, &mut self.output);
1006 hir::ItemKind::Fn(..) => {
1007 let def_id = self.tcx.hir.local_def_id(item.id);
1008 self.push_if_root(def_id);
1013 fn visit_trait_item(&mut self, _: &'v hir::TraitItem) {
1014 // Even if there's a default body with no explicit generics,
1015 // it's still generic over some `Self: Trait`, so not a root.
1018 fn visit_impl_item(&mut self, ii: &'v hir::ImplItem) {
1020 hir::ImplItemKind::Method(hir::MethodSig { .. }, _) => {
1021 let def_id = self.tcx.hir.local_def_id(ii.id);
1022 self.push_if_root(def_id);
1024 _ => { /* Nothing to do here */ }
1029 impl<'b, 'a, 'v> RootCollector<'b, 'a, 'v> {
1030 fn is_root(&self, def_id: DefId) -> bool {
1031 !item_has_type_parameters(self.tcx, def_id) && match self.mode {
1032 MonoItemCollectionMode::Eager => {
1035 MonoItemCollectionMode::Lazy => {
1036 self.entry_fn == Some(def_id) ||
1037 self.tcx.is_reachable_non_generic(def_id) ||
1038 self.tcx.codegen_fn_attrs(def_id).flags.contains(
1039 CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL)
1044 /// If `def_id` represents a root, then push it onto the list of
1045 /// outputs. (Note that all roots must be monomorphic.)
1046 fn push_if_root(&mut self, def_id: DefId) {
1047 if self.is_root(def_id) {
1048 debug!("RootCollector::push_if_root: found root def_id={:?}", def_id);
1050 let instance = Instance::mono(self.tcx, def_id);
1051 self.output.push(create_fn_mono_item(instance));
1055 /// As a special case, when/if we encounter the
1056 /// `main()` function, we also have to generate a
1057 /// monomorphized copy of the start lang item based on
1058 /// the return type of `main`. This is not needed when
1059 /// the user writes their own `start` manually.
1060 fn push_extra_entry_roots(&mut self) {
1061 if self.tcx.sess.entry_fn.get().map(|e| e.2) != Some(config::EntryFnType::Main) {
1065 let main_def_id = if let Some(def_id) = self.entry_fn {
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_late_bound_regions().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 { .. } => return,
1114 let impl_def_id = tcx.hir.local_def_id(item.id);
1116 debug!("create_mono_items_for_default_impls(item={})",
1117 def_id_to_string(tcx, impl_def_id));
1119 if let Some(trait_ref) = tcx.impl_trait_ref(impl_def_id) {
1120 let overridden_methods: FxHashSet<_> =
1121 impl_item_refs.iter()
1122 .map(|iiref| iiref.ident.modern())
1124 for method in tcx.provided_trait_methods(trait_ref.def_id) {
1125 if overridden_methods.contains(&method.ident.modern()) {
1129 if tcx.generics_of(method.def_id).own_counts().types != 0 {
1133 let substs = Substs::for_item(tcx, method.def_id, |param, _| {
1135 GenericParamDefKind::Lifetime => tcx.types.re_erased.into(),
1136 GenericParamDefKind::Type {..} => {
1137 trait_ref.substs[param.index as usize]
1142 let instance = ty::Instance::resolve(tcx,
1143 ty::ParamEnv::reveal_all(),
1147 let mono_item = create_fn_mono_item(instance);
1148 if mono_item.is_instantiable(tcx)
1149 && should_monomorphize_locally(tcx, &instance) {
1150 output.push(mono_item);
1161 /// Scan the miri alloc in order to find function calls, closures, and drop-glue
1162 fn collect_miri<'a, 'tcx>(
1163 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1165 output: &mut Vec<MonoItem<'tcx>>,
1167 let alloc_type = tcx.alloc_map.lock().get(alloc_id);
1169 Some(AllocType::Static(did)) => {
1170 let instance = Instance::mono(tcx, did);
1171 if should_monomorphize_locally(tcx, &instance) {
1172 trace!("collecting static {:?}", did);
1173 output.push(MonoItem::Static(did));
1176 Some(AllocType::Memory(alloc)) => {
1177 trace!("collecting {:?} with {:#?}", alloc_id, alloc);
1178 for &((), inner) in alloc.relocations.values() {
1179 collect_miri(tcx, inner, output);
1182 Some(AllocType::Function(fn_instance)) => {
1183 if should_monomorphize_locally(tcx, &fn_instance) {
1184 trace!("collecting {:?} with {:#?}", alloc_id, fn_instance);
1185 output.push(create_fn_mono_item(fn_instance));
1188 None => bug!("alloc id without corresponding allocation: {}", alloc_id),
1192 /// Scan the MIR in order to find function calls, closures, and drop-glue
1193 fn collect_neighbours<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1194 instance: Instance<'tcx>,
1195 output: &mut Vec<MonoItem<'tcx>>)
1197 let mir = tcx.instance_mir(instance.def);
1199 MirNeighborCollector {
1203 param_substs: instance.substs,
1205 let param_env = ty::ParamEnv::reveal_all();
1206 for i in 0..mir.promoted.len() {
1207 use rustc_data_structures::indexed_vec::Idx;
1208 let i = Promoted::new(i);
1209 let cid = GlobalId {
1213 match tcx.const_eval(param_env.and(cid)) {
1214 Ok(val) => collect_const(tcx, val, instance.substs, output),
1215 Err(ErrorHandled::Reported) => {},
1216 Err(ErrorHandled::TooGeneric) => span_bug!(
1217 mir.promoted[i].span, "collection encountered polymorphic constant",
1223 fn def_id_to_string<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
1226 let mut output = String::new();
1227 let printer = DefPathBasedNames::new(tcx, false, false);
1228 printer.push_def_path(def_id, &mut output);
1232 fn collect_const<'a, 'tcx>(
1233 tcx: TyCtxt<'a, 'tcx, 'tcx>,
1234 constant: &ty::Const<'tcx>,
1235 param_substs: &'tcx Substs<'tcx>,
1236 output: &mut Vec<MonoItem<'tcx>>,
1238 debug!("visiting const {:?}", *constant);
1240 let val = match constant.val {
1241 ConstValue::Unevaluated(def_id, substs) => {
1242 let param_env = ty::ParamEnv::reveal_all();
1243 let substs = tcx.subst_and_normalize_erasing_regions(
1248 let instance = ty::Instance::resolve(tcx,
1253 let cid = GlobalId {
1257 match tcx.const_eval(param_env.and(cid)) {
1259 Err(ErrorHandled::Reported) => return,
1260 Err(ErrorHandled::TooGeneric) => span_bug!(
1261 tcx.def_span(def_id), "collection encountered polymorphic constant",
1268 ConstValue::Unevaluated(..) => bug!("const eval yielded unevaluated const"),
1269 ConstValue::ScalarPair(Scalar::Ptr(a), Scalar::Ptr(b)) => {
1270 collect_miri(tcx, a.alloc_id, output);
1271 collect_miri(tcx, b.alloc_id, output);
1273 ConstValue::ScalarPair(_, Scalar::Ptr(ptr)) |
1274 ConstValue::ScalarPair(Scalar::Ptr(ptr), _) |
1275 ConstValue::Scalar(Scalar::Ptr(ptr)) =>
1276 collect_miri(tcx, ptr.alloc_id, output),
1277 ConstValue::ByRef(_id, alloc, _offset) => {
1278 for &((), id) in alloc.relocations.values() {
1279 collect_miri(tcx, id, output);