src/common.rs

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