inkwell/types/ptr_type.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
use llvm_sys::core::LLVMGetPointerAddressSpace;
#[llvm_versions(15..)]
use llvm_sys::core::LLVMPointerTypeIsOpaque;
use llvm_sys::prelude::LLVMTypeRef;
use crate::context::ContextRef;
use crate::support::LLVMString;
use crate::types::traits::AsTypeRef;
#[llvm_versions(..=14)]
use crate::types::AnyTypeEnum;
use crate::types::{ArrayType, FunctionType, ScalableVectorType, Type, VectorType};
use crate::values::{ArrayValue, IntValue, PointerValue};
use crate::AddressSpace;
use crate::types::enums::BasicMetadataTypeEnum;
use std::fmt::{self, Display};
/// A `PointerType` is the type of a pointer constant or variable.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct PointerType<'ctx> {
ptr_type: Type<'ctx>,
}
impl<'ctx> PointerType<'ctx> {
/// Create `PointerType` from [`LLVMTypeRef`]
///
/// # Safety
/// Undefined behavior, if referenced type isn't pointer type
pub unsafe fn new(ptr_type: LLVMTypeRef) -> Self {
assert!(!ptr_type.is_null());
PointerType {
ptr_type: Type::new(ptr_type),
}
}
/// Gets the size of this `PointerType`. Value may vary depending on the target architecture.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_type_size = f32_ptr_type.size_of();
/// ```
pub fn size_of(self) -> IntValue<'ctx> {
self.ptr_type.size_of().unwrap()
}
/// Gets the alignment of this `PointerType`. Value may vary depending on the target architecture.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_type_alignment = f32_ptr_type.get_alignment();
/// ```
pub fn get_alignment(self) -> IntValue<'ctx> {
self.ptr_type.get_alignment()
}
/// Creates a `PointerType` with this `PointerType` for its element type.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_ptr_type = f32_ptr_type.ptr_type(AddressSpace::default());
///
/// #[cfg(any(
/// feature = "llvm4-0",
/// feature = "llvm5-0",
/// feature = "llvm6-0",
/// feature = "llvm7-0",
/// feature = "llvm8-0",
/// feature = "llvm9-0",
/// feature = "llvm10-0",
/// feature = "llvm11-0",
/// feature = "llvm12-0",
/// feature = "llvm13-0",
/// feature = "llvm14-0"
/// ))]
/// assert_eq!(f32_ptr_ptr_type.get_element_type().into_pointer_type(), f32_ptr_type);
/// ```
#[cfg_attr(
any(
feature = "llvm15-0",
feature = "llvm16-0",
feature = "llvm17-0",
feature = "llvm18-0"
),
deprecated(
note = "Starting from version 15.0, LLVM doesn't differentiate between pointer types. Use Context::ptr_type instead."
)
)]
pub fn ptr_type(self, address_space: AddressSpace) -> PointerType<'ctx> {
self.ptr_type.ptr_type(address_space)
}
/// Gets a reference to the `Context` this `PointerType` was created in.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
///
/// assert_eq!(f32_ptr_type.get_context(), context);
/// ```
// TODO: Move to AnyType trait
pub fn get_context(self) -> ContextRef<'ctx> {
self.ptr_type.get_context()
}
/// Creates a `FunctionType` with this `PointerType` for its return type.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let fn_type = f32_ptr_type.fn_type(&[], false);
/// ```
pub fn fn_type(self, param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool) -> FunctionType<'ctx> {
self.ptr_type.fn_type(param_types, is_var_args)
}
/// Creates an `ArrayType` with this `PointerType` for its element type.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_array_type = f32_ptr_type.array_type(3);
///
/// assert_eq!(f32_ptr_array_type.len(), 3);
/// assert_eq!(f32_ptr_array_type.get_element_type().into_pointer_type(), f32_ptr_type);
/// ```
pub fn array_type(self, size: u32) -> ArrayType<'ctx> {
self.ptr_type.array_type(size)
}
/// Gets the `AddressSpace` a `PointerType` was created with.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
///
/// assert_eq!(f32_ptr_type.get_address_space(), AddressSpace::default());
/// ```
pub fn get_address_space(self) -> AddressSpace {
let addr_space = unsafe { LLVMGetPointerAddressSpace(self.as_type_ref()) };
AddressSpace(addr_space)
}
/// Print the definition of a `PointerType` to `LLVMString`.
pub fn print_to_string(self) -> LLVMString {
self.ptr_type.print_to_string()
}
/// Creates a null `PointerValue` of this `PointerType`.
/// It will be automatically assigned this `PointerType`'s `Context`.
///
/// # Example
/// ```no_run
/// use inkwell::AddressSpace;
/// use inkwell::context::Context;
///
/// // Local Context
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_null = f32_ptr_type.const_null();
///
/// assert!(f32_ptr_null.is_null());
/// ```
pub fn const_null(self) -> PointerValue<'ctx> {
unsafe { PointerValue::new(self.ptr_type.const_zero()) }
}
// REVIEW: Unlike the other const_zero functions, this one becomes null instead of a 0 value. Maybe remove?
/// Creates a constant null value of this `PointerType`.
/// This is practically the same as calling `const_null` for this particular type and
/// so this function may be removed in the future.
///
/// # Example
///
/// ```no_run
/// use inkwell::AddressSpace;
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_zero = f32_ptr_type.const_zero();
/// ```
pub fn const_zero(self) -> PointerValue<'ctx> {
unsafe { PointerValue::new(self.ptr_type.const_zero()) }
}
/// Creates an undefined instance of a `PointerType`.
///
/// # Example
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_undef = f32_ptr_type.get_undef();
///
/// assert!(f32_ptr_undef.is_undef());
/// ```
pub fn get_undef(self) -> PointerValue<'ctx> {
unsafe { PointerValue::new(self.ptr_type.get_undef()) }
}
/// Creates a poison instance of a `PointerType`.
///
/// # Example
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
/// use inkwell::values::AnyValue;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_undef = f32_ptr_type.get_poison();
///
/// assert!(f32_ptr_undef.is_poison());
/// ```
#[llvm_versions(12..)]
pub fn get_poison(self) -> PointerValue<'ctx> {
unsafe { PointerValue::new(self.ptr_type.get_poison()) }
}
/// Creates a `VectorType` with this `PointerType` for its element type.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_vec_type = f32_ptr_type.vec_type(3);
///
/// assert_eq!(f32_ptr_vec_type.get_size(), 3);
/// assert_eq!(f32_ptr_vec_type.get_element_type().into_pointer_type(), f32_ptr_type);
/// ```
pub fn vec_type(self, size: u32) -> VectorType<'ctx> {
self.ptr_type.vec_type(size)
}
/// Creates a `ScalableVectorType` with this `PointerType` for its element type.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_scalable_vec_type = f32_ptr_type.scalable_vec_type(3);
///
/// assert_eq!(f32_ptr_scalable_vec_type.get_size(), 3);
/// assert_eq!(f32_ptr_scalable_vec_type.get_element_type().into_pointer_type(), f32_ptr_type);
/// ```
#[llvm_versions(12..)]
pub fn scalable_vec_type(self, size: u32) -> ScalableVectorType<'ctx> {
self.ptr_type.scalable_vec_type(size)
}
// SubType: PointerrType<BT> -> BT?
/// Gets the element type of this `PointerType`.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
///
/// assert_eq!(f32_ptr_type.get_element_type().into_float_type(), f32_type);
/// ```
#[llvm_versions(..=14)]
pub fn get_element_type(self) -> AnyTypeEnum<'ctx> {
self.ptr_type.get_element_type()
}
/// Creates a constant `ArrayValue`.
///
/// # Example
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// #[cfg(not(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0")))]
/// let f32_ptr_type = f32_type.ptr_type(AddressSpace::default());
/// #[cfg(any(feature = "llvm15-0", feature = "llvm16-0", feature = "llvm17-0", feature = "llvm18-0"))]
/// let f32_ptr_type = context.ptr_type(AddressSpace::default());
/// let f32_ptr_val = f32_ptr_type.const_null();
/// let f32_ptr_array = f32_ptr_type.const_array(&[f32_ptr_val, f32_ptr_val]);
///
/// assert!(f32_ptr_array.is_const());
/// ```
pub fn const_array(self, values: &[PointerValue<'ctx>]) -> ArrayValue<'ctx> {
unsafe { ArrayValue::new_const_array(&self, values) }
}
/// Determine whether this pointer is opaque.
#[llvm_versions(15..)]
pub fn is_opaque(self) -> bool {
unsafe { LLVMPointerTypeIsOpaque(self.ptr_type.ty) != 0 }
}
}
unsafe impl AsTypeRef for PointerType<'_> {
fn as_type_ref(&self) -> LLVMTypeRef {
self.ptr_type.ty
}
}
impl Display for PointerType<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.print_to_string())
}
}