rustc_codegen_llvm/
type_.rs

1use std::borrow::Borrow;
2use std::hash::{Hash, Hasher};
3use std::{fmt, ptr};
4
5use libc::c_uint;
6use rustc_abi::{AddressSpace, Align, Integer, Reg, Size};
7use rustc_codegen_ssa::common::TypeKind;
8use rustc_codegen_ssa::traits::*;
9use rustc_data_structures::small_c_str::SmallCStr;
10use rustc_middle::bug;
11use rustc_middle::ty::layout::TyAndLayout;
12use rustc_middle::ty::{self, Ty};
13use rustc_target::callconv::{CastTarget, FnAbi};
14
15use crate::abi::{FnAbiLlvmExt, LlvmType};
16use crate::common;
17use crate::context::{CodegenCx, GenericCx, SCx};
18use crate::llvm::{self, FALSE, Metadata, TRUE, ToGeneric, ToLlvmBool, Type, Value};
19use crate::type_of::LayoutLlvmExt;
20
21impl PartialEq for Type {
22    fn eq(&self, other: &Self) -> bool {
23        ptr::eq(self, other)
24    }
25}
26
27impl Eq for Type {}
28
29impl Hash for Type {
30    fn hash<H: Hasher>(&self, state: &mut H) {
31        ptr::hash(self, state);
32    }
33}
34
35impl fmt::Debug for Type {
36    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
37        f.write_str(
38            &llvm::build_string(|s| unsafe {
39                llvm::LLVMRustWriteTypeToString(self, s);
40            })
41            .expect("non-UTF8 type description from LLVM"),
42        )
43    }
44}
45
46impl<'ll> CodegenCx<'ll, '_> {}
47impl<'ll, CX: Borrow<SCx<'ll>>> GenericCx<'ll, CX> {
48    pub(crate) fn type_named_struct(&self, name: &str) -> &'ll Type {
49        let name = SmallCStr::new(name);
50        unsafe { llvm::LLVMStructCreateNamed(self.llcx(), name.as_ptr()) }
51    }
52
53    pub(crate) fn set_struct_body(&self, ty: &'ll Type, els: &[&'ll Type], packed: bool) {
54        unsafe {
55            llvm::LLVMStructSetBody(ty, els.as_ptr(), els.len() as c_uint, packed.to_llvm_bool())
56        }
57    }
58    pub(crate) fn type_void(&self) -> &'ll Type {
59        unsafe { llvm::LLVMVoidTypeInContext(self.llcx()) }
60    }
61
62    ///x Creates an integer type with the given number of bits, e.g., i24
63    pub(crate) fn type_ix(&self, num_bits: u64) -> &'ll Type {
64        llvm::LLVMIntTypeInContext(self.llcx(), num_bits as c_uint)
65    }
66
67    pub(crate) fn type_vector(&self, ty: &'ll Type, len: u64) -> &'ll Type {
68        unsafe { llvm::LLVMVectorType(ty, len as c_uint) }
69    }
70
71    pub(crate) fn type_scalable_vector(&self, ty: &'ll Type, count: u64) -> &'ll Type {
72        unsafe { llvm::LLVMScalableVectorType(ty, count as c_uint) }
73    }
74
75    pub(crate) fn add_func(&self, name: &str, ty: &'ll Type) -> &'ll Value {
76        let name = SmallCStr::new(name);
77        unsafe { llvm::LLVMAddFunction(self.llmod(), name.as_ptr(), ty) }
78    }
79
80    pub(crate) fn func_params_types(&self, ty: &'ll Type) -> Vec<&'ll Type> {
81        unsafe {
82            let n_args = llvm::LLVMCountParamTypes(ty) as usize;
83            let mut args = Vec::with_capacity(n_args);
84            llvm::LLVMGetParamTypes(ty, args.as_mut_ptr());
85            args.set_len(n_args);
86            args
87        }
88    }
89}
90impl<'ll, 'tcx> CodegenCx<'ll, 'tcx> {
91    pub(crate) fn type_bool(&self) -> &'ll Type {
92        self.type_i8()
93    }
94
95    pub(crate) fn type_int_from_ty(&self, t: ty::IntTy) -> &'ll Type {
96        match t {
97            ty::IntTy::Isize => self.type_isize(),
98            ty::IntTy::I8 => self.type_i8(),
99            ty::IntTy::I16 => self.type_i16(),
100            ty::IntTy::I32 => self.type_i32(),
101            ty::IntTy::I64 => self.type_i64(),
102            ty::IntTy::I128 => self.type_i128(),
103        }
104    }
105
106    pub(crate) fn type_uint_from_ty(&self, t: ty::UintTy) -> &'ll Type {
107        match t {
108            ty::UintTy::Usize => self.type_isize(),
109            ty::UintTy::U8 => self.type_i8(),
110            ty::UintTy::U16 => self.type_i16(),
111            ty::UintTy::U32 => self.type_i32(),
112            ty::UintTy::U64 => self.type_i64(),
113            ty::UintTy::U128 => self.type_i128(),
114        }
115    }
116
117    pub(crate) fn type_float_from_ty(&self, t: ty::FloatTy) -> &'ll Type {
118        match t {
119            ty::FloatTy::F16 => self.type_f16(),
120            ty::FloatTy::F32 => self.type_f32(),
121            ty::FloatTy::F64 => self.type_f64(),
122            ty::FloatTy::F128 => self.type_f128(),
123        }
124    }
125
126    /// Return an LLVM type that has at most the required alignment,
127    /// and exactly the required size, as a best-effort padding array.
128    pub(crate) fn type_padding_filler(&self, size: Size, align: Align) -> &'ll Type {
129        let unit = Integer::approximate_align(self, align);
130        let size = size.bytes();
131        let unit_size = unit.size().bytes();
132        assert_eq!(size % unit_size, 0);
133        self.type_array(self.type_from_integer(unit), size / unit_size)
134    }
135}
136
137impl<'ll, CX: Borrow<SCx<'ll>>> GenericCx<'ll, CX> {
138    pub(crate) fn llcx(&self) -> &'ll llvm::Context {
139        (**self).borrow().llcx
140    }
141
142    pub(crate) fn llmod(&self) -> &'ll llvm::Module {
143        (**self).borrow().llmod
144    }
145
146    pub(crate) fn isize_ty(&self) -> &'ll Type {
147        (**self).borrow().isize_ty
148    }
149
150    pub(crate) fn type_variadic_func(&self, args: &[&'ll Type], ret: &'ll Type) -> &'ll Type {
151        unsafe { llvm::LLVMFunctionType(ret, args.as_ptr(), args.len() as c_uint, TRUE) }
152    }
153
154    pub(crate) fn type_i1(&self) -> &'ll Type {
155        unsafe { llvm::LLVMInt1TypeInContext(self.llcx()) }
156    }
157
158    pub(crate) fn type_struct(&self, els: &[&'ll Type], packed: bool) -> &'ll Type {
159        unsafe {
160            llvm::LLVMStructTypeInContext(
161                self.llcx(),
162                els.as_ptr(),
163                els.len() as c_uint,
164                packed.to_llvm_bool(),
165            )
166        }
167    }
168}
169
170impl<'ll, CX: Borrow<SCx<'ll>>> BaseTypeCodegenMethods for GenericCx<'ll, CX> {
171    fn type_i8(&self) -> &'ll Type {
172        unsafe { llvm::LLVMInt8TypeInContext(self.llcx()) }
173    }
174
175    fn type_i16(&self) -> &'ll Type {
176        unsafe { llvm::LLVMInt16TypeInContext(self.llcx()) }
177    }
178
179    fn type_i32(&self) -> &'ll Type {
180        unsafe { llvm::LLVMInt32TypeInContext(self.llcx()) }
181    }
182
183    fn type_i64(&self) -> &'ll Type {
184        unsafe { llvm::LLVMInt64TypeInContext(self.llcx()) }
185    }
186
187    fn type_i128(&self) -> &'ll Type {
188        self.type_ix(128)
189    }
190
191    fn type_isize(&self) -> &'ll Type {
192        self.isize_ty()
193    }
194
195    fn type_f16(&self) -> &'ll Type {
196        unsafe { llvm::LLVMHalfTypeInContext(self.llcx()) }
197    }
198
199    fn type_f32(&self) -> &'ll Type {
200        unsafe { llvm::LLVMFloatTypeInContext(self.llcx()) }
201    }
202
203    fn type_f64(&self) -> &'ll Type {
204        unsafe { llvm::LLVMDoubleTypeInContext(self.llcx()) }
205    }
206
207    fn type_f128(&self) -> &'ll Type {
208        unsafe { llvm::LLVMFP128TypeInContext(self.llcx()) }
209    }
210
211    fn type_func(&self, args: &[&'ll Type], ret: &'ll Type) -> &'ll Type {
212        unsafe { llvm::LLVMFunctionType(ret, args.as_ptr(), args.len() as c_uint, FALSE) }
213    }
214
215    fn type_kind(&self, ty: &'ll Type) -> TypeKind {
216        llvm::LLVMGetTypeKind(ty).to_rust().to_generic()
217    }
218
219    fn type_ptr(&self) -> &'ll Type {
220        llvm_type_ptr(self.llcx())
221    }
222
223    fn type_ptr_ext(&self, address_space: AddressSpace) -> &'ll Type {
224        llvm_type_ptr_in_address_space(self.llcx(), address_space)
225    }
226
227    fn element_type(&self, ty: &'ll Type) -> &'ll Type {
228        match self.type_kind(ty) {
229            TypeKind::Array | TypeKind::Vector => unsafe { llvm::LLVMGetElementType(ty) },
230            TypeKind::Pointer => bug!("element_type is not supported for opaque pointers"),
231            other => bug!("element_type called on unsupported type {other:?}"),
232        }
233    }
234
235    fn vector_length(&self, ty: &'ll Type) -> usize {
236        unsafe { llvm::LLVMGetVectorSize(ty) as usize }
237    }
238
239    fn float_width(&self, ty: &'ll Type) -> usize {
240        match self.type_kind(ty) {
241            TypeKind::Half => 16,
242            TypeKind::Float => 32,
243            TypeKind::Double => 64,
244            TypeKind::X86_FP80 => 80,
245            TypeKind::FP128 | TypeKind::PPC_FP128 => 128,
246            other => bug!("llvm_float_width called on a non-float type {other:?}"),
247        }
248    }
249
250    fn int_width(&self, ty: &'ll Type) -> u64 {
251        unsafe { llvm::LLVMGetIntTypeWidth(ty) as u64 }
252    }
253
254    fn val_ty(&self, v: &'ll Value) -> &'ll Type {
255        common::val_ty(v)
256    }
257
258    fn type_array(&self, ty: &'ll Type, len: u64) -> &'ll Type {
259        unsafe { llvm::LLVMArrayType2(ty, len) }
260    }
261}
262
263pub(crate) fn llvm_type_ptr(llcx: &llvm::Context) -> &Type {
264    llvm_type_ptr_in_address_space(llcx, AddressSpace::ZERO)
265}
266
267pub(crate) fn llvm_type_ptr_in_address_space<'ll>(
268    llcx: &'ll llvm::Context,
269    addr_space: AddressSpace,
270) -> &'ll Type {
271    llvm::LLVMPointerTypeInContext(llcx, addr_space.0)
272}
273
274impl<'ll, 'tcx> LayoutTypeCodegenMethods<'tcx> for CodegenCx<'ll, 'tcx> {
275    fn backend_type(&self, layout: TyAndLayout<'tcx>) -> &'ll Type {
276        layout.llvm_type(self)
277    }
278    fn immediate_backend_type(&self, layout: TyAndLayout<'tcx>) -> &'ll Type {
279        layout.immediate_llvm_type(self)
280    }
281    fn is_backend_immediate(&self, layout: TyAndLayout<'tcx>) -> bool {
282        layout.is_llvm_immediate()
283    }
284    fn is_backend_scalar_pair(&self, layout: TyAndLayout<'tcx>) -> bool {
285        layout.is_llvm_scalar_pair()
286    }
287    fn scalar_pair_element_backend_type(
288        &self,
289        layout: TyAndLayout<'tcx>,
290        index: usize,
291        immediate: bool,
292    ) -> &'ll Type {
293        layout.scalar_pair_element_llvm_type(self, index, immediate)
294    }
295    fn cast_backend_type(&self, ty: &CastTarget) -> &'ll Type {
296        ty.llvm_type(self)
297    }
298    fn fn_decl_backend_type(&self, fn_abi: &FnAbi<'tcx, Ty<'tcx>>) -> &'ll Type {
299        fn_abi.llvm_type(self)
300    }
301    fn fn_ptr_backend_type(&self, fn_abi: &FnAbi<'tcx, Ty<'tcx>>) -> &'ll Type {
302        fn_abi.ptr_to_llvm_type(self)
303    }
304    fn reg_backend_type(&self, ty: &Reg) -> &'ll Type {
305        ty.llvm_type(self)
306    }
307}
308
309impl<'ll, 'tcx> TypeMembershipCodegenMethods<'tcx> for CodegenCx<'ll, 'tcx> {
310    fn add_type_metadata(&self, function: &'ll Value, typeid: &[u8]) {
311        let typeid_metadata = self.create_metadata(typeid);
312        let v = [llvm::LLVMValueAsMetadata(self.const_usize(0)), typeid_metadata];
313        self.global_add_metadata_node(function, llvm::MD_type, &v);
314    }
315
316    fn set_type_metadata(&self, function: &'ll Value, typeid: &[u8]) {
317        let typeid_metadata = self.create_metadata(typeid);
318        let v = [llvm::LLVMValueAsMetadata(self.const_usize(0)), typeid_metadata];
319        self.global_set_metadata_node(function, llvm::MD_type, &v);
320    }
321
322    fn typeid_metadata(&self, typeid: &[u8]) -> Option<&'ll Metadata> {
323        Some(self.create_metadata(typeid))
324    }
325
326    fn add_kcfi_type_metadata(&self, function: &'ll Value, kcfi_typeid: u32) {
327        let kcfi_type_metadata = [llvm::LLVMValueAsMetadata(self.const_u32(kcfi_typeid))];
328        self.global_add_metadata_node(function, llvm::MD_kcfi_type, &kcfi_type_metadata);
329    }
330
331    fn set_kcfi_type_metadata(&self, function: &'ll Value, kcfi_typeid: u32) {
332        let kcfi_type_metadata = [llvm::LLVMValueAsMetadata(self.const_u32(kcfi_typeid))];
333        self.global_set_metadata_node(function, llvm::MD_kcfi_type, &kcfi_type_metadata);
334    }
335}
rustc_codegen_llvm/type_.rs

rustc_codegen_llvm/
type_.rs
