src/librustc_ty/needs_drop.rs

   1 //! Check whether a type has (potentially) non-trivial drop glue.
   2
   3 use rustc::ty::subst::Subst;
   4 use rustc::ty::util::{needs_drop_components, AlwaysRequiresDrop};
   5 use rustc::ty::{self, Ty, TyCtxt};
   6 use rustc_data_structures::fx::FxHashSet;
   7 use rustc_hir::def_id::DefId;
   8 use rustc_span::DUMMY_SP;
   9
  10 type NeedsDropResult<T> = Result<T, AlwaysRequiresDrop>;
  11
  12 fn needs_drop_raw<'tcx>(tcx: TyCtxt<'tcx>, query: ty::ParamEnvAnd<'tcx, Ty<'tcx>>) -> bool {
  13     let adt_fields =
  14         move |adt_def: &ty::AdtDef| tcx.adt_drop_tys(adt_def.did).map(|tys| tys.iter().copied());
  15     // If we don't know a type doesn't need drop, say it's a type parameter
  16     // without a `Copy` bound, then we conservatively return that it needs
  17     // drop.
  18     let res = NeedsDropTypes::new(tcx, query.param_env, query.value, adt_fields).next().is_some();
  19     debug!("needs_drop_raw({:?}) = {:?}", query, res);
  20     res
  21 }
  22
  23 struct NeedsDropTypes<'tcx, F> {
  24     tcx: TyCtxt<'tcx>,
  25     param_env: ty::ParamEnv<'tcx>,
  26     query_ty: Ty<'tcx>,
  27     seen_tys: FxHashSet<Ty<'tcx>>,
  28     /// A stack of types left to process. Each round, we pop something from the
  29     /// stack and check if it needs drop. If the result depends on whether some
  30     /// other types need drop we push them onto the stack.
  31     unchecked_tys: Vec<(Ty<'tcx>, usize)>,
  32     recursion_limit: usize,
  33     adt_components: F,
  34 }
  35
  36 impl<'tcx, F> NeedsDropTypes<'tcx, F> {
  37     fn new(
  38         tcx: TyCtxt<'tcx>,
  39         param_env: ty::ParamEnv<'tcx>,
  40         ty: Ty<'tcx>,
  41         adt_components: F,
  42     ) -> Self {
  43         let mut seen_tys = FxHashSet::default();
  44         seen_tys.insert(ty);
  45         let recursion_limit = *tcx.sess.recursion_limit.get();
  46         Self {
  47             tcx,
  48             param_env,
  49             seen_tys,
  50             query_ty: ty,
  51             unchecked_tys: vec![(ty, 0)],
  52             recursion_limit,
  53             adt_components,
  54         }
  55     }
  56 }
  57
  58 impl<'tcx, F, I> Iterator for NeedsDropTypes<'tcx, F>
  59 where
  60     F: Fn(&ty::AdtDef) -> NeedsDropResult<I>,
  61     I: Iterator<Item = Ty<'tcx>>,
  62 {
  63     type Item = NeedsDropResult<Ty<'tcx>>;
  64
  65     fn next(&mut self) -> Option<NeedsDropResult<Ty<'tcx>>> {
  66         let tcx = self.tcx;
  67
  68         while let Some((ty, level)) = self.unchecked_tys.pop() {
  69             if level > self.recursion_limit {
  70                 // Not having a `Span` isn't great. But there's hopefully some other
  71                 // recursion limit error as well.
  72                 tcx.sess.span_err(
  73                     DUMMY_SP,
  74                     &format!("overflow while checking whether `{}` requires drop", self.query_ty),
  75                 );
  76                 return Some(Err(AlwaysRequiresDrop));
  77             }
  78
  79             let components = match needs_drop_components(ty, &tcx.data_layout) {
  80                 Err(e) => return Some(Err(e)),
  81                 Ok(components) => components,
  82             };
  83             debug!("needs_drop_components({:?}) = {:?}", ty, components);
  84
  85             let queue_type = move |this: &mut Self, component: Ty<'tcx>| {
  86                 if this.seen_tys.insert(component) {
  87                     this.unchecked_tys.push((component, level + 1));
  88                 }
  89             };
  90
  91             for component in components {
  92                 match component.kind {
  93                     _ if component.is_copy_modulo_regions(tcx, self.param_env, DUMMY_SP) => (),
  94
  95                     ty::Closure(def_id, substs) => {
  96                         for upvar_ty in substs.as_closure().upvar_tys(def_id, tcx) {
  97                             queue_type(self, upvar_ty);
  98                         }
  99                     }
 100
 101                     // Check for a `Drop` impl and whether this is a union or
 102                     // `ManuallyDrop`. If it's a struct or enum without a `Drop`
 103                     // impl then check whether the field types need `Drop`.
 104                     ty::Adt(adt_def, substs) => {
 105                         let tys = match (self.adt_components)(adt_def) {
 106                             Err(e) => return Some(Err(e)),
 107                             Ok(tys) => tys,
 108                         };
 109                         for required_ty in tys {
 110                             let subst_ty = tcx.normalize_erasing_regions(
 111                                 self.param_env,
 112                                 required_ty.subst(tcx, substs),
 113                             );
 114                             queue_type(self, subst_ty);
 115                         }
 116                     }
 117                     ty::Array(..) | ty::Opaque(..) | ty::Projection(..) | ty::Param(_) => {
 118                         if ty == component {
 119                             // Return the type to the caller: they may be able
 120                             // to normalize further than we can.
 121                             return Some(Ok(component));
 122                         } else {
 123                             // Store the type for later. We can't return here
 124                             // because we would then lose any other components
 125                             // of the type.
 126                             queue_type(self, component);
 127                         }
 128                     }
 129                     _ => return Some(Err(AlwaysRequiresDrop)),
 130                 }
 131             }
 132         }
 133
 134         return None;
 135     }
 136 }
 137
 138 fn adt_drop_tys(tcx: TyCtxt<'_>, def_id: DefId) -> Result<&ty::List<Ty<'_>>, AlwaysRequiresDrop> {
 139     let adt_components = move |adt_def: &ty::AdtDef| {
 140         if adt_def.is_manually_drop() {
 141             debug!("adt_drop_tys: `{:?}` is manually drop", adt_def);
 142             return Ok(Vec::new().into_iter());
 143         } else if adt_def.destructor(tcx).is_some() {
 144             debug!("adt_drop_tys: `{:?}` implements `Drop`", adt_def);
 145             return Err(AlwaysRequiresDrop);
 146         } else if adt_def.is_union() {
 147             debug!("adt_drop_tys: `{:?}` is a union", adt_def);
 148             return Ok(Vec::new().into_iter());
 149         }
 150         Ok(adt_def.all_fields().map(|field| tcx.type_of(field.did)).collect::<Vec<_>>().into_iter())
 151     };
 152
 153     let adt_ty = tcx.type_of(def_id);
 154     let param_env = tcx.param_env(def_id);
 155     let res: Result<Vec<_>, _> =
 156         NeedsDropTypes::new(tcx, param_env, adt_ty, adt_components).collect();
 157
 158     debug!("adt_drop_tys(`{}`) = `{:?}`", tcx.def_path_str(def_id), res);
 159     res.map(|components| tcx.intern_type_list(&components))
 160 }
 161
 162 pub(crate) fn provide(providers: &mut ty::query::Providers<'_>) {
 163     *providers = ty::query::Providers { needs_drop_raw, adt_drop_tys, ..*providers };
 164 }