compiler/rustc_trait_selection/src/traits/query/dropck_outlives.rs

   1 use crate::infer::at::At;
   2 use crate::infer::canonical::OriginalQueryValues;
   3 use crate::infer::InferOk;
   4
   5 use rustc_middle::ty::subst::GenericArg;
   6 use rustc_middle::ty::{self, Ty, TyCtxt};
   7
   8 pub use rustc_middle::traits::query::{DropckConstraint, DropckOutlivesResult};
   9
  10 pub trait AtExt<'tcx> {
  11     fn dropck_outlives(&self, ty: Ty<'tcx>) -> InferOk<'tcx, Vec<GenericArg<'tcx>>>;
  12 }
  13
  14 impl<'cx, 'tcx> AtExt<'tcx> for At<'cx, 'tcx> {
  15     /// Given a type `ty` of some value being dropped, computes a set
  16     /// of "kinds" (types, regions) that must be outlive the execution
  17     /// of the destructor. These basically correspond to data that the
  18     /// destructor might access. This is used during regionck to
  19     /// impose "outlives" constraints on any lifetimes referenced
  20     /// within.
  21     ///
  22     /// The rules here are given by the "dropck" RFCs, notably [#1238]
  23     /// and [#1327]. This is a fixed-point computation, where we
  24     /// explore all the data that will be dropped (transitively) when
  25     /// a value of type `ty` is dropped. For each type T that will be
  26     /// dropped and which has a destructor, we must assume that all
  27     /// the types/regions of T are live during the destructor, unless
  28     /// they are marked with a special attribute (`#[may_dangle]`).
  29     ///
  30     /// [#1238]: https://github.com/rust-lang/rfcs/blob/master/text/1238-nonparametric-dropck.md
  31     /// [#1327]: https://github.com/rust-lang/rfcs/blob/master/text/1327-dropck-param-eyepatch.md
  32     fn dropck_outlives(&self, ty: Ty<'tcx>) -> InferOk<'tcx, Vec<GenericArg<'tcx>>> {
  33         debug!("dropck_outlives(ty={:?}, param_env={:?})", ty, self.param_env,);
  34
  35         // Quick check: there are a number of cases that we know do not require
  36         // any destructor.
  37         let tcx = self.infcx.tcx;
  38         if trivial_dropck_outlives(tcx, ty) {
  39             return InferOk { value: vec![], obligations: vec![] };
  40         }
  41
  42         let mut orig_values = OriginalQueryValues::default();
  43         let c_ty = self.infcx.canonicalize_query(self.param_env.and(ty), &mut orig_values);
  44         let span = self.cause.span;
  45         debug!("c_ty = {:?}", c_ty);
  46         if let Ok(result) = tcx.dropck_outlives(c_ty)
  47             && result.is_proven()
  48             && let Ok(InferOk { value, obligations }) =
  49                 self.infcx.instantiate_query_response_and_region_obligations(
  50                     self.cause,
  51                     self.param_env,
  52                     &orig_values,
  53                     result,
  54                 )
  55         {
  56             let ty = self.infcx.resolve_vars_if_possible(ty);
  57             let kinds = value.into_kinds_reporting_overflows(tcx, span, ty);
  58             return InferOk { value: kinds, obligations };
  59         }
  60
  61         // Errors and ambiuity in dropck occur in two cases:
  62         // - unresolved inference variables at the end of typeck
  63         // - non well-formed types where projections cannot be resolved
  64         // Either of these should have created an error before.
  65         tcx.sess.delay_span_bug(span, "dtorck encountered internal error");
  66
  67         InferOk { value: vec![], obligations: vec![] }
  68     }
  69 }
  70
  71 /// This returns true if the type `ty` is "trivial" for
  72 /// dropck-outlives -- that is, if it doesn't require any types to
  73 /// outlive. This is similar but not *quite* the same as the
  74 /// `needs_drop` test in the compiler already -- that is, for every
  75 /// type T for which this function return true, needs-drop would
  76 /// return `false`. But the reverse does not hold: in particular,
  77 /// `needs_drop` returns false for `PhantomData`, but it is not
  78 /// trivial for dropck-outlives.
  79 ///
  80 /// Note also that `needs_drop` requires a "global" type (i.e., one
  81 /// with erased regions), but this function does not.
  82 pub fn trivial_dropck_outlives<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> bool {
  83     match ty.kind() {
  84         // None of these types have a destructor and hence they do not
  85         // require anything in particular to outlive the dtor's
  86         // execution.
  87         ty::Infer(ty::FreshIntTy(_))
  88         | ty::Infer(ty::FreshFloatTy(_))
  89         | ty::Bool
  90         | ty::Int(_)
  91         | ty::Uint(_)
  92         | ty::Float(_)
  93         | ty::Never
  94         | ty::FnDef(..)
  95         | ty::FnPtr(_)
  96         | ty::Char
  97         | ty::GeneratorWitness(..)
  98         | ty::RawPtr(_)
  99         | ty::Ref(..)
 100         | ty::Str
 101         | ty::Foreign(..)
 102         | ty::Error(_) => true,
 103
 104         // [T; N] and [T] have same properties as T.
 105         ty::Array(ty, _) | ty::Slice(ty) => trivial_dropck_outlives(tcx, *ty),
 106
 107         // (T1..Tn) and closures have same properties as T1..Tn --
 108         // check if *any* of those are trivial.
 109         ty::Tuple(tys) => tys.iter().all(|t| trivial_dropck_outlives(tcx, t)),
 110         ty::Closure(_, ref substs) => {
 111             trivial_dropck_outlives(tcx, substs.as_closure().tupled_upvars_ty())
 112         }
 113
 114         ty::Adt(def, _) => {
 115             if Some(def.did()) == tcx.lang_items().manually_drop() {
 116                 // `ManuallyDrop` never has a dtor.
 117                 true
 118             } else {
 119                 // Other types might. Moreover, PhantomData doesn't
 120                 // have a dtor, but it is considered to own its
 121                 // content, so it is non-trivial. Unions can have `impl Drop`,
 122                 // and hence are non-trivial as well.
 123                 false
 124             }
 125         }
 126
 127         // The following *might* require a destructor: needs deeper inspection.
 128         ty::Dynamic(..)
 129         | ty::Projection(..)
 130         | ty::Param(_)
 131         | ty::Opaque(..)
 132         | ty::Placeholder(..)
 133         | ty::Infer(_)
 134         | ty::Bound(..)
 135         | ty::Generator(..) => false,
 136     }
 137 }