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