compiler/rustc_privacy/src/lib.rs

   1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
   2 #![feature(in_band_lifetimes)]
   3 #![feature(nll)]
   4 #![feature(control_flow_enum)]
   5 #![feature(try_blocks)]
   6 #![feature(associated_type_defaults)]
   7 #![recursion_limit = "256"]
   8
   9 use rustc_ast::MacroDef;
  10 use rustc_attr as attr;
  11 use rustc_data_structures::fx::FxHashSet;
  12 use rustc_errors::struct_span_err;
  13 use rustc_hir as hir;
  14 use rustc_hir::def::{DefKind, Res};
  15 use rustc_hir::def_id::{DefId, LocalDefId, LocalDefIdSet};
  16 use rustc_hir::def_id::{CRATE_DEF_ID, CRATE_DEF_INDEX, LOCAL_CRATE};
  17 use rustc_hir::intravisit::{self, DeepVisitor, NestedVisitorMap, Visitor};
  18 use rustc_hir::{AssocItemKind, HirIdSet, Node, PatKind};
  19 use rustc_middle::bug;
  20 use rustc_middle::hir::map::Map;
  21 use rustc_middle::middle::privacy::{AccessLevel, AccessLevels};
  22 use rustc_middle::mir::abstract_const::Node as ACNode;
  23 use rustc_middle::span_bug;
  24 use rustc_middle::ty::fold::TypeVisitor;
  25 use rustc_middle::ty::query::Providers;
  26 use rustc_middle::ty::subst::{InternalSubsts, Subst};
  27 use rustc_middle::ty::{self, Const, GenericParamDefKind, TraitRef, Ty, TyCtxt, TypeFoldable};
  28 use rustc_session::lint;
  29 use rustc_span::hygiene::Transparency;
  30 use rustc_span::symbol::{kw, sym, Ident};
  31 use rustc_span::Span;
  32 use rustc_trait_selection::traits::const_evaluatable::{self, AbstractConst};
  33
  34 use std::marker::PhantomData;
  35 use std::ops::ControlFlow;
  36 use std::{cmp, fmt, mem};
  37
  38 ////////////////////////////////////////////////////////////////////////////////
  39 /// Generic infrastructure used to implement specific visitors below.
  40 ////////////////////////////////////////////////////////////////////////////////
  41
  42 /// Implemented to visit all `DefId`s in a type.
  43 /// Visiting `DefId`s is useful because visibilities and reachabilities are attached to them.
  44 /// The idea is to visit "all components of a type", as documented in
  45 /// <https://github.com/rust-lang/rfcs/blob/master/text/2145-type-privacy.md#how-to-determine-visibility-of-a-type>.
  46 /// The default type visitor (`TypeVisitor`) does most of the job, but it has some shortcomings.
  47 /// First, it doesn't have overridable `fn visit_trait_ref`, so we have to catch trait `DefId`s
  48 /// manually. Second, it doesn't visit some type components like signatures of fn types, or traits
  49 /// in `impl Trait`, see individual comments in `DefIdVisitorSkeleton::visit_ty`.
  50 trait DefIdVisitor<'tcx> {
  51     type BreakTy = ();
  52
  53     fn tcx(&self) -> TyCtxt<'tcx>;
  54     fn shallow(&self) -> bool {
  55         false
  56     }
  57     fn skip_assoc_tys(&self) -> bool {
  58         false
  59     }
  60     fn visit_def_id(
  61         &mut self,
  62         def_id: DefId,
  63         kind: &str,
  64         descr: &dyn fmt::Display,
  65     ) -> ControlFlow<Self::BreakTy>;
  66
  67     /// Not overridden, but used to actually visit types and traits.
  68     fn skeleton(&mut self) -> DefIdVisitorSkeleton<'_, 'tcx, Self> {
  69         DefIdVisitorSkeleton {
  70             def_id_visitor: self,
  71             visited_opaque_tys: Default::default(),
  72             dummy: Default::default(),
  73         }
  74     }
  75     fn visit(&mut self, ty_fragment: impl TypeFoldable<'tcx>) -> ControlFlow<Self::BreakTy> {
  76         ty_fragment.visit_with(&mut self.skeleton())
  77     }
  78     fn visit_trait(&mut self, trait_ref: TraitRef<'tcx>) -> ControlFlow<Self::BreakTy> {
  79         self.skeleton().visit_trait(trait_ref)
  80     }
  81     fn visit_projection_ty(
  82         &mut self,
  83         projection: ty::ProjectionTy<'tcx>,
  84     ) -> ControlFlow<Self::BreakTy> {
  85         self.skeleton().visit_projection_ty(projection)
  86     }
  87     fn visit_predicates(
  88         &mut self,
  89         predicates: ty::GenericPredicates<'tcx>,
  90     ) -> ControlFlow<Self::BreakTy> {
  91         self.skeleton().visit_predicates(predicates)
  92     }
  93 }
  94
  95 struct DefIdVisitorSkeleton<'v, 'tcx, V: ?Sized> {
  96     def_id_visitor: &'v mut V,
  97     visited_opaque_tys: FxHashSet<DefId>,
  98     dummy: PhantomData<TyCtxt<'tcx>>,
  99 }
 100
 101 impl<'tcx, V> DefIdVisitorSkeleton<'_, 'tcx, V>
 102 where
 103     V: DefIdVisitor<'tcx> + ?Sized,
 104 {
 105     fn visit_trait(&mut self, trait_ref: TraitRef<'tcx>) -> ControlFlow<V::BreakTy> {
 106         let TraitRef { def_id, substs } = trait_ref;
 107         self.def_id_visitor.visit_def_id(def_id, "trait", &trait_ref.print_only_trait_path())?;
 108         if self.def_id_visitor.shallow() { ControlFlow::CONTINUE } else { substs.visit_with(self) }
 109     }
 110
 111     fn visit_projection_ty(
 112         &mut self,
 113         projection: ty::ProjectionTy<'tcx>,
 114     ) -> ControlFlow<V::BreakTy> {
 115         let (trait_ref, assoc_substs) =
 116             projection.trait_ref_and_own_substs(self.def_id_visitor.tcx());
 117         self.visit_trait(trait_ref)?;
 118         if self.def_id_visitor.shallow() {
 119             ControlFlow::CONTINUE
 120         } else {
 121             assoc_substs.iter().try_for_each(|subst| subst.visit_with(self))
 122         }
 123     }
 124
 125     fn visit_predicate(&mut self, predicate: ty::Predicate<'tcx>) -> ControlFlow<V::BreakTy> {
 126         match predicate.kind().skip_binder() {
 127             ty::PredicateKind::Trait(ty::TraitPredicate { trait_ref, constness: _ }) => {
 128                 self.visit_trait(trait_ref)
 129             }
 130             ty::PredicateKind::Projection(ty::ProjectionPredicate { projection_ty, ty }) => {
 131                 ty.visit_with(self)?;
 132                 self.visit_projection_ty(projection_ty)
 133             }
 134             ty::PredicateKind::TypeOutlives(ty::OutlivesPredicate(ty, _region)) => {
 135                 ty.visit_with(self)
 136             }
 137             ty::PredicateKind::RegionOutlives(..) => ControlFlow::CONTINUE,
 138             ty::PredicateKind::ConstEvaluatable(uv)
 139                 if self.def_id_visitor.tcx().features().generic_const_exprs =>
 140             {
 141                 let tcx = self.def_id_visitor.tcx();
 142                 if let Ok(Some(ct)) = AbstractConst::new(tcx, uv) {
 143                     self.visit_abstract_const_expr(tcx, ct)?;
 144                 }
 145                 ControlFlow::CONTINUE
 146             }
 147             _ => bug!("unexpected predicate: {:?}", predicate),
 148         }
 149     }
 150
 151     fn visit_abstract_const_expr(
 152         &mut self,
 153         tcx: TyCtxt<'tcx>,
 154         ct: AbstractConst<'tcx>,
 155     ) -> ControlFlow<V::BreakTy> {
 156         const_evaluatable::walk_abstract_const(tcx, ct, |node| match node.root() {
 157             ACNode::Leaf(leaf) => {
 158                 let leaf = leaf.subst(tcx, ct.substs);
 159                 self.visit_const(leaf)
 160             }
 161             ACNode::Cast(_, _, ty) => self.visit_ty(ty),
 162             ACNode::Block(_, _)
 163             | ACNode::Binop(..)
 164             | ACNode::UnaryOp(..)
 165             | ACNode::FunctionCall(_, _) => ControlFlow::CONTINUE,
 166         })
 167     }
 168
 169     fn visit_predicates(
 170         &mut self,
 171         predicates: ty::GenericPredicates<'tcx>,
 172     ) -> ControlFlow<V::BreakTy> {
 173         let ty::GenericPredicates { parent: _, predicates } = predicates;
 174         predicates.iter().try_for_each(|&(predicate, _span)| self.visit_predicate(predicate))
 175     }
 176 }
 177
 178 impl<'tcx, V> TypeVisitor<'tcx> for DefIdVisitorSkeleton<'_, 'tcx, V>
 179 where
 180     V: DefIdVisitor<'tcx> + ?Sized,
 181 {
 182     type BreakTy = V::BreakTy;
 183
 184     fn tcx_for_anon_const_substs(&self) -> Option<TyCtxt<'tcx>> {
 185         Some(self.def_id_visitor.tcx())
 186     }
 187
 188     fn visit_ty(&mut self, ty: Ty<'tcx>) -> ControlFlow<V::BreakTy> {
 189         let tcx = self.def_id_visitor.tcx();
 190         // InternalSubsts are not visited here because they are visited below in `super_visit_with`.
 191         match *ty.kind() {
 192             ty::Adt(&ty::AdtDef { did: def_id, .. }, ..)
 193             | ty::Foreign(def_id)
 194             | ty::FnDef(def_id, ..)
 195             | ty::Closure(def_id, ..)
 196             | ty::Generator(def_id, ..) => {
 197                 self.def_id_visitor.visit_def_id(def_id, "type", &ty)?;
 198                 if self.def_id_visitor.shallow() {
 199                     return ControlFlow::CONTINUE;
 200                 }
 201                 // Default type visitor doesn't visit signatures of fn types.
 202                 // Something like `fn() -> Priv {my_func}` is considered a private type even if
 203                 // `my_func` is public, so we need to visit signatures.
 204                 if let ty::FnDef(..) = ty.kind() {
 205                     tcx.fn_sig(def_id).visit_with(self)?;
 206                 }
 207                 // Inherent static methods don't have self type in substs.
 208                 // Something like `fn() {my_method}` type of the method
 209                 // `impl Pub<Priv> { pub fn my_method() {} }` is considered a private type,
 210                 // so we need to visit the self type additionally.
 211                 if let Some(assoc_item) = tcx.opt_associated_item(def_id) {
 212                     if let ty::ImplContainer(impl_def_id) = assoc_item.container {
 213                         tcx.type_of(impl_def_id).visit_with(self)?;
 214                     }
 215                 }
 216             }
 217             ty::Projection(proj) => {
 218                 if self.def_id_visitor.skip_assoc_tys() {
 219                     // Visitors searching for minimal visibility/reachability want to
 220                     // conservatively approximate associated types like `<Type as Trait>::Alias`
 221                     // as visible/reachable even if both `Type` and `Trait` are private.
 222                     // Ideally, associated types should be substituted in the same way as
 223                     // free type aliases, but this isn't done yet.
 224                     return ControlFlow::CONTINUE;
 225                 }
 226                 // This will also visit substs if necessary, so we don't need to recurse.
 227                 return self.visit_projection_ty(proj);
 228             }
 229             ty::Dynamic(predicates, ..) => {
 230                 // All traits in the list are considered the "primary" part of the type
 231                 // and are visited by shallow visitors.
 232                 for predicate in predicates {
 233                     let trait_ref = match predicate.skip_binder() {
 234                         ty::ExistentialPredicate::Trait(trait_ref) => trait_ref,
 235                         ty::ExistentialPredicate::Projection(proj) => proj.trait_ref(tcx),
 236                         ty::ExistentialPredicate::AutoTrait(def_id) => {
 237                             ty::ExistentialTraitRef { def_id, substs: InternalSubsts::empty() }
 238                         }
 239                     };
 240                     let ty::ExistentialTraitRef { def_id, substs: _ } = trait_ref;
 241                     self.def_id_visitor.visit_def_id(def_id, "trait", &trait_ref)?;
 242                 }
 243             }
 244             ty::Opaque(def_id, ..) => {
 245                 // Skip repeated `Opaque`s to avoid infinite recursion.
 246                 if self.visited_opaque_tys.insert(def_id) {
 247                     // The intent is to treat `impl Trait1 + Trait2` identically to
 248                     // `dyn Trait1 + Trait2`. Therefore we ignore def-id of the opaque type itself
 249                     // (it either has no visibility, or its visibility is insignificant, like
 250                     // visibilities of type aliases) and recurse into bounds instead to go
 251                     // through the trait list (default type visitor doesn't visit those traits).
 252                     // All traits in the list are considered the "primary" part of the type
 253                     // and are visited by shallow visitors.
 254                     self.visit_predicates(ty::GenericPredicates {
 255                         parent: None,
 256                         predicates: tcx.explicit_item_bounds(def_id),
 257                     })?;
 258                 }
 259             }
 260             // These types don't have their own def-ids (but may have subcomponents
 261             // with def-ids that should be visited recursively).
 262             ty::Bool
 263             | ty::Char
 264             | ty::Int(..)
 265             | ty::Uint(..)
 266             | ty::Float(..)
 267             | ty::Str
 268             | ty::Never
 269             | ty::Array(..)
 270             | ty::Slice(..)
 271             | ty::Tuple(..)
 272             | ty::RawPtr(..)
 273             | ty::Ref(..)
 274             | ty::FnPtr(..)
 275             | ty::Param(..)
 276             | ty::Error(_)
 277             | ty::GeneratorWitness(..) => {}
 278             ty::Bound(..) | ty::Placeholder(..) | ty::Infer(..) => {
 279                 bug!("unexpected type: {:?}", ty)
 280             }
 281         }
 282
 283         if self.def_id_visitor.shallow() {
 284             ControlFlow::CONTINUE
 285         } else {
 286             ty.super_visit_with(self)
 287         }
 288     }
 289
 290     fn visit_const(&mut self, c: &'tcx Const<'tcx>) -> ControlFlow<Self::BreakTy> {
 291         self.visit_ty(c.ty)?;
 292         let tcx = self.def_id_visitor.tcx();
 293         if let Ok(Some(ct)) = AbstractConst::from_const(tcx, c) {
 294             self.visit_abstract_const_expr(tcx, ct)?;
 295         }
 296         ControlFlow::CONTINUE
 297     }
 298 }
 299
 300 fn min(vis1: ty::Visibility, vis2: ty::Visibility, tcx: TyCtxt<'_>) -> ty::Visibility {
 301     if vis1.is_at_least(vis2, tcx) { vis2 } else { vis1 }
 302 }
 303
 304 ////////////////////////////////////////////////////////////////////////////////
 305 /// Visitor used to determine if pub(restricted) is used anywhere in the crate.
 306 ///
 307 /// This is done so that `private_in_public` warnings can be turned into hard errors
 308 /// in crates that have been updated to use pub(restricted).
 309 ////////////////////////////////////////////////////////////////////////////////
 310 struct PubRestrictedVisitor<'tcx> {
 311     tcx: TyCtxt<'tcx>,
 312     has_pub_restricted: bool,
 313 }
 314
 315 impl Visitor<'tcx> for PubRestrictedVisitor<'tcx> {
 316     type Map = Map<'tcx>;
 317
 318     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 319         NestedVisitorMap::All(self.tcx.hir())
 320     }
 321     fn visit_vis(&mut self, vis: &'tcx hir::Visibility<'tcx>) {
 322         self.has_pub_restricted = self.has_pub_restricted || vis.node.is_pub_restricted();
 323     }
 324 }
 325
 326 ////////////////////////////////////////////////////////////////////////////////
 327 /// Visitor used to determine impl visibility and reachability.
 328 ////////////////////////////////////////////////////////////////////////////////
 329
 330 struct FindMin<'a, 'tcx, VL: VisibilityLike> {
 331     tcx: TyCtxt<'tcx>,
 332     access_levels: &'a AccessLevels,
 333     min: VL,
 334 }
 335
 336 impl<'a, 'tcx, VL: VisibilityLike> DefIdVisitor<'tcx> for FindMin<'a, 'tcx, VL> {
 337     fn tcx(&self) -> TyCtxt<'tcx> {
 338         self.tcx
 339     }
 340     fn shallow(&self) -> bool {
 341         VL::SHALLOW
 342     }
 343     fn skip_assoc_tys(&self) -> bool {
 344         true
 345     }
 346     fn visit_def_id(
 347         &mut self,
 348         def_id: DefId,
 349         _kind: &str,
 350         _descr: &dyn fmt::Display,
 351     ) -> ControlFlow<Self::BreakTy> {
 352         self.min = VL::new_min(self, def_id);
 353         ControlFlow::CONTINUE
 354     }
 355 }
 356
 357 trait VisibilityLike: Sized {
 358     const MAX: Self;
 359     const SHALLOW: bool = false;
 360     fn new_min(find: &FindMin<'_, '_, Self>, def_id: DefId) -> Self;
 361
 362     // Returns an over-approximation (`skip_assoc_tys` = true) of visibility due to
 363     // associated types for which we can't determine visibility precisely.
 364     fn of_impl(def_id: LocalDefId, tcx: TyCtxt<'_>, access_levels: &AccessLevels) -> Self {
 365         let mut find = FindMin { tcx, access_levels, min: Self::MAX };
 366         find.visit(tcx.type_of(def_id));
 367         if let Some(trait_ref) = tcx.impl_trait_ref(def_id) {
 368             find.visit_trait(trait_ref);
 369         }
 370         find.min
 371     }
 372 }
 373 impl VisibilityLike for ty::Visibility {
 374     const MAX: Self = ty::Visibility::Public;
 375     fn new_min(find: &FindMin<'_, '_, Self>, def_id: DefId) -> Self {
 376         min(find.tcx.visibility(def_id), find.min, find.tcx)
 377     }
 378 }
 379 impl VisibilityLike for Option<AccessLevel> {
 380     const MAX: Self = Some(AccessLevel::Public);
 381     // Type inference is very smart sometimes.
 382     // It can make an impl reachable even some components of its type or trait are unreachable.
 383     // E.g. methods of `impl ReachableTrait<UnreachableTy> for ReachableTy<UnreachableTy> { ... }`
 384     // can be usable from other crates (#57264). So we skip substs when calculating reachability
 385     // and consider an impl reachable if its "shallow" type and trait are reachable.
 386     //
 387     // The assumption we make here is that type-inference won't let you use an impl without knowing
 388     // both "shallow" version of its self type and "shallow" version of its trait if it exists
 389     // (which require reaching the `DefId`s in them).
 390     const SHALLOW: bool = true;
 391     fn new_min(find: &FindMin<'_, '_, Self>, def_id: DefId) -> Self {
 392         cmp::min(
 393             if let Some(def_id) = def_id.as_local() {
 394                 find.access_levels.map.get(&def_id).copied()
 395             } else {
 396                 Self::MAX
 397             },
 398             find.min,
 399         )
 400     }
 401 }
 402
 403 ////////////////////////////////////////////////////////////////////////////////
 404 /// The embargo visitor, used to determine the exports of the AST.
 405 ////////////////////////////////////////////////////////////////////////////////
 406
 407 struct EmbargoVisitor<'tcx> {
 408     tcx: TyCtxt<'tcx>,
 409
 410     /// Accessibility levels for reachable nodes.
 411     access_levels: AccessLevels,
 412     /// A set of pairs corresponding to modules, where the first module is
 413     /// reachable via a macro that's defined in the second module. This cannot
 414     /// be represented as reachable because it can't handle the following case:
 415     ///
 416     /// pub mod n {                         // Should be `Public`
 417     ///     pub(crate) mod p {              // Should *not* be accessible
 418     ///         pub fn f() -> i32 { 12 }    // Must be `Reachable`
 419     ///     }
 420     /// }
 421     /// pub macro m() {
 422     ///     n::p::f()
 423     /// }
 424     macro_reachable: FxHashSet<(LocalDefId, LocalDefId)>,
 425     /// Previous accessibility level; `None` means unreachable.
 426     prev_level: Option<AccessLevel>,
 427     /// Has something changed in the level map?
 428     changed: bool,
 429 }
 430
 431 struct ReachEverythingInTheInterfaceVisitor<'a, 'tcx> {
 432     access_level: Option<AccessLevel>,
 433     item_def_id: LocalDefId,
 434     ev: &'a mut EmbargoVisitor<'tcx>,
 435 }
 436
 437 impl EmbargoVisitor<'tcx> {
 438     fn get(&self, def_id: LocalDefId) -> Option<AccessLevel> {
 439         self.access_levels.map.get(&def_id).copied()
 440     }
 441
 442     /// Updates node level and returns the updated level.
 443     fn update(&mut self, def_id: LocalDefId, level: Option<AccessLevel>) -> Option<AccessLevel> {
 444         let old_level = self.get(def_id);
 445         // Accessibility levels can only grow.
 446         if level > old_level {
 447             self.access_levels.map.insert(def_id, level.unwrap());
 448             self.changed = true;
 449             level
 450         } else {
 451             old_level
 452         }
 453     }
 454
 455     fn reach(
 456         &mut self,
 457         def_id: LocalDefId,
 458         access_level: Option<AccessLevel>,
 459     ) -> ReachEverythingInTheInterfaceVisitor<'_, 'tcx> {
 460         ReachEverythingInTheInterfaceVisitor {
 461             access_level: cmp::min(access_level, Some(AccessLevel::Reachable)),
 462             item_def_id: def_id,
 463             ev: self,
 464         }
 465     }
 466
 467     // We have to make sure that the items that macros might reference
 468     // are reachable, since they might be exported transitively.
 469     fn update_reachability_from_macro(&mut self, local_def_id: LocalDefId, md: &MacroDef) {
 470         // Non-opaque macros cannot make other items more accessible than they already are.
 471
 472         let hir_id = self.tcx.hir().local_def_id_to_hir_id(local_def_id);
 473         let attrs = self.tcx.hir().attrs(hir_id);
 474         if attr::find_transparency(&attrs, md.macro_rules).0 != Transparency::Opaque {
 475             return;
 476         }
 477
 478         let item_def_id = local_def_id.to_def_id();
 479         let macro_module_def_id =
 480             ty::DefIdTree::parent(self.tcx, item_def_id).unwrap().expect_local();
 481         if self.tcx.hir().opt_def_kind(macro_module_def_id) != Some(DefKind::Mod) {
 482             // The macro's parent doesn't correspond to a `mod`, return early (#63164, #65252).
 483             return;
 484         }
 485
 486         if self.get(local_def_id).is_none() {
 487             return;
 488         }
 489
 490         // Since we are starting from an externally visible module,
 491         // all the parents in the loop below are also guaranteed to be modules.
 492         let mut module_def_id = macro_module_def_id;
 493         loop {
 494             let changed_reachability =
 495                 self.update_macro_reachable(module_def_id, macro_module_def_id);
 496             if changed_reachability || module_def_id == CRATE_DEF_ID {
 497                 break;
 498             }
 499             module_def_id =
 500                 ty::DefIdTree::parent(self.tcx, module_def_id.to_def_id()).unwrap().expect_local();
 501         }
 502     }
 503
 504     /// Updates the item as being reachable through a macro defined in the given
 505     /// module. Returns `true` if the level has changed.
 506     fn update_macro_reachable(
 507         &mut self,
 508         module_def_id: LocalDefId,
 509         defining_mod: LocalDefId,
 510     ) -> bool {
 511         if self.macro_reachable.insert((module_def_id, defining_mod)) {
 512             self.update_macro_reachable_mod(module_def_id, defining_mod);
 513             true
 514         } else {
 515             false
 516         }
 517     }
 518
 519     fn update_macro_reachable_mod(&mut self, module_def_id: LocalDefId, defining_mod: LocalDefId) {
 520         let module = self.tcx.hir().get_module(module_def_id).0;
 521         for item_id in module.item_ids {
 522             let def_kind = self.tcx.def_kind(item_id.def_id);
 523             let vis = self.tcx.visibility(item_id.def_id);
 524             self.update_macro_reachable_def(item_id.def_id, def_kind, vis, defining_mod);
 525         }
 526         if let Some(exports) = self.tcx.module_exports(module_def_id) {
 527             for export in exports {
 528                 if export.vis.is_accessible_from(defining_mod.to_def_id(), self.tcx) {
 529                     if let Res::Def(def_kind, def_id) = export.res {
 530                         if let Some(def_id) = def_id.as_local() {
 531                             let vis = self.tcx.visibility(def_id.to_def_id());
 532                             self.update_macro_reachable_def(def_id, def_kind, vis, defining_mod);
 533                         }
 534                     }
 535                 }
 536             }
 537         }
 538     }
 539
 540     fn update_macro_reachable_def(
 541         &mut self,
 542         def_id: LocalDefId,
 543         def_kind: DefKind,
 544         vis: ty::Visibility,
 545         module: LocalDefId,
 546     ) {
 547         let level = Some(AccessLevel::Reachable);
 548         if let ty::Visibility::Public = vis {
 549             self.update(def_id, level);
 550         }
 551         match def_kind {
 552             // No type privacy, so can be directly marked as reachable.
 553             DefKind::Const | DefKind::Static | DefKind::TraitAlias | DefKind::TyAlias => {
 554                 if vis.is_accessible_from(module.to_def_id(), self.tcx) {
 555                     self.update(def_id, level);
 556                 }
 557             }
 558
 559             // Hygine isn't really implemented for `macro_rules!` macros at the
 560             // moment. Accordingly, marking them as reachable is unwise. `macro` macros
 561             // have normal  hygine, so we can treat them like other items without type
 562             // privacy and mark them reachable.
 563             DefKind::Macro(_) => {
 564                 let hir_id = self.tcx.hir().local_def_id_to_hir_id(def_id);
 565                 let item = self.tcx.hir().expect_item(hir_id);
 566                 if let hir::ItemKind::Macro(MacroDef { macro_rules: false, .. }) = item.kind {
 567                     if vis.is_accessible_from(module.to_def_id(), self.tcx) {
 568                         self.update(def_id, level);
 569                     }
 570                 }
 571             }
 572
 573             // We can't use a module name as the final segment of a path, except
 574             // in use statements. Since re-export checking doesn't consider
 575             // hygiene these don't need to be marked reachable. The contents of
 576             // the module, however may be reachable.
 577             DefKind::Mod => {
 578                 if vis.is_accessible_from(module.to_def_id(), self.tcx) {
 579                     self.update_macro_reachable(def_id, module);
 580                 }
 581             }
 582
 583             DefKind::Struct | DefKind::Union => {
 584                 // While structs and unions have type privacy, their fields do not.
 585                 if let ty::Visibility::Public = vis {
 586                     let item =
 587                         self.tcx.hir().expect_item(self.tcx.hir().local_def_id_to_hir_id(def_id));
 588                     if let hir::ItemKind::Struct(ref struct_def, _)
 589                     | hir::ItemKind::Union(ref struct_def, _) = item.kind
 590                     {
 591                         for field in struct_def.fields() {
 592                             let def_id = self.tcx.hir().local_def_id(field.hir_id);
 593                             let field_vis = self.tcx.visibility(def_id);
 594                             if field_vis.is_accessible_from(module.to_def_id(), self.tcx) {
 595                                 self.reach(def_id, level).ty();
 596                             }
 597                         }
 598                     } else {
 599                         bug!("item {:?} with DefKind {:?}", item, def_kind);
 600                     }
 601                 }
 602             }
 603
 604             // These have type privacy, so are not reachable unless they're
 605             // public, or are not namespaced at all.
 606             DefKind::AssocConst
 607             | DefKind::AssocTy
 608             | DefKind::ConstParam
 609             | DefKind::Ctor(_, _)
 610             | DefKind::Enum
 611             | DefKind::ForeignTy
 612             | DefKind::Fn
 613             | DefKind::OpaqueTy
 614             | DefKind::AssocFn
 615             | DefKind::Trait
 616             | DefKind::TyParam
 617             | DefKind::Variant
 618             | DefKind::LifetimeParam
 619             | DefKind::ExternCrate
 620             | DefKind::Use
 621             | DefKind::ForeignMod
 622             | DefKind::AnonConst
 623             | DefKind::Field
 624             | DefKind::GlobalAsm
 625             | DefKind::Impl
 626             | DefKind::Closure
 627             | DefKind::Generator => (),
 628         }
 629     }
 630
 631     /// Given the path segments of an `ItemKind::Use`, then we need
 632     /// to update the visibility of the intermediate use so that it isn't linted
 633     /// by `unreachable_pub`.
 634     ///
 635     /// This isn't trivial as `path.res` has the `DefId` of the eventual target
 636     /// of the use statement not of the next intermediate use statement.
 637     ///
 638     /// To do this, consider the last two segments of the path to our intermediate
 639     /// use statement. We expect the penultimate segment to be a module and the
 640     /// last segment to be the name of the item we are exporting. We can then
 641     /// look at the items contained in the module for the use statement with that
 642     /// name and update that item's visibility.
 643     ///
 644     /// FIXME: This solution won't work with glob imports and doesn't respect
 645     /// namespaces. See <https://github.com/rust-lang/rust/pull/57922#discussion_r251234202>.
 646     fn update_visibility_of_intermediate_use_statements(
 647         &mut self,
 648         segments: &[hir::PathSegment<'_>],
 649     ) {
 650         if let [.., module, segment] = segments {
 651             if let Some(item) = module
 652                 .res
 653                 .and_then(|res| res.mod_def_id())
 654                 // If the module is `self`, i.e. the current crate,
 655                 // there will be no corresponding item.
 656                 .filter(|def_id| def_id.index != CRATE_DEF_INDEX || def_id.krate != LOCAL_CRATE)
 657                 .and_then(|def_id| {
 658                     def_id.as_local().map(|def_id| self.tcx.hir().local_def_id_to_hir_id(def_id))
 659                 })
 660                 .map(|module_hir_id| self.tcx.hir().expect_item(module_hir_id))
 661             {
 662                 if let hir::ItemKind::Mod(m) = &item.kind {
 663                     for &item_id in m.item_ids {
 664                         let item = self.tcx.hir().item(item_id);
 665                         if !self.tcx.hygienic_eq(
 666                             segment.ident,
 667                             item.ident,
 668                             item_id.def_id.to_def_id(),
 669                         ) {
 670                             continue;
 671                         }
 672                         if let hir::ItemKind::Use(..) = item.kind {
 673                             self.update(item.def_id, Some(AccessLevel::Exported));
 674                         }
 675                     }
 676                 }
 677             }
 678         }
 679     }
 680 }
 681
 682 impl Visitor<'tcx> for EmbargoVisitor<'tcx> {
 683     type Map = Map<'tcx>;
 684
 685     /// We want to visit items in the context of their containing
 686     /// module and so forth, so supply a crate for doing a deep walk.
 687     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
 688         NestedVisitorMap::All(self.tcx.hir())
 689     }
 690
 691     fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
 692         let inherited_item_level = match item.kind {
 693             hir::ItemKind::Impl { .. } => {
 694                 Option::<AccessLevel>::of_impl(item.def_id, self.tcx, &self.access_levels)
 695             }
 696             // Only exported `macro_rules!` items are public, but they always are.
 697             hir::ItemKind::Macro(MacroDef { macro_rules: true, .. }) => {
 698                 let def_id = item.def_id.to_def_id();
 699                 let is_macro_export = self.tcx.has_attr(def_id, sym::macro_export);
 700                 if is_macro_export { Some(AccessLevel::Public) } else { None }
 701             }
 702             // Foreign modules inherit level from parents.
 703             hir::ItemKind::ForeignMod { .. } => self.prev_level,
 704             // Other `pub` items inherit levels from parents.
 705             hir::ItemKind::Const(..)
 706             | hir::ItemKind::Enum(..)
 707             | hir::ItemKind::ExternCrate(..)
 708             | hir::ItemKind::GlobalAsm(..)
 709             | hir::ItemKind::Fn(..)
 710             | hir::ItemKind::Macro(..)
 711             | hir::ItemKind::Mod(..)
 712             | hir::ItemKind::Static(..)
 713             | hir::ItemKind::Struct(..)
 714             | hir::ItemKind::Trait(..)
 715             | hir::ItemKind::TraitAlias(..)
 716             | hir::ItemKind::OpaqueTy(..)
 717             | hir::ItemKind::TyAlias(..)
 718             | hir::ItemKind::Union(..)
 719             | hir::ItemKind::Use(..) => {
 720                 if item.vis.node.is_pub() {
 721                     self.prev_level
 722                 } else {
 723                     None
 724                 }
 725             }
 726         };
 727
 728         // Update level of the item itself.
 729         let item_level = self.update(item.def_id, inherited_item_level);
 730
 731         // Update levels of nested things.
 732         match item.kind {
 733             hir::ItemKind::Enum(ref def, _) => {
 734                 for variant in def.variants {
 735                     let variant_level =
 736                         self.update(self.tcx.hir().local_def_id(variant.id), item_level);
 737                     if let Some(ctor_hir_id) = variant.data.ctor_hir_id() {
 738                         self.update(self.tcx.hir().local_def_id(ctor_hir_id), item_level);
 739                     }
 740                     for field in variant.data.fields() {
 741                         self.update(self.tcx.hir().local_def_id(field.hir_id), variant_level);
 742                     }
 743                 }
 744             }
 745             hir::ItemKind::Impl(ref impl_) => {
 746                 for impl_item_ref in impl_.items {
 747                     if impl_.of_trait.is_some() || impl_item_ref.vis.node.is_pub() {
 748                         self.update(impl_item_ref.id.def_id, item_level);
 749                     }
 750                 }
 751             }
 752             hir::ItemKind::Trait(.., trait_item_refs) => {
 753                 for trait_item_ref in trait_item_refs {
 754                     self.update(trait_item_ref.id.def_id, item_level);
 755                 }
 756             }
 757             hir::ItemKind::Struct(ref def, _) | hir::ItemKind::Union(ref def, _) => {
 758                 if let Some(ctor_hir_id) = def.ctor_hir_id() {
 759                     self.update(self.tcx.hir().local_def_id(ctor_hir_id), item_level);
 760                 }
 761                 for field in def.fields() {
 762                     if field.vis.node.is_pub() {
 763                         self.update(self.tcx.hir().local_def_id(field.hir_id), item_level);
 764                     }
 765                 }
 766             }
 767             hir::ItemKind::Macro(ref macro_def) => {
 768                 self.update_reachability_from_macro(item.def_id, macro_def);
 769             }
 770             hir::ItemKind::ForeignMod { items, .. } => {
 771                 for foreign_item in items {
 772                     if foreign_item.vis.node.is_pub() {
 773                         self.update(foreign_item.id.def_id, item_level);
 774                     }
 775                 }
 776             }
 777
 778             hir::ItemKind::OpaqueTy(..)
 779             | hir::ItemKind::Use(..)
 780             | hir::ItemKind::Static(..)
 781             | hir::ItemKind::Const(..)
 782             | hir::ItemKind::GlobalAsm(..)
 783             | hir::ItemKind::TyAlias(..)
 784             | hir::ItemKind::Mod(..)
 785             | hir::ItemKind::TraitAlias(..)
 786             | hir::ItemKind::Fn(..)
 787             | hir::ItemKind::ExternCrate(..) => {}
 788         }
 789
 790         // Mark all items in interfaces of reachable items as reachable.
 791         match item.kind {
 792             // The interface is empty.
 793             hir::ItemKind::Macro(..) | hir::ItemKind::ExternCrate(..) => {}
 794             // All nested items are checked by `visit_item`.
 795             hir::ItemKind::Mod(..) => {}
 796             // Re-exports are handled in `visit_mod`. However, in order to avoid looping over
 797             // all of the items of a mod in `visit_mod` looking for use statements, we handle
 798             // making sure that intermediate use statements have their visibilities updated here.
 799             hir::ItemKind::Use(ref path, _) => {
 800                 if item_level.is_some() {
 801                     self.update_visibility_of_intermediate_use_statements(path.segments.as_ref());
 802                 }
 803             }
 804             // The interface is empty.
 805             hir::ItemKind::GlobalAsm(..) => {}
 806             hir::ItemKind::OpaqueTy(..) => {
 807                 // HACK(jynelson): trying to infer the type of `impl trait` breaks `async-std` (and `pub async fn` in general)
 808                 // Since rustdoc never needs to do codegen and doesn't care about link-time reachability,
 809                 // mark this as unreachable.
 810                 // See https://github.com/rust-lang/rust/issues/75100
 811                 if !self.tcx.sess.opts.actually_rustdoc {
 812                     // FIXME: This is some serious pessimization intended to workaround deficiencies
 813                     // in the reachability pass (`middle/reachable.rs`). Types are marked as link-time
 814                     // reachable if they are returned via `impl Trait`, even from private functions.
 815                     let exist_level =
 816                         cmp::max(item_level, Some(AccessLevel::ReachableFromImplTrait));
 817                     self.reach(item.def_id, exist_level).generics().predicates().ty();
 818                 }
 819             }
 820             // Visit everything.
 821             hir::ItemKind::Const(..)
 822             | hir::ItemKind::Static(..)
 823             | hir::ItemKind::Fn(..)
 824             | hir::ItemKind::TyAlias(..) => {
 825                 if item_level.is_some() {
 826                     self.reach(item.def_id, item_level).generics().predicates().ty();
 827                 }
 828             }
 829             hir::ItemKind::Trait(.., trait_item_refs) => {
 830                 if item_level.is_some() {
 831                     self.reach(item.def_id, item_level).generics().predicates();
 832
 833                     for trait_item_ref in trait_item_refs {
 834                         let mut reach = self.reach(trait_item_ref.id.def_id, item_level);
 835                         reach.generics().predicates();
 836
 837                         if trait_item_ref.kind == AssocItemKind::Type
 838                             && !trait_item_ref.defaultness.has_value()
 839                         {
 840                             // No type to visit.
 841                         } else {
 842                             reach.ty();
 843                         }
 844                     }
 845                 }
 846             }
 847             hir::ItemKind::TraitAlias(..) => {
 848                 if item_level.is_some() {
 849                     self.reach(item.def_id, item_level).generics().predicates();
 850                 }
 851             }
 852             // Visit everything except for private impl items.
 853             hir::ItemKind::Impl(ref impl_) => {
 854                 if item_level.is_some() {
 855                     self.reach(item.def_id, item_level).generics().predicates().ty().trait_ref();
 856
 857                     for impl_item_ref in impl_.items {
 858                         let impl_item_level = self.get(impl_item_ref.id.def_id);
 859                         if impl_item_level.is_some() {
 860                             self.reach(impl_item_ref.id.def_id, impl_item_level)
 861                                 .generics()
 862                                 .predicates()
 863                                 .ty();
 864                         }
 865                     }
 866                 }
 867             }
 868
 869             // Visit everything, but enum variants have their own levels.
 870             hir::ItemKind::Enum(ref def, _) => {
 871                 if item_level.is_some() {
 872                     self.reach(item.def_id, item_level).generics().predicates();
 873                 }
 874                 for variant in def.variants {
 875                     let variant_level = self.get(self.tcx.hir().local_def_id(variant.id));
 876                     if variant_level.is_some() {
 877                         for field in variant.data.fields() {
 878                             self.reach(self.tcx.hir().local_def_id(field.hir_id), variant_level)
 879                                 .ty();
 880                         }
 881                         // Corner case: if the variant is reachable, but its
 882                         // enum is not, make the enum reachable as well.
 883                         self.update(item.def_id, variant_level);
 884                     }
 885                 }
 886             }
 887             // Visit everything, but foreign items have their own levels.
 888             hir::ItemKind::ForeignMod { items, .. } => {
 889                 for foreign_item in items {
 890                     let foreign_item_level = self.get(foreign_item.id.def_id);
 891                     if foreign_item_level.is_some() {
 892                         self.reach(foreign_item.id.def_id, foreign_item_level)
 893                             .generics()
 894                             .predicates()
 895                             .ty();
 896                     }
 897                 }
 898             }
 899             // Visit everything except for private fields.
 900             hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
 901                 if item_level.is_some() {
 902                     self.reach(item.def_id, item_level).generics().predicates();
 903                     for field in struct_def.fields() {
 904                         let def_id = self.tcx.hir().local_def_id(field.hir_id);
 905                         let field_level = self.get(def_id);
 906                         if field_level.is_some() {
 907                             self.reach(def_id, field_level).ty();
 908                         }
 909                     }
 910                 }
 911             }
 912         }
 913
 914         let orig_level = mem::replace(&mut self.prev_level, item_level);
 915         intravisit::walk_item(self, item);
 916         self.prev_level = orig_level;
 917     }
 918
 919     fn visit_block(&mut self, b: &'tcx hir::Block<'tcx>) {
 920         // Blocks can have public items, for example impls, but they always
 921         // start as completely private regardless of publicity of a function,
 922         // constant, type, field, etc., in which this block resides.
 923         let orig_level = mem::replace(&mut self.prev_level, None);
 924         intravisit::walk_block(self, b);
 925         self.prev_level = orig_level;
 926     }
 927
 928     fn visit_mod(&mut self, m: &'tcx hir::Mod<'tcx>, _sp: Span, id: hir::HirId) {
 929         // This code is here instead of in visit_item so that the
 930         // crate module gets processed as well.
 931         if self.prev_level.is_some() {
 932             let def_id = self.tcx.hir().local_def_id(id);
 933             if let Some(exports) = self.tcx.module_exports(def_id) {
 934                 for export in exports.iter() {
 935                     if export.vis == ty::Visibility::Public {
 936                         if let Some(def_id) = export.res.opt_def_id() {
 937                             if let Some(def_id) = def_id.as_local() {
 938                                 self.update(def_id, Some(AccessLevel::Exported));
 939                             }
 940                         }
 941                     }
 942                 }
 943             }
 944         }
 945
 946         intravisit::walk_mod(self, m, id);
 947     }
 948 }
 949
 950 impl ReachEverythingInTheInterfaceVisitor<'_, 'tcx> {
 951     fn generics(&mut self) -> &mut Self {
 952         for param in &self.ev.tcx.generics_of(self.item_def_id).params {
 953             match param.kind {
 954                 GenericParamDefKind::Lifetime => {}
 955                 GenericParamDefKind::Type { has_default, .. } => {
 956                     if has_default {
 957                         self.visit(self.ev.tcx.type_of(param.def_id));
 958                     }
 959                 }
 960                 GenericParamDefKind::Const { has_default, .. } => {
 961                     self.visit(self.ev.tcx.type_of(param.def_id));
 962                     if has_default {
 963                         self.visit(self.ev.tcx.const_param_default(param.def_id));
 964                     }
 965                 }
 966             }
 967         }
 968         self
 969     }
 970
 971     fn predicates(&mut self) -> &mut Self {
 972         self.visit_predicates(self.ev.tcx.predicates_of(self.item_def_id));
 973         self
 974     }
 975
 976     fn ty(&mut self) -> &mut Self {
 977         self.visit(self.ev.tcx.type_of(self.item_def_id));
 978         self
 979     }
 980
 981     fn trait_ref(&mut self) -> &mut Self {
 982         if let Some(trait_ref) = self.ev.tcx.impl_trait_ref(self.item_def_id) {
 983             self.visit_trait(trait_ref);
 984         }
 985         self
 986     }
 987 }
 988
 989 impl DefIdVisitor<'tcx> for ReachEverythingInTheInterfaceVisitor<'_, 'tcx> {
 990     fn tcx(&self) -> TyCtxt<'tcx> {
 991         self.ev.tcx
 992     }
 993     fn visit_def_id(
 994         &mut self,
 995         def_id: DefId,
 996         _kind: &str,
 997         _descr: &dyn fmt::Display,
 998     ) -> ControlFlow<Self::BreakTy> {
 999         if let Some(def_id) = def_id.as_local() {
1000             if let (ty::Visibility::Public, _) | (_, Some(AccessLevel::ReachableFromImplTrait)) =
1001                 (self.tcx().visibility(def_id.to_def_id()), self.access_level)
1002             {
1003                 self.ev.update(def_id, self.access_level);
1004             }
1005         }
1006         ControlFlow::CONTINUE
1007     }
1008 }
1009
1010 //////////////////////////////////////////////////////////////////////////////////////
1011 /// Name privacy visitor, checks privacy and reports violations.
1012 /// Most of name privacy checks are performed during the main resolution phase,
1013 /// or later in type checking when field accesses and associated items are resolved.
1014 /// This pass performs remaining checks for fields in struct expressions and patterns.
1015 //////////////////////////////////////////////////////////////////////////////////////
1016
1017 struct NamePrivacyVisitor<'tcx> {
1018     tcx: TyCtxt<'tcx>,
1019     maybe_typeck_results: Option<&'tcx ty::TypeckResults<'tcx>>,
1020     current_item: LocalDefId,
1021 }
1022
1023 impl<'tcx> NamePrivacyVisitor<'tcx> {
1024     /// Gets the type-checking results for the current body.
1025     /// As this will ICE if called outside bodies, only call when working with
1026     /// `Expr` or `Pat` nodes (they are guaranteed to be found only in bodies).
1027     #[track_caller]
1028     fn typeck_results(&self) -> &'tcx ty::TypeckResults<'tcx> {
1029         self.maybe_typeck_results
1030             .expect("`NamePrivacyVisitor::typeck_results` called outside of body")
1031     }
1032
1033     // Checks that a field in a struct constructor (expression or pattern) is accessible.
1034     fn check_field(
1035         &mut self,
1036         use_ctxt: Span,        // syntax context of the field name at the use site
1037         span: Span,            // span of the field pattern, e.g., `x: 0`
1038         def: &'tcx ty::AdtDef, // definition of the struct or enum
1039         field: &'tcx ty::FieldDef,
1040         in_update_syntax: bool,
1041     ) {
1042         if def.is_enum() {
1043             return;
1044         }
1045
1046         // definition of the field
1047         let ident = Ident::new(kw::Empty, use_ctxt);
1048         let hir_id = self.tcx.hir().local_def_id_to_hir_id(self.current_item);
1049         let def_id = self.tcx.adjust_ident_and_get_scope(ident, def.did, hir_id).1;
1050         if !field.vis.is_accessible_from(def_id, self.tcx) {
1051             let label = if in_update_syntax {
1052                 format!("field `{}` is private", field.ident)
1053             } else {
1054                 "private field".to_string()
1055             };
1056
1057             struct_span_err!(
1058                 self.tcx.sess,
1059                 span,
1060                 E0451,
1061                 "field `{}` of {} `{}` is private",
1062                 field.ident,
1063                 def.variant_descr(),
1064                 self.tcx.def_path_str(def.did)
1065             )
1066             .span_label(span, label)
1067             .emit();
1068         }
1069     }
1070 }
1071
1072 impl<'tcx> Visitor<'tcx> for NamePrivacyVisitor<'tcx> {
1073     type Map = Map<'tcx>;
1074
1075     /// We want to visit items in the context of their containing
1076     /// module and so forth, so supply a crate for doing a deep walk.
1077     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1078         NestedVisitorMap::All(self.tcx.hir())
1079     }
1080
1081     fn visit_mod(&mut self, _m: &'tcx hir::Mod<'tcx>, _s: Span, _n: hir::HirId) {
1082         // Don't visit nested modules, since we run a separate visitor walk
1083         // for each module in `privacy_access_levels`
1084     }
1085
1086     fn visit_nested_body(&mut self, body: hir::BodyId) {
1087         let old_maybe_typeck_results =
1088             self.maybe_typeck_results.replace(self.tcx.typeck_body(body));
1089         let body = self.tcx.hir().body(body);
1090         self.visit_body(body);
1091         self.maybe_typeck_results = old_maybe_typeck_results;
1092     }
1093
1094     fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1095         let orig_current_item = mem::replace(&mut self.current_item, item.def_id);
1096         intravisit::walk_item(self, item);
1097         self.current_item = orig_current_item;
1098     }
1099
1100     fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
1101         if let hir::ExprKind::Struct(ref qpath, fields, ref base) = expr.kind {
1102             let res = self.typeck_results().qpath_res(qpath, expr.hir_id);
1103             let adt = self.typeck_results().expr_ty(expr).ty_adt_def().unwrap();
1104             let variant = adt.variant_of_res(res);
1105             if let Some(ref base) = *base {
1106                 // If the expression uses FRU we need to make sure all the unmentioned fields
1107                 // are checked for privacy (RFC 736). Rather than computing the set of
1108                 // unmentioned fields, just check them all.
1109                 for (vf_index, variant_field) in variant.fields.iter().enumerate() {
1110                     let field = fields.iter().find(|f| {
1111                         self.tcx.field_index(f.hir_id, self.typeck_results()) == vf_index
1112                     });
1113                     let (use_ctxt, span) = match field {
1114                         Some(field) => (field.ident.span, field.span),
1115                         None => (base.span, base.span),
1116                     };
1117                     self.check_field(use_ctxt, span, adt, variant_field, true);
1118                 }
1119             } else {
1120                 for field in fields {
1121                     let use_ctxt = field.ident.span;
1122                     let index = self.tcx.field_index(field.hir_id, self.typeck_results());
1123                     self.check_field(use_ctxt, field.span, adt, &variant.fields[index], false);
1124                 }
1125             }
1126         }
1127
1128         intravisit::walk_expr(self, expr);
1129     }
1130
1131     fn visit_pat(&mut self, pat: &'tcx hir::Pat<'tcx>) {
1132         if let PatKind::Struct(ref qpath, fields, _) = pat.kind {
1133             let res = self.typeck_results().qpath_res(qpath, pat.hir_id);
1134             let adt = self.typeck_results().pat_ty(pat).ty_adt_def().unwrap();
1135             let variant = adt.variant_of_res(res);
1136             for field in fields {
1137                 let use_ctxt = field.ident.span;
1138                 let index = self.tcx.field_index(field.hir_id, self.typeck_results());
1139                 self.check_field(use_ctxt, field.span, adt, &variant.fields[index], false);
1140             }
1141         }
1142
1143         intravisit::walk_pat(self, pat);
1144     }
1145 }
1146
1147 ////////////////////////////////////////////////////////////////////////////////////////////
1148 /// Type privacy visitor, checks types for privacy and reports violations.
1149 /// Both explicitly written types and inferred types of expressions and patterns are checked.
1150 /// Checks are performed on "semantic" types regardless of names and their hygiene.
1151 ////////////////////////////////////////////////////////////////////////////////////////////
1152
1153 struct TypePrivacyVisitor<'tcx> {
1154     tcx: TyCtxt<'tcx>,
1155     maybe_typeck_results: Option<&'tcx ty::TypeckResults<'tcx>>,
1156     current_item: LocalDefId,
1157     span: Span,
1158 }
1159
1160 impl<'tcx> TypePrivacyVisitor<'tcx> {
1161     /// Gets the type-checking results for the current body.
1162     /// As this will ICE if called outside bodies, only call when working with
1163     /// `Expr` or `Pat` nodes (they are guaranteed to be found only in bodies).
1164     #[track_caller]
1165     fn typeck_results(&self) -> &'tcx ty::TypeckResults<'tcx> {
1166         self.maybe_typeck_results
1167             .expect("`TypePrivacyVisitor::typeck_results` called outside of body")
1168     }
1169
1170     fn item_is_accessible(&self, did: DefId) -> bool {
1171         self.tcx.visibility(did).is_accessible_from(self.current_item.to_def_id(), self.tcx)
1172     }
1173
1174     // Take node-id of an expression or pattern and check its type for privacy.
1175     fn check_expr_pat_type(&mut self, id: hir::HirId, span: Span) -> bool {
1176         self.span = span;
1177         let typeck_results = self.typeck_results();
1178         let result: ControlFlow<()> = try {
1179             self.visit(typeck_results.node_type(id))?;
1180             self.visit(typeck_results.node_substs(id))?;
1181             if let Some(adjustments) = typeck_results.adjustments().get(id) {
1182                 adjustments.iter().try_for_each(|adjustment| self.visit(adjustment.target))?;
1183             }
1184         };
1185         result.is_break()
1186     }
1187
1188     fn check_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1189         let is_error = !self.item_is_accessible(def_id);
1190         if is_error {
1191             self.tcx
1192                 .sess
1193                 .struct_span_err(self.span, &format!("{} `{}` is private", kind, descr))
1194                 .span_label(self.span, &format!("private {}", kind))
1195                 .emit();
1196         }
1197         is_error
1198     }
1199 }
1200
1201 impl<'tcx> Visitor<'tcx> for TypePrivacyVisitor<'tcx> {
1202     type Map = Map<'tcx>;
1203
1204     /// We want to visit items in the context of their containing
1205     /// module and so forth, so supply a crate for doing a deep walk.
1206     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1207         NestedVisitorMap::All(self.tcx.hir())
1208     }
1209
1210     fn visit_mod(&mut self, _m: &'tcx hir::Mod<'tcx>, _s: Span, _n: hir::HirId) {
1211         // Don't visit nested modules, since we run a separate visitor walk
1212         // for each module in `privacy_access_levels`
1213     }
1214
1215     fn visit_nested_body(&mut self, body: hir::BodyId) {
1216         let old_maybe_typeck_results =
1217             self.maybe_typeck_results.replace(self.tcx.typeck_body(body));
1218         let body = self.tcx.hir().body(body);
1219         self.visit_body(body);
1220         self.maybe_typeck_results = old_maybe_typeck_results;
1221     }
1222
1223     fn visit_generic_arg(&mut self, generic_arg: &'tcx hir::GenericArg<'tcx>) {
1224         match generic_arg {
1225             hir::GenericArg::Type(t) => self.visit_ty(t),
1226             hir::GenericArg::Infer(inf) => self.visit_infer(inf),
1227             hir::GenericArg::Lifetime(_) | hir::GenericArg::Const(_) => {}
1228         }
1229     }
1230
1231     fn visit_ty(&mut self, hir_ty: &'tcx hir::Ty<'tcx>) {
1232         self.span = hir_ty.span;
1233         if let Some(typeck_results) = self.maybe_typeck_results {
1234             // Types in bodies.
1235             if self.visit(typeck_results.node_type(hir_ty.hir_id)).is_break() {
1236                 return;
1237             }
1238         } else {
1239             // Types in signatures.
1240             // FIXME: This is very ineffective. Ideally each HIR type should be converted
1241             // into a semantic type only once and the result should be cached somehow.
1242             if self.visit(rustc_typeck::hir_ty_to_ty(self.tcx, hir_ty)).is_break() {
1243                 return;
1244             }
1245         }
1246
1247         intravisit::walk_ty(self, hir_ty);
1248     }
1249
1250     fn visit_infer(&mut self, inf: &'tcx hir::InferArg) {
1251         self.span = inf.span;
1252         if let Some(typeck_results) = self.maybe_typeck_results {
1253             if let Some(ty) = typeck_results.node_type_opt(inf.hir_id) {
1254                 if self.visit(ty).is_break() {
1255                     return;
1256                 }
1257             }
1258         } else {
1259             let local_id = self.tcx.hir().local_def_id(inf.hir_id);
1260             if let Some(did) = self.tcx.opt_const_param_of(local_id) {
1261                 if self.visit_def_id(did, "inferred", &"").is_break() {
1262                     return;
1263                 }
1264             }
1265
1266             // FIXME see above note for same issue.
1267             if self.visit(rustc_typeck::hir_ty_to_ty(self.tcx, &inf.to_ty())).is_break() {
1268                 return;
1269             }
1270         }
1271         intravisit::walk_inf(self, inf);
1272     }
1273
1274     fn visit_trait_ref(&mut self, trait_ref: &'tcx hir::TraitRef<'tcx>) {
1275         self.span = trait_ref.path.span;
1276         if self.maybe_typeck_results.is_none() {
1277             // Avoid calling `hir_trait_to_predicates` in bodies, it will ICE.
1278             // The traits' privacy in bodies is already checked as a part of trait object types.
1279             let bounds = rustc_typeck::hir_trait_to_predicates(
1280                 self.tcx,
1281                 trait_ref,
1282                 // NOTE: This isn't really right, but the actual type doesn't matter here. It's
1283                 // just required by `ty::TraitRef`.
1284                 self.tcx.types.never,
1285             );
1286
1287             for (trait_predicate, _, _) in bounds.trait_bounds {
1288                 if self.visit_trait(trait_predicate.skip_binder()).is_break() {
1289                     return;
1290                 }
1291             }
1292
1293             for (poly_predicate, _) in bounds.projection_bounds {
1294                 if self.visit(poly_predicate.skip_binder().ty).is_break()
1295                     || self
1296                         .visit_projection_ty(poly_predicate.skip_binder().projection_ty)
1297                         .is_break()
1298                 {
1299                     return;
1300                 }
1301             }
1302         }
1303
1304         intravisit::walk_trait_ref(self, trait_ref);
1305     }
1306
1307     // Check types of expressions
1308     fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
1309         if self.check_expr_pat_type(expr.hir_id, expr.span) {
1310             // Do not check nested expressions if the error already happened.
1311             return;
1312         }
1313         match expr.kind {
1314             hir::ExprKind::Assign(_, ref rhs, _) | hir::ExprKind::Match(ref rhs, ..) => {
1315                 // Do not report duplicate errors for `x = y` and `match x { ... }`.
1316                 if self.check_expr_pat_type(rhs.hir_id, rhs.span) {
1317                     return;
1318                 }
1319             }
1320             hir::ExprKind::MethodCall(_, span, _, _) => {
1321                 // Method calls have to be checked specially.
1322                 self.span = span;
1323                 if let Some(def_id) = self.typeck_results().type_dependent_def_id(expr.hir_id) {
1324                     if self.visit(self.tcx.type_of(def_id)).is_break() {
1325                         return;
1326                     }
1327                 } else {
1328                     self.tcx
1329                         .sess
1330                         .delay_span_bug(expr.span, "no type-dependent def for method call");
1331                 }
1332             }
1333             _ => {}
1334         }
1335
1336         intravisit::walk_expr(self, expr);
1337     }
1338
1339     // Prohibit access to associated items with insufficient nominal visibility.
1340     //
1341     // Additionally, until better reachability analysis for macros 2.0 is available,
1342     // we prohibit access to private statics from other crates, this allows to give
1343     // more code internal visibility at link time. (Access to private functions
1344     // is already prohibited by type privacy for function types.)
1345     fn visit_qpath(&mut self, qpath: &'tcx hir::QPath<'tcx>, id: hir::HirId, span: Span) {
1346         let def = match qpath {
1347             hir::QPath::Resolved(_, path) => match path.res {
1348                 Res::Def(kind, def_id) => Some((kind, def_id)),
1349                 _ => None,
1350             },
1351             hir::QPath::TypeRelative(..) | hir::QPath::LangItem(..) => self
1352                 .maybe_typeck_results
1353                 .and_then(|typeck_results| typeck_results.type_dependent_def(id)),
1354         };
1355         let def = def.filter(|(kind, _)| {
1356             matches!(
1357                 kind,
1358                 DefKind::AssocFn | DefKind::AssocConst | DefKind::AssocTy | DefKind::Static
1359             )
1360         });
1361         if let Some((kind, def_id)) = def {
1362             let is_local_static =
1363                 if let DefKind::Static = kind { def_id.is_local() } else { false };
1364             if !self.item_is_accessible(def_id) && !is_local_static {
1365                 let sess = self.tcx.sess;
1366                 let sm = sess.source_map();
1367                 let name = match qpath {
1368                     hir::QPath::Resolved(..) | hir::QPath::LangItem(..) => {
1369                         sm.span_to_snippet(qpath.span()).ok()
1370                     }
1371                     hir::QPath::TypeRelative(_, segment) => Some(segment.ident.to_string()),
1372                 };
1373                 let kind = kind.descr(def_id);
1374                 let msg = match name {
1375                     Some(name) => format!("{} `{}` is private", kind, name),
1376                     None => format!("{} is private", kind),
1377                 };
1378                 sess.struct_span_err(span, &msg)
1379                     .span_label(span, &format!("private {}", kind))
1380                     .emit();
1381                 return;
1382             }
1383         }
1384
1385         intravisit::walk_qpath(self, qpath, id, span);
1386     }
1387
1388     // Check types of patterns.
1389     fn visit_pat(&mut self, pattern: &'tcx hir::Pat<'tcx>) {
1390         if self.check_expr_pat_type(pattern.hir_id, pattern.span) {
1391             // Do not check nested patterns if the error already happened.
1392             return;
1393         }
1394
1395         intravisit::walk_pat(self, pattern);
1396     }
1397
1398     fn visit_local(&mut self, local: &'tcx hir::Local<'tcx>) {
1399         if let Some(ref init) = local.init {
1400             if self.check_expr_pat_type(init.hir_id, init.span) {
1401                 // Do not report duplicate errors for `let x = y`.
1402                 return;
1403             }
1404         }
1405
1406         intravisit::walk_local(self, local);
1407     }
1408
1409     // Check types in item interfaces.
1410     fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1411         let orig_current_item = mem::replace(&mut self.current_item, item.def_id);
1412         let old_maybe_typeck_results = self.maybe_typeck_results.take();
1413         intravisit::walk_item(self, item);
1414         self.maybe_typeck_results = old_maybe_typeck_results;
1415         self.current_item = orig_current_item;
1416     }
1417 }
1418
1419 impl DefIdVisitor<'tcx> for TypePrivacyVisitor<'tcx> {
1420     fn tcx(&self) -> TyCtxt<'tcx> {
1421         self.tcx
1422     }
1423     fn visit_def_id(
1424         &mut self,
1425         def_id: DefId,
1426         kind: &str,
1427         descr: &dyn fmt::Display,
1428     ) -> ControlFlow<Self::BreakTy> {
1429         if self.check_def_id(def_id, kind, descr) {
1430             ControlFlow::BREAK
1431         } else {
1432             ControlFlow::CONTINUE
1433         }
1434     }
1435 }
1436
1437 ///////////////////////////////////////////////////////////////////////////////
1438 /// Obsolete visitors for checking for private items in public interfaces.
1439 /// These visitors are supposed to be kept in frozen state and produce an
1440 /// "old error node set". For backward compatibility the new visitor reports
1441 /// warnings instead of hard errors when the erroneous node is not in this old set.
1442 ///////////////////////////////////////////////////////////////////////////////
1443
1444 struct ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1445     tcx: TyCtxt<'tcx>,
1446     access_levels: &'a AccessLevels,
1447     in_variant: bool,
1448     // Set of errors produced by this obsolete visitor.
1449     old_error_set: HirIdSet,
1450 }
1451
1452 struct ObsoleteCheckTypeForPrivatenessVisitor<'a, 'b, 'tcx> {
1453     inner: &'a ObsoleteVisiblePrivateTypesVisitor<'b, 'tcx>,
1454     /// Whether the type refers to private types.
1455     contains_private: bool,
1456     /// Whether we've recurred at all (i.e., if we're pointing at the
1457     /// first type on which `visit_ty` was called).
1458     at_outer_type: bool,
1459     /// Whether that first type is a public path.
1460     outer_type_is_public_path: bool,
1461 }
1462
1463 impl<'a, 'tcx> ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1464     fn path_is_private_type(&self, path: &hir::Path<'_>) -> bool {
1465         let did = match path.res {
1466             Res::PrimTy(..) | Res::SelfTy(..) | Res::Err => return false,
1467             res => res.def_id(),
1468         };
1469
1470         // A path can only be private if:
1471         // it's in this crate...
1472         if let Some(did) = did.as_local() {
1473             // .. and it corresponds to a private type in the AST (this returns
1474             // `None` for type parameters).
1475             match self.tcx.hir().find(self.tcx.hir().local_def_id_to_hir_id(did)) {
1476                 Some(Node::Item(ref item)) => !item.vis.node.is_pub(),
1477                 Some(_) | None => false,
1478             }
1479         } else {
1480             false
1481         }
1482     }
1483
1484     fn trait_is_public(&self, trait_id: LocalDefId) -> bool {
1485         // FIXME: this would preferably be using `exported_items`, but all
1486         // traits are exported currently (see `EmbargoVisitor.exported_trait`).
1487         self.access_levels.is_public(trait_id)
1488     }
1489
1490     fn check_generic_bound(&mut self, bound: &hir::GenericBound<'_>) {
1491         if let hir::GenericBound::Trait(ref trait_ref, _) = *bound {
1492             if self.path_is_private_type(&trait_ref.trait_ref.path) {
1493                 self.old_error_set.insert(trait_ref.trait_ref.hir_ref_id);
1494             }
1495         }
1496     }
1497
1498     fn item_is_public(&self, def_id: LocalDefId, vis: &hir::Visibility<'_>) -> bool {
1499         self.access_levels.is_reachable(def_id) || vis.node.is_pub()
1500     }
1501 }
1502
1503 impl<'a, 'b, 'tcx, 'v> Visitor<'v> for ObsoleteCheckTypeForPrivatenessVisitor<'a, 'b, 'tcx> {
1504     type Map = intravisit::ErasedMap<'v>;
1505
1506     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1507         NestedVisitorMap::None
1508     }
1509
1510     fn visit_generic_arg(&mut self, generic_arg: &'v hir::GenericArg<'v>) {
1511         match generic_arg {
1512             hir::GenericArg::Type(t) => self.visit_ty(t),
1513             hir::GenericArg::Infer(inf) => self.visit_ty(&inf.to_ty()),
1514             hir::GenericArg::Lifetime(_) | hir::GenericArg::Const(_) => {}
1515         }
1516     }
1517
1518     fn visit_ty(&mut self, ty: &hir::Ty<'_>) {
1519         if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = ty.kind {
1520             if self.inner.path_is_private_type(path) {
1521                 self.contains_private = true;
1522                 // Found what we're looking for, so let's stop working.
1523                 return;
1524             }
1525         }
1526         if let hir::TyKind::Path(_) = ty.kind {
1527             if self.at_outer_type {
1528                 self.outer_type_is_public_path = true;
1529             }
1530         }
1531         self.at_outer_type = false;
1532         intravisit::walk_ty(self, ty)
1533     }
1534
1535     // Don't want to recurse into `[, .. expr]`.
1536     fn visit_expr(&mut self, _: &hir::Expr<'_>) {}
1537 }
1538
1539 impl<'a, 'tcx> Visitor<'tcx> for ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1540     type Map = Map<'tcx>;
1541
1542     /// We want to visit items in the context of their containing
1543     /// module and so forth, so supply a crate for doing a deep walk.
1544     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1545         NestedVisitorMap::All(self.tcx.hir())
1546     }
1547
1548     fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1549         match item.kind {
1550             // Contents of a private mod can be re-exported, so we need
1551             // to check internals.
1552             hir::ItemKind::Mod(_) => {}
1553
1554             // An `extern {}` doesn't introduce a new privacy
1555             // namespace (the contents have their own privacies).
1556             hir::ItemKind::ForeignMod { .. } => {}
1557
1558             hir::ItemKind::Trait(.., ref bounds, _) => {
1559                 if !self.trait_is_public(item.def_id) {
1560                     return;
1561                 }
1562
1563                 for bound in bounds.iter() {
1564                     self.check_generic_bound(bound)
1565                 }
1566             }
1567
1568             // Impls need some special handling to try to offer useful
1569             // error messages without (too many) false positives
1570             // (i.e., we could just return here to not check them at
1571             // all, or some worse estimation of whether an impl is
1572             // publicly visible).
1573             hir::ItemKind::Impl(ref impl_) => {
1574                 // `impl [... for] Private` is never visible.
1575                 let self_contains_private;
1576                 // `impl [... for] Public<...>`, but not `impl [... for]
1577                 // Vec<Public>` or `(Public,)`, etc.
1578                 let self_is_public_path;
1579
1580                 // Check the properties of the `Self` type:
1581                 {
1582                     let mut visitor = ObsoleteCheckTypeForPrivatenessVisitor {
1583                         inner: self,
1584                         contains_private: false,
1585                         at_outer_type: true,
1586                         outer_type_is_public_path: false,
1587                     };
1588                     visitor.visit_ty(&impl_.self_ty);
1589                     self_contains_private = visitor.contains_private;
1590                     self_is_public_path = visitor.outer_type_is_public_path;
1591                 }
1592
1593                 // Miscellaneous info about the impl:
1594
1595                 // `true` iff this is `impl Private for ...`.
1596                 let not_private_trait = impl_.of_trait.as_ref().map_or(
1597                     true, // no trait counts as public trait
1598                     |tr| {
1599                         if let Some(def_id) = tr.path.res.def_id().as_local() {
1600                             self.trait_is_public(def_id)
1601                         } else {
1602                             true // external traits must be public
1603                         }
1604                     },
1605                 );
1606
1607                 // `true` iff this is a trait impl or at least one method is public.
1608                 //
1609                 // `impl Public { $( fn ...() {} )* }` is not visible.
1610                 //
1611                 // This is required over just using the methods' privacy
1612                 // directly because we might have `impl<T: Foo<Private>> ...`,
1613                 // and we shouldn't warn about the generics if all the methods
1614                 // are private (because `T` won't be visible externally).
1615                 let trait_or_some_public_method = impl_.of_trait.is_some()
1616                     || impl_.items.iter().any(|impl_item_ref| {
1617                         let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1618                         match impl_item.kind {
1619                             hir::ImplItemKind::Const(..) | hir::ImplItemKind::Fn(..) => {
1620                                 self.access_levels.is_reachable(impl_item_ref.id.def_id)
1621                             }
1622                             hir::ImplItemKind::TyAlias(_) => false,
1623                         }
1624                     });
1625
1626                 if !self_contains_private && not_private_trait && trait_or_some_public_method {
1627                     intravisit::walk_generics(self, &impl_.generics);
1628
1629                     match impl_.of_trait {
1630                         None => {
1631                             for impl_item_ref in impl_.items {
1632                                 // This is where we choose whether to walk down
1633                                 // further into the impl to check its items. We
1634                                 // should only walk into public items so that we
1635                                 // don't erroneously report errors for private
1636                                 // types in private items.
1637                                 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1638                                 match impl_item.kind {
1639                                     hir::ImplItemKind::Const(..) | hir::ImplItemKind::Fn(..)
1640                                         if self
1641                                             .item_is_public(impl_item.def_id, &impl_item.vis) =>
1642                                     {
1643                                         intravisit::walk_impl_item(self, impl_item)
1644                                     }
1645                                     hir::ImplItemKind::TyAlias(..) => {
1646                                         intravisit::walk_impl_item(self, impl_item)
1647                                     }
1648                                     _ => {}
1649                                 }
1650                             }
1651                         }
1652                         Some(ref tr) => {
1653                             // Any private types in a trait impl fall into three
1654                             // categories.
1655                             // 1. mentioned in the trait definition
1656                             // 2. mentioned in the type params/generics
1657                             // 3. mentioned in the associated types of the impl
1658                             //
1659                             // Those in 1. can only occur if the trait is in
1660                             // this crate and will've been warned about on the
1661                             // trait definition (there's no need to warn twice
1662                             // so we don't check the methods).
1663                             //
1664                             // Those in 2. are warned via walk_generics and this
1665                             // call here.
1666                             intravisit::walk_path(self, &tr.path);
1667
1668                             // Those in 3. are warned with this call.
1669                             for impl_item_ref in impl_.items {
1670                                 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1671                                 if let hir::ImplItemKind::TyAlias(ref ty) = impl_item.kind {
1672                                     self.visit_ty(ty);
1673                                 }
1674                             }
1675                         }
1676                     }
1677                 } else if impl_.of_trait.is_none() && self_is_public_path {
1678                     // `impl Public<Private> { ... }`. Any public static
1679                     // methods will be visible as `Public::foo`.
1680                     let mut found_pub_static = false;
1681                     for impl_item_ref in impl_.items {
1682                         if self.item_is_public(impl_item_ref.id.def_id, &impl_item_ref.vis) {
1683                             let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1684                             match impl_item_ref.kind {
1685                                 AssocItemKind::Const => {
1686                                     found_pub_static = true;
1687                                     intravisit::walk_impl_item(self, impl_item);
1688                                 }
1689                                 AssocItemKind::Fn { has_self: false } => {
1690                                     found_pub_static = true;
1691                                     intravisit::walk_impl_item(self, impl_item);
1692                                 }
1693                                 _ => {}
1694                             }
1695                         }
1696                     }
1697                     if found_pub_static {
1698                         intravisit::walk_generics(self, &impl_.generics)
1699                     }
1700                 }
1701                 return;
1702             }
1703
1704             // `type ... = ...;` can contain private types, because
1705             // we're introducing a new name.
1706             hir::ItemKind::TyAlias(..) => return,
1707
1708             // Not at all public, so we don't care.
1709             _ if !self.item_is_public(item.def_id, &item.vis) => {
1710                 return;
1711             }
1712
1713             _ => {}
1714         }
1715
1716         // We've carefully constructed it so that if we're here, then
1717         // any `visit_ty`'s will be called on things that are in
1718         // public signatures, i.e., things that we're interested in for
1719         // this visitor.
1720         intravisit::walk_item(self, item);
1721     }
1722
1723     fn visit_generics(&mut self, generics: &'tcx hir::Generics<'tcx>) {
1724         for param in generics.params {
1725             for bound in param.bounds {
1726                 self.check_generic_bound(bound);
1727             }
1728         }
1729         for predicate in generics.where_clause.predicates {
1730             match predicate {
1731                 hir::WherePredicate::BoundPredicate(bound_pred) => {
1732                     for bound in bound_pred.bounds.iter() {
1733                         self.check_generic_bound(bound)
1734                     }
1735                 }
1736                 hir::WherePredicate::RegionPredicate(_) => {}
1737                 hir::WherePredicate::EqPredicate(eq_pred) => {
1738                     self.visit_ty(&eq_pred.rhs_ty);
1739                 }
1740             }
1741         }
1742     }
1743
1744     fn visit_foreign_item(&mut self, item: &'tcx hir::ForeignItem<'tcx>) {
1745         if self.access_levels.is_reachable(item.def_id) {
1746             intravisit::walk_foreign_item(self, item)
1747         }
1748     }
1749
1750     fn visit_ty(&mut self, t: &'tcx hir::Ty<'tcx>) {
1751         if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = t.kind {
1752             if self.path_is_private_type(path) {
1753                 self.old_error_set.insert(t.hir_id);
1754             }
1755         }
1756         intravisit::walk_ty(self, t)
1757     }
1758
1759     fn visit_variant(
1760         &mut self,
1761         v: &'tcx hir::Variant<'tcx>,
1762         g: &'tcx hir::Generics<'tcx>,
1763         item_id: hir::HirId,
1764     ) {
1765         if self.access_levels.is_reachable(self.tcx.hir().local_def_id(v.id)) {
1766             self.in_variant = true;
1767             intravisit::walk_variant(self, v, g, item_id);
1768             self.in_variant = false;
1769         }
1770     }
1771
1772     fn visit_field_def(&mut self, s: &'tcx hir::FieldDef<'tcx>) {
1773         if s.vis.node.is_pub() || self.in_variant {
1774             intravisit::walk_field_def(self, s);
1775         }
1776     }
1777
1778     // We don't need to introspect into these at all: an
1779     // expression/block context can't possibly contain exported things.
1780     // (Making them no-ops stops us from traversing the whole AST without
1781     // having to be super careful about our `walk_...` calls above.)
1782     fn visit_block(&mut self, _: &'tcx hir::Block<'tcx>) {}
1783     fn visit_expr(&mut self, _: &'tcx hir::Expr<'tcx>) {}
1784 }
1785
1786 ///////////////////////////////////////////////////////////////////////////////
1787 /// SearchInterfaceForPrivateItemsVisitor traverses an item's interface and
1788 /// finds any private components in it.
1789 /// PrivateItemsInPublicInterfacesVisitor ensures there are no private types
1790 /// and traits in public interfaces.
1791 ///////////////////////////////////////////////////////////////////////////////
1792
1793 struct SearchInterfaceForPrivateItemsVisitor<'tcx> {
1794     tcx: TyCtxt<'tcx>,
1795     item_def_id: LocalDefId,
1796     /// The visitor checks that each component type is at least this visible.
1797     required_visibility: ty::Visibility,
1798     has_pub_restricted: bool,
1799     has_old_errors: bool,
1800     in_assoc_ty: bool,
1801 }
1802
1803 impl SearchInterfaceForPrivateItemsVisitor<'tcx> {
1804     fn generics(&mut self) -> &mut Self {
1805         for param in &self.tcx.generics_of(self.item_def_id).params {
1806             match param.kind {
1807                 GenericParamDefKind::Lifetime => {}
1808                 GenericParamDefKind::Type { has_default, .. } => {
1809                     if has_default {
1810                         self.visit(self.tcx.type_of(param.def_id));
1811                     }
1812                 }
1813                 // FIXME(generic_const_exprs): May want to look inside const here
1814                 GenericParamDefKind::Const { .. } => {
1815                     self.visit(self.tcx.type_of(param.def_id));
1816                 }
1817             }
1818         }
1819         self
1820     }
1821
1822     fn predicates(&mut self) -> &mut Self {
1823         // N.B., we use `explicit_predicates_of` and not `predicates_of`
1824         // because we don't want to report privacy errors due to where
1825         // clauses that the compiler inferred. We only want to
1826         // consider the ones that the user wrote. This is important
1827         // for the inferred outlives rules; see
1828         // `src/test/ui/rfc-2093-infer-outlives/privacy.rs`.
1829         self.visit_predicates(self.tcx.explicit_predicates_of(self.item_def_id));
1830         self
1831     }
1832
1833     fn bounds(&mut self) -> &mut Self {
1834         self.visit_predicates(ty::GenericPredicates {
1835             parent: None,
1836             predicates: self.tcx.explicit_item_bounds(self.item_def_id),
1837         });
1838         self
1839     }
1840
1841     fn ty(&mut self) -> &mut Self {
1842         self.visit(self.tcx.type_of(self.item_def_id));
1843         self
1844     }
1845
1846     fn check_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1847         if self.leaks_private_dep(def_id) {
1848             self.tcx.struct_span_lint_hir(
1849                 lint::builtin::EXPORTED_PRIVATE_DEPENDENCIES,
1850                 self.tcx.hir().local_def_id_to_hir_id(self.item_def_id),
1851                 self.tcx.def_span(self.item_def_id.to_def_id()),
1852                 |lint| {
1853                     lint.build(&format!(
1854                         "{} `{}` from private dependency '{}' in public \
1855                                                 interface",
1856                         kind,
1857                         descr,
1858                         self.tcx.crate_name(def_id.krate)
1859                     ))
1860                     .emit()
1861                 },
1862             );
1863         }
1864
1865         let hir_id = match def_id.as_local() {
1866             Some(def_id) => self.tcx.hir().local_def_id_to_hir_id(def_id),
1867             None => return false,
1868         };
1869
1870         let vis = self.tcx.visibility(def_id);
1871         if !vis.is_at_least(self.required_visibility, self.tcx) {
1872             let vis_descr = match vis {
1873                 ty::Visibility::Public => "public",
1874                 ty::Visibility::Invisible => "private",
1875                 ty::Visibility::Restricted(vis_def_id) => {
1876                     if vis_def_id == self.tcx.parent_module(hir_id).to_def_id() {
1877                         "private"
1878                     } else if vis_def_id.is_top_level_module() {
1879                         "crate-private"
1880                     } else {
1881                         "restricted"
1882                     }
1883                 }
1884             };
1885             let make_msg = || format!("{} {} `{}` in public interface", vis_descr, kind, descr);
1886             let span = self.tcx.def_span(self.item_def_id.to_def_id());
1887             if self.has_pub_restricted || self.has_old_errors || self.in_assoc_ty {
1888                 let mut err = if kind == "trait" {
1889                     struct_span_err!(self.tcx.sess, span, E0445, "{}", make_msg())
1890                 } else {
1891                     struct_span_err!(self.tcx.sess, span, E0446, "{}", make_msg())
1892                 };
1893                 let vis_span =
1894                     self.tcx.sess.source_map().guess_head_span(self.tcx.def_span(def_id));
1895                 err.span_label(span, format!("can't leak {} {}", vis_descr, kind));
1896                 err.span_label(vis_span, format!("`{}` declared as {}", descr, vis_descr));
1897                 err.emit();
1898             } else {
1899                 let err_code = if kind == "trait" { "E0445" } else { "E0446" };
1900                 self.tcx.struct_span_lint_hir(
1901                     lint::builtin::PRIVATE_IN_PUBLIC,
1902                     hir_id,
1903                     span,
1904                     |lint| lint.build(&format!("{} (error {})", make_msg(), err_code)).emit(),
1905                 );
1906             }
1907         }
1908
1909         false
1910     }
1911
1912     /// An item is 'leaked' from a private dependency if all
1913     /// of the following are true:
1914     /// 1. It's contained within a public type
1915     /// 2. It comes from a private crate
1916     fn leaks_private_dep(&self, item_id: DefId) -> bool {
1917         let ret = self.required_visibility == ty::Visibility::Public
1918             && self.tcx.is_private_dep(item_id.krate);
1919
1920         tracing::debug!("leaks_private_dep(item_id={:?})={}", item_id, ret);
1921         ret
1922     }
1923 }
1924
1925 impl DefIdVisitor<'tcx> for SearchInterfaceForPrivateItemsVisitor<'tcx> {
1926     fn tcx(&self) -> TyCtxt<'tcx> {
1927         self.tcx
1928     }
1929     fn visit_def_id(
1930         &mut self,
1931         def_id: DefId,
1932         kind: &str,
1933         descr: &dyn fmt::Display,
1934     ) -> ControlFlow<Self::BreakTy> {
1935         if self.check_def_id(def_id, kind, descr) {
1936             ControlFlow::BREAK
1937         } else {
1938             ControlFlow::CONTINUE
1939         }
1940     }
1941 }
1942
1943 struct PrivateItemsInPublicInterfacesVisitor<'tcx> {
1944     tcx: TyCtxt<'tcx>,
1945     has_pub_restricted: bool,
1946     old_error_set_ancestry: LocalDefIdSet,
1947 }
1948
1949 impl<'tcx> PrivateItemsInPublicInterfacesVisitor<'tcx> {
1950     fn check(
1951         &self,
1952         def_id: LocalDefId,
1953         required_visibility: ty::Visibility,
1954     ) -> SearchInterfaceForPrivateItemsVisitor<'tcx> {
1955         SearchInterfaceForPrivateItemsVisitor {
1956             tcx: self.tcx,
1957             item_def_id: def_id,
1958             required_visibility,
1959             has_pub_restricted: self.has_pub_restricted,
1960             has_old_errors: self.old_error_set_ancestry.contains(&def_id),
1961             in_assoc_ty: false,
1962         }
1963     }
1964
1965     fn check_assoc_item(
1966         &self,
1967         def_id: LocalDefId,
1968         assoc_item_kind: AssocItemKind,
1969         defaultness: hir::Defaultness,
1970         vis: ty::Visibility,
1971     ) {
1972         let mut check = self.check(def_id, vis);
1973
1974         let (check_ty, is_assoc_ty) = match assoc_item_kind {
1975             AssocItemKind::Const | AssocItemKind::Fn { .. } => (true, false),
1976             AssocItemKind::Type => (defaultness.has_value(), true),
1977         };
1978         check.in_assoc_ty = is_assoc_ty;
1979         check.generics().predicates();
1980         if check_ty {
1981             check.ty();
1982         }
1983     }
1984 }
1985
1986 impl<'tcx> Visitor<'tcx> for PrivateItemsInPublicInterfacesVisitor<'tcx> {
1987     type Map = Map<'tcx>;
1988
1989     fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
1990         NestedVisitorMap::OnlyBodies(self.tcx.hir())
1991     }
1992
1993     fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1994         let tcx = self.tcx;
1995         let item_visibility = tcx.visibility(item.def_id);
1996
1997         match item.kind {
1998             // Crates are always public.
1999             hir::ItemKind::ExternCrate(..) => {}
2000             // All nested items are checked by `visit_item`.
2001             hir::ItemKind::Mod(..) => {}
2002             // Checked in resolve.
2003             hir::ItemKind::Use(..) => {}
2004             // No subitems.
2005             hir::ItemKind::Macro(..) | hir::ItemKind::GlobalAsm(..) => {}
2006             // Subitems of these items have inherited publicity.
2007             hir::ItemKind::Const(..)
2008             | hir::ItemKind::Static(..)
2009             | hir::ItemKind::Fn(..)
2010             | hir::ItemKind::TyAlias(..) => {
2011                 self.check(item.def_id, item_visibility).generics().predicates().ty();
2012             }
2013             hir::ItemKind::OpaqueTy(..) => {
2014                 // `ty()` for opaque types is the underlying type,
2015                 // it's not a part of interface, so we skip it.
2016                 self.check(item.def_id, item_visibility).generics().bounds();
2017             }
2018             hir::ItemKind::Trait(.., trait_item_refs) => {
2019                 self.check(item.def_id, item_visibility).generics().predicates();
2020
2021                 for trait_item_ref in trait_item_refs {
2022                     self.check_assoc_item(
2023                         trait_item_ref.id.def_id,
2024                         trait_item_ref.kind,
2025                         trait_item_ref.defaultness,
2026                         item_visibility,
2027                     );
2028
2029                     if let AssocItemKind::Type = trait_item_ref.kind {
2030                         self.check(trait_item_ref.id.def_id, item_visibility).bounds();
2031                     }
2032                 }
2033             }
2034             hir::ItemKind::TraitAlias(..) => {
2035                 self.check(item.def_id, item_visibility).generics().predicates();
2036             }
2037             hir::ItemKind::Enum(ref def, _) => {
2038                 self.check(item.def_id, item_visibility).generics().predicates();
2039
2040                 for variant in def.variants {
2041                     for field in variant.data.fields() {
2042                         self.check(self.tcx.hir().local_def_id(field.hir_id), item_visibility).ty();
2043                     }
2044                 }
2045             }
2046             // Subitems of foreign modules have their own publicity.
2047             hir::ItemKind::ForeignMod { items, .. } => {
2048                 for foreign_item in items {
2049                     let vis = tcx.visibility(foreign_item.id.def_id);
2050                     self.check(foreign_item.id.def_id, vis).generics().predicates().ty();
2051                 }
2052             }
2053             // Subitems of structs and unions have their own publicity.
2054             hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
2055                 self.check(item.def_id, item_visibility).generics().predicates();
2056
2057                 for field in struct_def.fields() {
2058                     let def_id = tcx.hir().local_def_id(field.hir_id);
2059                     let field_visibility = tcx.visibility(def_id);
2060                     self.check(def_id, min(item_visibility, field_visibility, tcx)).ty();
2061                 }
2062             }
2063             // An inherent impl is public when its type is public
2064             // Subitems of inherent impls have their own publicity.
2065             // A trait impl is public when both its type and its trait are public
2066             // Subitems of trait impls have inherited publicity.
2067             hir::ItemKind::Impl(ref impl_) => {
2068                 let impl_vis = ty::Visibility::of_impl(item.def_id, tcx, &Default::default());
2069                 self.check(item.def_id, impl_vis).generics().predicates();
2070                 for impl_item_ref in impl_.items {
2071                     let impl_item_vis = if impl_.of_trait.is_none() {
2072                         min(tcx.visibility(impl_item_ref.id.def_id), impl_vis, tcx)
2073                     } else {
2074                         impl_vis
2075                     };
2076                     self.check_assoc_item(
2077                         impl_item_ref.id.def_id,
2078                         impl_item_ref.kind,
2079                         impl_item_ref.defaultness,
2080                         impl_item_vis,
2081                     );
2082                 }
2083             }
2084         }
2085     }
2086 }
2087
2088 pub fn provide(providers: &mut Providers) {
2089     *providers = Providers {
2090         visibility,
2091         privacy_access_levels,
2092         check_private_in_public,
2093         check_mod_privacy,
2094         ..*providers
2095     };
2096 }
2097
2098 fn visibility(tcx: TyCtxt<'_>, def_id: DefId) -> ty::Visibility {
2099     let def_id = def_id.expect_local();
2100     match tcx.resolutions(()).visibilities.get(&def_id) {
2101         Some(vis) => *vis,
2102         None => {
2103             let hir_id = tcx.hir().local_def_id_to_hir_id(def_id);
2104             match tcx.hir().get(hir_id) {
2105                 // Unique types created for closures participate in type privacy checking.
2106                 // They have visibilities inherited from the module they are defined in.
2107                 Node::Expr(hir::Expr { kind: hir::ExprKind::Closure(..), .. }) => {
2108                     ty::Visibility::Restricted(tcx.parent_module(hir_id).to_def_id())
2109                 }
2110                 // - AST lowering may clone `use` items and the clones don't
2111                 //   get their entries in the resolver's visibility table.
2112                 // - AST lowering also creates opaque type items with inherited visibilies.
2113                 //   Visibility on them should have no effect, but to avoid the visibility
2114                 //   query failing on some items, we provide it for opaque types as well.
2115                 Node::Item(hir::Item {
2116                     vis,
2117                     kind: hir::ItemKind::Use(..) | hir::ItemKind::OpaqueTy(..),
2118                     ..
2119                 }) => ty::Visibility::from_hir(vis, hir_id, tcx),
2120                 // Visibilities of trait impl items are inherited from their traits
2121                 // and are not filled in resolve.
2122                 Node::ImplItem(impl_item) => {
2123                     match tcx.hir().get(tcx.hir().get_parent_item(hir_id)) {
2124                         Node::Item(hir::Item {
2125                             kind: hir::ItemKind::Impl(hir::Impl { of_trait: Some(tr), .. }),
2126                             ..
2127                         }) => tr.path.res.opt_def_id().map_or_else(
2128                             || {
2129                                 tcx.sess.delay_span_bug(tr.path.span, "trait without a def-id");
2130                                 ty::Visibility::Public
2131                             },
2132                             |def_id| tcx.visibility(def_id),
2133                         ),
2134                         _ => span_bug!(impl_item.span, "the parent is not a trait impl"),
2135                     }
2136                 }
2137                 _ => span_bug!(
2138                     tcx.def_span(def_id),
2139                     "visibility table unexpectedly missing a def-id: {:?}",
2140                     def_id,
2141                 ),
2142             }
2143         }
2144     }
2145 }
2146
2147 fn check_mod_privacy(tcx: TyCtxt<'_>, module_def_id: LocalDefId) {
2148     // Check privacy of names not checked in previous compilation stages.
2149     let mut visitor =
2150         NamePrivacyVisitor { tcx, maybe_typeck_results: None, current_item: module_def_id };
2151     let (module, span, hir_id) = tcx.hir().get_module(module_def_id);
2152
2153     intravisit::walk_mod(&mut visitor, module, hir_id);
2154
2155     // Check privacy of explicitly written types and traits as well as
2156     // inferred types of expressions and patterns.
2157     let mut visitor =
2158         TypePrivacyVisitor { tcx, maybe_typeck_results: None, current_item: module_def_id, span };
2159     intravisit::walk_mod(&mut visitor, module, hir_id);
2160 }
2161
2162 fn privacy_access_levels(tcx: TyCtxt<'_>, (): ()) -> &AccessLevels {
2163     // Build up a set of all exported items in the AST. This is a set of all
2164     // items which are reachable from external crates based on visibility.
2165     let mut visitor = EmbargoVisitor {
2166         tcx,
2167         access_levels: Default::default(),
2168         macro_reachable: Default::default(),
2169         prev_level: Some(AccessLevel::Public),
2170         changed: false,
2171     };
2172     loop {
2173         tcx.hir().walk_toplevel_module(&mut visitor);
2174         if visitor.changed {
2175             visitor.changed = false;
2176         } else {
2177             break;
2178         }
2179     }
2180     visitor.update(CRATE_DEF_ID, Some(AccessLevel::Public));
2181
2182     tcx.arena.alloc(visitor.access_levels)
2183 }
2184
2185 fn check_private_in_public(tcx: TyCtxt<'_>, (): ()) {
2186     let access_levels = tcx.privacy_access_levels(());
2187
2188     let krate = tcx.hir().krate();
2189
2190     let mut visitor = ObsoleteVisiblePrivateTypesVisitor {
2191         tcx,
2192         access_levels: &access_levels,
2193         in_variant: false,
2194         old_error_set: Default::default(),
2195     };
2196     tcx.hir().walk_toplevel_module(&mut visitor);
2197
2198     let has_pub_restricted = {
2199         let mut pub_restricted_visitor = PubRestrictedVisitor { tcx, has_pub_restricted: false };
2200         tcx.hir().walk_toplevel_module(&mut pub_restricted_visitor);
2201         pub_restricted_visitor.has_pub_restricted
2202     };
2203
2204     let mut old_error_set_ancestry = HirIdSet::default();
2205     for mut id in visitor.old_error_set.iter().copied() {
2206         loop {
2207             if !old_error_set_ancestry.insert(id) {
2208                 break;
2209             }
2210             let parent = tcx.hir().get_parent_node(id);
2211             if parent == id {
2212                 break;
2213             }
2214             id = parent;
2215         }
2216     }
2217
2218     // Check for private types and traits in public interfaces.
2219     let mut visitor = PrivateItemsInPublicInterfacesVisitor {
2220         tcx,
2221         has_pub_restricted,
2222         // Only definition IDs are ever searched in `old_error_set_ancestry`,
2223         // so we can filter away all non-definition IDs at this point.
2224         old_error_set_ancestry: old_error_set_ancestry
2225             .into_iter()
2226             .filter_map(|hir_id| tcx.hir().opt_local_def_id(hir_id))
2227             .collect(),
2228     };
2229     krate.visit_all_item_likes(&mut DeepVisitor::new(&mut visitor));
2230 }