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