]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_mir/src/monomorphize/collector.rs
don't trim paths in collector PME message
[rust.git] / compiler / rustc_mir / src / monomorphize / collector.rs
1 //! Mono Item Collection
2 //! ====================
3 //!
4 //! This module is responsible for discovering all items that will contribute
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.
14 //!
15 //! The following kinds of "mono items" are handled here:
16 //!
17 //! - Functions
18 //! - Methods
19 //! - Closures
20 //! - Statics
21 //! - Drop glue
22 //!
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
25 //! codegen unit:
26 //!
27 //! - Constants
28 //! - Vtables
29 //! - Object Shims
30 //!
31 //!
32 //! General Algorithm
33 //! -----------------
34 //! Let's define some terms first:
35 //!
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
43 //!   for B.
44 //!
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".
48 //!
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.
51 //!
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:
54 //!
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.
59 //!
60 //! ### Discovering roots
61 //!
62 //! The roots of the mono item graph correspond to the public 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 public function, method, or static item,
65 //! we create a mono item consisting of the items DefId and, since we only
66 //! consider non-generic items, an empty type-substitution set. (In eager
67 //! collection mode, during incremental compilation, all non-generic functions
68 //! are considered as roots, as well as when the `-Clink-dead-code` option is
69 //! specified. Functions marked `#[no_mangle]` and functions called by inlinable
70 //! functions also always act as roots.)
71 //!
72 //! ### Finding neighbor nodes
73 //! Given a mono item node, we can discover neighbors by inspecting its
74 //! MIR. We walk the MIR and any time we hit upon something that signifies a
75 //! reference to another mono item, we have found a neighbor. Since the
76 //! mono item we are currently at is always monomorphic, we also know the
77 //! concrete type arguments of its neighbors, and so all neighbors again will be
78 //! monomorphic. The specific forms a reference to a neighboring node can take
79 //! in MIR are quite diverse. Here is an overview:
80 //!
81 //! #### Calling Functions/Methods
82 //! The most obvious form of one mono item referencing another is a
83 //! function or method call (represented by a CALL terminator in MIR). But
84 //! calls are not the only thing that might introduce a reference between two
85 //! function mono items, and as we will see below, they are just a
86 //! specialization of the form described next, and consequently will not get any
87 //! special treatment in the algorithm.
88 //!
89 //! #### Taking a reference to a function or method
90 //! A function does not need to actually be called in order to be a neighbor of
91 //! another function. It suffices to just take a reference in order to introduce
92 //! an edge. Consider the following example:
93 //!
94 //! ```rust
95 //! fn print_val<T: Display>(x: T) {
96 //!     println!("{}", x);
97 //! }
98 //!
99 //! fn call_fn(f: &Fn(i32), x: i32) {
100 //!     f(x);
101 //! }
102 //!
103 //! fn main() {
104 //!     let print_i32 = print_val::<i32>;
105 //!     call_fn(&print_i32, 0);
106 //! }
107 //! ```
108 //! The MIR of none of these functions will contain an explicit call to
109 //! `print_val::<i32>`. Nonetheless, in order to mono this program, we need
110 //! an instance of this function. Thus, whenever we encounter a function or
111 //! method in operand position, we treat it as a neighbor of the current
112 //! mono item. Calls are just a special case of that.
113 //!
114 //! #### Closures
115 //! In a way, closures are a simple case. Since every closure object needs to be
116 //! constructed somewhere, we can reliably discover them by observing
117 //! `RValue::Aggregate` expressions with `AggregateKind::Closure`. This is also
118 //! true for closures inlined from other crates.
119 //!
120 //! #### Drop glue
121 //! Drop glue mono items are introduced by MIR drop-statements. The
122 //! generated mono item will again have drop-glue item neighbors if the
123 //! type to be dropped contains nested values that also need to be dropped. It
124 //! might also have a function item neighbor for the explicit `Drop::drop`
125 //! implementation of its type.
126 //!
127 //! #### Unsizing Casts
128 //! A subtle way of introducing neighbor edges is by casting to a trait object.
129 //! Since the resulting fat-pointer contains a reference to a vtable, we need to
130 //! instantiate all object-save methods of the trait, as we need to store
131 //! pointers to these functions even if they never get called anywhere. This can
132 //! be seen as a special case of taking a function reference.
133 //!
134 //! #### Boxes
135 //! Since `Box` expression have special compiler support, no explicit calls to
136 //! `exchange_malloc()` and `box_free()` may show up in MIR, even if the
137 //! compiler will generate them. We have to observe `Rvalue::Box` expressions
138 //! and Box-typed drop-statements for that purpose.
139 //!
140 //!
141 //! Interaction with Cross-Crate Inlining
142 //! -------------------------------------
143 //! The binary of a crate will not only contain machine code for the items
144 //! defined in the source code of that crate. It will also contain monomorphic
145 //! instantiations of any extern generic functions and of functions marked with
146 //! `#[inline]`.
147 //! The collection algorithm handles this more or less mono. If it is
148 //! about to create a mono item for something with an external `DefId`,
149 //! it will take a look if the MIR for that item is available, and if so just
150 //! proceed normally. If the MIR is not available, it assumes that the item is
151 //! just linked to and no node is created; which is exactly what we want, since
152 //! no machine code should be generated in the current crate for such an item.
153 //!
154 //! Eager and Lazy Collection Mode
155 //! ------------------------------
156 //! Mono item collection can be performed in one of two modes:
157 //!
158 //! - Lazy mode means that items will only be instantiated when actually
159 //!   referenced. The goal is to produce the least amount of machine code
160 //!   possible.
161 //!
162 //! - Eager mode is meant to be used in conjunction with incremental compilation
163 //!   where a stable set of mono items is more important than a minimal
164 //!   one. Thus, eager mode will instantiate drop-glue for every drop-able type
165 //!   in the crate, even if no drop call for that type exists (yet). It will
166 //!   also instantiate default implementations of trait methods, something that
167 //!   otherwise is only done on demand.
168 //!
169 //!
170 //! Open Issues
171 //! -----------
172 //! Some things are not yet fully implemented in the current version of this
173 //! module.
174 //!
175 //! ### Const Fns
176 //! Ideally, no mono item should be generated for const fns unless there
177 //! is a call to them that cannot be evaluated at compile time. At the moment
178 //! this is not implemented however: a mono item will be produced
179 //! regardless of whether it is actually needed or not.
180
181 use crate::monomorphize;
182
183 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
184 use rustc_data_structures::sync::{par_iter, MTLock, MTRef, ParallelIterator};
185 use rustc_errors::{ErrorReported, FatalError};
186 use rustc_hir as hir;
187 use rustc_hir::def_id::{DefId, DefIdMap, LocalDefId, LOCAL_CRATE};
188 use rustc_hir::itemlikevisit::ItemLikeVisitor;
189 use rustc_hir::lang_items::LangItem;
190 use rustc_index::bit_set::GrowableBitSet;
191 use rustc_middle::mir::interpret::{AllocId, ConstValue};
192 use rustc_middle::mir::interpret::{ErrorHandled, GlobalAlloc, Scalar};
193 use rustc_middle::mir::mono::{InstantiationMode, MonoItem};
194 use rustc_middle::mir::visit::Visitor as MirVisitor;
195 use rustc_middle::mir::{self, Local, Location};
196 use rustc_middle::ty::adjustment::{CustomCoerceUnsized, PointerCast};
197 use rustc_middle::ty::print::with_no_trimmed_paths;
198 use rustc_middle::ty::subst::{GenericArgKind, InternalSubsts};
199 use rustc_middle::ty::{self, GenericParamDefKind, Instance, Ty, TyCtxt, TypeFoldable};
200 use rustc_middle::{middle::codegen_fn_attrs::CodegenFnAttrFlags, mir::visit::TyContext};
201 use rustc_session::config::EntryFnType;
202 use rustc_session::lint::builtin::LARGE_ASSIGNMENTS;
203 use rustc_span::source_map::{dummy_spanned, respan, Span, Spanned, DUMMY_SP};
204 use rustc_target::abi::Size;
205 use smallvec::SmallVec;
206 use std::iter;
207 use std::ops::Range;
208 use std::path::PathBuf;
209
210 #[derive(PartialEq)]
211 pub enum MonoItemCollectionMode {
212     Eager,
213     Lazy,
214 }
215
216 /// Maps every mono item to all mono items it references in its
217 /// body.
218 pub struct InliningMap<'tcx> {
219     // Maps a source mono item to the range of mono items
220     // accessed by it.
221     // The range selects elements within the `targets` vecs.
222     index: FxHashMap<MonoItem<'tcx>, Range<usize>>,
223     targets: Vec<MonoItem<'tcx>>,
224
225     // Contains one bit per mono item in the `targets` field. That bit
226     // is true if that mono item needs to be inlined into every CGU.
227     inlines: GrowableBitSet<usize>,
228 }
229
230 impl<'tcx> InliningMap<'tcx> {
231     fn new() -> InliningMap<'tcx> {
232         InliningMap {
233             index: FxHashMap::default(),
234             targets: Vec::new(),
235             inlines: GrowableBitSet::with_capacity(1024),
236         }
237     }
238
239     fn record_accesses(&mut self, source: MonoItem<'tcx>, new_targets: &[(MonoItem<'tcx>, bool)]) {
240         let start_index = self.targets.len();
241         let new_items_count = new_targets.len();
242         let new_items_count_total = new_items_count + self.targets.len();
243
244         self.targets.reserve(new_items_count);
245         self.inlines.ensure(new_items_count_total);
246
247         for (i, (target, inline)) in new_targets.iter().enumerate() {
248             self.targets.push(*target);
249             if *inline {
250                 self.inlines.insert(i + start_index);
251             }
252         }
253
254         let end_index = self.targets.len();
255         assert!(self.index.insert(source, start_index..end_index).is_none());
256     }
257
258     // Internally iterate over all items referenced by `source` which will be
259     // made available for inlining.
260     pub fn with_inlining_candidates<F>(&self, source: MonoItem<'tcx>, mut f: F)
261     where
262         F: FnMut(MonoItem<'tcx>),
263     {
264         if let Some(range) = self.index.get(&source) {
265             for (i, candidate) in self.targets[range.clone()].iter().enumerate() {
266                 if self.inlines.contains(range.start + i) {
267                     f(*candidate);
268                 }
269             }
270         }
271     }
272
273     // Internally iterate over all items and the things each accesses.
274     pub fn iter_accesses<F>(&self, mut f: F)
275     where
276         F: FnMut(MonoItem<'tcx>, &[MonoItem<'tcx>]),
277     {
278         for (&accessor, range) in &self.index {
279             f(accessor, &self.targets[range.clone()])
280         }
281     }
282 }
283
284 pub fn collect_crate_mono_items(
285     tcx: TyCtxt<'_>,
286     mode: MonoItemCollectionMode,
287 ) -> (FxHashSet<MonoItem<'_>>, InliningMap<'_>) {
288     let _prof_timer = tcx.prof.generic_activity("monomorphization_collector");
289
290     let roots =
291         tcx.sess.time("monomorphization_collector_root_collections", || collect_roots(tcx, mode));
292
293     debug!("building mono item graph, beginning at roots");
294
295     let mut visited = MTLock::new(FxHashSet::default());
296     let mut inlining_map = MTLock::new(InliningMap::new());
297
298     {
299         let visited: MTRef<'_, _> = &mut visited;
300         let inlining_map: MTRef<'_, _> = &mut inlining_map;
301
302         tcx.sess.time("monomorphization_collector_graph_walk", || {
303             par_iter(roots).for_each(|root| {
304                 let mut recursion_depths = DefIdMap::default();
305                 collect_items_rec(
306                     tcx,
307                     dummy_spanned(root),
308                     visited,
309                     &mut recursion_depths,
310                     inlining_map,
311                 );
312             });
313         });
314     }
315
316     (visited.into_inner(), inlining_map.into_inner())
317 }
318
319 // Find all non-generic items by walking the HIR. These items serve as roots to
320 // start monomorphizing from.
321 fn collect_roots(tcx: TyCtxt<'_>, mode: MonoItemCollectionMode) -> Vec<MonoItem<'_>> {
322     debug!("collecting roots");
323     let mut roots = Vec::new();
324
325     {
326         let entry_fn = tcx.entry_fn(());
327
328         debug!("collect_roots: entry_fn = {:?}", entry_fn);
329
330         let mut visitor = RootCollector { tcx, mode, entry_fn, output: &mut roots };
331
332         tcx.hir().krate().visit_all_item_likes(&mut visitor);
333
334         visitor.push_extra_entry_roots();
335     }
336
337     // We can only codegen items that are instantiable - items all of
338     // whose predicates hold. Luckily, items that aren't instantiable
339     // can't actually be used, so we can just skip codegenning them.
340     roots
341         .into_iter()
342         .filter_map(|root| root.node.is_instantiable(tcx).then_some(root.node))
343         .collect()
344 }
345
346 /// Collect all monomorphized items reachable from `starting_point`, and emit a note diagnostic if a
347 /// post-monorphization error is encountered during a collection step.
348 fn collect_items_rec<'tcx>(
349     tcx: TyCtxt<'tcx>,
350     starting_point: Spanned<MonoItem<'tcx>>,
351     visited: MTRef<'_, MTLock<FxHashSet<MonoItem<'tcx>>>>,
352     recursion_depths: &mut DefIdMap<usize>,
353     inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>,
354 ) {
355     if !visited.lock_mut().insert(starting_point.node) {
356         // We've been here already, no need to search again.
357         return;
358     }
359     debug!("BEGIN collect_items_rec({})", starting_point.node);
360
361     let mut neighbors = Vec::new();
362     let recursion_depth_reset;
363
364     //
365     // Post-monomorphization errors MVP
366     //
367     // We can encounter errors while monomorphizing an item, but we don't have a good way of
368     // showing a complete stack of spans ultimately leading to collecting the erroneous one yet.
369     // (It's also currently unclear exactly which diagnostics and information would be interesting
370     // to report in such cases)
371     //
372     // This leads to suboptimal error reporting: a post-monomorphization error (PME) will be
373     // shown with just a spanned piece of code causing the error, without information on where
374     // it was called from. This is especially obscure if the erroneous mono item is in a
375     // dependency. See for example issue #85155, where, before minimization, a PME happened two
376     // crates downstream from libcore's stdarch, without a way to know which dependency was the
377     // cause.
378     //
379     // If such an error occurs in the current crate, its span will be enough to locate the
380     // source. If the cause is in another crate, the goal here is to quickly locate which mono
381     // item in the current crate is ultimately responsible for causing the error.
382     //
383     // To give at least _some_ context to the user: while collecting mono items, we check the
384     // error count. If it has changed, a PME occurred, and we trigger some diagnostics about the
385     // current step of mono items collection.
386     //
387     let error_count = tcx.sess.diagnostic().err_count();
388
389     match starting_point.node {
390         MonoItem::Static(def_id) => {
391             let instance = Instance::mono(tcx, def_id);
392
393             // Sanity check whether this ended up being collected accidentally
394             debug_assert!(should_codegen_locally(tcx, &instance));
395
396             let ty = instance.ty(tcx, ty::ParamEnv::reveal_all());
397             visit_drop_use(tcx, ty, true, starting_point.span, &mut neighbors);
398
399             recursion_depth_reset = None;
400
401             if let Ok(alloc) = tcx.eval_static_initializer(def_id) {
402                 for &((), id) in alloc.relocations().values() {
403                     collect_miri(tcx, id, &mut neighbors);
404                 }
405             }
406         }
407         MonoItem::Fn(instance) => {
408             // Sanity check whether this ended up being collected accidentally
409             debug_assert!(should_codegen_locally(tcx, &instance));
410
411             // Keep track of the monomorphization recursion depth
412             recursion_depth_reset =
413                 Some(check_recursion_limit(tcx, instance, starting_point.span, recursion_depths));
414             check_type_length_limit(tcx, instance);
415
416             rustc_data_structures::stack::ensure_sufficient_stack(|| {
417                 collect_neighbours(tcx, instance, &mut neighbors);
418             });
419         }
420         MonoItem::GlobalAsm(item_id) => {
421             recursion_depth_reset = None;
422
423             let item = tcx.hir().item(item_id);
424             if let hir::ItemKind::GlobalAsm(asm) = item.kind {
425                 for (op, op_sp) in asm.operands {
426                     match op {
427                         hir::InlineAsmOperand::Const { .. } => {
428                             // Only constants which resolve to a plain integer
429                             // are supported. Therefore the value should not
430                             // depend on any other items.
431                         }
432                         _ => span_bug!(*op_sp, "invalid operand type for global_asm!"),
433                     }
434                 }
435             } else {
436                 span_bug!(item.span, "Mismatch between hir::Item type and MonoItem type")
437             }
438         }
439     }
440
441     // Check for PMEs and emit a diagnostic if one happened. To try to show relevant edges of the
442     // mono item graph where the PME diagnostics are currently the most problematic (e.g. ones
443     // involving a dependency, and the lack of context is confusing) in this MVP, we focus on
444     // diagnostics on edges crossing a crate boundary: the collected mono items which are not
445     // defined in the local crate.
446     if tcx.sess.diagnostic().err_count() > error_count && starting_point.node.krate() != LOCAL_CRATE
447     {
448         let formatted_item = with_no_trimmed_paths(|| starting_point.node.to_string());
449         tcx.sess.span_note_without_error(
450             starting_point.span,
451             &format!("the above error was encountered while instantiating `{}`", formatted_item),
452         );
453     }
454
455     record_accesses(tcx, starting_point.node, neighbors.iter().map(|i| &i.node), inlining_map);
456
457     for neighbour in neighbors {
458         collect_items_rec(tcx, neighbour, visited, recursion_depths, inlining_map);
459     }
460
461     if let Some((def_id, depth)) = recursion_depth_reset {
462         recursion_depths.insert(def_id, depth);
463     }
464
465     debug!("END collect_items_rec({})", starting_point.node);
466 }
467
468 fn record_accesses<'a, 'tcx: 'a>(
469     tcx: TyCtxt<'tcx>,
470     caller: MonoItem<'tcx>,
471     callees: impl Iterator<Item = &'a MonoItem<'tcx>>,
472     inlining_map: MTRef<'_, MTLock<InliningMap<'tcx>>>,
473 ) {
474     let is_inlining_candidate = |mono_item: &MonoItem<'tcx>| {
475         mono_item.instantiation_mode(tcx) == InstantiationMode::LocalCopy
476     };
477
478     // We collect this into a `SmallVec` to avoid calling `is_inlining_candidate` in the lock.
479     // FIXME: Call `is_inlining_candidate` when pushing to `neighbors` in `collect_items_rec`
480     // instead to avoid creating this `SmallVec`.
481     let accesses: SmallVec<[_; 128]> =
482         callees.map(|mono_item| (*mono_item, is_inlining_candidate(mono_item))).collect();
483
484     inlining_map.lock_mut().record_accesses(caller, &accesses);
485 }
486
487 /// Format instance name that is already known to be too long for rustc.
488 /// Show only the first and last 32 characters to avoid blasting
489 /// the user's terminal with thousands of lines of type-name.
490 ///
491 /// If the type name is longer than before+after, it will be written to a file.
492 fn shrunk_instance_name(
493     tcx: TyCtxt<'tcx>,
494     instance: &Instance<'tcx>,
495     before: usize,
496     after: usize,
497 ) -> (String, Option<PathBuf>) {
498     let s = instance.to_string();
499
500     // Only use the shrunk version if it's really shorter.
501     // This also avoids the case where before and after slices overlap.
502     if s.chars().nth(before + after + 1).is_some() {
503         // An iterator of all byte positions including the end of the string.
504         let positions = || s.char_indices().map(|(i, _)| i).chain(iter::once(s.len()));
505
506         let shrunk = format!(
507             "{before}...{after}",
508             before = &s[..positions().nth(before).unwrap_or(s.len())],
509             after = &s[positions().rev().nth(after).unwrap_or(0)..],
510         );
511
512         let path = tcx.output_filenames(()).temp_path_ext("long-type.txt", None);
513         let written_to_path = std::fs::write(&path, s).ok().map(|_| path);
514
515         (shrunk, written_to_path)
516     } else {
517         (s, None)
518     }
519 }
520
521 fn check_recursion_limit<'tcx>(
522     tcx: TyCtxt<'tcx>,
523     instance: Instance<'tcx>,
524     span: Span,
525     recursion_depths: &mut DefIdMap<usize>,
526 ) -> (DefId, usize) {
527     let def_id = instance.def_id();
528     let recursion_depth = recursion_depths.get(&def_id).cloned().unwrap_or(0);
529     debug!(" => recursion depth={}", recursion_depth);
530
531     let adjusted_recursion_depth = if Some(def_id) == tcx.lang_items().drop_in_place_fn() {
532         // HACK: drop_in_place creates tight monomorphization loops. Give
533         // it more margin.
534         recursion_depth / 4
535     } else {
536         recursion_depth
537     };
538
539     // Code that needs to instantiate the same function recursively
540     // more than the recursion limit is assumed to be causing an
541     // infinite expansion.
542     if !tcx.sess.recursion_limit().value_within_limit(adjusted_recursion_depth) {
543         let (shrunk, written_to_path) = shrunk_instance_name(tcx, &instance, 32, 32);
544         let error = format!("reached the recursion limit while instantiating `{}`", shrunk);
545         let mut err = tcx.sess.struct_span_fatal(span, &error);
546         err.span_note(
547             tcx.def_span(def_id),
548             &format!("`{}` defined here", tcx.def_path_str(def_id)),
549         );
550         if let Some(path) = written_to_path {
551             err.note(&format!("the full type name has been written to '{}'", path.display()));
552         }
553         err.emit();
554         FatalError.raise();
555     }
556
557     recursion_depths.insert(def_id, recursion_depth + 1);
558
559     (def_id, recursion_depth)
560 }
561
562 fn check_type_length_limit<'tcx>(tcx: TyCtxt<'tcx>, instance: Instance<'tcx>) {
563     let type_length = instance
564         .substs
565         .iter()
566         .flat_map(|arg| arg.walk())
567         .filter(|arg| match arg.unpack() {
568             GenericArgKind::Type(_) | GenericArgKind::Const(_) => true,
569             GenericArgKind::Lifetime(_) => false,
570         })
571         .count();
572     debug!(" => type length={}", type_length);
573
574     // Rust code can easily create exponentially-long types using only a
575     // polynomial recursion depth. Even with the default recursion
576     // depth, you can easily get cases that take >2^60 steps to run,
577     // which means that rustc basically hangs.
578     //
579     // Bail out in these cases to avoid that bad user experience.
580     if !tcx.sess.type_length_limit().value_within_limit(type_length) {
581         let (shrunk, written_to_path) = shrunk_instance_name(tcx, &instance, 32, 32);
582         let msg = format!("reached the type-length limit while instantiating `{}`", shrunk);
583         let mut diag = tcx.sess.struct_span_fatal(tcx.def_span(instance.def_id()), &msg);
584         if let Some(path) = written_to_path {
585             diag.note(&format!("the full type name has been written to '{}'", path.display()));
586         }
587         diag.help(&format!(
588             "consider adding a `#![type_length_limit=\"{}\"]` attribute to your crate",
589             type_length
590         ));
591         diag.emit();
592         tcx.sess.abort_if_errors();
593     }
594 }
595
596 struct MirNeighborCollector<'a, 'tcx> {
597     tcx: TyCtxt<'tcx>,
598     body: &'a mir::Body<'tcx>,
599     output: &'a mut Vec<Spanned<MonoItem<'tcx>>>,
600     instance: Instance<'tcx>,
601 }
602
603 impl<'a, 'tcx> MirNeighborCollector<'a, 'tcx> {
604     pub fn monomorphize<T>(&self, value: T) -> T
605     where
606         T: TypeFoldable<'tcx>,
607     {
608         debug!("monomorphize: self.instance={:?}", self.instance);
609         self.instance.subst_mir_and_normalize_erasing_regions(
610             self.tcx,
611             ty::ParamEnv::reveal_all(),
612             value,
613         )
614     }
615 }
616
617 impl<'a, 'tcx> MirVisitor<'tcx> for MirNeighborCollector<'a, 'tcx> {
618     fn visit_rvalue(&mut self, rvalue: &mir::Rvalue<'tcx>, location: Location) {
619         debug!("visiting rvalue {:?}", *rvalue);
620
621         let span = self.body.source_info(location).span;
622
623         match *rvalue {
624             // When doing an cast from a regular pointer to a fat pointer, we
625             // have to instantiate all methods of the trait being cast to, so we
626             // can build the appropriate vtable.
627             mir::Rvalue::Cast(
628                 mir::CastKind::Pointer(PointerCast::Unsize),
629                 ref operand,
630                 target_ty,
631             ) => {
632                 let target_ty = self.monomorphize(target_ty);
633                 let source_ty = operand.ty(self.body, self.tcx);
634                 let source_ty = self.monomorphize(source_ty);
635                 let (source_ty, target_ty) =
636                     find_vtable_types_for_unsizing(self.tcx, source_ty, target_ty);
637                 // This could also be a different Unsize instruction, like
638                 // from a fixed sized array to a slice. But we are only
639                 // interested in things that produce a vtable.
640                 if target_ty.is_trait() && !source_ty.is_trait() {
641                     create_mono_items_for_vtable_methods(
642                         self.tcx,
643                         target_ty,
644                         source_ty,
645                         span,
646                         self.output,
647                     );
648                 }
649             }
650             mir::Rvalue::Cast(
651                 mir::CastKind::Pointer(PointerCast::ReifyFnPointer),
652                 ref operand,
653                 _,
654             ) => {
655                 let fn_ty = operand.ty(self.body, self.tcx);
656                 let fn_ty = self.monomorphize(fn_ty);
657                 visit_fn_use(self.tcx, fn_ty, false, span, &mut self.output);
658             }
659             mir::Rvalue::Cast(
660                 mir::CastKind::Pointer(PointerCast::ClosureFnPointer(_)),
661                 ref operand,
662                 _,
663             ) => {
664                 let source_ty = operand.ty(self.body, self.tcx);
665                 let source_ty = self.monomorphize(source_ty);
666                 match *source_ty.kind() {
667                     ty::Closure(def_id, substs) => {
668                         let instance = Instance::resolve_closure(
669                             self.tcx,
670                             def_id,
671                             substs,
672                             ty::ClosureKind::FnOnce,
673                         );
674                         if should_codegen_locally(self.tcx, &instance) {
675                             self.output.push(create_fn_mono_item(self.tcx, instance, span));
676                         }
677                     }
678                     _ => bug!(),
679                 }
680             }
681             mir::Rvalue::NullaryOp(mir::NullOp::Box, _) => {
682                 let tcx = self.tcx;
683                 let exchange_malloc_fn_def_id =
684                     tcx.require_lang_item(LangItem::ExchangeMalloc, None);
685                 let instance = Instance::mono(tcx, exchange_malloc_fn_def_id);
686                 if should_codegen_locally(tcx, &instance) {
687                     self.output.push(create_fn_mono_item(self.tcx, instance, span));
688                 }
689             }
690             mir::Rvalue::ThreadLocalRef(def_id) => {
691                 assert!(self.tcx.is_thread_local_static(def_id));
692                 let instance = Instance::mono(self.tcx, def_id);
693                 if should_codegen_locally(self.tcx, &instance) {
694                     trace!("collecting thread-local static {:?}", def_id);
695                     self.output.push(respan(span, MonoItem::Static(def_id)));
696                 }
697             }
698             _ => { /* not interesting */ }
699         }
700
701         self.super_rvalue(rvalue, location);
702     }
703
704     /// This does not walk the constant, as it has been handled entirely here and trying
705     /// to walk it would attempt to evaluate the `ty::Const` inside, which doesn't necessarily
706     /// work, as some constants cannot be represented in the type system.
707     fn visit_constant(&mut self, constant: &mir::Constant<'tcx>, location: Location) {
708         let literal = self.monomorphize(constant.literal);
709         let val = match literal {
710             mir::ConstantKind::Val(val, _) => val,
711             mir::ConstantKind::Ty(ct) => match ct.val {
712                 ty::ConstKind::Value(val) => val,
713                 ty::ConstKind::Unevaluated(ct) => {
714                     let param_env = ty::ParamEnv::reveal_all();
715                     match self.tcx.const_eval_resolve(param_env, ct, None) {
716                         // The `monomorphize` call should have evaluated that constant already.
717                         Ok(val) => val,
718                         Err(ErrorHandled::Reported(ErrorReported) | ErrorHandled::Linted) => return,
719                         Err(ErrorHandled::TooGeneric) => span_bug!(
720                             self.body.source_info(location).span,
721                             "collection encountered polymorphic constant: {:?}",
722                             literal
723                         ),
724                     }
725                 }
726                 _ => return,
727             },
728         };
729         collect_const_value(self.tcx, val, self.output);
730         self.visit_ty(literal.ty(), TyContext::Location(location));
731     }
732
733     fn visit_const(&mut self, constant: &&'tcx ty::Const<'tcx>, location: Location) {
734         debug!("visiting const {:?} @ {:?}", *constant, location);
735
736         let substituted_constant = self.monomorphize(*constant);
737         let param_env = ty::ParamEnv::reveal_all();
738
739         match substituted_constant.val {
740             ty::ConstKind::Value(val) => collect_const_value(self.tcx, val, self.output),
741             ty::ConstKind::Unevaluated(unevaluated) => {
742                 match self.tcx.const_eval_resolve(param_env, unevaluated, None) {
743                     // The `monomorphize` call should have evaluated that constant already.
744                     Ok(val) => span_bug!(
745                         self.body.source_info(location).span,
746                         "collection encountered the unevaluated constant {} which evaluated to {:?}",
747                         substituted_constant,
748                         val
749                     ),
750                     Err(ErrorHandled::Reported(ErrorReported) | ErrorHandled::Linted) => {}
751                     Err(ErrorHandled::TooGeneric) => span_bug!(
752                         self.body.source_info(location).span,
753                         "collection encountered polymorphic constant: {}",
754                         substituted_constant
755                     ),
756                 }
757             }
758             _ => {}
759         }
760
761         self.super_const(constant);
762     }
763
764     fn visit_terminator(&mut self, terminator: &mir::Terminator<'tcx>, location: Location) {
765         debug!("visiting terminator {:?} @ {:?}", terminator, location);
766         let source = self.body.source_info(location).span;
767
768         let tcx = self.tcx;
769         match terminator.kind {
770             mir::TerminatorKind::Call { ref func, .. } => {
771                 let callee_ty = func.ty(self.body, tcx);
772                 let callee_ty = self.monomorphize(callee_ty);
773                 visit_fn_use(self.tcx, callee_ty, true, source, &mut self.output);
774             }
775             mir::TerminatorKind::Drop { ref place, .. }
776             | mir::TerminatorKind::DropAndReplace { ref place, .. } => {
777                 let ty = place.ty(self.body, self.tcx).ty;
778                 let ty = self.monomorphize(ty);
779                 visit_drop_use(self.tcx, ty, true, source, self.output);
780             }
781             mir::TerminatorKind::InlineAsm { ref operands, .. } => {
782                 for op in operands {
783                     match *op {
784                         mir::InlineAsmOperand::SymFn { ref value } => {
785                             let fn_ty = self.monomorphize(value.literal.ty());
786                             visit_fn_use(self.tcx, fn_ty, false, source, &mut self.output);
787                         }
788                         mir::InlineAsmOperand::SymStatic { def_id } => {
789                             let instance = Instance::mono(self.tcx, def_id);
790                             if should_codegen_locally(self.tcx, &instance) {
791                                 trace!("collecting asm sym static {:?}", def_id);
792                                 self.output.push(respan(source, MonoItem::Static(def_id)));
793                             }
794                         }
795                         _ => {}
796                     }
797                 }
798             }
799             mir::TerminatorKind::Goto { .. }
800             | mir::TerminatorKind::SwitchInt { .. }
801             | mir::TerminatorKind::Resume
802             | mir::TerminatorKind::Abort
803             | mir::TerminatorKind::Return
804             | mir::TerminatorKind::Unreachable
805             | mir::TerminatorKind::Assert { .. } => {}
806             mir::TerminatorKind::GeneratorDrop
807             | mir::TerminatorKind::Yield { .. }
808             | mir::TerminatorKind::FalseEdge { .. }
809             | mir::TerminatorKind::FalseUnwind { .. } => bug!(),
810         }
811
812         self.super_terminator(terminator, location);
813     }
814
815     fn visit_operand(&mut self, operand: &mir::Operand<'tcx>, location: Location) {
816         self.super_operand(operand, location);
817         let limit = self.tcx.sess.move_size_limit();
818         if limit == 0 {
819             return;
820         }
821         let limit = Size::from_bytes(limit);
822         let ty = operand.ty(self.body, self.tcx);
823         let ty = self.monomorphize(ty);
824         let layout = self.tcx.layout_of(ty::ParamEnv::reveal_all().and(ty));
825         if let Ok(layout) = layout {
826             if layout.size > limit {
827                 debug!(?layout);
828                 let source_info = self.body.source_info(location);
829                 debug!(?source_info);
830                 let lint_root = source_info.scope.lint_root(&self.body.source_scopes);
831                 debug!(?lint_root);
832                 let lint_root = match lint_root {
833                     Some(lint_root) => lint_root,
834                     // This happens when the issue is in a function from a foreign crate that
835                     // we monomorphized in the current crate. We can't get a `HirId` for things
836                     // in other crates.
837                     // FIXME: Find out where to report the lint on. Maybe simply crate-level lint root
838                     // but correct span? This would make the lint at least accept crate-level lint attributes.
839                     None => return,
840                 };
841                 self.tcx.struct_span_lint_hir(
842                     LARGE_ASSIGNMENTS,
843                     lint_root,
844                     source_info.span,
845                     |lint| {
846                         let mut err = lint.build(&format!("moving {} bytes", layout.size.bytes()));
847                         err.span_label(source_info.span, "value moved from here");
848                         err.emit()
849                     },
850                 );
851             }
852         }
853     }
854
855     fn visit_local(
856         &mut self,
857         _place_local: &Local,
858         _context: mir::visit::PlaceContext,
859         _location: Location,
860     ) {
861     }
862 }
863
864 fn visit_drop_use<'tcx>(
865     tcx: TyCtxt<'tcx>,
866     ty: Ty<'tcx>,
867     is_direct_call: bool,
868     source: Span,
869     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
870 ) {
871     let instance = Instance::resolve_drop_in_place(tcx, ty);
872     visit_instance_use(tcx, instance, is_direct_call, source, output);
873 }
874
875 fn visit_fn_use<'tcx>(
876     tcx: TyCtxt<'tcx>,
877     ty: Ty<'tcx>,
878     is_direct_call: bool,
879     source: Span,
880     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
881 ) {
882     if let ty::FnDef(def_id, substs) = *ty.kind() {
883         let instance = if is_direct_call {
884             ty::Instance::resolve(tcx, ty::ParamEnv::reveal_all(), def_id, substs).unwrap().unwrap()
885         } else {
886             ty::Instance::resolve_for_fn_ptr(tcx, ty::ParamEnv::reveal_all(), def_id, substs)
887                 .unwrap()
888         };
889         visit_instance_use(tcx, instance, is_direct_call, source, output);
890     }
891 }
892
893 fn visit_instance_use<'tcx>(
894     tcx: TyCtxt<'tcx>,
895     instance: ty::Instance<'tcx>,
896     is_direct_call: bool,
897     source: Span,
898     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
899 ) {
900     debug!("visit_item_use({:?}, is_direct_call={:?})", instance, is_direct_call);
901     if !should_codegen_locally(tcx, &instance) {
902         return;
903     }
904
905     match instance.def {
906         ty::InstanceDef::Virtual(..) | ty::InstanceDef::Intrinsic(_) => {
907             if !is_direct_call {
908                 bug!("{:?} being reified", instance);
909             }
910         }
911         ty::InstanceDef::DropGlue(_, None) => {
912             // Don't need to emit noop drop glue if we are calling directly.
913             if !is_direct_call {
914                 output.push(create_fn_mono_item(tcx, instance, source));
915             }
916         }
917         ty::InstanceDef::DropGlue(_, Some(_))
918         | ty::InstanceDef::VtableShim(..)
919         | ty::InstanceDef::ReifyShim(..)
920         | ty::InstanceDef::ClosureOnceShim { .. }
921         | ty::InstanceDef::Item(..)
922         | ty::InstanceDef::FnPtrShim(..)
923         | ty::InstanceDef::CloneShim(..) => {
924             output.push(create_fn_mono_item(tcx, instance, source));
925         }
926     }
927 }
928
929 // Returns `true` if we should codegen an instance in the local crate.
930 // Returns `false` if we can just link to the upstream crate and therefore don't
931 // need a mono item.
932 fn should_codegen_locally<'tcx>(tcx: TyCtxt<'tcx>, instance: &Instance<'tcx>) -> bool {
933     let def_id = match instance.def {
934         ty::InstanceDef::Item(def) => def.did,
935         ty::InstanceDef::DropGlue(def_id, Some(_)) => def_id,
936         ty::InstanceDef::VtableShim(..)
937         | ty::InstanceDef::ReifyShim(..)
938         | ty::InstanceDef::ClosureOnceShim { .. }
939         | ty::InstanceDef::Virtual(..)
940         | ty::InstanceDef::FnPtrShim(..)
941         | ty::InstanceDef::DropGlue(..)
942         | ty::InstanceDef::Intrinsic(_)
943         | ty::InstanceDef::CloneShim(..) => return true,
944     };
945
946     if tcx.is_foreign_item(def_id) {
947         // Foreign items are always linked against, there's no way of instantiating them.
948         return false;
949     }
950
951     if def_id.is_local() {
952         // Local items cannot be referred to locally without monomorphizing them locally.
953         return true;
954     }
955
956     if tcx.is_reachable_non_generic(def_id)
957         || instance.polymorphize(tcx).upstream_monomorphization(tcx).is_some()
958     {
959         // We can link to the item in question, no instance needed in this crate.
960         return false;
961     }
962
963     if !tcx.is_mir_available(def_id) {
964         bug!("no MIR available for {:?}", def_id);
965     }
966
967     true
968 }
969
970 /// For a given pair of source and target type that occur in an unsizing coercion,
971 /// this function finds the pair of types that determines the vtable linking
972 /// them.
973 ///
974 /// For example, the source type might be `&SomeStruct` and the target type\
975 /// might be `&SomeTrait` in a cast like:
976 ///
977 /// let src: &SomeStruct = ...;
978 /// let target = src as &SomeTrait;
979 ///
980 /// Then the output of this function would be (SomeStruct, SomeTrait) since for
981 /// constructing the `target` fat-pointer we need the vtable for that pair.
982 ///
983 /// Things can get more complicated though because there's also the case where
984 /// the unsized type occurs as a field:
985 ///
986 /// ```rust
987 /// struct ComplexStruct<T: ?Sized> {
988 ///    a: u32,
989 ///    b: f64,
990 ///    c: T
991 /// }
992 /// ```
993 ///
994 /// In this case, if `T` is sized, `&ComplexStruct<T>` is a thin pointer. If `T`
995 /// is unsized, `&SomeStruct` is a fat pointer, and the vtable it points to is
996 /// for the pair of `T` (which is a trait) and the concrete type that `T` was
997 /// originally coerced from:
998 ///
999 /// let src: &ComplexStruct<SomeStruct> = ...;
1000 /// let target = src as &ComplexStruct<SomeTrait>;
1001 ///
1002 /// Again, we want this `find_vtable_types_for_unsizing()` to provide the pair
1003 /// `(SomeStruct, SomeTrait)`.
1004 ///
1005 /// Finally, there is also the case of custom unsizing coercions, e.g., for
1006 /// smart pointers such as `Rc` and `Arc`.
1007 fn find_vtable_types_for_unsizing<'tcx>(
1008     tcx: TyCtxt<'tcx>,
1009     source_ty: Ty<'tcx>,
1010     target_ty: Ty<'tcx>,
1011 ) -> (Ty<'tcx>, Ty<'tcx>) {
1012     let ptr_vtable = |inner_source: Ty<'tcx>, inner_target: Ty<'tcx>| {
1013         let param_env = ty::ParamEnv::reveal_all();
1014         let type_has_metadata = |ty: Ty<'tcx>| -> bool {
1015             if ty.is_sized(tcx.at(DUMMY_SP), param_env) {
1016                 return false;
1017             }
1018             let tail = tcx.struct_tail_erasing_lifetimes(ty, param_env);
1019             match tail.kind() {
1020                 ty::Foreign(..) => false,
1021                 ty::Str | ty::Slice(..) | ty::Dynamic(..) => true,
1022                 _ => bug!("unexpected unsized tail: {:?}", tail),
1023             }
1024         };
1025         if type_has_metadata(inner_source) {
1026             (inner_source, inner_target)
1027         } else {
1028             tcx.struct_lockstep_tails_erasing_lifetimes(inner_source, inner_target, param_env)
1029         }
1030     };
1031
1032     match (&source_ty.kind(), &target_ty.kind()) {
1033         (&ty::Ref(_, a, _), &ty::Ref(_, b, _) | &ty::RawPtr(ty::TypeAndMut { ty: b, .. }))
1034         | (&ty::RawPtr(ty::TypeAndMut { ty: a, .. }), &ty::RawPtr(ty::TypeAndMut { ty: b, .. })) => {
1035             ptr_vtable(a, b)
1036         }
1037         (&ty::Adt(def_a, _), &ty::Adt(def_b, _)) if def_a.is_box() && def_b.is_box() => {
1038             ptr_vtable(source_ty.boxed_ty(), target_ty.boxed_ty())
1039         }
1040
1041         (&ty::Adt(source_adt_def, source_substs), &ty::Adt(target_adt_def, target_substs)) => {
1042             assert_eq!(source_adt_def, target_adt_def);
1043
1044             let CustomCoerceUnsized::Struct(coerce_index) =
1045                 monomorphize::custom_coerce_unsize_info(tcx, source_ty, target_ty);
1046
1047             let source_fields = &source_adt_def.non_enum_variant().fields;
1048             let target_fields = &target_adt_def.non_enum_variant().fields;
1049
1050             assert!(
1051                 coerce_index < source_fields.len() && source_fields.len() == target_fields.len()
1052             );
1053
1054             find_vtable_types_for_unsizing(
1055                 tcx,
1056                 source_fields[coerce_index].ty(tcx, source_substs),
1057                 target_fields[coerce_index].ty(tcx, target_substs),
1058             )
1059         }
1060         _ => bug!(
1061             "find_vtable_types_for_unsizing: invalid coercion {:?} -> {:?}",
1062             source_ty,
1063             target_ty
1064         ),
1065     }
1066 }
1067
1068 fn create_fn_mono_item<'tcx>(
1069     tcx: TyCtxt<'tcx>,
1070     instance: Instance<'tcx>,
1071     source: Span,
1072 ) -> Spanned<MonoItem<'tcx>> {
1073     debug!("create_fn_mono_item(instance={})", instance);
1074     respan(source, MonoItem::Fn(instance.polymorphize(tcx)))
1075 }
1076
1077 /// Creates a `MonoItem` for each method that is referenced by the vtable for
1078 /// the given trait/impl pair.
1079 fn create_mono_items_for_vtable_methods<'tcx>(
1080     tcx: TyCtxt<'tcx>,
1081     trait_ty: Ty<'tcx>,
1082     impl_ty: Ty<'tcx>,
1083     source: Span,
1084     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1085 ) {
1086     assert!(!trait_ty.has_escaping_bound_vars() && !impl_ty.has_escaping_bound_vars());
1087
1088     if let ty::Dynamic(ref trait_ty, ..) = trait_ty.kind() {
1089         if let Some(principal) = trait_ty.principal() {
1090             let poly_trait_ref = principal.with_self_ty(tcx, impl_ty);
1091             assert!(!poly_trait_ref.has_escaping_bound_vars());
1092
1093             // Walk all methods of the trait, including those of its supertraits
1094             let methods = tcx.vtable_methods(poly_trait_ref);
1095             let methods = methods
1096                 .iter()
1097                 .cloned()
1098                 .filter_map(|method| method)
1099                 .map(|(def_id, substs)| {
1100                     ty::Instance::resolve_for_vtable(
1101                         tcx,
1102                         ty::ParamEnv::reveal_all(),
1103                         def_id,
1104                         substs,
1105                     )
1106                     .unwrap()
1107                 })
1108                 .filter(|&instance| should_codegen_locally(tcx, &instance))
1109                 .map(|item| create_fn_mono_item(tcx, item, source));
1110             output.extend(methods);
1111         }
1112
1113         // Also add the destructor.
1114         visit_drop_use(tcx, impl_ty, false, source, output);
1115     }
1116 }
1117
1118 //=-----------------------------------------------------------------------------
1119 // Root Collection
1120 //=-----------------------------------------------------------------------------
1121
1122 struct RootCollector<'a, 'tcx> {
1123     tcx: TyCtxt<'tcx>,
1124     mode: MonoItemCollectionMode,
1125     output: &'a mut Vec<Spanned<MonoItem<'tcx>>>,
1126     entry_fn: Option<(DefId, EntryFnType)>,
1127 }
1128
1129 impl ItemLikeVisitor<'v> for RootCollector<'_, 'v> {
1130     fn visit_item(&mut self, item: &'v hir::Item<'v>) {
1131         match item.kind {
1132             hir::ItemKind::ExternCrate(..)
1133             | hir::ItemKind::Use(..)
1134             | hir::ItemKind::ForeignMod { .. }
1135             | hir::ItemKind::TyAlias(..)
1136             | hir::ItemKind::Trait(..)
1137             | hir::ItemKind::TraitAlias(..)
1138             | hir::ItemKind::OpaqueTy(..)
1139             | hir::ItemKind::Mod(..) => {
1140                 // Nothing to do, just keep recursing.
1141             }
1142
1143             hir::ItemKind::Impl { .. } => {
1144                 if self.mode == MonoItemCollectionMode::Eager {
1145                     create_mono_items_for_default_impls(self.tcx, item, self.output);
1146                 }
1147             }
1148
1149             hir::ItemKind::Enum(_, ref generics)
1150             | hir::ItemKind::Struct(_, ref generics)
1151             | hir::ItemKind::Union(_, ref generics) => {
1152                 if generics.params.is_empty() {
1153                     if self.mode == MonoItemCollectionMode::Eager {
1154                         debug!(
1155                             "RootCollector: ADT drop-glue for {}",
1156                             self.tcx.def_path_str(item.def_id.to_def_id())
1157                         );
1158
1159                         let ty = Instance::new(item.def_id.to_def_id(), InternalSubsts::empty())
1160                             .ty(self.tcx, ty::ParamEnv::reveal_all());
1161                         visit_drop_use(self.tcx, ty, true, DUMMY_SP, self.output);
1162                     }
1163                 }
1164             }
1165             hir::ItemKind::GlobalAsm(..) => {
1166                 debug!(
1167                     "RootCollector: ItemKind::GlobalAsm({})",
1168                     self.tcx.def_path_str(item.def_id.to_def_id())
1169                 );
1170                 self.output.push(dummy_spanned(MonoItem::GlobalAsm(item.item_id())));
1171             }
1172             hir::ItemKind::Static(..) => {
1173                 debug!(
1174                     "RootCollector: ItemKind::Static({})",
1175                     self.tcx.def_path_str(item.def_id.to_def_id())
1176                 );
1177                 self.output.push(dummy_spanned(MonoItem::Static(item.def_id.to_def_id())));
1178             }
1179             hir::ItemKind::Const(..) => {
1180                 // const items only generate mono items if they are
1181                 // actually used somewhere. Just declaring them is insufficient.
1182
1183                 // but even just declaring them must collect the items they refer to
1184                 if let Ok(val) = self.tcx.const_eval_poly(item.def_id.to_def_id()) {
1185                     collect_const_value(self.tcx, val, &mut self.output);
1186                 }
1187             }
1188             hir::ItemKind::Fn(..) => {
1189                 self.push_if_root(item.def_id);
1190             }
1191         }
1192     }
1193
1194     fn visit_trait_item(&mut self, _: &'v hir::TraitItem<'v>) {
1195         // Even if there's a default body with no explicit generics,
1196         // it's still generic over some `Self: Trait`, so not a root.
1197     }
1198
1199     fn visit_impl_item(&mut self, ii: &'v hir::ImplItem<'v>) {
1200         if let hir::ImplItemKind::Fn(hir::FnSig { .. }, _) = ii.kind {
1201             self.push_if_root(ii.def_id);
1202         }
1203     }
1204
1205     fn visit_foreign_item(&mut self, _foreign_item: &'v hir::ForeignItem<'v>) {}
1206 }
1207
1208 impl RootCollector<'_, 'v> {
1209     fn is_root(&self, def_id: LocalDefId) -> bool {
1210         !item_requires_monomorphization(self.tcx, def_id)
1211             && match self.mode {
1212                 MonoItemCollectionMode::Eager => true,
1213                 MonoItemCollectionMode::Lazy => {
1214                     self.entry_fn.and_then(|(id, _)| id.as_local()) == Some(def_id)
1215                         || self.tcx.is_reachable_non_generic(def_id)
1216                         || self
1217                             .tcx
1218                             .codegen_fn_attrs(def_id)
1219                             .flags
1220                             .contains(CodegenFnAttrFlags::RUSTC_STD_INTERNAL_SYMBOL)
1221                 }
1222             }
1223     }
1224
1225     /// If `def_id` represents a root, pushes it onto the list of
1226     /// outputs. (Note that all roots must be monomorphic.)
1227     fn push_if_root(&mut self, def_id: LocalDefId) {
1228         if self.is_root(def_id) {
1229             debug!("RootCollector::push_if_root: found root def_id={:?}", def_id);
1230
1231             let instance = Instance::mono(self.tcx, def_id.to_def_id());
1232             self.output.push(create_fn_mono_item(self.tcx, instance, DUMMY_SP));
1233         }
1234     }
1235
1236     /// As a special case, when/if we encounter the
1237     /// `main()` function, we also have to generate a
1238     /// monomorphized copy of the start lang item based on
1239     /// the return type of `main`. This is not needed when
1240     /// the user writes their own `start` manually.
1241     fn push_extra_entry_roots(&mut self) {
1242         let main_def_id = match self.entry_fn {
1243             Some((def_id, EntryFnType::Main)) => def_id,
1244             _ => return,
1245         };
1246
1247         let start_def_id = match self.tcx.lang_items().require(LangItem::Start) {
1248             Ok(s) => s,
1249             Err(err) => self.tcx.sess.fatal(&err),
1250         };
1251         let main_ret_ty = self.tcx.fn_sig(main_def_id).output();
1252
1253         // Given that `main()` has no arguments,
1254         // then its return type cannot have
1255         // late-bound regions, since late-bound
1256         // regions must appear in the argument
1257         // listing.
1258         let main_ret_ty = self.tcx.erase_regions(main_ret_ty.no_bound_vars().unwrap());
1259
1260         let start_instance = Instance::resolve(
1261             self.tcx,
1262             ty::ParamEnv::reveal_all(),
1263             start_def_id,
1264             self.tcx.intern_substs(&[main_ret_ty.into()]),
1265         )
1266         .unwrap()
1267         .unwrap();
1268
1269         self.output.push(create_fn_mono_item(self.tcx, start_instance, DUMMY_SP));
1270     }
1271 }
1272
1273 fn item_requires_monomorphization(tcx: TyCtxt<'_>, def_id: LocalDefId) -> bool {
1274     let generics = tcx.generics_of(def_id);
1275     generics.requires_monomorphization(tcx)
1276 }
1277
1278 fn create_mono_items_for_default_impls<'tcx>(
1279     tcx: TyCtxt<'tcx>,
1280     item: &'tcx hir::Item<'tcx>,
1281     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1282 ) {
1283     match item.kind {
1284         hir::ItemKind::Impl(ref impl_) => {
1285             for param in impl_.generics.params {
1286                 match param.kind {
1287                     hir::GenericParamKind::Lifetime { .. } => {}
1288                     hir::GenericParamKind::Type { .. } | hir::GenericParamKind::Const { .. } => {
1289                         return;
1290                     }
1291                 }
1292             }
1293
1294             debug!(
1295                 "create_mono_items_for_default_impls(item={})",
1296                 tcx.def_path_str(item.def_id.to_def_id())
1297             );
1298
1299             if let Some(trait_ref) = tcx.impl_trait_ref(item.def_id) {
1300                 let param_env = ty::ParamEnv::reveal_all();
1301                 let trait_ref = tcx.normalize_erasing_regions(param_env, trait_ref);
1302                 let overridden_methods: FxHashSet<_> =
1303                     impl_.items.iter().map(|iiref| iiref.ident.normalize_to_macros_2_0()).collect();
1304                 for method in tcx.provided_trait_methods(trait_ref.def_id) {
1305                     if overridden_methods.contains(&method.ident.normalize_to_macros_2_0()) {
1306                         continue;
1307                     }
1308
1309                     if tcx.generics_of(method.def_id).own_requires_monomorphization() {
1310                         continue;
1311                     }
1312
1313                     let substs =
1314                         InternalSubsts::for_item(tcx, method.def_id, |param, _| match param.kind {
1315                             GenericParamDefKind::Lifetime => tcx.lifetimes.re_erased.into(),
1316                             GenericParamDefKind::Type { .. }
1317                             | GenericParamDefKind::Const { .. } => {
1318                                 trait_ref.substs[param.index as usize]
1319                             }
1320                         });
1321                     let instance = ty::Instance::resolve(tcx, param_env, method.def_id, substs)
1322                         .unwrap()
1323                         .unwrap();
1324
1325                     let mono_item = create_fn_mono_item(tcx, instance, DUMMY_SP);
1326                     if mono_item.node.is_instantiable(tcx) && should_codegen_locally(tcx, &instance)
1327                     {
1328                         output.push(mono_item);
1329                     }
1330                 }
1331             }
1332         }
1333         _ => bug!(),
1334     }
1335 }
1336
1337 /// Scans the miri alloc in order to find function calls, closures, and drop-glue.
1338 fn collect_miri<'tcx>(
1339     tcx: TyCtxt<'tcx>,
1340     alloc_id: AllocId,
1341     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1342 ) {
1343     match tcx.global_alloc(alloc_id) {
1344         GlobalAlloc::Static(def_id) => {
1345             assert!(!tcx.is_thread_local_static(def_id));
1346             let instance = Instance::mono(tcx, def_id);
1347             if should_codegen_locally(tcx, &instance) {
1348                 trace!("collecting static {:?}", def_id);
1349                 output.push(dummy_spanned(MonoItem::Static(def_id)));
1350             }
1351         }
1352         GlobalAlloc::Memory(alloc) => {
1353             trace!("collecting {:?} with {:#?}", alloc_id, alloc);
1354             for &((), inner) in alloc.relocations().values() {
1355                 rustc_data_structures::stack::ensure_sufficient_stack(|| {
1356                     collect_miri(tcx, inner, output);
1357                 });
1358             }
1359         }
1360         GlobalAlloc::Function(fn_instance) => {
1361             if should_codegen_locally(tcx, &fn_instance) {
1362                 trace!("collecting {:?} with {:#?}", alloc_id, fn_instance);
1363                 output.push(create_fn_mono_item(tcx, fn_instance, DUMMY_SP));
1364             }
1365         }
1366     }
1367 }
1368
1369 /// Scans the MIR in order to find function calls, closures, and drop-glue.
1370 fn collect_neighbours<'tcx>(
1371     tcx: TyCtxt<'tcx>,
1372     instance: Instance<'tcx>,
1373     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1374 ) {
1375     debug!("collect_neighbours: {:?}", instance.def_id());
1376     let body = tcx.instance_mir(instance.def);
1377
1378     MirNeighborCollector { tcx, body: &body, output, instance }.visit_body(&body);
1379 }
1380
1381 fn collect_const_value<'tcx>(
1382     tcx: TyCtxt<'tcx>,
1383     value: ConstValue<'tcx>,
1384     output: &mut Vec<Spanned<MonoItem<'tcx>>>,
1385 ) {
1386     match value {
1387         ConstValue::Scalar(Scalar::Ptr(ptr)) => collect_miri(tcx, ptr.alloc_id, output),
1388         ConstValue::Slice { data: alloc, start: _, end: _ } | ConstValue::ByRef { alloc, .. } => {
1389             for &((), id) in alloc.relocations().values() {
1390                 collect_miri(tcx, id, output);
1391             }
1392         }
1393         _ => {}
1394     }
1395 }