Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 1 | // Copyright (c) 2015 The Khronos Group Inc. |
| 2 | // |
| 3 | // Permission is hereby granted, free of charge, to any person obtaining a |
| 4 | // copy of this software and/or associated documentation files (the |
| 5 | // "Materials"), to deal in the Materials without restriction, including |
| 6 | // without limitation the rights to use, copy, modify, merge, publish, |
| 7 | // distribute, sublicense, and/or sell copies of the Materials, and to |
| 8 | // permit persons to whom the Materials are furnished to do so, subject to |
| 9 | // the following conditions: |
| 10 | // |
| 11 | // The above copyright notice and this permission notice shall be included |
| 12 | // in all copies or substantial portions of the Materials. |
| 13 | // |
| 14 | // MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS |
| 15 | // KHRONOS STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS |
| 16 | // SPECIFICATIONS AND HEADER INFORMATION ARE LOCATED AT |
| 17 | // https://www.khronos.org/registry/ |
| 18 | // |
| 19 | // THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
| 20 | // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
| 21 | // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
| 22 | // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
| 23 | // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
| 24 | // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
| 25 | // MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS. |
| 26 | |
David Neto | 36b0c0f | 2015-09-16 18:32:54 -0400 | [diff] [blame] | 27 | #include "text.h" |
| 28 | |
Dejan Mircevski | ba569fb | 2015-09-11 16:34:49 -0400 | [diff] [blame] | 29 | #include <algorithm> |
| 30 | #include <cassert> |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 31 | #include <cctype> |
Dejan Mircevski | ba569fb | 2015-09-11 16:34:49 -0400 | [diff] [blame] | 32 | #include <cstdio> |
| 33 | #include <cstdlib> |
David Neto | 36b0c0f | 2015-09-16 18:32:54 -0400 | [diff] [blame] | 34 | #include <cstring> |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 35 | #include <memory> |
Dejan Mircevski | ba569fb | 2015-09-11 16:34:49 -0400 | [diff] [blame] | 36 | #include <string> |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 37 | #include <sstream> |
David Neto | 36b0c0f | 2015-09-16 18:32:54 -0400 | [diff] [blame] | 38 | #include <unordered_map> |
| 39 | #include <vector> |
Dejan Mircevski | ba569fb | 2015-09-11 16:34:49 -0400 | [diff] [blame] | 40 | |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 41 | #include "binary.h" |
David Neto | 36b0c0f | 2015-09-16 18:32:54 -0400 | [diff] [blame] | 42 | #include "bitwisecast.h" |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 43 | #include "diagnostic.h" |
| 44 | #include "ext_inst.h" |
David Neto | 36b0c0f | 2015-09-16 18:32:54 -0400 | [diff] [blame] | 45 | #include <libspirv/libspirv.h> |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 46 | #include "opcode.h" |
| 47 | #include "operand.h" |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 48 | #include "text_handler.h" |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 49 | |
Lei Zhang | 610c525 | 2015-09-09 10:36:48 -0400 | [diff] [blame] | 50 | using spvutils::BitwiseCast; |
| 51 | |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 52 | |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 53 | bool spvIsValidIDCharacter(const char value) { |
| 54 | return value == '_' || 0 != ::isalnum(value); |
| 55 | } |
| 56 | |
| 57 | // Returns true if the given string represents a valid ID name. |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 58 | bool spvIsValidID(const char *textValue) { |
| 59 | const char *c = textValue; |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 60 | for (; *c != '\0'; ++c) { |
| 61 | if (!spvIsValidIDCharacter(*c)) { |
| 62 | return false; |
| 63 | } |
| 64 | } |
| 65 | // If the string was empty, then the ID also is not valid. |
| 66 | return c != textValue; |
| 67 | } |
| 68 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 69 | // Text API |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 70 | |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 71 | spv_result_t spvTextToLiteral(const char* textValue, spv_literal_t* pLiteral) { |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 72 | bool isSigned = false; |
David Neto | affa696 | 2015-08-24 15:33:14 -0400 | [diff] [blame] | 73 | int numPeriods = 0; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 74 | bool isString = false; |
| 75 | |
David Neto | affa696 | 2015-08-24 15:33:14 -0400 | [diff] [blame] | 76 | const size_t len = strlen(textValue); |
David Neto | 98290a2 | 2015-08-24 16:27:02 -0400 | [diff] [blame] | 77 | if (len == 0) return SPV_FAILED_MATCH; |
| 78 | |
David Neto | affa696 | 2015-08-24 15:33:14 -0400 | [diff] [blame] | 79 | for (uint64_t index = 0; index < len; ++index) { |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 80 | switch (textValue[index]) { |
| 81 | case '0': |
| 82 | case '1': |
| 83 | case '2': |
| 84 | case '3': |
| 85 | case '4': |
| 86 | case '5': |
| 87 | case '6': |
| 88 | case '7': |
| 89 | case '8': |
| 90 | case '9': |
| 91 | break; |
| 92 | case '.': |
David Neto | affa696 | 2015-08-24 15:33:14 -0400 | [diff] [blame] | 93 | numPeriods++; |
| 94 | break; |
| 95 | case '-': |
| 96 | if (index == 0) { |
| 97 | isSigned = true; |
| 98 | } else { |
| 99 | isString = true; |
| 100 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 101 | break; |
| 102 | default: |
| 103 | isString = true; |
Lei Zhang | e78a7c1 | 2015-09-10 17:07:21 -0400 | [diff] [blame] | 104 | index = len; // break out of the loop too. |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 105 | break; |
| 106 | } |
| 107 | } |
| 108 | |
David Neto | affa696 | 2015-08-24 15:33:14 -0400 | [diff] [blame] | 109 | pLiteral->type = spv_literal_type_t(99); |
| 110 | |
Lei Zhang | e78a7c1 | 2015-09-10 17:07:21 -0400 | [diff] [blame] | 111 | if (isString || numPeriods > 1 || (isSigned && len == 1)) { |
David Neto | affa696 | 2015-08-24 15:33:14 -0400 | [diff] [blame] | 112 | // TODO(dneto): Allow escaping. |
David Neto | 98290a2 | 2015-08-24 16:27:02 -0400 | [diff] [blame] | 113 | if (len < 2 || textValue[0] != '"' || textValue[len - 1] != '"') |
| 114 | return SPV_FAILED_MATCH; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 115 | pLiteral->type = SPV_LITERAL_TYPE_STRING; |
David Neto | affa696 | 2015-08-24 15:33:14 -0400 | [diff] [blame] | 116 | // Need room for the null-terminator. |
David Neto | 98290a2 | 2015-08-24 16:27:02 -0400 | [diff] [blame] | 117 | if (len >= sizeof(pLiteral->value.str)) return SPV_ERROR_OUT_OF_MEMORY; |
Lei Zhang | e78a7c1 | 2015-09-10 17:07:21 -0400 | [diff] [blame] | 118 | strncpy(pLiteral->value.str, textValue + 1, len - 2); |
| 119 | pLiteral->value.str[len - 2] = 0; |
David Neto | affa696 | 2015-08-24 15:33:14 -0400 | [diff] [blame] | 120 | } else if (numPeriods == 1) { |
| 121 | double d = std::strtod(textValue, nullptr); |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 122 | float f = (float)d; |
| 123 | if (d == (double)f) { |
| 124 | pLiteral->type = SPV_LITERAL_TYPE_FLOAT_32; |
| 125 | pLiteral->value.f = f; |
| 126 | } else { |
| 127 | pLiteral->type = SPV_LITERAL_TYPE_FLOAT_64; |
| 128 | pLiteral->value.d = d; |
| 129 | } |
| 130 | } else if (isSigned) { |
| 131 | int64_t i64 = strtoll(textValue, nullptr, 10); |
| 132 | int32_t i32 = (int32_t)i64; |
| 133 | if (i64 == (int64_t)i32) { |
| 134 | pLiteral->type = SPV_LITERAL_TYPE_INT_32; |
| 135 | pLiteral->value.i32 = i32; |
| 136 | } else { |
| 137 | pLiteral->type = SPV_LITERAL_TYPE_INT_64; |
| 138 | pLiteral->value.i64 = i64; |
| 139 | } |
| 140 | } else { |
| 141 | uint64_t u64 = strtoull(textValue, nullptr, 10); |
| 142 | uint32_t u32 = (uint32_t)u64; |
| 143 | if (u64 == (uint64_t)u32) { |
| 144 | pLiteral->type = SPV_LITERAL_TYPE_UINT_32; |
| 145 | pLiteral->value.u32 = u32; |
| 146 | } else { |
| 147 | pLiteral->type = SPV_LITERAL_TYPE_UINT_64; |
| 148 | pLiteral->value.u64 = u64; |
| 149 | } |
| 150 | } |
| 151 | |
| 152 | return SPV_SUCCESS; |
| 153 | } |
| 154 | |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 155 | /// @brief Translate an Opcode operand to binary form |
| 156 | /// |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 157 | /// @param[in] grammar the grammar to use for compilation |
| 158 | /// @param[in, out] context the dynamic compilation info |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 159 | /// @param[in] type of the operand |
| 160 | /// @param[in] textValue word of text to be parsed |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 161 | /// @param[out] pInst return binary Opcode |
| 162 | /// @param[in,out] pExpectedOperands the operand types expected |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 163 | /// |
| 164 | /// @return result code |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 165 | spv_result_t spvTextEncodeOperand(const libspirv::AssemblyGrammar &grammar, |
| 166 | libspirv::AssemblyContext* context, |
| 167 | const spv_operand_type_t type, |
| 168 | const char* textValue, |
| 169 | spv_instruction_t* pInst, |
| 170 | spv_operand_pattern_t* pExpectedOperands) { |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 171 | // NOTE: Handle immediate int in the stream |
| 172 | if ('!' == textValue[0]) { |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 173 | const char* begin = textValue + 1; |
| 174 | char* end = nullptr; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 175 | uint32_t immediateInt = strtoul(begin, &end, 0); |
| 176 | size_t size = strlen(textValue); |
| 177 | size_t length = (end - begin); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 178 | if (size - 1 != length) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 179 | context->diagnostic() << "Invalid immediate integer '" << textValue << "'."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 180 | return SPV_ERROR_INVALID_TEXT; |
| 181 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 182 | context->seekForward(size); |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 183 | pInst->words[pInst->wordCount] = immediateInt; |
| 184 | pInst->wordCount += 1; |
Dejan Mircevski | 897bff9 | 2015-09-29 10:38:18 -0400 | [diff] [blame] | 185 | *pExpectedOperands = |
| 186 | spvAlternatePatternFollowingImmediate(*pExpectedOperands); |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 187 | return SPV_SUCCESS; |
| 188 | } |
| 189 | |
| 190 | switch (type) { |
David Neto | b14a727 | 2015-09-25 13:56:09 -0400 | [diff] [blame] | 191 | case SPV_OPERAND_TYPE_EXECUTION_SCOPE: |
David Neto | e3f70b9 | 2015-08-27 13:50:05 -0400 | [diff] [blame] | 192 | case SPV_OPERAND_TYPE_ID: |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 193 | case SPV_OPERAND_TYPE_ID_IN_OPTIONAL_TUPLE: |
| 194 | case SPV_OPERAND_TYPE_OPTIONAL_ID: |
David Neto | b14a727 | 2015-09-25 13:56:09 -0400 | [diff] [blame] | 195 | case SPV_OPERAND_TYPE_MEMORY_SEMANTICS: |
| 196 | case SPV_OPERAND_TYPE_RESULT_ID: { |
Lei Zhang | abafd5e | 2015-08-21 11:52:29 -0400 | [diff] [blame] | 197 | if ('%' == textValue[0]) { |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 198 | textValue++; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 199 | } else { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 200 | context->diagnostic() << "Expected id to start with %."; |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 201 | return SPV_ERROR_INVALID_TEXT; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 202 | } |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 203 | if (!spvIsValidID(textValue)) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 204 | context->diagnostic() << "Invalid ID " << textValue; |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 205 | return SPV_ERROR_INVALID_TEXT; |
| 206 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 207 | const uint32_t id = context->spvNamedIdAssignOrGet(textValue); |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 208 | pInst->words[pInst->wordCount++] = id; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 209 | } break; |
| 210 | case SPV_OPERAND_TYPE_LITERAL_NUMBER: { |
| 211 | // NOTE: Special case for extension instruction lookup |
| 212 | if (OpExtInst == pInst->opcode) { |
| 213 | spv_ext_inst_desc extInst; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 214 | if (grammar.lookupExtInst(pInst->extInstType, textValue, |
| 215 | &extInst)) { |
| 216 | context->diagnostic() << "Invalid extended instruction name '" |
| 217 | << textValue << "'."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 218 | return SPV_ERROR_INVALID_TEXT; |
| 219 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 220 | pInst->words[pInst->wordCount++] = extInst->ext_inst; |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 221 | |
| 222 | // Prepare to parse the operands for the extended instructions. |
| 223 | spvPrependOperandTypes(extInst->operandTypes, pExpectedOperands); |
| 224 | |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 225 | return SPV_SUCCESS; |
| 226 | } |
Lei Zhang | 6d41581 | 2015-09-15 13:36:21 -0400 | [diff] [blame] | 227 | } // Fall through for the general case. |
Lei Zhang | b41d150 | 2015-09-14 15:22:23 -0400 | [diff] [blame] | 228 | case SPV_OPERAND_TYPE_MULTIWORD_LITERAL_NUMBER: |
David Neto | 561dc4e | 2015-09-25 14:23:29 -0400 | [diff] [blame] | 229 | case SPV_OPERAND_TYPE_LITERAL_NUMBER_IN_OPTIONAL_TUPLE: |
| 230 | case SPV_OPERAND_TYPE_OPTIONAL_LITERAL_NUMBER: { |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 231 | spv_literal_t literal = {}; |
Lei Zhang | 6d41581 | 2015-09-15 13:36:21 -0400 | [diff] [blame] | 232 | spv_result_t error = spvTextToLiteral(textValue, &literal); |
| 233 | if (error != SPV_SUCCESS) { |
| 234 | if (error == SPV_ERROR_OUT_OF_MEMORY) return error; |
| 235 | if (spvOperandIsOptional(type)) return SPV_FAILED_MATCH; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 236 | context->diagnostic() << "Invalid literal number '" << textValue << "'."; |
Lei Zhang | 6d41581 | 2015-09-15 13:36:21 -0400 | [diff] [blame] | 237 | return SPV_ERROR_INVALID_TEXT; |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 238 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 239 | switch (literal.type) { |
Andrew Woloszyn | 4b4acde | 2015-09-10 10:28:22 -0400 | [diff] [blame] | 240 | // We do not have to print diagnostics here because spvBinaryEncode* |
| 241 | // prints diagnostic messages on failure. |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 242 | case SPV_LITERAL_TYPE_INT_32: |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 243 | if (context->binaryEncodeU32(BitwiseCast<uint32_t>(literal.value.i32), |
| 244 | pInst)) |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 245 | return SPV_ERROR_INVALID_TEXT; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 246 | break; |
| 247 | case SPV_LITERAL_TYPE_INT_64: { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 248 | if (context->binaryEncodeU64(BitwiseCast<uint64_t>(literal.value.i64), |
| 249 | pInst)) |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 250 | return SPV_ERROR_INVALID_TEXT; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 251 | } break; |
| 252 | case SPV_LITERAL_TYPE_UINT_32: { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 253 | if (context->binaryEncodeU32(literal.value.u32, pInst)) |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 254 | return SPV_ERROR_INVALID_TEXT; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 255 | } break; |
| 256 | case SPV_LITERAL_TYPE_UINT_64: { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 257 | if (context->binaryEncodeU64(BitwiseCast<uint64_t>(literal.value.u64), |
| 258 | pInst)) |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 259 | return SPV_ERROR_INVALID_TEXT; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 260 | } break; |
| 261 | case SPV_LITERAL_TYPE_FLOAT_32: { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 262 | if (context->binaryEncodeU32(BitwiseCast<uint32_t>(literal.value.f), |
| 263 | pInst)) |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 264 | return SPV_ERROR_INVALID_TEXT; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 265 | } break; |
| 266 | case SPV_LITERAL_TYPE_FLOAT_64: { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 267 | if (context->binaryEncodeU64(BitwiseCast<uint64_t>(literal.value.d), |
| 268 | pInst)) |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 269 | return SPV_ERROR_INVALID_TEXT; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 270 | } break; |
| 271 | case SPV_LITERAL_TYPE_STRING: { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 272 | context->diagnostic() << "Expected literal number, found literal string '" |
| 273 | << textValue << "'."; |
Lei Zhang | 6d41581 | 2015-09-15 13:36:21 -0400 | [diff] [blame] | 274 | return SPV_FAILED_MATCH; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 275 | } break; |
| 276 | default: |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 277 | context->diagnostic() << "Invalid literal number '" << textValue << "'"; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 278 | return SPV_ERROR_INVALID_TEXT; |
| 279 | } |
| 280 | } break; |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 281 | case SPV_OPERAND_TYPE_LITERAL_STRING: |
| 282 | case SPV_OPERAND_TYPE_OPTIONAL_LITERAL_STRING: { |
Lei Zhang | 6d41581 | 2015-09-15 13:36:21 -0400 | [diff] [blame] | 283 | spv_literal_t literal = {}; |
| 284 | spv_result_t error = spvTextToLiteral(textValue, &literal); |
| 285 | if (error != SPV_SUCCESS) { |
| 286 | if (error == SPV_ERROR_OUT_OF_MEMORY) return error; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 287 | if (spvOperandIsOptional(type)) return SPV_FAILED_MATCH; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 288 | context->diagnostic() << "Invalid literal string '" << textValue << "'."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 289 | return SPV_ERROR_INVALID_TEXT; |
| 290 | } |
Lei Zhang | 6d41581 | 2015-09-15 13:36:21 -0400 | [diff] [blame] | 291 | if (literal.type != SPV_LITERAL_TYPE_STRING) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 292 | context->diagnostic() << "Expected literal string, found literal number '" |
| 293 | << textValue << "'."; |
Lei Zhang | 6d41581 | 2015-09-15 13:36:21 -0400 | [diff] [blame] | 294 | return SPV_FAILED_MATCH; |
| 295 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 296 | |
| 297 | // NOTE: Special case for extended instruction library import |
| 298 | if (OpExtInstImport == pInst->opcode) { |
Lei Zhang | 6d41581 | 2015-09-15 13:36:21 -0400 | [diff] [blame] | 299 | pInst->extInstType = spvExtInstImportTypeGet(literal.value.str); |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 300 | } |
| 301 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 302 | if (context->binaryEncodeString(literal.value.str, pInst)) |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 303 | return SPV_ERROR_INVALID_TEXT; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 304 | } break; |
David Neto | 36b0c0f | 2015-09-16 18:32:54 -0400 | [diff] [blame] | 305 | case SPV_OPERAND_TYPE_FP_FAST_MATH_MODE: |
| 306 | case SPV_OPERAND_TYPE_FUNCTION_CONTROL: |
| 307 | case SPV_OPERAND_TYPE_LOOP_CONTROL: |
David Neto | ee1b3bb | 2015-09-18 11:19:18 -0400 | [diff] [blame] | 308 | case SPV_OPERAND_TYPE_OPTIONAL_IMAGE: |
David Neto | 5bf88fc | 2015-09-17 17:06:10 -0400 | [diff] [blame] | 309 | case SPV_OPERAND_TYPE_OPTIONAL_MEMORY_ACCESS: |
David Neto | 36b0c0f | 2015-09-16 18:32:54 -0400 | [diff] [blame] | 310 | case SPV_OPERAND_TYPE_SELECTION_CONTROL: { |
| 311 | uint32_t value; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 312 | if (grammar.parseMaskOperand(type, textValue, &value)) { |
| 313 | context->diagnostic() << "Invalid " << spvOperandTypeStr(type) << " '" |
| 314 | << textValue << "'."; |
David Neto | 36b0c0f | 2015-09-16 18:32:54 -0400 | [diff] [blame] | 315 | return SPV_ERROR_INVALID_TEXT; |
| 316 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 317 | if (auto error = context->binaryEncodeU32(value, pInst)) return error; |
David Neto | 5bf88fc | 2015-09-17 17:06:10 -0400 | [diff] [blame] | 318 | // Prepare to parse the operands for this logical operand. |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 319 | grammar.prependOperandTypesForMask(type, value, pExpectedOperands); |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 320 | } break; |
| 321 | case SPV_OPERAND_TYPE_OPTIONAL_CIV: { |
| 322 | auto error = spvTextEncodeOperand( |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 323 | grammar, context, SPV_OPERAND_TYPE_OPTIONAL_LITERAL_NUMBER, textValue, |
| 324 | pInst, pExpectedOperands); |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 325 | if (error == SPV_FAILED_MATCH) { |
| 326 | // It's not a literal number -- is it a literal string? |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 327 | error = spvTextEncodeOperand(grammar, context, |
| 328 | SPV_OPERAND_TYPE_OPTIONAL_LITERAL_STRING, |
| 329 | textValue, pInst, pExpectedOperands); |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 330 | } |
| 331 | if (error == SPV_FAILED_MATCH) { |
| 332 | // It's not a literal -- is it an ID? |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 333 | error = |
| 334 | spvTextEncodeOperand(grammar, context, SPV_OPERAND_TYPE_OPTIONAL_ID, |
| 335 | textValue, pInst, pExpectedOperands); |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 336 | } |
| 337 | if (error) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 338 | context->diagnostic() << "Invalid word following !<integer>: " << textValue; |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 339 | return error; |
| 340 | } |
| 341 | if (pExpectedOperands->empty()) { |
| 342 | pExpectedOperands->push_back(SPV_OPERAND_TYPE_OPTIONAL_CIV); |
| 343 | } |
David Neto | 36b0c0f | 2015-09-16 18:32:54 -0400 | [diff] [blame] | 344 | } break; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 345 | default: { |
| 346 | // NOTE: All non literal operands are handled here using the operand |
| 347 | // table. |
| 348 | spv_operand_desc entry; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 349 | if (grammar.lookupOperand(type, textValue, strlen(textValue), |
| 350 | &entry)) { |
| 351 | context->diagnostic() << "Invalid " << spvOperandTypeStr(type) << " '" |
| 352 | << textValue << "'."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 353 | return SPV_ERROR_INVALID_TEXT; |
| 354 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 355 | if (context->binaryEncodeU32(entry->value, pInst)) { |
| 356 | context->diagnostic() << "Invalid " << spvOperandTypeStr(type) << " '" |
| 357 | << textValue << "'."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 358 | return SPV_ERROR_INVALID_TEXT; |
| 359 | } |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 360 | |
| 361 | // Prepare to parse the operands for this logical operand. |
| 362 | spvPrependOperandTypes(entry->operandTypes, pExpectedOperands); |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 363 | } break; |
| 364 | } |
| 365 | return SPV_SUCCESS; |
| 366 | } |
| 367 | |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 368 | namespace { |
| 369 | |
| 370 | /// Encodes an instruction started by !<integer> at the given position in text. |
| 371 | /// |
| 372 | /// Puts the encoded words into *pInst. If successful, moves position past the |
| 373 | /// instruction and returns SPV_SUCCESS. Otherwise, returns an error code and |
| 374 | /// leaves position pointing to the error in text. |
| 375 | spv_result_t encodeInstructionStartingWithImmediate( |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 376 | const libspirv::AssemblyGrammar &grammar, |
| 377 | libspirv::AssemblyContext* context, spv_instruction_t* pInst) { |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 378 | std::string firstWord; |
| 379 | spv_position_t nextPosition = {}; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 380 | auto error = context->getWord(firstWord, &nextPosition); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 381 | if (error) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 382 | context->diagnostic() << "Internal Error"; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 383 | return error; |
| 384 | } |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 385 | |
| 386 | assert(firstWord[0] == '!'); |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 387 | const char* begin = firstWord.data() + 1; |
| 388 | char* end = nullptr; |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 389 | uint32_t immediateInt = strtoul(begin, &end, 0); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 390 | if ((begin + firstWord.size() - 1) != end) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 391 | context->diagnostic() << "Invalid immediate integer '" << firstWord << "'."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 392 | return SPV_ERROR_INVALID_TEXT; |
| 393 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 394 | context->seekForward(firstWord.size()); |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 395 | pInst->words[0] = immediateInt; |
| 396 | pInst->wordCount = 1; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 397 | while (context->advance() != SPV_END_OF_STREAM) { |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 398 | // A beginning of a new instruction means we're done. |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 399 | if (context->isStartOfNewInst()) return SPV_SUCCESS; |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 400 | |
| 401 | // Otherwise, there must be an operand that's either a literal, an ID, or |
| 402 | // an immediate. |
| 403 | std::string operandValue; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 404 | if ((error = context->getWord(operandValue, &nextPosition))) { |
| 405 | context->diagnostic() << "Internal Error"; |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 406 | return error; |
| 407 | } |
| 408 | |
Dejan Mircevski | e3a19c0 | 2015-09-11 15:03:54 -0400 | [diff] [blame] | 409 | if (operandValue == "=") { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 410 | context->diagnostic() << firstWord << " not allowed before =."; |
Dejan Mircevski | e3a19c0 | 2015-09-11 15:03:54 -0400 | [diff] [blame] | 411 | return SPV_ERROR_INVALID_TEXT; |
| 412 | } |
| 413 | |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 414 | // Needed to pass to spvTextEncodeOpcode(), but it shouldn't ever be |
| 415 | // expanded. |
| 416 | spv_operand_pattern_t dummyExpectedOperands; |
| 417 | error = spvTextEncodeOperand( |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 418 | grammar, context, SPV_OPERAND_TYPE_OPTIONAL_CIV, operandValue.c_str(), |
| 419 | pInst, &dummyExpectedOperands); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 420 | if (error) return error; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 421 | context->setPosition(nextPosition); |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 422 | } |
| 423 | return SPV_SUCCESS; |
| 424 | } |
| 425 | |
| 426 | } // anonymous namespace |
| 427 | |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 428 | /// @brief Translate single Opcode and operands to binary form |
| 429 | /// |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 430 | /// @param[in] grammar the grammar to use for compilation |
| 431 | /// @param[in, out] context the dynamic compilation info |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 432 | /// @param[in] text stream to translate |
| 433 | /// @param[in] format the assembly syntax format of text |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 434 | /// @param[out] pInst returned binary Opcode |
| 435 | /// @param[in,out] pPosition in the text stream |
Andrew Woloszyn | 13804e5 | 2015-09-22 15:50:33 -0400 | [diff] [blame] | 436 | /// |
| 437 | /// @return result code |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 438 | spv_result_t spvTextEncodeOpcode(const libspirv::AssemblyGrammar &grammar, |
| 439 | libspirv::AssemblyContext* context, |
| 440 | spv_assembly_syntax_format_t format, |
| 441 | spv_instruction_t* pInst) { |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 442 | // Check for !<integer> first. |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 443 | if ('!' == context->peek()) { |
| 444 | return encodeInstructionStartingWithImmediate(grammar, context, pInst); |
Dejan Mircevski | f79519c | 2015-09-11 00:43:11 -0400 | [diff] [blame] | 445 | } |
| 446 | |
Lei Zhang | dfc5008 | 2015-08-21 11:50:55 -0400 | [diff] [blame] | 447 | // An assembly instruction has two possible formats: |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 448 | // 1(CAF): <opcode> <operand>..., e.g., "OpTypeVoid %void". |
| 449 | // 2(AAF): <result-id> = <opcode> <operand>..., e.g., "%void = OpTypeVoid". |
Lei Zhang | dfc5008 | 2015-08-21 11:50:55 -0400 | [diff] [blame] | 450 | |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 451 | std::string firstWord; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 452 | spv_position_t nextPosition = {}; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 453 | spv_result_t error = context->getWord(firstWord, &nextPosition); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 454 | if (error) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 455 | context->diagnostic() << "Internal Error"; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 456 | return error; |
| 457 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 458 | |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 459 | std::string opcodeName; |
Lei Zhang | dfc5008 | 2015-08-21 11:50:55 -0400 | [diff] [blame] | 460 | std::string result_id; |
| 461 | spv_position_t result_id_position = {}; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 462 | if (context->startsWithOp()) { |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 463 | opcodeName = firstWord; |
| 464 | } else { |
| 465 | // If the first word of this instruction is not an opcode, we must be |
| 466 | // processing AAF now. |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 467 | if (SPV_ASSEMBLY_SYNTAX_FORMAT_ASSIGNMENT != format) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 468 | context->diagnostic() |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 469 | << "Expected <opcode> at the beginning of an instruction, found '" |
| 470 | << firstWord << "'."; |
| 471 | return SPV_ERROR_INVALID_TEXT; |
| 472 | } |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 473 | |
| 474 | result_id = firstWord; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 475 | if ('%' != result_id.front()) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 476 | context->diagnostic() << "Expected <opcode> or <result-id> at the beginning " |
| 477 | "of an instruction, found '" |
| 478 | << result_id << "'."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 479 | return SPV_ERROR_INVALID_TEXT; |
| 480 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 481 | result_id_position = context->position(); |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 482 | |
| 483 | // The '=' sign. |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 484 | context->setPosition(nextPosition); |
| 485 | if (context->advance()) { |
| 486 | context->diagnostic() << "Expected '=', found end of stream."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 487 | return SPV_ERROR_INVALID_TEXT; |
| 488 | } |
Lei Zhang | dfc5008 | 2015-08-21 11:50:55 -0400 | [diff] [blame] | 489 | std::string equal_sign; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 490 | error = context->getWord(equal_sign, &nextPosition); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 491 | if ("=" != equal_sign) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 492 | context->diagnostic() << "'=' expected after result id."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 493 | return SPV_ERROR_INVALID_TEXT; |
| 494 | } |
Lei Zhang | dfc5008 | 2015-08-21 11:50:55 -0400 | [diff] [blame] | 495 | |
| 496 | // The <opcode> after the '=' sign. |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 497 | context->setPosition(nextPosition); |
| 498 | if (context->advance()) { |
| 499 | context->diagnostic() << "Expected opcode, found end of stream."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 500 | return SPV_ERROR_INVALID_TEXT; |
| 501 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 502 | error = context->getWord(opcodeName, &nextPosition); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 503 | if (error) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 504 | context->diagnostic() << "Internal Error"; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 505 | return error; |
| 506 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 507 | if (!context->startsWithOp()) { |
| 508 | context->diagnostic() << "Invalid Opcode prefix '" << opcodeName << "'."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 509 | return SPV_ERROR_INVALID_TEXT; |
| 510 | } |
Lei Zhang | dfc5008 | 2015-08-21 11:50:55 -0400 | [diff] [blame] | 511 | } |
| 512 | |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 513 | // NOTE: The table contains Opcode names without the "Op" prefix. |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 514 | const char* pInstName = opcodeName.data() + 2; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 515 | |
| 516 | spv_opcode_desc opcodeEntry; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 517 | error = grammar.lookupOpcode(pInstName, &opcodeEntry); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 518 | if (error) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 519 | context->diagnostic() << "Invalid Opcode name '" << context->getWord() << "'"; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 520 | return error; |
| 521 | } |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 522 | if (SPV_ASSEMBLY_SYNTAX_FORMAT_ASSIGNMENT == format) { |
| 523 | // If this instruction has <result-id>, check it follows AAF. |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 524 | if (opcodeEntry->hasResult && result_id.empty()) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 525 | context->diagnostic() << "Expected <result-id> at the beginning of an " |
| 526 | "instruction, found '" |
| 527 | << firstWord << "'."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 528 | return SPV_ERROR_INVALID_TEXT; |
| 529 | } |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 530 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 531 | pInst->opcode = opcodeEntry->opcode; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 532 | context->setPosition(nextPosition); |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 533 | pInst->wordCount++; |
| 534 | |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 535 | // Maintains the ordered list of expected operand types. |
| 536 | // For many instructions we only need the {numTypes, operandTypes} |
| 537 | // entries in opcodeEntry. However, sometimes we need to modify |
| 538 | // the list as we parse the operands. This occurs when an operand |
| 539 | // has its own logical operands (such as the LocalSize operand for |
| 540 | // ExecutionMode), or for extended instructions that may have their |
| 541 | // own operands depending on the selected extended instruction. |
| 542 | spv_operand_pattern_t expectedOperands( |
| 543 | opcodeEntry->operandTypes, |
| 544 | opcodeEntry->operandTypes + opcodeEntry->numTypes); |
Lei Zhang | dfc5008 | 2015-08-21 11:50:55 -0400 | [diff] [blame] | 545 | |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 546 | while (!expectedOperands.empty()) { |
| 547 | const spv_operand_type_t type = expectedOperands.front(); |
| 548 | expectedOperands.pop_front(); |
| 549 | |
| 550 | // Expand optional tuples lazily. |
Lei Zhang | e78a7c1 | 2015-09-10 17:07:21 -0400 | [diff] [blame] | 551 | if (spvExpandOperandSequenceOnce(type, &expectedOperands)) continue; |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 552 | |
| 553 | if (type == SPV_OPERAND_TYPE_RESULT_ID && !result_id.empty()) { |
| 554 | // Handle the <result-id> for value generating instructions. |
| 555 | // We've already consumed it from the text stream. Here |
| 556 | // we inject its words into the instruction. |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 557 | spv_position_t temp_pos = context->position(); |
| 558 | error = spvTextEncodeOperand(grammar, context, SPV_OPERAND_TYPE_RESULT_ID, |
| 559 | result_id.c_str(), pInst, nullptr); |
| 560 | result_id_position = context->position(); |
| 561 | // Because we are injecting we have to reset the position afterwards. |
| 562 | context->setPosition(temp_pos); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 563 | if (error) return error; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 564 | } else { |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 565 | // Find the next word. |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 566 | error = context->advance(); |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 567 | if (error == SPV_END_OF_STREAM) { |
| 568 | if (spvOperandIsOptional(type)) { |
Lei Zhang | e78a7c1 | 2015-09-10 17:07:21 -0400 | [diff] [blame] | 569 | // This would have been the last potential operand for the |
| 570 | // instruction, |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 571 | // and we didn't find one. We're finished parsing this instruction. |
| 572 | break; |
| 573 | } else { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 574 | context->diagnostic() << "Expected operand, found end of stream."; |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 575 | return SPV_ERROR_INVALID_TEXT; |
| 576 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 577 | } |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 578 | assert(error == SPV_SUCCESS && "Somebody added another way to fail"); |
| 579 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 580 | if (context->isStartOfNewInst()) { |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 581 | if (spvOperandIsOptional(type)) { |
| 582 | break; |
| 583 | } else { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 584 | context->diagnostic() |
| 585 | << "Expected operand, found next instruction instead."; |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 586 | return SPV_ERROR_INVALID_TEXT; |
| 587 | } |
| 588 | } |
| 589 | |
| 590 | std::string operandValue; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 591 | error = context->getWord(operandValue, &nextPosition); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 592 | if (error) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 593 | context->diagnostic() << "Internal Error"; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 594 | return error; |
| 595 | } |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 596 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 597 | error = spvTextEncodeOperand(grammar, context, type, operandValue.c_str(), |
| 598 | pInst, &expectedOperands); |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 599 | |
| 600 | if (error == SPV_FAILED_MATCH && spvOperandIsOptional(type)) |
| 601 | return SPV_SUCCESS; |
| 602 | |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 603 | if (error) return error; |
David Neto | 78c3b43 | 2015-08-27 13:03:52 -0400 | [diff] [blame] | 604 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 605 | context->setPosition(nextPosition); |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 606 | } |
| 607 | } |
| 608 | |
| 609 | pInst->words[0] = spvOpcodeMake(pInst->wordCount, opcodeEntry->opcode); |
| 610 | |
| 611 | return SPV_SUCCESS; |
| 612 | } |
| 613 | |
David Neto | c978643 | 2015-09-01 18:05:14 -0400 | [diff] [blame] | 614 | namespace { |
| 615 | |
| 616 | // Translates a given assembly language module into binary form. |
| 617 | // If a diagnostic is generated, it is not yet marked as being |
| 618 | // for a text-based input. |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 619 | spv_result_t spvTextToBinaryInternal( |
| 620 | const libspirv::AssemblyGrammar &grammar, const spv_text text, |
| 621 | spv_assembly_syntax_format_t format, spv_binary* pBinary, |
| 622 | spv_diagnostic* pDiagnostic) { |
| 623 | if (!pDiagnostic) return SPV_ERROR_INVALID_DIAGNOSTIC; |
| 624 | libspirv::AssemblyContext context(text, pDiagnostic); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 625 | if (!text->str || !text->length) { |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 626 | context.diagnostic() << "Text stream is empty."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 627 | return SPV_ERROR_INVALID_TEXT; |
| 628 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 629 | if (!grammar.isValid()) { |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 630 | return SPV_ERROR_INVALID_TABLE; |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 631 | } |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 632 | if (!pBinary) return SPV_ERROR_INVALID_POINTER; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 633 | |
| 634 | // NOTE: Ensure diagnostic is zero initialised |
| 635 | *pDiagnostic = {}; |
| 636 | |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 637 | std::vector<spv_instruction_t> instructions; |
| 638 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 639 | if (context.advance()) { |
| 640 | context.diagnostic() << "Text stream is empty."; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 641 | return SPV_ERROR_INVALID_TEXT; |
| 642 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 643 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 644 | spv_ext_inst_type_t extInstType = SPV_EXT_INST_TYPE_NONE; |
| 645 | while (context.hasText()) { |
| 646 | spv_instruction_t inst = {}; |
| 647 | inst.extInstType = extInstType; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 648 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 649 | if (spvTextEncodeOpcode(grammar, &context, format, &inst)) { |
| 650 | return SPV_ERROR_INVALID_TEXT; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 651 | } |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 652 | extInstType = inst.extInstType; |
| 653 | |
| 654 | instructions.push_back(inst); |
| 655 | |
| 656 | if (context.advance()) break; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 657 | } |
| 658 | |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 659 | size_t totalSize = SPV_INDEX_INSTRUCTION; |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 660 | for (auto& inst : instructions) { |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 661 | totalSize += inst.wordCount; |
| 662 | } |
| 663 | |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 664 | uint32_t* data = new uint32_t[totalSize]; |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 665 | if (!data) return SPV_ERROR_OUT_OF_MEMORY; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 666 | uint64_t currentIndex = SPV_INDEX_INSTRUCTION; |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 667 | for (auto& inst : instructions) { |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 668 | memcpy(data + currentIndex, inst.words, sizeof(uint32_t) * inst.wordCount); |
| 669 | currentIndex += inst.wordCount; |
| 670 | } |
| 671 | |
| 672 | spv_binary binary = new spv_binary_t(); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 673 | if (!binary) { |
| 674 | delete[] data; |
| 675 | return SPV_ERROR_OUT_OF_MEMORY; |
| 676 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 677 | binary->code = data; |
| 678 | binary->wordCount = totalSize; |
| 679 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 680 | spv_result_t error = spvBinaryHeaderSet(binary, context.getBound()); |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 681 | if (error) { |
| 682 | spvBinaryDestroy(binary); |
| 683 | return error; |
| 684 | } |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 685 | |
| 686 | *pBinary = binary; |
| 687 | |
| 688 | return SPV_SUCCESS; |
| 689 | } |
| 690 | |
Lei Zhang | e78a7c1 | 2015-09-10 17:07:21 -0400 | [diff] [blame] | 691 | } // anonymous namespace |
David Neto | c978643 | 2015-09-01 18:05:14 -0400 | [diff] [blame] | 692 | |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 693 | spv_result_t spvTextToBinary(const char* input_text, |
Andrew Woloszyn | cfeac48 | 2015-09-09 13:04:32 -0400 | [diff] [blame] | 694 | const uint64_t input_text_size, |
David Neto | c978643 | 2015-09-01 18:05:14 -0400 | [diff] [blame] | 695 | const spv_opcode_table opcodeTable, |
| 696 | const spv_operand_table operandTable, |
| 697 | const spv_ext_inst_table extInstTable, |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 698 | spv_binary* pBinary, spv_diagnostic* pDiagnostic) { |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 699 | return spvTextWithFormatToBinary( |
| 700 | input_text, input_text_size, SPV_ASSEMBLY_SYNTAX_FORMAT_DEFAULT, |
| 701 | opcodeTable, operandTable, extInstTable, pBinary, pDiagnostic); |
| 702 | } |
| 703 | |
| 704 | spv_result_t spvTextWithFormatToBinary( |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 705 | const char* input_text, const uint64_t input_text_size, |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 706 | spv_assembly_syntax_format_t format, const spv_opcode_table opcodeTable, |
| 707 | const spv_operand_table operandTable, const spv_ext_inst_table extInstTable, |
Dejan Mircevski | 903f9d6 | 2015-09-28 17:04:39 -0400 | [diff] [blame] | 708 | spv_binary* pBinary, spv_diagnostic* pDiagnostic) { |
Andrew Woloszyn | cfeac48 | 2015-09-09 13:04:32 -0400 | [diff] [blame] | 709 | spv_text_t text = {input_text, input_text_size}; |
| 710 | |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 711 | libspirv::AssemblyGrammar grammar(operandTable, opcodeTable, |
| 712 | extInstTable); |
Lei Zhang | 06efdc5 | 2015-09-10 14:00:00 -0400 | [diff] [blame] | 713 | spv_result_t result = |
Andrew Woloszyn | 71fc055 | 2015-09-24 10:26:51 -0400 | [diff] [blame] | 714 | spvTextToBinaryInternal(grammar, &text, format, pBinary, pDiagnostic); |
David Neto | c978643 | 2015-09-01 18:05:14 -0400 | [diff] [blame] | 715 | if (pDiagnostic && *pDiagnostic) (*pDiagnostic)->isTextSource = true; |
| 716 | |
| 717 | return result; |
| 718 | } |
| 719 | |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 720 | void spvTextDestroy(spv_text text) { |
Lei Zhang | 4005670 | 2015-09-11 14:31:27 -0400 | [diff] [blame] | 721 | if (!text) return; |
Kenneth Benzie (Benie) | 83e5a29 | 2015-05-22 18:26:19 +0100 | [diff] [blame] | 722 | if (text->str) { |
| 723 | delete[] text->str; |
| 724 | } |
| 725 | delete text; |
| 726 | } |