compiler/rustc_codegen_cranelift/src/common.rs

   1 use rustc_index::vec::IndexVec;
   2 use rustc_target::abi::call::FnAbi;
   3 use rustc_target::abi::{Integer, Primitive};
   4 use rustc_target::spec::{HasTargetSpec, Target};
   5
   6 use crate::prelude::*;
   7
   8 pub(crate) fn pointer_ty(tcx: TyCtxt<'_>) -> types::Type {
   9     match tcx.data_layout.pointer_size.bits() {
  10         16 => types::I16,
  11         32 => types::I32,
  12         64 => types::I64,
  13         bits => bug!("ptr_sized_integer: unknown pointer bit size {}", bits),
  14     }
  15 }
  16
  17 pub(crate) fn scalar_to_clif_type(tcx: TyCtxt<'_>, scalar: Scalar) -> Type {
  18     match scalar.value {
  19         Primitive::Int(int, _sign) => match int {
  20             Integer::I8 => types::I8,
  21             Integer::I16 => types::I16,
  22             Integer::I32 => types::I32,
  23             Integer::I64 => types::I64,
  24             Integer::I128 => types::I128,
  25         },
  26         Primitive::F32 => types::F32,
  27         Primitive::F64 => types::F64,
  28         Primitive::Pointer => pointer_ty(tcx),
  29     }
  30 }
  31
  32 fn clif_type_from_ty<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> Option<types::Type> {
  33     Some(match ty.kind() {
  34         ty::Bool => types::I8,
  35         ty::Uint(size) => match size {
  36             UintTy::U8 => types::I8,
  37             UintTy::U16 => types::I16,
  38             UintTy::U32 => types::I32,
  39             UintTy::U64 => types::I64,
  40             UintTy::U128 => types::I128,
  41             UintTy::Usize => pointer_ty(tcx),
  42         },
  43         ty::Int(size) => match size {
  44             IntTy::I8 => types::I8,
  45             IntTy::I16 => types::I16,
  46             IntTy::I32 => types::I32,
  47             IntTy::I64 => types::I64,
  48             IntTy::I128 => types::I128,
  49             IntTy::Isize => pointer_ty(tcx),
  50         },
  51         ty::Char => types::I32,
  52         ty::Float(size) => match size {
  53             FloatTy::F32 => types::F32,
  54             FloatTy::F64 => types::F64,
  55         },
  56         ty::FnPtr(_) => pointer_ty(tcx),
  57         ty::RawPtr(TypeAndMut { ty: pointee_ty, mutbl: _ }) | ty::Ref(_, pointee_ty, _) => {
  58             if has_ptr_meta(tcx, pointee_ty) {
  59                 return None;
  60             } else {
  61                 pointer_ty(tcx)
  62             }
  63         }
  64         ty::Adt(adt_def, _) if adt_def.repr.simd() => {
  65             let (element, count) = match &tcx.layout_of(ParamEnv::reveal_all().and(ty)).unwrap().abi
  66             {
  67                 Abi::Vector { element, count } => (element.clone(), *count),
  68                 _ => unreachable!(),
  69             };
  70
  71             match scalar_to_clif_type(tcx, element).by(u16::try_from(count).unwrap()) {
  72                 // Cranelift currently only implements icmp for 128bit vectors.
  73                 Some(vector_ty) if vector_ty.bits() == 128 => vector_ty,
  74                 _ => return None,
  75             }
  76         }
  77         ty::Param(_) => bug!("ty param {:?}", ty),
  78         _ => return None,
  79     })
  80 }
  81
  82 fn clif_pair_type_from_ty<'tcx>(
  83     tcx: TyCtxt<'tcx>,
  84     ty: Ty<'tcx>,
  85 ) -> Option<(types::Type, types::Type)> {
  86     Some(match ty.kind() {
  87         ty::Tuple(substs) if substs.len() == 2 => {
  88             let mut types = substs.types();
  89             let a = clif_type_from_ty(tcx, types.next().unwrap())?;
  90             let b = clif_type_from_ty(tcx, types.next().unwrap())?;
  91             if a.is_vector() || b.is_vector() {
  92                 return None;
  93             }
  94             (a, b)
  95         }
  96         ty::RawPtr(TypeAndMut { ty: pointee_ty, mutbl: _ }) | ty::Ref(_, pointee_ty, _) => {
  97             if has_ptr_meta(tcx, pointee_ty) {
  98                 (pointer_ty(tcx), pointer_ty(tcx))
  99             } else {
 100                 return None;
 101             }
 102         }
 103         _ => return None,
 104     })
 105 }
 106
 107 /// Is a pointer to this type a fat ptr?
 108 pub(crate) fn has_ptr_meta<'tcx>(tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> bool {
 109     let ptr_ty = tcx.mk_ptr(TypeAndMut { ty, mutbl: rustc_hir::Mutability::Not });
 110     match &tcx.layout_of(ParamEnv::reveal_all().and(ptr_ty)).unwrap().abi {
 111         Abi::Scalar(_) => false,
 112         Abi::ScalarPair(_, _) => true,
 113         abi => unreachable!("Abi of ptr to {:?} is {:?}???", ty, abi),
 114     }
 115 }
 116
 117 pub(crate) fn codegen_icmp_imm(
 118     fx: &mut FunctionCx<'_, '_, '_>,
 119     intcc: IntCC,
 120     lhs: Value,
 121     rhs: i128,
 122 ) -> Value {
 123     let lhs_ty = fx.bcx.func.dfg.value_type(lhs);
 124     if lhs_ty == types::I128 {
 125         // FIXME legalize `icmp_imm.i128` in Cranelift
 126
 127         let (lhs_lsb, lhs_msb) = fx.bcx.ins().isplit(lhs);
 128         let (rhs_lsb, rhs_msb) = (rhs as u128 as u64 as i64, (rhs as u128 >> 64) as u64 as i64);
 129
 130         match intcc {
 131             IntCC::Equal => {
 132                 let lsb_eq = fx.bcx.ins().icmp_imm(IntCC::Equal, lhs_lsb, rhs_lsb);
 133                 let msb_eq = fx.bcx.ins().icmp_imm(IntCC::Equal, lhs_msb, rhs_msb);
 134                 fx.bcx.ins().band(lsb_eq, msb_eq)
 135             }
 136             IntCC::NotEqual => {
 137                 let lsb_ne = fx.bcx.ins().icmp_imm(IntCC::NotEqual, lhs_lsb, rhs_lsb);
 138                 let msb_ne = fx.bcx.ins().icmp_imm(IntCC::NotEqual, lhs_msb, rhs_msb);
 139                 fx.bcx.ins().bor(lsb_ne, msb_ne)
 140             }
 141             _ => {
 142                 // if msb_eq {
 143                 //     lsb_cc
 144                 // } else {
 145                 //     msb_cc
 146                 // }
 147
 148                 let msb_eq = fx.bcx.ins().icmp_imm(IntCC::Equal, lhs_msb, rhs_msb);
 149                 let lsb_cc = fx.bcx.ins().icmp_imm(intcc, lhs_lsb, rhs_lsb);
 150                 let msb_cc = fx.bcx.ins().icmp_imm(intcc, lhs_msb, rhs_msb);
 151
 152                 fx.bcx.ins().select(msb_eq, lsb_cc, msb_cc)
 153             }
 154         }
 155     } else {
 156         let rhs = i64::try_from(rhs).expect("codegen_icmp_imm rhs out of range for <128bit int");
 157         fx.bcx.ins().icmp_imm(intcc, lhs, rhs)
 158     }
 159 }
 160
 161 pub(crate) fn type_min_max_value(
 162     bcx: &mut FunctionBuilder<'_>,
 163     ty: Type,
 164     signed: bool,
 165 ) -> (Value, Value) {
 166     assert!(ty.is_int());
 167
 168     if ty == types::I128 {
 169         if signed {
 170             let min = i128::MIN as u128;
 171             let min_lsb = bcx.ins().iconst(types::I64, min as u64 as i64);
 172             let min_msb = bcx.ins().iconst(types::I64, (min >> 64) as u64 as i64);
 173             let min = bcx.ins().iconcat(min_lsb, min_msb);
 174
 175             let max = i128::MAX as u128;
 176             let max_lsb = bcx.ins().iconst(types::I64, max as u64 as i64);
 177             let max_msb = bcx.ins().iconst(types::I64, (max >> 64) as u64 as i64);
 178             let max = bcx.ins().iconcat(max_lsb, max_msb);
 179
 180             return (min, max);
 181         } else {
 182             let min_half = bcx.ins().iconst(types::I64, 0);
 183             let min = bcx.ins().iconcat(min_half, min_half);
 184
 185             let max_half = bcx.ins().iconst(types::I64, u64::MAX as i64);
 186             let max = bcx.ins().iconcat(max_half, max_half);
 187
 188             return (min, max);
 189         }
 190     }
 191
 192     let min = match (ty, signed) {
 193         (types::I8, false) | (types::I16, false) | (types::I32, false) | (types::I64, false) => {
 194             0i64
 195         }
 196         (types::I8, true) => i64::from(i8::MIN),
 197         (types::I16, true) => i64::from(i16::MIN),
 198         (types::I32, true) => i64::from(i32::MIN),
 199         (types::I64, true) => i64::MIN,
 200         _ => unreachable!(),
 201     };
 202
 203     let max = match (ty, signed) {
 204         (types::I8, false) => i64::from(u8::MAX),
 205         (types::I16, false) => i64::from(u16::MAX),
 206         (types::I32, false) => i64::from(u32::MAX),
 207         (types::I64, false) => u64::MAX as i64,
 208         (types::I8, true) => i64::from(i8::MAX),
 209         (types::I16, true) => i64::from(i16::MAX),
 210         (types::I32, true) => i64::from(i32::MAX),
 211         (types::I64, true) => i64::MAX,
 212         _ => unreachable!(),
 213     };
 214
 215     let (min, max) = (bcx.ins().iconst(ty, min), bcx.ins().iconst(ty, max));
 216
 217     (min, max)
 218 }
 219
 220 pub(crate) fn type_sign(ty: Ty<'_>) -> bool {
 221     match ty.kind() {
 222         ty::Ref(..) | ty::RawPtr(..) | ty::FnPtr(..) | ty::Char | ty::Uint(..) | ty::Bool => false,
 223         ty::Int(..) => true,
 224         ty::Float(..) => false, // `signed` is unused for floats
 225         _ => panic!("{}", ty),
 226     }
 227 }
 228
 229 pub(crate) struct FunctionCx<'m, 'clif, 'tcx> {
 230     pub(crate) cx: &'clif mut crate::CodegenCx<'m, 'tcx>,
 231     pub(crate) tcx: TyCtxt<'tcx>,
 232     pub(crate) pointer_type: Type, // Cached from module
 233
 234     pub(crate) instance: Instance<'tcx>,
 235     pub(crate) mir: &'tcx Body<'tcx>,
 236     pub(crate) fn_abi: Option<FnAbi<'tcx, Ty<'tcx>>>,
 237
 238     pub(crate) bcx: FunctionBuilder<'clif>,
 239     pub(crate) block_map: IndexVec<BasicBlock, Block>,
 240     pub(crate) local_map: IndexVec<Local, CPlace<'tcx>>,
 241
 242     /// When `#[track_caller]` is used, the implicit caller location is stored in this variable.
 243     pub(crate) caller_location: Option<CValue<'tcx>>,
 244
 245     /// See [`crate::optimize::code_layout`] for more information.
 246     pub(crate) cold_blocks: EntitySet<Block>,
 247
 248     pub(crate) clif_comments: crate::pretty_clif::CommentWriter,
 249     pub(crate) source_info_set: indexmap::IndexSet<SourceInfo>,
 250
 251     /// This should only be accessed by `CPlace::new_var`.
 252     pub(crate) next_ssa_var: u32,
 253
 254     pub(crate) inline_asm_index: u32,
 255 }
 256
 257 impl<'tcx> LayoutOf for FunctionCx<'_, '_, 'tcx> {
 258     type Ty = Ty<'tcx>;
 259     type TyAndLayout = TyAndLayout<'tcx>;
 260
 261     fn layout_of(&self, ty: Ty<'tcx>) -> TyAndLayout<'tcx> {
 262         RevealAllLayoutCx(self.tcx).layout_of(ty)
 263     }
 264 }
 265
 266 impl<'tcx> layout::HasTyCtxt<'tcx> for FunctionCx<'_, '_, 'tcx> {
 267     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
 268         self.tcx
 269     }
 270 }
 271
 272 impl<'tcx> rustc_target::abi::HasDataLayout for FunctionCx<'_, '_, 'tcx> {
 273     fn data_layout(&self) -> &rustc_target::abi::TargetDataLayout {
 274         &self.tcx.data_layout
 275     }
 276 }
 277
 278 impl<'tcx> layout::HasParamEnv<'tcx> for FunctionCx<'_, '_, 'tcx> {
 279     fn param_env(&self) -> ParamEnv<'tcx> {
 280         ParamEnv::reveal_all()
 281     }
 282 }
 283
 284 impl<'tcx> HasTargetSpec for FunctionCx<'_, '_, 'tcx> {
 285     fn target_spec(&self) -> &Target {
 286         &self.tcx.sess.target
 287     }
 288 }
 289
 290 impl<'tcx> FunctionCx<'_, '_, 'tcx> {
 291     pub(crate) fn monomorphize<T>(&self, value: T) -> T
 292     where
 293         T: TypeFoldable<'tcx> + Copy,
 294     {
 295         self.instance.subst_mir_and_normalize_erasing_regions(
 296             self.tcx,
 297             ty::ParamEnv::reveal_all(),
 298             value,
 299         )
 300     }
 301
 302     pub(crate) fn clif_type(&self, ty: Ty<'tcx>) -> Option<Type> {
 303         clif_type_from_ty(self.tcx, ty)
 304     }
 305
 306     pub(crate) fn clif_pair_type(&self, ty: Ty<'tcx>) -> Option<(Type, Type)> {
 307         clif_pair_type_from_ty(self.tcx, ty)
 308     }
 309
 310     pub(crate) fn get_block(&self, bb: BasicBlock) -> Block {
 311         *self.block_map.get(bb).unwrap()
 312     }
 313
 314     pub(crate) fn get_local_place(&mut self, local: Local) -> CPlace<'tcx> {
 315         *self.local_map.get(local).unwrap_or_else(|| {
 316             panic!("Local {:?} doesn't exist", local);
 317         })
 318     }
 319
 320     pub(crate) fn set_debug_loc(&mut self, source_info: mir::SourceInfo) {
 321         let (index, _) = self.source_info_set.insert_full(source_info);
 322         self.bcx.set_srcloc(SourceLoc::new(index as u32));
 323     }
 324
 325     pub(crate) fn get_caller_location(&mut self, span: Span) -> CValue<'tcx> {
 326         if let Some(loc) = self.caller_location {
 327             // `#[track_caller]` is used; return caller location instead of current location.
 328             return loc;
 329         }
 330
 331         let topmost = span.ctxt().outer_expn().expansion_cause().unwrap_or(span);
 332         let caller = self.tcx.sess.source_map().lookup_char_pos(topmost.lo());
 333         let const_loc = self.tcx.const_caller_location((
 334             rustc_span::symbol::Symbol::intern(&caller.file.name.to_string()),
 335             caller.line as u32,
 336             caller.col_display as u32 + 1,
 337         ));
 338         crate::constant::codegen_const_value(self, const_loc, self.tcx.caller_location_ty())
 339     }
 340
 341     pub(crate) fn triple(&self) -> &target_lexicon::Triple {
 342         self.cx.module.isa().triple()
 343     }
 344
 345     pub(crate) fn anonymous_str(&mut self, prefix: &str, msg: &str) -> Value {
 346         use std::collections::hash_map::DefaultHasher;
 347         use std::hash::{Hash, Hasher};
 348
 349         let mut hasher = DefaultHasher::new();
 350         msg.hash(&mut hasher);
 351         let msg_hash = hasher.finish();
 352         let mut data_ctx = DataContext::new();
 353         data_ctx.define(msg.as_bytes().to_vec().into_boxed_slice());
 354         let msg_id = self
 355             .cx
 356             .module
 357             .declare_data(&format!("__{}_{:08x}", prefix, msg_hash), Linkage::Local, false, false)
 358             .unwrap();
 359
 360         // Ignore DuplicateDefinition error, as the data will be the same
 361         let _ = self.cx.module.define_data(msg_id, &data_ctx);
 362
 363         let local_msg_id = self.cx.module.declare_data_in_func(msg_id, self.bcx.func);
 364         #[cfg(debug_assertions)]
 365         {
 366             self.add_comment(local_msg_id, msg);
 367         }
 368         self.bcx.ins().global_value(self.pointer_type, local_msg_id)
 369     }
 370 }
 371
 372 pub(crate) struct RevealAllLayoutCx<'tcx>(pub(crate) TyCtxt<'tcx>);
 373
 374 impl<'tcx> LayoutOf for RevealAllLayoutCx<'tcx> {
 375     type Ty = Ty<'tcx>;
 376     type TyAndLayout = TyAndLayout<'tcx>;
 377
 378     fn layout_of(&self, ty: Ty<'tcx>) -> TyAndLayout<'tcx> {
 379         assert!(!ty.still_further_specializable());
 380         self.0.layout_of(ParamEnv::reveal_all().and(&ty)).unwrap_or_else(|e| {
 381             if let layout::LayoutError::SizeOverflow(_) = e {
 382                 self.0.sess.fatal(&e.to_string())
 383             } else {
 384                 bug!("failed to get layout for `{}`: {}", ty, e)
 385             }
 386         })
 387     }
 388 }
 389
 390 impl<'tcx> layout::HasTyCtxt<'tcx> for RevealAllLayoutCx<'tcx> {
 391     fn tcx<'b>(&'b self) -> TyCtxt<'tcx> {
 392         self.0
 393     }
 394 }
 395
 396 impl<'tcx> rustc_target::abi::HasDataLayout for RevealAllLayoutCx<'tcx> {
 397     fn data_layout(&self) -> &rustc_target::abi::TargetDataLayout {
 398         &self.0.data_layout
 399     }
 400 }
 401
 402 impl<'tcx> layout::HasParamEnv<'tcx> for RevealAllLayoutCx<'tcx> {
 403     fn param_env(&self) -> ParamEnv<'tcx> {
 404         ParamEnv::reveal_all()
 405     }
 406 }
 407
 408 impl<'tcx> HasTargetSpec for RevealAllLayoutCx<'tcx> {
 409     fn target_spec(&self) -> &Target {
 410         &self.0.sess.target
 411     }
 412 }