1 // Copyright (c) 2015-2016 The Khronos Group Inc. 2 // 3 // Licensed under the Apache License, Version 2.0 (the "License"); 4 // you may not use this file except in compliance with the License. 5 // You may obtain a copy of the License at 6 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 #ifndef LIBSPIRV_SPIRV_CONSTANT_H_ 16 #define LIBSPIRV_SPIRV_CONSTANT_H_ 17 18 #include "spirv-tools/libspirv.h" 19 #include "spirv/1.2/spirv.h" 20 21 // Version number macros. 22 23 // Evaluates to a well-formed version header word, given valid 24 // SPIR-V version major and minor version numbers. 25 #define SPV_SPIRV_VERSION_WORD(MAJOR, MINOR) \ 26 ((uint32_t(uint8_t(MAJOR)) << 16) | (uint32_t(uint8_t(MINOR)) << 8)) 27 // Returns the major version extracted from a version header word. 28 #define SPV_SPIRV_VERSION_MAJOR_PART(WORD) ((uint32_t(WORD) >> 16) & 0xff) 29 // Returns the minor version extracted from a version header word. 30 #define SPV_SPIRV_VERSION_MINOR_PART(WORD) ((uint32_t(WORD) >> 8) & 0xff) 31 32 // Returns the version number for the given SPIR-V target environment. 33 uint32_t spvVersionForTargetEnv(spv_target_env env); 34 35 // Header indices 36 37 #define SPV_INDEX_MAGIC_NUMBER 0u 38 #define SPV_INDEX_VERSION_NUMBER 1u 39 #define SPV_INDEX_GENERATOR_NUMBER 2u 40 #define SPV_INDEX_BOUND 3u 41 #define SPV_INDEX_SCHEMA 4u 42 #define SPV_INDEX_INSTRUCTION 5u 43 44 // Universal limits 45 46 // SPIR-V 1.0 limits 47 #define SPV_LIMIT_INSTRUCTION_WORD_COUNT_MAX 0xffff 48 #define SPV_LIMIT_LITERAL_STRING_UTF8_CHARS_MAX 0xffff 49 50 // A single Unicode character in UTF-8 encoding can take 51 // up 4 bytes. 52 #define SPV_LIMIT_LITERAL_STRING_BYTES_MAX \ 53 (SPV_LIMIT_LITERAL_STRING_UTF8_CHARS_MAX * 4) 54 55 // NOTE: These are set to the minimum maximum values 56 // TODO(dneto): Check these. 57 58 // libspirv limits. 59 #define SPV_LIMIT_RESULT_ID_BOUND 0x00400000 60 #define SPV_LIMIT_CONTROL_FLOW_NEST_DEPTH 0x00000400 61 #define SPV_LIMIT_GLOBAL_VARIABLES_MAX 0x00010000 62 #define SPV_LIMIT_LOCAL_VARIABLES_MAX 0x00080000 63 // TODO: Decorations per target ID max, depends on decoration table size 64 #define SPV_LIMIT_EXECUTION_MODE_PER_ENTRY_POINT_MAX 0x00000100 65 #define SPV_LIMIT_INDICIES_MAX_ACCESS_CHAIN_COMPOSITE_MAX 0x00000100 66 #define SPV_LIMIT_FUNCTION_PARAMETERS_PER_FUNCTION_DECL 0x00000100 67 #define SPV_LIMIT_FUNCTION_CALL_ARGUMENTS_MAX 0x00000100 68 #define SPV_LIMIT_EXT_FUNCTION_CALL_ARGUMENTS_MAX 0x00000100 69 #define SPV_LIMIT_SWITCH_LITERAL_LABEL_PAIRS_MAX 0x00004000 70 #define SPV_LIMIT_STRUCT_MEMBERS_MAX 0x0000400 71 #define SPV_LIMIT_STRUCT_NESTING_DEPTH_MAX 0x00000100 72 73 // Enumerations 74 75 // Values mapping to registered tools. See the registry at 76 // https://www.khronos.org/registry/spir-v/api/spir-v.xml 77 // These values occupy the higher order 16 bits of the generator magic word. 78 typedef enum spv_generator_t { 79 // TODO(dneto) Values 0 through 5 were registered only as vendor. 80 SPV_GENERATOR_KHRONOS = 0, 81 SPV_GENERATOR_LUNARG = 1, 82 SPV_GENERATOR_VALVE = 2, 83 SPV_GENERATOR_CODEPLAY = 3, 84 SPV_GENERATOR_NVIDIA = 4, 85 SPV_GENERATOR_ARM = 5, 86 // These are vendor and tool. 87 SPV_GENERATOR_KHRONOS_LLVM_TRANSLATOR = 6, 88 SPV_GENERATOR_KHRONOS_ASSEMBLER = 7, 89 SPV_GENERATOR_KHRONOS_GLSLANG = 8, 90 SPV_GENERATOR_NUM_ENTRIES, 91 SPV_FORCE_16_BIT_ENUM(spv_generator_t) 92 } spv_generator_t; 93 94 // Evaluates to a well-formed generator magic word from a tool value and 95 // miscellaneous 16-bit value. 96 #define SPV_GENERATOR_WORD(TOOL, MISC) \ 97 ((uint32_t(uint16_t(TOOL)) << 16) | uint16_t(MISC)) 98 // Returns the tool component of the generator word. 99 #define SPV_GENERATOR_TOOL_PART(WORD) (uint32_t(WORD) >> 16) 100 // Returns the misc part of the generator word. 101 #define SPV_GENERATOR_MISC_PART(WORD) (uint32_t(WORD) & 0xFFFF) 102 103 #endif // LIBSPIRV_SPIRV_CONSTANT_H_ 104
