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