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 .Default(Value: MIToken::Identifier);
298}
299
300static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
301 if (!isalpha(C.peek()) && C.peek() != '_')
302 return std::nullopt;
303 auto Range = C;
304 while (isIdentifierChar(C: C.peek()))
305 C.advance();
306 auto Identifier = Range.upto(C);
307 Token.reset(Kind: getIdentifierKind(Identifier), Range: Identifier)
308 .setStringValue(Identifier);
309 return C;
310}
311
312static Cursor maybeLexMachineBasicBlock(Cursor C, MIToken &Token,
313 ErrorCallbackType ErrorCallback) {
314 bool IsReference = C.remaining().starts_with(Prefix: "%bb.");
315 if (!IsReference && !C.remaining().starts_with(Prefix: "bb."))
316 return std::nullopt;
317 auto Range = C;
318 unsigned PrefixLength = IsReference ? 4 : 3;
319 C.advance(I: PrefixLength); // Skip '%bb.' or 'bb.'
320 if (!isdigit(C.peek())) {
321 Token.reset(Kind: MIToken::Error, Range: C.remaining());
322 ErrorCallback(C.location(), "expected a number after '%bb.'");
323 return C;
324 }
325 auto NumberRange = C;
326 while (isdigit(C.peek()))
327 C.advance();
328 StringRef Number = NumberRange.upto(C);
329 unsigned StringOffset = PrefixLength + Number.size(); // Drop '%bb.<id>'
330 // TODO: The format bb.<id>.<irname> is supported only when it's not a
331 // reference. Once we deprecate the format where the irname shows up, we
332 // should only lex forward if it is a reference.
333 if (C.peek() == '.') {
334 C.advance(); // Skip '.'
335 ++StringOffset;
336 while (isIdentifierChar(C: C.peek()))
337 C.advance();
338 }
339 Token.reset(Kind: IsReference ? MIToken::MachineBasicBlock
340 : MIToken::MachineBasicBlockLabel,
341 Range: Range.upto(C))
342 .setIntegerValue(APSInt(Number))
343 .setStringValue(Range.upto(C).drop_front(N: StringOffset));
344 return C;
345}
346
347static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
348 MIToken::TokenKind Kind) {
349 if (!C.remaining().starts_with(Prefix: Rule) || !isdigit(C.peek(I: Rule.size())))
350 return std::nullopt;
351 auto Range = C;
352 C.advance(I: Rule.size());
353 auto NumberRange = C;
354 while (isdigit(C.peek()))
355 C.advance();
356 Token.reset(Kind, Range: Range.upto(C)).setIntegerValue(APSInt(NumberRange.upto(C)));
357 return C;
358}
359
360static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
361 MIToken::TokenKind Kind) {
362 if (!C.remaining().starts_with(Prefix: Rule) || !isdigit(C.peek(I: Rule.size())))
363 return std::nullopt;
364 auto Range = C;
365 C.advance(I: Rule.size());
366 auto NumberRange = C;
367 while (isdigit(C.peek()))
368 C.advance();
369 StringRef Number = NumberRange.upto(C);
370 unsigned StringOffset = Rule.size() + Number.size();
371 if (C.peek() == '.') {
372 C.advance();
373 ++StringOffset;
374 while (isIdentifierChar(C: C.peek()))
375 C.advance();
376 }
377 Token.reset(Kind, Range: Range.upto(C))
378 .setIntegerValue(APSInt(Number))
379 .setStringValue(Range.upto(C).drop_front(N: StringOffset));
380 return C;
381}
382
383static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
384 return maybeLexIndex(C, Token, Rule: "%jump-table.", Kind: MIToken::JumpTableIndex);
385}
386
387static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
388 return maybeLexIndexAndName(C, Token, Rule: "%stack.", Kind: MIToken::StackObject);
389}
390
391static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
392 return maybeLexIndex(C, Token, Rule: "%fixed-stack.", Kind: MIToken::FixedStackObject);
393}
394
395static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
396 return maybeLexIndex(C, Token, Rule: "%const.", Kind: MIToken::ConstantPoolItem);
397}
398
399static Cursor maybeLexSubRegisterIndex(Cursor C, MIToken &Token,
400 ErrorCallbackType ErrorCallback) {
401 const StringRef Rule = "%subreg.";
402 if (!C.remaining().starts_with(Prefix: Rule))
403 return std::nullopt;
404 return lexName(C, Token, Type: MIToken::SubRegisterIndex, PrefixLength: Rule.size(),
405 ErrorCallback);
406}
407
408static Cursor maybeLexIRBlock(Cursor C, MIToken &Token,
409 ErrorCallbackType ErrorCallback) {
410 const StringRef Rule = "%ir-block.";
411 if (!C.remaining().starts_with(Prefix: Rule))
412 return std::nullopt;
413 if (isdigit(C.peek(I: Rule.size())))
414 return maybeLexIndex(C, Token, Rule, Kind: MIToken::IRBlock);
415 return lexName(C, Token, Type: MIToken::NamedIRBlock, PrefixLength: Rule.size(), ErrorCallback);
416}
417
418static Cursor maybeLexIRValue(Cursor C, MIToken &Token,
419 ErrorCallbackType ErrorCallback) {
420 const StringRef Rule = "%ir.";
421 if (!C.remaining().starts_with(Prefix: Rule))
422 return std::nullopt;
423 if (isdigit(C.peek(I: Rule.size())))
424 return maybeLexIndex(C, Token, Rule, Kind: MIToken::IRValue);
425 return lexName(C, Token, Type: MIToken::NamedIRValue, PrefixLength: Rule.size(), ErrorCallback);
426}
427
428static Cursor maybeLexStringConstant(Cursor C, MIToken &Token,
429 ErrorCallbackType ErrorCallback) {
430 if (C.peek() != '"')
431 return std::nullopt;
432 return lexName(C, Token, Type: MIToken::StringConstant, /*PrefixLength=*/0,
433 ErrorCallback);
434}
435
436static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
437 auto Range = C;
438 C.advance(); // Skip '%'
439 auto NumberRange = C;
440 while (isdigit(C.peek()))
441 C.advance();
442 Token.reset(Kind: MIToken::VirtualRegister, Range: Range.upto(C))
443 .setIntegerValue(APSInt(NumberRange.upto(C)));
444 return C;
445}
446
447/// Returns true for a character allowed in a register name.
448static bool isRegisterChar(char C) {
449 return isIdentifierChar(C) && C != '.';
450}
451
452static Cursor lexNamedVirtualRegister(Cursor C, MIToken &Token) {
453 Cursor Range = C;
454 C.advance(); // Skip '%'
455 while (isRegisterChar(C: C.peek()))
456 C.advance();
457 Token.reset(Kind: MIToken::NamedVirtualRegister, Range: Range.upto(C))
458 .setStringValue(Range.upto(C).drop_front(N: 1)); // Drop the '%'
459 return C;
460}
461
462static Cursor maybeLexRegister(Cursor C, MIToken &Token,
463 ErrorCallbackType ErrorCallback) {
464 if (C.peek() != '%' && C.peek() != '$')
465 return std::nullopt;
466
467 if (C.peek() == '%') {
468 if (isdigit(C.peek(I: 1)))
469 return lexVirtualRegister(C, Token);
470
471 if (isRegisterChar(C: C.peek(I: 1)))
472 return lexNamedVirtualRegister(C, Token);
473
474 return std::nullopt;
475 }
476
477 assert(C.peek() == '$');
478 auto Range = C;
479 C.advance(); // Skip '$'
480 while (isRegisterChar(C: C.peek()))
481 C.advance();
482 Token.reset(Kind: MIToken::NamedRegister, Range: Range.upto(C))
483 .setStringValue(Range.upto(C).drop_front(N: 1)); // Drop the '$'
484 return C;
485}
486
487static Cursor maybeLexGlobalValue(Cursor C, MIToken &Token,
488 ErrorCallbackType ErrorCallback) {
489 if (C.peek() != '@')
490 return std::nullopt;
491 if (!isdigit(C.peek(I: 1)))
492 return lexName(C, Token, Type: MIToken::NamedGlobalValue, /*PrefixLength=*/1,
493 ErrorCallback);
494 auto Range = C;
495 C.advance(I: 1); // Skip the '@'
496 auto NumberRange = C;
497 while (isdigit(C.peek()))
498 C.advance();
499 Token.reset(Kind: MIToken::GlobalValue, Range: Range.upto(C))
500 .setIntegerValue(APSInt(NumberRange.upto(C)));
501 return C;
502}
503
504static Cursor maybeLexExternalSymbol(Cursor C, MIToken &Token,
505 ErrorCallbackType ErrorCallback) {
506 if (C.peek() != '&')
507 return std::nullopt;
508 return lexName(C, Token, Type: MIToken::ExternalSymbol, /*PrefixLength=*/1,
509 ErrorCallback);
510}
511
512static Cursor maybeLexMCSymbol(Cursor C, MIToken &Token,
513 ErrorCallbackType ErrorCallback) {
514 const StringRef Rule = "<mcsymbol ";
515 if (!C.remaining().starts_with(Prefix: Rule))
516 return std::nullopt;
517 auto Start = C;
518 C.advance(I: Rule.size());
519
520 // Try a simple unquoted name.
521 if (C.peek() != '"') {
522 while (isIdentifierChar(C: C.peek()))
523 C.advance();
524 StringRef String = Start.upto(C).drop_front(N: Rule.size());
525 if (C.peek() != '>') {
526 ErrorCallback(C.location(),
527 "expected the '<mcsymbol ...' to be closed by a '>'");
528 Token.reset(Kind: MIToken::Error, Range: Start.remaining());
529 return Start;
530 }
531 C.advance();
532
533 Token.reset(Kind: MIToken::MCSymbol, Range: Start.upto(C)).setStringValue(String);
534 return C;
535 }
536
537 // Otherwise lex out a quoted name.
538 Cursor R = lexStringConstant(C, ErrorCallback);
539 if (!R) {
540 ErrorCallback(C.location(),
541 "unable to parse quoted string from opening quote");
542 Token.reset(Kind: MIToken::Error, Range: Start.remaining());
543 return Start;
544 }
545 StringRef String = Start.upto(C: R).drop_front(N: Rule.size());
546 if (R.peek() != '>') {
547 ErrorCallback(R.location(),
548 "expected the '<mcsymbol ...' to be closed by a '>'");
549 Token.reset(Kind: MIToken::Error, Range: Start.remaining());
550 return Start;
551 }
552 R.advance();
553
554 Token.reset(Kind: MIToken::MCSymbol, Range: Start.upto(C: R))
555 .setOwnedStringValue(unescapeQuotedString(Value: String));
556 return R;
557}
558
559static bool isValidHexFloatingPointPrefix(char C) {
560 return C == 'H' || C == 'K' || C == 'L' || C == 'M' || C == 'R';
561}
562
563static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
564 C.advance();
565 // Skip over [0-9]*([eE][-+]?[0-9]+)?
566 while (isdigit(C.peek()))
567 C.advance();
568 if ((C.peek() == 'e' || C.peek() == 'E') &&
569 (isdigit(C.peek(I: 1)) ||
570 ((C.peek(I: 1) == '-' || C.peek(I: 1) == '+') && isdigit(C.peek(I: 2))))) {
571 C.advance(I: 2);
572 while (isdigit(C.peek()))
573 C.advance();
574 }
575 Token.reset(Kind: MIToken::FloatingPointLiteral, Range: Range.upto(C));
576 return C;
577}
578
579static Cursor maybeLexHexadecimalLiteral(Cursor C, MIToken &Token) {
580 if (C.peek() != '0' || (C.peek(I: 1) != 'x' && C.peek(I: 1) != 'X'))
581 return std::nullopt;
582 Cursor Range = C;
583 C.advance(I: 2);
584 unsigned PrefLen = 2;
585 if (isValidHexFloatingPointPrefix(C: C.peek())) {
586 C.advance();
587 PrefLen++;
588 }
589 while (isxdigit(C.peek()))
590 C.advance();
591 StringRef StrVal = Range.upto(C);
592 if (StrVal.size() <= PrefLen)
593 return std::nullopt;
594 if (PrefLen == 2)
595 Token.reset(Kind: MIToken::HexLiteral, Range: Range.upto(C));
596 else // It must be 3, which means that there was a floating-point prefix.
597 Token.reset(Kind: MIToken::FloatingPointLiteral, Range: Range.upto(C));
598 return C;
599}
600
601static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
602 if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(I: 1))))
603 return std::nullopt;
604 auto Range = C;
605 C.advance();
606 while (isdigit(C.peek()))
607 C.advance();
608 if (C.peek() == '.')
609 return lexFloatingPointLiteral(Range, C, Token);
610 StringRef StrVal = Range.upto(C);
611 Token.reset(Kind: MIToken::IntegerLiteral, Range: StrVal).setIntegerValue(APSInt(StrVal));
612 return C;
613}
614
615static MIToken::TokenKind getMetadataKeywordKind(StringRef Identifier) {
616 return StringSwitch<MIToken::TokenKind>(Identifier)
617 .Case(S: "!tbaa", Value: MIToken::md_tbaa)
618 .Case(S: "!alias.scope", Value: MIToken::md_alias_scope)
619 .Case(S: "!noalias", Value: MIToken::md_noalias)
620 .Case(S: "!range", Value: MIToken::md_range)
621 .Case(S: "!DIExpression", Value: MIToken::md_diexpr)
622 .Case(S: "!DILocation", Value: MIToken::md_dilocation)
623 .Case(S: "!noalias.addrspace", Value: MIToken::md_noalias_addrspace)
624 .Default(Value: MIToken::Error);
625}
626
627static Cursor maybeLexExclaim(Cursor C, MIToken &Token,
628 ErrorCallbackType ErrorCallback) {
629 if (C.peek() != '!')
630 return std::nullopt;
631 auto Range = C;
632 C.advance(I: 1);
633 if (isdigit(C.peek()) || !isIdentifierChar(C: C.peek())) {
634 Token.reset(Kind: MIToken::exclaim, Range: Range.upto(C));
635 return C;
636 }
637 while (isIdentifierChar(C: C.peek()))
638 C.advance();
639 StringRef StrVal = Range.upto(C);
640 Token.reset(Kind: getMetadataKeywordKind(Identifier: StrVal), Range: StrVal);
641 if (Token.isError())
642 ErrorCallback(Token.location(),
643 "use of unknown metadata keyword '" + StrVal + "'");
644 return C;
645}
646
647static MIToken::TokenKind symbolToken(char C) {
648 switch (C) {
649 case ',':
650 return MIToken::comma;
651 case '.':
652 return MIToken::dot;
653 case '=':
654 return MIToken::equal;
655 case ':':
656 return MIToken::colon;
657 case '(':
658 return MIToken::lparen;
659 case ')':
660 return MIToken::rparen;
661 case '{':
662 return MIToken::lbrace;
663 case '}':
664 return MIToken::rbrace;
665 case '+':
666 return MIToken::plus;
667 case '-':
668 return MIToken::minus;
669 case '<':
670 return MIToken::less;
671 case '>':
672 return MIToken::greater;
673 default:
674 return MIToken::Error;
675 }
676}
677
678static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
679 MIToken::TokenKind Kind;
680 unsigned Length = 1;
681 if (C.peek() == ':' && C.peek(I: 1) == ':') {
682 Kind = MIToken::coloncolon;
683 Length = 2;
684 } else
685 Kind = symbolToken(C: C.peek());
686 if (Kind == MIToken::Error)
687 return std::nullopt;
688 auto Range = C;
689 C.advance(I: Length);
690 Token.reset(Kind, Range: Range.upto(C));
691 return C;
692}
693
694static Cursor maybeLexNewline(Cursor C, MIToken &Token) {
695 if (!isNewlineChar(C: C.peek()))
696 return std::nullopt;
697 auto Range = C;
698 C.advance();
699 Token.reset(Kind: MIToken::Newline, Range: Range.upto(C));
700 return C;
701}
702
703static Cursor maybeLexEscapedIRValue(Cursor C, MIToken &Token,
704 ErrorCallbackType ErrorCallback) {
705 if (C.peek() != '`')
706 return std::nullopt;
707 auto Range = C;
708 C.advance();
709 auto StrRange = C;
710 while (C.peek() != '`') {
711 if (C.isEOF() || isNewlineChar(C: C.peek())) {
712 ErrorCallback(
713 C.location(),
714 "end of machine instruction reached before the closing '`'");
715 Token.reset(Kind: MIToken::Error, Range: Range.remaining());
716 return C;
717 }
718 C.advance();
719 }
720 StringRef Value = StrRange.upto(C);
721 C.advance();
722 Token.reset(Kind: MIToken::QuotedIRValue, Range: Range.upto(C)).setStringValue(Value);
723 return C;
724}
725
726StringRef llvm::lexMIToken(StringRef Source, MIToken &Token,
727 ErrorCallbackType ErrorCallback) {
728 auto C = skipComment(C: skipWhitespace(C: Cursor(Source)));
729 if (C.isEOF()) {
730 Token.reset(Kind: MIToken::Eof, Range: C.remaining());
731 return C.remaining();
732 }
733
734 C = skipWhitespace(C: skipMachineOperandComment(C));
735
736 if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
737 return R.remaining();
738 if (Cursor R = maybeLexIdentifier(C, Token))
739 return R.remaining();
740 if (Cursor R = maybeLexJumpTableIndex(C, Token))
741 return R.remaining();
742 if (Cursor R = maybeLexStackObject(C, Token))
743 return R.remaining();
744 if (Cursor R = maybeLexFixedStackObject(C, Token))
745 return R.remaining();
746 if (Cursor R = maybeLexConstantPoolItem(C, Token))
747 return R.remaining();
748 if (Cursor R = maybeLexSubRegisterIndex(C, Token, ErrorCallback))
749 return R.remaining();
750 if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
751 return R.remaining();
752 if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
753 return R.remaining();
754 if (Cursor R = maybeLexRegister(C, Token, ErrorCallback))
755 return R.remaining();
756 if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
757 return R.remaining();
758 if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
759 return R.remaining();
760 if (Cursor R = maybeLexMCSymbol(C, Token, ErrorCallback))
761 return R.remaining();
762 if (Cursor R = maybeLexHexadecimalLiteral(C, Token))
763 return R.remaining();
764 if (Cursor R = maybeLexNumericalLiteral(C, Token))
765 return R.remaining();
766 if (Cursor R = maybeLexExclaim(C, Token, ErrorCallback))
767 return R.remaining();
768 if (Cursor R = maybeLexSymbol(C, Token))
769 return R.remaining();
770 if (Cursor R = maybeLexNewline(C, Token))
771 return R.remaining();
772 if (Cursor R = maybeLexEscapedIRValue(C, Token, ErrorCallback))
773 return R.remaining();
774 if (Cursor R = maybeLexStringConstant(C, Token, ErrorCallback))
775 return R.remaining();
776
777 Token.reset(Kind: MIToken::Error, Range: C.remaining());
778 ErrorCallback(C.location(),
779 Twine("unexpected character '") + Twine(C.peek()) + "'");
780 return C.remaining();
781}
782