1//===- MILexer.cpp - Machine instructions lexer implementation ------------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This file implements the lexing of machine instructions.
10//
11//===----------------------------------------------------------------------===//
12
13#include "MILexer.h"
14#include "llvm/ADT/StringExtras.h"
15#include "llvm/ADT/StringSwitch.h"
16#include "llvm/ADT/Twine.h"
17#include <cassert>
18#include <cctype>
19#include <string>
20
21using namespace llvm;
22
23namespace {
24
25using ErrorCallbackType =
26 function_ref<void(StringRef::iterator Loc, const Twine &)>;
27
28/// This class provides a way to iterate and get characters from the source
29/// string.
30class Cursor {
31 const char *Ptr = nullptr;
32 const char *End = nullptr;
33
34public:
35 Cursor(std::nullopt_t) {}
36
37 explicit Cursor(StringRef Str) {
38 Ptr = Str.data();
39 End = Ptr + Str.size();
40 }
41
42 bool isEOF() const { return Ptr == End; }
43
44 char peek(int I = 0) const { return End - Ptr <= I ? 0 : Ptr[I]; }
45
46 void advance(unsigned I = 1) { Ptr += I; }
47
48 StringRef remaining() const { return StringRef(Ptr, End - Ptr); }
49
50 StringRef upto(Cursor C) const {
51 assert(C.Ptr >= Ptr && C.Ptr <= End);
52 return StringRef(Ptr, C.Ptr - Ptr);
53 }
54
55 StringRef::iterator location() const { return Ptr; }
56
57 operator bool() const { return Ptr != nullptr; }
58};
59
60} // end anonymous namespace
61
62MIToken &MIToken::reset(TokenKind Kind, StringRef Range) {
63 this->Kind = Kind;
64 this->Range = Range;
65 return *this;
66}
67
68MIToken &MIToken::setStringValue(StringRef StrVal) {
69 StringValue = StrVal;
70 return *this;
71}
72
73MIToken &MIToken::setOwnedStringValue(std::string StrVal) {
74 StringValueStorage = std::move(StrVal);
75 StringValue = StringValueStorage;
76 return *this;
77}
78
79MIToken &MIToken::setIntegerValue(APSInt IntVal) {
80 this->IntVal = std::move(IntVal);
81 return *this;
82}
83
84/// Skip the leading whitespace characters and return the updated cursor.
85static Cursor skipWhitespace(Cursor C) {
86 while (isblank(C.peek()))
87 C.advance();
88 return C;
89}
90
91static bool isNewlineChar(char C) { return C == '\n' || C == '\r'; }
92
93/// Skip a line comment and return the updated cursor.
94static Cursor skipComment(Cursor C) {
95 if (C.peek() != ';')
96 return C;
97 while (!isNewlineChar(C: C.peek()) && !C.isEOF())
98 C.advance();
99 return C;
100}
101
102/// Machine operands can have comments, enclosed between /* and */.
103/// This eats up all tokens, including /* and */.
104static Cursor skipMachineOperandComment(Cursor C) {
105 if (C.peek() != '/' || C.peek(I: 1) != '*')
106 return C;
107
108 while (C.peek() != '*' || C.peek(I: 1) != '/')
109 C.advance();
110
111 C.advance();
112 C.advance();
113 return C;
114}
115
116/// Return true if the given character satisfies the following regular
117/// expression: [-a-zA-Z$._0-9]
118static bool isIdentifierChar(char C) {
119 return isalpha(C) || isdigit(C) || C == '_' || C == '-' || C == '.' ||
120 C == '$';
121}
122
123/// Unescapes the given string value.
124///
125/// Expects the string value to be quoted.
126static std::string unescapeQuotedString(StringRef Value) {
127 assert(Value.front() == '"' && Value.back() == '"');
128 Cursor C = Cursor(Value.substr(Start: 1, N: Value.size() - 2));
129
130 std::string Str;
131 Str.reserve(res_arg: C.remaining().size());
132 while (!C.isEOF()) {
133 char Char = C.peek();
134 if (Char == '\\') {
135 if (C.peek(I: 1) == '\\') {
136 // Two '\' become one
137 Str += '\\';
138 C.advance(I: 2);
139 continue;
140 }
141 if (isxdigit(C.peek(I: 1)) && isxdigit(C.peek(I: 2))) {
142 Str += hexDigitValue(C: C.peek(I: 1)) * 16 + hexDigitValue(C: C.peek(I: 2));
143 C.advance(I: 3);
144 continue;
145 }
146 }
147 Str += Char;
148 C.advance();
149 }
150 return Str;
151}
152
153/// Lex a string constant using the following regular expression: \"[^\"]*\"
154static Cursor lexStringConstant(Cursor C, ErrorCallbackType ErrorCallback) {
155 assert(C.peek() == '"');
156 for (C.advance(); C.peek() != '"'; C.advance()) {
157 if (C.isEOF() || isNewlineChar(C: C.peek())) {
158 ErrorCallback(
159 C.location(),
160 "end of machine instruction reached before the closing '\"'");
161 return std::nullopt;
162 }
163 }
164 C.advance();
165 return C;
166}
167
168static Cursor lexName(Cursor C, MIToken &Token, MIToken::TokenKind Type,
169 unsigned PrefixLength, ErrorCallbackType ErrorCallback) {
170 auto Range = C;
171 C.advance(I: PrefixLength);
172 if (C.peek() == '"') {
173 if (Cursor R = lexStringConstant(C, ErrorCallback)) {
174 StringRef String = Range.upto(C: R);
175 Token.reset(Kind: Type, Range: String)
176 .setOwnedStringValue(
177 unescapeQuotedString(Value: String.drop_front(N: PrefixLength)));
178 return R;
179 }
180 Token.reset(Kind: MIToken::Error, Range: Range.remaining());
181 return Range;
182 }
183 while (isIdentifierChar(C: C.peek()))
184 C.advance();
185 Token.reset(Kind: Type, Range: Range.upto(C))
186 .setStringValue(Range.upto(C).drop_front(N: PrefixLength));
187 return C;
188}
189
190static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
191 return StringSwitch<MIToken::TokenKind>(Identifier)
192 .Case(S: "_", Value: MIToken::underscore)
193 .Case(S: "implicit", Value: MIToken::kw_implicit)
194 .Case(S: "implicit-def", Value: MIToken::kw_implicit_define)
195 .Case(S: "def", Value: MIToken::kw_def)
196 .Case(S: "dead", Value: MIToken::kw_dead)
197 .Case(S: "killed", Value: MIToken::kw_killed)
198 .Case(S: "undef", Value: MIToken::kw_undef)
199 .Case(S: "internal", Value: MIToken::kw_internal)
200 .Case(S: "early-clobber", Value: MIToken::kw_early_clobber)
201 .Case(S: "debug-use", Value: MIToken::kw_debug_use)
202 .Case(S: "renamable", Value: MIToken::kw_renamable)
203 .Case(S: "tied-def", Value: MIToken::kw_tied_def)
204 .Case(S: "frame-setup", Value: MIToken::kw_frame_setup)
205 .Case(S: "frame-destroy", Value: MIToken::kw_frame_destroy)
206 .Case(S: "nnan", Value: MIToken::kw_nnan)
207 .Case(S: "ninf", Value: MIToken::kw_ninf)
208 .Case(S: "nsz", Value: MIToken::kw_nsz)
209 .Case(S: "arcp", Value: MIToken::kw_arcp)
210 .Case(S: "contract", Value: MIToken::kw_contract)
211 .Case(S: "afn", Value: MIToken::kw_afn)
212 .Case(S: "reassoc", Value: MIToken::kw_reassoc)
213 .Case(S: "nuw", Value: MIToken::kw_nuw)
214 .Case(S: "nsw", Value: MIToken::kw_nsw)
215 .Case(S: "nusw", Value: MIToken::kw_nusw)
216 .Case(S: "exact", Value: MIToken::kw_exact)
217 .Case(S: "nneg", Value: MIToken::kw_nneg)
218 .Case(S: "disjoint", Value: MIToken::kw_disjoint)
219 .Case(S: "samesign", Value: MIToken::kw_samesign)
220 .Case(S: "inbounds", Value: MIToken::kw_inbounds)
221 .Case(S: "nonnull", Value: MIToken::kw_nonnull)
222 .Case(S: "nofpexcept", Value: MIToken::kw_nofpexcept)
223 .Case(S: "unpredictable", Value: MIToken::kw_unpredictable)
224 .Case(S: "debug-location", Value: MIToken::kw_debug_location)
225 .Case(S: "debug-instr-number", Value: MIToken::kw_debug_instr_number)
226 .Case(S: "dbg-instr-ref", Value: MIToken::kw_dbg_instr_ref)
227 .Case(S: "same_value", Value: MIToken::kw_cfi_same_value)
228 .Case(S: "offset", Value: MIToken::kw_cfi_offset)
229 .Case(S: "rel_offset", Value: MIToken::kw_cfi_rel_offset)
230 .Case(S: "def_cfa_register", Value: MIToken::kw_cfi_def_cfa_register)
231 .Case(S: "def_cfa_offset", Value: MIToken::kw_cfi_def_cfa_offset)
232 .Case(S: "adjust_cfa_offset", Value: MIToken::kw_cfi_adjust_cfa_offset)
233 .Case(S: "escape", Value: MIToken::kw_cfi_escape)
234 .Case(S: "def_cfa", Value: MIToken::kw_cfi_def_cfa)
235 .Case(S: "llvm_def_aspace_cfa", Value: MIToken::kw_cfi_llvm_def_aspace_cfa)
236 .Case(S: "remember_state", Value: MIToken::kw_cfi_remember_state)
237 .Case(S: "restore", Value: MIToken::kw_cfi_restore)
238 .Case(S: "restore_state", Value: MIToken::kw_cfi_restore_state)
239 .Case(S: "undefined", Value: MIToken::kw_cfi_undefined)
240 .Case(S: "register", Value: MIToken::kw_cfi_register)
241 .Case(S: "window_save", Value: MIToken::kw_cfi_window_save)
242 .Case(S: "negate_ra_sign_state",
243 Value: MIToken::kw_cfi_aarch64_negate_ra_sign_state)
244 .Case(S: "negate_ra_sign_state_with_pc",
245 Value: MIToken::kw_cfi_aarch64_negate_ra_sign_state_with_pc)
246 .Case(S: "llvm_set_ra_state", Value: MIToken::kw_cfi_set_ra_state)
247 .Case(S: "llvm_register_pair", Value: MIToken::kw_cfi_llvm_register_pair)
248 .Case(S: "llvm_vector_registers", Value: MIToken::kw_cfi_llvm_vector_registers)
249 .Case(S: "llvm_vector_offset", Value: MIToken::kw_cfi_llvm_vector_offset)
250 .Case(S: "llvm_vector_register_mask",
251 Value: MIToken::kw_cfi_llvm_vector_register_mask)
252 .Case(S: "blockaddress", Value: MIToken::kw_blockaddress)
253 .Case(S: "intrinsic", Value: MIToken::kw_intrinsic)
254 .Case(S: "target-index", Value: MIToken::kw_target_index)
255 .Case(S: "half", Value: MIToken::kw_half)
256 .Case(S: "bfloat", Value: MIToken::kw_bfloat)
257 .Case(S: "float", Value: MIToken::kw_float)
258 .Case(S: "double", Value: MIToken::kw_double)
259 .Case(S: "x86_fp80", Value: MIToken::kw_x86_fp80)
260 .Case(S: "fp128", Value: MIToken::kw_fp128)
261 .Case(S: "ppc_fp128", Value: MIToken::kw_ppc_fp128)
262 .Case(S: "target-flags", Value: MIToken::kw_target_flags)
263 .Case(S: "volatile", Value: MIToken::kw_volatile)
264 .Case(S: "non-temporal", Value: MIToken::kw_non_temporal)
265 .Case(S: "dereferenceable", Value: MIToken::kw_dereferenceable)
266 .Case(S: "invariant", Value: MIToken::kw_invariant)
267 .Case(S: "align", Value: MIToken::kw_align)
268 .Case(S: "basealign", Value: MIToken::kw_basealign)
269 .Case(S: "addrspace", Value: MIToken::kw_addrspace)
270 .Case(S: "stack", Value: MIToken::kw_stack)
271 .Case(S: "got", Value: MIToken::kw_got)
272 .Case(S: "jump-table", Value: MIToken::kw_jump_table)
273 .Case(S: "constant-pool", Value: MIToken::kw_constant_pool)
274 .Case(S: "call-entry", Value: MIToken::kw_call_entry)
275 .Case(S: "custom", Value: MIToken::kw_custom)
276 .Case(S: "lanemask", Value: MIToken::kw_lanemask)
277 .Case(S: "liveout", Value: MIToken::kw_liveout)
278 .Case(S: "landing-pad", Value: MIToken::kw_landing_pad)
279 .Case(S: "inlineasm-br-indirect-target",
280 Value: MIToken::kw_inlineasm_br_indirect_target)
281 .Case(S: "ehscope-entry", Value: MIToken::kw_ehscope_entry)
282 .Case(S: "ehfunclet-entry", Value: MIToken::kw_ehfunclet_entry)
283 .Case(S: "cleanup-funclet-entry", Value: MIToken::kw_cleanup_funclet_entry)
284 .Case(S: "ehcont-target", Value: MIToken::kw_ehcont_target)
285 .Case(S: "liveins", Value: MIToken::kw_liveins)
286 .Case(S: "successors", Value: MIToken::kw_successors)
287 .Case(S: "floatpred", Value: MIToken::kw_floatpred)
288 .Case(S: "intpred", Value: MIToken::kw_intpred)
289 .Case(S: "shufflemask", Value: MIToken::kw_shufflemask)
290 .Case(S: "pre-instr-symbol", Value: MIToken::kw_pre_instr_symbol)
291 .Case(S: "post-instr-symbol", Value: MIToken::kw_post_instr_symbol)
292 .Case(S: "heap-alloc-marker", Value: MIToken::kw_heap_alloc_marker)
293 .Case(S: "pcsections", Value: MIToken::kw_pcsections)
294 .Case(S: "cfi-type", Value: MIToken::kw_cfi_type)
295 .Case(S: "deactivation-symbol", Value: MIToken::kw_deactivation_symbol)
296 .Case(S: "bbsections", Value: MIToken::kw_bbsections)
297 .Case(S: "bb_id", Value: MIToken::kw_bb_id)
298 .Case(S: "unknown-size", Value: MIToken::kw_unknown_size)
299 .Case(S: "unknown-address", Value: MIToken::kw_unknown_address)
300 .Case(S: "distinct", Value: MIToken::kw_distinct)
301 .Case(S: "ir-block-address-taken", Value: MIToken::kw_ir_block_address_taken)
302 .Case(S: "machine-block-address-taken",
303 Value: MIToken::kw_machine_block_address_taken)
304 .Case(S: "label-must-be-emitted", Value: MIToken::kw_label_must_be_emitted)
305 .Case(S: "call-frame-size", Value: MIToken::kw_call_frame_size)
306 .Case(S: "max-bytes-for-alignment", Value: MIToken::kw_max_bytes_for_alignment)
307 .Case(S: "noconvergent", Value: MIToken::kw_noconvergent)
308 .Case(S: "mmra", Value: MIToken::kw_mmra)
309 .Case(S: "lr-split", Value: MIToken::kw_lr_split)
310 .Default(Value: MIToken::Identifier);
311}
312
313static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
314 if (!isalpha(C.peek()) && C.peek() != '_')
315 return std::nullopt;
316 auto Range = C;
317 while (isIdentifierChar(C: C.peek()))
318 C.advance();
319 auto Identifier = Range.upto(C);
320 Token.reset(Kind: getIdentifierKind(Identifier), Range: Identifier)
321 .setStringValue(Identifier);
322 return C;
323}
324
325static Cursor maybeLexMachineBasicBlock(Cursor C, MIToken &Token,
326 ErrorCallbackType ErrorCallback) {
327 bool IsReference = C.remaining().starts_with(Prefix: "%bb.");
328 if (!IsReference && !C.remaining().starts_with(Prefix: "bb."))
329 return std::nullopt;
330 auto Range = C;
331 unsigned PrefixLength = IsReference ? 4 : 3;
332 C.advance(I: PrefixLength); // Skip '%bb.' or 'bb.'
333 if (!isdigit(C.peek())) {
334 Token.reset(Kind: MIToken::Error, Range: C.remaining());
335 ErrorCallback(C.location(), "expected a number after '%bb.'");
336 return C;
337 }
338 auto NumberRange = C;
339 while (isdigit(C.peek()))
340 C.advance();
341 StringRef Number = NumberRange.upto(C);
342 unsigned StringOffset = PrefixLength + Number.size(); // Drop '%bb.<id>'
343 // TODO: The format bb.<id>.<irname> is supported only when it's not a
344 // reference. Once we deprecate the format where the irname shows up, we
345 // should only lex forward if it is a reference.
346 if (C.peek() == '.') {
347 C.advance(); // Skip '.'
348 ++StringOffset;
349 // The name is quoted if it is not a plain identifier.
350 if (C.peek() == '"') {
351 Cursor R = lexStringConstant(C, ErrorCallback);
352 if (!R) {
353 ErrorCallback(C.location(),
354 "unable to parse quoted string from opening quote");
355 Token.reset(Kind: MIToken::Error, Range: Range.remaining());
356 return Range;
357 }
358 MIToken::TokenKind Kind = IsReference ? MIToken::MachineBasicBlock
359 : MIToken::MachineBasicBlockLabel;
360 Token.reset(Kind, Range: Range.upto(C: R))
361 .setIntegerValue(APSInt(Number))
362 .setOwnedStringValue(
363 unescapeQuotedString(Value: Range.upto(C: R).drop_front(N: StringOffset)));
364 return R;
365 }
366 while (isIdentifierChar(C: C.peek()))
367 C.advance();
368 }
369 Token.reset(Kind: IsReference ? MIToken::MachineBasicBlock
370 : MIToken::MachineBasicBlockLabel,
371 Range: Range.upto(C))
372 .setIntegerValue(APSInt(Number))
373 .setStringValue(Range.upto(C).drop_front(N: StringOffset));
374 return C;
375}
376
377static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
378 MIToken::TokenKind Kind) {
379 if (!C.remaining().starts_with(Prefix: Rule) || !isdigit(C.peek(I: Rule.size())))
380 return std::nullopt;
381 auto Range = C;
382 C.advance(I: Rule.size());
383 auto NumberRange = C;
384 while (isdigit(C.peek()))
385 C.advance();
386 Token.reset(Kind, Range: Range.upto(C)).setIntegerValue(APSInt(NumberRange.upto(C)));
387 return C;
388}
389
390static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
391 MIToken::TokenKind Kind) {
392 if (!C.remaining().starts_with(Prefix: Rule) || !isdigit(C.peek(I: Rule.size())))
393 return std::nullopt;
394 auto Range = C;
395 C.advance(I: Rule.size());
396 auto NumberRange = C;
397 while (isdigit(C.peek()))
398 C.advance();
399 StringRef Number = NumberRange.upto(C);
400 unsigned StringOffset = Rule.size() + Number.size();
401 if (C.peek() == '.') {
402 C.advance();
403 ++StringOffset;
404 while (isIdentifierChar(C: C.peek()))
405 C.advance();
406 }
407 Token.reset(Kind, Range: Range.upto(C))
408 .setIntegerValue(APSInt(Number))
409 .setStringValue(Range.upto(C).drop_front(N: StringOffset));
410 return C;
411}
412
413static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
414 return maybeLexIndex(C, Token, Rule: "%jump-table.", Kind: MIToken::JumpTableIndex);
415}
416
417static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
418 return maybeLexIndexAndName(C, Token, Rule: "%stack.", Kind: MIToken::StackObject);
419}
420
421static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
422 return maybeLexIndex(C, Token, Rule: "%fixed-stack.", Kind: MIToken::FixedStackObject);
423}
424
425static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
426 return maybeLexIndex(C, Token, Rule: "%const.", Kind: MIToken::ConstantPoolItem);
427}
428
429static Cursor maybeLexSubRegisterIndex(Cursor C, MIToken &Token,
430 ErrorCallbackType ErrorCallback) {
431 const StringRef Rule = "%subreg.";
432 if (!C.remaining().starts_with(Prefix: Rule))
433 return std::nullopt;
434 return lexName(C, Token, Type: MIToken::SubRegisterIndex, PrefixLength: Rule.size(),
435 ErrorCallback);
436}
437
438static Cursor maybeLexIRBlock(Cursor C, MIToken &Token,
439 ErrorCallbackType ErrorCallback) {
440 const StringRef Rule = "%ir-block.";
441 if (!C.remaining().starts_with(Prefix: Rule))
442 return std::nullopt;
443 if (isdigit(C.peek(I: Rule.size())))
444 return maybeLexIndex(C, Token, Rule, Kind: MIToken::IRBlock);
445 return lexName(C, Token, Type: MIToken::NamedIRBlock, PrefixLength: Rule.size(), ErrorCallback);
446}
447
448static Cursor maybeLexIRValue(Cursor C, MIToken &Token,
449 ErrorCallbackType ErrorCallback) {
450 const StringRef Rule = "%ir.";
451 if (!C.remaining().starts_with(Prefix: Rule))
452 return std::nullopt;
453 if (isdigit(C.peek(I: Rule.size())))
454 return maybeLexIndex(C, Token, Rule, Kind: MIToken::IRValue);
455 return lexName(C, Token, Type: MIToken::NamedIRValue, PrefixLength: Rule.size(), ErrorCallback);
456}
457
458static Cursor maybeLexStringConstant(Cursor C, MIToken &Token,
459 ErrorCallbackType ErrorCallback) {
460 if (C.peek() != '"')
461 return std::nullopt;
462 return lexName(C, Token, Type: MIToken::StringConstant, /*PrefixLength=*/0,
463 ErrorCallback);
464}
465
466static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
467 auto Range = C;
468 C.advance(); // Skip '%'
469 auto NumberRange = C;
470 while (isdigit(C.peek()))
471 C.advance();
472 Token.reset(Kind: MIToken::VirtualRegister, Range: Range.upto(C))
473 .setIntegerValue(APSInt(NumberRange.upto(C)));
474 return C;
475}
476
477/// Returns true for a character allowed in a register name.
478static bool isRegisterChar(char C) {
479 return isIdentifierChar(C) && C != '.';
480}
481
482static Cursor lexNamedVirtualRegister(Cursor C, MIToken &Token) {
483 Cursor Range = C;
484 C.advance(); // Skip '%'
485 while (isRegisterChar(C: C.peek()))
486 C.advance();
487 Token.reset(Kind: MIToken::NamedVirtualRegister, Range: Range.upto(C))
488 .setStringValue(Range.upto(C).drop_front(N: 1)); // Drop the '%'
489 return C;
490}
491
492static Cursor maybeLexRegister(Cursor C, MIToken &Token,
493 ErrorCallbackType ErrorCallback) {
494 if (C.peek() != '%' && C.peek() != '$')
495 return std::nullopt;
496
497 if (C.peek() == '%') {
498 if (isdigit(C.peek(I: 1)))
499 return lexVirtualRegister(C, Token);
500
501 if (isRegisterChar(C: C.peek(I: 1)))
502 return lexNamedVirtualRegister(C, Token);
503
504 return std::nullopt;
505 }
506
507 assert(C.peek() == '$');
508 auto Range = C;
509 C.advance(); // Skip '$'
510 while (isRegisterChar(C: C.peek()))
511 C.advance();
512 Token.reset(Kind: MIToken::NamedRegister, Range: Range.upto(C))
513 .setStringValue(Range.upto(C).drop_front(N: 1)); // Drop the '$'
514 return C;
515}
516
517static Cursor maybeLexGlobalValue(Cursor C, MIToken &Token,
518 ErrorCallbackType ErrorCallback) {
519 if (C.peek() != '@')
520 return std::nullopt;
521 if (!isdigit(C.peek(I: 1)))
522 return lexName(C, Token, Type: MIToken::NamedGlobalValue, /*PrefixLength=*/1,
523 ErrorCallback);
524 auto Range = C;
525 C.advance(I: 1); // Skip the '@'
526 auto NumberRange = C;
527 while (isdigit(C.peek()))
528 C.advance();
529 Token.reset(Kind: MIToken::GlobalValue, Range: Range.upto(C))
530 .setIntegerValue(APSInt(NumberRange.upto(C)));
531 return C;
532}
533
534static Cursor maybeLexExternalSymbol(Cursor C, MIToken &Token,
535 ErrorCallbackType ErrorCallback) {
536 if (C.peek() != '&')
537 return std::nullopt;
538 return lexName(C, Token, Type: MIToken::ExternalSymbol, /*PrefixLength=*/1,
539 ErrorCallback);
540}
541
542static Cursor maybeLexMCSymbol(Cursor C, MIToken &Token,
543 ErrorCallbackType ErrorCallback) {
544 const StringRef Rule = "<mcsymbol ";
545 if (!C.remaining().starts_with(Prefix: Rule))
546 return std::nullopt;
547 auto Start = C;
548 C.advance(I: Rule.size());
549
550 // Try a simple unquoted name.
551 if (C.peek() != '"') {
552 while (isIdentifierChar(C: C.peek()))
553 C.advance();
554 StringRef String = Start.upto(C).drop_front(N: Rule.size());
555 if (C.peek() != '>') {
556 ErrorCallback(C.location(),
557 "expected the '<mcsymbol ...' to be closed by a '>'");
558 Token.reset(Kind: MIToken::Error, Range: Start.remaining());
559 return Start;
560 }
561 C.advance();
562
563 Token.reset(Kind: MIToken::MCSymbol, Range: Start.upto(C)).setStringValue(String);
564 return C;
565 }
566
567 // Otherwise lex out a quoted name.
568 Cursor R = lexStringConstant(C, ErrorCallback);
569 if (!R) {
570 ErrorCallback(C.location(),
571 "unable to parse quoted string from opening quote");
572 Token.reset(Kind: MIToken::Error, Range: Start.remaining());
573 return Start;
574 }
575 StringRef String = Start.upto(C: R).drop_front(N: Rule.size());
576 if (R.peek() != '>') {
577 ErrorCallback(R.location(),
578 "expected the '<mcsymbol ...' to be closed by a '>'");
579 Token.reset(Kind: MIToken::Error, Range: Start.remaining());
580 return Start;
581 }
582 R.advance();
583
584 Token.reset(Kind: MIToken::MCSymbol, Range: Start.upto(C: R))
585 .setOwnedStringValue(unescapeQuotedString(Value: String));
586 return R;
587}
588
589static bool isValidHexFloatingPointPrefix(char C) {
590 return C == 'H' || C == 'K' || C == 'L' || C == 'M' || C == 'R';
591}
592
593static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
594 C.advance();
595 // Skip over [0-9]*([eE][-+]?[0-9]+)?
596 while (isdigit(C.peek()))
597 C.advance();
598 if ((C.peek() == 'e' || C.peek() == 'E') &&
599 (isdigit(C.peek(I: 1)) ||
600 ((C.peek(I: 1) == '-' || C.peek(I: 1) == '+') && isdigit(C.peek(I: 2))))) {
601 C.advance(I: 2);
602 while (isdigit(C.peek()))
603 C.advance();
604 }
605 Token.reset(Kind: MIToken::FloatingPointLiteral, Range: Range.upto(C));
606 return C;
607}
608
609static Cursor maybeLexHexadecimalLiteral(Cursor C, MIToken &Token) {
610 if (C.peek() != '0' || (C.peek(I: 1) != 'x' && C.peek(I: 1) != 'X'))
611 return std::nullopt;
612 Cursor Range = C;
613 C.advance(I: 2);
614 unsigned PrefLen = 2;
615 if (isValidHexFloatingPointPrefix(C: C.peek())) {
616 C.advance();
617 PrefLen++;
618 }
619 while (isxdigit(C.peek()))
620 C.advance();
621 StringRef StrVal = Range.upto(C);
622 if (StrVal.size() <= PrefLen)
623 return std::nullopt;
624 if (PrefLen == 2)
625 Token.reset(Kind: MIToken::HexLiteral, Range: Range.upto(C));
626 else // It must be 3, which means that there was a floating-point prefix.
627 Token.reset(Kind: MIToken::FloatingPointLiteral, Range: Range.upto(C));
628 return C;
629}
630
631static Cursor maybeLexFloatHexBits(Cursor C, MIToken &Token) {
632 if (C.peek() != 'f')
633 return std::nullopt;
634 if (C.peek(I: 1) != '0' || (C.peek(I: 2) != 'x' && C.peek(I: 2) != 'X'))
635 return std::nullopt;
636 Cursor Range = C;
637 C.advance(I: 3);
638 while (isxdigit(C.peek()))
639 C.advance();
640 StringRef StrVal = Range.upto(C);
641 if (StrVal.size() <= 3)
642 return std::nullopt;
643 Token.reset(Kind: MIToken::FloatingPointLiteral, Range: Range.upto(C));
644 return C;
645}
646
647static Cursor maybeLexInfinityLiteral(Cursor C, MIToken &Token) {
648 if ((C.peek() != '+' && C.peek() != '-') || C.peek(I: 1) != 'i' ||
649 C.peek(I: 2) != 'n' || C.peek(I: 3) != 'f' || isIdentifierChar(C: C.peek(I: 4)))
650 return std::nullopt;
651
652 Cursor Range = C;
653 C.advance(I: 4);
654 Token.reset(Kind: MIToken::FloatingPointLiteral, Range: Range.upto(C));
655 return C;
656}
657
658static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
659 if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(I: 1))))
660 return std::nullopt;
661 auto Range = C;
662 C.advance();
663 while (isdigit(C.peek()))
664 C.advance();
665 if (C.peek() == '.')
666 return lexFloatingPointLiteral(Range, C, Token);
667 StringRef StrVal = Range.upto(C);
668 Token.reset(Kind: MIToken::IntegerLiteral, Range: StrVal).setIntegerValue(APSInt(StrVal));
669 return C;
670}
671
672static MIToken::TokenKind getMetadataKeywordKind(StringRef Identifier) {
673 return StringSwitch<MIToken::TokenKind>(Identifier)
674 .Case(S: "!tbaa", Value: MIToken::md_tbaa)
675 .Case(S: "!alias.scope", Value: MIToken::md_alias_scope)
676 .Case(S: "!noalias", Value: MIToken::md_noalias)
677 .Case(S: "!range", Value: MIToken::md_range)
678 .Case(S: "!mem.cache_hint", Value: MIToken::md_mem_cache_hint)
679 .Case(S: "!DIExpression", Value: MIToken::md_diexpr)
680 .Case(S: "!DILocation", Value: MIToken::md_dilocation)
681 .Case(S: "!noalias.addrspace", Value: MIToken::md_noalias_addrspace)
682 .Default(Value: MIToken::Error);
683}
684
685static Cursor maybeLexExclaim(Cursor C, MIToken &Token,
686 ErrorCallbackType ErrorCallback) {
687 if (C.peek() != '!')
688 return std::nullopt;
689 auto Range = C;
690 C.advance(I: 1);
691 if (isdigit(C.peek()) || !isIdentifierChar(C: C.peek())) {
692 Token.reset(Kind: MIToken::exclaim, Range: Range.upto(C));
693 return C;
694 }
695 while (isIdentifierChar(C: C.peek()))
696 C.advance();
697 StringRef StrVal = Range.upto(C);
698 Token.reset(Kind: getMetadataKeywordKind(Identifier: StrVal), Range: StrVal);
699 if (Token.isError())
700 ErrorCallback(Token.location(),
701 "use of unknown metadata keyword '" + StrVal + "'");
702 return C;
703}
704
705static MIToken::TokenKind symbolToken(char C) {
706 switch (C) {
707 case ',':
708 return MIToken::comma;
709 case '.':
710 return MIToken::dot;
711 case '=':
712 return MIToken::equal;
713 case ':':
714 return MIToken::colon;
715 case '(':
716 return MIToken::lparen;
717 case ')':
718 return MIToken::rparen;
719 case '{':
720 return MIToken::lbrace;
721 case '}':
722 return MIToken::rbrace;
723 case '+':
724 return MIToken::plus;
725 case '-':
726 return MIToken::minus;
727 case '<':
728 return MIToken::less;
729 case '>':
730 return MIToken::greater;
731 default:
732 return MIToken::Error;
733 }
734}
735
736static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
737 MIToken::TokenKind Kind;
738 unsigned Length = 1;
739 if (C.peek() == ':' && C.peek(I: 1) == ':') {
740 Kind = MIToken::coloncolon;
741 Length = 2;
742 } else
743 Kind = symbolToken(C: C.peek());
744 if (Kind == MIToken::Error)
745 return std::nullopt;
746 auto Range = C;
747 C.advance(I: Length);
748 Token.reset(Kind, Range: Range.upto(C));
749 return C;
750}
751
752static Cursor maybeLexNewline(Cursor C, MIToken &Token) {
753 if (!isNewlineChar(C: C.peek()))
754 return std::nullopt;
755 auto Range = C;
756 C.advance();
757 Token.reset(Kind: MIToken::Newline, Range: Range.upto(C));
758 return C;
759}
760
761static Cursor maybeLexEscapedIRValue(Cursor C, MIToken &Token,
762 ErrorCallbackType ErrorCallback) {
763 if (C.peek() != '`')
764 return std::nullopt;
765 auto Range = C;
766 C.advance();
767 auto StrRange = C;
768 while (C.peek() != '`') {
769 if (C.isEOF() || isNewlineChar(C: C.peek())) {
770 ErrorCallback(
771 C.location(),
772 "end of machine instruction reached before the closing '`'");
773 Token.reset(Kind: MIToken::Error, Range: Range.remaining());
774 return C;
775 }
776 C.advance();
777 }
778 StringRef Value = StrRange.upto(C);
779 C.advance();
780 Token.reset(Kind: MIToken::QuotedIRValue, Range: Range.upto(C)).setStringValue(Value);
781 return C;
782}
783
784StringRef llvm::lexMIToken(StringRef Source, MIToken &Token,
785 ErrorCallbackType ErrorCallback) {
786 auto C = skipComment(C: skipWhitespace(C: Cursor(Source)));
787 if (C.isEOF()) {
788 Token.reset(Kind: MIToken::Eof, Range: C.remaining());
789 return C.remaining();
790 }
791
792 C = skipWhitespace(C: skipMachineOperandComment(C));
793
794 if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
795 return R.remaining();
796 if (Cursor R = maybeLexFloatHexBits(C, Token))
797 return R.remaining();
798 if (Cursor R = maybeLexInfinityLiteral(C, Token))
799 return R.remaining();
800 if (Cursor R = maybeLexIdentifier(C, Token))
801 return R.remaining();
802 if (Cursor R = maybeLexJumpTableIndex(C, Token))
803 return R.remaining();
804 if (Cursor R = maybeLexStackObject(C, Token))
805 return R.remaining();
806 if (Cursor R = maybeLexFixedStackObject(C, Token))
807 return R.remaining();
808 if (Cursor R = maybeLexConstantPoolItem(C, Token))
809 return R.remaining();
810 if (Cursor R = maybeLexSubRegisterIndex(C, Token, ErrorCallback))
811 return R.remaining();
812 if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
813 return R.remaining();
814 if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
815 return R.remaining();
816 if (Cursor R = maybeLexRegister(C, Token, ErrorCallback))
817 return R.remaining();
818 if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
819 return R.remaining();
820 if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
821 return R.remaining();
822 if (Cursor R = maybeLexMCSymbol(C, Token, ErrorCallback))
823 return R.remaining();
824 if (Cursor R = maybeLexHexadecimalLiteral(C, Token))
825 return R.remaining();
826 if (Cursor R = maybeLexNumericalLiteral(C, Token))
827 return R.remaining();
828 if (Cursor R = maybeLexExclaim(C, Token, ErrorCallback))
829 return R.remaining();
830 if (Cursor R = maybeLexSymbol(C, Token))
831 return R.remaining();
832 if (Cursor R = maybeLexNewline(C, Token))
833 return R.remaining();
834 if (Cursor R = maybeLexEscapedIRValue(C, Token, ErrorCallback))
835 return R.remaining();
836 if (Cursor R = maybeLexStringConstant(C, Token, ErrorCallback))
837 return R.remaining();
838
839 Token.reset(Kind: MIToken::Error, Range: C.remaining());
840 ErrorCallback(C.location(),
841 Twine("unexpected character '") + Twine(C.peek()) + "'");
842 return C.remaining();
843}
844