1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
2 #![feature(in_band_lifetimes)]
4 #![recursion_limit = "256"]
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};
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 syntax::ast::Ident;
25 use syntax::symbol::{kw, sym};
26 use syntax_pos::hygiene::Transparency;
29 use std::marker::PhantomData;
30 use std::{cmp, fmt, mem};
32 use rustc_error_codes::*;
34 ////////////////////////////////////////////////////////////////////////////////
35 /// Generic infrastructure used to implement specific visitors below.
36 ////////////////////////////////////////////////////////////////////////////////
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 {
51 fn skip_assoc_tys(&self) -> bool {
54 fn visit_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool;
56 /// Not overridden, but used to actually visit types and traits.
57 fn skeleton(&mut self) -> DefIdVisitorSkeleton<'_, 'tcx, Self> {
58 DefIdVisitorSkeleton {
60 visited_opaque_tys: Default::default(),
61 dummy: Default::default(),
64 fn visit(&mut self, ty_fragment: impl TypeFoldable<'tcx>) -> bool {
65 ty_fragment.visit_with(&mut self.skeleton())
67 fn visit_trait(&mut self, trait_ref: TraitRef<'tcx>) -> bool {
68 self.skeleton().visit_trait(trait_ref)
70 fn visit_predicates(&mut self, predicates: ty::GenericPredicates<'tcx>) -> bool {
71 self.skeleton().visit_predicates(predicates)
75 struct DefIdVisitorSkeleton<'v, 'tcx, V>
77 V: DefIdVisitor<'tcx> + ?Sized,
79 def_id_visitor: &'v mut V,
80 visited_opaque_tys: FxHashSet<DefId>,
81 dummy: PhantomData<TyCtxt<'tcx>>,
84 impl<'tcx, V> DefIdVisitorSkeleton<'_, 'tcx, V>
86 V: DefIdVisitor<'tcx> + ?Sized,
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))
94 fn visit_predicates(&mut self, predicates: ty::GenericPredicates<'tcx>) -> bool {
95 let ty::GenericPredicates { parent: _, predicates } = predicates;
96 for (predicate, _span) in predicates {
98 ty::Predicate::Trait(poly_predicate) => {
99 let ty::TraitPredicate { trait_ref } = *poly_predicate.skip_binder();
100 if self.visit_trait(trait_ref) {
104 ty::Predicate::Projection(poly_predicate) => {
105 let ty::ProjectionPredicate { projection_ty, ty } =
106 *poly_predicate.skip_binder();
107 if ty.visit_with(self) {
110 if self.visit_trait(projection_ty.trait_ref(self.def_id_visitor.tcx())) {
114 ty::Predicate::TypeOutlives(poly_predicate) => {
115 let ty::OutlivesPredicate(ty, _region) = *poly_predicate.skip_binder();
116 if ty.visit_with(self) {
120 ty::Predicate::RegionOutlives(..) => {}
121 _ => bug!("unexpected predicate: {:?}", predicate),
128 impl<'tcx, V> TypeVisitor<'tcx> for DefIdVisitorSkeleton<'_, 'tcx, V>
130 V: DefIdVisitor<'tcx> + ?Sized,
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`.
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) {
144 if self.def_id_visitor.shallow() {
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) {
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) {
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.
176 // This will also visit substs if necessary, so we don't need to recurse.
177 return self.visit_trait(proj.trait_ref(tcx));
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() }
190 let ty::ExistentialTraitRef { def_id, substs: _ } = trait_ref;
191 if self.def_id_visitor.visit_def_id(def_id, "trait", &trait_ref) {
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)) {
211 // These types don't have their own def-ids (but may have subcomponents
212 // with def-ids that should be visited recursively).
228 | ty::GeneratorWitness(..) => {}
229 ty::Bound(..) | ty::Placeholder(..) | ty::Infer(..) => {
230 bug!("unexpected type: {:?}", ty)
234 !self.def_id_visitor.shallow() && ty.super_visit_with(self)
238 fn def_id_visibility<'tcx>(
241 ) -> (ty::Visibility, Span, &'static str) {
242 match tcx.hir().as_local_hir_id(def_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(¯o_def.attrs, sym::macro_export) {
249 return (ty::Visibility::Public, macro_def.span, "public");
254 Node::TraitItem(..) | Node::Variant(..) => {
255 return def_id_visibility(tcx, tcx.hir().get_parent_did(hir_id));
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());
264 kind => bug!("unexpected item kind: {:?}", kind),
266 node => bug!("unexpected node kind: {:?}", node),
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);
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);
281 if variant.is_field_list_non_exhaustive()
282 && ctor_vis == ty::Visibility::Public
285 ty::Visibility::Restricted(DefId::local(CRATE_DEF_INDEX));
286 let attrs = tcx.get_attrs(variant.def_id);
288 attr::find_by_name(&attrs, sym::non_exhaustive).unwrap().span;
289 descr = "crate-visible";
292 return (ctor_vis, span, descr);
295 let item = match tcx.hir().get(parent_hir_id) {
296 Node::Item(item) => item,
297 node => bug!("unexpected node kind: {:?}", node),
299 let (mut ctor_vis, mut span, mut descr) = (
300 ty::Visibility::from_hir(&item.vis, parent_hir_id, tcx),
302 item.vis.node.descr(),
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();
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() {
319 ty::Visibility::Restricted(DefId::local(CRATE_DEF_INDEX));
320 span = attr::find_by_name(&item.attrs, sym::non_exhaustive)
323 descr = "crate-visible";
327 return (ctor_vis, span, descr);
329 node => bug!("unexpected node kind: {:?}", node),
332 Node::Expr(expr) => {
334 ty::Visibility::Restricted(tcx.hir().get_module_parent(expr.hir_id)),
339 node => bug!("unexpected node kind: {:?}", node),
341 (ty::Visibility::from_hir(vis, hir_id, tcx), vis.span, vis.node.descr())
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)
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>(
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 }
362 fn min(vis1: ty::Visibility, vis2: ty::Visibility, tcx: TyCtxt<'_>) -> ty::Visibility {
363 if vis1.is_at_least(vis2, tcx) { vis2 } else { vis1 }
366 ////////////////////////////////////////////////////////////////////////////////
367 /// Visitor used to determine if pub(restricted) is used anywhere in the crate.
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> {
374 has_pub_restricted: bool,
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())
381 fn visit_vis(&mut self, vis: &'tcx hir::Visibility) {
382 self.has_pub_restricted = self.has_pub_restricted || vis.node.is_pub_restricted();
386 ////////////////////////////////////////////////////////////////////////////////
387 /// Visitor used to determine impl visibility and reachability.
388 ////////////////////////////////////////////////////////////////////////////////
390 struct FindMin<'a, 'tcx, VL: VisibilityLike> {
392 access_levels: &'a AccessLevels,
396 impl<'a, 'tcx, VL: VisibilityLike> DefIdVisitor<'tcx> for FindMin<'a, 'tcx, VL> {
397 fn tcx(&self) -> TyCtxt<'tcx> {
400 fn shallow(&self) -> bool {
403 fn skip_assoc_tys(&self) -> bool {
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);
412 trait VisibilityLike: Sized {
414 const SHALLOW: bool = false;
415 fn new_min(find: &FindMin<'_, '_, Self>, def_id: DefId) -> Self;
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);
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)
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.
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 {
449 if let Some(hir_id) = find.tcx.hir().as_local_hir_id(def_id) {
450 find.access_levels.map.get(&hir_id).cloned()
459 ////////////////////////////////////////////////////////////////////////////////
460 /// The embargo visitor, used to determine the exports of the AST.
461 ////////////////////////////////////////////////////////////////////////////////
463 struct EmbargoVisitor<'tcx> {
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:
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`
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?
487 struct ReachEverythingInTheInterfaceVisitor<'a, 'tcx> {
488 access_level: Option<AccessLevel>,
490 ev: &'a mut EmbargoVisitor<'tcx>,
493 impl EmbargoVisitor<'tcx> {
494 fn get(&self, id: hir::HirId) -> Option<AccessLevel> {
495 self.access_levels.map.get(&id).cloned()
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());
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),
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);
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);
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);
560 fn update_macro_reachable_def(
567 let level = Some(AccessLevel::Reachable);
568 if let ty::Visibility::Public = vis {
569 self.update(hir_id, level);
572 // No type privacy, so can be directly marked as reachable.
576 | DefKind::TraitAlias
577 | DefKind::TyAlias => {
578 if vis.is_accessible_from(module, self.tcx) {
579 self.update(hir_id, level);
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.
588 if vis.is_accessible_from(module, self.tcx) {
589 self.update_macro_reachable(hir_id, module);
593 DefKind::Struct | DefKind::Union => {
594 // While structs and unions have type privacy, their fields do
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
601 for field in struct_def.fields() {
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();
609 bug!("item {:?} with DefKind {:?}", item, def_kind);
614 // These have type privacy, so are not reachable unless they're
618 | DefKind::AssocOpaqueTy
619 | DefKind::ConstParam
620 | DefKind::Ctor(_, _)
628 | DefKind::Variant => (),
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`.
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.
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.
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(&mut self, segments: &[hir::PathSegment]) {
648 if let Some([module, segment]) = segments.rchunks_exact(2).next() {
649 if let Some(item) = module
651 .and_then(|res| res.mod_def_id())
652 .and_then(|def_id| self.tcx.hir().as_local_hir_id(def_id))
653 .map(|module_hir_id| self.tcx.hir().expect_item(module_hir_id))
655 if let hir::ItemKind::Mod(m) = &item.kind {
656 for item_id in m.item_ids.as_ref() {
657 let item = self.tcx.hir().expect_item(item_id.id);
658 let def_id = self.tcx.hir().local_def_id(item_id.id);
659 if !self.tcx.hygienic_eq(segment.ident, item.ident, def_id) {
662 if let hir::ItemKind::Use(..) = item.kind {
663 self.update(item.hir_id, Some(AccessLevel::Exported));
672 impl Visitor<'tcx> for EmbargoVisitor<'tcx> {
673 /// We want to visit items in the context of their containing
674 /// module and so forth, so supply a crate for doing a deep walk.
675 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
676 NestedVisitorMap::All(&self.tcx.hir())
679 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
680 let inherited_item_level = match item.kind {
681 hir::ItemKind::Impl(..) => {
682 Option::<AccessLevel>::of_impl(item.hir_id, self.tcx, &self.access_levels)
684 // Foreign modules inherit level from parents.
685 hir::ItemKind::ForeignMod(..) => self.prev_level,
686 // Other `pub` items inherit levels from parents.
687 hir::ItemKind::Const(..)
688 | hir::ItemKind::Enum(..)
689 | hir::ItemKind::ExternCrate(..)
690 | hir::ItemKind::GlobalAsm(..)
691 | hir::ItemKind::Fn(..)
692 | hir::ItemKind::Mod(..)
693 | hir::ItemKind::Static(..)
694 | hir::ItemKind::Struct(..)
695 | hir::ItemKind::Trait(..)
696 | hir::ItemKind::TraitAlias(..)
697 | hir::ItemKind::OpaqueTy(..)
698 | hir::ItemKind::TyAlias(..)
699 | hir::ItemKind::Union(..)
700 | hir::ItemKind::Use(..) => {
701 if item.vis.node.is_pub() {
709 // Update level of the item itself.
710 let item_level = self.update(item.hir_id, inherited_item_level);
712 // Update levels of nested things.
714 hir::ItemKind::Enum(ref def, _) => {
715 for variant in def.variants {
716 let variant_level = self.update(variant.id, item_level);
717 if let Some(ctor_hir_id) = variant.data.ctor_hir_id() {
718 self.update(ctor_hir_id, item_level);
720 for field in variant.data.fields() {
721 self.update(field.hir_id, variant_level);
725 hir::ItemKind::Impl(.., ref trait_ref, _, impl_item_refs) => {
726 for impl_item_ref in impl_item_refs {
727 if trait_ref.is_some() || impl_item_ref.vis.node.is_pub() {
728 self.update(impl_item_ref.id.hir_id, item_level);
732 hir::ItemKind::Trait(.., trait_item_refs) => {
733 for trait_item_ref in trait_item_refs {
734 self.update(trait_item_ref.id.hir_id, item_level);
737 hir::ItemKind::Struct(ref def, _) | hir::ItemKind::Union(ref def, _) => {
738 if let Some(ctor_hir_id) = def.ctor_hir_id() {
739 self.update(ctor_hir_id, item_level);
741 for field in def.fields() {
742 if field.vis.node.is_pub() {
743 self.update(field.hir_id, item_level);
747 hir::ItemKind::ForeignMod(ref foreign_mod) => {
748 for foreign_item in foreign_mod.items {
749 if foreign_item.vis.node.is_pub() {
750 self.update(foreign_item.hir_id, item_level);
754 hir::ItemKind::OpaqueTy(..)
755 | hir::ItemKind::Use(..)
756 | hir::ItemKind::Static(..)
757 | hir::ItemKind::Const(..)
758 | hir::ItemKind::GlobalAsm(..)
759 | hir::ItemKind::TyAlias(..)
760 | hir::ItemKind::Mod(..)
761 | hir::ItemKind::TraitAlias(..)
762 | hir::ItemKind::Fn(..)
763 | hir::ItemKind::ExternCrate(..) => {}
766 // Mark all items in interfaces of reachable items as reachable.
768 // The interface is empty.
769 hir::ItemKind::ExternCrate(..) => {}
770 // All nested items are checked by `visit_item`.
771 hir::ItemKind::Mod(..) => {}
772 // Re-exports are handled in `visit_mod`. However, in order to avoid looping over
773 // all of the items of a mod in `visit_mod` looking for use statements, we handle
774 // making sure that intermediate use statements have their visibilities updated here.
775 hir::ItemKind::Use(ref path, _) => {
776 if item_level.is_some() {
777 self.update_visibility_of_intermediate_use_statements(path.segments.as_ref());
780 // The interface is empty.
781 hir::ItemKind::GlobalAsm(..) => {}
782 hir::ItemKind::OpaqueTy(..) => {
783 // FIXME: This is some serious pessimization intended to workaround deficiencies
784 // in the reachability pass (`middle/reachable.rs`). Types are marked as link-time
785 // reachable if they are returned via `impl Trait`, even from private functions.
786 let exist_level = cmp::max(item_level, Some(AccessLevel::ReachableFromImplTrait));
787 self.reach(item.hir_id, exist_level).generics().predicates().ty();
790 hir::ItemKind::Const(..)
791 | hir::ItemKind::Static(..)
792 | hir::ItemKind::Fn(..)
793 | hir::ItemKind::TyAlias(..) => {
794 if item_level.is_some() {
795 self.reach(item.hir_id, item_level).generics().predicates().ty();
798 hir::ItemKind::Trait(.., trait_item_refs) => {
799 if item_level.is_some() {
800 self.reach(item.hir_id, item_level).generics().predicates();
802 for trait_item_ref in trait_item_refs {
803 let mut reach = self.reach(trait_item_ref.id.hir_id, item_level);
804 reach.generics().predicates();
806 if trait_item_ref.kind == AssocItemKind::Type
807 && !trait_item_ref.defaultness.has_value()
816 hir::ItemKind::TraitAlias(..) => {
817 if item_level.is_some() {
818 self.reach(item.hir_id, item_level).generics().predicates();
821 // Visit everything except for private impl items.
822 hir::ItemKind::Impl(.., impl_item_refs) => {
823 if item_level.is_some() {
824 self.reach(item.hir_id, item_level).generics().predicates().ty().trait_ref();
826 for impl_item_ref in impl_item_refs {
827 let impl_item_level = self.get(impl_item_ref.id.hir_id);
828 if impl_item_level.is_some() {
829 self.reach(impl_item_ref.id.hir_id, impl_item_level)
838 // Visit everything, but enum variants have their own levels.
839 hir::ItemKind::Enum(ref def, _) => {
840 if item_level.is_some() {
841 self.reach(item.hir_id, item_level).generics().predicates();
843 for variant in def.variants {
844 let variant_level = self.get(variant.id);
845 if variant_level.is_some() {
846 for field in variant.data.fields() {
847 self.reach(field.hir_id, variant_level).ty();
849 // Corner case: if the variant is reachable, but its
850 // enum is not, make the enum reachable as well.
851 self.update(item.hir_id, variant_level);
855 // Visit everything, but foreign items have their own levels.
856 hir::ItemKind::ForeignMod(ref foreign_mod) => {
857 for foreign_item in foreign_mod.items {
858 let foreign_item_level = self.get(foreign_item.hir_id);
859 if foreign_item_level.is_some() {
860 self.reach(foreign_item.hir_id, foreign_item_level)
867 // Visit everything except for private fields.
868 hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
869 if item_level.is_some() {
870 self.reach(item.hir_id, item_level).generics().predicates();
871 for field in struct_def.fields() {
872 let field_level = self.get(field.hir_id);
873 if field_level.is_some() {
874 self.reach(field.hir_id, field_level).ty();
881 let orig_level = mem::replace(&mut self.prev_level, item_level);
882 intravisit::walk_item(self, item);
883 self.prev_level = orig_level;
886 fn visit_block(&mut self, b: &'tcx hir::Block<'tcx>) {
887 // Blocks can have public items, for example impls, but they always
888 // start as completely private regardless of publicity of a function,
889 // constant, type, field, etc., in which this block resides.
890 let orig_level = mem::replace(&mut self.prev_level, None);
891 intravisit::walk_block(self, b);
892 self.prev_level = orig_level;
895 fn visit_mod(&mut self, m: &'tcx hir::Mod<'tcx>, _sp: Span, id: hir::HirId) {
896 // This code is here instead of in visit_item so that the
897 // crate module gets processed as well.
898 if self.prev_level.is_some() {
899 let def_id = self.tcx.hir().local_def_id(id);
900 if let Some(exports) = self.tcx.module_exports(def_id) {
901 for export in exports.iter() {
902 if export.vis == ty::Visibility::Public {
903 if let Some(def_id) = export.res.opt_def_id() {
904 if let Some(hir_id) = self.tcx.hir().as_local_hir_id(def_id) {
905 self.update(hir_id, Some(AccessLevel::Exported));
913 intravisit::walk_mod(self, m, id);
916 fn visit_macro_def(&mut self, md: &'tcx hir::MacroDef<'tcx>) {
917 if attr::find_transparency(&md.attrs, md.legacy).0 != Transparency::Opaque {
918 self.update(md.hir_id, Some(AccessLevel::Public));
922 let macro_module_def_id =
923 ty::DefIdTree::parent(self.tcx, self.tcx.hir().local_def_id(md.hir_id)).unwrap();
924 let mut module_id = match self.tcx.hir().as_local_hir_id(macro_module_def_id) {
925 Some(module_id) if self.tcx.hir().is_hir_id_module(module_id) => module_id,
926 // `module_id` doesn't correspond to a `mod`, return early (#63164, #65252).
929 let level = if md.vis.node.is_pub() { self.get(module_id) } else { None };
930 let new_level = self.update(md.hir_id, level);
931 if new_level.is_none() {
936 let changed_reachability = self.update_macro_reachable(module_id, macro_module_def_id);
937 if changed_reachability || module_id == hir::CRATE_HIR_ID {
940 module_id = self.tcx.hir().get_parent_node(module_id);
945 impl ReachEverythingInTheInterfaceVisitor<'_, 'tcx> {
946 fn generics(&mut self) -> &mut Self {
947 for param in &self.ev.tcx.generics_of(self.item_def_id).params {
949 GenericParamDefKind::Lifetime => {}
950 GenericParamDefKind::Type { has_default, .. } => {
952 self.visit(self.ev.tcx.type_of(param.def_id));
955 GenericParamDefKind::Const => {
956 self.visit(self.ev.tcx.type_of(param.def_id));
963 fn predicates(&mut self) -> &mut Self {
964 self.visit_predicates(self.ev.tcx.predicates_of(self.item_def_id));
968 fn ty(&mut self) -> &mut Self {
969 self.visit(self.ev.tcx.type_of(self.item_def_id));
973 fn trait_ref(&mut self) -> &mut Self {
974 if let Some(trait_ref) = self.ev.tcx.impl_trait_ref(self.item_def_id) {
975 self.visit_trait(trait_ref);
981 impl DefIdVisitor<'tcx> for ReachEverythingInTheInterfaceVisitor<'_, 'tcx> {
982 fn tcx(&self) -> TyCtxt<'tcx> {
985 fn visit_def_id(&mut self, def_id: DefId, _kind: &str, _descr: &dyn fmt::Display) -> bool {
986 if let Some(hir_id) = self.ev.tcx.hir().as_local_hir_id(def_id) {
987 if let ((ty::Visibility::Public, ..), _)
988 | (_, Some(AccessLevel::ReachableFromImplTrait)) =
989 (def_id_visibility(self.tcx(), def_id), self.access_level)
991 self.ev.update(hir_id, self.access_level);
998 //////////////////////////////////////////////////////////////////////////////////////
999 /// Name privacy visitor, checks privacy and reports violations.
1000 /// Most of name privacy checks are performed during the main resolution phase,
1001 /// or later in type checking when field accesses and associated items are resolved.
1002 /// This pass performs remaining checks for fields in struct expressions and patterns.
1003 //////////////////////////////////////////////////////////////////////////////////////
1005 struct NamePrivacyVisitor<'a, 'tcx> {
1007 tables: &'a ty::TypeckTables<'tcx>,
1008 current_item: hir::HirId,
1009 empty_tables: &'a ty::TypeckTables<'tcx>,
1012 impl<'a, 'tcx> NamePrivacyVisitor<'a, 'tcx> {
1013 // Checks that a field in a struct constructor (expression or pattern) is accessible.
1016 use_ctxt: Span, // syntax context of the field name at the use site
1017 span: Span, // span of the field pattern, e.g., `x: 0`
1018 def: &'tcx ty::AdtDef, // definition of the struct or enum
1019 field: &'tcx ty::FieldDef,
1021 // definition of the field
1022 let ident = Ident::new(kw::Invalid, use_ctxt);
1023 let current_hir = self.current_item;
1024 let def_id = self.tcx.adjust_ident_and_get_scope(ident, def.did, current_hir).1;
1025 if !def.is_enum() && !field.vis.is_accessible_from(def_id, self.tcx) {
1030 "field `{}` of {} `{}` is private",
1032 def.variant_descr(),
1033 self.tcx.def_path_str(def.did)
1035 .span_label(span, format!("field `{}` is private", field.ident))
1041 impl<'a, 'tcx> Visitor<'tcx> for NamePrivacyVisitor<'a, 'tcx> {
1042 /// We want to visit items in the context of their containing
1043 /// module and so forth, so supply a crate for doing a deep walk.
1044 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1045 NestedVisitorMap::All(&self.tcx.hir())
1048 fn visit_mod(&mut self, _m: &'tcx hir::Mod<'tcx>, _s: Span, _n: hir::HirId) {
1049 // Don't visit nested modules, since we run a separate visitor walk
1050 // for each module in `privacy_access_levels`
1053 fn visit_nested_body(&mut self, body: hir::BodyId) {
1054 let orig_tables = mem::replace(&mut self.tables, self.tcx.body_tables(body));
1055 let body = self.tcx.hir().body(body);
1056 self.visit_body(body);
1057 self.tables = orig_tables;
1060 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1061 let orig_current_item = mem::replace(&mut self.current_item, item.hir_id);
1063 mem::replace(&mut self.tables, item_tables(self.tcx, item.hir_id, self.empty_tables));
1064 intravisit::walk_item(self, item);
1065 self.current_item = orig_current_item;
1066 self.tables = orig_tables;
1069 fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem<'tcx>) {
1071 mem::replace(&mut self.tables, item_tables(self.tcx, ti.hir_id, self.empty_tables));
1072 intravisit::walk_trait_item(self, ti);
1073 self.tables = orig_tables;
1076 fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem<'tcx>) {
1078 mem::replace(&mut self.tables, item_tables(self.tcx, ii.hir_id, self.empty_tables));
1079 intravisit::walk_impl_item(self, ii);
1080 self.tables = orig_tables;
1083 fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
1085 hir::ExprKind::Struct(ref qpath, fields, ref base) => {
1086 let res = self.tables.qpath_res(qpath, expr.hir_id);
1087 let adt = self.tables.expr_ty(expr).ty_adt_def().unwrap();
1088 let variant = adt.variant_of_res(res);
1089 if let Some(ref base) = *base {
1090 // If the expression uses FRU we need to make sure all the unmentioned fields
1091 // are checked for privacy (RFC 736). Rather than computing the set of
1092 // unmentioned fields, just check them all.
1093 for (vf_index, variant_field) in variant.fields.iter().enumerate() {
1096 .find(|f| self.tcx.field_index(f.hir_id, self.tables) == vf_index);
1097 let (use_ctxt, span) = match field {
1098 Some(field) => (field.ident.span, field.span),
1099 None => (base.span, base.span),
1101 self.check_field(use_ctxt, span, adt, variant_field);
1104 for field in fields {
1105 let use_ctxt = field.ident.span;
1106 let index = self.tcx.field_index(field.hir_id, self.tables);
1107 self.check_field(use_ctxt, field.span, adt, &variant.fields[index]);
1114 intravisit::walk_expr(self, expr);
1117 fn visit_pat(&mut self, pat: &'tcx hir::Pat<'tcx>) {
1119 PatKind::Struct(ref qpath, fields, _) => {
1120 let res = self.tables.qpath_res(qpath, pat.hir_id);
1121 let adt = self.tables.pat_ty(pat).ty_adt_def().unwrap();
1122 let variant = adt.variant_of_res(res);
1123 for field in fields {
1124 let use_ctxt = field.ident.span;
1125 let index = self.tcx.field_index(field.hir_id, self.tables);
1126 self.check_field(use_ctxt, field.span, adt, &variant.fields[index]);
1132 intravisit::walk_pat(self, pat);
1136 ////////////////////////////////////////////////////////////////////////////////////////////
1137 /// Type privacy visitor, checks types for privacy and reports violations.
1138 /// Both explicitly written types and inferred types of expressions and patters are checked.
1139 /// Checks are performed on "semantic" types regardless of names and their hygiene.
1140 ////////////////////////////////////////////////////////////////////////////////////////////
1142 struct TypePrivacyVisitor<'a, 'tcx> {
1144 tables: &'a ty::TypeckTables<'tcx>,
1145 current_item: DefId,
1148 empty_tables: &'a ty::TypeckTables<'tcx>,
1151 impl<'a, 'tcx> TypePrivacyVisitor<'a, 'tcx> {
1152 fn item_is_accessible(&self, did: DefId) -> bool {
1153 def_id_visibility(self.tcx, did).0.is_accessible_from(self.current_item, self.tcx)
1156 // Take node-id of an expression or pattern and check its type for privacy.
1157 fn check_expr_pat_type(&mut self, id: hir::HirId, span: Span) -> bool {
1159 if self.visit(self.tables.node_type(id)) || self.visit(self.tables.node_substs(id)) {
1162 if let Some(adjustments) = self.tables.adjustments().get(id) {
1163 for adjustment in adjustments {
1164 if self.visit(adjustment.target) {
1172 fn check_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1173 let is_error = !self.item_is_accessible(def_id);
1175 self.tcx.sess.span_err(self.span, &format!("{} `{}` is private", kind, descr));
1181 impl<'a, 'tcx> Visitor<'tcx> for TypePrivacyVisitor<'a, 'tcx> {
1182 /// We want to visit items in the context of their containing
1183 /// module and so forth, so supply a crate for doing a deep walk.
1184 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1185 NestedVisitorMap::All(&self.tcx.hir())
1188 fn visit_mod(&mut self, _m: &'tcx hir::Mod<'tcx>, _s: Span, _n: hir::HirId) {
1189 // Don't visit nested modules, since we run a separate visitor walk
1190 // for each module in `privacy_access_levels`
1193 fn visit_nested_body(&mut self, body: hir::BodyId) {
1194 let orig_tables = mem::replace(&mut self.tables, self.tcx.body_tables(body));
1195 let orig_in_body = mem::replace(&mut self.in_body, true);
1196 let body = self.tcx.hir().body(body);
1197 self.visit_body(body);
1198 self.tables = orig_tables;
1199 self.in_body = orig_in_body;
1202 fn visit_ty(&mut self, hir_ty: &'tcx hir::Ty) {
1203 self.span = hir_ty.span;
1206 if self.visit(self.tables.node_type(hir_ty.hir_id)) {
1210 // Types in signatures.
1211 // FIXME: This is very ineffective. Ideally each HIR type should be converted
1212 // into a semantic type only once and the result should be cached somehow.
1213 if self.visit(rustc_typeck::hir_ty_to_ty(self.tcx, hir_ty)) {
1218 intravisit::walk_ty(self, hir_ty);
1221 fn visit_trait_ref(&mut self, trait_ref: &'tcx hir::TraitRef) {
1222 self.span = trait_ref.path.span;
1224 // Avoid calling `hir_trait_to_predicates` in bodies, it will ICE.
1225 // The traits' privacy in bodies is already checked as a part of trait object types.
1226 let bounds = rustc_typeck::hir_trait_to_predicates(self.tcx, trait_ref);
1228 for (trait_predicate, _) in bounds.trait_bounds {
1229 if self.visit_trait(*trait_predicate.skip_binder()) {
1234 for (poly_predicate, _) in bounds.projection_bounds {
1236 if self.visit(poly_predicate.skip_binder().ty)
1237 || self.visit_trait(poly_predicate.skip_binder().projection_ty.trait_ref(tcx))
1244 intravisit::walk_trait_ref(self, trait_ref);
1247 // Check types of expressions
1248 fn visit_expr(&mut self, expr: &'tcx hir::Expr<'tcx>) {
1249 if self.check_expr_pat_type(expr.hir_id, expr.span) {
1250 // Do not check nested expressions if the error already happened.
1254 hir::ExprKind::Assign(_, ref rhs, _) | hir::ExprKind::Match(ref rhs, ..) => {
1255 // Do not report duplicate errors for `x = y` and `match x { ... }`.
1256 if self.check_expr_pat_type(rhs.hir_id, rhs.span) {
1260 hir::ExprKind::MethodCall(_, span, _) => {
1261 // Method calls have to be checked specially.
1263 if let Some(def_id) = self.tables.type_dependent_def_id(expr.hir_id) {
1264 if self.visit(self.tcx.type_of(def_id)) {
1270 .delay_span_bug(expr.span, "no type-dependent def for method call");
1276 intravisit::walk_expr(self, expr);
1279 // Prohibit access to associated items with insufficient nominal visibility.
1281 // Additionally, until better reachability analysis for macros 2.0 is available,
1282 // we prohibit access to private statics from other crates, this allows to give
1283 // more code internal visibility at link time. (Access to private functions
1284 // is already prohibited by type privacy for function types.)
1285 fn visit_qpath(&mut self, qpath: &'tcx hir::QPath, id: hir::HirId, span: Span) {
1286 let def = match self.tables.qpath_res(qpath, id) {
1287 Res::Def(kind, def_id) => Some((kind, def_id)),
1290 let def = def.filter(|(kind, _)| match kind {
1292 | DefKind::AssocConst
1294 | DefKind::AssocOpaqueTy
1295 | DefKind::Static => true,
1298 if let Some((kind, def_id)) = def {
1299 let is_local_static =
1300 if let DefKind::Static = kind { def_id.is_local() } else { false };
1301 if !self.item_is_accessible(def_id) && !is_local_static {
1302 let name = match *qpath {
1303 hir::QPath::Resolved(_, ref path) => path.to_string(),
1304 hir::QPath::TypeRelative(_, ref segment) => segment.ident.to_string(),
1306 let msg = format!("{} `{}` is private", kind.descr(def_id), name);
1307 self.tcx.sess.span_err(span, &msg);
1312 intravisit::walk_qpath(self, qpath, id, span);
1315 // Check types of patterns.
1316 fn visit_pat(&mut self, pattern: &'tcx hir::Pat<'tcx>) {
1317 if self.check_expr_pat_type(pattern.hir_id, pattern.span) {
1318 // Do not check nested patterns if the error already happened.
1322 intravisit::walk_pat(self, pattern);
1325 fn visit_local(&mut self, local: &'tcx hir::Local<'tcx>) {
1326 if let Some(ref init) = local.init {
1327 if self.check_expr_pat_type(init.hir_id, init.span) {
1328 // Do not report duplicate errors for `let x = y`.
1333 intravisit::walk_local(self, local);
1336 // Check types in item interfaces.
1337 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1338 let orig_current_item =
1339 mem::replace(&mut self.current_item, self.tcx.hir().local_def_id(item.hir_id));
1340 let orig_in_body = mem::replace(&mut self.in_body, false);
1342 mem::replace(&mut self.tables, item_tables(self.tcx, item.hir_id, self.empty_tables));
1343 intravisit::walk_item(self, item);
1344 self.tables = orig_tables;
1345 self.in_body = orig_in_body;
1346 self.current_item = orig_current_item;
1349 fn visit_trait_item(&mut self, ti: &'tcx hir::TraitItem<'tcx>) {
1351 mem::replace(&mut self.tables, item_tables(self.tcx, ti.hir_id, self.empty_tables));
1352 intravisit::walk_trait_item(self, ti);
1353 self.tables = orig_tables;
1356 fn visit_impl_item(&mut self, ii: &'tcx hir::ImplItem<'tcx>) {
1358 mem::replace(&mut self.tables, item_tables(self.tcx, ii.hir_id, self.empty_tables));
1359 intravisit::walk_impl_item(self, ii);
1360 self.tables = orig_tables;
1364 impl DefIdVisitor<'tcx> for TypePrivacyVisitor<'a, 'tcx> {
1365 fn tcx(&self) -> TyCtxt<'tcx> {
1368 fn visit_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1369 self.check_def_id(def_id, kind, descr)
1373 ///////////////////////////////////////////////////////////////////////////////
1374 /// Obsolete visitors for checking for private items in public interfaces.
1375 /// These visitors are supposed to be kept in frozen state and produce an
1376 /// "old error node set". For backward compatibility the new visitor reports
1377 /// warnings instead of hard errors when the erroneous node is not in this old set.
1378 ///////////////////////////////////////////////////////////////////////////////
1380 struct ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1382 access_levels: &'a AccessLevels,
1384 // Set of errors produced by this obsolete visitor.
1385 old_error_set: HirIdSet,
1388 struct ObsoleteCheckTypeForPrivatenessVisitor<'a, 'b, 'tcx> {
1389 inner: &'a ObsoleteVisiblePrivateTypesVisitor<'b, 'tcx>,
1390 /// Whether the type refers to private types.
1391 contains_private: bool,
1392 /// Whether we've recurred at all (i.e., if we're pointing at the
1393 /// first type on which `visit_ty` was called).
1394 at_outer_type: bool,
1395 /// Whether that first type is a public path.
1396 outer_type_is_public_path: bool,
1399 impl<'a, 'tcx> ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1400 fn path_is_private_type(&self, path: &hir::Path) -> bool {
1401 let did = match path.res {
1402 Res::PrimTy(..) | Res::SelfTy(..) | Res::Err => return false,
1403 res => res.def_id(),
1406 // A path can only be private if:
1407 // it's in this crate...
1408 if let Some(hir_id) = self.tcx.hir().as_local_hir_id(did) {
1409 // .. and it corresponds to a private type in the AST (this returns
1410 // `None` for type parameters).
1411 match self.tcx.hir().find(hir_id) {
1412 Some(Node::Item(ref item)) => !item.vis.node.is_pub(),
1413 Some(_) | None => false,
1420 fn trait_is_public(&self, trait_id: hir::HirId) -> bool {
1421 // FIXME: this would preferably be using `exported_items`, but all
1422 // traits are exported currently (see `EmbargoVisitor.exported_trait`).
1423 self.access_levels.is_public(trait_id)
1426 fn check_generic_bound(&mut self, bound: &hir::GenericBound) {
1427 if let hir::GenericBound::Trait(ref trait_ref, _) = *bound {
1428 if self.path_is_private_type(&trait_ref.trait_ref.path) {
1429 self.old_error_set.insert(trait_ref.trait_ref.hir_ref_id);
1434 fn item_is_public(&self, id: &hir::HirId, vis: &hir::Visibility) -> bool {
1435 self.access_levels.is_reachable(*id) || vis.node.is_pub()
1439 impl<'a, 'b, 'tcx, 'v> Visitor<'v> for ObsoleteCheckTypeForPrivatenessVisitor<'a, 'b, 'tcx> {
1440 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'v> {
1441 NestedVisitorMap::None
1444 fn visit_ty(&mut self, ty: &hir::Ty) {
1445 if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = ty.kind {
1446 if self.inner.path_is_private_type(path) {
1447 self.contains_private = true;
1448 // Found what we're looking for, so let's stop working.
1452 if let hir::TyKind::Path(_) = ty.kind {
1453 if self.at_outer_type {
1454 self.outer_type_is_public_path = true;
1457 self.at_outer_type = false;
1458 intravisit::walk_ty(self, ty)
1461 // Don't want to recurse into `[, .. expr]`.
1462 fn visit_expr(&mut self, _: &hir::Expr<'_>) {}
1465 impl<'a, 'tcx> Visitor<'tcx> for ObsoleteVisiblePrivateTypesVisitor<'a, 'tcx> {
1466 /// We want to visit items in the context of their containing
1467 /// module and so forth, so supply a crate for doing a deep walk.
1468 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1469 NestedVisitorMap::All(&self.tcx.hir())
1472 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1474 // Contents of a private mod can be re-exported, so we need
1475 // to check internals.
1476 hir::ItemKind::Mod(_) => {}
1478 // An `extern {}` doesn't introduce a new privacy
1479 // namespace (the contents have their own privacies).
1480 hir::ItemKind::ForeignMod(_) => {}
1482 hir::ItemKind::Trait(.., ref bounds, _) => {
1483 if !self.trait_is_public(item.hir_id) {
1487 for bound in bounds.iter() {
1488 self.check_generic_bound(bound)
1492 // Impls need some special handling to try to offer useful
1493 // error messages without (too many) false positives
1494 // (i.e., we could just return here to not check them at
1495 // all, or some worse estimation of whether an impl is
1496 // publicly visible).
1497 hir::ItemKind::Impl(.., ref g, ref trait_ref, ref self_, impl_item_refs) => {
1498 // `impl [... for] Private` is never visible.
1499 let self_contains_private;
1500 // `impl [... for] Public<...>`, but not `impl [... for]
1501 // Vec<Public>` or `(Public,)`, etc.
1502 let self_is_public_path;
1504 // Check the properties of the `Self` type:
1506 let mut visitor = ObsoleteCheckTypeForPrivatenessVisitor {
1508 contains_private: false,
1509 at_outer_type: true,
1510 outer_type_is_public_path: false,
1512 visitor.visit_ty(&self_);
1513 self_contains_private = visitor.contains_private;
1514 self_is_public_path = visitor.outer_type_is_public_path;
1517 // Miscellaneous info about the impl:
1519 // `true` iff this is `impl Private for ...`.
1520 let not_private_trait = trait_ref.as_ref().map_or(
1521 true, // no trait counts as public trait
1523 let did = tr.path.res.def_id();
1525 if let Some(hir_id) = self.tcx.hir().as_local_hir_id(did) {
1526 self.trait_is_public(hir_id)
1528 true // external traits must be public
1533 // `true` iff this is a trait impl or at least one method is public.
1535 // `impl Public { $( fn ...() {} )* }` is not visible.
1537 // This is required over just using the methods' privacy
1538 // directly because we might have `impl<T: Foo<Private>> ...`,
1539 // and we shouldn't warn about the generics if all the methods
1540 // are private (because `T` won't be visible externally).
1541 let trait_or_some_public_method = trait_ref.is_some()
1542 || impl_item_refs.iter().any(|impl_item_ref| {
1543 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1544 match impl_item.kind {
1545 hir::ImplItemKind::Const(..) | hir::ImplItemKind::Method(..) => {
1546 self.access_levels.is_reachable(impl_item_ref.id.hir_id)
1548 hir::ImplItemKind::OpaqueTy(..) | hir::ImplItemKind::TyAlias(_) => {
1554 if !self_contains_private && not_private_trait && trait_or_some_public_method {
1555 intravisit::walk_generics(self, g);
1559 for impl_item_ref in impl_item_refs {
1560 // This is where we choose whether to walk down
1561 // further into the impl to check its items. We
1562 // should only walk into public items so that we
1563 // don't erroneously report errors for private
1564 // types in private items.
1565 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1566 match impl_item.kind {
1567 hir::ImplItemKind::Const(..)
1568 | hir::ImplItemKind::Method(..)
1570 .item_is_public(&impl_item.hir_id, &impl_item.vis) =>
1572 intravisit::walk_impl_item(self, impl_item)
1574 hir::ImplItemKind::TyAlias(..) => {
1575 intravisit::walk_impl_item(self, impl_item)
1582 // Any private types in a trait impl fall into three
1584 // 1. mentioned in the trait definition
1585 // 2. mentioned in the type params/generics
1586 // 3. mentioned in the associated types of the impl
1588 // Those in 1. can only occur if the trait is in
1589 // this crate and will've been warned about on the
1590 // trait definition (there's no need to warn twice
1591 // so we don't check the methods).
1593 // Those in 2. are warned via walk_generics and this
1595 intravisit::walk_path(self, &tr.path);
1597 // Those in 3. are warned with this call.
1598 for impl_item_ref in impl_item_refs {
1599 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1600 if let hir::ImplItemKind::TyAlias(ref ty) = impl_item.kind {
1606 } else if trait_ref.is_none() && self_is_public_path {
1607 // `impl Public<Private> { ... }`. Any public static
1608 // methods will be visible as `Public::foo`.
1609 let mut found_pub_static = false;
1610 for impl_item_ref in impl_item_refs {
1611 if self.item_is_public(&impl_item_ref.id.hir_id, &impl_item_ref.vis) {
1612 let impl_item = self.tcx.hir().impl_item(impl_item_ref.id);
1613 match impl_item_ref.kind {
1614 AssocItemKind::Const => {
1615 found_pub_static = true;
1616 intravisit::walk_impl_item(self, impl_item);
1618 AssocItemKind::Method { has_self: false } => {
1619 found_pub_static = true;
1620 intravisit::walk_impl_item(self, impl_item);
1626 if found_pub_static {
1627 intravisit::walk_generics(self, g)
1633 // `type ... = ...;` can contain private types, because
1634 // we're introducing a new name.
1635 hir::ItemKind::TyAlias(..) => return,
1637 // Not at all public, so we don't care.
1638 _ if !self.item_is_public(&item.hir_id, &item.vis) => {
1645 // We've carefully constructed it so that if we're here, then
1646 // any `visit_ty`'s will be called on things that are in
1647 // public signatures, i.e., things that we're interested in for
1649 intravisit::walk_item(self, item);
1652 fn visit_generics(&mut self, generics: &'tcx hir::Generics) {
1653 for param in &generics.params {
1654 for bound in ¶m.bounds {
1655 self.check_generic_bound(bound);
1658 for predicate in &generics.where_clause.predicates {
1660 hir::WherePredicate::BoundPredicate(bound_pred) => {
1661 for bound in bound_pred.bounds.iter() {
1662 self.check_generic_bound(bound)
1665 hir::WherePredicate::RegionPredicate(_) => {}
1666 hir::WherePredicate::EqPredicate(eq_pred) => {
1667 self.visit_ty(&eq_pred.rhs_ty);
1673 fn visit_foreign_item(&mut self, item: &'tcx hir::ForeignItem<'tcx>) {
1674 if self.access_levels.is_reachable(item.hir_id) {
1675 intravisit::walk_foreign_item(self, item)
1679 fn visit_ty(&mut self, t: &'tcx hir::Ty) {
1680 if let hir::TyKind::Path(hir::QPath::Resolved(_, ref path)) = t.kind {
1681 if self.path_is_private_type(path) {
1682 self.old_error_set.insert(t.hir_id);
1685 intravisit::walk_ty(self, t)
1690 v: &'tcx hir::Variant<'tcx>,
1691 g: &'tcx hir::Generics,
1692 item_id: hir::HirId,
1694 if self.access_levels.is_reachable(v.id) {
1695 self.in_variant = true;
1696 intravisit::walk_variant(self, v, g, item_id);
1697 self.in_variant = false;
1701 fn visit_struct_field(&mut self, s: &'tcx hir::StructField<'tcx>) {
1702 if s.vis.node.is_pub() || self.in_variant {
1703 intravisit::walk_struct_field(self, s);
1707 // We don't need to introspect into these at all: an
1708 // expression/block context can't possibly contain exported things.
1709 // (Making them no-ops stops us from traversing the whole AST without
1710 // having to be super careful about our `walk_...` calls above.)
1711 fn visit_block(&mut self, _: &'tcx hir::Block<'tcx>) {}
1712 fn visit_expr(&mut self, _: &'tcx hir::Expr<'tcx>) {}
1715 ///////////////////////////////////////////////////////////////////////////////
1716 /// SearchInterfaceForPrivateItemsVisitor traverses an item's interface and
1717 /// finds any private components in it.
1718 /// PrivateItemsInPublicInterfacesVisitor ensures there are no private types
1719 /// and traits in public interfaces.
1720 ///////////////////////////////////////////////////////////////////////////////
1722 struct SearchInterfaceForPrivateItemsVisitor<'tcx> {
1724 item_id: hir::HirId,
1727 /// The visitor checks that each component type is at least this visible.
1728 required_visibility: ty::Visibility,
1729 has_pub_restricted: bool,
1730 has_old_errors: bool,
1734 impl SearchInterfaceForPrivateItemsVisitor<'tcx> {
1735 fn generics(&mut self) -> &mut Self {
1736 for param in &self.tcx.generics_of(self.item_def_id).params {
1738 GenericParamDefKind::Lifetime => {}
1739 GenericParamDefKind::Type { has_default, .. } => {
1741 self.visit(self.tcx.type_of(param.def_id));
1744 GenericParamDefKind::Const => {
1745 self.visit(self.tcx.type_of(param.def_id));
1752 fn predicates(&mut self) -> &mut Self {
1753 // N.B., we use `explicit_predicates_of` and not `predicates_of`
1754 // because we don't want to report privacy errors due to where
1755 // clauses that the compiler inferred. We only want to
1756 // consider the ones that the user wrote. This is important
1757 // for the inferred outlives rules; see
1758 // `src/test/ui/rfc-2093-infer-outlives/privacy.rs`.
1759 self.visit_predicates(self.tcx.explicit_predicates_of(self.item_def_id));
1763 fn ty(&mut self) -> &mut Self {
1764 self.visit(self.tcx.type_of(self.item_def_id));
1768 fn check_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1769 if self.leaks_private_dep(def_id) {
1771 lint::builtin::EXPORTED_PRIVATE_DEPENDENCIES,
1775 "{} `{}` from private dependency '{}' in public \
1779 self.tcx.crate_name(def_id.krate)
1784 let hir_id = match self.tcx.hir().as_local_hir_id(def_id) {
1785 Some(hir_id) => hir_id,
1786 None => return false,
1789 let (vis, vis_span, vis_descr) = def_id_visibility(self.tcx, def_id);
1790 if !vis.is_at_least(self.required_visibility, self.tcx) {
1791 let msg = format!("{} {} `{}` in public interface", vis_descr, kind, descr);
1792 if self.has_pub_restricted || self.has_old_errors || self.in_assoc_ty {
1793 let mut err = if kind == "trait" {
1794 struct_span_err!(self.tcx.sess, self.span, E0445, "{}", msg)
1796 struct_span_err!(self.tcx.sess, self.span, E0446, "{}", msg)
1798 err.span_label(self.span, format!("can't leak {} {}", vis_descr, kind));
1799 err.span_label(vis_span, format!("`{}` declared as {}", descr, vis_descr));
1802 let err_code = if kind == "trait" { "E0445" } else { "E0446" };
1804 lint::builtin::PRIVATE_IN_PUBLIC,
1807 &format!("{} (error {})", msg, err_code),
1815 /// An item is 'leaked' from a private dependency if all
1816 /// of the following are true:
1817 /// 1. It's contained within a public type
1818 /// 2. It comes from a private crate
1819 fn leaks_private_dep(&self, item_id: DefId) -> bool {
1820 let ret = self.required_visibility == ty::Visibility::Public
1821 && self.tcx.is_private_dep(item_id.krate);
1823 log::debug!("leaks_private_dep(item_id={:?})={}", item_id, ret);
1828 impl DefIdVisitor<'tcx> for SearchInterfaceForPrivateItemsVisitor<'tcx> {
1829 fn tcx(&self) -> TyCtxt<'tcx> {
1832 fn visit_def_id(&mut self, def_id: DefId, kind: &str, descr: &dyn fmt::Display) -> bool {
1833 self.check_def_id(def_id, kind, descr)
1837 struct PrivateItemsInPublicInterfacesVisitor<'a, 'tcx> {
1839 has_pub_restricted: bool,
1840 old_error_set: &'a HirIdSet,
1843 impl<'a, 'tcx> PrivateItemsInPublicInterfacesVisitor<'a, 'tcx> {
1846 item_id: hir::HirId,
1847 required_visibility: ty::Visibility,
1848 ) -> SearchInterfaceForPrivateItemsVisitor<'tcx> {
1849 let mut has_old_errors = false;
1851 // Slow path taken only if there any errors in the crate.
1852 for &id in self.old_error_set {
1853 // Walk up the nodes until we find `item_id` (or we hit a root).
1857 has_old_errors = true;
1860 let parent = self.tcx.hir().get_parent_node(id);
1872 SearchInterfaceForPrivateItemsVisitor {
1875 item_def_id: self.tcx.hir().local_def_id(item_id),
1876 span: self.tcx.hir().span(item_id),
1877 required_visibility,
1878 has_pub_restricted: self.has_pub_restricted,
1884 fn check_assoc_item(
1887 assoc_item_kind: AssocItemKind,
1888 defaultness: hir::Defaultness,
1889 vis: ty::Visibility,
1891 let mut check = self.check(hir_id, vis);
1893 let (check_ty, is_assoc_ty) = match assoc_item_kind {
1894 AssocItemKind::Const | AssocItemKind::Method { .. } => (true, false),
1895 AssocItemKind::Type => (defaultness.has_value(), true),
1896 // `ty()` for opaque types is the underlying type,
1897 // it's not a part of interface, so we skip it.
1898 AssocItemKind::OpaqueTy => (false, true),
1900 check.in_assoc_ty = is_assoc_ty;
1901 check.generics().predicates();
1908 impl<'a, 'tcx> Visitor<'tcx> for PrivateItemsInPublicInterfacesVisitor<'a, 'tcx> {
1909 fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
1910 NestedVisitorMap::OnlyBodies(&self.tcx.hir())
1913 fn visit_item(&mut self, item: &'tcx hir::Item<'tcx>) {
1915 let item_visibility = ty::Visibility::from_hir(&item.vis, item.hir_id, tcx);
1918 // Crates are always public.
1919 hir::ItemKind::ExternCrate(..) => {}
1920 // All nested items are checked by `visit_item`.
1921 hir::ItemKind::Mod(..) => {}
1922 // Checked in resolve.
1923 hir::ItemKind::Use(..) => {}
1925 hir::ItemKind::GlobalAsm(..) => {}
1926 // Subitems of these items have inherited publicity.
1927 hir::ItemKind::Const(..)
1928 | hir::ItemKind::Static(..)
1929 | hir::ItemKind::Fn(..)
1930 | hir::ItemKind::TyAlias(..) => {
1931 self.check(item.hir_id, item_visibility).generics().predicates().ty();
1933 hir::ItemKind::OpaqueTy(..) => {
1934 // `ty()` for opaque types is the underlying type,
1935 // it's not a part of interface, so we skip it.
1936 self.check(item.hir_id, item_visibility).generics().predicates();
1938 hir::ItemKind::Trait(.., trait_item_refs) => {
1939 self.check(item.hir_id, item_visibility).generics().predicates();
1941 for trait_item_ref in trait_item_refs {
1942 self.check_assoc_item(
1943 trait_item_ref.id.hir_id,
1944 trait_item_ref.kind,
1945 trait_item_ref.defaultness,
1950 hir::ItemKind::TraitAlias(..) => {
1951 self.check(item.hir_id, item_visibility).generics().predicates();
1953 hir::ItemKind::Enum(ref def, _) => {
1954 self.check(item.hir_id, item_visibility).generics().predicates();
1956 for variant in def.variants {
1957 for field in variant.data.fields() {
1958 self.check(field.hir_id, item_visibility).ty();
1962 // Subitems of foreign modules have their own publicity.
1963 hir::ItemKind::ForeignMod(ref foreign_mod) => {
1964 for foreign_item in foreign_mod.items {
1965 let vis = ty::Visibility::from_hir(&foreign_item.vis, item.hir_id, tcx);
1966 self.check(foreign_item.hir_id, vis).generics().predicates().ty();
1969 // Subitems of structs and unions have their own publicity.
1970 hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
1971 self.check(item.hir_id, item_visibility).generics().predicates();
1973 for field in struct_def.fields() {
1974 let field_visibility = ty::Visibility::from_hir(&field.vis, item.hir_id, tcx);
1975 self.check(field.hir_id, min(item_visibility, field_visibility, tcx)).ty();
1978 // An inherent impl is public when its type is public
1979 // Subitems of inherent impls have their own publicity.
1980 // A trait impl is public when both its type and its trait are public
1981 // Subitems of trait impls have inherited publicity.
1982 hir::ItemKind::Impl(.., ref trait_ref, _, impl_item_refs) => {
1983 let impl_vis = ty::Visibility::of_impl(item.hir_id, tcx, &Default::default());
1984 self.check(item.hir_id, impl_vis).generics().predicates();
1985 for impl_item_ref in impl_item_refs {
1986 let impl_item = tcx.hir().impl_item(impl_item_ref.id);
1987 let impl_item_vis = if trait_ref.is_none() {
1989 ty::Visibility::from_hir(&impl_item.vis, item.hir_id, tcx),
1996 self.check_assoc_item(
1997 impl_item_ref.id.hir_id,
1999 impl_item_ref.defaultness,
2008 pub fn provide(providers: &mut Providers<'_>) {
2009 *providers = Providers {
2010 privacy_access_levels,
2011 check_private_in_public,
2017 fn check_mod_privacy(tcx: TyCtxt<'_>, module_def_id: DefId) {
2018 let empty_tables = ty::TypeckTables::empty(None);
2020 // Check privacy of names not checked in previous compilation stages.
2021 let mut visitor = NamePrivacyVisitor {
2023 tables: &empty_tables,
2024 current_item: hir::DUMMY_HIR_ID,
2025 empty_tables: &empty_tables,
2027 let (module, span, hir_id) = tcx.hir().get_module(module_def_id);
2029 intravisit::walk_mod(&mut visitor, module, hir_id);
2031 // Check privacy of explicitly written types and traits as well as
2032 // inferred types of expressions and patterns.
2033 let mut visitor = TypePrivacyVisitor {
2035 tables: &empty_tables,
2036 current_item: module_def_id,
2039 empty_tables: &empty_tables,
2041 intravisit::walk_mod(&mut visitor, module, hir_id);
2044 fn privacy_access_levels(tcx: TyCtxt<'_>, krate: CrateNum) -> &AccessLevels {
2045 assert_eq!(krate, LOCAL_CRATE);
2047 // Build up a set of all exported items in the AST. This is a set of all
2048 // items which are reachable from external crates based on visibility.
2049 let mut visitor = EmbargoVisitor {
2051 access_levels: Default::default(),
2052 macro_reachable: Default::default(),
2053 prev_level: Some(AccessLevel::Public),
2057 intravisit::walk_crate(&mut visitor, tcx.hir().krate());
2058 if visitor.changed {
2059 visitor.changed = false;
2064 visitor.update(hir::CRATE_HIR_ID, Some(AccessLevel::Public));
2066 tcx.arena.alloc(visitor.access_levels)
2069 fn check_private_in_public(tcx: TyCtxt<'_>, krate: CrateNum) {
2070 assert_eq!(krate, LOCAL_CRATE);
2072 let access_levels = tcx.privacy_access_levels(LOCAL_CRATE);
2074 let krate = tcx.hir().krate();
2076 let mut visitor = ObsoleteVisiblePrivateTypesVisitor {
2078 access_levels: &access_levels,
2080 old_error_set: Default::default(),
2082 intravisit::walk_crate(&mut visitor, krate);
2084 let has_pub_restricted = {
2085 let mut pub_restricted_visitor = PubRestrictedVisitor { tcx, has_pub_restricted: false };
2086 intravisit::walk_crate(&mut pub_restricted_visitor, krate);
2087 pub_restricted_visitor.has_pub_restricted
2090 // Check for private types and traits in public interfaces.
2091 let mut visitor = PrivateItemsInPublicInterfacesVisitor {
2094 old_error_set: &visitor.old_error_set,
2096 krate.visit_all_item_likes(&mut DeepVisitor::new(&mut visitor));