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