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
|
/*! Metal Shading Language (MSL) backend
## Binding model
Metal's bindings are flat per resource. Since there isn't an obvious mapping
from SPIR-V's descriptor sets, we require a separate mapping provided in the options.
This mapping may have one or more resource end points for each descriptor set + index
pair.
## Outputs
In Metal, built-in shader outputs can not be nested into structures within
the output struct. If there is a structure in the outputs, and it contains any built-ins,
we move them up to the root output structure that we define ourselves.
!*/
use crate::{arena::Handle, proc::ResolveError, FastHashMap};
use std::{
io::{Error as IoError, Write},
string::FromUtf8Error,
};
mod keywords;
mod writer;
pub use writer::Writer;
#[derive(Clone, Debug, Default, PartialEq)]
pub struct BindTarget {
pub buffer: Option<u8>,
pub texture: Option<u8>,
pub sampler: Option<u8>,
pub mutable: bool,
}
#[derive(Clone, Debug, Hash, Eq, Ord, PartialEq, PartialOrd)]
pub struct BindSource {
pub stage: crate::ShaderStage,
pub group: u32,
pub binding: u32,
}
pub type BindingMap = FastHashMap<BindSource, BindTarget>;
enum ResolvedBinding {
BuiltIn(crate::BuiltIn),
Attribute(u32),
Color(u32),
User { prefix: &'static str, index: u32 },
Resource(BindTarget),
}
// Note: some of these should be removed in favor of proper IR validation.
#[derive(Debug)]
pub enum Error {
IO(IoError),
Utf8(FromUtf8Error),
Type(ResolveError),
UnexpectedLocation,
MissingBinding(Handle<crate::GlobalVariable>),
MissingBindTarget(BindSource),
InvalidImageAccess(crate::StorageAccess),
MutabilityViolation(Handle<crate::GlobalVariable>),
BadName(String),
UnexpectedGlobalType(Handle<crate::Type>),
UnimplementedBindTarget(BindTarget),
UnsupportedCompose(Handle<crate::Type>),
UnsupportedBinaryOp(crate::BinaryOperator),
UnexpectedSampleLevel(crate::SampleLevel),
UnsupportedCall(String),
UnsupportedDynamicArrayLength,
UnableToReturnValue(Handle<crate::Expression>),
/// The source IR is not valid.
Validation,
}
impl From<IoError> for Error {
fn from(e: IoError) -> Self {
Error::IO(e)
}
}
impl From<FromUtf8Error> for Error {
fn from(e: FromUtf8Error) -> Self {
Error::Utf8(e)
}
}
impl From<ResolveError> for Error {
fn from(e: ResolveError) -> Self {
Error::Type(e)
}
}
#[derive(Clone, Copy, Debug)]
enum LocationMode {
VertexInput,
FragmentOutput,
Intermediate,
Uniform,
}
#[derive(Debug, Default, Clone)]
pub struct Options {
/// (Major, Minor) target version of the Metal Shading Language.
pub lang_version: (u8, u8),
/// Make it possible to link different stages via SPIRV-Cross.
pub spirv_cross_compatibility: bool,
/// Binding model mapping to Metal.
pub binding_map: BindingMap,
}
impl Options {
fn resolve_binding(
&self,
stage: crate::ShaderStage,
binding: &crate::Binding,
mode: LocationMode,
) -> Result<ResolvedBinding, Error> {
match *binding {
crate::Binding::BuiltIn(built_in) => Ok(ResolvedBinding::BuiltIn(built_in)),
crate::Binding::Location(index) => match mode {
LocationMode::VertexInput => Ok(ResolvedBinding::Attribute(index)),
LocationMode::FragmentOutput => Ok(ResolvedBinding::Color(index)),
LocationMode::Intermediate => Ok(ResolvedBinding::User {
prefix: if self.spirv_cross_compatibility {
"locn"
} else {
"loc"
},
index,
}),
LocationMode::Uniform => Err(Error::UnexpectedLocation),
},
crate::Binding::Resource { group, binding } => {
let source = BindSource {
stage,
group,
binding,
};
self.binding_map
.get(&source)
.cloned()
.map(ResolvedBinding::Resource)
.ok_or(Error::MissingBindTarget(source))
}
}
}
}
impl ResolvedBinding {
fn try_fmt<W: Write>(&self, out: &mut W) -> Result<(), Error> {
match *self {
ResolvedBinding::BuiltIn(built_in) => {
use crate::BuiltIn as Bi;
let name = match built_in {
// vertex
Bi::BaseInstance => "base_instance",
Bi::BaseVertex => "base_vertex",
Bi::ClipDistance => "clip_distance",
Bi::InstanceIndex => "instance_id",
Bi::PointSize => "point_size",
Bi::Position => "position",
Bi::VertexIndex => "vertex_id",
// fragment
Bi::FragCoord => "position",
Bi::FragDepth => "depth(any)",
Bi::FrontFacing => "front_facing",
Bi::SampleIndex => "sample_id",
// compute
Bi::GlobalInvocationId => "thread_position_in_grid",
Bi::LocalInvocationId => "thread_position_in_threadgroup",
Bi::LocalInvocationIndex => "thread_index_in_threadgroup",
Bi::WorkGroupId => "threadgroup_position_in_grid",
};
Ok(write!(out, "{}", name)?)
}
ResolvedBinding::Attribute(index) => Ok(write!(out, "attribute({})", index)?),
ResolvedBinding::Color(index) => Ok(write!(out, "color({})", index)?),
ResolvedBinding::User { prefix, index } => {
Ok(write!(out, "user({}{})", prefix, index)?)
}
ResolvedBinding::Resource(ref target) => {
if let Some(id) = target.buffer {
Ok(write!(out, "buffer({})", id)?)
} else if let Some(id) = target.texture {
Ok(write!(out, "texture({})", id)?)
} else if let Some(id) = target.sampler {
Ok(write!(out, "sampler({})", id)?)
} else {
Err(Error::UnimplementedBindTarget(target.clone()))
}
}
}
}
fn try_fmt_decorated<W: Write>(&self, out: &mut W, terminator: &str) -> Result<(), Error> {
write!(out, " [[")?;
self.try_fmt(out)?;
write!(out, "]]")?;
write!(out, "{}", terminator)?;
Ok(())
}
}
pub fn write_string(module: &crate::Module, options: &Options) -> Result<String, Error> {
let mut w = writer::Writer::new(Vec::new());
w.write(module, options)?;
Ok(String::from_utf8(w.finish())?)
}
|
