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/StringExtras.h"
16 #include "llvm/ADT/StringSwitch.h"
17 #include "llvm/ADT/Twine.h"
24 /// This class provides a way to iterate and get characters from the source
31 Cursor(NoneType) : Ptr(nullptr), End(nullptr) {}
33 explicit Cursor(StringRef Str) {
35 End = Ptr + Str.size();
38 bool isEOF() const { return Ptr == End; }
40 char peek(int I = 0) const { return End - Ptr <= I ? 0 : Ptr[I]; }
42 void advance(unsigned I = 1) { Ptr += I; }
44 StringRef remaining() const { return StringRef(Ptr, End - Ptr); }
46 StringRef upto(Cursor C) const {
47 assert(C.Ptr >= Ptr && C.Ptr <= End);
48 return StringRef(Ptr, C.Ptr - Ptr);
51 StringRef::iterator location() const { return Ptr; }
53 operator bool() const { return Ptr != nullptr; }
56 } // end anonymous namespace
58 MIToken &MIToken::reset(TokenKind Kind, StringRef Range) {
64 MIToken &MIToken::setStringValue(StringRef StrVal) {
69 MIToken &MIToken::setOwnedStringValue(std::string StrVal) {
70 StringValueStorage = std::move(StrVal);
71 StringValue = StringValueStorage;
75 MIToken &MIToken::setIntegerValue(APSInt IntVal) {
76 this->IntVal = std::move(IntVal);
80 /// Skip the leading whitespace characters and return the updated cursor.
81 static Cursor skipWhitespace(Cursor C) {
82 while (isblank(C.peek()))
87 static bool isNewlineChar(char C) { return C == '\n' || C == '\r'; }
89 /// Skip a line comment and return the updated cursor.
90 static Cursor skipComment(Cursor C) {
93 while (!isNewlineChar(C.peek()) && !C.isEOF())
98 /// Return true if the given character satisfies the following regular
99 /// expression: [-a-zA-Z$._0-9]
100 static bool isIdentifierChar(char C) {
101 return isalpha(C) || isdigit(C) || C == '_' || C == '-' || C == '.' ||
105 /// Unescapes the given string value.
107 /// Expects the string value to be quoted.
108 static std::string unescapeQuotedString(StringRef Value) {
109 assert(Value.front() == '"' && Value.back() == '"');
110 Cursor C = Cursor(Value.substr(1, Value.size() - 2));
113 Str.reserve(C.remaining().size());
115 char Char = C.peek();
117 if (C.peek(1) == '\\') {
118 // Two '\' become one
123 if (isxdigit(C.peek(1)) && isxdigit(C.peek(2))) {
124 Str += hexDigitValue(C.peek(1)) * 16 + hexDigitValue(C.peek(2));
135 /// Lex a string constant using the following regular expression: \"[^\"]*\"
136 static Cursor lexStringConstant(
138 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
139 assert(C.peek() == '"');
140 for (C.advance(); C.peek() != '"'; C.advance()) {
141 if (C.isEOF() || isNewlineChar(C.peek())) {
144 "end of machine instruction reached before the closing '\"'");
152 static Cursor lexName(
153 Cursor C, MIToken &Token, MIToken::TokenKind Type, unsigned PrefixLength,
154 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
156 C.advance(PrefixLength);
157 if (C.peek() == '"') {
158 if (Cursor R = lexStringConstant(C, ErrorCallback)) {
159 StringRef String = Range.upto(R);
160 Token.reset(Type, String)
161 .setOwnedStringValue(
162 unescapeQuotedString(String.drop_front(PrefixLength)));
165 Token.reset(MIToken::Error, Range.remaining());
168 while (isIdentifierChar(C.peek()))
170 Token.reset(Type, Range.upto(C))
171 .setStringValue(Range.upto(C).drop_front(PrefixLength));
175 static Cursor maybeLexIntegerType(Cursor C, MIToken &Token) {
176 if (C.peek() != 'i' || !isdigit(C.peek(1)))
179 C.advance(); // Skip 'i'
180 while (isdigit(C.peek()))
182 Token.reset(MIToken::IntegerType, Range.upto(C));
186 static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
187 return StringSwitch<MIToken::TokenKind>(Identifier)
188 .Case("_", MIToken::underscore)
189 .Case("implicit", MIToken::kw_implicit)
190 .Case("implicit-def", MIToken::kw_implicit_define)
191 .Case("def", MIToken::kw_def)
192 .Case("dead", MIToken::kw_dead)
193 .Case("killed", MIToken::kw_killed)
194 .Case("undef", MIToken::kw_undef)
195 .Case("internal", MIToken::kw_internal)
196 .Case("early-clobber", MIToken::kw_early_clobber)
197 .Case("debug-use", MIToken::kw_debug_use)
198 .Case("tied-def", MIToken::kw_tied_def)
199 .Case("frame-setup", MIToken::kw_frame_setup)
200 .Case("debug-location", MIToken::kw_debug_location)
201 .Case(".cfi_same_value", MIToken::kw_cfi_same_value)
202 .Case(".cfi_offset", MIToken::kw_cfi_offset)
203 .Case(".cfi_def_cfa_register", MIToken::kw_cfi_def_cfa_register)
204 .Case(".cfi_def_cfa_offset", MIToken::kw_cfi_def_cfa_offset)
205 .Case(".cfi_def_cfa", MIToken::kw_cfi_def_cfa)
206 .Case("blockaddress", MIToken::kw_blockaddress)
207 .Case("target-index", MIToken::kw_target_index)
208 .Case("half", MIToken::kw_half)
209 .Case("float", MIToken::kw_float)
210 .Case("double", MIToken::kw_double)
211 .Case("x86_fp80", MIToken::kw_x86_fp80)
212 .Case("fp128", MIToken::kw_fp128)
213 .Case("ppc_fp128", MIToken::kw_ppc_fp128)
214 .Case("target-flags", MIToken::kw_target_flags)
215 .Case("volatile", MIToken::kw_volatile)
216 .Case("non-temporal", MIToken::kw_non_temporal)
217 .Case("invariant", MIToken::kw_invariant)
218 .Case("align", MIToken::kw_align)
219 .Case("stack", MIToken::kw_stack)
220 .Case("got", MIToken::kw_got)
221 .Case("jump-table", MIToken::kw_jump_table)
222 .Case("constant-pool", MIToken::kw_constant_pool)
223 .Case("liveout", MIToken::kw_liveout)
224 .Case("address-taken", MIToken::kw_address_taken)
225 .Case("landing-pad", MIToken::kw_landing_pad)
226 .Case("liveins", MIToken::kw_liveins)
227 .Case("successors", MIToken::kw_successors)
228 .Default(MIToken::Identifier);
231 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
232 if (!isalpha(C.peek()) && C.peek() != '_' && C.peek() != '.')
235 while (isIdentifierChar(C.peek()))
237 auto Identifier = Range.upto(C);
238 Token.reset(getIdentifierKind(Identifier), Identifier)
239 .setStringValue(Identifier);
243 static Cursor maybeLexMachineBasicBlock(
244 Cursor C, MIToken &Token,
245 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
246 bool IsReference = C.remaining().startswith("%bb.");
247 if (!IsReference && !C.remaining().startswith("bb."))
250 unsigned PrefixLength = IsReference ? 4 : 3;
251 C.advance(PrefixLength); // Skip '%bb.' or 'bb.'
252 if (!isdigit(C.peek())) {
253 Token.reset(MIToken::Error, C.remaining());
254 ErrorCallback(C.location(), "expected a number after '%bb.'");
257 auto NumberRange = C;
258 while (isdigit(C.peek()))
260 StringRef Number = NumberRange.upto(C);
261 unsigned StringOffset = PrefixLength + Number.size(); // Drop '%bb.<id>'
262 if (C.peek() == '.') {
263 C.advance(); // Skip '.'
265 while (isIdentifierChar(C.peek()))
268 Token.reset(IsReference ? MIToken::MachineBasicBlock
269 : MIToken::MachineBasicBlockLabel,
271 .setIntegerValue(APSInt(Number))
272 .setStringValue(Range.upto(C).drop_front(StringOffset));
276 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
277 MIToken::TokenKind Kind) {
278 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
281 C.advance(Rule.size());
282 auto NumberRange = C;
283 while (isdigit(C.peek()))
285 Token.reset(Kind, Range.upto(C)).setIntegerValue(APSInt(NumberRange.upto(C)));
289 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
290 MIToken::TokenKind Kind) {
291 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
294 C.advance(Rule.size());
295 auto NumberRange = C;
296 while (isdigit(C.peek()))
298 StringRef Number = NumberRange.upto(C);
299 unsigned StringOffset = Rule.size() + Number.size();
300 if (C.peek() == '.') {
303 while (isIdentifierChar(C.peek()))
306 Token.reset(Kind, Range.upto(C))
307 .setIntegerValue(APSInt(Number))
308 .setStringValue(Range.upto(C).drop_front(StringOffset));
312 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
313 return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
316 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
317 return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
320 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
321 return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
324 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
325 return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
328 static Cursor maybeLexIRBlock(
329 Cursor C, MIToken &Token,
330 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
331 const StringRef Rule = "%ir-block.";
332 if (!C.remaining().startswith(Rule))
334 if (isdigit(C.peek(Rule.size())))
335 return maybeLexIndex(C, Token, Rule, MIToken::IRBlock);
336 return lexName(C, Token, MIToken::NamedIRBlock, Rule.size(), ErrorCallback);
339 static Cursor maybeLexIRValue(
340 Cursor C, MIToken &Token,
341 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
342 const StringRef Rule = "%ir.";
343 if (!C.remaining().startswith(Rule))
345 if (isdigit(C.peek(Rule.size())))
346 return maybeLexIndex(C, Token, Rule, MIToken::IRValue);
347 return lexName(C, Token, MIToken::NamedIRValue, Rule.size(), ErrorCallback);
350 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
352 C.advance(); // Skip '%'
353 auto NumberRange = C;
354 while (isdigit(C.peek()))
356 Token.reset(MIToken::VirtualRegister, Range.upto(C))
357 .setIntegerValue(APSInt(NumberRange.upto(C)));
361 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
364 if (isdigit(C.peek(1)))
365 return lexVirtualRegister(C, Token);
367 C.advance(); // Skip '%'
368 while (isIdentifierChar(C.peek()))
370 Token.reset(MIToken::NamedRegister, Range.upto(C))
371 .setStringValue(Range.upto(C).drop_front(1)); // Drop the '%'
375 static Cursor maybeLexGlobalValue(
376 Cursor C, MIToken &Token,
377 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
380 if (!isdigit(C.peek(1)))
381 return lexName(C, Token, MIToken::NamedGlobalValue, /*PrefixLength=*/1,
384 C.advance(1); // Skip the '@'
385 auto NumberRange = C;
386 while (isdigit(C.peek()))
388 Token.reset(MIToken::GlobalValue, Range.upto(C))
389 .setIntegerValue(APSInt(NumberRange.upto(C)));
393 static Cursor maybeLexExternalSymbol(
394 Cursor C, MIToken &Token,
395 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
398 return lexName(C, Token, MIToken::ExternalSymbol, /*PrefixLength=*/1,
402 static bool isValidHexFloatingPointPrefix(char C) {
403 return C == 'H' || C == 'K' || C == 'L' || C == 'M';
406 static Cursor maybeLexHexFloatingPointLiteral(Cursor C, MIToken &Token) {
407 if (C.peek() != '0' || C.peek(1) != 'x')
410 C.advance(2); // Skip '0x'
411 if (isValidHexFloatingPointPrefix(C.peek()))
413 while (isxdigit(C.peek()))
415 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
419 static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
421 // Skip over [0-9]*([eE][-+]?[0-9]+)?
422 while (isdigit(C.peek()))
424 if ((C.peek() == 'e' || C.peek() == 'E') &&
425 (isdigit(C.peek(1)) ||
426 ((C.peek(1) == '-' || C.peek(1) == '+') && isdigit(C.peek(2))))) {
428 while (isdigit(C.peek()))
431 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
435 static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
436 if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
440 while (isdigit(C.peek()))
443 return lexFloatingPointLiteral(Range, C, Token);
444 StringRef StrVal = Range.upto(C);
445 Token.reset(MIToken::IntegerLiteral, StrVal).setIntegerValue(APSInt(StrVal));
449 static MIToken::TokenKind getMetadataKeywordKind(StringRef Identifier) {
450 return StringSwitch<MIToken::TokenKind>(Identifier)
451 .Case("!tbaa", MIToken::md_tbaa)
452 .Case("!alias.scope", MIToken::md_alias_scope)
453 .Case("!noalias", MIToken::md_noalias)
454 .Case("!range", MIToken::md_range)
455 .Default(MIToken::Error);
458 static Cursor maybeLexExlaim(
459 Cursor C, MIToken &Token,
460 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
465 if (isdigit(C.peek()) || !isIdentifierChar(C.peek())) {
466 Token.reset(MIToken::exclaim, Range.upto(C));
469 while (isIdentifierChar(C.peek()))
471 StringRef StrVal = Range.upto(C);
472 Token.reset(getMetadataKeywordKind(StrVal), StrVal);
474 ErrorCallback(Token.location(),
475 "use of unknown metadata keyword '" + StrVal + "'");
479 static MIToken::TokenKind symbolToken(char C) {
482 return MIToken::comma;
484 return MIToken::equal;
486 return MIToken::colon;
488 return MIToken::lparen;
490 return MIToken::rparen;
492 return MIToken::lbrace;
494 return MIToken::rbrace;
496 return MIToken::plus;
498 return MIToken::minus;
500 return MIToken::Error;
504 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
505 MIToken::TokenKind Kind;
507 if (C.peek() == ':' && C.peek(1) == ':') {
508 Kind = MIToken::coloncolon;
511 Kind = symbolToken(C.peek());
512 if (Kind == MIToken::Error)
516 Token.reset(Kind, Range.upto(C));
520 static Cursor maybeLexNewline(Cursor C, MIToken &Token) {
521 if (!isNewlineChar(C.peek()))
525 Token.reset(MIToken::Newline, Range.upto(C));
529 StringRef llvm::lexMIToken(
530 StringRef Source, MIToken &Token,
531 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
532 auto C = skipComment(skipWhitespace(Cursor(Source)));
534 Token.reset(MIToken::Eof, C.remaining());
535 return C.remaining();
538 if (Cursor R = maybeLexIntegerType(C, Token))
539 return R.remaining();
540 if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
541 return R.remaining();
542 if (Cursor R = maybeLexIdentifier(C, Token))
543 return R.remaining();
544 if (Cursor R = maybeLexJumpTableIndex(C, Token))
545 return R.remaining();
546 if (Cursor R = maybeLexStackObject(C, Token))
547 return R.remaining();
548 if (Cursor R = maybeLexFixedStackObject(C, Token))
549 return R.remaining();
550 if (Cursor R = maybeLexConstantPoolItem(C, Token))
551 return R.remaining();
552 if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
553 return R.remaining();
554 if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
555 return R.remaining();
556 if (Cursor R = maybeLexRegister(C, Token))
557 return R.remaining();
558 if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
559 return R.remaining();
560 if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
561 return R.remaining();
562 if (Cursor R = maybeLexHexFloatingPointLiteral(C, Token))
563 return R.remaining();
564 if (Cursor R = maybeLexNumericalLiteral(C, Token))
565 return R.remaining();
566 if (Cursor R = maybeLexExlaim(C, Token, ErrorCallback))
567 return R.remaining();
568 if (Cursor R = maybeLexSymbol(C, Token))
569 return R.remaining();
570 if (Cursor R = maybeLexNewline(C, Token))
571 return R.remaining();
573 Token.reset(MIToken::Error, C.remaining());
574 ErrorCallback(C.location(),
575 Twine("unexpected character '") + Twine(C.peek()) + "'");
576 return C.remaining();