src/common.rs

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