]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_resolve/src/lib.rs
Rollup merge of #101256 - andrewpollack:fuchsia-docs-adding, r=tmandry
[rust.git] / compiler / rustc_resolve / src / lib.rs
1 //! This crate is responsible for the part of name resolution that doesn't require type checker.
2 //!
3 //! Module structure of the crate is built here.
4 //! Paths in macros, imports, expressions, types, patterns are resolved here.
5 //! Label and lifetime names are resolved here as well.
6 //!
7 //! Type-relative name resolution (methods, fields, associated items) happens in `rustc_typeck`.
8
9 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
10 #![feature(box_patterns)]
11 #![feature(drain_filter)]
12 #![feature(if_let_guard)]
13 #![feature(iter_intersperse)]
14 #![feature(let_chains)]
15 #![feature(let_else)]
16 #![feature(never_type)]
17 #![recursion_limit = "256"]
18 #![allow(rustdoc::private_intra_doc_links)]
19 #![allow(rustc::potential_query_instability)]
20
21 #[macro_use]
22 extern crate tracing;
23
24 pub use rustc_hir::def::{Namespace, PerNS};
25
26 use rustc_arena::{DroplessArena, TypedArena};
27 use rustc_ast::node_id::NodeMap;
28 use rustc_ast::{self as ast, NodeId, CRATE_NODE_ID};
29 use rustc_ast::{AngleBracketedArg, Crate, Expr, ExprKind, GenericArg, GenericArgs, LitKind, Path};
30 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap, FxIndexSet};
31 use rustc_data_structures::intern::Interned;
32 use rustc_data_structures::sync::Lrc;
33 use rustc_errors::{Applicability, DiagnosticBuilder, ErrorGuaranteed};
34 use rustc_expand::base::{DeriveResolutions, SyntaxExtension, SyntaxExtensionKind};
35 use rustc_hir::def::Namespace::*;
36 use rustc_hir::def::{self, CtorOf, DefKind, LifetimeRes, PartialRes};
37 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, LocalDefId};
38 use rustc_hir::def_id::{CRATE_DEF_ID, LOCAL_CRATE};
39 use rustc_hir::definitions::{DefPathData, Definitions};
40 use rustc_hir::TraitCandidate;
41 use rustc_index::vec::IndexVec;
42 use rustc_metadata::creader::{CStore, CrateLoader};
43 use rustc_middle::metadata::ModChild;
44 use rustc_middle::middle::privacy::AccessLevels;
45 use rustc_middle::span_bug;
46 use rustc_middle::ty::query::Providers;
47 use rustc_middle::ty::{self, DefIdTree, MainDefinition, RegisteredTools, ResolverOutputs};
48 use rustc_query_system::ich::StableHashingContext;
49 use rustc_session::cstore::{CrateStore, CrateStoreDyn, MetadataLoaderDyn};
50 use rustc_session::lint::LintBuffer;
51 use rustc_session::Session;
52 use rustc_span::hygiene::{ExpnId, LocalExpnId, MacroKind, SyntaxContext, Transparency};
53 use rustc_span::source_map::Spanned;
54 use rustc_span::symbol::{kw, sym, Ident, Symbol};
55 use rustc_span::{Span, DUMMY_SP};
56
57 use smallvec::{smallvec, SmallVec};
58 use std::cell::{Cell, RefCell};
59 use std::collections::BTreeSet;
60 use std::{cmp, fmt, ptr};
61
62 use diagnostics::{ImportSuggestion, LabelSuggestion, Suggestion};
63 use imports::{Import, ImportKind, ImportResolver, NameResolution};
64 use late::{HasGenericParams, PathSource, PatternSource};
65 use macros::{MacroRulesBinding, MacroRulesScope, MacroRulesScopeRef};
66
67 use crate::access_levels::AccessLevelsVisitor;
68
69 type Res = def::Res<NodeId>;
70
71 mod access_levels;
72 mod build_reduced_graph;
73 mod check_unused;
74 mod def_collector;
75 mod diagnostics;
76 mod ident;
77 mod imports;
78 mod late;
79 mod macros;
80
81 enum Weak {
82     Yes,
83     No,
84 }
85
86 #[derive(Copy, Clone, PartialEq, Debug)]
87 pub enum Determinacy {
88     Determined,
89     Undetermined,
90 }
91
92 impl Determinacy {
93     fn determined(determined: bool) -> Determinacy {
94         if determined { Determinacy::Determined } else { Determinacy::Undetermined }
95     }
96 }
97
98 /// A specific scope in which a name can be looked up.
99 /// This enum is currently used only for early resolution (imports and macros),
100 /// but not for late resolution yet.
101 #[derive(Clone, Copy)]
102 enum Scope<'a> {
103     DeriveHelpers(LocalExpnId),
104     DeriveHelpersCompat,
105     MacroRules(MacroRulesScopeRef<'a>),
106     CrateRoot,
107     // The node ID is for reporting the `PROC_MACRO_DERIVE_RESOLUTION_FALLBACK`
108     // lint if it should be reported.
109     Module(Module<'a>, Option<NodeId>),
110     MacroUsePrelude,
111     BuiltinAttrs,
112     ExternPrelude,
113     ToolPrelude,
114     StdLibPrelude,
115     BuiltinTypes,
116 }
117
118 /// Names from different contexts may want to visit different subsets of all specific scopes
119 /// with different restrictions when looking up the resolution.
120 /// This enum is currently used only for early resolution (imports and macros),
121 /// but not for late resolution yet.
122 #[derive(Clone, Copy)]
123 enum ScopeSet<'a> {
124     /// All scopes with the given namespace.
125     All(Namespace, /*is_import*/ bool),
126     /// Crate root, then extern prelude (used for mixed 2015-2018 mode in macros).
127     AbsolutePath(Namespace),
128     /// All scopes with macro namespace and the given macro kind restriction.
129     Macro(MacroKind),
130     /// All scopes with the given namespace, used for partially performing late resolution.
131     /// The node id enables lints and is used for reporting them.
132     Late(Namespace, Module<'a>, Option<NodeId>),
133 }
134
135 /// Everything you need to know about a name's location to resolve it.
136 /// Serves as a starting point for the scope visitor.
137 /// This struct is currently used only for early resolution (imports and macros),
138 /// but not for late resolution yet.
139 #[derive(Clone, Copy, Debug)]
140 pub struct ParentScope<'a> {
141     pub module: Module<'a>,
142     expansion: LocalExpnId,
143     pub macro_rules: MacroRulesScopeRef<'a>,
144     derives: &'a [ast::Path],
145 }
146
147 impl<'a> ParentScope<'a> {
148     /// Creates a parent scope with the passed argument used as the module scope component,
149     /// and other scope components set to default empty values.
150     pub fn module(module: Module<'a>, resolver: &Resolver<'a>) -> ParentScope<'a> {
151         ParentScope {
152             module,
153             expansion: LocalExpnId::ROOT,
154             macro_rules: resolver.arenas.alloc_macro_rules_scope(MacroRulesScope::Empty),
155             derives: &[],
156         }
157     }
158 }
159
160 #[derive(Copy, Debug, Clone)]
161 enum ImplTraitContext {
162     Existential,
163     Universal(LocalDefId),
164 }
165
166 #[derive(Eq)]
167 struct BindingError {
168     name: Symbol,
169     origin: BTreeSet<Span>,
170     target: BTreeSet<Span>,
171     could_be_path: bool,
172 }
173
174 impl PartialOrd for BindingError {
175     fn partial_cmp(&self, other: &BindingError) -> Option<cmp::Ordering> {
176         Some(self.cmp(other))
177     }
178 }
179
180 impl PartialEq for BindingError {
181     fn eq(&self, other: &BindingError) -> bool {
182         self.name == other.name
183     }
184 }
185
186 impl Ord for BindingError {
187     fn cmp(&self, other: &BindingError) -> cmp::Ordering {
188         self.name.cmp(&other.name)
189     }
190 }
191
192 enum ResolutionError<'a> {
193     /// Error E0401: can't use type or const parameters from outer function.
194     GenericParamsFromOuterFunction(Res, HasGenericParams),
195     /// Error E0403: the name is already used for a type or const parameter in this generic
196     /// parameter list.
197     NameAlreadyUsedInParameterList(Symbol, Span),
198     /// Error E0407: method is not a member of trait.
199     MethodNotMemberOfTrait(Ident, String, Option<Symbol>),
200     /// Error E0437: type is not a member of trait.
201     TypeNotMemberOfTrait(Ident, String, Option<Symbol>),
202     /// Error E0438: const is not a member of trait.
203     ConstNotMemberOfTrait(Ident, String, Option<Symbol>),
204     /// Error E0408: variable `{}` is not bound in all patterns.
205     VariableNotBoundInPattern(BindingError, ParentScope<'a>),
206     /// Error E0409: variable `{}` is bound in inconsistent ways within the same match arm.
207     VariableBoundWithDifferentMode(Symbol, Span),
208     /// Error E0415: identifier is bound more than once in this parameter list.
209     IdentifierBoundMoreThanOnceInParameterList(Symbol),
210     /// Error E0416: identifier is bound more than once in the same pattern.
211     IdentifierBoundMoreThanOnceInSamePattern(Symbol),
212     /// Error E0426: use of undeclared label.
213     UndeclaredLabel { name: Symbol, suggestion: Option<LabelSuggestion> },
214     /// Error E0429: `self` imports are only allowed within a `{ }` list.
215     SelfImportsOnlyAllowedWithin { root: bool, span_with_rename: Span },
216     /// Error E0430: `self` import can only appear once in the list.
217     SelfImportCanOnlyAppearOnceInTheList,
218     /// Error E0431: `self` import can only appear in an import list with a non-empty prefix.
219     SelfImportOnlyInImportListWithNonEmptyPrefix,
220     /// Error E0433: failed to resolve.
221     FailedToResolve { label: String, suggestion: Option<Suggestion> },
222     /// Error E0434: can't capture dynamic environment in a fn item.
223     CannotCaptureDynamicEnvironmentInFnItem,
224     /// Error E0435: attempt to use a non-constant value in a constant.
225     AttemptToUseNonConstantValueInConstant(
226         Ident,
227         /* suggestion */ &'static str,
228         /* current */ &'static str,
229     ),
230     /// Error E0530: `X` bindings cannot shadow `Y`s.
231     BindingShadowsSomethingUnacceptable {
232         shadowing_binding: PatternSource,
233         name: Symbol,
234         participle: &'static str,
235         article: &'static str,
236         shadowed_binding: Res,
237         shadowed_binding_span: Span,
238     },
239     /// Error E0128: generic parameters with a default cannot use forward-declared identifiers.
240     ForwardDeclaredGenericParam,
241     /// ERROR E0770: the type of const parameters must not depend on other generic parameters.
242     ParamInTyOfConstParam(Symbol),
243     /// generic parameters must not be used inside const evaluations.
244     ///
245     /// This error is only emitted when using `min_const_generics`.
246     ParamInNonTrivialAnonConst { name: Symbol, is_type: bool },
247     /// Error E0735: generic parameters with a default cannot use `Self`
248     SelfInGenericParamDefault,
249     /// Error E0767: use of unreachable label
250     UnreachableLabel { name: Symbol, definition_span: Span, suggestion: Option<LabelSuggestion> },
251     /// Error E0323, E0324, E0325: mismatch between trait item and impl item.
252     TraitImplMismatch {
253         name: Symbol,
254         kind: &'static str,
255         trait_path: String,
256         trait_item_span: Span,
257         code: rustc_errors::DiagnosticId,
258     },
259     /// Inline asm `sym` operand must refer to a `fn` or `static`.
260     InvalidAsmSym,
261 }
262
263 enum VisResolutionError<'a> {
264     Relative2018(Span, &'a ast::Path),
265     AncestorOnly(Span),
266     FailedToResolve(Span, String, Option<Suggestion>),
267     ExpectedFound(Span, String, Res),
268     Indeterminate(Span),
269     ModuleOnly(Span),
270 }
271
272 /// A minimal representation of a path segment. We use this in resolve because we synthesize 'path
273 /// segments' which don't have the rest of an AST or HIR `PathSegment`.
274 #[derive(Clone, Copy, Debug)]
275 pub struct Segment {
276     ident: Ident,
277     id: Option<NodeId>,
278     /// Signals whether this `PathSegment` has generic arguments. Used to avoid providing
279     /// nonsensical suggestions.
280     has_generic_args: bool,
281     /// Signals whether this `PathSegment` has lifetime arguments.
282     has_lifetime_args: bool,
283     args_span: Span,
284 }
285
286 impl Segment {
287     fn from_path(path: &Path) -> Vec<Segment> {
288         path.segments.iter().map(|s| s.into()).collect()
289     }
290
291     fn from_ident(ident: Ident) -> Segment {
292         Segment {
293             ident,
294             id: None,
295             has_generic_args: false,
296             has_lifetime_args: false,
297             args_span: DUMMY_SP,
298         }
299     }
300
301     fn from_ident_and_id(ident: Ident, id: NodeId) -> Segment {
302         Segment {
303             ident,
304             id: Some(id),
305             has_generic_args: false,
306             has_lifetime_args: false,
307             args_span: DUMMY_SP,
308         }
309     }
310
311     fn names_to_string(segments: &[Segment]) -> String {
312         names_to_string(&segments.iter().map(|seg| seg.ident.name).collect::<Vec<_>>())
313     }
314 }
315
316 impl<'a> From<&'a ast::PathSegment> for Segment {
317     fn from(seg: &'a ast::PathSegment) -> Segment {
318         let has_generic_args = seg.args.is_some();
319         let (args_span, has_lifetime_args) = if let Some(args) = seg.args.as_deref() {
320             match args {
321                 GenericArgs::AngleBracketed(args) => {
322                     let found_lifetimes = args
323                         .args
324                         .iter()
325                         .any(|arg| matches!(arg, AngleBracketedArg::Arg(GenericArg::Lifetime(_))));
326                     (args.span, found_lifetimes)
327                 }
328                 GenericArgs::Parenthesized(args) => (args.span, true),
329             }
330         } else {
331             (DUMMY_SP, false)
332         };
333         Segment {
334             ident: seg.ident,
335             id: Some(seg.id),
336             has_generic_args,
337             has_lifetime_args,
338             args_span,
339         }
340     }
341 }
342
343 /// An intermediate resolution result.
344 ///
345 /// This refers to the thing referred by a name. The difference between `Res` and `Item` is that
346 /// items are visible in their whole block, while `Res`es only from the place they are defined
347 /// forward.
348 #[derive(Debug)]
349 enum LexicalScopeBinding<'a> {
350     Item(&'a NameBinding<'a>),
351     Res(Res),
352 }
353
354 impl<'a> LexicalScopeBinding<'a> {
355     fn res(self) -> Res {
356         match self {
357             LexicalScopeBinding::Item(binding) => binding.res(),
358             LexicalScopeBinding::Res(res) => res,
359         }
360     }
361 }
362
363 #[derive(Copy, Clone, Debug)]
364 enum ModuleOrUniformRoot<'a> {
365     /// Regular module.
366     Module(Module<'a>),
367
368     /// Virtual module that denotes resolution in crate root with fallback to extern prelude.
369     CrateRootAndExternPrelude,
370
371     /// Virtual module that denotes resolution in extern prelude.
372     /// Used for paths starting with `::` on 2018 edition.
373     ExternPrelude,
374
375     /// Virtual module that denotes resolution in current scope.
376     /// Used only for resolving single-segment imports. The reason it exists is that import paths
377     /// are always split into two parts, the first of which should be some kind of module.
378     CurrentScope,
379 }
380
381 impl ModuleOrUniformRoot<'_> {
382     fn same_def(lhs: Self, rhs: Self) -> bool {
383         match (lhs, rhs) {
384             (ModuleOrUniformRoot::Module(lhs), ModuleOrUniformRoot::Module(rhs)) => {
385                 ptr::eq(lhs, rhs)
386             }
387             (
388                 ModuleOrUniformRoot::CrateRootAndExternPrelude,
389                 ModuleOrUniformRoot::CrateRootAndExternPrelude,
390             )
391             | (ModuleOrUniformRoot::ExternPrelude, ModuleOrUniformRoot::ExternPrelude)
392             | (ModuleOrUniformRoot::CurrentScope, ModuleOrUniformRoot::CurrentScope) => true,
393             _ => false,
394         }
395     }
396 }
397
398 #[derive(Clone, Debug)]
399 enum PathResult<'a> {
400     Module(ModuleOrUniformRoot<'a>),
401     NonModule(PartialRes),
402     Indeterminate,
403     Failed {
404         span: Span,
405         label: String,
406         suggestion: Option<Suggestion>,
407         is_error_from_last_segment: bool,
408     },
409 }
410
411 impl<'a> PathResult<'a> {
412     fn failed(
413         span: Span,
414         is_error_from_last_segment: bool,
415         finalize: bool,
416         label_and_suggestion: impl FnOnce() -> (String, Option<Suggestion>),
417     ) -> PathResult<'a> {
418         let (label, suggestion) =
419             if finalize { label_and_suggestion() } else { (String::new(), None) };
420         PathResult::Failed { span, label, suggestion, is_error_from_last_segment }
421     }
422 }
423
424 #[derive(Debug)]
425 enum ModuleKind {
426     /// An anonymous module; e.g., just a block.
427     ///
428     /// ```
429     /// fn main() {
430     ///     fn f() {} // (1)
431     ///     { // This is an anonymous module
432     ///         f(); // This resolves to (2) as we are inside the block.
433     ///         fn f() {} // (2)
434     ///     }
435     ///     f(); // Resolves to (1)
436     /// }
437     /// ```
438     Block,
439     /// Any module with a name.
440     ///
441     /// This could be:
442     ///
443     /// * A normal module â€“ either `mod from_file;` or `mod from_block { }` â€“
444     ///   or the crate root (which is conceptually a top-level module).
445     ///   Note that the crate root's [name][Self::name] will be [`kw::Empty`].
446     /// * A trait or an enum (it implicitly contains associated types, methods and variant
447     ///   constructors).
448     Def(DefKind, DefId, Symbol),
449 }
450
451 impl ModuleKind {
452     /// Get name of the module.
453     pub fn name(&self) -> Option<Symbol> {
454         match self {
455             ModuleKind::Block => None,
456             ModuleKind::Def(.., name) => Some(*name),
457         }
458     }
459 }
460
461 /// A key that identifies a binding in a given `Module`.
462 ///
463 /// Multiple bindings in the same module can have the same key (in a valid
464 /// program) if all but one of them come from glob imports.
465 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
466 struct BindingKey {
467     /// The identifier for the binding, always the `normalize_to_macros_2_0` version of the
468     /// identifier.
469     ident: Ident,
470     ns: Namespace,
471     /// 0 if ident is not `_`, otherwise a value that's unique to the specific
472     /// `_` in the expanded AST that introduced this binding.
473     disambiguator: u32,
474 }
475
476 type Resolutions<'a> = RefCell<FxIndexMap<BindingKey, &'a RefCell<NameResolution<'a>>>>;
477
478 /// One node in the tree of modules.
479 ///
480 /// Note that a "module" in resolve is broader than a `mod` that you declare in Rust code. It may be one of these:
481 ///
482 /// * `mod`
483 /// * crate root (aka, top-level anonymous module)
484 /// * `enum`
485 /// * `trait`
486 /// * curly-braced block with statements
487 ///
488 /// You can use [`ModuleData::kind`] to determine the kind of module this is.
489 pub struct ModuleData<'a> {
490     /// The direct parent module (it may not be a `mod`, however).
491     parent: Option<Module<'a>>,
492     /// What kind of module this is, because this may not be a `mod`.
493     kind: ModuleKind,
494
495     /// Mapping between names and their (possibly in-progress) resolutions in this module.
496     /// Resolutions in modules from other crates are not populated until accessed.
497     lazy_resolutions: Resolutions<'a>,
498     /// True if this is a module from other crate that needs to be populated on access.
499     populate_on_access: Cell<bool>,
500
501     /// Macro invocations that can expand into items in this module.
502     unexpanded_invocations: RefCell<FxHashSet<LocalExpnId>>,
503
504     /// Whether `#[no_implicit_prelude]` is active.
505     no_implicit_prelude: bool,
506
507     glob_importers: RefCell<Vec<&'a Import<'a>>>,
508     globs: RefCell<Vec<&'a Import<'a>>>,
509
510     /// Used to memoize the traits in this module for faster searches through all traits in scope.
511     traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
512
513     /// Span of the module itself. Used for error reporting.
514     span: Span,
515
516     expansion: ExpnId,
517 }
518
519 type Module<'a> = &'a ModuleData<'a>;
520
521 impl<'a> ModuleData<'a> {
522     fn new(
523         parent: Option<Module<'a>>,
524         kind: ModuleKind,
525         expansion: ExpnId,
526         span: Span,
527         no_implicit_prelude: bool,
528     ) -> Self {
529         let is_foreign = match kind {
530             ModuleKind::Def(_, def_id, _) => !def_id.is_local(),
531             ModuleKind::Block => false,
532         };
533         ModuleData {
534             parent,
535             kind,
536             lazy_resolutions: Default::default(),
537             populate_on_access: Cell::new(is_foreign),
538             unexpanded_invocations: Default::default(),
539             no_implicit_prelude,
540             glob_importers: RefCell::new(Vec::new()),
541             globs: RefCell::new(Vec::new()),
542             traits: RefCell::new(None),
543             span,
544             expansion,
545         }
546     }
547
548     fn for_each_child<R, F>(&'a self, resolver: &mut R, mut f: F)
549     where
550         R: AsMut<Resolver<'a>>,
551         F: FnMut(&mut R, Ident, Namespace, &'a NameBinding<'a>),
552     {
553         for (key, name_resolution) in resolver.as_mut().resolutions(self).borrow().iter() {
554             if let Some(binding) = name_resolution.borrow().binding {
555                 f(resolver, key.ident, key.ns, binding);
556             }
557         }
558     }
559
560     /// This modifies `self` in place. The traits will be stored in `self.traits`.
561     fn ensure_traits<R>(&'a self, resolver: &mut R)
562     where
563         R: AsMut<Resolver<'a>>,
564     {
565         let mut traits = self.traits.borrow_mut();
566         if traits.is_none() {
567             let mut collected_traits = Vec::new();
568             self.for_each_child(resolver, |_, name, ns, binding| {
569                 if ns != TypeNS {
570                     return;
571                 }
572                 if let Res::Def(DefKind::Trait | DefKind::TraitAlias, _) = binding.res() {
573                     collected_traits.push((name, binding))
574                 }
575             });
576             *traits = Some(collected_traits.into_boxed_slice());
577         }
578     }
579
580     fn res(&self) -> Option<Res> {
581         match self.kind {
582             ModuleKind::Def(kind, def_id, _) => Some(Res::Def(kind, def_id)),
583             _ => None,
584         }
585     }
586
587     // Public for rustdoc.
588     pub fn def_id(&self) -> DefId {
589         self.opt_def_id().expect("`ModuleData::def_id` is called on a block module")
590     }
591
592     fn opt_def_id(&self) -> Option<DefId> {
593         match self.kind {
594             ModuleKind::Def(_, def_id, _) => Some(def_id),
595             _ => None,
596         }
597     }
598
599     // `self` resolves to the first module ancestor that `is_normal`.
600     fn is_normal(&self) -> bool {
601         matches!(self.kind, ModuleKind::Def(DefKind::Mod, _, _))
602     }
603
604     fn is_trait(&self) -> bool {
605         matches!(self.kind, ModuleKind::Def(DefKind::Trait, _, _))
606     }
607
608     fn nearest_item_scope(&'a self) -> Module<'a> {
609         match self.kind {
610             ModuleKind::Def(DefKind::Enum | DefKind::Trait, ..) => {
611                 self.parent.expect("enum or trait module without a parent")
612             }
613             _ => self,
614         }
615     }
616
617     /// The [`DefId`] of the nearest `mod` item ancestor (which may be this module).
618     /// This may be the crate root.
619     fn nearest_parent_mod(&self) -> DefId {
620         match self.kind {
621             ModuleKind::Def(DefKind::Mod, def_id, _) => def_id,
622             _ => self.parent.expect("non-root module without parent").nearest_parent_mod(),
623         }
624     }
625
626     fn is_ancestor_of(&self, mut other: &Self) -> bool {
627         while !ptr::eq(self, other) {
628             if let Some(parent) = other.parent {
629                 other = parent;
630             } else {
631                 return false;
632             }
633         }
634         true
635     }
636 }
637
638 impl<'a> fmt::Debug for ModuleData<'a> {
639     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
640         write!(f, "{:?}", self.res())
641     }
642 }
643
644 /// Records a possibly-private value, type, or module definition.
645 #[derive(Clone, Debug)]
646 pub struct NameBinding<'a> {
647     kind: NameBindingKind<'a>,
648     ambiguity: Option<(&'a NameBinding<'a>, AmbiguityKind)>,
649     expansion: LocalExpnId,
650     span: Span,
651     vis: ty::Visibility,
652 }
653
654 pub trait ToNameBinding<'a> {
655     fn to_name_binding(self, arenas: &'a ResolverArenas<'a>) -> &'a NameBinding<'a>;
656 }
657
658 impl<'a> ToNameBinding<'a> for &'a NameBinding<'a> {
659     fn to_name_binding(self, _: &'a ResolverArenas<'a>) -> &'a NameBinding<'a> {
660         self
661     }
662 }
663
664 #[derive(Clone, Debug)]
665 enum NameBindingKind<'a> {
666     Res(Res, /* is_macro_export */ bool),
667     Module(Module<'a>),
668     Import { binding: &'a NameBinding<'a>, import: &'a Import<'a>, used: Cell<bool> },
669 }
670
671 impl<'a> NameBindingKind<'a> {
672     /// Is this a name binding of an import?
673     fn is_import(&self) -> bool {
674         matches!(*self, NameBindingKind::Import { .. })
675     }
676 }
677
678 struct PrivacyError<'a> {
679     ident: Ident,
680     binding: &'a NameBinding<'a>,
681     dedup_span: Span,
682 }
683
684 struct UseError<'a> {
685     err: DiagnosticBuilder<'a, ErrorGuaranteed>,
686     /// Candidates which user could `use` to access the missing type.
687     candidates: Vec<ImportSuggestion>,
688     /// The `DefId` of the module to place the use-statements in.
689     def_id: DefId,
690     /// Whether the diagnostic should say "instead" (as in `consider importing ... instead`).
691     instead: bool,
692     /// Extra free-form suggestion.
693     suggestion: Option<(Span, &'static str, String, Applicability)>,
694     /// Path `Segment`s at the place of use that failed. Used for accurate suggestion after telling
695     /// the user to import the item directly.
696     path: Vec<Segment>,
697 }
698
699 #[derive(Clone, Copy, PartialEq, Debug)]
700 enum AmbiguityKind {
701     Import,
702     BuiltinAttr,
703     DeriveHelper,
704     MacroRulesVsModularized,
705     GlobVsOuter,
706     GlobVsGlob,
707     GlobVsExpanded,
708     MoreExpandedVsOuter,
709 }
710
711 impl AmbiguityKind {
712     fn descr(self) -> &'static str {
713         match self {
714             AmbiguityKind::Import => "multiple potential import sources",
715             AmbiguityKind::BuiltinAttr => "a name conflict with a builtin attribute",
716             AmbiguityKind::DeriveHelper => "a name conflict with a derive helper attribute",
717             AmbiguityKind::MacroRulesVsModularized => {
718                 "a conflict between a `macro_rules` name and a non-`macro_rules` name from another module"
719             }
720             AmbiguityKind::GlobVsOuter => {
721                 "a conflict between a name from a glob import and an outer scope during import or macro resolution"
722             }
723             AmbiguityKind::GlobVsGlob => "multiple glob imports of a name in the same module",
724             AmbiguityKind::GlobVsExpanded => {
725                 "a conflict between a name from a glob import and a macro-expanded name in the same module during import or macro resolution"
726             }
727             AmbiguityKind::MoreExpandedVsOuter => {
728                 "a conflict between a macro-expanded name and a less macro-expanded name from outer scope during import or macro resolution"
729             }
730         }
731     }
732 }
733
734 /// Miscellaneous bits of metadata for better ambiguity error reporting.
735 #[derive(Clone, Copy, PartialEq)]
736 enum AmbiguityErrorMisc {
737     SuggestCrate,
738     SuggestSelf,
739     FromPrelude,
740     None,
741 }
742
743 struct AmbiguityError<'a> {
744     kind: AmbiguityKind,
745     ident: Ident,
746     b1: &'a NameBinding<'a>,
747     b2: &'a NameBinding<'a>,
748     misc1: AmbiguityErrorMisc,
749     misc2: AmbiguityErrorMisc,
750 }
751
752 impl<'a> NameBinding<'a> {
753     fn module(&self) -> Option<Module<'a>> {
754         match self.kind {
755             NameBindingKind::Module(module) => Some(module),
756             NameBindingKind::Import { binding, .. } => binding.module(),
757             _ => None,
758         }
759     }
760
761     fn res(&self) -> Res {
762         match self.kind {
763             NameBindingKind::Res(res, _) => res,
764             NameBindingKind::Module(module) => module.res().unwrap(),
765             NameBindingKind::Import { binding, .. } => binding.res(),
766         }
767     }
768
769     fn is_ambiguity(&self) -> bool {
770         self.ambiguity.is_some()
771             || match self.kind {
772                 NameBindingKind::Import { binding, .. } => binding.is_ambiguity(),
773                 _ => false,
774             }
775     }
776
777     fn is_possibly_imported_variant(&self) -> bool {
778         match self.kind {
779             NameBindingKind::Import { binding, .. } => binding.is_possibly_imported_variant(),
780             NameBindingKind::Res(
781                 Res::Def(DefKind::Variant | DefKind::Ctor(CtorOf::Variant, ..), _),
782                 _,
783             ) => true,
784             NameBindingKind::Res(..) | NameBindingKind::Module(..) => false,
785         }
786     }
787
788     fn is_extern_crate(&self) -> bool {
789         match self.kind {
790             NameBindingKind::Import {
791                 import: &Import { kind: ImportKind::ExternCrate { .. }, .. },
792                 ..
793             } => true,
794             NameBindingKind::Module(&ModuleData {
795                 kind: ModuleKind::Def(DefKind::Mod, def_id, _),
796                 ..
797             }) => def_id.is_crate_root(),
798             _ => false,
799         }
800     }
801
802     fn is_import(&self) -> bool {
803         matches!(self.kind, NameBindingKind::Import { .. })
804     }
805
806     fn is_glob_import(&self) -> bool {
807         match self.kind {
808             NameBindingKind::Import { import, .. } => import.is_glob(),
809             _ => false,
810         }
811     }
812
813     fn is_importable(&self) -> bool {
814         !matches!(
815             self.res(),
816             Res::Def(DefKind::AssocConst | DefKind::AssocFn | DefKind::AssocTy, _)
817         )
818     }
819
820     fn macro_kind(&self) -> Option<MacroKind> {
821         self.res().macro_kind()
822     }
823
824     // Suppose that we resolved macro invocation with `invoc_parent_expansion` to binding `binding`
825     // at some expansion round `max(invoc, binding)` when they both emerged from macros.
826     // Then this function returns `true` if `self` may emerge from a macro *after* that
827     // in some later round and screw up our previously found resolution.
828     // See more detailed explanation in
829     // https://github.com/rust-lang/rust/pull/53778#issuecomment-419224049
830     fn may_appear_after(
831         &self,
832         invoc_parent_expansion: LocalExpnId,
833         binding: &NameBinding<'_>,
834     ) -> bool {
835         // self > max(invoc, binding) => !(self <= invoc || self <= binding)
836         // Expansions are partially ordered, so "may appear after" is an inversion of
837         // "certainly appears before or simultaneously" and includes unordered cases.
838         let self_parent_expansion = self.expansion;
839         let other_parent_expansion = binding.expansion;
840         let certainly_before_other_or_simultaneously =
841             other_parent_expansion.is_descendant_of(self_parent_expansion);
842         let certainly_before_invoc_or_simultaneously =
843             invoc_parent_expansion.is_descendant_of(self_parent_expansion);
844         !(certainly_before_other_or_simultaneously || certainly_before_invoc_or_simultaneously)
845     }
846 }
847
848 #[derive(Debug, Default, Clone)]
849 pub struct ExternPreludeEntry<'a> {
850     extern_crate_item: Option<&'a NameBinding<'a>>,
851     pub introduced_by_item: bool,
852 }
853
854 /// Used for better errors for E0773
855 enum BuiltinMacroState {
856     NotYetSeen(SyntaxExtensionKind),
857     AlreadySeen(Span),
858 }
859
860 struct DeriveData {
861     resolutions: DeriveResolutions,
862     helper_attrs: Vec<(usize, Ident)>,
863     has_derive_copy: bool,
864 }
865
866 #[derive(Clone)]
867 struct MacroData {
868     ext: Lrc<SyntaxExtension>,
869     macro_rules: bool,
870 }
871
872 /// The main resolver class.
873 ///
874 /// This is the visitor that walks the whole crate.
875 pub struct Resolver<'a> {
876     session: &'a Session,
877
878     definitions: Definitions,
879     /// Item with a given `LocalDefId` was defined during macro expansion with ID `ExpnId`.
880     expn_that_defined: FxHashMap<LocalDefId, ExpnId>,
881     /// Reference span for definitions.
882     source_span: IndexVec<LocalDefId, Span>,
883
884     graph_root: Module<'a>,
885
886     prelude: Option<Module<'a>>,
887     extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'a>>,
888
889     /// N.B., this is used only for better diagnostics, not name resolution itself.
890     has_self: FxHashSet<DefId>,
891
892     /// Names of fields of an item `DefId` accessible with dot syntax.
893     /// Used for hints during error reporting.
894     field_names: FxHashMap<DefId, Vec<Spanned<Symbol>>>,
895
896     /// All imports known to succeed or fail.
897     determined_imports: Vec<&'a Import<'a>>,
898
899     /// All non-determined imports.
900     indeterminate_imports: Vec<&'a Import<'a>>,
901
902     // Spans for local variables found during pattern resolution.
903     // Used for suggestions during error reporting.
904     pat_span_map: NodeMap<Span>,
905
906     /// Resolutions for nodes that have a single resolution.
907     partial_res_map: NodeMap<PartialRes>,
908     /// Resolutions for import nodes, which have multiple resolutions in different namespaces.
909     import_res_map: NodeMap<PerNS<Option<Res>>>,
910     /// Resolutions for labels (node IDs of their corresponding blocks or loops).
911     label_res_map: NodeMap<NodeId>,
912     /// Resolutions for lifetimes.
913     lifetimes_res_map: NodeMap<LifetimeRes>,
914     /// Mapping from generics `def_id`s to TAIT generics `def_id`s.
915     /// For each captured lifetime (e.g., 'a), we create a new lifetime parameter that is a generic
916     /// defined on the TAIT, so we have type Foo<'a1> = ... and we establish a mapping in this
917     /// field from the original parameter 'a to the new parameter 'a1.
918     generics_def_id_map: Vec<FxHashMap<LocalDefId, LocalDefId>>,
919     /// Lifetime parameters that lowering will have to introduce.
920     extra_lifetime_params_map: NodeMap<Vec<(Ident, NodeId, LifetimeRes)>>,
921
922     /// `CrateNum` resolutions of `extern crate` items.
923     extern_crate_map: FxHashMap<LocalDefId, CrateNum>,
924     reexport_map: FxHashMap<LocalDefId, Vec<ModChild>>,
925     trait_map: NodeMap<Vec<TraitCandidate>>,
926
927     /// A map from nodes to anonymous modules.
928     /// Anonymous modules are pseudo-modules that are implicitly created around items
929     /// contained within blocks.
930     ///
931     /// For example, if we have this:
932     ///
933     ///  fn f() {
934     ///      fn g() {
935     ///          ...
936     ///      }
937     ///  }
938     ///
939     /// There will be an anonymous module created around `g` with the ID of the
940     /// entry block for `f`.
941     block_map: NodeMap<Module<'a>>,
942     /// A fake module that contains no definition and no prelude. Used so that
943     /// some AST passes can generate identifiers that only resolve to local or
944     /// language items.
945     empty_module: Module<'a>,
946     module_map: FxHashMap<DefId, Module<'a>>,
947     binding_parent_modules: FxHashMap<Interned<'a, NameBinding<'a>>, Module<'a>>,
948     underscore_disambiguator: u32,
949
950     /// Maps glob imports to the names of items actually imported.
951     glob_map: FxHashMap<LocalDefId, FxHashSet<Symbol>>,
952     /// Visibilities in "lowered" form, for all entities that have them.
953     visibilities: FxHashMap<LocalDefId, ty::Visibility>,
954     has_pub_restricted: bool,
955     used_imports: FxHashSet<NodeId>,
956     maybe_unused_trait_imports: FxIndexSet<LocalDefId>,
957     maybe_unused_extern_crates: Vec<(LocalDefId, Span)>,
958
959     /// Privacy errors are delayed until the end in order to deduplicate them.
960     privacy_errors: Vec<PrivacyError<'a>>,
961     /// Ambiguity errors are delayed for deduplication.
962     ambiguity_errors: Vec<AmbiguityError<'a>>,
963     /// `use` injections are delayed for better placement and deduplication.
964     use_injections: Vec<UseError<'a>>,
965     /// Crate-local macro expanded `macro_export` referred to by a module-relative path.
966     macro_expanded_macro_export_errors: BTreeSet<(Span, Span)>,
967
968     arenas: &'a ResolverArenas<'a>,
969     dummy_binding: &'a NameBinding<'a>,
970
971     crate_loader: CrateLoader<'a>,
972     macro_names: FxHashSet<Ident>,
973     builtin_macros: FxHashMap<Symbol, BuiltinMacroState>,
974     /// A small map keeping true kinds of built-in macros that appear to be fn-like on
975     /// the surface (`macro` items in libcore), but are actually attributes or derives.
976     builtin_macro_kinds: FxHashMap<LocalDefId, MacroKind>,
977     registered_tools: RegisteredTools,
978     macro_use_prelude: FxHashMap<Symbol, &'a NameBinding<'a>>,
979     macro_map: FxHashMap<DefId, MacroData>,
980     dummy_ext_bang: Lrc<SyntaxExtension>,
981     dummy_ext_derive: Lrc<SyntaxExtension>,
982     non_macro_attr: Lrc<SyntaxExtension>,
983     local_macro_def_scopes: FxHashMap<LocalDefId, Module<'a>>,
984     ast_transform_scopes: FxHashMap<LocalExpnId, Module<'a>>,
985     unused_macros: FxHashMap<LocalDefId, (NodeId, Ident)>,
986     unused_macro_rules: FxHashMap<(LocalDefId, usize), (Ident, Span)>,
987     proc_macro_stubs: FxHashSet<LocalDefId>,
988     /// Traces collected during macro resolution and validated when it's complete.
989     single_segment_macro_resolutions:
990         Vec<(Ident, MacroKind, ParentScope<'a>, Option<&'a NameBinding<'a>>)>,
991     multi_segment_macro_resolutions:
992         Vec<(Vec<Segment>, Span, MacroKind, ParentScope<'a>, Option<Res>)>,
993     builtin_attrs: Vec<(Ident, ParentScope<'a>)>,
994     /// `derive(Copy)` marks items they are applied to so they are treated specially later.
995     /// Derive macros cannot modify the item themselves and have to store the markers in the global
996     /// context, so they attach the markers to derive container IDs using this resolver table.
997     containers_deriving_copy: FxHashSet<LocalExpnId>,
998     /// Parent scopes in which the macros were invoked.
999     /// FIXME: `derives` are missing in these parent scopes and need to be taken from elsewhere.
1000     invocation_parent_scopes: FxHashMap<LocalExpnId, ParentScope<'a>>,
1001     /// `macro_rules` scopes *produced* by expanding the macro invocations,
1002     /// include all the `macro_rules` items and other invocations generated by them.
1003     output_macro_rules_scopes: FxHashMap<LocalExpnId, MacroRulesScopeRef<'a>>,
1004     /// `macro_rules` scopes produced by `macro_rules` item definitions.
1005     macro_rules_scopes: FxHashMap<LocalDefId, MacroRulesScopeRef<'a>>,
1006     /// Helper attributes that are in scope for the given expansion.
1007     helper_attrs: FxHashMap<LocalExpnId, Vec<Ident>>,
1008     /// Ready or in-progress results of resolving paths inside the `#[derive(...)]` attribute
1009     /// with the given `ExpnId`.
1010     derive_data: FxHashMap<LocalExpnId, DeriveData>,
1011
1012     /// Avoid duplicated errors for "name already defined".
1013     name_already_seen: FxHashMap<Symbol, Span>,
1014
1015     potentially_unused_imports: Vec<&'a Import<'a>>,
1016
1017     /// Table for mapping struct IDs into struct constructor IDs,
1018     /// it's not used during normal resolution, only for better error reporting.
1019     /// Also includes of list of each fields visibility
1020     struct_constructors: DefIdMap<(Res, ty::Visibility, Vec<ty::Visibility>)>,
1021
1022     /// Features enabled for this crate.
1023     active_features: FxHashSet<Symbol>,
1024
1025     lint_buffer: LintBuffer,
1026
1027     next_node_id: NodeId,
1028
1029     node_id_to_def_id: FxHashMap<ast::NodeId, LocalDefId>,
1030     def_id_to_node_id: IndexVec<LocalDefId, ast::NodeId>,
1031
1032     /// Indices of unnamed struct or variant fields with unresolved attributes.
1033     placeholder_field_indices: FxHashMap<NodeId, usize>,
1034     /// When collecting definitions from an AST fragment produced by a macro invocation `ExpnId`
1035     /// we know what parent node that fragment should be attached to thanks to this table,
1036     /// and how the `impl Trait` fragments were introduced.
1037     invocation_parents: FxHashMap<LocalExpnId, (LocalDefId, ImplTraitContext)>,
1038
1039     /// Some way to know that we are in a *trait* impl in `visit_assoc_item`.
1040     /// FIXME: Replace with a more general AST map (together with some other fields).
1041     trait_impl_items: FxHashSet<LocalDefId>,
1042
1043     legacy_const_generic_args: FxHashMap<DefId, Option<Vec<usize>>>,
1044     /// Amount of lifetime parameters for each item in the crate.
1045     item_generics_num_lifetimes: FxHashMap<LocalDefId, usize>,
1046
1047     main_def: Option<MainDefinition>,
1048     trait_impls: FxIndexMap<DefId, Vec<LocalDefId>>,
1049     /// A list of proc macro LocalDefIds, written out in the order in which
1050     /// they are declared in the static array generated by proc_macro_harness.
1051     proc_macros: Vec<NodeId>,
1052     confused_type_with_std_module: FxHashMap<Span, Span>,
1053
1054     access_levels: AccessLevels,
1055 }
1056
1057 /// Nothing really interesting here; it just provides memory for the rest of the crate.
1058 #[derive(Default)]
1059 pub struct ResolverArenas<'a> {
1060     modules: TypedArena<ModuleData<'a>>,
1061     local_modules: RefCell<Vec<Module<'a>>>,
1062     imports: TypedArena<Import<'a>>,
1063     name_resolutions: TypedArena<RefCell<NameResolution<'a>>>,
1064     ast_paths: TypedArena<ast::Path>,
1065     dropless: DroplessArena,
1066 }
1067
1068 impl<'a> ResolverArenas<'a> {
1069     fn new_module(
1070         &'a self,
1071         parent: Option<Module<'a>>,
1072         kind: ModuleKind,
1073         expn_id: ExpnId,
1074         span: Span,
1075         no_implicit_prelude: bool,
1076         module_map: &mut FxHashMap<DefId, Module<'a>>,
1077     ) -> Module<'a> {
1078         let module =
1079             self.modules.alloc(ModuleData::new(parent, kind, expn_id, span, no_implicit_prelude));
1080         let def_id = module.opt_def_id();
1081         if def_id.map_or(true, |def_id| def_id.is_local()) {
1082             self.local_modules.borrow_mut().push(module);
1083         }
1084         if let Some(def_id) = def_id {
1085             module_map.insert(def_id, module);
1086         }
1087         module
1088     }
1089     fn local_modules(&'a self) -> std::cell::Ref<'a, Vec<Module<'a>>> {
1090         self.local_modules.borrow()
1091     }
1092     fn alloc_name_binding(&'a self, name_binding: NameBinding<'a>) -> &'a NameBinding<'a> {
1093         self.dropless.alloc(name_binding)
1094     }
1095     fn alloc_import(&'a self, import: Import<'a>) -> &'a Import<'_> {
1096         self.imports.alloc(import)
1097     }
1098     fn alloc_name_resolution(&'a self) -> &'a RefCell<NameResolution<'a>> {
1099         self.name_resolutions.alloc(Default::default())
1100     }
1101     fn alloc_macro_rules_scope(&'a self, scope: MacroRulesScope<'a>) -> MacroRulesScopeRef<'a> {
1102         Interned::new_unchecked(self.dropless.alloc(Cell::new(scope)))
1103     }
1104     fn alloc_macro_rules_binding(
1105         &'a self,
1106         binding: MacroRulesBinding<'a>,
1107     ) -> &'a MacroRulesBinding<'a> {
1108         self.dropless.alloc(binding)
1109     }
1110     fn alloc_ast_paths(&'a self, paths: &[ast::Path]) -> &'a [ast::Path] {
1111         self.ast_paths.alloc_from_iter(paths.iter().cloned())
1112     }
1113     fn alloc_pattern_spans(&'a self, spans: impl Iterator<Item = Span>) -> &'a [Span] {
1114         self.dropless.alloc_from_iter(spans)
1115     }
1116 }
1117
1118 impl<'a> AsMut<Resolver<'a>> for Resolver<'a> {
1119     fn as_mut(&mut self) -> &mut Resolver<'a> {
1120         self
1121     }
1122 }
1123
1124 impl<'a, 'b> DefIdTree for &'a Resolver<'b> {
1125     #[inline]
1126     fn opt_parent(self, id: DefId) -> Option<DefId> {
1127         match id.as_local() {
1128             Some(id) => self.definitions.def_key(id).parent,
1129             None => self.cstore().def_key(id).parent,
1130         }
1131         .map(|index| DefId { index, ..id })
1132     }
1133 }
1134
1135 impl Resolver<'_> {
1136     fn opt_local_def_id(&self, node: NodeId) -> Option<LocalDefId> {
1137         self.node_id_to_def_id.get(&node).copied()
1138     }
1139
1140     pub fn local_def_id(&self, node: NodeId) -> LocalDefId {
1141         self.opt_local_def_id(node).unwrap_or_else(|| panic!("no entry for node id: `{:?}`", node))
1142     }
1143
1144     /// Adds a definition with a parent definition.
1145     fn create_def(
1146         &mut self,
1147         parent: LocalDefId,
1148         node_id: ast::NodeId,
1149         data: DefPathData,
1150         expn_id: ExpnId,
1151         span: Span,
1152     ) -> LocalDefId {
1153         assert!(
1154             !self.node_id_to_def_id.contains_key(&node_id),
1155             "adding a def'n for node-id {:?} and data {:?} but a previous def'n exists: {:?}",
1156             node_id,
1157             data,
1158             self.definitions.def_key(self.node_id_to_def_id[&node_id]),
1159         );
1160
1161         let def_id = self.definitions.create_def(parent, data);
1162
1163         // Create the definition.
1164         if expn_id != ExpnId::root() {
1165             self.expn_that_defined.insert(def_id, expn_id);
1166         }
1167
1168         // A relative span's parent must be an absolute span.
1169         debug_assert_eq!(span.data_untracked().parent, None);
1170         let _id = self.source_span.push(span);
1171         debug_assert_eq!(_id, def_id);
1172
1173         // Some things for which we allocate `LocalDefId`s don't correspond to
1174         // anything in the AST, so they don't have a `NodeId`. For these cases
1175         // we don't need a mapping from `NodeId` to `LocalDefId`.
1176         if node_id != ast::DUMMY_NODE_ID {
1177             debug!("create_def: def_id_to_node_id[{:?}] <-> {:?}", def_id, node_id);
1178             self.node_id_to_def_id.insert(node_id, def_id);
1179         }
1180         assert_eq!(self.def_id_to_node_id.push(node_id), def_id);
1181
1182         def_id
1183     }
1184
1185     fn item_generics_num_lifetimes(&self, def_id: DefId) -> usize {
1186         if let Some(def_id) = def_id.as_local() {
1187             self.item_generics_num_lifetimes[&def_id]
1188         } else {
1189             self.cstore().item_generics_num_lifetimes(def_id, self.session)
1190         }
1191     }
1192 }
1193
1194 impl<'a> Resolver<'a> {
1195     pub fn new(
1196         session: &'a Session,
1197         krate: &Crate,
1198         crate_name: &str,
1199         metadata_loader: Box<MetadataLoaderDyn>,
1200         arenas: &'a ResolverArenas<'a>,
1201     ) -> Resolver<'a> {
1202         let root_def_id = CRATE_DEF_ID.to_def_id();
1203         let mut module_map = FxHashMap::default();
1204         let graph_root = arenas.new_module(
1205             None,
1206             ModuleKind::Def(DefKind::Mod, root_def_id, kw::Empty),
1207             ExpnId::root(),
1208             krate.spans.inner_span,
1209             session.contains_name(&krate.attrs, sym::no_implicit_prelude),
1210             &mut module_map,
1211         );
1212         let empty_module = arenas.new_module(
1213             None,
1214             ModuleKind::Def(DefKind::Mod, root_def_id, kw::Empty),
1215             ExpnId::root(),
1216             DUMMY_SP,
1217             true,
1218             &mut FxHashMap::default(),
1219         );
1220
1221         let definitions = Definitions::new(session.local_stable_crate_id());
1222
1223         let mut visibilities = FxHashMap::default();
1224         visibilities.insert(CRATE_DEF_ID, ty::Visibility::Public);
1225
1226         let mut def_id_to_node_id = IndexVec::default();
1227         assert_eq!(def_id_to_node_id.push(CRATE_NODE_ID), CRATE_DEF_ID);
1228         let mut node_id_to_def_id = FxHashMap::default();
1229         node_id_to_def_id.insert(CRATE_NODE_ID, CRATE_DEF_ID);
1230
1231         let mut invocation_parents = FxHashMap::default();
1232         invocation_parents.insert(LocalExpnId::ROOT, (CRATE_DEF_ID, ImplTraitContext::Existential));
1233
1234         let mut source_span = IndexVec::default();
1235         let _id = source_span.push(krate.spans.inner_span);
1236         debug_assert_eq!(_id, CRATE_DEF_ID);
1237
1238         let mut extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'_>> = session
1239             .opts
1240             .externs
1241             .iter()
1242             .filter(|(_, entry)| entry.add_prelude)
1243             .map(|(name, _)| (Ident::from_str(name), Default::default()))
1244             .collect();
1245
1246         if !session.contains_name(&krate.attrs, sym::no_core) {
1247             extern_prelude.insert(Ident::with_dummy_span(sym::core), Default::default());
1248             if !session.contains_name(&krate.attrs, sym::no_std) {
1249                 extern_prelude.insert(Ident::with_dummy_span(sym::std), Default::default());
1250             }
1251         }
1252
1253         let registered_tools = macros::registered_tools(session, &krate.attrs);
1254
1255         let features = session.features_untracked();
1256
1257         let mut resolver = Resolver {
1258             session,
1259
1260             definitions,
1261             expn_that_defined: Default::default(),
1262             source_span,
1263
1264             // The outermost module has def ID 0; this is not reflected in the
1265             // AST.
1266             graph_root,
1267             prelude: None,
1268             extern_prelude,
1269
1270             has_self: FxHashSet::default(),
1271             field_names: FxHashMap::default(),
1272
1273             determined_imports: Vec::new(),
1274             indeterminate_imports: Vec::new(),
1275
1276             pat_span_map: Default::default(),
1277             partial_res_map: Default::default(),
1278             import_res_map: Default::default(),
1279             label_res_map: Default::default(),
1280             lifetimes_res_map: Default::default(),
1281             generics_def_id_map: Vec::new(),
1282             extra_lifetime_params_map: Default::default(),
1283             extern_crate_map: Default::default(),
1284             reexport_map: FxHashMap::default(),
1285             trait_map: NodeMap::default(),
1286             underscore_disambiguator: 0,
1287             empty_module,
1288             module_map,
1289             block_map: Default::default(),
1290             binding_parent_modules: FxHashMap::default(),
1291             ast_transform_scopes: FxHashMap::default(),
1292
1293             glob_map: Default::default(),
1294             visibilities,
1295             has_pub_restricted: false,
1296             used_imports: FxHashSet::default(),
1297             maybe_unused_trait_imports: Default::default(),
1298             maybe_unused_extern_crates: Vec::new(),
1299
1300             privacy_errors: Vec::new(),
1301             ambiguity_errors: Vec::new(),
1302             use_injections: Vec::new(),
1303             macro_expanded_macro_export_errors: BTreeSet::new(),
1304
1305             arenas,
1306             dummy_binding: arenas.alloc_name_binding(NameBinding {
1307                 kind: NameBindingKind::Res(Res::Err, false),
1308                 ambiguity: None,
1309                 expansion: LocalExpnId::ROOT,
1310                 span: DUMMY_SP,
1311                 vis: ty::Visibility::Public,
1312             }),
1313
1314             crate_loader: CrateLoader::new(session, metadata_loader, crate_name),
1315             macro_names: FxHashSet::default(),
1316             builtin_macros: Default::default(),
1317             builtin_macro_kinds: Default::default(),
1318             registered_tools,
1319             macro_use_prelude: FxHashMap::default(),
1320             macro_map: FxHashMap::default(),
1321             dummy_ext_bang: Lrc::new(SyntaxExtension::dummy_bang(session.edition())),
1322             dummy_ext_derive: Lrc::new(SyntaxExtension::dummy_derive(session.edition())),
1323             non_macro_attr: Lrc::new(SyntaxExtension::non_macro_attr(session.edition())),
1324             invocation_parent_scopes: Default::default(),
1325             output_macro_rules_scopes: Default::default(),
1326             macro_rules_scopes: Default::default(),
1327             helper_attrs: Default::default(),
1328             derive_data: Default::default(),
1329             local_macro_def_scopes: FxHashMap::default(),
1330             name_already_seen: FxHashMap::default(),
1331             potentially_unused_imports: Vec::new(),
1332             struct_constructors: Default::default(),
1333             unused_macros: Default::default(),
1334             unused_macro_rules: Default::default(),
1335             proc_macro_stubs: Default::default(),
1336             single_segment_macro_resolutions: Default::default(),
1337             multi_segment_macro_resolutions: Default::default(),
1338             builtin_attrs: Default::default(),
1339             containers_deriving_copy: Default::default(),
1340             active_features: features
1341                 .declared_lib_features
1342                 .iter()
1343                 .map(|(feat, ..)| *feat)
1344                 .chain(features.declared_lang_features.iter().map(|(feat, ..)| *feat))
1345                 .collect(),
1346             lint_buffer: LintBuffer::default(),
1347             next_node_id: CRATE_NODE_ID,
1348             node_id_to_def_id,
1349             def_id_to_node_id,
1350             placeholder_field_indices: Default::default(),
1351             invocation_parents,
1352             trait_impl_items: Default::default(),
1353             legacy_const_generic_args: Default::default(),
1354             item_generics_num_lifetimes: Default::default(),
1355             main_def: Default::default(),
1356             trait_impls: Default::default(),
1357             proc_macros: Default::default(),
1358             confused_type_with_std_module: Default::default(),
1359             access_levels: Default::default(),
1360         };
1361
1362         let root_parent_scope = ParentScope::module(graph_root, &resolver);
1363         resolver.invocation_parent_scopes.insert(LocalExpnId::ROOT, root_parent_scope);
1364
1365         resolver
1366     }
1367
1368     fn new_module(
1369         &mut self,
1370         parent: Option<Module<'a>>,
1371         kind: ModuleKind,
1372         expn_id: ExpnId,
1373         span: Span,
1374         no_implicit_prelude: bool,
1375     ) -> Module<'a> {
1376         let module_map = &mut self.module_map;
1377         self.arenas.new_module(parent, kind, expn_id, span, no_implicit_prelude, module_map)
1378     }
1379
1380     pub fn next_node_id(&mut self) -> NodeId {
1381         let start = self.next_node_id;
1382         let next = start.as_u32().checked_add(1).expect("input too large; ran out of NodeIds");
1383         self.next_node_id = ast::NodeId::from_u32(next);
1384         start
1385     }
1386
1387     pub fn next_node_ids(&mut self, count: usize) -> std::ops::Range<NodeId> {
1388         let start = self.next_node_id;
1389         let end = start.as_usize().checked_add(count).expect("input too large; ran out of NodeIds");
1390         self.next_node_id = ast::NodeId::from_usize(end);
1391         start..self.next_node_id
1392     }
1393
1394     pub fn lint_buffer(&mut self) -> &mut LintBuffer {
1395         &mut self.lint_buffer
1396     }
1397
1398     pub fn arenas() -> ResolverArenas<'a> {
1399         Default::default()
1400     }
1401
1402     pub fn into_outputs(
1403         self,
1404     ) -> (Definitions, Box<CrateStoreDyn>, ResolverOutputs, ty::ResolverAstLowering) {
1405         let proc_macros = self.proc_macros.iter().map(|id| self.local_def_id(*id)).collect();
1406         let definitions = self.definitions;
1407         let cstore = Box::new(self.crate_loader.into_cstore());
1408         let source_span = self.source_span;
1409         let expn_that_defined = self.expn_that_defined;
1410         let visibilities = self.visibilities;
1411         let has_pub_restricted = self.has_pub_restricted;
1412         let extern_crate_map = self.extern_crate_map;
1413         let reexport_map = self.reexport_map;
1414         let maybe_unused_trait_imports = self.maybe_unused_trait_imports;
1415         let maybe_unused_extern_crates = self.maybe_unused_extern_crates;
1416         let glob_map = self.glob_map;
1417         let main_def = self.main_def;
1418         let confused_type_with_std_module = self.confused_type_with_std_module;
1419         let access_levels = self.access_levels;
1420         let resolutions = ResolverOutputs {
1421             source_span,
1422             expn_that_defined,
1423             visibilities,
1424             has_pub_restricted,
1425             access_levels,
1426             extern_crate_map,
1427             reexport_map,
1428             glob_map,
1429             maybe_unused_trait_imports,
1430             maybe_unused_extern_crates,
1431             extern_prelude: self
1432                 .extern_prelude
1433                 .iter()
1434                 .map(|(ident, entry)| (ident.name, entry.introduced_by_item))
1435                 .collect(),
1436             main_def,
1437             trait_impls: self.trait_impls,
1438             proc_macros,
1439             confused_type_with_std_module,
1440             registered_tools: self.registered_tools,
1441         };
1442         let resolutions_lowering = ty::ResolverAstLowering {
1443             legacy_const_generic_args: self.legacy_const_generic_args,
1444             partial_res_map: self.partial_res_map,
1445             import_res_map: self.import_res_map,
1446             label_res_map: self.label_res_map,
1447             lifetimes_res_map: self.lifetimes_res_map,
1448             generics_def_id_map: self.generics_def_id_map,
1449             extra_lifetime_params_map: self.extra_lifetime_params_map,
1450             next_node_id: self.next_node_id,
1451             node_id_to_def_id: self.node_id_to_def_id,
1452             def_id_to_node_id: self.def_id_to_node_id,
1453             trait_map: self.trait_map,
1454             builtin_macro_kinds: self.builtin_macro_kinds,
1455         };
1456         (definitions, cstore, resolutions, resolutions_lowering)
1457     }
1458
1459     pub fn clone_outputs(
1460         &self,
1461     ) -> (Definitions, Box<CrateStoreDyn>, ResolverOutputs, ty::ResolverAstLowering) {
1462         let proc_macros = self.proc_macros.iter().map(|id| self.local_def_id(*id)).collect();
1463         let definitions = self.definitions.clone();
1464         let cstore = Box::new(self.cstore().clone());
1465         let resolutions = ResolverOutputs {
1466             source_span: self.source_span.clone(),
1467             expn_that_defined: self.expn_that_defined.clone(),
1468             visibilities: self.visibilities.clone(),
1469             has_pub_restricted: self.has_pub_restricted,
1470             extern_crate_map: self.extern_crate_map.clone(),
1471             reexport_map: self.reexport_map.clone(),
1472             glob_map: self.glob_map.clone(),
1473             maybe_unused_trait_imports: self.maybe_unused_trait_imports.clone(),
1474             maybe_unused_extern_crates: self.maybe_unused_extern_crates.clone(),
1475             extern_prelude: self
1476                 .extern_prelude
1477                 .iter()
1478                 .map(|(ident, entry)| (ident.name, entry.introduced_by_item))
1479                 .collect(),
1480             main_def: self.main_def,
1481             trait_impls: self.trait_impls.clone(),
1482             proc_macros,
1483             confused_type_with_std_module: self.confused_type_with_std_module.clone(),
1484             registered_tools: self.registered_tools.clone(),
1485             access_levels: self.access_levels.clone(),
1486         };
1487         let resolutions_lowering = ty::ResolverAstLowering {
1488             legacy_const_generic_args: self.legacy_const_generic_args.clone(),
1489             partial_res_map: self.partial_res_map.clone(),
1490             import_res_map: self.import_res_map.clone(),
1491             label_res_map: self.label_res_map.clone(),
1492             lifetimes_res_map: self.lifetimes_res_map.clone(),
1493             generics_def_id_map: self.generics_def_id_map.clone(),
1494             extra_lifetime_params_map: self.extra_lifetime_params_map.clone(),
1495             next_node_id: self.next_node_id.clone(),
1496             node_id_to_def_id: self.node_id_to_def_id.clone(),
1497             def_id_to_node_id: self.def_id_to_node_id.clone(),
1498             trait_map: self.trait_map.clone(),
1499             builtin_macro_kinds: self.builtin_macro_kinds.clone(),
1500         };
1501         (definitions, cstore, resolutions, resolutions_lowering)
1502     }
1503
1504     fn create_stable_hashing_context(&self) -> StableHashingContext<'_> {
1505         StableHashingContext::new(
1506             self.session,
1507             &self.definitions,
1508             self.crate_loader.cstore(),
1509             &self.source_span,
1510         )
1511     }
1512
1513     pub fn cstore(&self) -> &CStore {
1514         self.crate_loader.cstore()
1515     }
1516
1517     fn dummy_ext(&self, macro_kind: MacroKind) -> Lrc<SyntaxExtension> {
1518         match macro_kind {
1519             MacroKind::Bang => self.dummy_ext_bang.clone(),
1520             MacroKind::Derive => self.dummy_ext_derive.clone(),
1521             MacroKind::Attr => self.non_macro_attr.clone(),
1522         }
1523     }
1524
1525     /// Runs the function on each namespace.
1526     fn per_ns<F: FnMut(&mut Self, Namespace)>(&mut self, mut f: F) {
1527         f(self, TypeNS);
1528         f(self, ValueNS);
1529         f(self, MacroNS);
1530     }
1531
1532     fn is_builtin_macro(&mut self, res: Res) -> bool {
1533         self.get_macro(res).map_or(false, |macro_data| macro_data.ext.builtin_name.is_some())
1534     }
1535
1536     fn macro_def(&self, mut ctxt: SyntaxContext) -> DefId {
1537         loop {
1538             match ctxt.outer_expn_data().macro_def_id {
1539                 Some(def_id) => return def_id,
1540                 None => ctxt.remove_mark(),
1541             };
1542         }
1543     }
1544
1545     /// Entry point to crate resolution.
1546     pub fn resolve_crate(&mut self, krate: &Crate) {
1547         self.session.time("resolve_crate", || {
1548             self.session.time("finalize_imports", || ImportResolver { r: self }.finalize_imports());
1549             self.session.time("resolve_access_levels", || {
1550                 AccessLevelsVisitor::compute_access_levels(self, krate)
1551             });
1552             self.session.time("finalize_macro_resolutions", || self.finalize_macro_resolutions());
1553             self.session.time("late_resolve_crate", || self.late_resolve_crate(krate));
1554             self.session.time("resolve_main", || self.resolve_main());
1555             self.session.time("resolve_check_unused", || self.check_unused(krate));
1556             self.session.time("resolve_report_errors", || self.report_errors(krate));
1557             self.session.time("resolve_postprocess", || self.crate_loader.postprocess(krate));
1558         });
1559     }
1560
1561     pub fn traits_in_scope(
1562         &mut self,
1563         current_trait: Option<Module<'a>>,
1564         parent_scope: &ParentScope<'a>,
1565         ctxt: SyntaxContext,
1566         assoc_item: Option<(Symbol, Namespace)>,
1567     ) -> Vec<TraitCandidate> {
1568         let mut found_traits = Vec::new();
1569
1570         if let Some(module) = current_trait {
1571             if self.trait_may_have_item(Some(module), assoc_item) {
1572                 let def_id = module.def_id();
1573                 found_traits.push(TraitCandidate { def_id, import_ids: smallvec![] });
1574             }
1575         }
1576
1577         self.visit_scopes(ScopeSet::All(TypeNS, false), parent_scope, ctxt, |this, scope, _, _| {
1578             match scope {
1579                 Scope::Module(module, _) => {
1580                     this.traits_in_module(module, assoc_item, &mut found_traits);
1581                 }
1582                 Scope::StdLibPrelude => {
1583                     if let Some(module) = this.prelude {
1584                         this.traits_in_module(module, assoc_item, &mut found_traits);
1585                     }
1586                 }
1587                 Scope::ExternPrelude | Scope::ToolPrelude | Scope::BuiltinTypes => {}
1588                 _ => unreachable!(),
1589             }
1590             None::<()>
1591         });
1592
1593         found_traits
1594     }
1595
1596     fn traits_in_module(
1597         &mut self,
1598         module: Module<'a>,
1599         assoc_item: Option<(Symbol, Namespace)>,
1600         found_traits: &mut Vec<TraitCandidate>,
1601     ) {
1602         module.ensure_traits(self);
1603         let traits = module.traits.borrow();
1604         for (trait_name, trait_binding) in traits.as_ref().unwrap().iter() {
1605             if self.trait_may_have_item(trait_binding.module(), assoc_item) {
1606                 let def_id = trait_binding.res().def_id();
1607                 let import_ids = self.find_transitive_imports(&trait_binding.kind, *trait_name);
1608                 found_traits.push(TraitCandidate { def_id, import_ids });
1609             }
1610         }
1611     }
1612
1613     // List of traits in scope is pruned on best effort basis. We reject traits not having an
1614     // associated item with the given name and namespace (if specified). This is a conservative
1615     // optimization, proper hygienic type-based resolution of associated items is done in typeck.
1616     // We don't reject trait aliases (`trait_module == None`) because we don't have access to their
1617     // associated items.
1618     fn trait_may_have_item(
1619         &mut self,
1620         trait_module: Option<Module<'a>>,
1621         assoc_item: Option<(Symbol, Namespace)>,
1622     ) -> bool {
1623         match (trait_module, assoc_item) {
1624             (Some(trait_module), Some((name, ns))) => {
1625                 self.resolutions(trait_module).borrow().iter().any(|resolution| {
1626                     let (&BindingKey { ident: assoc_ident, ns: assoc_ns, .. }, _) = resolution;
1627                     assoc_ns == ns && assoc_ident.name == name
1628                 })
1629             }
1630             _ => true,
1631         }
1632     }
1633
1634     fn find_transitive_imports(
1635         &mut self,
1636         mut kind: &NameBindingKind<'_>,
1637         trait_name: Ident,
1638     ) -> SmallVec<[LocalDefId; 1]> {
1639         let mut import_ids = smallvec![];
1640         while let NameBindingKind::Import { import, binding, .. } = kind {
1641             let id = self.local_def_id(import.id);
1642             self.maybe_unused_trait_imports.insert(id);
1643             self.add_to_glob_map(&import, trait_name);
1644             import_ids.push(id);
1645             kind = &binding.kind;
1646         }
1647         import_ids
1648     }
1649
1650     fn new_key(&mut self, ident: Ident, ns: Namespace) -> BindingKey {
1651         let ident = ident.normalize_to_macros_2_0();
1652         let disambiguator = if ident.name == kw::Underscore {
1653             self.underscore_disambiguator += 1;
1654             self.underscore_disambiguator
1655         } else {
1656             0
1657         };
1658         BindingKey { ident, ns, disambiguator }
1659     }
1660
1661     fn resolutions(&mut self, module: Module<'a>) -> &'a Resolutions<'a> {
1662         if module.populate_on_access.get() {
1663             module.populate_on_access.set(false);
1664             self.build_reduced_graph_external(module);
1665         }
1666         &module.lazy_resolutions
1667     }
1668
1669     fn resolution(
1670         &mut self,
1671         module: Module<'a>,
1672         key: BindingKey,
1673     ) -> &'a RefCell<NameResolution<'a>> {
1674         *self
1675             .resolutions(module)
1676             .borrow_mut()
1677             .entry(key)
1678             .or_insert_with(|| self.arenas.alloc_name_resolution())
1679     }
1680
1681     fn record_use(
1682         &mut self,
1683         ident: Ident,
1684         used_binding: &'a NameBinding<'a>,
1685         is_lexical_scope: bool,
1686     ) {
1687         if let Some((b2, kind)) = used_binding.ambiguity {
1688             self.ambiguity_errors.push(AmbiguityError {
1689                 kind,
1690                 ident,
1691                 b1: used_binding,
1692                 b2,
1693                 misc1: AmbiguityErrorMisc::None,
1694                 misc2: AmbiguityErrorMisc::None,
1695             });
1696         }
1697         if let NameBindingKind::Import { import, binding, ref used } = used_binding.kind {
1698             // Avoid marking `extern crate` items that refer to a name from extern prelude,
1699             // but not introduce it, as used if they are accessed from lexical scope.
1700             if is_lexical_scope {
1701                 if let Some(entry) = self.extern_prelude.get(&ident.normalize_to_macros_2_0()) {
1702                     if let Some(crate_item) = entry.extern_crate_item {
1703                         if ptr::eq(used_binding, crate_item) && !entry.introduced_by_item {
1704                             return;
1705                         }
1706                     }
1707                 }
1708             }
1709             used.set(true);
1710             import.used.set(true);
1711             self.used_imports.insert(import.id);
1712             self.add_to_glob_map(&import, ident);
1713             self.record_use(ident, binding, false);
1714         }
1715     }
1716
1717     #[inline]
1718     fn add_to_glob_map(&mut self, import: &Import<'_>, ident: Ident) {
1719         if import.is_glob() {
1720             let def_id = self.local_def_id(import.id);
1721             self.glob_map.entry(def_id).or_default().insert(ident.name);
1722         }
1723     }
1724
1725     fn resolve_crate_root(&mut self, ident: Ident) -> Module<'a> {
1726         debug!("resolve_crate_root({:?})", ident);
1727         let mut ctxt = ident.span.ctxt();
1728         let mark = if ident.name == kw::DollarCrate {
1729             // When resolving `$crate` from a `macro_rules!` invoked in a `macro`,
1730             // we don't want to pretend that the `macro_rules!` definition is in the `macro`
1731             // as described in `SyntaxContext::apply_mark`, so we ignore prepended opaque marks.
1732             // FIXME: This is only a guess and it doesn't work correctly for `macro_rules!`
1733             // definitions actually produced by `macro` and `macro` definitions produced by
1734             // `macro_rules!`, but at least such configurations are not stable yet.
1735             ctxt = ctxt.normalize_to_macro_rules();
1736             debug!(
1737                 "resolve_crate_root: marks={:?}",
1738                 ctxt.marks().into_iter().map(|(i, t)| (i.expn_data(), t)).collect::<Vec<_>>()
1739             );
1740             let mut iter = ctxt.marks().into_iter().rev().peekable();
1741             let mut result = None;
1742             // Find the last opaque mark from the end if it exists.
1743             while let Some(&(mark, transparency)) = iter.peek() {
1744                 if transparency == Transparency::Opaque {
1745                     result = Some(mark);
1746                     iter.next();
1747                 } else {
1748                     break;
1749                 }
1750             }
1751             debug!(
1752                 "resolve_crate_root: found opaque mark {:?} {:?}",
1753                 result,
1754                 result.map(|r| r.expn_data())
1755             );
1756             // Then find the last semi-transparent mark from the end if it exists.
1757             for (mark, transparency) in iter {
1758                 if transparency == Transparency::SemiTransparent {
1759                     result = Some(mark);
1760                 } else {
1761                     break;
1762                 }
1763             }
1764             debug!(
1765                 "resolve_crate_root: found semi-transparent mark {:?} {:?}",
1766                 result,
1767                 result.map(|r| r.expn_data())
1768             );
1769             result
1770         } else {
1771             debug!("resolve_crate_root: not DollarCrate");
1772             ctxt = ctxt.normalize_to_macros_2_0();
1773             ctxt.adjust(ExpnId::root())
1774         };
1775         let module = match mark {
1776             Some(def) => self.expn_def_scope(def),
1777             None => {
1778                 debug!(
1779                     "resolve_crate_root({:?}): found no mark (ident.span = {:?})",
1780                     ident, ident.span
1781                 );
1782                 return self.graph_root;
1783             }
1784         };
1785         let module = self.expect_module(
1786             module.opt_def_id().map_or(LOCAL_CRATE, |def_id| def_id.krate).as_def_id(),
1787         );
1788         debug!(
1789             "resolve_crate_root({:?}): got module {:?} ({:?}) (ident.span = {:?})",
1790             ident,
1791             module,
1792             module.kind.name(),
1793             ident.span
1794         );
1795         module
1796     }
1797
1798     fn resolve_self(&mut self, ctxt: &mut SyntaxContext, module: Module<'a>) -> Module<'a> {
1799         let mut module = self.expect_module(module.nearest_parent_mod());
1800         while module.span.ctxt().normalize_to_macros_2_0() != *ctxt {
1801             let parent = module.parent.unwrap_or_else(|| self.expn_def_scope(ctxt.remove_mark()));
1802             module = self.expect_module(parent.nearest_parent_mod());
1803         }
1804         module
1805     }
1806
1807     fn record_partial_res(&mut self, node_id: NodeId, resolution: PartialRes) {
1808         debug!("(recording res) recording {:?} for {}", resolution, node_id);
1809         if let Some(prev_res) = self.partial_res_map.insert(node_id, resolution) {
1810             panic!("path resolved multiple times ({:?} before, {:?} now)", prev_res, resolution);
1811         }
1812     }
1813
1814     fn record_pat_span(&mut self, node: NodeId, span: Span) {
1815         debug!("(recording pat) recording {:?} for {:?}", node, span);
1816         self.pat_span_map.insert(node, span);
1817     }
1818
1819     fn is_accessible_from(&self, vis: ty::Visibility, module: Module<'a>) -> bool {
1820         vis.is_accessible_from(module.nearest_parent_mod(), self)
1821     }
1822
1823     fn set_binding_parent_module(&mut self, binding: &'a NameBinding<'a>, module: Module<'a>) {
1824         if let Some(old_module) =
1825             self.binding_parent_modules.insert(Interned::new_unchecked(binding), module)
1826         {
1827             if !ptr::eq(module, old_module) {
1828                 span_bug!(binding.span, "parent module is reset for binding");
1829             }
1830         }
1831     }
1832
1833     fn disambiguate_macro_rules_vs_modularized(
1834         &self,
1835         macro_rules: &'a NameBinding<'a>,
1836         modularized: &'a NameBinding<'a>,
1837     ) -> bool {
1838         // Some non-controversial subset of ambiguities "modularized macro name" vs "macro_rules"
1839         // is disambiguated to mitigate regressions from macro modularization.
1840         // Scoping for `macro_rules` behaves like scoping for `let` at module level, in general.
1841         match (
1842             self.binding_parent_modules.get(&Interned::new_unchecked(macro_rules)),
1843             self.binding_parent_modules.get(&Interned::new_unchecked(modularized)),
1844         ) {
1845             (Some(macro_rules), Some(modularized)) => {
1846                 macro_rules.nearest_parent_mod() == modularized.nearest_parent_mod()
1847                     && modularized.is_ancestor_of(macro_rules)
1848             }
1849             _ => false,
1850         }
1851     }
1852
1853     fn extern_prelude_get(&mut self, ident: Ident, finalize: bool) -> Option<&'a NameBinding<'a>> {
1854         if ident.is_path_segment_keyword() {
1855             // Make sure `self`, `super` etc produce an error when passed to here.
1856             return None;
1857         }
1858         self.extern_prelude.get(&ident.normalize_to_macros_2_0()).cloned().and_then(|entry| {
1859             if let Some(binding) = entry.extern_crate_item {
1860                 if finalize && entry.introduced_by_item {
1861                     self.record_use(ident, binding, false);
1862                 }
1863                 Some(binding)
1864             } else {
1865                 let crate_id = if finalize {
1866                     let Some(crate_id) =
1867                         self.crate_loader.process_path_extern(ident.name, ident.span) else { return Some(self.dummy_binding); };
1868                     crate_id
1869                 } else {
1870                     self.crate_loader.maybe_process_path_extern(ident.name)?
1871                 };
1872                 let crate_root = self.expect_module(crate_id.as_def_id());
1873                 Some(
1874                     (crate_root, ty::Visibility::Public, DUMMY_SP, LocalExpnId::ROOT)
1875                         .to_name_binding(self.arenas),
1876                 )
1877             }
1878         })
1879     }
1880
1881     /// Rustdoc uses this to resolve doc link paths in a recoverable way. `PathResult<'a>`
1882     /// isn't something that can be returned because it can't be made to live that long,
1883     /// and also it's a private type. Fortunately rustdoc doesn't need to know the error,
1884     /// just that an error occurred.
1885     pub fn resolve_rustdoc_path(
1886         &mut self,
1887         path_str: &str,
1888         ns: Namespace,
1889         mut parent_scope: ParentScope<'a>,
1890     ) -> Option<Res> {
1891         let mut segments =
1892             Vec::from_iter(path_str.split("::").map(Ident::from_str).map(Segment::from_ident));
1893         if let Some(segment) = segments.first_mut() {
1894             if segment.ident.name == kw::Crate {
1895                 // FIXME: `resolve_path` always resolves `crate` to the current crate root, but
1896                 // rustdoc wants it to resolve to the `parent_scope`'s crate root. This trick of
1897                 // replacing `crate` with `self` and changing the current module should achieve
1898                 // the same effect.
1899                 segment.ident.name = kw::SelfLower;
1900                 parent_scope.module =
1901                     self.expect_module(parent_scope.module.def_id().krate.as_def_id());
1902             } else if segment.ident.name == kw::Empty {
1903                 segment.ident.name = kw::PathRoot;
1904             }
1905         }
1906
1907         match self.maybe_resolve_path(&segments, Some(ns), &parent_scope) {
1908             PathResult::Module(ModuleOrUniformRoot::Module(module)) => Some(module.res().unwrap()),
1909             PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 => {
1910                 Some(path_res.base_res())
1911             }
1912             PathResult::Module(ModuleOrUniformRoot::ExternPrelude)
1913             | PathResult::NonModule(..)
1914             | PathResult::Failed { .. } => None,
1915             PathResult::Module(..) | PathResult::Indeterminate => unreachable!(),
1916         }
1917     }
1918
1919     /// For rustdoc.
1920     /// For local modules returns only reexports, for external modules returns all children.
1921     pub fn module_children_or_reexports(&self, def_id: DefId) -> Vec<ModChild> {
1922         if let Some(def_id) = def_id.as_local() {
1923             self.reexport_map.get(&def_id).cloned().unwrap_or_default()
1924         } else {
1925             self.cstore().module_children_untracked(def_id, self.session)
1926         }
1927     }
1928
1929     /// For rustdoc.
1930     pub fn macro_rules_scope(&self, def_id: LocalDefId) -> (MacroRulesScopeRef<'a>, Res) {
1931         let scope = *self.macro_rules_scopes.get(&def_id).expect("not a `macro_rules` item");
1932         match scope.get() {
1933             MacroRulesScope::Binding(mb) => (scope, mb.binding.res()),
1934             _ => unreachable!(),
1935         }
1936     }
1937
1938     /// Retrieves the span of the given `DefId` if `DefId` is in the local crate.
1939     #[inline]
1940     pub fn opt_span(&self, def_id: DefId) -> Option<Span> {
1941         def_id.as_local().map(|def_id| self.source_span[def_id])
1942     }
1943
1944     /// Retrieves the name of the given `DefId`.
1945     #[inline]
1946     pub fn opt_name(&self, def_id: DefId) -> Option<Symbol> {
1947         let def_key = match def_id.as_local() {
1948             Some(def_id) => self.definitions.def_key(def_id),
1949             None => self.cstore().def_key(def_id),
1950         };
1951         def_key.get_opt_name()
1952     }
1953
1954     /// Checks if an expression refers to a function marked with
1955     /// `#[rustc_legacy_const_generics]` and returns the argument index list
1956     /// from the attribute.
1957     pub fn legacy_const_generic_args(&mut self, expr: &Expr) -> Option<Vec<usize>> {
1958         if let ExprKind::Path(None, path) = &expr.kind {
1959             // Don't perform legacy const generics rewriting if the path already
1960             // has generic arguments.
1961             if path.segments.last().unwrap().args.is_some() {
1962                 return None;
1963             }
1964
1965             let partial_res = self.partial_res_map.get(&expr.id)?;
1966             if partial_res.unresolved_segments() != 0 {
1967                 return None;
1968             }
1969
1970             if let Res::Def(def::DefKind::Fn, def_id) = partial_res.base_res() {
1971                 // We only support cross-crate argument rewriting. Uses
1972                 // within the same crate should be updated to use the new
1973                 // const generics style.
1974                 if def_id.is_local() {
1975                     return None;
1976                 }
1977
1978                 if let Some(v) = self.legacy_const_generic_args.get(&def_id) {
1979                     return v.clone();
1980                 }
1981
1982                 let attr = self
1983                     .cstore()
1984                     .item_attrs_untracked(def_id, self.session)
1985                     .find(|a| a.has_name(sym::rustc_legacy_const_generics))?;
1986                 let mut ret = Vec::new();
1987                 for meta in attr.meta_item_list()? {
1988                     match meta.literal()?.kind {
1989                         LitKind::Int(a, _) => ret.push(a as usize),
1990                         _ => panic!("invalid arg index"),
1991                     }
1992                 }
1993                 // Cache the lookup to avoid parsing attributes for an item multiple times.
1994                 self.legacy_const_generic_args.insert(def_id, Some(ret.clone()));
1995                 return Some(ret);
1996             }
1997         }
1998         None
1999     }
2000
2001     fn resolve_main(&mut self) {
2002         let module = self.graph_root;
2003         let ident = Ident::with_dummy_span(sym::main);
2004         let parent_scope = &ParentScope::module(module, self);
2005
2006         let Ok(name_binding) = self.maybe_resolve_ident_in_module(
2007             ModuleOrUniformRoot::Module(module),
2008             ident,
2009             ValueNS,
2010             parent_scope,
2011         ) else {
2012             return;
2013         };
2014
2015         let res = name_binding.res();
2016         let is_import = name_binding.is_import();
2017         let span = name_binding.span;
2018         if let Res::Def(DefKind::Fn, _) = res {
2019             self.record_use(ident, name_binding, false);
2020         }
2021         self.main_def = Some(MainDefinition { res, is_import, span });
2022     }
2023 }
2024
2025 fn names_to_string(names: &[Symbol]) -> String {
2026     let mut result = String::new();
2027     for (i, name) in names.iter().filter(|name| **name != kw::PathRoot).enumerate() {
2028         if i > 0 {
2029             result.push_str("::");
2030         }
2031         if Ident::with_dummy_span(*name).is_raw_guess() {
2032             result.push_str("r#");
2033         }
2034         result.push_str(name.as_str());
2035     }
2036     result
2037 }
2038
2039 fn path_names_to_string(path: &Path) -> String {
2040     names_to_string(&path.segments.iter().map(|seg| seg.ident.name).collect::<Vec<_>>())
2041 }
2042
2043 /// A somewhat inefficient routine to obtain the name of a module.
2044 fn module_to_string(module: Module<'_>) -> Option<String> {
2045     let mut names = Vec::new();
2046
2047     fn collect_mod(names: &mut Vec<Symbol>, module: Module<'_>) {
2048         if let ModuleKind::Def(.., name) = module.kind {
2049             if let Some(parent) = module.parent {
2050                 names.push(name);
2051                 collect_mod(names, parent);
2052             }
2053         } else {
2054             names.push(Symbol::intern("<opaque>"));
2055             collect_mod(names, module.parent.unwrap());
2056         }
2057     }
2058     collect_mod(&mut names, module);
2059
2060     if names.is_empty() {
2061         return None;
2062     }
2063     names.reverse();
2064     Some(names_to_string(&names))
2065 }
2066
2067 #[derive(Copy, Clone, Debug)]
2068 struct Finalize {
2069     /// Node ID for linting.
2070     node_id: NodeId,
2071     /// Span of the whole path or some its characteristic fragment.
2072     /// E.g. span of `b` in `foo::{a, b, c}`, or full span for regular paths.
2073     path_span: Span,
2074     /// Span of the path start, suitable for prepending something to to it.
2075     /// E.g. span of `foo` in `foo::{a, b, c}`, or full span for regular paths.
2076     root_span: Span,
2077     /// Whether to report privacy errors or silently return "no resolution" for them,
2078     /// similarly to speculative resolution.
2079     report_private: bool,
2080 }
2081
2082 impl Finalize {
2083     fn new(node_id: NodeId, path_span: Span) -> Finalize {
2084         Finalize::with_root_span(node_id, path_span, path_span)
2085     }
2086
2087     fn with_root_span(node_id: NodeId, path_span: Span, root_span: Span) -> Finalize {
2088         Finalize { node_id, path_span, root_span, report_private: true }
2089     }
2090 }
2091
2092 pub fn provide(providers: &mut Providers) {
2093     late::lifetimes::provide(providers);
2094 }