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: "nofpexcept", Value: MIToken::kw_nofpexcept)
222 .Case(S: "unpredictable", Value: MIToken::kw_unpredictable)
223 .Case(S: "debug-location", Value: MIToken::kw_debug_location)
224 .Case(S: "debug-instr-number", Value: MIToken::kw_debug_instr_number)
225 .Case(S: "dbg-instr-ref", Value: MIToken::kw_dbg_instr_ref)
226 .Case(S: "same_value", Value: MIToken::kw_cfi_same_value)
227 .Case(S: "offset", Value: MIToken::kw_cfi_offset)
228 .Case(S: "rel_offset", Value: MIToken::kw_cfi_rel_offset)
229 .Case(S: "def_cfa_register", Value: MIToken::kw_cfi_def_cfa_register)
230 .Case(S: "def_cfa_offset", Value: MIToken::kw_cfi_def_cfa_offset)
231 .Case(S: "adjust_cfa_offset", Value: MIToken::kw_cfi_adjust_cfa_offset)
232 .Case(S: "escape", Value: MIToken::kw_cfi_escape)
233 .Case(S: "def_cfa", Value: MIToken::kw_cfi_def_cfa)
234 .Case(S: "llvm_def_aspace_cfa", Value: MIToken::kw_cfi_llvm_def_aspace_cfa)
235 .Case(S: "remember_state", Value: MIToken::kw_cfi_remember_state)
236 .Case(S: "restore", Value: MIToken::kw_cfi_restore)
237 .Case(S: "restore_state", Value: MIToken::kw_cfi_restore_state)
238 .Case(S: "undefined", Value: MIToken::kw_cfi_undefined)
239 .Case(S: "register", Value: MIToken::kw_cfi_register)
240 .Case(S: "window_save", Value: MIToken::kw_cfi_window_save)
241 .Case(S: "negate_ra_sign_state",
242 Value: MIToken::kw_cfi_aarch64_negate_ra_sign_state)
243 .Case(S: "negate_ra_sign_state_with_pc",
244 Value: MIToken::kw_cfi_aarch64_negate_ra_sign_state_with_pc)
245 .Case(S: "blockaddress", Value: MIToken::kw_blockaddress)
246 .Case(S: "intrinsic", Value: MIToken::kw_intrinsic)
247 .Case(S: "target-index", Value: MIToken::kw_target_index)
248 .Case(S: "half", Value: MIToken::kw_half)
249 .Case(S: "bfloat", Value: MIToken::kw_bfloat)
250 .Case(S: "float", Value: MIToken::kw_float)
251 .Case(S: "double", Value: MIToken::kw_double)
252 .Case(S: "x86_fp80", Value: MIToken::kw_x86_fp80)
253 .Case(S: "fp128", Value: MIToken::kw_fp128)
254 .Case(S: "ppc_fp128", Value: MIToken::kw_ppc_fp128)
255 .Case(S: "target-flags", Value: MIToken::kw_target_flags)
256 .Case(S: "volatile", Value: MIToken::kw_volatile)
257 .Case(S: "non-temporal", Value: MIToken::kw_non_temporal)
258 .Case(S: "dereferenceable", Value: MIToken::kw_dereferenceable)
259 .Case(S: "invariant", Value: MIToken::kw_invariant)
260 .Case(S: "align", Value: MIToken::kw_align)
261 .Case(S: "basealign", Value: MIToken::kw_basealign)
262 .Case(S: "addrspace", Value: MIToken::kw_addrspace)
263 .Case(S: "stack", Value: MIToken::kw_stack)
264 .Case(S: "got", Value: MIToken::kw_got)
265 .Case(S: "jump-table", Value: MIToken::kw_jump_table)
266 .Case(S: "constant-pool", Value: MIToken::kw_constant_pool)
267 .Case(S: "call-entry", Value: MIToken::kw_call_entry)
268 .Case(S: "custom", Value: MIToken::kw_custom)
269 .Case(S: "lanemask", Value: MIToken::kw_lanemask)
270 .Case(S: "liveout", Value: MIToken::kw_liveout)
271 .Case(S: "landing-pad", Value: MIToken::kw_landing_pad)
272 .Case(S: "inlineasm-br-indirect-target",
273 Value: MIToken::kw_inlineasm_br_indirect_target)
274 .Case(S: "ehscope-entry", Value: MIToken::kw_ehscope_entry)
275 .Case(S: "ehfunclet-entry", Value: MIToken::kw_ehfunclet_entry)
276 .Case(S: "liveins", Value: MIToken::kw_liveins)
277 .Case(S: "successors", Value: MIToken::kw_successors)
278 .Case(S: "floatpred", Value: MIToken::kw_floatpred)
279 .Case(S: "intpred", Value: MIToken::kw_intpred)
280 .Case(S: "shufflemask", Value: MIToken::kw_shufflemask)
281 .Case(S: "pre-instr-symbol", Value: MIToken::kw_pre_instr_symbol)
282 .Case(S: "post-instr-symbol", Value: MIToken::kw_post_instr_symbol)
283 .Case(S: "heap-alloc-marker", Value: MIToken::kw_heap_alloc_marker)
284 .Case(S: "pcsections", Value: MIToken::kw_pcsections)
285 .Case(S: "cfi-type", Value: MIToken::kw_cfi_type)
286 .Case(S: "deactivation-symbol", Value: MIToken::kw_deactivation_symbol)
287 .Case(S: "bbsections", Value: MIToken::kw_bbsections)
288 .Case(S: "bb_id", Value: MIToken::kw_bb_id)
289 .Case(S: "unknown-size", Value: MIToken::kw_unknown_size)
290 .Case(S: "unknown-address", Value: MIToken::kw_unknown_address)
291 .Case(S: "distinct", Value: MIToken::kw_distinct)
292 .Case(S: "ir-block-address-taken", Value: MIToken::kw_ir_block_address_taken)
293 .Case(S: "machine-block-address-taken",
294 Value: MIToken::kw_machine_block_address_taken)
295 .Case(S: "call-frame-size", Value: MIToken::kw_call_frame_size)
296 .Case(S: "noconvergent", Value: MIToken::kw_noconvergent)
297 .Case(S: "mmra", Value: MIToken::kw_mmra)
298 .Default(Value: MIToken::Identifier);
299}
300
301static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
302 if (!isalpha(C.peek()) && C.peek() != '_')
303 return std::nullopt;
304 auto Range = C;
305 while (isIdentifierChar(C: C.peek()))
306 C.advance();
307 auto Identifier = Range.upto(C);
308 Token.reset(Kind: getIdentifierKind(Identifier), Range: Identifier)
309 .setStringValue(Identifier);
310 return C;
311}
312
313static Cursor maybeLexMachineBasicBlock(Cursor C, MIToken &Token,
314 ErrorCallbackType ErrorCallback) {
315 bool IsReference = C.remaining().starts_with(Prefix: "%bb.");
316 if (!IsReference && !C.remaining().starts_with(Prefix: "bb."))
317 return std::nullopt;
318 auto Range = C;
319 unsigned PrefixLength = IsReference ? 4 : 3;
320 C.advance(I: PrefixLength); // Skip '%bb.' or 'bb.'
321 if (!isdigit(C.peek())) {
322 Token.reset(Kind: MIToken::Error, Range: C.remaining());
323 ErrorCallback(C.location(), "expected a number after '%bb.'");
324 return C;
325 }
326 auto NumberRange = C;
327 while (isdigit(C.peek()))
328 C.advance();
329 StringRef Number = NumberRange.upto(C);
330 unsigned StringOffset = PrefixLength + Number.size(); // Drop '%bb.<id>'
331 // TODO: The format bb.<id>.<irname> is supported only when it's not a
332 // reference. Once we deprecate the format where the irname shows up, we
333 // should only lex forward if it is a reference.
334 if (C.peek() == '.') {
335 C.advance(); // Skip '.'
336 ++StringOffset;
337 while (isIdentifierChar(C: C.peek()))
338 C.advance();
339 }
340 Token.reset(Kind: IsReference ? MIToken::MachineBasicBlock
341 : MIToken::MachineBasicBlockLabel,
342 Range: Range.upto(C))
343 .setIntegerValue(APSInt(Number))
344 .setStringValue(Range.upto(C).drop_front(N: StringOffset));
345 return C;
346}
347
348static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
349 MIToken::TokenKind Kind) {
350 if (!C.remaining().starts_with(Prefix: Rule) || !isdigit(C.peek(I: Rule.size())))
351 return std::nullopt;
352 auto Range = C;
353 C.advance(I: Rule.size());
354 auto NumberRange = C;
355 while (isdigit(C.peek()))
356 C.advance();
357 Token.reset(Kind, Range: Range.upto(C)).setIntegerValue(APSInt(NumberRange.upto(C)));
358 return C;
359}
360
361static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
362 MIToken::TokenKind Kind) {
363 if (!C.remaining().starts_with(Prefix: Rule) || !isdigit(C.peek(I: Rule.size())))
364 return std::nullopt;
365 auto Range = C;
366 C.advance(I: Rule.size());
367 auto NumberRange = C;
368 while (isdigit(C.peek()))
369 C.advance();
370 StringRef Number = NumberRange.upto(C);
371 unsigned StringOffset = Rule.size() + Number.size();
372 if (C.peek() == '.') {
373 C.advance();
374 ++StringOffset;
375 while (isIdentifierChar(C: C.peek()))
376 C.advance();
377 }
378 Token.reset(Kind, Range: Range.upto(C))
379 .setIntegerValue(APSInt(Number))
380 .setStringValue(Range.upto(C).drop_front(N: StringOffset));
381 return C;
382}
383
384static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
385 return maybeLexIndex(C, Token, Rule: "%jump-table.", Kind: MIToken::JumpTableIndex);
386}
387
388static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
389 return maybeLexIndexAndName(C, Token, Rule: "%stack.", Kind: MIToken::StackObject);
390}
391
392static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
393 return maybeLexIndex(C, Token, Rule: "%fixed-stack.", Kind: MIToken::FixedStackObject);
394}
395
396static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
397 return maybeLexIndex(C, Token, Rule: "%const.", Kind: MIToken::ConstantPoolItem);
398}
399
400static Cursor maybeLexSubRegisterIndex(Cursor C, MIToken &Token,
401 ErrorCallbackType ErrorCallback) {
402 const StringRef Rule = "%subreg.";
403 if (!C.remaining().starts_with(Prefix: Rule))
404 return std::nullopt;
405 return lexName(C, Token, Type: MIToken::SubRegisterIndex, PrefixLength: Rule.size(),
406 ErrorCallback);
407}
408
409static Cursor maybeLexIRBlock(Cursor C, MIToken &Token,
410 ErrorCallbackType ErrorCallback) {
411 const StringRef Rule = "%ir-block.";
412 if (!C.remaining().starts_with(Prefix: Rule))
413 return std::nullopt;
414 if (isdigit(C.peek(I: Rule.size())))
415 return maybeLexIndex(C, Token, Rule, Kind: MIToken::IRBlock);
416 return lexName(C, Token, Type: MIToken::NamedIRBlock, PrefixLength: Rule.size(), ErrorCallback);
417}
418
419static Cursor maybeLexIRValue(Cursor C, MIToken &Token,
420 ErrorCallbackType ErrorCallback) {
421 const StringRef Rule = "%ir.";
422 if (!C.remaining().starts_with(Prefix: Rule))
423 return std::nullopt;
424 if (isdigit(C.peek(I: Rule.size())))
425 return maybeLexIndex(C, Token, Rule, Kind: MIToken::IRValue);
426 return lexName(C, Token, Type: MIToken::NamedIRValue, PrefixLength: Rule.size(), ErrorCallback);
427}
428
429static Cursor maybeLexStringConstant(Cursor C, MIToken &Token,
430 ErrorCallbackType ErrorCallback) {
431 if (C.peek() != '"')
432 return std::nullopt;
433 return lexName(C, Token, Type: MIToken::StringConstant, /*PrefixLength=*/0,
434 ErrorCallback);
435}
436
437static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
438 auto Range = C;
439 C.advance(); // Skip '%'
440 auto NumberRange = C;
441 while (isdigit(C.peek()))
442 C.advance();
443 Token.reset(Kind: MIToken::VirtualRegister, Range: Range.upto(C))
444 .setIntegerValue(APSInt(NumberRange.upto(C)));
445 return C;
446}
447
448/// Returns true for a character allowed in a register name.
449static bool isRegisterChar(char C) {
450 return isIdentifierChar(C) && C != '.';
451}
452
453static Cursor lexNamedVirtualRegister(Cursor C, MIToken &Token) {
454 Cursor Range = C;
455 C.advance(); // Skip '%'
456 while (isRegisterChar(C: C.peek()))
457 C.advance();
458 Token.reset(Kind: MIToken::NamedVirtualRegister, Range: Range.upto(C))
459 .setStringValue(Range.upto(C).drop_front(N: 1)); // Drop the '%'
460 return C;
461}
462
463static Cursor maybeLexRegister(Cursor C, MIToken &Token,
464 ErrorCallbackType ErrorCallback) {
465 if (C.peek() != '%' && C.peek() != '$')
466 return std::nullopt;
467
468 if (C.peek() == '%') {
469 if (isdigit(C.peek(I: 1)))
470 return lexVirtualRegister(C, Token);
471
472 if (isRegisterChar(C: C.peek(I: 1)))
473 return lexNamedVirtualRegister(C, Token);
474
475 return std::nullopt;
476 }
477
478 assert(C.peek() == '$');
479 auto Range = C;
480 C.advance(); // Skip '$'
481 while (isRegisterChar(C: C.peek()))
482 C.advance();
483 Token.reset(Kind: MIToken::NamedRegister, Range: Range.upto(C))
484 .setStringValue(Range.upto(C).drop_front(N: 1)); // Drop the '$'
485 return C;
486}
487
488static Cursor maybeLexGlobalValue(Cursor C, MIToken &Token,
489 ErrorCallbackType ErrorCallback) {
490 if (C.peek() != '@')
491 return std::nullopt;
492 if (!isdigit(C.peek(I: 1)))
493 return lexName(C, Token, Type: MIToken::NamedGlobalValue, /*PrefixLength=*/1,
494 ErrorCallback);
495 auto Range = C;
496 C.advance(I: 1); // Skip the '@'
497 auto NumberRange = C;
498 while (isdigit(C.peek()))
499 C.advance();
500 Token.reset(Kind: MIToken::GlobalValue, Range: Range.upto(C))
501 .setIntegerValue(APSInt(NumberRange.upto(C)));
502 return C;
503}
504
505static Cursor maybeLexExternalSymbol(Cursor C, MIToken &Token,
506 ErrorCallbackType ErrorCallback) {
507 if (C.peek() != '&')
508 return std::nullopt;
509 return lexName(C, Token, Type: MIToken::ExternalSymbol, /*PrefixLength=*/1,
510 ErrorCallback);
511}
512
513static Cursor maybeLexMCSymbol(Cursor C, MIToken &Token,
514 ErrorCallbackType ErrorCallback) {
515 const StringRef Rule = "<mcsymbol ";
516 if (!C.remaining().starts_with(Prefix: Rule))
517 return std::nullopt;
518 auto Start = C;
519 C.advance(I: Rule.size());
520
521 // Try a simple unquoted name.
522 if (C.peek() != '"') {
523 while (isIdentifierChar(C: C.peek()))
524 C.advance();
525 StringRef String = Start.upto(C).drop_front(N: Rule.size());
526 if (C.peek() != '>') {
527 ErrorCallback(C.location(),
528 "expected the '<mcsymbol ...' to be closed by a '>'");
529 Token.reset(Kind: MIToken::Error, Range: Start.remaining());
530 return Start;
531 }
532 C.advance();
533
534 Token.reset(Kind: MIToken::MCSymbol, Range: Start.upto(C)).setStringValue(String);
535 return C;
536 }
537
538 // Otherwise lex out a quoted name.
539 Cursor R = lexStringConstant(C, ErrorCallback);
540 if (!R) {
541 ErrorCallback(C.location(),
542 "unable to parse quoted string from opening quote");
543 Token.reset(Kind: MIToken::Error, Range: Start.remaining());
544 return Start;
545 }
546 StringRef String = Start.upto(C: R).drop_front(N: Rule.size());
547 if (R.peek() != '>') {
548 ErrorCallback(R.location(),
549 "expected the '<mcsymbol ...' to be closed by a '>'");
550 Token.reset(Kind: MIToken::Error, Range: Start.remaining());
551 return Start;
552 }
553 R.advance();
554
555 Token.reset(Kind: MIToken::MCSymbol, Range: Start.upto(C: R))
556 .setOwnedStringValue(unescapeQuotedString(Value: String));
557 return R;
558}
559
560static bool isValidHexFloatingPointPrefix(char C) {
561 return C == 'H' || C == 'K' || C == 'L' || C == 'M' || C == 'R';
562}
563
564static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
565 C.advance();
566 // Skip over [0-9]*([eE][-+]?[0-9]+)?
567 while (isdigit(C.peek()))
568 C.advance();
569 if ((C.peek() == 'e' || C.peek() == 'E') &&
570 (isdigit(C.peek(I: 1)) ||
571 ((C.peek(I: 1) == '-' || C.peek(I: 1) == '+') && isdigit(C.peek(I: 2))))) {
572 C.advance(I: 2);
573 while (isdigit(C.peek()))
574 C.advance();
575 }
576 Token.reset(Kind: MIToken::FloatingPointLiteral, Range: Range.upto(C));
577 return C;
578}
579
580static Cursor maybeLexHexadecimalLiteral(Cursor C, MIToken &Token) {
581 if (C.peek() != '0' || (C.peek(I: 1) != 'x' && C.peek(I: 1) != 'X'))
582 return std::nullopt;
583 Cursor Range = C;
584 C.advance(I: 2);
585 unsigned PrefLen = 2;
586 if (isValidHexFloatingPointPrefix(C: C.peek())) {
587 C.advance();
588 PrefLen++;
589 }
590 while (isxdigit(C.peek()))
591 C.advance();
592 StringRef StrVal = Range.upto(C);
593 if (StrVal.size() <= PrefLen)
594 return std::nullopt;
595 if (PrefLen == 2)
596 Token.reset(Kind: MIToken::HexLiteral, Range: Range.upto(C));
597 else // It must be 3, which means that there was a floating-point prefix.
598 Token.reset(Kind: MIToken::FloatingPointLiteral, Range: Range.upto(C));
599 return C;
600}
601
602static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
603 if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(I: 1))))
604 return std::nullopt;
605 auto Range = C;
606 C.advance();
607 while (isdigit(C.peek()))
608 C.advance();
609 if (C.peek() == '.')
610 return lexFloatingPointLiteral(Range, C, Token);
611 StringRef StrVal = Range.upto(C);
612 Token.reset(Kind: MIToken::IntegerLiteral, Range: StrVal).setIntegerValue(APSInt(StrVal));
613 return C;
614}
615
616static MIToken::TokenKind getMetadataKeywordKind(StringRef Identifier) {
617 return StringSwitch<MIToken::TokenKind>(Identifier)
618 .Case(S: "!tbaa", Value: MIToken::md_tbaa)
619 .Case(S: "!alias.scope", Value: MIToken::md_alias_scope)
620 .Case(S: "!noalias", Value: MIToken::md_noalias)
621 .Case(S: "!range", Value: MIToken::md_range)
622 .Case(S: "!DIExpression", Value: MIToken::md_diexpr)
623 .Case(S: "!DILocation", Value: MIToken::md_dilocation)
624 .Case(S: "!noalias.addrspace", Value: MIToken::md_noalias_addrspace)
625 .Default(Value: MIToken::Error);
626}
627
628static Cursor maybeLexExclaim(Cursor C, MIToken &Token,
629 ErrorCallbackType ErrorCallback) {
630 if (C.peek() != '!')
631 return std::nullopt;
632 auto Range = C;
633 C.advance(I: 1);
634 if (isdigit(C.peek()) || !isIdentifierChar(C: C.peek())) {
635 Token.reset(Kind: MIToken::exclaim, Range: Range.upto(C));
636 return C;
637 }
638 while (isIdentifierChar(C: C.peek()))
639 C.advance();
640 StringRef StrVal = Range.upto(C);
641 Token.reset(Kind: getMetadataKeywordKind(Identifier: StrVal), Range: StrVal);
642 if (Token.isError())
643 ErrorCallback(Token.location(),
644 "use of unknown metadata keyword '" + StrVal + "'");
645 return C;
646}
647
648static MIToken::TokenKind symbolToken(char C) {
649 switch (C) {
650 case ',':
651 return MIToken::comma;
652 case '.':
653 return MIToken::dot;
654 case '=':
655 return MIToken::equal;
656 case ':':
657 return MIToken::colon;
658 case '(':
659 return MIToken::lparen;
660 case ')':
661 return MIToken::rparen;
662 case '{':
663 return MIToken::lbrace;
664 case '}':
665 return MIToken::rbrace;
666 case '+':
667 return MIToken::plus;
668 case '-':
669 return MIToken::minus;
670 case '<':
671 return MIToken::less;
672 case '>':
673 return MIToken::greater;
674 default:
675 return MIToken::Error;
676 }
677}
678
679static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
680 MIToken::TokenKind Kind;
681 unsigned Length = 1;
682 if (C.peek() == ':' && C.peek(I: 1) == ':') {
683 Kind = MIToken::coloncolon;
684 Length = 2;
685 } else
686 Kind = symbolToken(C: C.peek());
687 if (Kind == MIToken::Error)
688 return std::nullopt;
689 auto Range = C;
690 C.advance(I: Length);
691 Token.reset(Kind, Range: Range.upto(C));
692 return C;
693}
694
695static Cursor maybeLexNewline(Cursor C, MIToken &Token) {
696 if (!isNewlineChar(C: C.peek()))
697 return std::nullopt;
698 auto Range = C;
699 C.advance();
700 Token.reset(Kind: MIToken::Newline, Range: Range.upto(C));
701 return C;
702}
703
704static Cursor maybeLexEscapedIRValue(Cursor C, MIToken &Token,
705 ErrorCallbackType ErrorCallback) {
706 if (C.peek() != '`')
707 return std::nullopt;
708 auto Range = C;
709 C.advance();
710 auto StrRange = C;
711 while (C.peek() != '`') {
712 if (C.isEOF() || isNewlineChar(C: C.peek())) {
713 ErrorCallback(
714 C.location(),
715 "end of machine instruction reached before the closing '`'");
716 Token.reset(Kind: MIToken::Error, Range: Range.remaining());
717 return C;
718 }
719 C.advance();
720 }
721 StringRef Value = StrRange.upto(C);
722 C.advance();
723 Token.reset(Kind: MIToken::QuotedIRValue, Range: Range.upto(C)).setStringValue(Value);
724 return C;
725}
726
727StringRef llvm::lexMIToken(StringRef Source, MIToken &Token,
728 ErrorCallbackType ErrorCallback) {
729 auto C = skipComment(C: skipWhitespace(C: Cursor(Source)));
730 if (C.isEOF()) {
731 Token.reset(Kind: MIToken::Eof, Range: C.remaining());
732 return C.remaining();
733 }
734
735 C = skipWhitespace(C: skipMachineOperandComment(C));
736
737 if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
738 return R.remaining();
739 if (Cursor R = maybeLexIdentifier(C, Token))
740 return R.remaining();
741 if (Cursor R = maybeLexJumpTableIndex(C, Token))
742 return R.remaining();
743 if (Cursor R = maybeLexStackObject(C, Token))
744 return R.remaining();
745 if (Cursor R = maybeLexFixedStackObject(C, Token))
746 return R.remaining();
747 if (Cursor R = maybeLexConstantPoolItem(C, Token))
748 return R.remaining();
749 if (Cursor R = maybeLexSubRegisterIndex(C, Token, ErrorCallback))
750 return R.remaining();
751 if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
752 return R.remaining();
753 if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
754 return R.remaining();
755 if (Cursor R = maybeLexRegister(C, Token, ErrorCallback))
756 return R.remaining();
757 if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
758 return R.remaining();
759 if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
760 return R.remaining();
761 if (Cursor R = maybeLexMCSymbol(C, Token, ErrorCallback))
762 return R.remaining();
763 if (Cursor R = maybeLexHexadecimalLiteral(C, Token))
764 return R.remaining();
765 if (Cursor R = maybeLexNumericalLiteral(C, Token))
766 return R.remaining();
767 if (Cursor R = maybeLexExclaim(C, Token, ErrorCallback))
768 return R.remaining();
769 if (Cursor R = maybeLexSymbol(C, Token))
770 return R.remaining();
771 if (Cursor R = maybeLexNewline(C, Token))
772 return R.remaining();
773 if (Cursor R = maybeLexEscapedIRValue(C, Token, ErrorCallback))
774 return R.remaining();
775 if (Cursor R = maybeLexStringConstant(C, Token, ErrorCallback))
776 return R.remaining();
777
778 Token.reset(Kind: MIToken::Error, Range: C.remaining());
779 ErrorCallback(C.location(),
780 Twine("unexpected character '") + Twine(C.peek()) + "'");
781 return C.remaining();
782}
783