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 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
//! [`QPtr`](crate::TypeCtor::QPtr) lowering (e.g. from SPIR-V).
// HACK(eddyb) layout code used to be in this module.
use super::layout::*;
use crate::func_at::FuncAtMut;
use crate::qptr::{shapes, QPtrAttr, QPtrOp};
use crate::transform::{InnerInPlaceTransform, Transformed, Transformer};
use crate::{
spv, AddrSpace, AttrSet, AttrSetDef, Const, ConstCtor, ConstDef, Context, ControlNode,
ControlNodeKind, DataInst, DataInstDef, DataInstForm, DataInstFormDef, DataInstKind, Diag,
FuncDecl, GlobalVarDecl, OrdAssertEq, Type, TypeCtor, TypeCtorArg, TypeDef, Value,
};
use smallvec::SmallVec;
use std::cell::Cell;
use std::num::NonZeroU32;
use std::rc::Rc;
struct LowerError(Diag);
/// Context for lowering SPIR-V `OpTypePointer`s to `QPtr`s.
///
/// See also `passes::qptr::lower_from_spv_ptrs` (which drives this).
pub struct LowerFromSpvPtrs<'a> {
cx: Rc<Context>,
wk: &'static spv::spec::WellKnown,
layout_cache: LayoutCache<'a>,
cached_qptr_type: Cell<Option<Type>>,
}
impl<'a> LowerFromSpvPtrs<'a> {
pub fn new(cx: Rc<Context>, layout_config: &'a LayoutConfig) -> Self {
Self {
cx: cx.clone(),
wk: &spv::spec::Spec::get().well_known,
layout_cache: LayoutCache::new(cx, layout_config),
cached_qptr_type: Default::default(),
}
}
pub fn lower_global_var(&self, global_var_decl: &mut GlobalVarDecl) {
let wk = self.wk;
let (_, pointee_type) = self.as_spv_ptr_type(global_var_decl.type_of_ptr_to).unwrap();
let handle_layout_to_handle = |handle_layout: HandleLayout| match handle_layout {
shapes::Handle::Opaque(ty) => shapes::Handle::Opaque(ty),
shapes::Handle::Buffer(addr_space, buf) => {
shapes::Handle::Buffer(addr_space, buf.mem_layout)
}
};
let mut shape_result = self.layout_of(pointee_type).and_then(|layout| {
Ok(match layout {
TypeLayout::Handle(handle) => shapes::GlobalVarShape::Handles {
handle: handle_layout_to_handle(handle),
fixed_count: Some(NonZeroU32::new(1).unwrap()),
},
TypeLayout::HandleArray(handle, fixed_count) => shapes::GlobalVarShape::Handles {
handle: handle_layout_to_handle(handle),
fixed_count,
},
TypeLayout::Concrete(concrete) => {
if concrete.mem_layout.dyn_unit_stride.is_some() {
return Err(LowerError(Diag::err([
"global variable cannot have dynamically sized type `".into(),
pointee_type.into(),
"`".into(),
])));
}
match global_var_decl.addr_space {
// These SPIR-V Storage Classes are defined to require
// exact types, either because they're `BuiltIn`s, or
// for "interface matching" between pipeline stages.
AddrSpace::SpvStorageClass(sc)
if [
wk.Input,
wk.Output,
wk.IncomingRayPayloadKHR,
wk.IncomingCallableDataKHR,
wk.HitAttributeKHR,
wk.RayPayloadKHR,
wk.CallableDataKHR,
]
.contains(&sc) =>
{
shapes::GlobalVarShape::TypedInterface(pointee_type)
}
_ => shapes::GlobalVarShape::UntypedData(concrete.mem_layout.fixed_base),
}
}
})
});
if let Ok(shapes::GlobalVarShape::Handles { handle, .. }) = &mut shape_result {
match handle {
shapes::Handle::Opaque(_) => {
if global_var_decl.addr_space != AddrSpace::SpvStorageClass(wk.UniformConstant)
{
shape_result = Err(LowerError(Diag::bug([
"opaque Handles require UniformConstant".into(),
])));
}
}
// FIXME(eddyb) not all "interface blocks" imply buffers, so this
// may need to be ignored based on the SPIR-V storage class.
//
// OH GOD but the lowering of operations to the right thing.......
// depends on whether it's a buffer or not...... outside of
// Rust-GPU's abuse of `Generic` it should at least be possible
// to determine it from the pointer type itself, at the lowering
// op time, but with storage class inference.... THIS IS FUCKED
// OTOH, Rust-GPU doesn't really use `Block` outside of buffers!
// Long-term it should probably have different types per storage
// class, or even represent buffers as pointers.
shapes::Handle::Buffer(buf_addr_space, _) => {
// HACK(eddyb) it couldn't have been known in `layout_of`.
assert!(*buf_addr_space == AddrSpace::Handles);
*buf_addr_space = global_var_decl.addr_space;
}
}
if shape_result.is_ok() {
global_var_decl.addr_space = AddrSpace::Handles;
}
}
match shape_result {
Ok(shape) => {
global_var_decl.shape = Some(shape);
// HACK(eddyb) this should handle shallow `QPtr` in the initializer, but
// typed initializers should be replaced with miri/linker-style ones.
EraseSpvPtrs { lowerer: self }.in_place_transform_global_var_decl(global_var_decl);
}
Err(LowerError(e)) => {
global_var_decl.attrs.push_diag(&self.cx, e);
}
}
}
pub fn lower_func(&self, func_decl: &mut FuncDecl) {
// HACK(eddyb) two-step to avoid having to record the original types
// separately - so `LowerFromSpvPtrInstsInFunc` will leave all value defs
// (including replaced instructions!) with unchanged `OpTypePointer`
// types, that only `EraseSpvPtrs`, later, replaces with `QPtr`.
LowerFromSpvPtrInstsInFunc { lowerer: self }.in_place_transform_func_decl(func_decl);
EraseSpvPtrs { lowerer: self }.in_place_transform_func_decl(func_decl);
}
/// Returns `Some` iff `ty` is a SPIR-V `OpTypePointer`.
//
// FIXME(eddyb) deduplicate with `qptr::lift`.
//
// FIXME(eddyb) consider using the storage class to determine whether a
// `Block`-annotated type is a buffer or just interface nonsense.
// (!!! may cause bad interactions with storage class inference `Generic` abuse)
fn as_spv_ptr_type(&self, ty: Type) -> Option<(AddrSpace, Type)> {
let ty_def = &self.cx[ty];
match &ty_def.ctor {
TypeCtor::SpvInst(spv_inst) if spv_inst.opcode == self.wk.OpTypePointer => {
let sc = match spv_inst.imms[..] {
[spv::Imm::Short(_, sc)] => sc,
_ => unreachable!(),
};
let pointee = match ty_def.ctor_args[..] {
[TypeCtorArg::Type(elem_type)] => elem_type,
_ => unreachable!(),
};
Some((AddrSpace::SpvStorageClass(sc), pointee))
}
_ => None,
}
}
// FIXME(eddyb) properly distinguish between zero-extension and sign-extension.
fn const_as_u32(&self, ct: Const) -> Option<u32> {
match &self.cx[ct].ctor {
ConstCtor::SpvInst(spv_inst)
if spv_inst.opcode == self.wk.OpConstant && spv_inst.imms.len() == 1 =>
{
match spv_inst.imms[..] {
[spv::Imm::Short(_, x)] => Some(x),
_ => unreachable!(),
}
}
_ => None,
}
}
/// Get the (likely cached) `QPtr` type.
fn qptr_type(&self) -> Type {
if let Some(cached) = self.cached_qptr_type.get() {
return cached;
}
let ty = self.cx.intern(TypeDef {
attrs: Default::default(),
ctor: TypeCtor::QPtr,
ctor_args: Default::default(),
});
self.cached_qptr_type.set(Some(ty));
ty
}
/// Attempt to compute a `TypeLayout` for a given (SPIR-V) `Type`.
fn layout_of(&self, ty: Type) -> Result<TypeLayout, LowerError> {
self.layout_cache.layout_of(ty).map_err(|LayoutError(err)| LowerError(err))
}
}
struct EraseSpvPtrs<'a> {
lowerer: &'a LowerFromSpvPtrs<'a>,
}
impl Transformer for EraseSpvPtrs<'_> {
// FIXME(eddyb) this is intentionally *shallow* and will not handle pointers
// "hidden" in composites (which should be handled in SPIR-T explicitly).
fn transform_type_use(&mut self, ty: Type) -> Transformed<Type> {
// FIXME(eddyb) maybe cache this remap (in `LowerFromSpvPtrs`, globally).
if self.lowerer.as_spv_ptr_type(ty).is_some() {
Transformed::Changed(self.lowerer.qptr_type())
} else {
Transformed::Unchanged
}
}
// FIXME(eddyb) this is intentionally *shallow* and will not handle pointers
// "hidden" in composites (which should be handled in SPIR-T explicitly).
fn transform_const_use(&mut self, ct: Const) -> Transformed<Const> {
// FIXME(eddyb) maybe cache this remap (in `LowerFromSpvPtrs`, globally).
let ct_def = &self.lowerer.cx[ct];
if let ConstCtor::PtrToGlobalVar(_) = ct_def.ctor {
Transformed::Changed(self.lowerer.cx.intern(ConstDef {
attrs: ct_def.attrs,
ty: self.lowerer.qptr_type(),
ctor: ct_def.ctor.clone(),
ctor_args: ct_def.ctor_args.clone(),
}))
} else {
Transformed::Unchanged
}
}
// FIXME(eddyb) because this is now interned, it might be better to
// temporarily track the old output types in a map, and not actually
// intern the non-`qptr`-output `qptr.*` instructions, only to replace
// the output type with `qptr` here.
fn transform_data_inst_form_use(
&mut self,
data_inst_form: DataInstForm,
) -> Transformed<DataInstForm> {
// FIXME(eddyb) maybe cache this remap (in `LowerFromSpvPtrs`, globally).
self.transform_data_inst_form_def(&self.lowerer.cx[data_inst_form])
.map(|data_inst_form_def| self.lowerer.cx.intern(data_inst_form_def))
}
}
struct LowerFromSpvPtrInstsInFunc<'a> {
lowerer: &'a LowerFromSpvPtrs<'a>,
}
/// One `QPtr`->`QPtr` step used in the lowering of `Op*AccessChain`.
///
/// The `op` should take a `QPtr` as its first input and produce a `QPtr`.
struct QPtrChainStep {
op: QPtrOp,
/// For `QPtrOp::HandleArrayIndex` and `QPtrOp::DynOffset`, this is the
/// second input (after the `QPtr` which is automatically handled).
dyn_idx: Option<Value>,
}
impl QPtrChainStep {
fn into_data_inst_kind_and_inputs(
self,
in_qptr: Value,
) -> (DataInstKind, SmallVec<[Value; 2]>) {
let Self { op, dyn_idx } = self;
(op.into(), [in_qptr].into_iter().chain(dyn_idx).collect())
}
}
impl LowerFromSpvPtrInstsInFunc<'_> {
fn try_lower_access_chain(
&self,
mut layout: TypeLayout,
indices: &[Value],
) -> Result<SmallVec<[QPtrChainStep; 4]>, LowerError> {
// FIXME(eddyb) pass in the `AddrSpace` to determine this correctly.
let is_logical_addressing = true;
let const_idx_as_i32 = |idx| match idx {
// FIXME(eddyb) figure out the signedness semantics here.
Value::Const(idx) => self.lowerer.const_as_u32(idx).map(|idx_u32| idx_u32 as i32),
_ => None,
};
let mut steps: SmallVec<[QPtrChainStep; 4]> = SmallVec::new();
let mut indices = indices.iter().copied();
while indices.len() > 0 {
let (mut op, component_layout) = match layout {
TypeLayout::Handle(shapes::Handle::Opaque(_)) => {
return Err(LowerError(Diag::bug([
"opaque handles have no sub-components".into()
])));
}
TypeLayout::Handle(shapes::Handle::Buffer(_, buffer_data_layout)) => {
(QPtrOp::BufferData, TypeLayout::Concrete(buffer_data_layout))
}
TypeLayout::HandleArray(handle, _) => {
(QPtrOp::HandleArrayIndex, TypeLayout::Handle(handle))
}
TypeLayout::Concrete(concrete) => match &concrete.components {
Components::Scalar => {
return Err(LowerError(Diag::bug([
"scalars have no sub-components".into()
])));
}
// FIXME(eddyb) handle the weird `OpTypeMatrix` layout when `RowMajor`.
Components::Elements { stride, elem, fixed_len } => (
QPtrOp::DynOffset {
stride: *stride,
// FIXME(eddyb) even without a fixed length, logical
// addressing still implies the index is *positive*,
// that should be encoded here, to help analysis.
index_bounds: fixed_len
.filter(|_| is_logical_addressing)
.and_then(|len| Some(0..len.get().try_into().ok()?)),
},
TypeLayout::Concrete(elem.clone()),
),
Components::Fields { offsets, layouts } => {
let field_idx =
const_idx_as_i32(indices.next().unwrap()).ok_or_else(|| {
LowerError(Diag::bug(["non-constant field index".into()]))
})?;
let (field_offset, field_layout) = usize::try_from(field_idx)
.ok()
.and_then(|field_idx| {
Some((*offsets.get(field_idx)?, layouts.get(field_idx)?.clone()))
})
.ok_or_else(|| {
LowerError(Diag::bug([format!(
"field {field_idx} out of bounds (expected 0..{})",
offsets.len()
)
.into()]))
})?;
(
QPtrOp::Offset(i32::try_from(field_offset).ok().ok_or_else(|| {
LowerError(Diag::bug([format!(
"{field_offset} not representable as a positive s32"
)
.into()]))
})?),
TypeLayout::Concrete(field_layout),
)
}
},
};
layout = component_layout;
// Automatically grab the dynamic index, whenever necessary.
let mut dyn_idx = match op {
QPtrOp::HandleArrayIndex | QPtrOp::DynOffset { .. } => {
Some(indices.next().unwrap())
}
_ => None,
};
// Constant-fold dynamic indexing, whenever possible.
if let QPtrOp::DynOffset { stride, index_bounds } = &op {
let const_offset = const_idx_as_i32(dyn_idx.unwrap())
.filter(|const_idx| {
index_bounds.as_ref().map_or(true, |bounds| bounds.contains(const_idx))
})
.and_then(|const_idx| i32::try_from(stride.get()).ok()?.checked_mul(const_idx));
if let Some(const_offset) = const_offset {
op = QPtrOp::Offset(const_offset);
dyn_idx = None;
}
}
// Combine consecutive immediate offsets, whenever possible.
match (steps.last_mut().map(|last_step| &mut last_step.op), &op) {
// Complete ignore noop offsets.
(_, QPtrOp::Offset(0)) => {}
(Some(QPtrOp::Offset(last_offset)), &QPtrOp::Offset(new_offset)) => {
*last_offset = last_offset.checked_add(new_offset).ok_or_else(|| {
LowerError(Diag::bug([format!(
"offset overflow ({last_offset}+{new_offset})"
)
.into()]))
})?;
}
_ => steps.push(QPtrChainStep { op, dyn_idx }),
}
}
Ok(steps)
}
fn try_lower_data_inst_def(
&self,
mut func_at_data_inst: FuncAtMut<'_, DataInst>,
parent_block: ControlNode,
) -> Result<Transformed<DataInstDef>, LowerError> {
let cx = &self.lowerer.cx;
let wk = self.lowerer.wk;
let func_at_data_inst_frozen = func_at_data_inst.reborrow().freeze();
let data_inst = func_at_data_inst_frozen.position;
let data_inst_def = func_at_data_inst_frozen.def();
// FIXME(eddyb) is this a good convention?
let func = func_at_data_inst_frozen.at(());
let mut attrs = data_inst_def.attrs;
let DataInstFormDef { ref kind, output_type } = cx[data_inst_def.form];
let spv_inst = match kind {
DataInstKind::SpvInst(spv_inst) => spv_inst,
_ => return Ok(Transformed::Unchanged),
};
let replacement_kind_and_inputs = if spv_inst.opcode == wk.OpVariable {
assert!(data_inst_def.inputs.len() <= 1);
let (_, var_data_type) =
self.lowerer.as_spv_ptr_type(output_type.unwrap()).ok_or_else(|| {
LowerError(Diag::bug(["output type not an `OpTypePointer`".into()]))
})?;
match self.lowerer.layout_of(var_data_type)? {
TypeLayout::Concrete(concrete) if concrete.mem_layout.dyn_unit_stride.is_none() => {
(
QPtrOp::FuncLocalVar(concrete.mem_layout.fixed_base).into(),
data_inst_def.inputs.clone(),
)
}
_ => return Ok(Transformed::Unchanged),
}
} else if spv_inst.opcode == wk.OpLoad {
// FIXME(eddyb) support memory operands somehow.
if !spv_inst.imms.is_empty() {
return Ok(Transformed::Unchanged);
}
assert_eq!(data_inst_def.inputs.len(), 1);
(QPtrOp::Load.into(), data_inst_def.inputs.clone())
} else if spv_inst.opcode == wk.OpStore {
// FIXME(eddyb) support memory operands somehow.
if !spv_inst.imms.is_empty() {
return Ok(Transformed::Unchanged);
}
assert_eq!(data_inst_def.inputs.len(), 2);
(QPtrOp::Store.into(), data_inst_def.inputs.clone())
} else if spv_inst.opcode == wk.OpArrayLength {
let field_idx = match spv_inst.imms[..] {
[spv::Imm::Short(_, field_idx)] => field_idx,
_ => unreachable!(),
};
assert_eq!(data_inst_def.inputs.len(), 1);
let ptr = data_inst_def.inputs[0];
let (_, pointee_type) =
self.lowerer.as_spv_ptr_type(func.at(ptr).type_of(cx)).ok_or_else(|| {
LowerError(Diag::bug(["pointer input not an `OpTypePointer`".into()]))
})?;
let buf_data_layout = match self.lowerer.layout_of(pointee_type)? {
TypeLayout::Handle(shapes::Handle::Buffer(_, buf)) => buf,
_ => return Err(LowerError(Diag::bug(["non-Buffer pointee".into()]))),
};
let (field_offset, field_layout) = match &buf_data_layout.components {
Components::Fields { offsets, layouts } => usize::try_from(field_idx)
.ok()
.and_then(|field_idx| {
Some((*offsets.get(field_idx)?, layouts.get(field_idx)?.clone()))
})
.ok_or_else(|| {
LowerError(Diag::bug([format!(
"field {field_idx} out of bounds (expected 0..{})",
offsets.len()
)
.into()]))
})?,
_ => {
return Err(LowerError(Diag::bug(
["buffer data not an `OpTypeStruct`".into()],
)));
}
};
let array_stride = match field_layout.components {
Components::Elements { stride, fixed_len: None, .. } => stride,
_ => {
return Err(LowerError(Diag::bug([format!(
"buffer data field #{field_idx} not an `OpTypeRuntimeArray`"
)
.into()])));
}
};
// Sanity-check layout invariants (should always hold given above checks).
assert_eq!(field_layout.mem_layout.fixed_base.size, 0);
assert_eq!(field_layout.mem_layout.dyn_unit_stride, Some(array_stride));
assert_eq!(buf_data_layout.mem_layout.fixed_base.size, field_offset);
assert_eq!(buf_data_layout.mem_layout.dyn_unit_stride, Some(array_stride));
(
QPtrOp::BufferDynLen {
fixed_base_size: field_offset,
dyn_unit_stride: array_stride,
}
.into(),
data_inst_def.inputs.clone(),
)
} else if [
wk.OpAccessChain,
wk.OpInBoundsAccessChain,
wk.OpPtrAccessChain,
wk.OpInBoundsPtrAccessChain,
]
.contains(&spv_inst.opcode)
{
// FIXME(eddyb) avoid erasing the "inbounds" qualifier.
let base_ptr = data_inst_def.inputs[0];
let (_, base_pointee_type) =
self.lowerer.as_spv_ptr_type(func.at(base_ptr).type_of(cx)).ok_or_else(|| {
LowerError(Diag::bug(["pointer input not an `OpTypePointer`".into()]))
})?;
// HACK(eddyb) for `OpPtrAccessChain`, this pretends to be indexing
// a `OpTypeRuntimeArray`, with the original type as the element type.
let access_chain_base_layout =
if [wk.OpPtrAccessChain, wk.OpInBoundsPtrAccessChain].contains(&spv_inst.opcode) {
self.lowerer.layout_of(cx.intern(TypeDef {
attrs: AttrSet::default(),
ctor: TypeCtor::SpvInst(wk.OpTypeRuntimeArray.into()),
ctor_args: [TypeCtorArg::Type(base_pointee_type)].into_iter().collect(),
}))?
} else {
self.lowerer.layout_of(base_pointee_type)?
};
let mut steps =
self.try_lower_access_chain(access_chain_base_layout, &data_inst_def.inputs[1..])?;
// HACK(eddyb) noop cases should probably not use any `DataInst`s at all,
// but that would require the ability to replace all uses of a `Value`.
let final_step =
steps.pop().unwrap_or(QPtrChainStep { op: QPtrOp::Offset(0), dyn_idx: None });
let mut ptr = base_ptr;
for step in steps {
let (kind, inputs) = step.into_data_inst_kind_and_inputs(ptr);
let step_data_inst = func_at_data_inst.reborrow().data_insts.define(
cx,
DataInstDef {
attrs: Default::default(),
form: cx.intern(DataInstFormDef {
kind,
output_type: Some(self.lowerer.qptr_type()),
}),
inputs,
}
.into(),
);
// HACK(eddyb) can't really use helpers like `FuncAtMut::def`,
// due to the need to borrow `control_nodes` and `data_insts`
// at the same time - perhaps some kind of `FuncAtMut` position
// types for "where a list is in a parent entity" could be used
// to make this more ergonomic, although the potential need for
// an actual list entity of its own, should be considered.
let func = func_at_data_inst.reborrow().at(());
match &mut func.control_nodes[parent_block].kind {
ControlNodeKind::Block { insts } => {
insts.insert_before(step_data_inst, data_inst, func.data_insts);
}
_ => unreachable!(),
}
ptr = Value::DataInstOutput(step_data_inst);
}
final_step.into_data_inst_kind_and_inputs(ptr)
} else if spv_inst.opcode == wk.OpBitcast {
let input = data_inst_def.inputs[0];
// Pointer-to-pointer casts are noops on `qptr`.
if self.lowerer.as_spv_ptr_type(func.at(input).type_of(cx)).is_some()
&& self.lowerer.as_spv_ptr_type(output_type.unwrap()).is_some()
{
// HACK(eddyb) noop cases should not use any `DataInst`s at all,
// but that would require the ability to replace all uses of a `Value`.
let noop_step = QPtrChainStep { op: QPtrOp::Offset(0), dyn_idx: None };
// HACK(eddyb) since we're not removing the `DataInst` entirely,
// at least get rid of its attributes to clearly mark it as synthetic.
attrs = AttrSet::default();
noop_step.into_data_inst_kind_and_inputs(input)
} else {
return Ok(Transformed::Unchanged);
}
} else {
return Ok(Transformed::Unchanged);
};
// FIXME(eddyb) should the `if`-`else` chain above produce `DataInstDef`s?
let (new_kind, new_inputs) = replacement_kind_and_inputs;
Ok(Transformed::Changed(DataInstDef {
attrs,
// FIXME(eddyb) because this is now interned, it might be better to
// temporarily track the old output types in a map, and not actually
// intern the non-`qptr`-output `qptr.*` instructions.
form: cx.intern(DataInstFormDef { kind: new_kind, output_type }),
inputs: new_inputs,
}))
}
fn add_fallback_attrs_to_data_inst_def(
&self,
mut func_at_data_inst: FuncAtMut<'_, DataInst>,
extra_error: Option<LowerError>,
) {
let cx = &self.lowerer.cx;
let func_at_data_inst_frozen = func_at_data_inst.reborrow().freeze();
let data_inst_def = func_at_data_inst_frozen.def();
let data_inst_form_def = &cx[data_inst_def.form];
// FIXME(eddyb) is this a good convention?
let func = func_at_data_inst_frozen.at(());
match data_inst_form_def.kind {
// Known semantics, no need to preserve SPIR-V pointer information.
DataInstKind::FuncCall(_) | DataInstKind::QPtr(_) => return,
DataInstKind::SpvInst(_) | DataInstKind::SpvExtInst { .. } => {}
}
let mut old_and_new_attrs = None;
let get_old_attrs = || AttrSetDef { attrs: cx[data_inst_def.attrs].attrs.clone() };
for (input_idx, &v) in data_inst_def.inputs.iter().enumerate() {
if let Some((_, pointee)) = self.lowerer.as_spv_ptr_type(func.at(v).type_of(cx)) {
old_and_new_attrs.get_or_insert_with(get_old_attrs).attrs.insert(
QPtrAttr::ToSpvPtrInput {
input_idx: input_idx.try_into().unwrap(),
pointee: OrdAssertEq(pointee),
}
.into(),
);
}
}
if let Some(output_type) = data_inst_form_def.output_type {
if let Some((addr_space, pointee)) = self.lowerer.as_spv_ptr_type(output_type) {
old_and_new_attrs.get_or_insert_with(get_old_attrs).attrs.insert(
QPtrAttr::FromSpvPtrOutput {
addr_space: OrdAssertEq(addr_space),
pointee: OrdAssertEq(pointee),
}
.into(),
);
}
}
if let Some(LowerError(e)) = extra_error {
old_and_new_attrs.get_or_insert_with(get_old_attrs).push_diag(e);
}
if let Some(attrs) = old_and_new_attrs {
func_at_data_inst.def().attrs = cx.intern(attrs);
}
}
}
impl Transformer for LowerFromSpvPtrInstsInFunc<'_> {
// HACK(eddyb) while we want to transform `DataInstDef`s, we can't inject
// adjacent instructions without access to the parent `ControlNodeKind::Block`,
// and to fix this would likely require list nodes to carry some handle to
// the list they're part of, either the whole semantic parent, or something
// more contrived, where lists are actually allocated entities of their own,
// perhaps something where an `EntityListDefs<DataInstDef>` contains both:
// - an `EntityDefs<EntityListNode<DataInstDef>>` (keyed by `DataInst`)
// - an `EntityDefs<EntityListDef<DataInst>>` (keyed by `EntityList<DataInst>`)
fn in_place_transform_control_node_def(
&mut self,
mut func_at_control_node: FuncAtMut<'_, ControlNode>,
) {
func_at_control_node.reborrow().inner_in_place_transform_with(self);
let control_node = func_at_control_node.position;
if let ControlNodeKind::Block { insts } = func_at_control_node.reborrow().def().kind {
let mut func_at_inst_iter = func_at_control_node.reborrow().at(insts).into_iter();
while let Some(mut func_at_inst) = func_at_inst_iter.next() {
match self.try_lower_data_inst_def(func_at_inst.reborrow(), control_node) {
Ok(Transformed::Changed(new_def)) => {
*func_at_inst.def() = new_def;
}
result @ (Ok(Transformed::Unchanged) | Err(_)) => {
self.add_fallback_attrs_to_data_inst_def(func_at_inst, result.err());
}
}
}
}
}
}