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