compiler/rustc_mir_transform/src/add_retag.rs

   1 //! This pass adds validation calls (AcquireValid, ReleaseValid) where appropriate.
   2 //! It has to be run really early, before transformations like inlining, because
   3 //! introducing these calls *adds* UB -- so, conceptually, this pass is actually part
   4 //! of MIR building, and only after this pass we think of the program has having the
   5 //! normal MIR semantics.
   6
   7 use crate::MirPass;
   8 use rustc_middle::mir::*;
   9 use rustc_middle::ty::{self, Ty, TyCtxt};
  10
  11 pub struct AddRetag;
  12
  13 /// Determines whether this place is "stable": Whether, if we evaluate it again
  14 /// after the assignment, we can be sure to obtain the same place value.
  15 /// (Concurrent accesses by other threads are no problem as these are anyway non-atomic
  16 /// copies.  Data races are UB.)
  17 fn is_stable(place: PlaceRef<'_>) -> bool {
  18     place.projection.iter().all(|elem| {
  19         match elem {
  20             // Which place this evaluates to can change with any memory write,
  21             // so cannot assume this to be stable.
  22             ProjectionElem::Deref => false,
  23             // Array indices are interesting, but MIR building generates a *fresh*
  24             // temporary for every array access, so the index cannot be changed as
  25             // a side-effect.
  26             ProjectionElem::Index { .. } |
  27             // The rest is completely boring, they just offset by a constant.
  28             ProjectionElem::Field { .. } |
  29             ProjectionElem::ConstantIndex { .. } |
  30             ProjectionElem::Subslice { .. } |
  31             ProjectionElem::Downcast { .. } => true,
  32         }
  33     })
  34 }
  35
  36 /// Determine whether this type may contain a reference (or box), and thus needs retagging.
  37 /// We will only recurse `depth` times into Tuples/ADTs to bound the cost of this.
  38 fn may_contain_reference<'tcx>(ty: Ty<'tcx>, depth: u32, tcx: TyCtxt<'tcx>) -> bool {
  39     match ty.kind() {
  40         // Primitive types that are not references
  41         ty::Bool
  42         | ty::Char
  43         | ty::Float(_)
  44         | ty::Int(_)
  45         | ty::Uint(_)
  46         | ty::RawPtr(..)
  47         | ty::FnPtr(..)
  48         | ty::Str
  49         | ty::FnDef(..)
  50         | ty::Never => false,
  51         // References
  52         ty::Ref(..) => true,
  53         ty::Adt(..) if ty.is_box() => true,
  54         // Compound types: recurse
  55         ty::Array(ty, _) | ty::Slice(ty) => {
  56             // This does not branch so we keep the depth the same.
  57             may_contain_reference(*ty, depth, tcx)
  58         }
  59         ty::Tuple(tys) => {
  60             depth == 0 || tys.iter().any(|ty| may_contain_reference(ty, depth - 1, tcx))
  61         }
  62         ty::Adt(adt, subst) => {
  63             depth == 0
  64                 || adt.variants().iter().any(|v| {
  65                     v.fields.iter().any(|f| may_contain_reference(f.ty(tcx, subst), depth - 1, tcx))
  66                 })
  67         }
  68         // Conservative fallback
  69         _ => true,
  70     }
  71 }
  72
  73 impl<'tcx> MirPass<'tcx> for AddRetag {
  74     fn is_enabled(&self, sess: &rustc_session::Session) -> bool {
  75         sess.opts.unstable_opts.mir_emit_retag
  76     }
  77
  78     fn run_pass(&self, tcx: TyCtxt<'tcx>, body: &mut Body<'tcx>) {
  79         // We need an `AllCallEdges` pass before we can do any work.
  80         super::add_call_guards::AllCallEdges.run_pass(tcx, body);
  81
  82         let (span, arg_count) = (body.span, body.arg_count);
  83         let basic_blocks = body.basic_blocks.as_mut();
  84         let local_decls = &body.local_decls;
  85         let needs_retag = |place: &Place<'tcx>| {
  86             // FIXME: Instead of giving up for unstable places, we should introduce
  87             // a temporary and retag on that.
  88             is_stable(place.as_ref())
  89                 && may_contain_reference(place.ty(&*local_decls, tcx).ty, /*depth*/ 3, tcx)
  90                 && !local_decls[place.local].is_deref_temp()
  91         };
  92         let place_base_raw = |place: &Place<'tcx>| {
  93             // If this is a `Deref`, get the type of what we are deref'ing.
  94             let deref_base =
  95                 place.projection.iter().rposition(|p| matches!(p, ProjectionElem::Deref));
  96             if let Some(deref_base) = deref_base {
  97                 let base_proj = &place.projection[..deref_base];
  98                 let ty = Place::ty_from(place.local, base_proj, &*local_decls, tcx).ty;
  99                 ty.is_unsafe_ptr()
 100             } else {
 101                 // Not a deref, and thus not raw.
 102                 false
 103             }
 104         };
 105
 106         // PART 1
 107         // Retag arguments at the beginning of the start block.
 108         {
 109             // FIXME: Consider using just the span covering the function
 110             // argument declaration.
 111             let source_info = SourceInfo::outermost(span);
 112             // Gather all arguments, skip return value.
 113             let places = local_decls
 114                 .iter_enumerated()
 115                 .skip(1)
 116                 .take(arg_count)
 117                 .map(|(local, _)| Place::from(local))
 118                 .filter(needs_retag);
 119             // Emit their retags.
 120             basic_blocks[START_BLOCK].statements.splice(
 121                 0..0,
 122                 places.map(|place| Statement {
 123                     source_info,
 124                     kind: StatementKind::Retag(RetagKind::FnEntry, Box::new(place)),
 125                 }),
 126             );
 127         }
 128
 129         // PART 2
 130         // Retag return values of functions.  Also escape-to-raw the argument of `drop`.
 131         // We collect the return destinations because we cannot mutate while iterating.
 132         let returns = basic_blocks
 133             .iter_mut()
 134             .filter_map(|block_data| {
 135                 match block_data.terminator().kind {
 136                     TerminatorKind::Call { target: Some(target), destination, .. }
 137                         if needs_retag(&destination) =>
 138                     {
 139                         // Remember the return destination for later
 140                         Some((block_data.terminator().source_info, destination, target))
 141                     }
 142
 143                     // `Drop` is also a call, but it doesn't return anything so we are good.
 144                     TerminatorKind::Drop { .. } | TerminatorKind::DropAndReplace { .. } => None,
 145                     // Not a block ending in a Call -> ignore.
 146                     _ => None,
 147                 }
 148             })
 149             .collect::<Vec<_>>();
 150         // Now we go over the returns we collected to retag the return values.
 151         for (source_info, dest_place, dest_block) in returns {
 152             basic_blocks[dest_block].statements.insert(
 153                 0,
 154                 Statement {
 155                     source_info,
 156                     kind: StatementKind::Retag(RetagKind::Default, Box::new(dest_place)),
 157                 },
 158             );
 159         }
 160
 161         // PART 3
 162         // Add retag after assignment.
 163         for block_data in basic_blocks {
 164             // We want to insert statements as we iterate.  To this end, we
 165             // iterate backwards using indices.
 166             for i in (0..block_data.statements.len()).rev() {
 167                 let (retag_kind, place) = match block_data.statements[i].kind {
 168                     // Retag-as-raw after escaping to a raw pointer, if the referent
 169                     // is not already a raw pointer.
 170                     StatementKind::Assign(box (lplace, Rvalue::AddressOf(_, ref rplace)))
 171                         if !place_base_raw(rplace) =>
 172                     {
 173                         (RetagKind::Raw, lplace)
 174                     }
 175                     // Retag after assignments of reference type.
 176                     StatementKind::Assign(box (ref place, ref rvalue)) if needs_retag(place) => {
 177                         let kind = match rvalue {
 178                             Rvalue::Ref(_, borrow_kind, _)
 179                                 if borrow_kind.allows_two_phase_borrow() =>
 180                             {
 181                                 RetagKind::TwoPhase
 182                             }
 183                             _ => RetagKind::Default,
 184                         };
 185                         (kind, *place)
 186                     }
 187                     // Do nothing for the rest
 188                     _ => continue,
 189                 };
 190                 // Insert a retag after the statement.
 191                 let source_info = block_data.statements[i].source_info;
 192                 block_data.statements.insert(
 193                     i + 1,
 194                     Statement {
 195                         source_info,
 196                         kind: StatementKind::Retag(retag_kind, Box::new(place)),
 197                     },
 198                 );
 199             }
 200         }
 201     }
 202 }