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/None.h"
16 #include "llvm/ADT/StringExtras.h"
17 #include "llvm/ADT/StringSwitch.h"
18 #include "llvm/ADT/Twine.h"
25 typedef function_ref<void(StringRef::iterator Loc, const Twine &)>
28 /// This class provides a way to iterate and get characters from the source
35 Cursor(NoneType) : Ptr(nullptr), End(nullptr) {}
37 explicit Cursor(StringRef Str) {
39 End = Ptr + Str.size();
42 bool isEOF() const { return Ptr == End; }
44 char peek(int I = 0) const { return End - Ptr <= I ? 0 : Ptr[I]; }
46 void advance(unsigned I = 1) { Ptr += I; }
48 StringRef remaining() const { return StringRef(Ptr, End - Ptr); }
50 StringRef upto(Cursor C) const {
51 assert(C.Ptr >= Ptr && C.Ptr <= End);
52 return StringRef(Ptr, C.Ptr - Ptr);
55 StringRef::iterator location() const { return Ptr; }
57 operator bool() const { return Ptr != nullptr; }
60 } // end anonymous namespace
62 MIToken &MIToken::reset(TokenKind Kind, StringRef Range) {
68 MIToken &MIToken::setStringValue(StringRef StrVal) {
73 MIToken &MIToken::setOwnedStringValue(std::string StrVal) {
74 StringValueStorage = std::move(StrVal);
75 StringValue = StringValueStorage;
79 MIToken &MIToken::setIntegerValue(APSInt IntVal) {
80 this->IntVal = std::move(IntVal);
84 /// Skip the leading whitespace characters and return the updated cursor.
85 static Cursor skipWhitespace(Cursor C) {
86 while (isblank(C.peek()))
91 static bool isNewlineChar(char C) { return C == '\n' || C == '\r'; }
93 /// Skip a line comment and return the updated cursor.
94 static Cursor skipComment(Cursor C) {
97 while (!isNewlineChar(C.peek()) && !C.isEOF())
102 /// Return true if the given character satisfies the following regular
103 /// expression: [-a-zA-Z$._0-9]
104 static bool isIdentifierChar(char C) {
105 return isalpha(C) || isdigit(C) || C == '_' || C == '-' || C == '.' ||
109 /// Unescapes the given string value.
111 /// Expects the string value to be quoted.
112 static std::string unescapeQuotedString(StringRef Value) {
113 assert(Value.front() == '"' && Value.back() == '"');
114 Cursor C = Cursor(Value.substr(1, Value.size() - 2));
117 Str.reserve(C.remaining().size());
119 char Char = C.peek();
121 if (C.peek(1) == '\\') {
122 // Two '\' become one
127 if (isxdigit(C.peek(1)) && isxdigit(C.peek(2))) {
128 Str += hexDigitValue(C.peek(1)) * 16 + hexDigitValue(C.peek(2));
139 /// Lex a string constant using the following regular expression: \"[^\"]*\"
140 static Cursor lexStringConstant(Cursor C, ErrorCallbackType ErrorCallback) {
141 assert(C.peek() == '"');
142 for (C.advance(); C.peek() != '"'; C.advance()) {
143 if (C.isEOF() || isNewlineChar(C.peek())) {
146 "end of machine instruction reached before the closing '\"'");
154 static Cursor lexName(Cursor C, MIToken &Token, MIToken::TokenKind Type,
155 unsigned PrefixLength, ErrorCallbackType ErrorCallback) {
157 C.advance(PrefixLength);
158 if (C.peek() == '"') {
159 if (Cursor R = lexStringConstant(C, ErrorCallback)) {
160 StringRef String = Range.upto(R);
161 Token.reset(Type, String)
162 .setOwnedStringValue(
163 unescapeQuotedString(String.drop_front(PrefixLength)));
166 Token.reset(MIToken::Error, Range.remaining());
169 while (isIdentifierChar(C.peek()))
171 Token.reset(Type, Range.upto(C))
172 .setStringValue(Range.upto(C).drop_front(PrefixLength));
176 static Cursor maybeLexIntegerOrScalarType(Cursor C, MIToken &Token) {
177 if ((C.peek() != 'i' && C.peek() != 's' && C.peek() != 'p') ||
180 char Kind = C.peek();
182 C.advance(); // Skip 'i', 's', or 'p'
183 while (isdigit(C.peek()))
186 Token.reset(Kind == 'i'
187 ? MIToken::IntegerType
188 : (Kind == 's' ? MIToken::ScalarType : MIToken::PointerType),
193 static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
194 return StringSwitch<MIToken::TokenKind>(Identifier)
195 .Case("_", MIToken::underscore)
196 .Case("implicit", MIToken::kw_implicit)
197 .Case("implicit-def", MIToken::kw_implicit_define)
198 .Case("def", MIToken::kw_def)
199 .Case("dead", MIToken::kw_dead)
200 .Case("killed", MIToken::kw_killed)
201 .Case("undef", MIToken::kw_undef)
202 .Case("internal", MIToken::kw_internal)
203 .Case("early-clobber", MIToken::kw_early_clobber)
204 .Case("debug-use", MIToken::kw_debug_use)
205 .Case("tied-def", MIToken::kw_tied_def)
206 .Case("frame-setup", MIToken::kw_frame_setup)
207 .Case("debug-location", MIToken::kw_debug_location)
208 .Case("same_value", MIToken::kw_cfi_same_value)
209 .Case("offset", MIToken::kw_cfi_offset)
210 .Case("def_cfa_register", MIToken::kw_cfi_def_cfa_register)
211 .Case("def_cfa_offset", MIToken::kw_cfi_def_cfa_offset)
212 .Case("def_cfa", MIToken::kw_cfi_def_cfa)
213 .Case("blockaddress", MIToken::kw_blockaddress)
214 .Case("intrinsic", MIToken::kw_intrinsic)
215 .Case("target-index", MIToken::kw_target_index)
216 .Case("half", MIToken::kw_half)
217 .Case("float", MIToken::kw_float)
218 .Case("double", MIToken::kw_double)
219 .Case("x86_fp80", MIToken::kw_x86_fp80)
220 .Case("fp128", MIToken::kw_fp128)
221 .Case("ppc_fp128", MIToken::kw_ppc_fp128)
222 .Case("target-flags", MIToken::kw_target_flags)
223 .Case("volatile", MIToken::kw_volatile)
224 .Case("non-temporal", MIToken::kw_non_temporal)
225 .Case("dereferenceable", MIToken::kw_dereferenceable)
226 .Case("invariant", MIToken::kw_invariant)
227 .Case("align", MIToken::kw_align)
228 .Case("stack", MIToken::kw_stack)
229 .Case("got", MIToken::kw_got)
230 .Case("jump-table", MIToken::kw_jump_table)
231 .Case("constant-pool", MIToken::kw_constant_pool)
232 .Case("call-entry", MIToken::kw_call_entry)
233 .Case("liveout", MIToken::kw_liveout)
234 .Case("address-taken", MIToken::kw_address_taken)
235 .Case("landing-pad", MIToken::kw_landing_pad)
236 .Case("liveins", MIToken::kw_liveins)
237 .Case("successors", MIToken::kw_successors)
238 .Case("floatpred", MIToken::kw_floatpred)
239 .Case("intpred", MIToken::kw_intpred)
240 .Default(MIToken::Identifier);
243 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
244 if (!isalpha(C.peek()) && C.peek() != '_')
247 while (isIdentifierChar(C.peek()))
249 auto Identifier = Range.upto(C);
250 Token.reset(getIdentifierKind(Identifier), Identifier)
251 .setStringValue(Identifier);
255 static Cursor maybeLexMachineBasicBlock(Cursor C, MIToken &Token,
256 ErrorCallbackType ErrorCallback) {
257 bool IsReference = C.remaining().startswith("%bb.");
258 if (!IsReference && !C.remaining().startswith("bb."))
261 unsigned PrefixLength = IsReference ? 4 : 3;
262 C.advance(PrefixLength); // Skip '%bb.' or 'bb.'
263 if (!isdigit(C.peek())) {
264 Token.reset(MIToken::Error, C.remaining());
265 ErrorCallback(C.location(), "expected a number after '%bb.'");
268 auto NumberRange = C;
269 while (isdigit(C.peek()))
271 StringRef Number = NumberRange.upto(C);
272 unsigned StringOffset = PrefixLength + Number.size(); // Drop '%bb.<id>'
273 if (C.peek() == '.') {
274 C.advance(); // Skip '.'
276 while (isIdentifierChar(C.peek()))
279 Token.reset(IsReference ? MIToken::MachineBasicBlock
280 : MIToken::MachineBasicBlockLabel,
282 .setIntegerValue(APSInt(Number))
283 .setStringValue(Range.upto(C).drop_front(StringOffset));
287 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
288 MIToken::TokenKind Kind) {
289 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
292 C.advance(Rule.size());
293 auto NumberRange = C;
294 while (isdigit(C.peek()))
296 Token.reset(Kind, Range.upto(C)).setIntegerValue(APSInt(NumberRange.upto(C)));
300 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
301 MIToken::TokenKind Kind) {
302 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
305 C.advance(Rule.size());
306 auto NumberRange = C;
307 while (isdigit(C.peek()))
309 StringRef Number = NumberRange.upto(C);
310 unsigned StringOffset = Rule.size() + Number.size();
311 if (C.peek() == '.') {
314 while (isIdentifierChar(C.peek()))
317 Token.reset(Kind, Range.upto(C))
318 .setIntegerValue(APSInt(Number))
319 .setStringValue(Range.upto(C).drop_front(StringOffset));
323 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
324 return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
327 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
328 return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
331 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
332 return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
335 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
336 return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
339 static Cursor maybeLexSubRegisterIndex(Cursor C, MIToken &Token,
340 ErrorCallbackType ErrorCallback) {
341 const StringRef Rule = "%subreg.";
342 if (!C.remaining().startswith(Rule))
344 return lexName(C, Token, MIToken::SubRegisterIndex, Rule.size(),
348 static Cursor maybeLexIRBlock(Cursor C, MIToken &Token,
349 ErrorCallbackType ErrorCallback) {
350 const StringRef Rule = "%ir-block.";
351 if (!C.remaining().startswith(Rule))
353 if (isdigit(C.peek(Rule.size())))
354 return maybeLexIndex(C, Token, Rule, MIToken::IRBlock);
355 return lexName(C, Token, MIToken::NamedIRBlock, Rule.size(), ErrorCallback);
358 static Cursor maybeLexIRValue(Cursor C, MIToken &Token,
359 ErrorCallbackType ErrorCallback) {
360 const StringRef Rule = "%ir.";
361 if (!C.remaining().startswith(Rule))
363 if (isdigit(C.peek(Rule.size())))
364 return maybeLexIndex(C, Token, Rule, MIToken::IRValue);
365 return lexName(C, Token, MIToken::NamedIRValue, Rule.size(), ErrorCallback);
368 static Cursor maybeLexStringConstant(Cursor C, MIToken &Token,
369 ErrorCallbackType ErrorCallback) {
372 return lexName(C, Token, MIToken::StringConstant, /*PrefixLength=*/0,
376 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
378 C.advance(); // Skip '%'
379 auto NumberRange = C;
380 while (isdigit(C.peek()))
382 Token.reset(MIToken::VirtualRegister, Range.upto(C))
383 .setIntegerValue(APSInt(NumberRange.upto(C)));
387 /// Returns true for a character allowed in a register name.
388 static bool isRegisterChar(char C) {
389 return isIdentifierChar(C) && C != '.';
392 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
395 if (isdigit(C.peek(1)))
396 return lexVirtualRegister(C, Token);
398 C.advance(); // Skip '%'
399 while (isRegisterChar(C.peek()))
401 Token.reset(MIToken::NamedRegister, Range.upto(C))
402 .setStringValue(Range.upto(C).drop_front(1)); // Drop the '%'
406 static Cursor maybeLexGlobalValue(Cursor C, MIToken &Token,
407 ErrorCallbackType ErrorCallback) {
410 if (!isdigit(C.peek(1)))
411 return lexName(C, Token, MIToken::NamedGlobalValue, /*PrefixLength=*/1,
414 C.advance(1); // Skip the '@'
415 auto NumberRange = C;
416 while (isdigit(C.peek()))
418 Token.reset(MIToken::GlobalValue, Range.upto(C))
419 .setIntegerValue(APSInt(NumberRange.upto(C)));
423 static Cursor maybeLexExternalSymbol(Cursor C, MIToken &Token,
424 ErrorCallbackType ErrorCallback) {
427 return lexName(C, Token, MIToken::ExternalSymbol, /*PrefixLength=*/1,
431 static bool isValidHexFloatingPointPrefix(char C) {
432 return C == 'H' || C == 'K' || C == 'L' || C == 'M';
435 static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
437 // Skip over [0-9]*([eE][-+]?[0-9]+)?
438 while (isdigit(C.peek()))
440 if ((C.peek() == 'e' || C.peek() == 'E') &&
441 (isdigit(C.peek(1)) ||
442 ((C.peek(1) == '-' || C.peek(1) == '+') && isdigit(C.peek(2))))) {
444 while (isdigit(C.peek()))
447 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
451 static Cursor maybeLexHexadecimalLiteral(Cursor C, MIToken &Token) {
452 if (C.peek() != '0' || (C.peek(1) != 'x' && C.peek(1) != 'X'))
456 unsigned PrefLen = 2;
457 if (isValidHexFloatingPointPrefix(C.peek())) {
461 while (isxdigit(C.peek()))
463 StringRef StrVal = Range.upto(C);
464 if (StrVal.size() <= PrefLen)
467 Token.reset(MIToken::HexLiteral, Range.upto(C));
468 else // It must be 3, which means that there was a floating-point prefix.
469 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
473 static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
474 if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
478 while (isdigit(C.peek()))
481 return lexFloatingPointLiteral(Range, C, Token);
482 StringRef StrVal = Range.upto(C);
483 Token.reset(MIToken::IntegerLiteral, StrVal).setIntegerValue(APSInt(StrVal));
487 static MIToken::TokenKind getMetadataKeywordKind(StringRef Identifier) {
488 return StringSwitch<MIToken::TokenKind>(Identifier)
489 .Case("!tbaa", MIToken::md_tbaa)
490 .Case("!alias.scope", MIToken::md_alias_scope)
491 .Case("!noalias", MIToken::md_noalias)
492 .Case("!range", MIToken::md_range)
493 .Default(MIToken::Error);
496 static Cursor maybeLexExlaim(Cursor C, MIToken &Token,
497 ErrorCallbackType ErrorCallback) {
502 if (isdigit(C.peek()) || !isIdentifierChar(C.peek())) {
503 Token.reset(MIToken::exclaim, Range.upto(C));
506 while (isIdentifierChar(C.peek()))
508 StringRef StrVal = Range.upto(C);
509 Token.reset(getMetadataKeywordKind(StrVal), StrVal);
511 ErrorCallback(Token.location(),
512 "use of unknown metadata keyword '" + StrVal + "'");
516 static MIToken::TokenKind symbolToken(char C) {
519 return MIToken::comma;
523 return MIToken::equal;
525 return MIToken::colon;
527 return MIToken::lparen;
529 return MIToken::rparen;
531 return MIToken::lbrace;
533 return MIToken::rbrace;
535 return MIToken::plus;
537 return MIToken::minus;
539 return MIToken::less;
541 return MIToken::greater;
543 return MIToken::Error;
547 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
548 MIToken::TokenKind Kind;
550 if (C.peek() == ':' && C.peek(1) == ':') {
551 Kind = MIToken::coloncolon;
554 Kind = symbolToken(C.peek());
555 if (Kind == MIToken::Error)
559 Token.reset(Kind, Range.upto(C));
563 static Cursor maybeLexNewline(Cursor C, MIToken &Token) {
564 if (!isNewlineChar(C.peek()))
568 Token.reset(MIToken::Newline, Range.upto(C));
572 static Cursor maybeLexEscapedIRValue(Cursor C, MIToken &Token,
573 ErrorCallbackType ErrorCallback) {
579 while (C.peek() != '`') {
580 if (C.isEOF() || isNewlineChar(C.peek())) {
583 "end of machine instruction reached before the closing '`'");
584 Token.reset(MIToken::Error, Range.remaining());
589 StringRef Value = StrRange.upto(C);
591 Token.reset(MIToken::QuotedIRValue, Range.upto(C)).setStringValue(Value);
595 StringRef llvm::lexMIToken(StringRef Source, MIToken &Token,
596 ErrorCallbackType ErrorCallback) {
597 auto C = skipComment(skipWhitespace(Cursor(Source)));
599 Token.reset(MIToken::Eof, C.remaining());
600 return C.remaining();
603 if (Cursor R = maybeLexIntegerOrScalarType(C, Token))
604 return R.remaining();
605 if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
606 return R.remaining();
607 if (Cursor R = maybeLexIdentifier(C, Token))
608 return R.remaining();
609 if (Cursor R = maybeLexJumpTableIndex(C, Token))
610 return R.remaining();
611 if (Cursor R = maybeLexStackObject(C, Token))
612 return R.remaining();
613 if (Cursor R = maybeLexFixedStackObject(C, Token))
614 return R.remaining();
615 if (Cursor R = maybeLexConstantPoolItem(C, Token))
616 return R.remaining();
617 if (Cursor R = maybeLexSubRegisterIndex(C, Token, ErrorCallback))
618 return R.remaining();
619 if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
620 return R.remaining();
621 if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
622 return R.remaining();
623 if (Cursor R = maybeLexRegister(C, Token))
624 return R.remaining();
625 if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
626 return R.remaining();
627 if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
628 return R.remaining();
629 if (Cursor R = maybeLexHexadecimalLiteral(C, Token))
630 return R.remaining();
631 if (Cursor R = maybeLexNumericalLiteral(C, Token))
632 return R.remaining();
633 if (Cursor R = maybeLexExlaim(C, Token, ErrorCallback))
634 return R.remaining();
635 if (Cursor R = maybeLexSymbol(C, Token))
636 return R.remaining();
637 if (Cursor R = maybeLexNewline(C, Token))
638 return R.remaining();
639 if (Cursor R = maybeLexEscapedIRValue(C, Token, ErrorCallback))
640 return R.remaining();
641 if (Cursor R = maybeLexStringConstant(C, Token, ErrorCallback))
642 return R.remaining();
644 Token.reset(MIToken::Error, C.remaining());
645 ErrorCallback(C.location(),
646 Twine("unexpected character '") + Twine(C.peek()) + "'");
647 return C.remaining();