1 //===- MILexer.cpp - Machine instructions lexer implementation ------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the lexing of machine instructions.
12 //===----------------------------------------------------------------------===//
15 #include "llvm/ADT/APSInt.h"
16 #include "llvm/ADT/None.h"
17 #include "llvm/ADT/STLExtras.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/ADT/StringSwitch.h"
20 #include "llvm/ADT/StringRef.h"
21 #include "llvm/ADT/Twine.h"
31 using ErrorCallbackType =
32 function_ref<void(StringRef::iterator Loc, const Twine &)>;
34 /// This class provides a way to iterate and get characters from the source
37 const char *Ptr = nullptr;
38 const char *End = nullptr;
43 explicit Cursor(StringRef Str) {
45 End = Ptr + Str.size();
48 bool isEOF() const { return Ptr == End; }
50 char peek(int I = 0) const { return End - Ptr <= I ? 0 : Ptr[I]; }
52 void advance(unsigned I = 1) { Ptr += I; }
54 StringRef remaining() const { return StringRef(Ptr, End - Ptr); }
56 StringRef upto(Cursor C) const {
57 assert(C.Ptr >= Ptr && C.Ptr <= End);
58 return StringRef(Ptr, C.Ptr - Ptr);
61 StringRef::iterator location() const { return Ptr; }
63 operator bool() const { return Ptr != nullptr; }
66 } // end anonymous namespace
68 MIToken &MIToken::reset(TokenKind Kind, StringRef Range) {
74 MIToken &MIToken::setStringValue(StringRef StrVal) {
79 MIToken &MIToken::setOwnedStringValue(std::string StrVal) {
80 StringValueStorage = std::move(StrVal);
81 StringValue = StringValueStorage;
85 MIToken &MIToken::setIntegerValue(APSInt IntVal) {
86 this->IntVal = std::move(IntVal);
90 /// Skip the leading whitespace characters and return the updated cursor.
91 static Cursor skipWhitespace(Cursor C) {
92 while (isblank(C.peek()))
97 static bool isNewlineChar(char C) { return C == '\n' || C == '\r'; }
99 /// Skip a line comment and return the updated cursor.
100 static Cursor skipComment(Cursor C) {
103 while (!isNewlineChar(C.peek()) && !C.isEOF())
108 /// Return true if the given character satisfies the following regular
109 /// expression: [-a-zA-Z$._0-9]
110 static bool isIdentifierChar(char C) {
111 return isalpha(C) || isdigit(C) || C == '_' || C == '-' || C == '.' ||
115 /// Unescapes the given string value.
117 /// Expects the string value to be quoted.
118 static std::string unescapeQuotedString(StringRef Value) {
119 assert(Value.front() == '"' && Value.back() == '"');
120 Cursor C = Cursor(Value.substr(1, Value.size() - 2));
123 Str.reserve(C.remaining().size());
125 char Char = C.peek();
127 if (C.peek(1) == '\\') {
128 // Two '\' become one
133 if (isxdigit(C.peek(1)) && isxdigit(C.peek(2))) {
134 Str += hexDigitValue(C.peek(1)) * 16 + hexDigitValue(C.peek(2));
145 /// Lex a string constant using the following regular expression: \"[^\"]*\"
146 static Cursor lexStringConstant(Cursor C, ErrorCallbackType ErrorCallback) {
147 assert(C.peek() == '"');
148 for (C.advance(); C.peek() != '"'; C.advance()) {
149 if (C.isEOF() || isNewlineChar(C.peek())) {
152 "end of machine instruction reached before the closing '\"'");
160 static Cursor lexName(Cursor C, MIToken &Token, MIToken::TokenKind Type,
161 unsigned PrefixLength, ErrorCallbackType ErrorCallback) {
163 C.advance(PrefixLength);
164 if (C.peek() == '"') {
165 if (Cursor R = lexStringConstant(C, ErrorCallback)) {
166 StringRef String = Range.upto(R);
167 Token.reset(Type, String)
168 .setOwnedStringValue(
169 unescapeQuotedString(String.drop_front(PrefixLength)));
172 Token.reset(MIToken::Error, Range.remaining());
175 while (isIdentifierChar(C.peek()))
177 Token.reset(Type, Range.upto(C))
178 .setStringValue(Range.upto(C).drop_front(PrefixLength));
182 static Cursor maybeLexIntegerOrScalarType(Cursor C, MIToken &Token) {
183 if ((C.peek() != 'i' && C.peek() != 's' && C.peek() != 'p') ||
186 char Kind = C.peek();
188 C.advance(); // Skip 'i', 's', or 'p'
189 while (isdigit(C.peek()))
192 Token.reset(Kind == 'i'
193 ? MIToken::IntegerType
194 : (Kind == 's' ? MIToken::ScalarType : MIToken::PointerType),
199 static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
200 return StringSwitch<MIToken::TokenKind>(Identifier)
201 .Case("_", MIToken::underscore)
202 .Case("implicit", MIToken::kw_implicit)
203 .Case("implicit-def", MIToken::kw_implicit_define)
204 .Case("def", MIToken::kw_def)
205 .Case("dead", MIToken::kw_dead)
206 .Case("killed", MIToken::kw_killed)
207 .Case("undef", MIToken::kw_undef)
208 .Case("internal", MIToken::kw_internal)
209 .Case("early-clobber", MIToken::kw_early_clobber)
210 .Case("debug-use", MIToken::kw_debug_use)
211 .Case("renamable", MIToken::kw_renamable)
212 .Case("tied-def", MIToken::kw_tied_def)
213 .Case("frame-setup", MIToken::kw_frame_setup)
214 .Case("debug-location", MIToken::kw_debug_location)
215 .Case("same_value", MIToken::kw_cfi_same_value)
216 .Case("offset", MIToken::kw_cfi_offset)
217 .Case("rel_offset", MIToken::kw_cfi_rel_offset)
218 .Case("def_cfa_register", MIToken::kw_cfi_def_cfa_register)
219 .Case("def_cfa_offset", MIToken::kw_cfi_def_cfa_offset)
220 .Case("adjust_cfa_offset", MIToken::kw_cfi_adjust_cfa_offset)
221 .Case("escape", MIToken::kw_cfi_escape)
222 .Case("def_cfa", MIToken::kw_cfi_def_cfa)
223 .Case("remember_state", MIToken::kw_cfi_remember_state)
224 .Case("restore", MIToken::kw_cfi_restore)
225 .Case("restore_state", MIToken::kw_cfi_restore_state)
226 .Case("undefined", MIToken::kw_cfi_undefined)
227 .Case("register", MIToken::kw_cfi_register)
228 .Case("window_save", MIToken::kw_cfi_window_save)
229 .Case("blockaddress", MIToken::kw_blockaddress)
230 .Case("intrinsic", MIToken::kw_intrinsic)
231 .Case("target-index", MIToken::kw_target_index)
232 .Case("half", MIToken::kw_half)
233 .Case("float", MIToken::kw_float)
234 .Case("double", MIToken::kw_double)
235 .Case("x86_fp80", MIToken::kw_x86_fp80)
236 .Case("fp128", MIToken::kw_fp128)
237 .Case("ppc_fp128", MIToken::kw_ppc_fp128)
238 .Case("target-flags", MIToken::kw_target_flags)
239 .Case("volatile", MIToken::kw_volatile)
240 .Case("non-temporal", MIToken::kw_non_temporal)
241 .Case("dereferenceable", MIToken::kw_dereferenceable)
242 .Case("invariant", MIToken::kw_invariant)
243 .Case("align", MIToken::kw_align)
244 .Case("stack", MIToken::kw_stack)
245 .Case("got", MIToken::kw_got)
246 .Case("jump-table", MIToken::kw_jump_table)
247 .Case("constant-pool", MIToken::kw_constant_pool)
248 .Case("call-entry", MIToken::kw_call_entry)
249 .Case("liveout", MIToken::kw_liveout)
250 .Case("address-taken", MIToken::kw_address_taken)
251 .Case("landing-pad", MIToken::kw_landing_pad)
252 .Case("liveins", MIToken::kw_liveins)
253 .Case("successors", MIToken::kw_successors)
254 .Case("floatpred", MIToken::kw_floatpred)
255 .Case("intpred", MIToken::kw_intpred)
256 .Default(MIToken::Identifier);
259 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
260 if (!isalpha(C.peek()) && C.peek() != '_')
263 while (isIdentifierChar(C.peek()))
265 auto Identifier = Range.upto(C);
266 Token.reset(getIdentifierKind(Identifier), Identifier)
267 .setStringValue(Identifier);
271 static Cursor maybeLexMachineBasicBlock(Cursor C, MIToken &Token,
272 ErrorCallbackType ErrorCallback) {
273 bool IsReference = C.remaining().startswith("%bb.");
274 if (!IsReference && !C.remaining().startswith("bb."))
277 unsigned PrefixLength = IsReference ? 4 : 3;
278 C.advance(PrefixLength); // Skip '%bb.' or 'bb.'
279 if (!isdigit(C.peek())) {
280 Token.reset(MIToken::Error, C.remaining());
281 ErrorCallback(C.location(), "expected a number after '%bb.'");
284 auto NumberRange = C;
285 while (isdigit(C.peek()))
287 StringRef Number = NumberRange.upto(C);
288 unsigned StringOffset = PrefixLength + Number.size(); // Drop '%bb.<id>'
289 // TODO: The format bb.<id>.<irname> is supported only when it's not a
290 // reference. Once we deprecate the format where the irname shows up, we
291 // should only lex forward if it is a reference.
292 if (C.peek() == '.') {
293 C.advance(); // Skip '.'
295 while (isIdentifierChar(C.peek()))
298 Token.reset(IsReference ? MIToken::MachineBasicBlock
299 : MIToken::MachineBasicBlockLabel,
301 .setIntegerValue(APSInt(Number))
302 .setStringValue(Range.upto(C).drop_front(StringOffset));
306 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
307 MIToken::TokenKind Kind) {
308 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
311 C.advance(Rule.size());
312 auto NumberRange = C;
313 while (isdigit(C.peek()))
315 Token.reset(Kind, Range.upto(C)).setIntegerValue(APSInt(NumberRange.upto(C)));
319 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
320 MIToken::TokenKind Kind) {
321 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
324 C.advance(Rule.size());
325 auto NumberRange = C;
326 while (isdigit(C.peek()))
328 StringRef Number = NumberRange.upto(C);
329 unsigned StringOffset = Rule.size() + Number.size();
330 if (C.peek() == '.') {
333 while (isIdentifierChar(C.peek()))
336 Token.reset(Kind, Range.upto(C))
337 .setIntegerValue(APSInt(Number))
338 .setStringValue(Range.upto(C).drop_front(StringOffset));
342 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
343 return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
346 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
347 return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
350 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
351 return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
354 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
355 return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
358 static Cursor maybeLexSubRegisterIndex(Cursor C, MIToken &Token,
359 ErrorCallbackType ErrorCallback) {
360 const StringRef Rule = "%subreg.";
361 if (!C.remaining().startswith(Rule))
363 return lexName(C, Token, MIToken::SubRegisterIndex, Rule.size(),
367 static Cursor maybeLexIRBlock(Cursor C, MIToken &Token,
368 ErrorCallbackType ErrorCallback) {
369 const StringRef Rule = "%ir-block.";
370 if (!C.remaining().startswith(Rule))
372 if (isdigit(C.peek(Rule.size())))
373 return maybeLexIndex(C, Token, Rule, MIToken::IRBlock);
374 return lexName(C, Token, MIToken::NamedIRBlock, Rule.size(), ErrorCallback);
377 static Cursor maybeLexIRValue(Cursor C, MIToken &Token,
378 ErrorCallbackType ErrorCallback) {
379 const StringRef Rule = "%ir.";
380 if (!C.remaining().startswith(Rule))
382 if (isdigit(C.peek(Rule.size())))
383 return maybeLexIndex(C, Token, Rule, MIToken::IRValue);
384 return lexName(C, Token, MIToken::NamedIRValue, Rule.size(), ErrorCallback);
387 static Cursor maybeLexStringConstant(Cursor C, MIToken &Token,
388 ErrorCallbackType ErrorCallback) {
391 return lexName(C, Token, MIToken::StringConstant, /*PrefixLength=*/0,
395 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
397 C.advance(); // Skip '%'
398 auto NumberRange = C;
399 while (isdigit(C.peek()))
401 Token.reset(MIToken::VirtualRegister, Range.upto(C))
402 .setIntegerValue(APSInt(NumberRange.upto(C)));
406 /// Returns true for a character allowed in a register name.
407 static bool isRegisterChar(char C) {
408 return isIdentifierChar(C) && C != '.';
411 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
414 if (isdigit(C.peek(1)))
415 return lexVirtualRegister(C, Token);
417 C.advance(); // Skip '%'
418 while (isRegisterChar(C.peek()))
420 Token.reset(MIToken::NamedRegister, Range.upto(C))
421 .setStringValue(Range.upto(C).drop_front(1)); // Drop the '%'
425 static Cursor maybeLexGlobalValue(Cursor C, MIToken &Token,
426 ErrorCallbackType ErrorCallback) {
429 if (!isdigit(C.peek(1)))
430 return lexName(C, Token, MIToken::NamedGlobalValue, /*PrefixLength=*/1,
433 C.advance(1); // Skip the '@'
434 auto NumberRange = C;
435 while (isdigit(C.peek()))
437 Token.reset(MIToken::GlobalValue, Range.upto(C))
438 .setIntegerValue(APSInt(NumberRange.upto(C)));
442 static Cursor maybeLexExternalSymbol(Cursor C, MIToken &Token,
443 ErrorCallbackType ErrorCallback) {
446 return lexName(C, Token, MIToken::ExternalSymbol, /*PrefixLength=*/1,
450 static bool isValidHexFloatingPointPrefix(char C) {
451 return C == 'H' || C == 'K' || C == 'L' || C == 'M';
454 static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
456 // Skip over [0-9]*([eE][-+]?[0-9]+)?
457 while (isdigit(C.peek()))
459 if ((C.peek() == 'e' || C.peek() == 'E') &&
460 (isdigit(C.peek(1)) ||
461 ((C.peek(1) == '-' || C.peek(1) == '+') && isdigit(C.peek(2))))) {
463 while (isdigit(C.peek()))
466 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
470 static Cursor maybeLexHexadecimalLiteral(Cursor C, MIToken &Token) {
471 if (C.peek() != '0' || (C.peek(1) != 'x' && C.peek(1) != 'X'))
475 unsigned PrefLen = 2;
476 if (isValidHexFloatingPointPrefix(C.peek())) {
480 while (isxdigit(C.peek()))
482 StringRef StrVal = Range.upto(C);
483 if (StrVal.size() <= PrefLen)
486 Token.reset(MIToken::HexLiteral, Range.upto(C));
487 else // It must be 3, which means that there was a floating-point prefix.
488 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
492 static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
493 if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
497 while (isdigit(C.peek()))
500 return lexFloatingPointLiteral(Range, C, Token);
501 StringRef StrVal = Range.upto(C);
502 Token.reset(MIToken::IntegerLiteral, StrVal).setIntegerValue(APSInt(StrVal));
506 static MIToken::TokenKind getMetadataKeywordKind(StringRef Identifier) {
507 return StringSwitch<MIToken::TokenKind>(Identifier)
508 .Case("!tbaa", MIToken::md_tbaa)
509 .Case("!alias.scope", MIToken::md_alias_scope)
510 .Case("!noalias", MIToken::md_noalias)
511 .Case("!range", MIToken::md_range)
512 .Case("!DIExpression", MIToken::md_diexpr)
513 .Default(MIToken::Error);
516 static Cursor maybeLexExlaim(Cursor C, MIToken &Token,
517 ErrorCallbackType ErrorCallback) {
522 if (isdigit(C.peek()) || !isIdentifierChar(C.peek())) {
523 Token.reset(MIToken::exclaim, Range.upto(C));
526 while (isIdentifierChar(C.peek()))
528 StringRef StrVal = Range.upto(C);
529 Token.reset(getMetadataKeywordKind(StrVal), StrVal);
531 ErrorCallback(Token.location(),
532 "use of unknown metadata keyword '" + StrVal + "'");
536 static MIToken::TokenKind symbolToken(char C) {
539 return MIToken::comma;
543 return MIToken::equal;
545 return MIToken::colon;
547 return MIToken::lparen;
549 return MIToken::rparen;
551 return MIToken::lbrace;
553 return MIToken::rbrace;
555 return MIToken::plus;
557 return MIToken::minus;
559 return MIToken::less;
561 return MIToken::greater;
563 return MIToken::Error;
567 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
568 MIToken::TokenKind Kind;
570 if (C.peek() == ':' && C.peek(1) == ':') {
571 Kind = MIToken::coloncolon;
574 Kind = symbolToken(C.peek());
575 if (Kind == MIToken::Error)
579 Token.reset(Kind, Range.upto(C));
583 static Cursor maybeLexNewline(Cursor C, MIToken &Token) {
584 if (!isNewlineChar(C.peek()))
588 Token.reset(MIToken::Newline, Range.upto(C));
592 static Cursor maybeLexEscapedIRValue(Cursor C, MIToken &Token,
593 ErrorCallbackType ErrorCallback) {
599 while (C.peek() != '`') {
600 if (C.isEOF() || isNewlineChar(C.peek())) {
603 "end of machine instruction reached before the closing '`'");
604 Token.reset(MIToken::Error, Range.remaining());
609 StringRef Value = StrRange.upto(C);
611 Token.reset(MIToken::QuotedIRValue, Range.upto(C)).setStringValue(Value);
615 StringRef llvm::lexMIToken(StringRef Source, MIToken &Token,
616 ErrorCallbackType ErrorCallback) {
617 auto C = skipComment(skipWhitespace(Cursor(Source)));
619 Token.reset(MIToken::Eof, C.remaining());
620 return C.remaining();
623 if (Cursor R = maybeLexIntegerOrScalarType(C, Token))
624 return R.remaining();
625 if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
626 return R.remaining();
627 if (Cursor R = maybeLexIdentifier(C, Token))
628 return R.remaining();
629 if (Cursor R = maybeLexJumpTableIndex(C, Token))
630 return R.remaining();
631 if (Cursor R = maybeLexStackObject(C, Token))
632 return R.remaining();
633 if (Cursor R = maybeLexFixedStackObject(C, Token))
634 return R.remaining();
635 if (Cursor R = maybeLexConstantPoolItem(C, Token))
636 return R.remaining();
637 if (Cursor R = maybeLexSubRegisterIndex(C, Token, ErrorCallback))
638 return R.remaining();
639 if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
640 return R.remaining();
641 if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
642 return R.remaining();
643 if (Cursor R = maybeLexRegister(C, Token))
644 return R.remaining();
645 if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
646 return R.remaining();
647 if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
648 return R.remaining();
649 if (Cursor R = maybeLexHexadecimalLiteral(C, Token))
650 return R.remaining();
651 if (Cursor R = maybeLexNumericalLiteral(C, Token))
652 return R.remaining();
653 if (Cursor R = maybeLexExlaim(C, Token, ErrorCallback))
654 return R.remaining();
655 if (Cursor R = maybeLexSymbol(C, Token))
656 return R.remaining();
657 if (Cursor R = maybeLexNewline(C, Token))
658 return R.remaining();
659 if (Cursor R = maybeLexEscapedIRValue(C, Token, ErrorCallback))
660 return R.remaining();
661 if (Cursor R = maybeLexStringConstant(C, Token, ErrorCallback))
662 return R.remaining();
664 Token.reset(MIToken::Error, C.remaining());
665 ErrorCallback(C.location(),
666 Twine("unexpected character '") + Twine(C.peek()) + "'");
667 return C.remaining();