src/librustc_privacy/lib.rs

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