Skip to content

Minimal support for several SPIR-V features (either new, or rare edge cases, some Rust-GPU specific). #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
eddyb wants to merge 4 commits into from
Draft

Minimal support for several SPIR-V features (either new, or rare edge cases, some Rust-GPU specific). #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
cac4f8c
spv/print: generalize `operand_from_imms` to `operand` that can also …
eddyb Oct 8, 2026
e9fdfd2
Support IDs (`Const`s) in `Attr::SpvAnnotation` (for e.g. `OpDecorate…
eddyb Oct 8, 2026
44eb9c4
Embed `Type`s in values via `ConstKind::SpvTypeOperand`, for SPIR-V i…
eddyb Oct 9, 2026
64d7eb3
spv/lower: support illegal forward refs to global `OpVariable`s (for …
eddyb Dec 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,20 @@ pub enum Attr {
#[from]
QPtr(qptr::QPtrAttr),

SpvAnnotation(spv::Inst),
SpvAnnotation {
spv_inst: spv::Inst,

/// If present, each "instance" represents a different use of `spv_inst`,
/// grouped together only because the non-ID operands (enumerand/literals)
/// inside `spv::Inst` are not enough to uniquely identify an annotation
/// (i.e. at least some of the `Const` IDs are semantically part of the
/// "key" side `Attr`, which should normally be outside the `OrdAssertEq`).
//
// HACK(eddyb) this is enough of a complication to furthger call into
// question the use of ordered sets for `AttrSet`s, in the first place.
#[allow(clippy::type_complexity)]
per_instance_const_inputs: Option<OrdAssertEq<Rc<Vec<SmallVec<[Const; 2]>>>>>,
},

/// Some SPIR-V instructions, like `OpFunction`, take a bitflags operand
/// that is effectively an optimization over using `OpDecorate`.
Expand Down Expand Up @@ -552,6 +565,10 @@ pub enum TypeKind {
type_and_const_inputs: SmallVec<[TypeOrConst; 2]>,
},

/// The type of a [`ConstKind::SpvTypeOperand`] constant, i.e. a [`Type`]
/// embedded in a [`Value`] to be passed as a SPIR-V operand.
SpvTypeOperand,

/// The type of a [`ConstKind::SpvStringLiteralForExtInst`] constant, i.e.
/// a SPIR-V `OpString` with no actual type in SPIR-V.
SpvStringLiteralForExtInst,
Expand Down Expand Up @@ -595,6 +612,9 @@ pub enum ConstKind {
spv_inst_and_const_inputs: Rc<(spv::Inst, SmallVec<[Const; 4]>)>,
},

/// Type used as an operand to a SPIR-V instruction (other than result type).
SpvTypeOperand(Type),

/// SPIR-V `OpString`, but only when used as an operand for an `OpExtInst`,
/// which can't have literals itself - for non-string literals `OpConstant*`
/// are readily usable, but only `OpString` is supported for string literals.
Expand Down
131 changes: 94 additions & 37 deletions src/print/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,7 +483,12 @@ impl<'a> Visitor<'a> for Plan<'a> {
.attrs
.iter()
.filter_map(|attr| match attr {
Attr::SpvAnnotation(spv_inst) if spv_inst.opcode == wk.OpName => Some(spv_inst),
Attr::SpvAnnotation { spv_inst, per_instance_const_inputs }
if spv_inst.opcode == wk.OpName =>
{
assert!(per_instance_const_inputs.is_none());
Some(spv_inst)
}
_ => None,
})
.peekable();
Expand Down Expand Up @@ -1132,9 +1137,9 @@ impl<'a> Printer<'a> {
|| type_and_const_inputs.is_empty()
}

TypeKind::QPtr | TypeKind::SpvStringLiteralForExtInst => {
true
}
TypeKind::QPtr
| TypeKind::SpvTypeOperand
| TypeKind::SpvStringLiteralForExtInst => true,
};

ty_def.attrs == AttrSet::default()
Expand Down Expand Up @@ -1874,7 +1879,7 @@ impl Printer<'_> {
&self,
imms: impl IntoIterator<Item = spv::Imm>,
) -> pretty::Fragment {
self.pretty_spv_print_tokens_for_operand(spv::print::operand_from_imms(imms))
self.pretty_spv_print_tokens_for_operand(spv::print::operand(imms, []))
}

/// Pretty-print a single SPIR-V (short) immediate (e.g. an enumerand).
Expand Down Expand Up @@ -2419,7 +2424,7 @@ impl Print for spv::Dialect {
// HACK(eddyb) construct a custom `spv.Capability.{A,B,C}`.
let capability_namespace_prefix = printer
.pretty_spv_print_tokens_for_operand({
let mut tokens = spv::print::operand_from_imms(cap_imms(0));
let mut tokens = spv::print::operand(cap_imms(0), []);
assert!(matches!(
tokens.tokens.pop(),
Some(spv::print::Token::EnumerandName(_))
Expand All @@ -2429,7 +2434,7 @@ impl Print for spv::Dialect {

let mut cap_names = capabilities.iter().map(|&cap| {
printer.pretty_spv_print_tokens_for_operand({
let mut tokens = spv::print::operand_from_imms(cap_imms(cap));
let mut tokens = spv::print::operand(cap_imms(cap), []);
tokens.tokens.drain(..tokens.tokens.len() - 1);
assert!(matches!(
tokens.tokens[..],
Expand Down Expand Up @@ -2703,7 +2708,9 @@ impl Print for AttrSet {
attrs
.iter()
.filter(|attr| match attr {
Attr::SpvAnnotation(spv_inst) => Some(spv_inst) != spv_name_to_hide,
Attr::SpvAnnotation { spv_inst, per_instance_const_inputs: None } => {
Some(spv_inst) != spv_name_to_hide
}
_ => true,
})
.map(|attr| attr.print(printer))
Expand Down Expand Up @@ -2781,7 +2788,14 @@ impl DbgScope {
impl Print for Attr {
type Output = pretty::Fragment;
fn print(&self, printer: &Printer<'_>) -> pretty::Fragment {
let non_comment_attr = match self {
let mk_non_comment_attr = |attr| {
pretty::Fragment::new([
printer.attr_style().apply("#[").into(),
attr,
printer.attr_style().apply("]").into(),
])
};
match self {
&Attr::DbgSrcLoc(OrdAssertEq(dbg_src_loc)) => {
let mut comment = SmallVec::<[_; 4]>::new();

Expand Down Expand Up @@ -2869,11 +2883,11 @@ impl Print for Attr {
}
}

return comment;
comment
}

Attr::Diagnostics(diags) => {
return pretty::Fragment::new(
pretty::Fragment::new(
diags
.0
.iter()
Expand Down Expand Up @@ -2947,7 +2961,7 @@ impl Print for Attr {
])
})
.intersperse(pretty::Node::ForceLineSeparation.into()),
);
)
}

Attr::QPtr(attr) => {
Expand Down Expand Up @@ -2983,41 +2997,77 @@ impl Print for Attr {
("usage", pretty::join_comma_sep("(", [usage.0.print(printer)], ")"))
}
};
pretty::Fragment::new([
mk_non_comment_attr(pretty::Fragment::new([
printer
.demote_style_for_namespace_prefix(printer.attr_style())
.apply("qptr.")
.into(),
printer.attr_style().apply(name).into(),
params_inputs,
])
]))
}

Attr::SpvAnnotation(spv::Inst { opcode, imms }) => {
Attr::SpvAnnotation {
spv_inst: spv::Inst { opcode, imms },
per_instance_const_inputs,
} => {
let wk = &spv::spec::Spec::get().well_known;

// HACK(eddyb) `#[spv.OpDecorate(...)]` is redundant (with its operand).
if [wk.OpDecorate, wk.OpDecorateString, wk.OpExecutionMode].contains(opcode) {
printer.pretty_spv_operand_from_imms(imms.iter().copied())
} else if *opcode == wk.OpName {
// HACK(eddyb) unlike `OpDecorate`, we can't just omit `OpName`,
// but pretending it's a SPIR-T-specific `#[name = "..."]`
// attribute should be good enough for now.
pretty::Fragment::new([
printer.attr_style().apply("name = ").into(),
printer.pretty_spv_operand_from_imms(imms.iter().copied()),
])
} else {
printer.pretty_spv_inst(printer.attr_style(), *opcode, imms, [None])
}
let empty_const_inputs = SmallVec::new();
let instances =
per_instance_const_inputs
.as_ref()
.map_or(std::slice::from_ref(&empty_const_inputs), |instances| {
&instances.0[..]
});

pretty::Fragment::new(
instances
.iter()
.map(|const_inputs| {
// HACK(eddyb) `#[spv.OpDecorate(...)]` is redundant (with its operand).
if [
wk.OpDecorate,
wk.OpDecorateId,
wk.OpDecorateString,
wk.OpExecutionMode,
wk.OpExecutionModeId,
]
.contains(opcode)
{
printer.pretty_spv_print_tokens_for_operand(spv::print::operand(
imms.iter().copied(),
const_inputs.iter().map(|ct| ct.print(printer).into()),
))
} else if *opcode == wk.OpName {
assert_eq!(const_inputs.len(), 0);

// HACK(eddyb) unlike `OpDecorate`, we can't just omit `OpName`,
// but pretending it's a SPIR-T-specific `#[name = "..."]`
// attribute should be good enough for now.
pretty::Fragment::new([
printer.attr_style().apply("name = ").into(),
printer.pretty_spv_operand_from_imms(imms.iter().copied()),
])
} else {
printer.pretty_spv_inst(
printer.attr_style(),
*opcode,
imms,
[None].into_iter().chain(
const_inputs.iter().map(|ct| ct.print(printer)).map(Some),
),
)
}
})
.map(mk_non_comment_attr)
.intersperse_with(|| pretty::Node::ForceLineSeparation.into()),
)
}
&Attr::SpvBitflagsOperand(imm) => printer.pretty_spv_operand_from_imms([imm]),
};
pretty::Fragment::new([
printer.attr_style().apply("#[").into(),
non_comment_attr,
printer.attr_style().apply("]").into(),
])
&Attr::SpvBitflagsOperand(imm) => {
mk_non_comment_attr(printer.pretty_spv_operand_from_imms([imm]))
}
}
}
}

Expand Down Expand Up @@ -3168,6 +3218,12 @@ impl Print for TypeDef {
TypeOrConst::Const(ct) => ct.print(printer),
}),
),
TypeKind::SpvTypeOperand => pretty::Fragment::new([
printer.error_style().apply("type_of"),
"(".into(),
printer.declarative_keyword_style().apply("type"),
")".into(),
]),
TypeKind::SpvStringLiteralForExtInst => pretty::Fragment::new([
printer.error_style().apply("type_of").into(),
"(".into(),
Expand Down Expand Up @@ -3338,6 +3394,7 @@ impl Print for ConstDef {
printer.pretty_type_ascription_suffix(*ty),
])
}
ConstKind::SpvTypeOperand(ty) => ty.print(printer),
&ConstKind::SpvStringLiteralForExtInst(s) => pretty::Fragment::new([
printer.pretty_spv_opcode(printer.spv_op_style(), wk.OpString),
"(".into(),
Expand Down Expand Up @@ -4089,7 +4146,7 @@ impl Print for FuncAt<'_, DataInst> {
}
}
}
ConstKind::PtrToGlobalVar(_) => {}
ConstKind::PtrToGlobalVar(_) | ConstKind::SpvTypeOperand(_) => {}
}
}
None
Expand Down
21 changes: 17 additions & 4 deletions src/qptr/layout.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,9 @@ impl<'a> LayoutCache<'a> {
TypeKind::SpvInst { spv_inst, type_and_const_inputs } => {
(spv_inst, type_and_const_inputs)
}
TypeKind::SpvTypeOperand => {
return Err(LayoutError(Diag::bug(["`layout_of(type_of(type))`".into()])));
}
TypeKind::SpvStringLiteralForExtInst => {
return Err(LayoutError(Diag::bug([
"`layout_of(type_of(OpString<\"...\">))`".into()
Expand Down Expand Up @@ -399,11 +402,14 @@ impl<'a> LayoutCache<'a> {
let mut stride_decoration = None;
for attr in &cx[ty_def.attrs].attrs {
match attr {
Attr::SpvAnnotation(attr_spv_inst)
Attr::SpvAnnotation { spv_inst: attr_spv_inst, per_instance_const_inputs }
if attr_spv_inst.opcode == wk.OpDecorate
&& attr_spv_inst.imms[0]
== spv::Imm::Short(wk.Decoration, wk.ArrayStride) =>
{
// FIXME(eddyb) support `ArrayStrideId`.
assert!(per_instance_const_inputs.is_none());

stride_decoration = Some(match attr_spv_inst.imms[1] {
spv::Imm::Short(_, x) => x,
_ => unreachable!(),
Expand Down Expand Up @@ -445,20 +451,25 @@ impl<'a> LayoutCache<'a> {
let mut field_offsets: SmallVec<[_; 4]> = SmallVec::with_capacity(field_layouts.len());
for attr in &cx[ty_def.attrs].attrs {
match attr {
Attr::SpvAnnotation(attr_spv_inst)
Attr::SpvAnnotation { spv_inst: attr_spv_inst, per_instance_const_inputs }
if attr_spv_inst.opcode == wk.OpMemberDecorate
&& attr_spv_inst.imms[1]
== spv::Imm::Short(wk.Decoration, wk.RowMajor) =>
{
assert!(per_instance_const_inputs.is_none());

return Err(LayoutError(Diag::bug([
"`RowMajor` matrix types unsupported".into(),
])));
}
Attr::SpvAnnotation(attr_spv_inst)
Attr::SpvAnnotation { spv_inst: attr_spv_inst, per_instance_const_inputs }
if attr_spv_inst.opcode == wk.OpMemberDecorate
&& attr_spv_inst.imms[1]
== spv::Imm::Short(wk.Decoration, wk.Offset) =>
{
// FIXME(eddyb) support `OffsetId`.
assert!(per_instance_const_inputs.is_none());

let (field_idx, field_offset) = match attr_spv_inst.imms[..] {
[spv::Imm::Short(_, idx), _, spv::Imm::Short(_, offset)] => {
(idx, offset)
Expand Down Expand Up @@ -597,11 +608,13 @@ impl<'a> LayoutCache<'a> {
let mut is_interface_block = false;
for attr in &cx[ty_def.attrs].attrs {
match attr {
Attr::SpvAnnotation(attr_spv_inst)
Attr::SpvAnnotation { spv_inst: attr_spv_inst, per_instance_const_inputs }
if attr_spv_inst.opcode == wk.OpDecorate
&& attr_spv_inst.imms[0]
== spv::Imm::Short(wk.Decoration, wk.Block) =>
{
assert!(per_instance_const_inputs.is_none());

is_interface_block = true;
break;
}
Expand Down
Loading
Loading