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