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.
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.
11 #![allow(non_upper_case_globals)]
14 use llvm::{TypeRef, Bool, False, True, TypeKind, ValueRef};
15 use llvm::{Float, Double, X86_FP80, PPC_FP128, FP128};
17 use trans::context::CrateContext;
18 use util::nodemap::FnvHashMap;
22 use std::ffi::CString;
25 use std::cell::RefCell;
26 use std::iter::repeat;
30 #[derive(Clone, Copy, PartialEq, Debug)]
37 ($e:expr) => ( Type::from_ref(unsafe { $e }))
40 /// Wrapper for LLVM TypeRef
43 pub fn from_ref(r: TypeRef) -> Type {
49 #[inline(always)] // So it doesn't kill --opt-level=0 builds of the compiler
50 pub fn to_ref(&self) -> TypeRef {
54 pub fn void(ccx: &CrateContext) -> Type {
55 ty!(llvm::LLVMVoidTypeInContext(ccx.llcx()))
58 pub fn nil(ccx: &CrateContext) -> Type {
59 Type::empty_struct(ccx)
62 pub fn metadata(ccx: &CrateContext) -> Type {
63 ty!(llvm::LLVMMetadataTypeInContext(ccx.llcx()))
66 pub fn i1(ccx: &CrateContext) -> Type {
67 ty!(llvm::LLVMInt1TypeInContext(ccx.llcx()))
70 pub fn i8(ccx: &CrateContext) -> Type {
71 ty!(llvm::LLVMInt8TypeInContext(ccx.llcx()))
74 pub fn i16(ccx: &CrateContext) -> Type {
75 ty!(llvm::LLVMInt16TypeInContext(ccx.llcx()))
78 pub fn i32(ccx: &CrateContext) -> Type {
79 ty!(llvm::LLVMInt32TypeInContext(ccx.llcx()))
82 pub fn i64(ccx: &CrateContext) -> Type {
83 ty!(llvm::LLVMInt64TypeInContext(ccx.llcx()))
86 // Creates an integer type with the given number of bits, e.g. i24
87 pub fn ix(ccx: &CrateContext, num_bits: u64) -> Type {
88 ty!(llvm::LLVMIntTypeInContext(ccx.llcx(), num_bits as c_uint))
91 pub fn f32(ccx: &CrateContext) -> Type {
92 ty!(llvm::LLVMFloatTypeInContext(ccx.llcx()))
95 pub fn f64(ccx: &CrateContext) -> Type {
96 ty!(llvm::LLVMDoubleTypeInContext(ccx.llcx()))
99 pub fn bool(ccx: &CrateContext) -> Type {
103 pub fn char(ccx: &CrateContext) -> Type {
107 pub fn i8p(ccx: &CrateContext) -> Type {
108 Type::i8(ccx).ptr_to()
111 pub fn int(ccx: &CrateContext) -> Type {
112 match &ccx.tcx().sess.target.target.target_pointer_width[] {
113 "32" => Type::i32(ccx),
114 "64" => Type::i64(ccx),
115 tws => panic!("Unsupported target word size for int: {}", tws),
119 pub fn int_from_ty(ccx: &CrateContext, t: ast::IntTy) -> Type {
121 ast::TyIs(_) => ccx.int_type(),
122 ast::TyI8 => Type::i8(ccx),
123 ast::TyI16 => Type::i16(ccx),
124 ast::TyI32 => Type::i32(ccx),
125 ast::TyI64 => Type::i64(ccx)
129 pub fn uint_from_ty(ccx: &CrateContext, t: ast::UintTy) -> Type {
131 ast::TyUs(_) => ccx.int_type(),
132 ast::TyU8 => Type::i8(ccx),
133 ast::TyU16 => Type::i16(ccx),
134 ast::TyU32 => Type::i32(ccx),
135 ast::TyU64 => Type::i64(ccx)
139 pub fn float_from_ty(ccx: &CrateContext, t: ast::FloatTy) -> Type {
141 ast::TyF32 => Type::f32(ccx),
142 ast::TyF64 => Type::f64(ccx),
146 pub fn func(args: &[Type], ret: &Type) -> Type {
147 let vec : &[TypeRef] = unsafe { mem::transmute(args) };
148 ty!(llvm::LLVMFunctionType(ret.to_ref(), vec.as_ptr(),
149 args.len() as c_uint, False))
152 pub fn variadic_func(args: &[Type], ret: &Type) -> Type {
153 let vec : &[TypeRef] = unsafe { mem::transmute(args) };
154 ty!(llvm::LLVMFunctionType(ret.to_ref(), vec.as_ptr(),
155 args.len() as c_uint, True))
158 pub fn struct_(ccx: &CrateContext, els: &[Type], packed: bool) -> Type {
159 let els : &[TypeRef] = unsafe { mem::transmute(els) };
160 ty!(llvm::LLVMStructTypeInContext(ccx.llcx(), els.as_ptr(),
165 pub fn named_struct(ccx: &CrateContext, name: &str) -> Type {
166 let name = CString::new(name).unwrap();
167 ty!(llvm::LLVMStructCreateNamed(ccx.llcx(), name.as_ptr()))
170 pub fn empty_struct(ccx: &CrateContext) -> Type {
171 Type::struct_(ccx, &[], false)
174 pub fn vtable(ccx: &CrateContext) -> Type {
175 Type::array(&Type::i8p(ccx).ptr_to(), 1)
178 pub fn generic_glue_fn(cx: &CrateContext) -> Type {
179 match cx.tn().find_type("glue_fn") {
180 Some(ty) => return ty,
184 let ty = Type::glue_fn(cx, Type::i8p(cx));
185 cx.tn().associate_type("glue_fn", &ty);
190 pub fn glue_fn(ccx: &CrateContext, t: Type) -> Type {
191 Type::func(&[t], &Type::void(ccx))
194 pub fn tydesc(ccx: &CrateContext, str_slice_ty: Type) -> Type {
195 let mut tydesc = Type::named_struct(ccx, "tydesc");
196 let glue_fn_ty = Type::glue_fn(ccx, Type::i8p(ccx)).ptr_to();
198 let int_ty = Type::int(ccx);
202 // std::unstable::intrinsics::TyDesc
204 let elems = [int_ty, // size
207 str_slice_ty]; // name
208 tydesc.set_struct_body(&elems, false);
213 pub fn array(ty: &Type, len: u64) -> Type {
214 ty!(llvm::LLVMRustArrayType(ty.to_ref(), len))
217 pub fn vector(ty: &Type, len: u64) -> Type {
218 ty!(llvm::LLVMVectorType(ty.to_ref(), len as c_uint))
221 pub fn vec(ccx: &CrateContext, ty: &Type) -> Type {
223 &[Type::array(ty, 0), Type::int(ccx)],
227 pub fn opaque_vec(ccx: &CrateContext) -> Type {
228 Type::vec(ccx, &Type::i8(ccx))
231 pub fn vtable_ptr(ccx: &CrateContext) -> Type {
232 Type::glue_fn(ccx, Type::i8p(ccx)).ptr_to().ptr_to()
235 pub fn opaque_trait(ccx: &CrateContext) -> Type {
236 Type::struct_(ccx, &[Type::opaque_trait_data(ccx).ptr_to(), Type::vtable_ptr(ccx)], false)
239 pub fn opaque_trait_data(ccx: &CrateContext) -> Type {
243 pub fn kind(&self) -> TypeKind {
245 llvm::LLVMGetTypeKind(self.to_ref())
249 pub fn set_struct_body(&mut self, els: &[Type], packed: bool) {
251 let vec : &[TypeRef] = mem::transmute(els);
252 llvm::LLVMStructSetBody(self.to_ref(), vec.as_ptr(),
253 els.len() as c_uint, packed as Bool)
257 pub fn ptr_to(&self) -> Type {
258 ty!(llvm::LLVMPointerType(self.to_ref(), 0))
261 pub fn is_aggregate(&self) -> bool {
263 TypeKind::Struct | TypeKind::Array => true,
268 pub fn is_packed(&self) -> bool {
270 llvm::LLVMIsPackedStruct(self.to_ref()) == True
274 pub fn element_type(&self) -> Type {
276 Type::from_ref(llvm::LLVMGetElementType(self.to_ref()))
280 /// Return the number of elements in `self` if it is a LLVM vector type.
281 pub fn vector_length(&self) -> uint {
283 llvm::LLVMGetVectorSize(self.to_ref()) as uint
287 pub fn array_length(&self) -> uint {
289 llvm::LLVMGetArrayLength(self.to_ref()) as uint
293 pub fn field_types(&self) -> Vec<Type> {
295 let n_elts = llvm::LLVMCountStructElementTypes(self.to_ref()) as uint;
299 let mut elts: Vec<_> = repeat(Type { rf: ptr::null_mut() }).take(n_elts).collect();
300 llvm::LLVMGetStructElementTypes(self.to_ref(),
301 elts.as_mut_ptr() as *mut TypeRef);
306 pub fn return_type(&self) -> Type {
307 ty!(llvm::LLVMGetReturnType(self.to_ref()))
310 pub fn func_params(&self) -> Vec<Type> {
312 let n_args = llvm::LLVMCountParamTypes(self.to_ref()) as uint;
313 let mut args: Vec<_> = repeat(Type { rf: ptr::null_mut() }).take(n_args).collect();
314 llvm::LLVMGetParamTypes(self.to_ref(),
315 args.as_mut_ptr() as *mut TypeRef);
320 pub fn float_width(&self) -> uint {
325 FP128 | PPC_FP128 => 128,
326 _ => panic!("llvm_float_width called on a non-float type")
330 /// Retrieve the bit width of the integer type `self`.
331 pub fn int_width(&self) -> u64 {
333 llvm::LLVMGetIntTypeWidth(self.to_ref()) as u64
339 /* Memory-managed object interface to type handles. */
341 pub struct TypeNames {
342 named_types: RefCell<FnvHashMap<String, TypeRef>>,
346 pub fn new() -> TypeNames {
348 named_types: RefCell::new(FnvHashMap())
352 pub fn associate_type(&self, s: &str, t: &Type) {
353 assert!(self.named_types.borrow_mut().insert(s.to_string(),
354 t.to_ref()).is_none());
357 pub fn find_type(&self, s: &str) -> Option<Type> {
358 self.named_types.borrow().get(s).map(|x| Type::from_ref(*x))
361 pub fn type_to_string(&self, ty: Type) -> String {
362 llvm::build_string(|s| unsafe {
363 llvm::LLVMWriteTypeToString(ty.to_ref(), s);
364 }).expect("non-UTF8 type description from LLVM")
367 pub fn types_to_str(&self, tys: &[Type]) -> String {
368 let strs: Vec<String> = tys.iter().map(|t| self.type_to_string(*t)).collect();
369 format!("[{}]", strs.connect(","))
372 pub fn val_to_string(&self, val: ValueRef) -> String {
373 llvm::build_string(|s| unsafe {
374 llvm::LLVMWriteValueToString(val, s);
375 }).expect("nun-UTF8 value description from LLVM")