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
use llvm_sys::core::{LLVMConstVector, LLVMGetVectorSize};
use llvm_sys::prelude::{LLVMTypeRef, LLVMValueRef};
use crate::context::ContextRef;
use crate::support::LLVMString;
use crate::types::enums::BasicMetadataTypeEnum;
use crate::types::{traits::AsTypeRef, ArrayType, BasicTypeEnum, FunctionType, PointerType, Type};
use crate::values::{ArrayValue, BasicValue, IntValue, VectorValue};
use crate::AddressSpace;
use std::fmt::{self, Display};
/// A `VectorType` is the type of a multiple value SIMD constant or variable.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
pub struct VectorType<'ctx> {
vec_type: Type<'ctx>,
}
impl<'ctx> VectorType<'ctx> {
/// Create `VectorType` from [`LLVMTypeRef`]
///
/// # Safety
/// Undefined behavior, if referenced type isn't vector type
pub unsafe fn new(vector_type: LLVMTypeRef) -> Self {
assert!(!vector_type.is_null());
VectorType {
vec_type: Type::new(vector_type),
}
}
// TODO: impl only for VectorType<!StructType<Opaque>>
// REVIEW: What about Opaque struct hiding in deeper levels
// like VectorType<ArrayType<StructType<Opaque>>>?
/// Gets the size of this `VectorType`. Value may vary depending on the target architecture.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vec_type = f32_type.vec_type(3);
/// let f32_vec_type_size = f32_vec_type.size_of();
/// ```
pub fn size_of(self) -> Option<IntValue<'ctx>> {
self.vec_type.size_of()
}
/// Gets the alignment of this `VectorType`. Value may vary depending on the target architecture.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vec_type = f32_type.vec_type(7);
/// let f32_type_alignment = f32_vec_type.get_alignment();
/// ```
pub fn get_alignment(self) -> IntValue<'ctx> {
self.vec_type.get_alignment()
}
/// Gets the size of this `VectorType`.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vector_type = f32_type.vec_type(3);
///
/// assert_eq!(f32_vector_type.get_size(), 3);
/// assert_eq!(f32_vector_type.get_element_type().into_float_type(), f32_type);
/// ```
pub fn get_size(self) -> u32 {
unsafe { LLVMGetVectorSize(self.as_type_ref()) }
}
// REVIEW:
// TypeSafety v2 (GH Issue #8) could help here by constraining
// sub-types to be the same across the board. For now, we could
// have V just be the set of Int & Float and any others that
// are valid for Vectors
// REVIEW: Maybe we could make this use &self if the vector size
// is stored as a const and the input values took a const size?
// Something like: values: &[&V; self.size]. Doesn't sound possible though
/// Creates a constant `VectorValue`.
///
/// # Example
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::types::VectorType;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_val = f32_type.const_float(0.);
/// let f32_val2 = f32_type.const_float(2.);
/// let f32_vec_val = VectorType::const_vector(&[f32_val, f32_val2]);
///
/// assert!(f32_vec_val.is_constant_vector());
/// ```
pub fn const_vector<V: BasicValue<'ctx>>(values: &[V]) -> VectorValue<'ctx> {
let mut values: Vec<LLVMValueRef> = values.iter().map(|val| val.as_value_ref()).collect();
unsafe { VectorValue::new(LLVMConstVector(values.as_mut_ptr(), values.len() as u32)) }
}
/// Creates a constant zero value of this `VectorType`.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vec_type = f32_type.vec_type(7);
/// let f32_vec_zero = f32_vec_type.const_zero();
/// ```
pub fn const_zero(self) -> VectorValue<'ctx> {
unsafe { VectorValue::new(self.vec_type.const_zero()) }
}
/// Print the definition of a `VectorType` to `LLVMString`.
pub fn print_to_string(self) -> LLVMString {
self.vec_type.print_to_string()
}
/// Creates an undefined instance of a `VectorType`.
///
/// # Example
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vec_type = f32_type.vec_type(3);
/// let f32_vec_undef = f32_vec_type.get_undef();
///
/// assert!(f32_vec_undef.is_undef());
/// ```
pub fn get_undef(self) -> VectorValue<'ctx> {
unsafe { VectorValue::new(self.vec_type.get_undef()) }
}
/// Creates a poison instance of a `VectorType`.
///
/// # Example
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vec_type = f32_type.vec_type(3);
/// let f32_vec_poison = f32_vec_type.get_undef();
///
/// assert!(f32_vec_poison.is_undef());
/// ```
#[llvm_versions(12..)]
pub fn get_poison(self) -> VectorValue<'ctx> {
unsafe { VectorValue::new(self.vec_type.get_poison()) }
}
// SubType: VectorType<BT> -> BT?
/// Gets the element type of this `VectorType`.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vector_type = f32_type.vec_type(3);
///
/// assert_eq!(f32_vector_type.get_size(), 3);
/// assert_eq!(f32_vector_type.get_element_type().into_float_type(), f32_type);
/// ```
pub fn get_element_type(self) -> BasicTypeEnum<'ctx> {
self.vec_type.get_element_type().as_basic_type_enum()
}
/// Creates a `PointerType` with this `VectorType` for its element type.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::AddressSpace;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vec_type = f32_type.vec_type(3);
/// let f32_vec_ptr_type = f32_vec_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_vec_ptr_type.get_element_type().into_vector_type(), f32_vec_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.vec_type.ptr_type(address_space)
}
/// Creates a `FunctionType` with this `VectorType` for its return type.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vec_type = f32_type.vec_type(3);
/// let fn_type = f32_vec_type.fn_type(&[], false);
/// ```
pub fn fn_type(self, param_types: &[BasicMetadataTypeEnum<'ctx>], is_var_args: bool) -> FunctionType<'ctx> {
self.vec_type.fn_type(param_types, is_var_args)
}
/// Creates an `ArrayType` with this `VectorType` for its element type.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vec_type = f32_type.vec_type(3);
/// let f32_vec_array_type = f32_vec_type.array_type(3);
///
/// assert_eq!(f32_vec_array_type.len(), 3);
/// assert_eq!(f32_vec_array_type.get_element_type().into_vector_type(), f32_vec_type);
/// ```
pub fn array_type(self, size: u32) -> ArrayType<'ctx> {
self.vec_type.array_type(size)
}
/// Creates a constant `ArrayValue`.
///
/// # Example
/// ```no_run
/// use inkwell::context::Context;
/// use inkwell::types::VectorType;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_val = f32_type.const_float(0.);
/// let f32_val2 = f32_type.const_float(2.);
/// let f32_vec_type = f32_type.vec_type(2);
/// let f32_vec_val = VectorType::const_vector(&[f32_val, f32_val2]);
/// let f32_array = f32_vec_type.const_array(&[f32_vec_val, f32_vec_val]);
///
/// assert!(f32_array.is_const());
/// ```
pub fn const_array(self, values: &[VectorValue<'ctx>]) -> ArrayValue<'ctx> {
unsafe { ArrayValue::new_const_array(&self, values) }
}
/// Gets a reference to the `Context` this `VectorType` was created in.
///
/// # Example
///
/// ```no_run
/// use inkwell::context::Context;
///
/// let context = Context::create();
/// let f32_type = context.f32_type();
/// let f32_vec_type = f32_type.vec_type(7);
///
/// assert_eq!(f32_vec_type.get_context(), context);
/// ```
pub fn get_context(self) -> ContextRef<'ctx> {
self.vec_type.get_context()
}
}
unsafe impl AsTypeRef for VectorType<'_> {
fn as_type_ref(&self) -> LLVMTypeRef {
self.vec_type.ty
}
}
impl Display for VectorType<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.print_to_string())
}
}