rustc_codegen_llvm/
type_.rs

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

rustc_codegen_llvm/
type_.rs
