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 crate::monomorphize;
179 use rustc::middle::codegen_fn_attrs::CodegenFnAttrFlags;
180 use rustc::middle::lang_items::{ExchangeMallocFnLangItem, StartFnLangItem};
181 use rustc::mir::interpret::{AllocId, ConstValue};
182 use rustc::mir::interpret::{ErrorHandled, GlobalAlloc, Scalar};
183 use rustc::mir::mono::{InstantiationMode, MonoItem};
184 use rustc::mir::visit::Visitor as MirVisitor;
185 use rustc::mir::{self, Location, PlaceBase, Static, StaticKind};
186 use rustc::session::config::EntryFnType;
187 use rustc::ty::adjustment::{CustomCoerceUnsized, PointerCast};
188 use rustc::ty::print::obsolete::DefPathBasedNames;
189 use rustc::ty::subst::{InternalSubsts, Subst, SubstsRef};
190 use rustc::ty::{self, GenericParamDefKind, Instance, Ty, TyCtxt, TypeFoldable};
191 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
192 use rustc_data_structures::sync::{par_iter, MTLock, MTRef, ParallelIterator};
193 use rustc_hir as hir;
194 use rustc_hir::def_id::{DefId, DefIdMap, LOCAL_CRATE};
195 use rustc_hir::itemlikevisit::ItemLikeVisitor;
196 use rustc_index::bit_set::GrowableBitSet;
201 pub enum MonoItemCollectionMode {
206 /// Maps every mono item to all mono items it references in its
208 pub struct InliningMap<'tcx> {
209 // Maps a source mono item to the range of mono items
211 // The two numbers in the tuple are the start (inclusive) and
212 // end index (exclusive) within the `targets` vecs.
213 index: FxHashMap<MonoItem<'tcx>, (usize, usize)>,
214 targets: Vec<MonoItem<'tcx>>,
216 // Contains one bit per mono item in the `targets` field. That bit
217 // is true if that mono item needs to be inlined into every CGU.
218 inlines: GrowableBitSet<usize>,
221 impl<'tcx> InliningMap<'tcx> {
222 fn new() -> InliningMap<'tcx> {
224 index: FxHashMap::default(),
226 inlines: GrowableBitSet::with_capacity(1024),
230 fn record_accesses<I>(&mut self, source: MonoItem<'tcx>, new_targets: I)
232 I: Iterator<Item = (MonoItem<'tcx>, bool)> + ExactSizeIterator,
234 assert!(!self.index.contains_key(&source));
236 let start_index = self.targets.len();
237 let new_items_count = new_targets.len();
238 let new_items_count_total = new_items_count + self.targets.len();
240 self.targets.reserve(new_items_count);
241 self.inlines.ensure(new_items_count_total);
243 for (i, (target, inline)) in new_targets.enumerate() {
244 self.targets.push(target);
246 self.inlines.insert(i + start_index);
250 let end_index = self.targets.len();
251 self.index.insert(source, (start_index, end_index));
254 // Internally iterate over all items referenced by `source` which will be
255 // made available for inlining.
256 pub fn with_inlining_candidates<F>(&self, source: MonoItem<'tcx>, mut f: F)
258 F: FnMut(MonoItem<'tcx>),
260 if let Some(&(start_index, end_index)) = self.index.get(&source) {
261 for (i, candidate) in self.targets[start_index..end_index].iter().enumerate() {
262 if self.inlines.contains(start_index + i) {
269 // Internally iterate over all items and the things each accesses.
270 pub fn iter_accesses<F>(&self, mut f: F)
272 F: FnMut(MonoItem<'tcx>, &[MonoItem<'tcx>]),
274 for (&accessor, &(start_index, end_index)) in &self.index {
275 f(accessor, &self.targets[start_index..end_index])
280 pub fn collect_crate_mono_items(
282 mode: MonoItemCollectionMode,
283 ) -> (FxHashSet<MonoItem<'_>>, InliningMap<'_>) {
284 let _prof_timer = tcx.prof.generic_activity("monomorphization_collector");
286 let roots = tcx.sess.time("collecting roots", || {
287 let _prof_timer = tcx.prof.generic_activity("monomorphization_collector_root_collections");
288 collect_roots(tcx, mode)
291 debug!("building mono item graph, beginning at roots");
293 let mut visited = MTLock::new(FxHashSet::default());
294 let mut inlining_map = MTLock::new(InliningMap::new());
297 let visited: MTRef<'_, _> = &mut visited;
298 let inlining_map: MTRef<'_, _> = &mut inlining_map;
300 tcx.sess.time("collecting mono items", || {
301 par_iter(roots).for_each(|root| {
302 let mut recursion_depths = DefIdMap::default();
303 collect_items_rec(tcx, root, visited, &mut recursion_depths, inlining_map);
308 (visited.into_inner(), inlining_map.into_inner())
311 // Find all non-generic items by walking the HIR. These items serve as roots to
312 // start monomorphizing from.
313 fn collect_roots(tcx: TyCtxt<'_>, mode: MonoItemCollectionMode) -> Vec<MonoItem<'_>> {
314 debug!("collecting roots");
315 let mut roots = Vec::new();
318 let entry_fn = tcx.entry_fn(LOCAL_CRATE);
320 debug!("collect_roots: entry_fn = {:?}", entry_fn);
322 let mut visitor = RootCollector { tcx, mode, entry_fn, output: &mut roots };
324 tcx.hir().krate().visit_all_item_likes(&mut visitor);
326 visitor.push_extra_entry_roots();
329 // We can only codegen items that are instantiable - items all of
330 // whose predicates hold. Luckily, items that aren't instantiable
331 // can't actually be used, so we can just skip codegenning them.
332 roots.retain(|root| root.is_instantiable(tcx));
337 // Collect all monomorphized items reachable from `starting_point`
338 fn collect_items_rec<'tcx>(
340 starting_point: MonoItem<'tcx>,
341 visited: MTRef<'_, MTLock<FxHashSet<MonoItem<'tcx>>>>,
342 recursion_depths: &mut DefIdMap<usize>,
343 inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>,
345 if !visited.lock_mut().insert(starting_point.clone()) {
346 // We've been here already, no need to search again.
349 debug!("BEGIN collect_items_rec({})", starting_point.to_string(tcx, true));
351 let mut neighbors = Vec::new();
352 let recursion_depth_reset;
354 match starting_point {
355 MonoItem::Static(def_id) => {
356 let instance = Instance::mono(tcx, def_id);
358 // Sanity check whether this ended up being collected accidentally
359 debug_assert!(should_monomorphize_locally(tcx, &instance));
361 let ty = instance.monomorphic_ty(tcx);
362 visit_drop_use(tcx, ty, true, &mut neighbors);
364 recursion_depth_reset = None;
366 if let Ok(val) = tcx.const_eval_poly(def_id) {
367 collect_const(tcx, val, InternalSubsts::empty(), &mut neighbors);
370 MonoItem::Fn(instance) => {
371 // Sanity check whether this ended up being collected accidentally
372 debug_assert!(should_monomorphize_locally(tcx, &instance));
374 // Keep track of the monomorphization recursion depth
375 recursion_depth_reset = Some(check_recursion_limit(tcx, instance, recursion_depths));
376 check_type_length_limit(tcx, instance);
378 collect_neighbours(tcx, instance, &mut neighbors);
380 MonoItem::GlobalAsm(..) => {
381 recursion_depth_reset = None;
385 record_accesses(tcx, starting_point, &neighbors[..], inlining_map);
387 for neighbour in neighbors {
388 collect_items_rec(tcx, neighbour, visited, recursion_depths, inlining_map);
391 if let Some((def_id, depth)) = recursion_depth_reset {
392 recursion_depths.insert(def_id, depth);
395 debug!("END collect_items_rec({})", starting_point.to_string(tcx, true));
398 fn record_accesses<'tcx>(
400 caller: MonoItem<'tcx>,
401 callees: &[MonoItem<'tcx>],
402 inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>,
404 let is_inlining_candidate = |mono_item: &MonoItem<'tcx>| {
405 mono_item.instantiation_mode(tcx) == InstantiationMode::LocalCopy
409 callees.into_iter().map(|mono_item| (*mono_item, is_inlining_candidate(mono_item)));
411 inlining_map.lock_mut().record_accesses(caller, accesses);
414 fn check_recursion_limit<'tcx>(
416 instance: Instance<'tcx>,
417 recursion_depths: &mut DefIdMap<usize>,
418 ) -> (DefId, usize) {
419 let def_id = instance.def_id();
420 let recursion_depth = recursion_depths.get(&def_id).cloned().unwrap_or(0);
421 debug!(" => recursion depth={}", recursion_depth);
423 let recursion_depth = if Some(def_id) == tcx.lang_items().drop_in_place_fn() {
424 // HACK: drop_in_place creates tight monomorphization loops. Give
431 // Code that needs to instantiate the same function recursively
432 // more than the recursion limit is assumed to be causing an
433 // infinite expansion.
434 if recursion_depth > *tcx.sess.recursion_limit.get() {
435 let error = format!("reached the recursion limit while instantiating `{}`", instance);
436 if let Some(hir_id) = tcx.hir().as_local_hir_id(def_id) {
437 tcx.sess.span_fatal(tcx.hir().span(hir_id), &error);
439 tcx.sess.fatal(&error);
443 recursion_depths.insert(def_id, recursion_depth + 1);
445 (def_id, recursion_depth)
448 fn check_type_length_limit<'tcx>(tcx: TyCtxt<'tcx>, instance: Instance<'tcx>) {
449 let type_length = instance.substs.types().flat_map(|ty| ty.walk()).count();
450 let const_length = instance.substs.consts().flat_map(|ct| ct.ty.walk()).count();
451 debug!(" => type length={}, const length={}", type_length, const_length);
453 // Rust code can easily create exponentially-long types using only a
454 // polynomial recursion depth. Even with the default recursion
455 // depth, you can easily get cases that take >2^60 steps to run,
456 // which means that rustc basically hangs.
458 // Bail out in these cases to avoid that bad user experience.
459 let type_length_limit = *tcx.sess.type_length_limit.get();
460 // We include the const length in the type length, as it's better
461 // to be overly conservative.
462 // FIXME(const_generics): we should instead uniformly walk through `substs`,
463 // ignoring lifetimes.
464 if type_length + const_length > type_length_limit {
465 // The instance name is already known to be too long for rustc.
466 // Show only the first and last 32 characters to avoid blasting
467 // the user's terminal with thousands of lines of type-name.
468 let shrink = |s: String, before: usize, after: usize| {
469 // An iterator of all byte positions including the end of the string.
470 let positions = || s.char_indices().map(|(i, _)| i).chain(iter::once(s.len()));
472 let shrunk = format!(
473 "{before}...{after}",
474 before = &s[..positions().nth(before).unwrap_or(s.len())],
475 after = &s[positions().rev().nth(after).unwrap_or(0)..],
478 // Only use the shrunk version if it's really shorter.
479 // This also avoids the case where before and after slices overlap.
480 if shrunk.len() < s.len() { shrunk } else { s }
483 "reached the type-length limit while instantiating `{}`",
484 shrink(instance.to_string(), 32, 32)
486 let mut diag = tcx.sess.struct_span_fatal(tcx.def_span(instance.def_id()), &msg);
488 "consider adding a `#![type_length_limit=\"{}\"]` attribute to your crate",
492 tcx.sess.abort_if_errors();
496 struct MirNeighborCollector<'a, 'tcx> {
498 body: &'a mir::Body<'tcx>,
499 output: &'a mut Vec<MonoItem<'tcx>>,
500 param_substs: SubstsRef<'tcx>,
503 impl<'a, 'tcx> MirVisitor<'tcx> for MirNeighborCollector<'a, 'tcx> {
504 fn visit_rvalue(&mut self, rvalue: &mir::Rvalue<'tcx>, location: Location) {
505 debug!("visiting rvalue {:?}", *rvalue);
508 // When doing an cast from a regular pointer to a fat pointer, we
509 // have to instantiate all methods of the trait being cast to, so we
510 // can build the appropriate vtable.
512 mir::CastKind::Pointer(PointerCast::Unsize),
516 let target_ty = self.tcx.subst_and_normalize_erasing_regions(
518 ty::ParamEnv::reveal_all(),
521 let source_ty = operand.ty(self.body, self.tcx);
522 let source_ty = self.tcx.subst_and_normalize_erasing_regions(
524 ty::ParamEnv::reveal_all(),
527 let (source_ty, target_ty) =
528 find_vtable_types_for_unsizing(self.tcx, source_ty, target_ty);
529 // This could also be a different Unsize instruction, like
530 // from a fixed sized array to a slice. But we are only
531 // interested in things that produce a vtable.
532 if target_ty.is_trait() && !source_ty.is_trait() {
533 create_mono_items_for_vtable_methods(
542 mir::CastKind::Pointer(PointerCast::ReifyFnPointer),
546 let fn_ty = operand.ty(self.body, self.tcx);
547 let fn_ty = self.tcx.subst_and_normalize_erasing_regions(
549 ty::ParamEnv::reveal_all(),
552 visit_fn_use(self.tcx, fn_ty, false, &mut self.output);
555 mir::CastKind::Pointer(PointerCast::ClosureFnPointer(_)),
559 let source_ty = operand.ty(self.body, self.tcx);
560 let source_ty = self.tcx.subst_and_normalize_erasing_regions(
562 ty::ParamEnv::reveal_all(),
565 match source_ty.kind {
566 ty::Closure(def_id, substs) => {
567 let instance = Instance::resolve_closure(
571 ty::ClosureKind::FnOnce,
573 if should_monomorphize_locally(self.tcx, &instance) {
574 self.output.push(create_fn_mono_item(instance));
580 mir::Rvalue::NullaryOp(mir::NullOp::Box, _) => {
582 let exchange_malloc_fn_def_id = tcx
584 .require(ExchangeMallocFnLangItem)
585 .unwrap_or_else(|e| tcx.sess.fatal(&e));
586 let instance = Instance::mono(tcx, exchange_malloc_fn_def_id);
587 if should_monomorphize_locally(tcx, &instance) {
588 self.output.push(create_fn_mono_item(instance));
591 _ => { /* not interesting */ }
594 self.super_rvalue(rvalue, location);
597 fn visit_const(&mut self, constant: &&'tcx ty::Const<'tcx>, location: Location) {
598 debug!("visiting const {:?} @ {:?}", *constant, location);
600 collect_const(self.tcx, *constant, self.param_substs, self.output);
602 self.super_const(constant);
605 fn visit_terminator_kind(&mut self, kind: &mir::TerminatorKind<'tcx>, location: Location) {
606 debug!("visiting terminator {:?} @ {:?}", kind, location);
610 mir::TerminatorKind::Call { ref func, .. } => {
611 let callee_ty = func.ty(self.body, tcx);
612 let callee_ty = tcx.subst_and_normalize_erasing_regions(
614 ty::ParamEnv::reveal_all(),
617 visit_fn_use(self.tcx, callee_ty, true, &mut self.output);
619 mir::TerminatorKind::Drop { ref location, .. }
620 | mir::TerminatorKind::DropAndReplace { ref location, .. } => {
621 let ty = location.ty(self.body, self.tcx).ty;
622 let ty = tcx.subst_and_normalize_erasing_regions(
624 ty::ParamEnv::reveal_all(),
627 visit_drop_use(self.tcx, ty, true, self.output);
629 mir::TerminatorKind::Goto { .. }
630 | mir::TerminatorKind::SwitchInt { .. }
631 | mir::TerminatorKind::Resume
632 | mir::TerminatorKind::Abort
633 | mir::TerminatorKind::Return
634 | mir::TerminatorKind::Unreachable
635 | mir::TerminatorKind::Assert { .. } => {}
636 mir::TerminatorKind::GeneratorDrop
637 | mir::TerminatorKind::Yield { .. }
638 | mir::TerminatorKind::FalseEdges { .. }
639 | mir::TerminatorKind::FalseUnwind { .. } => bug!(),
642 self.super_terminator_kind(kind, location);
647 place_base: &mir::PlaceBase<'tcx>,
648 _context: mir::visit::PlaceContext,
652 PlaceBase::Static(box Static { kind: StaticKind::Static, def_id, .. }) => {
653 debug!("visiting static {:?} @ {:?}", def_id, location);
656 let instance = Instance::mono(tcx, *def_id);
657 if should_monomorphize_locally(tcx, &instance) {
658 self.output.push(MonoItem::Static(*def_id));
661 PlaceBase::Static(box Static {
662 kind: StaticKind::Promoted(promoted, substs),
666 let instance = Instance::new(*def_id, substs.subst(self.tcx, self.param_substs));
667 match self.tcx.const_eval_promoted(instance, *promoted) {
668 Ok(val) => collect_const(self.tcx, val, substs, self.output),
669 Err(ErrorHandled::Reported) => {}
670 Err(ErrorHandled::TooGeneric) => {
671 let span = self.tcx.promoted_mir(*def_id)[*promoted].span;
672 span_bug!(span, "collection encountered polymorphic constant")
676 PlaceBase::Local(_) => {
677 // Locals have no relevance for collector.
683 fn visit_drop_use<'tcx>(
686 is_direct_call: bool,
687 output: &mut Vec<MonoItem<'tcx>>,
689 let instance = Instance::resolve_drop_in_place(tcx, ty);
690 visit_instance_use(tcx, instance, is_direct_call, output);
693 fn visit_fn_use<'tcx>(
696 is_direct_call: bool,
697 output: &mut Vec<MonoItem<'tcx>>,
699 if let ty::FnDef(def_id, substs) = ty.kind {
701 if is_direct_call { ty::Instance::resolve } else { ty::Instance::resolve_for_fn_ptr };
702 let instance = resolver(tcx, ty::ParamEnv::reveal_all(), def_id, substs).unwrap();
703 visit_instance_use(tcx, instance, is_direct_call, output);
707 fn visit_instance_use<'tcx>(
709 instance: ty::Instance<'tcx>,
710 is_direct_call: bool,
711 output: &mut Vec<MonoItem<'tcx>>,
713 debug!("visit_item_use({:?}, is_direct_call={:?})", instance, is_direct_call);
714 if !should_monomorphize_locally(tcx, &instance) {
719 ty::InstanceDef::Virtual(..) | ty::InstanceDef::Intrinsic(_) => {
721 bug!("{:?} being reified", instance);
724 ty::InstanceDef::DropGlue(_, None) => {
725 // Don't need to emit noop drop glue if we are calling directly.
727 output.push(create_fn_mono_item(instance));
730 ty::InstanceDef::DropGlue(_, Some(_))
731 | ty::InstanceDef::VtableShim(..)
732 | ty::InstanceDef::ReifyShim(..)
733 | ty::InstanceDef::ClosureOnceShim { .. }
734 | ty::InstanceDef::Item(..)
735 | ty::InstanceDef::FnPtrShim(..)
736 | ty::InstanceDef::CloneShim(..) => {
737 output.push(create_fn_mono_item(instance));
742 // Returns `true` if we should codegen an instance in the local crate.
743 // Returns `false` if we can just link to the upstream crate and therefore don't
745 fn should_monomorphize_locally<'tcx>(tcx: TyCtxt<'tcx>, instance: &Instance<'tcx>) -> bool {
746 let def_id = match instance.def {
747 ty::InstanceDef::Item(def_id) => def_id,
748 ty::InstanceDef::VtableShim(..)
749 | ty::InstanceDef::ReifyShim(..)
750 | ty::InstanceDef::ClosureOnceShim { .. }
751 | ty::InstanceDef::Virtual(..)
752 | ty::InstanceDef::FnPtrShim(..)
753 | ty::InstanceDef::DropGlue(..)
754 | ty::InstanceDef::Intrinsic(_)
755 | ty::InstanceDef::CloneShim(..) => return true,
758 if tcx.is_foreign_item(def_id) {
759 // We can always link to foreign items.
763 if def_id.is_local() {
764 // Local items cannot be referred to locally without monomorphizing them locally.
768 if tcx.is_reachable_non_generic(def_id)
769 || is_available_upstream_generic(tcx, def_id, instance.substs)
771 // We can link to the item in question, no instance needed
776 if !tcx.is_mir_available(def_id) {
777 bug!("cannot create local mono-item for {:?}", def_id)
781 fn is_available_upstream_generic<'tcx>(
784 substs: SubstsRef<'tcx>,
786 debug_assert!(!def_id.is_local());
788 // If we are not in share generics mode, we don't link to upstream
789 // monomorphizations but always instantiate our own internal versions
791 if !tcx.sess.opts.share_generics() {
795 // If this instance has non-erasable parameters, it cannot be a shared
796 // monomorphization. Non-generic instances are already handled above
797 // by `is_reachable_non_generic()`.
798 if substs.non_erasable_generics().next().is_none() {
802 // Take a look at the available monomorphizations listed in the metadata
803 // of upstream crates.
804 tcx.upstream_monomorphizations_for(def_id)
805 .map(|set| set.contains_key(substs))
810 /// For a given pair of source and target type that occur in an unsizing coercion,
811 /// this function finds the pair of types that determines the vtable linking
814 /// For example, the source type might be `&SomeStruct` and the target type\
815 /// might be `&SomeTrait` in a cast like:
817 /// let src: &SomeStruct = ...;
818 /// let target = src as &SomeTrait;
820 /// Then the output of this function would be (SomeStruct, SomeTrait) since for
821 /// constructing the `target` fat-pointer we need the vtable for that pair.
823 /// Things can get more complicated though because there's also the case where
824 /// the unsized type occurs as a field:
827 /// struct ComplexStruct<T: ?Sized> {
834 /// In this case, if `T` is sized, `&ComplexStruct<T>` is a thin pointer. If `T`
835 /// is unsized, `&SomeStruct` is a fat pointer, and the vtable it points to is
836 /// for the pair of `T` (which is a trait) and the concrete type that `T` was
837 /// originally coerced from:
839 /// let src: &ComplexStruct<SomeStruct> = ...;
840 /// let target = src as &ComplexStruct<SomeTrait>;
842 /// Again, we want this `find_vtable_types_for_unsizing()` to provide the pair
843 /// `(SomeStruct, SomeTrait)`.
845 /// Finally, there is also the case of custom unsizing coercions, e.g., for
846 /// smart pointers such as `Rc` and `Arc`.
847 fn find_vtable_types_for_unsizing<'tcx>(
851 ) -> (Ty<'tcx>, Ty<'tcx>) {
852 let ptr_vtable = |inner_source: Ty<'tcx>, inner_target: Ty<'tcx>| {
853 let param_env = ty::ParamEnv::reveal_all();
854 let type_has_metadata = |ty: Ty<'tcx>| -> bool {
855 use rustc_span::DUMMY_SP;
856 if ty.is_sized(tcx.at(DUMMY_SP), param_env) {
859 let tail = tcx.struct_tail_erasing_lifetimes(ty, param_env);
861 ty::Foreign(..) => false,
862 ty::Str | ty::Slice(..) | ty::Dynamic(..) => true,
863 _ => bug!("unexpected unsized tail: {:?}", tail),
866 if type_has_metadata(inner_source) {
867 (inner_source, inner_target)
869 tcx.struct_lockstep_tails_erasing_lifetimes(inner_source, inner_target, param_env)
873 match (&source_ty.kind, &target_ty.kind) {
874 (&ty::Ref(_, a, _), &ty::Ref(_, b, _))
875 | (&ty::Ref(_, a, _), &ty::RawPtr(ty::TypeAndMut { ty: b, .. }))
876 | (&ty::RawPtr(ty::TypeAndMut { ty: a, .. }), &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) => {
879 (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
880 ptr_vtable(source_ty.boxed_ty(), target_ty.boxed_ty())
883 (&ty::Adt(source_adt_def, source_substs), &ty::Adt(target_adt_def, target_substs)) => {
884 assert_eq!(source_adt_def, target_adt_def);
886 let kind = monomorphize::custom_coerce_unsize_info(tcx, source_ty, target_ty);
888 let coerce_index = match kind {
889 CustomCoerceUnsized::Struct(i) => i,
892 let source_fields = &source_adt_def.non_enum_variant().fields;
893 let target_fields = &target_adt_def.non_enum_variant().fields;
896 coerce_index < source_fields.len() && source_fields.len() == target_fields.len()
899 find_vtable_types_for_unsizing(
901 source_fields[coerce_index].ty(tcx, source_substs),
902 target_fields[coerce_index].ty(tcx, target_substs),
906 "find_vtable_types_for_unsizing: invalid coercion {:?} -> {:?}",
913 fn create_fn_mono_item(instance: Instance<'_>) -> MonoItem<'_> {
914 debug!("create_fn_mono_item(instance={})", instance);
915 MonoItem::Fn(instance)
918 /// Creates a `MonoItem` for each method that is referenced by the vtable for
919 /// the given trait/impl pair.
920 fn create_mono_items_for_vtable_methods<'tcx>(
924 output: &mut Vec<MonoItem<'tcx>>,
927 !trait_ty.needs_subst()
928 && !trait_ty.has_escaping_bound_vars()
929 && !impl_ty.needs_subst()
930 && !impl_ty.has_escaping_bound_vars()
933 if let ty::Dynamic(ref trait_ty, ..) = trait_ty.kind {
934 if let Some(principal) = trait_ty.principal() {
935 let poly_trait_ref = principal.with_self_ty(tcx, impl_ty);
936 assert!(!poly_trait_ref.has_escaping_bound_vars());
938 // Walk all methods of the trait, including those of its supertraits
939 let methods = tcx.vtable_methods(poly_trait_ref);
940 let methods = methods
943 .filter_map(|method| method)
944 .map(|(def_id, substs)| {
945 ty::Instance::resolve_for_vtable(
947 ty::ParamEnv::reveal_all(),
953 .filter(|&instance| should_monomorphize_locally(tcx, &instance))
954 .map(|instance| create_fn_mono_item(instance));
955 output.extend(methods);
958 // Also add the destructor.
959 visit_drop_use(tcx, impl_ty, false, output);
963 //=-----------------------------------------------------------------------------
965 //=-----------------------------------------------------------------------------
967 struct RootCollector<'a, 'tcx> {
969 mode: MonoItemCollectionMode,
970 output: &'a mut Vec<MonoItem<'tcx>>,
971 entry_fn: Option<(DefId, EntryFnType)>,
974 impl ItemLikeVisitor<'v> for RootCollector<'_, 'v> {
975 fn visit_item(&mut self, item: &'v hir::Item<'v>) {
977 hir::ItemKind::ExternCrate(..)
978 | hir::ItemKind::Use(..)
979 | hir::ItemKind::ForeignMod(..)
980 | hir::ItemKind::TyAlias(..)
981 | hir::ItemKind::Trait(..)
982 | hir::ItemKind::TraitAlias(..)
983 | hir::ItemKind::OpaqueTy(..)
984 | hir::ItemKind::Mod(..) => {
985 // Nothing to do, just keep recursing.
988 hir::ItemKind::Impl(..) => {
989 if self.mode == MonoItemCollectionMode::Eager {
990 create_mono_items_for_default_impls(self.tcx, item, self.output);
994 hir::ItemKind::Enum(_, ref generics)
995 | hir::ItemKind::Struct(_, ref generics)
996 | hir::ItemKind::Union(_, ref generics) => {
997 if generics.params.is_empty() {
998 if self.mode == MonoItemCollectionMode::Eager {
999 let def_id = self.tcx.hir().local_def_id(item.hir_id);
1001 "RootCollector: ADT drop-glue for {}",
1002 def_id_to_string(self.tcx, def_id)
1006 Instance::new(def_id, InternalSubsts::empty()).monomorphic_ty(self.tcx);
1007 visit_drop_use(self.tcx, ty, true, self.output);
1011 hir::ItemKind::GlobalAsm(..) => {
1013 "RootCollector: ItemKind::GlobalAsm({})",
1014 def_id_to_string(self.tcx, self.tcx.hir().local_def_id(item.hir_id))
1016 self.output.push(MonoItem::GlobalAsm(item.hir_id));
1018 hir::ItemKind::Static(..) => {
1019 let def_id = self.tcx.hir().local_def_id(item.hir_id);
1020 debug!("RootCollector: ItemKind::Static({})", def_id_to_string(self.tcx, def_id));
1021 self.output.push(MonoItem::Static(def_id));
1023 hir::ItemKind::Const(..) => {
1024 // const items only generate mono items if they are
1025 // actually used somewhere. Just declaring them is insufficient.
1027 // but even just declaring them must collect the items they refer to
1028 let def_id = self.tcx.hir().local_def_id(item.hir_id);
1030 if let Ok(val) = self.tcx.const_eval_poly(def_id) {
1031 collect_const(self.tcx, val, InternalSubsts::empty(), &mut self.output);
1034 hir::ItemKind::Fn(..) => {
1035 let def_id = self.tcx.hir().local_def_id(item.hir_id);
1036 self.push_if_root(def_id);
1041 fn visit_trait_item(&mut self, _: &'v hir::TraitItem<'v>) {
1042 // Even if there's a default body with no explicit generics,
1043 // it's still generic over some `Self: Trait`, so not a root.
1046 fn visit_impl_item(&mut self, ii: &'v hir::ImplItem<'v>) {
1048 hir::ImplItemKind::Method(hir::FnSig { .. }, _) => {
1049 let def_id = self.tcx.hir().local_def_id(ii.hir_id);
1050 self.push_if_root(def_id);
1052 _ => { /* nothing to do here */ }
1057 impl RootCollector<'_, 'v> {
1058 fn is_root(&self, def_id: DefId) -> bool {
1059 !item_requires_monomorphization(self.tcx, def_id)
1060 && match self.mode {
1061 MonoItemCollectionMode::Eager => true,
1062 MonoItemCollectionMode::Lazy => {
1063 self.entry_fn.map(|(id, _)| id) == Some(def_id)
1064 || self.tcx.is_reachable_non_generic(def_id)
1067 .codegen_fn_attrs(def_id)
1069 .contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL)
1074 /// If `def_id` represents a root, pushes it onto the list of
1075 /// outputs. (Note that all roots must be monomorphic.)
1076 fn push_if_root(&mut self, def_id: DefId) {
1077 if self.is_root(def_id) {
1078 debug!("RootCollector::push_if_root: found root def_id={:?}", def_id);
1080 let instance = Instance::mono(self.tcx, def_id);
1081 self.output.push(create_fn_mono_item(instance));
1085 /// As a special case, when/if we encounter the
1086 /// `main()` function, we also have to generate a
1087 /// monomorphized copy of the start lang item based on
1088 /// the return type of `main`. This is not needed when
1089 /// the user writes their own `start` manually.
1090 fn push_extra_entry_roots(&mut self) {
1091 let main_def_id = match self.entry_fn {
1092 Some((def_id, EntryFnType::Main)) => def_id,
1096 let start_def_id = match self.tcx.lang_items().require(StartFnLangItem) {
1098 Err(err) => self.tcx.sess.fatal(&err),
1100 let main_ret_ty = self.tcx.fn_sig(main_def_id).output();
1102 // Given that `main()` has no arguments,
1103 // then its return type cannot have
1104 // late-bound regions, since late-bound
1105 // regions must appear in the argument
1107 let main_ret_ty = self.tcx.erase_regions(&main_ret_ty.no_bound_vars().unwrap());
1109 let start_instance = Instance::resolve(
1111 ty::ParamEnv::reveal_all(),
1113 self.tcx.intern_substs(&[main_ret_ty.into()]),
1117 self.output.push(create_fn_mono_item(start_instance));
1121 fn item_requires_monomorphization(tcx: TyCtxt<'_>, def_id: DefId) -> bool {
1122 let generics = tcx.generics_of(def_id);
1123 generics.requires_monomorphization(tcx)
1126 fn create_mono_items_for_default_impls<'tcx>(
1128 item: &'tcx hir::Item<'tcx>,
1129 output: &mut Vec<MonoItem<'tcx>>,
1132 hir::ItemKind::Impl(_, _, _, ref generics, .., ref impl_item_refs) => {
1133 for param in generics.params {
1135 hir::GenericParamKind::Lifetime { .. } => {}
1136 hir::GenericParamKind::Type { .. } | hir::GenericParamKind::Const { .. } => {
1142 let impl_def_id = tcx.hir().local_def_id(item.hir_id);
1145 "create_mono_items_for_default_impls(item={})",
1146 def_id_to_string(tcx, impl_def_id)
1149 if let Some(trait_ref) = tcx.impl_trait_ref(impl_def_id) {
1150 let param_env = ty::ParamEnv::reveal_all();
1151 let trait_ref = tcx.normalize_erasing_regions(param_env, trait_ref);
1152 let overridden_methods: FxHashSet<_> =
1153 impl_item_refs.iter().map(|iiref| iiref.ident.modern()).collect();
1154 for method in tcx.provided_trait_methods(trait_ref.def_id) {
1155 if overridden_methods.contains(&method.ident.modern()) {
1159 if tcx.generics_of(method.def_id).own_requires_monomorphization() {
1164 InternalSubsts::for_item(tcx, method.def_id, |param, _| match param.kind {
1165 GenericParamDefKind::Lifetime => tcx.lifetimes.re_erased.into(),
1166 GenericParamDefKind::Type { .. } | GenericParamDefKind::Const => {
1167 trait_ref.substs[param.index as usize]
1171 ty::Instance::resolve(tcx, param_env, method.def_id, substs).unwrap();
1173 let mono_item = create_fn_mono_item(instance);
1174 if mono_item.is_instantiable(tcx) && should_monomorphize_locally(tcx, &instance)
1176 output.push(mono_item);
1185 /// Scans the miri alloc in order to find function calls, closures, and drop-glue.
1186 fn collect_miri<'tcx>(tcx: TyCtxt<'tcx>, alloc_id: AllocId, output: &mut Vec<MonoItem<'tcx>>) {
1187 let alloc_kind = tcx.alloc_map.lock().get(alloc_id);
1189 Some(GlobalAlloc::Static(def_id)) => {
1190 let instance = Instance::mono(tcx, def_id);
1191 if should_monomorphize_locally(tcx, &instance) {
1192 trace!("collecting static {:?}", def_id);
1193 output.push(MonoItem::Static(def_id));
1196 Some(GlobalAlloc::Memory(alloc)) => {
1197 trace!("collecting {:?} with {:#?}", alloc_id, alloc);
1198 for &((), inner) in alloc.relocations().values() {
1199 collect_miri(tcx, inner, output);
1202 Some(GlobalAlloc::Function(fn_instance)) => {
1203 if should_monomorphize_locally(tcx, &fn_instance) {
1204 trace!("collecting {:?} with {:#?}", alloc_id, fn_instance);
1205 output.push(create_fn_mono_item(fn_instance));
1208 None => bug!("alloc id without corresponding allocation: {}", alloc_id),
1212 /// Scans the MIR in order to find function calls, closures, and drop-glue.
1213 fn collect_neighbours<'tcx>(
1215 instance: Instance<'tcx>,
1216 output: &mut Vec<MonoItem<'tcx>>,
1218 debug!("collect_neighbours: {:?}", instance.def_id());
1219 let body = tcx.instance_mir(instance.def);
1221 MirNeighborCollector { tcx, body: &body, output, param_substs: instance.substs }
1225 fn def_id_to_string(tcx: TyCtxt<'_>, def_id: DefId) -> String {
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<'tcx>(
1234 constant: &'tcx ty::Const<'tcx>,
1235 param_substs: SubstsRef<'tcx>,
1236 output: &mut Vec<MonoItem<'tcx>>,
1238 debug!("visiting const {:?}", constant);
1240 let param_env = ty::ParamEnv::reveal_all();
1241 let substituted_constant =
1242 tcx.subst_and_normalize_erasing_regions(param_substs, param_env, &constant);
1244 match substituted_constant.val {
1245 ty::ConstKind::Value(ConstValue::Scalar(Scalar::Ptr(ptr))) => {
1246 collect_miri(tcx, ptr.alloc_id, output)
1248 ty::ConstKind::Value(ConstValue::Slice { data: alloc, start: _, end: _ })
1249 | ty::ConstKind::Value(ConstValue::ByRef { alloc, .. }) => {
1250 for &((), id) in alloc.relocations().values() {
1251 collect_miri(tcx, id, output);
1254 ty::ConstKind::Unevaluated(def_id, substs) => {
1255 match tcx.const_eval_resolve(param_env, def_id, substs, None) {
1256 Ok(val) => collect_const(tcx, val, param_substs, output),
1257 Err(ErrorHandled::Reported) => {}
1258 Err(ErrorHandled::TooGeneric) => {
1259 span_bug!(tcx.def_span(def_id), "collection encountered polymorphic constant",)