src/common.rs

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