spirv_tools_sys/shared.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
use std::fmt;
/// Certain target environments impose additional restrictions on SPIR-V, so it's
/// often necessary to specify which one applies. `Universal_*` implies an
/// environment-agnostic SPIR-V.
///
/// When an API method needs to derive a SPIR-V version from a target environment
/// the method will choose the highest version of SPIR-V supported by the target
/// environment. Examples:
///
/// ```text
/// SPV_ENV_VULKAN_1_0 -> SPIR-V 1.0
/// SPV_ENV_VULKAN_1_1 -> SPIR-V 1.3
/// SPV_ENV_VULKAN_1_1_SPIRV_1_4 -> SPIR-V 1.4
/// SPV_ENV_VULKAN_1_2 -> SPIR-V 1.5
/// ```
///
/// Consult the description of API entry points for specific rules.
#[derive(Copy, Clone, Debug, PartialEq)]
#[repr(C)]
#[allow(non_camel_case_types, clippy::upper_case_acronyms)]
pub enum TargetEnv {
/// SPIR-V 1.0 latest revision, no other restrictions.
Universal_1_0,
/// Vulkan 1.0 latest revision.
Vulkan_1_0,
/// SPIR-V 1.1 latest revision, no other restrictions.
Universal_1_1,
/// `OpenCL` Full Profile 2.1 latest revision.
OpenCL_2_1,
/// `OpenCL` Full Profile 2.2 latest revision.
OpenCL_2_2,
/// OpenGL 4.0 plus `GL_ARB_gl_spirv`, latest revisions.
OpenGL_4_0,
/// OpenGL 4.1 plus `GL_ARB_gl_spirv`, latest revisions.
OpenGL_4_1,
/// OpenGL 4.2 plus `GL_ARB_gl_spirv`, latest revisions.
OpenGL_4_2,
/// OpenGL 4.3 plus `GL_ARB_gl_spirv`, latest revisions.
OpenGL_4_3,
/// OpenGL 4.5 plus `GL_ARB_gl_spirv`, latest revisions.
OpenGL_4_5,
/// SPIR-V 1.2, latest revision, no other restrictions.
Universal_1_2,
/// `OpenCL` Full Profile 1.2 plus `cl_khr_il_program`, latest revision.
OpenCL_1_2,
/// `OpenCL` Embedded Profile 1.2 plus `cl_khr_il_program`, latest revision.
OpenCLEmbedded_1_2,
/// `OpenCL` Full Profile 2.0 plus `cl_khr_il_program`, latest revision.
OpenCL_2_0,
/// `OpenCL` Embedded Profile 2.0 plus `cl_khr_il_program`, latest revision.
OpenCLEmbedded_2_0,
/// `OpenCL` Embedded Profile 2.1 latest revision.
OpenCLEmbedded_2_1,
/// `OpenCL` Embedded Profile 2.2 latest revision.
OpenCLEmbedded_2_2,
/// SPIR-V 1.3 latest revision, no other restrictions.
Universal_1_3,
/// Vulkan 1.1 latest revision.
Vulkan_1_1,
/// Work in progress WebGPU 1.0.
WebGPU_0,
/// SPIR-V 1.4 latest revision, no other restrictions.
Universal_1_4,
/// Vulkan 1.1 with `VK_KHR_spirv_1_4`, i.e. SPIR-V 1.4 binary.
Vulkan_1_1_Spirv_1_4,
/// SPIR-V 1.5 latest revision, no other restrictions.
Universal_1_5,
/// Vulkan 1.2 latest revision.
Vulkan_1_2,
}
impl Default for TargetEnv {
fn default() -> Self {
// This is the default target environment for (AFAICT) all spirv-tools
Self::Universal_1_5
}
}
impl std::str::FromStr for TargetEnv {
type Err = SpirvResult;
fn from_str(s: &str) -> Result<Self, Self::Err> {
Ok(match s {
"vulkan1.1spv1.4" => Self::Vulkan_1_1_Spirv_1_4,
"vulkan1.0" => Self::Vulkan_1_0,
"vulkan1.1" => Self::Vulkan_1_1,
"vulkan1.2" => Self::Vulkan_1_2,
"spv1.0" => Self::Universal_1_0,
"spv1.1" => Self::Universal_1_1,
"spv1.2" => Self::Universal_1_2,
"spv1.3" => Self::Universal_1_3,
"spv1.4" => Self::Universal_1_4,
"spv1.5" => Self::Universal_1_5,
"opencl1.2embedded" => Self::OpenCLEmbedded_1_2,
"opencl1.2" => Self::OpenCL_1_2,
"opencl2.0embedded" => Self::OpenCLEmbedded_2_0,
"opencl2.0" => Self::OpenCL_2_0,
"opencl2.1embedded" => Self::OpenCLEmbedded_2_1,
"opencl2.1" => Self::OpenCL_2_1,
"opencl2.2embedded" => Self::OpenCLEmbedded_2_2,
"opencl2.2" => Self::OpenCL_2_2,
"opengl4.0" => Self::OpenGL_4_0,
"opengl4.1" => Self::OpenGL_4_1,
"opengl4.2" => Self::OpenGL_4_2,
"opengl4.3" => Self::OpenGL_4_3,
"opengl4.5" => Self::OpenGL_4_5,
"webgpu0" => Self::WebGPU_0,
_ => return Err(SpirvResult::InvalidValue),
})
}
}
impl fmt::Display for TargetEnv {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(match self {
Self::Vulkan_1_1_Spirv_1_4 => "vulkan1.1spv1.4",
Self::Vulkan_1_0 => "vulkan1.0",
Self::Vulkan_1_1 => "vulkan1.1",
Self::Vulkan_1_2 => "vulkan1.2",
Self::Universal_1_0 => "spv1.0",
Self::Universal_1_1 => "spv1.1",
Self::Universal_1_2 => "spv1.2",
Self::Universal_1_3 => "spv1.3",
Self::Universal_1_4 => "spv1.4",
Self::Universal_1_5 => "spv1.5",
Self::OpenCLEmbedded_1_2 => "opencl1.2embedded",
Self::OpenCL_1_2 => "opencl1.2",
Self::OpenCLEmbedded_2_0 => "opencl2.0embedded",
Self::OpenCL_2_0 => "opencl2.0",
Self::OpenCLEmbedded_2_1 => "opencl2.1embedded",
Self::OpenCL_2_1 => "opencl2.1",
Self::OpenCLEmbedded_2_2 => "opencl2.2embedded",
Self::OpenCL_2_2 => "opencl2.2",
Self::OpenGL_4_0 => "opengl4.0",
Self::OpenGL_4_1 => "opengl4.1",
Self::OpenGL_4_2 => "opengl4.2",
Self::OpenGL_4_3 => "opengl4.3",
Self::OpenGL_4_5 => "opengl4.5",
Self::WebGPU_0 => "webgpu0",
})
}
}
#[derive(Copy, Clone, Debug, PartialEq)]
#[repr(i32)] // SPV_FORCE_32_BIT_ENUM
pub enum SpirvResult {
Success = 0,
Unsupported = 1,
EndOfStream = 2,
Warning = 3,
FailedMatch = 4,
/// Success, but signals early termination.
RequestedTermination = 5,
InternalError = -1,
OutOfMemory = -2,
InvalidPointer = -3,
InvalidBinary = -4,
InvalidText = -5,
InvalidTable = -6,
InvalidValue = -7,
InvalidDiagnostic = -8,
InvalidLookup = -9,
InvalidId = -10,
InvalidCfg = -11,
InvalidLayout = -12,
InvalidCapability = -13,
/// Indicates data rules validation failure.
InvalidData = -14,
MissingExtension = -15,
/// Indicates wrong SPIR-V version
WrongVersion = -16,
}
impl fmt::Display for SpirvResult {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
#[allow(clippy::enum_glob_use)]
use SpirvResult::*;
match self {
Success => f.write_str("success"),
Unsupported => f.write_str("unsupported"),
EndOfStream => f.write_str("end of stream"),
Warning => f.write_str("warning"),
FailedMatch => f.write_str("failed match"),
RequestedTermination => f.write_str("requested termination"),
InternalError => f.write_str("internal error"),
OutOfMemory => f.write_str("out of memory"),
InvalidPointer => f.write_str("invalid pointer"),
InvalidBinary => f.write_str("invalid binary"),
InvalidText => f.write_str("invalid text"),
InvalidTable => f.write_str("invalid table"),
InvalidValue => f.write_str("invalid value"),
InvalidDiagnostic => f.write_str("invalid diagnostic"),
InvalidLookup => f.write_str("invalid lookup"),
InvalidId => f.write_str("invalid id"),
InvalidCfg => f.write_str("invalid cfg"),
InvalidLayout => f.write_str("invalid layout"),
InvalidCapability => f.write_str("invalid capability"),
InvalidData => f.write_str("invalid data"),
MissingExtension => f.write_str("missing extension"),
WrongVersion => f.write_str("wrong SPIR-V version"),
}
}
}
impl std::error::Error for SpirvResult {}
#[repr(C)]
pub struct Binary {
pub code: *const u32,
pub size: usize,
}
#[repr(C)]
pub struct ToolContext {
_unused: [u8; 0],
}
extern "C" {
/// Creates a context object for most of the SPIRV-Tools API.
/// Returns null if env is invalid.
///
/// See specific API calls for how the target environment is interpeted
/// (particularly assembly and validation).
#[link_name = "spvContextCreate"]
pub fn context_create(env: TargetEnv) -> *mut ToolContext;
/// Destroys the given context object.
#[link_name = "spvContextDestroy"]
pub fn context_destroy(opt: *mut ToolContext);
/// Frees a binary stream from memory. This is a no-op if binary is a null
/// pointer.
#[link_name = "spvBinaryDestroy"]
pub fn binary_destroy(binary: *mut Binary);
}