src/librustc_trans/trans/type_.rs

   1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 #![allow(non_upper_case_globals)]
  12
  13 use llvm;
  14 use llvm::{TypeRef, Bool, False, True, TypeKind, ValueRef};
  15 use llvm::{Float, Double, X86_FP80, PPC_FP128, FP128};
  16
  17 use trans::context::CrateContext;
  18 use util::nodemap::FnvHashMap;
  19
  20 use syntax::ast;
  21
  22 use std::ffi::CString;
  23 use std::mem;
  24 use std::ptr;
  25 use std::cell::RefCell;
  26
  27 use libc::c_uint;
  28
  29 #[derive(Clone, Copy, PartialEq, Debug)]
  30 #[repr(C)]
  31 pub struct Type {
  32     rf: TypeRef
  33 }
  34
  35 macro_rules! ty {
  36     ($e:expr) => ( Type::from_ref(unsafe { $e }))
  37 }
  38
  39 /// Wrapper for LLVM TypeRef
  40 impl Type {
  41     #[inline(always)]
  42     pub fn from_ref(r: TypeRef) -> Type {
  43         Type {
  44             rf: r
  45         }
  46     }
  47
  48     #[inline(always)] // So it doesn't kill --opt-level=0 builds of the compiler
  49     pub fn to_ref(&self) -> TypeRef {
  50         self.rf
  51     }
  52
  53     pub fn void(ccx: &CrateContext) -> Type {
  54         ty!(llvm::LLVMVoidTypeInContext(ccx.llcx()))
  55     }
  56
  57     pub fn nil(ccx: &CrateContext) -> Type {
  58         Type::empty_struct(ccx)
  59     }
  60
  61     pub fn metadata(ccx: &CrateContext) -> Type {
  62         ty!(llvm::LLVMMetadataTypeInContext(ccx.llcx()))
  63     }
  64
  65     pub fn i1(ccx: &CrateContext) -> Type {
  66         ty!(llvm::LLVMInt1TypeInContext(ccx.llcx()))
  67     }
  68
  69     pub fn i8(ccx: &CrateContext) -> Type {
  70         ty!(llvm::LLVMInt8TypeInContext(ccx.llcx()))
  71     }
  72
  73     pub fn i16(ccx: &CrateContext) -> Type {
  74         ty!(llvm::LLVMInt16TypeInContext(ccx.llcx()))
  75     }
  76
  77     pub fn i32(ccx: &CrateContext) -> Type {
  78         ty!(llvm::LLVMInt32TypeInContext(ccx.llcx()))
  79     }
  80
  81     pub fn i64(ccx: &CrateContext) -> Type {
  82         ty!(llvm::LLVMInt64TypeInContext(ccx.llcx()))
  83     }
  84
  85     // Creates an integer type with the given number of bits, e.g. i24
  86     pub fn ix(ccx: &CrateContext, num_bits: u64) -> Type {
  87         ty!(llvm::LLVMIntTypeInContext(ccx.llcx(), num_bits as c_uint))
  88     }
  89
  90     pub fn f32(ccx: &CrateContext) -> Type {
  91         ty!(llvm::LLVMFloatTypeInContext(ccx.llcx()))
  92     }
  93
  94     pub fn f64(ccx: &CrateContext) -> Type {
  95         ty!(llvm::LLVMDoubleTypeInContext(ccx.llcx()))
  96     }
  97
  98     pub fn bool(ccx: &CrateContext) -> Type {
  99         Type::i8(ccx)
 100     }
 101
 102     pub fn char(ccx: &CrateContext) -> Type {
 103         Type::i32(ccx)
 104     }
 105
 106     pub fn i8p(ccx: &CrateContext) -> Type {
 107         Type::i8(ccx).ptr_to()
 108     }
 109
 110     pub fn int(ccx: &CrateContext) -> Type {
 111         match &ccx.tcx().sess.target.target.target_pointer_width[..] {
 112             "32" => Type::i32(ccx),
 113             "64" => Type::i64(ccx),
 114             tws => panic!("Unsupported target word size for int: {}", tws),
 115         }
 116     }
 117
 118     pub fn int_from_ty(ccx: &CrateContext, t: ast::IntTy) -> Type {
 119         match t {
 120             ast::TyIs => ccx.int_type(),
 121             ast::TyI8 => Type::i8(ccx),
 122             ast::TyI16 => Type::i16(ccx),
 123             ast::TyI32 => Type::i32(ccx),
 124             ast::TyI64 => Type::i64(ccx)
 125         }
 126     }
 127
 128     pub fn uint_from_ty(ccx: &CrateContext, t: ast::UintTy) -> Type {
 129         match t {
 130             ast::TyUs => ccx.int_type(),
 131             ast::TyU8 => Type::i8(ccx),
 132             ast::TyU16 => Type::i16(ccx),
 133             ast::TyU32 => Type::i32(ccx),
 134             ast::TyU64 => Type::i64(ccx)
 135         }
 136     }
 137
 138     pub fn float_from_ty(ccx: &CrateContext, t: ast::FloatTy) -> Type {
 139         match t {
 140             ast::TyF32 => Type::f32(ccx),
 141             ast::TyF64 => Type::f64(ccx),
 142         }
 143     }
 144
 145     pub fn func(args: &[Type], ret: &Type) -> Type {
 146         let vec : &[TypeRef] = unsafe { mem::transmute(args) };
 147         ty!(llvm::LLVMFunctionType(ret.to_ref(), vec.as_ptr(),
 148                                    args.len() as c_uint, False))
 149     }
 150
 151     pub fn variadic_func(args: &[Type], ret: &Type) -> Type {
 152         let vec : &[TypeRef] = unsafe { mem::transmute(args) };
 153         ty!(llvm::LLVMFunctionType(ret.to_ref(), vec.as_ptr(),
 154                                    args.len() as c_uint, True))
 155     }
 156
 157     pub fn struct_(ccx: &CrateContext, els: &[Type], packed: bool) -> Type {
 158         let els : &[TypeRef] = unsafe { mem::transmute(els) };
 159         ty!(llvm::LLVMStructTypeInContext(ccx.llcx(), els.as_ptr(),
 160                                           els.len() as c_uint,
 161                                           packed as Bool))
 162     }
 163
 164     pub fn named_struct(ccx: &CrateContext, name: &str) -> Type {
 165         let name = CString::new(name).unwrap();
 166         ty!(llvm::LLVMStructCreateNamed(ccx.llcx(), name.as_ptr()))
 167     }
 168
 169     pub fn empty_struct(ccx: &CrateContext) -> Type {
 170         Type::struct_(ccx, &[], false)
 171     }
 172
 173     pub fn glue_fn(ccx: &CrateContext, t: Type) -> Type {
 174         Type::func(&[t], &Type::void(ccx))
 175     }
 176
 177     pub fn array(ty: &Type, len: u64) -> Type {
 178         ty!(llvm::LLVMRustArrayType(ty.to_ref(), len))
 179     }
 180
 181     pub fn vector(ty: &Type, len: u64) -> Type {
 182         ty!(llvm::LLVMVectorType(ty.to_ref(), len as c_uint))
 183     }
 184
 185     pub fn vec(ccx: &CrateContext, ty: &Type) -> Type {
 186         Type::struct_(ccx,
 187             &[Type::array(ty, 0), Type::int(ccx)],
 188         false)
 189     }
 190
 191     pub fn opaque_vec(ccx: &CrateContext) -> Type {
 192         Type::vec(ccx, &Type::i8(ccx))
 193     }
 194
 195     pub fn vtable_ptr(ccx: &CrateContext) -> Type {
 196         Type::glue_fn(ccx, Type::i8p(ccx)).ptr_to().ptr_to()
 197     }
 198
 199     pub fn kind(&self) -> TypeKind {
 200         unsafe {
 201             llvm::LLVMGetTypeKind(self.to_ref())
 202         }
 203     }
 204
 205     pub fn set_struct_body(&mut self, els: &[Type], packed: bool) {
 206         unsafe {
 207             let vec : &[TypeRef] = mem::transmute(els);
 208             llvm::LLVMStructSetBody(self.to_ref(), vec.as_ptr(),
 209                                     els.len() as c_uint, packed as Bool)
 210         }
 211     }
 212
 213     pub fn ptr_to(&self) -> Type {
 214         ty!(llvm::LLVMPointerType(self.to_ref(), 0))
 215     }
 216
 217     pub fn is_aggregate(&self) -> bool {
 218         match self.kind() {
 219             TypeKind::Struct | TypeKind::Array => true,
 220             _ =>  false
 221         }
 222     }
 223
 224     pub fn is_packed(&self) -> bool {
 225         unsafe {
 226             llvm::LLVMIsPackedStruct(self.to_ref()) == True
 227         }
 228     }
 229
 230     pub fn element_type(&self) -> Type {
 231         unsafe {
 232             Type::from_ref(llvm::LLVMGetElementType(self.to_ref()))
 233         }
 234     }
 235
 236     /// Return the number of elements in `self` if it is a LLVM vector type.
 237     pub fn vector_length(&self) -> usize {
 238         unsafe {
 239             llvm::LLVMGetVectorSize(self.to_ref()) as usize
 240         }
 241     }
 242
 243     pub fn array_length(&self) -> usize {
 244         unsafe {
 245             llvm::LLVMGetArrayLength(self.to_ref()) as usize
 246         }
 247     }
 248
 249     pub fn field_types(&self) -> Vec<Type> {
 250         unsafe {
 251             let n_elts = llvm::LLVMCountStructElementTypes(self.to_ref()) as usize;
 252             if n_elts == 0 {
 253                 return Vec::new();
 254             }
 255             let mut elts = vec![Type { rf: ptr::null_mut() }; n_elts];
 256             llvm::LLVMGetStructElementTypes(self.to_ref(),
 257                                             elts.as_mut_ptr() as *mut TypeRef);
 258             elts
 259         }
 260     }
 261
 262     pub fn return_type(&self) -> Type {
 263         ty!(llvm::LLVMGetReturnType(self.to_ref()))
 264     }
 265
 266     pub fn func_params(&self) -> Vec<Type> {
 267         unsafe {
 268             let n_args = llvm::LLVMCountParamTypes(self.to_ref()) as usize;
 269             let mut args = vec![Type { rf: ptr::null_mut() }; n_args];
 270             llvm::LLVMGetParamTypes(self.to_ref(),
 271                                     args.as_mut_ptr() as *mut TypeRef);
 272             args
 273         }
 274     }
 275
 276     pub fn float_width(&self) -> usize {
 277         match self.kind() {
 278             Float => 32,
 279             Double => 64,
 280             X86_FP80 => 80,
 281             FP128 | PPC_FP128 => 128,
 282             _ => panic!("llvm_float_width called on a non-float type")
 283         }
 284     }
 285
 286     /// Retrieve the bit width of the integer type `self`.
 287     pub fn int_width(&self) -> u64 {
 288         unsafe {
 289             llvm::LLVMGetIntTypeWidth(self.to_ref()) as u64
 290         }
 291     }
 292 }
 293
 294
 295 /* Memory-managed object interface to type handles. */
 296
 297 pub struct TypeNames {
 298     named_types: RefCell<FnvHashMap<String, TypeRef>>,
 299 }
 300
 301 impl TypeNames {
 302     pub fn new() -> TypeNames {
 303         TypeNames {
 304             named_types: RefCell::new(FnvHashMap())
 305         }
 306     }
 307
 308     pub fn associate_type(&self, s: &str, t: &Type) {
 309         assert!(self.named_types.borrow_mut().insert(s.to_string(),
 310                                                      t.to_ref()).is_none());
 311     }
 312
 313     pub fn find_type(&self, s: &str) -> Option<Type> {
 314         self.named_types.borrow().get(s).map(|x| Type::from_ref(*x))
 315     }
 316
 317     pub fn type_to_string(&self, ty: Type) -> String {
 318         llvm::build_string(|s| unsafe {
 319                 llvm::LLVMWriteTypeToString(ty.to_ref(), s);
 320             }).expect("non-UTF8 type description from LLVM")
 321     }
 322
 323     pub fn types_to_str(&self, tys: &[Type]) -> String {
 324         let strs: Vec<String> = tys.iter().map(|t| self.type_to_string(*t)).collect();
 325         format!("[{}]", strs.join(","))
 326     }
 327
 328     pub fn val_to_string(&self, val: ValueRef) -> String {
 329         llvm::build_string(|s| unsafe {
 330                 llvm::LLVMWriteValueToString(val, s);
 331             }).expect("nun-UTF8 value description from LLVM")
 332     }
 333 }