src/common.rs

   1 use std::convert::TryFrom;
   2 use std::convert::TryInto;
   3
   4 use gccjit::LValue;
   5 use gccjit::{Block, CType, RValue, Type, ToRValue};
   6 use rustc_codegen_ssa::mir::place::PlaceRef;
   7 use rustc_codegen_ssa::traits::{
   8     BaseTypeMethods,
   9     ConstMethods,
  10     DerivedTypeMethods,
  11     MiscMethods,
  12     StaticMethods,
  13 };
  14 use rustc_middle::mir::Mutability;
  15 use rustc_middle::ty::ScalarInt;
  16 use rustc_middle::ty::layout::{TyAndLayout, LayoutOf};
  17 use rustc_middle::mir::interpret::{Allocation, GlobalAlloc, Scalar};
  18 use rustc_span::Symbol;
  19 use rustc_target::abi::{self, HasDataLayout, Pointer, Size};
  20
  21 use crate::consts::const_alloc_to_gcc;
  22 use crate::context::CodegenCx;
  23 use crate::type_of::LayoutGccExt;
  24
  25 impl<'gcc, 'tcx> CodegenCx<'gcc, 'tcx> {
  26     pub fn const_bytes(&self, bytes: &[u8]) -> RValue<'gcc> {
  27         bytes_in_context(self, bytes)
  28     }
  29
  30     fn const_cstr(&self, symbol: Symbol, _null_terminated: bool) -> LValue<'gcc> {
  31         // TODO(antoyo): handle null_terminated.
  32         if let Some(&value) = self.const_cstr_cache.borrow().get(&symbol) {
  33             return value;
  34         }
  35
  36         let global = self.global_string(&*symbol.as_str());
  37
  38         self.const_cstr_cache.borrow_mut().insert(symbol, global);
  39         global
  40     }
  41
  42     fn global_string(&self, string: &str) -> LValue<'gcc> {
  43         // TODO(antoyo): handle non-null-terminated strings.
  44         let string = self.context.new_string_literal(&*string);
  45         let sym = self.generate_local_symbol_name("str");
  46         // NOTE: TLS is always off for a string litteral.
  47         // NOTE: string litterals do not have a link section.
  48         let global = self.declare_private_global(&sym, self.val_ty(string));
  49         global.global_set_initializer_value(string); // TODO: only set if not imported?
  50         global
  51         // TODO(antoyo): set linkage.
  52     }
  53
  54     pub fn inttoptr(&self, block: Block<'gcc>, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
  55         let func = block.get_function();
  56         let local = func.new_local(None, value.get_type(), "intLocal");
  57         block.add_assignment(None, local, value);
  58         let value_address = local.get_address(None);
  59
  60         let ptr = self.context.new_cast(None, value_address, dest_ty.make_pointer());
  61         ptr.dereference(None).to_rvalue()
  62     }
  63
  64     pub fn ptrtoint(&self, block: Block<'gcc>, value: RValue<'gcc>, dest_ty: Type<'gcc>) -> RValue<'gcc> {
  65         // TODO(antoyo): when libgccjit allow casting from pointer to int, remove this.
  66         let func = block.get_function();
  67         let local = func.new_local(None, value.get_type(), "ptrLocal");
  68         block.add_assignment(None, local, value);
  69         let ptr_address = local.get_address(None);
  70
  71         let ptr = self.context.new_cast(None, ptr_address, dest_ty.make_pointer());
  72         ptr.dereference(None).to_rvalue()
  73     }
  74 }
  75
  76 pub fn bytes_in_context<'gcc, 'tcx>(cx: &CodegenCx<'gcc, 'tcx>, bytes: &[u8]) -> RValue<'gcc> {
  77     let context = &cx.context;
  78     let byte_type = context.new_type::<u8>();
  79     let typ = context.new_array_type(None, byte_type, bytes.len() as i32);
  80     let elements: Vec<_> =
  81         bytes.iter()
  82         .map(|&byte| context.new_rvalue_from_int(byte_type, byte as i32))
  83         .collect();
  84     context.new_rvalue_from_array(None, typ, &elements)
  85 }
  86
  87 pub fn type_is_pointer<'gcc>(typ: Type<'gcc>) -> bool {
  88     typ.get_pointee().is_some()
  89 }
  90
  91 impl<'gcc, 'tcx> ConstMethods<'tcx> for CodegenCx<'gcc, 'tcx> {
  92     fn const_null(&self, typ: Type<'gcc>) -> RValue<'gcc> {
  93         if type_is_pointer(typ) {
  94             self.context.new_null(typ)
  95         }
  96         else {
  97             self.const_int(typ, 0)
  98         }
  99     }
 100
 101     fn const_undef(&self, typ: Type<'gcc>) -> RValue<'gcc> {
 102         let local = self.current_func.borrow().expect("func")
 103             .new_local(None, typ, "undefined");
 104         if typ.is_struct().is_some() {
 105             // NOTE: hack to workaround a limitation of the rustc API: see comment on
 106             // CodegenCx.structs_as_pointer
 107             let pointer = local.get_address(None);
 108             self.structs_as_pointer.borrow_mut().insert(pointer);
 109             pointer
 110         }
 111         else {
 112             local.to_rvalue()
 113         }
 114     }
 115
 116     fn const_int(&self, typ: Type<'gcc>, int: i64) -> RValue<'gcc> {
 117         self.context.new_rvalue_from_long(typ, i64::try_from(int).expect("i64::try_from"))
 118     }
 119
 120     fn const_uint(&self, typ: Type<'gcc>, int: u64) -> RValue<'gcc> {
 121         self.context.new_rvalue_from_long(typ, u64::try_from(int).expect("u64::try_from") as i64)
 122     }
 123
 124     fn const_uint_big(&self, typ: Type<'gcc>, num: u128) -> RValue<'gcc> {
 125         let num64: Result<i64, _> = num.try_into();
 126         if let Ok(num) = num64 {
 127             // FIXME(antoyo): workaround for a bug where libgccjit is expecting a constant.
 128             // The operations >> 64 and | low are making the normal case a non-constant.
 129             return self.context.new_rvalue_from_long(typ, num as i64);
 130         }
 131
 132         if num >> 64 != 0 {
 133             // FIXME(antoyo): use a new function new_rvalue_from_unsigned_long()?
 134             let low = self.context.new_rvalue_from_long(self.u64_type, num as u64 as i64);
 135             let high = self.context.new_rvalue_from_long(typ, (num >> 64) as u64 as i64);
 136
 137             let sixty_four = self.context.new_rvalue_from_long(typ, 64);
 138             (high << sixty_four) | self.context.new_cast(None, low, typ)
 139         }
 140         else if typ.is_i128(self) {
 141             let num = self.context.new_rvalue_from_long(self.u64_type, num as u64 as i64);
 142             self.context.new_cast(None, num, typ)
 143         }
 144         else {
 145             self.context.new_rvalue_from_long(typ, num as u64 as i64)
 146         }
 147     }
 148
 149     fn const_bool(&self, val: bool) -> RValue<'gcc> {
 150         self.const_uint(self.type_i1(), val as u64)
 151     }
 152
 153     fn const_i32(&self, i: i32) -> RValue<'gcc> {
 154         self.const_int(self.type_i32(), i as i64)
 155     }
 156
 157     fn const_u32(&self, i: u32) -> RValue<'gcc> {
 158         self.const_uint(self.type_u32(), i as u64)
 159     }
 160
 161     fn const_u64(&self, i: u64) -> RValue<'gcc> {
 162         self.const_uint(self.type_u64(), i)
 163     }
 164
 165     fn const_usize(&self, i: u64) -> RValue<'gcc> {
 166         let bit_size = self.data_layout().pointer_size.bits();
 167         if bit_size < 64 {
 168             // make sure it doesn't overflow
 169             assert!(i < (1 << bit_size));
 170         }
 171
 172         self.const_uint(self.usize_type, i)
 173     }
 174
 175     fn const_u8(&self, _i: u8) -> RValue<'gcc> {
 176         unimplemented!();
 177     }
 178
 179     fn const_real(&self, _t: Type<'gcc>, _val: f64) -> RValue<'gcc> {
 180         unimplemented!();
 181     }
 182
 183     fn const_str(&self, s: Symbol) -> (RValue<'gcc>, RValue<'gcc>) {
 184         let len = s.as_str().len();
 185         let cs = self.const_ptrcast(self.const_cstr(s, false).get_address(None),
 186             self.type_ptr_to(self.layout_of(self.tcx.types.str_).gcc_type(self, true)),
 187         );
 188         (cs, self.const_usize(len as u64))
 189     }
 190
 191     fn const_struct(&self, values: &[RValue<'gcc>], packed: bool) -> RValue<'gcc> {
 192         let fields: Vec<_> = values.iter()
 193             .map(|value| value.get_type())
 194             .collect();
 195         // TODO(antoyo): cache the type? It's anonymous, so probably not.
 196         let typ = self.type_struct(&fields, packed);
 197         let struct_type = typ.is_struct().expect("struct type");
 198         self.context.new_rvalue_from_struct(None, struct_type, values)
 199     }
 200
 201     fn const_to_opt_uint(&self, _v: RValue<'gcc>) -> Option<u64> {
 202         // TODO(antoyo)
 203         None
 204     }
 205
 206     fn const_to_opt_u128(&self, _v: RValue<'gcc>, _sign_ext: bool) -> Option<u128> {
 207         // TODO(antoyo)
 208         None
 209     }
 210
 211     fn scalar_to_backend(&self, cv: Scalar, layout: abi::Scalar, ty: Type<'gcc>) -> RValue<'gcc> {
 212         let bitsize = if layout.is_bool() { 1 } else { layout.value.size(self).bits() };
 213         match cv {
 214             Scalar::Int(ScalarInt::ZST) => {
 215                 assert_eq!(0, layout.value.size(self).bytes());
 216                 self.const_undef(self.type_ix(0))
 217             }
 218             Scalar::Int(int) => {
 219                 let data = int.assert_bits(layout.value.size(self));
 220
 221                 // FIXME(antoyo): there's some issues with using the u128 code that follows, so hard-code
 222                 // the paths for floating-point values.
 223                 if ty == self.float_type {
 224                     return self.context.new_rvalue_from_double(ty, f32::from_bits(data as u32) as f64);
 225                 }
 226                 else if ty == self.double_type {
 227                     return self.context.new_rvalue_from_double(ty, f64::from_bits(data as u64));
 228                 }
 229
 230                 let value = self.const_uint_big(self.type_ix(bitsize), data);
 231                 if layout.value == Pointer {
 232                     self.inttoptr(self.current_block.borrow().expect("block"), value, ty)
 233                 } else {
 234                     self.const_bitcast(value, ty)
 235                 }
 236             }
 237             Scalar::Ptr(ptr, _size) => {
 238                 let (alloc_id, offset) = ptr.into_parts();
 239                 let base_addr =
 240                     match self.tcx.global_alloc(alloc_id) {
 241                         GlobalAlloc::Memory(alloc) => {
 242                             let init = const_alloc_to_gcc(self, alloc);
 243                             let value =
 244                                 match alloc.mutability {
 245                                     Mutability::Mut => self.static_addr_of_mut(init, alloc.align, None),
 246                                     _ => self.static_addr_of(init, alloc.align, None),
 247                                 };
 248                             if !self.sess().fewer_names() {
 249                                 // TODO(antoyo): set value name.
 250                             }
 251                             value
 252                         },
 253                         GlobalAlloc::Function(fn_instance) => {
 254                             self.get_fn_addr(fn_instance)
 255                         },
 256                         GlobalAlloc::Static(def_id) => {
 257                             assert!(self.tcx.is_static(def_id));
 258                             self.get_static(def_id).get_address(None)
 259                         },
 260                     };
 261                 let ptr_type = base_addr.get_type();
 262                 let base_addr = self.const_bitcast(base_addr, self.usize_type);
 263                 let offset = self.context.new_rvalue_from_long(self.usize_type, offset.bytes() as i64);
 264                 let ptr = self.const_bitcast(base_addr + offset, ptr_type);
 265                 if layout.value != Pointer {
 266                     self.const_bitcast(ptr.dereference(None).to_rvalue(), ty)
 267                 }
 268                 else {
 269                     self.const_bitcast(ptr, ty)
 270                 }
 271             }
 272         }
 273     }
 274
 275     fn const_data_from_alloc(&self, alloc: &Allocation) -> Self::Value {
 276         const_alloc_to_gcc(self, alloc)
 277     }
 278
 279     fn from_const_alloc(&self, layout: TyAndLayout<'tcx>, alloc: &Allocation, offset: Size) -> PlaceRef<'tcx, RValue<'gcc>> {
 280         assert_eq!(alloc.align, layout.align.abi);
 281         let ty = self.type_ptr_to(layout.gcc_type(self, true));
 282         let value =
 283             if layout.size == Size::ZERO {
 284                 let value = self.const_usize(alloc.align.bytes());
 285                 self.context.new_cast(None, value, ty)
 286             }
 287             else {
 288                 let init = const_alloc_to_gcc(self, alloc);
 289                 let base_addr = self.static_addr_of(init, alloc.align, None);
 290
 291                 let array = self.const_bitcast(base_addr, self.type_i8p());
 292                 let value = self.context.new_array_access(None, array, self.const_usize(offset.bytes())).get_address(None);
 293                 self.const_bitcast(value, ty)
 294             };
 295         PlaceRef::new_sized(value, layout)
 296     }
 297
 298     fn const_ptrcast(&self, val: RValue<'gcc>, ty: Type<'gcc>) -> RValue<'gcc> {
 299         self.context.new_cast(None, val, ty)
 300     }
 301 }
 302
 303 pub trait SignType<'gcc, 'tcx> {
 304     fn is_signed(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 305     fn is_unsigned(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 306     fn to_signed(&self, cx: &CodegenCx<'gcc, 'tcx>) -> Type<'gcc>;
 307 }
 308
 309 impl<'gcc, 'tcx> SignType<'gcc, 'tcx> for Type<'gcc> {
 310     fn is_signed(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 311         self.is_i8(cx) || self.is_i16(cx) || self.is_i32(cx) || self.is_i64(cx) || self.is_i128(cx)
 312     }
 313
 314     fn is_unsigned(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 315         self.is_u8(cx) || self.is_u16(cx) || self.is_u32(cx) || self.is_u64(cx) || self.is_u128(cx)
 316     }
 317
 318     fn to_signed(&self, cx: &CodegenCx<'gcc, 'tcx>) -> Type<'gcc> {
 319         if self.is_u8(cx) {
 320             cx.i8_type
 321         }
 322         else if self.is_u16(cx) {
 323             cx.i16_type
 324         }
 325         else if self.is_u32(cx) {
 326             cx.i32_type
 327         }
 328         else if self.is_u64(cx) {
 329             cx.i64_type
 330         }
 331         else if self.is_u128(cx) {
 332             cx.i128_type
 333         }
 334         else {
 335             self.clone()
 336         }
 337     }
 338 }
 339
 340 pub trait TypeReflection<'gcc, 'tcx>  {
 341     fn is_uchar(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 342     fn is_ushort(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 343     fn is_uint(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 344     fn is_ulong(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 345     fn is_ulonglong(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 346
 347     fn is_i8(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 348     fn is_u8(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 349     fn is_i16(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 350     fn is_u16(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 351     fn is_i32(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 352     fn is_u32(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 353     fn is_i64(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 354     fn is_u64(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 355     fn is_i128(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 356     fn is_u128(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 357
 358     fn is_f32(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 359     fn is_f64(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool;
 360 }
 361
 362 impl<'gcc, 'tcx> TypeReflection<'gcc, 'tcx> for Type<'gcc> {
 363     fn is_uchar(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 364         self.unqualified() == cx.u8_type
 365     }
 366
 367     fn is_ushort(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 368         self.unqualified() == cx.u16_type
 369     }
 370
 371     fn is_uint(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 372         self.unqualified() == cx.uint_type
 373     }
 374
 375     fn is_ulong(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 376         self.unqualified() == cx.ulong_type
 377     }
 378
 379     fn is_ulonglong(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 380         self.unqualified() == cx.ulonglong_type
 381     }
 382
 383     fn is_i8(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 384         self.unqualified() == cx.i8_type
 385     }
 386
 387     fn is_u8(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 388         self.unqualified() == cx.u8_type
 389     }
 390
 391     fn is_i16(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 392         self.unqualified() == cx.i16_type
 393     }
 394
 395     fn is_u16(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 396         self.unqualified() == cx.u16_type
 397     }
 398
 399     fn is_i32(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 400         self.unqualified() == cx.i32_type
 401     }
 402
 403     fn is_u32(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 404         self.unqualified() == cx.u32_type
 405     }
 406
 407     fn is_i64(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 408         self.unqualified() == cx.i64_type
 409     }
 410
 411     fn is_u64(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 412         self.unqualified() == cx.u64_type
 413     }
 414
 415     fn is_i128(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 416         self.unqualified() == cx.context.new_c_type(CType::Int128t)
 417     }
 418
 419     fn is_u128(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 420         self.unqualified() == cx.context.new_c_type(CType::UInt128t)
 421     }
 422
 423     fn is_f32(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 424         self.unqualified() == cx.context.new_type::<f32>()
 425     }
 426
 427     fn is_f64(&self, cx: &CodegenCx<'gcc, 'tcx>) -> bool {
 428         self.unqualified() == cx.context.new_type::<f64>()
 429     }
 430 }