1 //! Constraint construction and representation
3 //! The second pass over the AST determines the set of constraints.
4 //! We walk the set of items and, for each member, generate new constraints.
6 use hir::def_id::{DefId, LocalDefId};
8 use rustc_hir::itemlikevisit::ItemLikeVisitor;
9 use rustc_middle::ty::subst::{GenericArgKind, SubstsRef};
10 use rustc_middle::ty::{self, Ty, TyCtxt};
12 use super::terms::VarianceTerm::*;
15 pub struct ConstraintContext<'a, 'tcx> {
16 pub terms_cx: TermsContext<'a, 'tcx>,
18 // These are pointers to common `ConstantTerm` instances
19 covariant: VarianceTermPtr<'a>,
20 contravariant: VarianceTermPtr<'a>,
21 invariant: VarianceTermPtr<'a>,
22 bivariant: VarianceTermPtr<'a>,
24 pub constraints: Vec<Constraint<'a>>,
27 /// Declares that the variable `decl_id` appears in a location with
28 /// variance `variance`.
29 #[derive(Copy, Clone)]
30 pub struct Constraint<'a> {
31 pub inferred: InferredIndex,
32 pub variance: &'a VarianceTerm<'a>,
35 /// To build constraints, we visit one item (type, trait) at a time
36 /// and look at its contents. So e.g., if we have
42 /// then while we are visiting `Bar<T>`, the `CurrentItem` would have
43 /// the `DefId` and the start of `Foo`'s inferreds.
44 pub struct CurrentItem {
45 inferred_start: InferredIndex,
48 pub fn add_constraints_from_crate<'a, 'tcx>(
49 terms_cx: TermsContext<'a, 'tcx>,
50 ) -> ConstraintContext<'a, 'tcx> {
51 let tcx = terms_cx.tcx;
52 let covariant = terms_cx.arena.alloc(ConstantTerm(ty::Covariant));
53 let contravariant = terms_cx.arena.alloc(ConstantTerm(ty::Contravariant));
54 let invariant = terms_cx.arena.alloc(ConstantTerm(ty::Invariant));
55 let bivariant = terms_cx.arena.alloc(ConstantTerm(ty::Bivariant));
56 let mut constraint_cx = ConstraintContext {
62 constraints: Vec::new(),
65 tcx.hir().visit_all_item_likes(&mut constraint_cx);
70 impl<'a, 'tcx, 'v> ItemLikeVisitor<'v> for ConstraintContext<'a, 'tcx> {
71 fn visit_item(&mut self, item: &hir::Item<'_>) {
73 hir::ItemKind::Struct(ref struct_def, _) | hir::ItemKind::Union(ref struct_def, _) => {
74 self.visit_node_helper(item.hir_id());
76 if let hir::VariantData::Tuple(..) = *struct_def {
77 self.visit_node_helper(struct_def.ctor_hir_id().unwrap());
81 hir::ItemKind::Enum(ref enum_def, _) => {
82 self.visit_node_helper(item.hir_id());
84 for variant in enum_def.variants {
85 if let hir::VariantData::Tuple(..) = variant.data {
86 self.visit_node_helper(variant.data.ctor_hir_id().unwrap());
91 hir::ItemKind::Fn(..) => {
92 self.visit_node_helper(item.hir_id());
99 fn visit_trait_item(&mut self, trait_item: &hir::TraitItem<'_>) {
100 if let hir::TraitItemKind::Fn(..) = trait_item.kind {
101 self.visit_node_helper(trait_item.hir_id());
105 fn visit_impl_item(&mut self, impl_item: &hir::ImplItem<'_>) {
106 if let hir::ImplItemKind::Fn(..) = impl_item.kind {
107 self.visit_node_helper(impl_item.hir_id());
111 fn visit_foreign_item(&mut self, foreign_item: &hir::ForeignItem<'_>) {
112 if let hir::ForeignItemKind::Fn(..) = foreign_item.kind {
113 self.visit_node_helper(foreign_item.hir_id());
118 impl<'a, 'tcx> ConstraintContext<'a, 'tcx> {
119 fn visit_node_helper(&mut self, id: hir::HirId) {
120 let tcx = self.terms_cx.tcx;
121 let def_id = tcx.hir().local_def_id(id);
122 self.build_constraints_for_item(def_id);
125 fn tcx(&self) -> TyCtxt<'tcx> {
129 fn build_constraints_for_item(&mut self, def_id: LocalDefId) {
130 let tcx = self.tcx();
131 debug!("build_constraints_for_item({})", tcx.def_path_str(def_id.to_def_id()));
133 // Skip items with no generics - there's nothing to infer in them.
134 if tcx.generics_of(def_id).count() == 0 {
138 let id = tcx.hir().local_def_id_to_hir_id(def_id);
139 let inferred_start = self.terms_cx.inferred_starts[&id];
140 let current_item = &CurrentItem { inferred_start };
141 match tcx.type_of(def_id).kind() {
143 // Not entirely obvious: constraints on structs/enums do not
144 // affect the variance of their type parameters. See discussion
145 // in comment at top of module.
147 // self.add_constraints_from_generics(generics);
149 for field in def.all_fields() {
150 self.add_constraints_from_ty(
152 tcx.type_of(field.did),
159 self.add_constraints_from_sig(current_item, tcx.fn_sig(def_id), self.covariant);
165 tcx.def_span(def_id),
166 "`build_constraints_for_item` unsupported for this item"
172 fn add_constraint(&mut self, current: &CurrentItem, index: u32, variance: VarianceTermPtr<'a>) {
173 debug!("add_constraint(index={}, variance={:?})", index, variance);
174 self.constraints.push(Constraint {
175 inferred: InferredIndex(current.inferred_start.0 + index as usize),
180 fn contravariant(&mut self, variance: VarianceTermPtr<'a>) -> VarianceTermPtr<'a> {
181 self.xform(variance, self.contravariant)
184 fn invariant(&mut self, variance: VarianceTermPtr<'a>) -> VarianceTermPtr<'a> {
185 self.xform(variance, self.invariant)
188 fn constant_term(&self, v: ty::Variance) -> VarianceTermPtr<'a> {
190 ty::Covariant => self.covariant,
191 ty::Invariant => self.invariant,
192 ty::Contravariant => self.contravariant,
193 ty::Bivariant => self.bivariant,
197 fn xform(&mut self, v1: VarianceTermPtr<'a>, v2: VarianceTermPtr<'a>) -> VarianceTermPtr<'a> {
199 (_, ConstantTerm(ty::Covariant)) => {
200 // Applying a "covariant" transform is always a no-op
204 (ConstantTerm(c1), ConstantTerm(c2)) => self.constant_term(c1.xform(c2)),
206 _ => &*self.terms_cx.arena.alloc(TransformTerm(v1, v2)),
210 #[instrument(level = "debug", skip(self, current))]
211 fn add_constraints_from_invariant_substs(
213 current: &CurrentItem,
214 substs: SubstsRef<'tcx>,
215 variance: VarianceTermPtr<'a>,
217 // Trait are always invariant so we can take advantage of that.
218 let variance_i = self.invariant(variance);
222 GenericArgKind::Lifetime(lt) => {
223 self.add_constraints_from_region(current, lt, variance_i)
225 GenericArgKind::Type(ty) => self.add_constraints_from_ty(current, ty, variance_i),
226 GenericArgKind::Const(val) => {
227 self.add_constraints_from_const(current, val, variance_i)
233 /// Adds constraints appropriate for an instance of `ty` appearing
234 /// in a context with the generics defined in `generics` and
235 /// ambient variance `variance`
236 fn add_constraints_from_ty(
238 current: &CurrentItem,
240 variance: VarianceTermPtr<'a>,
242 debug!("add_constraints_from_ty(ty={:?}, variance={:?})", ty, variance);
252 | ty::Foreign(..) => {
256 ty::FnDef(..) | ty::Generator(..) | ty::Closure(..) => {
257 bug!("Unexpected closure type in variance computation");
260 ty::Ref(region, ty, mutbl) => {
261 let contra = self.contravariant(variance);
262 self.add_constraints_from_region(current, region, contra);
263 self.add_constraints_from_mt(current, &ty::TypeAndMut { ty, mutbl }, variance);
266 ty::Array(typ, len) => {
267 self.add_constraints_from_const(current, len, variance);
268 self.add_constraints_from_ty(current, typ, variance);
272 self.add_constraints_from_ty(current, typ, variance);
275 ty::RawPtr(ref mt) => {
276 self.add_constraints_from_mt(current, mt, variance);
279 ty::Tuple(subtys) => {
280 for subty in subtys {
281 self.add_constraints_from_ty(current, subty.expect_ty(), variance);
285 ty::Adt(def, substs) => {
286 self.add_constraints_from_substs(current, def.did, substs, variance);
289 ty::Projection(ref data) => {
290 self.add_constraints_from_invariant_substs(current, data.substs, variance);
293 ty::Opaque(_, substs) => {
294 self.add_constraints_from_invariant_substs(current, substs, variance);
297 ty::Dynamic(data, r) => {
298 // The type `Foo<T+'a>` is contravariant w/r/t `'a`:
299 let contra = self.contravariant(variance);
300 self.add_constraints_from_region(current, r, contra);
302 if let Some(poly_trait_ref) = data.principal() {
303 self.add_constraints_from_invariant_substs(
305 poly_trait_ref.skip_binder().substs,
310 for projection in data.projection_bounds() {
311 match projection.skip_binder().term {
312 ty::Term::Ty(ty) => {
313 self.add_constraints_from_ty(current, ty, self.invariant);
315 ty::Term::Const(c) => {
316 self.add_constraints_from_const(current, c, self.invariant)
322 ty::Param(ref data) => {
323 self.add_constraint(current, data.index, variance);
327 self.add_constraints_from_sig(current, sig, variance);
331 // we encounter this when walking the trait references for object
332 // types, where we use Error as the Self type
335 ty::Placeholder(..) | ty::GeneratorWitness(..) | ty::Bound(..) | ty::Infer(..) => {
337 "unexpected type encountered in \
338 variance inference: {}",
345 /// Adds constraints appropriate for a nominal type (enum, struct,
346 /// object, etc) appearing in a context with ambient variance `variance`
347 fn add_constraints_from_substs(
349 current: &CurrentItem,
351 substs: SubstsRef<'tcx>,
352 variance: VarianceTermPtr<'a>,
355 "add_constraints_from_substs(def_id={:?}, substs={:?}, variance={:?})",
356 def_id, substs, variance
359 // We don't record `inferred_starts` entries for empty generics.
360 if substs.is_empty() {
364 let (local, remote) = if let Some(def_id) = def_id.as_local() {
365 let id = self.tcx().hir().local_def_id_to_hir_id(def_id);
366 (Some(self.terms_cx.inferred_starts[&id]), None)
368 (None, Some(self.tcx().variances_of(def_id)))
371 for (i, k) in substs.iter().enumerate() {
372 let variance_decl = if let Some(InferredIndex(start)) = local {
373 // Parameter on an item defined within current crate:
374 // variance not yet inferred, so return a symbolic
376 self.terms_cx.inferred_terms[start + i]
378 // Parameter on an item defined within another crate:
379 // variance already inferred, just look it up.
380 self.constant_term(remote.as_ref().unwrap()[i])
382 let variance_i = self.xform(variance, variance_decl);
384 "add_constraints_from_substs: variance_decl={:?} variance_i={:?}",
385 variance_decl, variance_i
388 GenericArgKind::Lifetime(lt) => {
389 self.add_constraints_from_region(current, lt, variance_i)
391 GenericArgKind::Type(ty) => self.add_constraints_from_ty(current, ty, variance_i),
392 GenericArgKind::Const(val) => {
393 self.add_constraints_from_const(current, val, variance)
399 /// Adds constraints appropriate for a const expression `val`
400 /// in a context with ambient variance `variance`
401 fn add_constraints_from_const(
403 current: &CurrentItem,
404 val: ty::Const<'tcx>,
405 variance: VarianceTermPtr<'a>,
407 debug!("add_constraints_from_const(val={:?}, variance={:?})", val, variance);
410 ty::ConstKind::Unevaluated(uv) => {
411 self.add_constraints_from_invariant_substs(current, uv.substs, variance);
417 /// Adds constraints appropriate for a function with signature
418 /// `sig` appearing in a context with ambient variance `variance`
419 fn add_constraints_from_sig(
421 current: &CurrentItem,
422 sig: ty::PolyFnSig<'tcx>,
423 variance: VarianceTermPtr<'a>,
425 let contra = self.contravariant(variance);
426 for &input in sig.skip_binder().inputs() {
427 self.add_constraints_from_ty(current, input, contra);
429 self.add_constraints_from_ty(current, sig.skip_binder().output(), variance);
432 /// Adds constraints appropriate for a region appearing in a
433 /// context with ambient variance `variance`
434 fn add_constraints_from_region(
436 current: &CurrentItem,
437 region: ty::Region<'tcx>,
438 variance: VarianceTermPtr<'a>,
441 ty::ReEarlyBound(ref data) => {
442 self.add_constraint(current, data.index, variance);
447 ty::ReLateBound(..) => {
448 // Late-bound regions do not get substituted the same
449 // way early-bound regions do, so we skip them here.
454 | ty::RePlaceholder(..)
457 // We don't expect to see anything but 'static or bound
458 // regions when visiting member types or method types.
460 "unexpected region encountered in variance \
468 /// Adds constraints appropriate for a mutability-type pair
469 /// appearing in a context with ambient variance `variance`
470 fn add_constraints_from_mt(
472 current: &CurrentItem,
473 mt: &ty::TypeAndMut<'tcx>,
474 variance: VarianceTermPtr<'a>,
477 hir::Mutability::Mut => {
478 let invar = self.invariant(variance);
479 self.add_constraints_from_ty(current, mt.ty, invar);
482 hir::Mutability::Not => {
483 self.add_constraints_from_ty(current, mt.ty, variance);