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 (isspace(C.peek()))
87 /// Return true if the given character satisfies the following regular
88 /// expression: [-a-zA-Z$._0-9]
89 static bool isIdentifierChar(char C) {
90 return isalpha(C) || isdigit(C) || C == '_' || C == '-' || C == '.' ||
94 /// Unescapes the given string value.
96 /// Expects the string value to be quoted.
97 static std::string unescapeQuotedString(StringRef Value) {
98 assert(Value.front() == '"' && Value.back() == '"');
99 Cursor C = Cursor(Value.substr(1, Value.size() - 2));
102 Str.reserve(C.remaining().size());
104 char Char = C.peek();
106 if (C.peek(1) == '\\') {
107 // Two '\' become one
112 if (isxdigit(C.peek(1)) && isxdigit(C.peek(2))) {
113 Str += hexDigitValue(C.peek(1)) * 16 + hexDigitValue(C.peek(2));
124 /// Lex a string constant using the following regular expression: \"[^\"]*\"
125 static Cursor lexStringConstant(
127 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
128 assert(C.peek() == '"');
129 for (C.advance(); C.peek() != '"'; C.advance()) {
133 "end of machine instruction reached before the closing '\"'");
141 static Cursor lexName(
142 Cursor C, MIToken &Token, MIToken::TokenKind Type, unsigned PrefixLength,
143 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
145 C.advance(PrefixLength);
146 if (C.peek() == '"') {
147 if (Cursor R = lexStringConstant(C, ErrorCallback)) {
148 StringRef String = Range.upto(R);
149 Token.reset(Type, String)
150 .setOwnedStringValue(
151 unescapeQuotedString(String.drop_front(PrefixLength)));
154 Token.reset(MIToken::Error, Range.remaining());
157 while (isIdentifierChar(C.peek()))
159 Token.reset(Type, Range.upto(C))
160 .setStringValue(Range.upto(C).drop_front(PrefixLength));
164 static Cursor maybeLexIntegerType(Cursor C, MIToken &Token) {
165 if (C.peek() != 'i' || !isdigit(C.peek(1)))
168 C.advance(); // Skip 'i'
169 while (isdigit(C.peek()))
171 Token.reset(MIToken::IntegerType, Range.upto(C));
175 static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
176 return StringSwitch<MIToken::TokenKind>(Identifier)
177 .Case("_", MIToken::underscore)
178 .Case("implicit", MIToken::kw_implicit)
179 .Case("implicit-def", MIToken::kw_implicit_define)
180 .Case("dead", MIToken::kw_dead)
181 .Case("killed", MIToken::kw_killed)
182 .Case("undef", MIToken::kw_undef)
183 .Case("early-clobber", MIToken::kw_early_clobber)
184 .Case("debug-use", MIToken::kw_debug_use)
185 .Case("frame-setup", MIToken::kw_frame_setup)
186 .Case("debug-location", MIToken::kw_debug_location)
187 .Case(".cfi_offset", MIToken::kw_cfi_offset)
188 .Case(".cfi_def_cfa_register", MIToken::kw_cfi_def_cfa_register)
189 .Case(".cfi_def_cfa_offset", MIToken::kw_cfi_def_cfa_offset)
190 .Case(".cfi_def_cfa", MIToken::kw_cfi_def_cfa)
191 .Case("blockaddress", MIToken::kw_blockaddress)
192 .Case("target-index", MIToken::kw_target_index)
193 .Case("half", MIToken::kw_half)
194 .Case("float", MIToken::kw_float)
195 .Case("double", MIToken::kw_double)
196 .Case("x86_fp80", MIToken::kw_x86_fp80)
197 .Case("fp128", MIToken::kw_fp128)
198 .Case("ppc_fp128", MIToken::kw_ppc_fp128)
199 .Case("target-flags", MIToken::kw_target_flags)
200 .Case("volatile", MIToken::kw_volatile)
201 .Case("non-temporal", MIToken::kw_non_temporal)
202 .Case("invariant", MIToken::kw_invariant)
203 .Case("align", MIToken::kw_align)
204 .Case("liveout", MIToken::kw_liveout)
205 .Default(MIToken::Identifier);
208 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
209 if (!isalpha(C.peek()) && C.peek() != '_' && C.peek() != '.')
212 while (isIdentifierChar(C.peek()))
214 auto Identifier = Range.upto(C);
215 Token.reset(getIdentifierKind(Identifier), Identifier)
216 .setStringValue(Identifier);
220 static Cursor maybeLexMachineBasicBlock(
221 Cursor C, MIToken &Token,
222 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
223 if (!C.remaining().startswith("%bb."))
226 C.advance(4); // Skip '%bb.'
227 if (!isdigit(C.peek())) {
228 Token.reset(MIToken::Error, C.remaining());
229 ErrorCallback(C.location(), "expected a number after '%bb.'");
232 auto NumberRange = C;
233 while (isdigit(C.peek()))
235 StringRef Number = NumberRange.upto(C);
236 unsigned StringOffset = 4 + Number.size(); // Drop '%bb.<id>'
237 if (C.peek() == '.') {
238 C.advance(); // Skip '.'
240 while (isIdentifierChar(C.peek()))
243 Token.reset(MIToken::MachineBasicBlock, Range.upto(C))
244 .setIntegerValue(APSInt(Number))
245 .setStringValue(Range.upto(C).drop_front(StringOffset));
249 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
250 MIToken::TokenKind Kind) {
251 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
254 C.advance(Rule.size());
255 auto NumberRange = C;
256 while (isdigit(C.peek()))
258 Token.reset(Kind, Range.upto(C)).setIntegerValue(APSInt(NumberRange.upto(C)));
262 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
263 MIToken::TokenKind Kind) {
264 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
267 C.advance(Rule.size());
268 auto NumberRange = C;
269 while (isdigit(C.peek()))
271 StringRef Number = NumberRange.upto(C);
272 unsigned StringOffset = Rule.size() + Number.size();
273 if (C.peek() == '.') {
276 while (isIdentifierChar(C.peek()))
279 Token.reset(Kind, Range.upto(C))
280 .setIntegerValue(APSInt(Number))
281 .setStringValue(Range.upto(C).drop_front(StringOffset));
285 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
286 return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
289 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
290 return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
293 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
294 return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
297 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
298 return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
301 static Cursor maybeLexIRBlock(
302 Cursor C, MIToken &Token,
303 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
304 const StringRef Rule = "%ir-block.";
305 if (!C.remaining().startswith(Rule))
307 if (isdigit(C.peek(Rule.size())))
308 return maybeLexIndex(C, Token, Rule, MIToken::IRBlock);
309 return lexName(C, Token, MIToken::NamedIRBlock, Rule.size(), ErrorCallback);
312 static Cursor maybeLexIRValue(
313 Cursor C, MIToken &Token,
314 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
315 const StringRef Rule = "%ir.";
316 if (!C.remaining().startswith(Rule))
318 return lexName(C, Token, MIToken::NamedIRValue, Rule.size(), ErrorCallback);
321 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
323 C.advance(); // Skip '%'
324 auto NumberRange = C;
325 while (isdigit(C.peek()))
327 Token.reset(MIToken::VirtualRegister, Range.upto(C))
328 .setIntegerValue(APSInt(NumberRange.upto(C)));
332 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
335 if (isdigit(C.peek(1)))
336 return lexVirtualRegister(C, Token);
338 C.advance(); // Skip '%'
339 while (isIdentifierChar(C.peek()))
341 Token.reset(MIToken::NamedRegister, Range.upto(C))
342 .setStringValue(Range.upto(C).drop_front(1)); // Drop the '%'
346 static Cursor maybeLexGlobalValue(
347 Cursor C, MIToken &Token,
348 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
351 if (!isdigit(C.peek(1)))
352 return lexName(C, Token, MIToken::NamedGlobalValue, /*PrefixLength=*/1,
355 C.advance(1); // Skip the '@'
356 auto NumberRange = C;
357 while (isdigit(C.peek()))
359 Token.reset(MIToken::GlobalValue, Range.upto(C))
360 .setIntegerValue(APSInt(NumberRange.upto(C)));
364 static Cursor maybeLexExternalSymbol(
365 Cursor C, MIToken &Token,
366 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
369 return lexName(C, Token, MIToken::ExternalSymbol, /*PrefixLength=*/1,
373 static bool isValidHexFloatingPointPrefix(char C) {
374 return C == 'H' || C == 'K' || C == 'L' || C == 'M';
377 static Cursor maybeLexHexFloatingPointLiteral(Cursor C, MIToken &Token) {
378 if (C.peek() != '0' || C.peek(1) != 'x')
381 C.advance(2); // Skip '0x'
382 if (isValidHexFloatingPointPrefix(C.peek()))
384 while (isxdigit(C.peek()))
386 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
390 static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
392 // Skip over [0-9]*([eE][-+]?[0-9]+)?
393 while (isdigit(C.peek()))
395 if ((C.peek() == 'e' || C.peek() == 'E') &&
396 (isdigit(C.peek(1)) ||
397 ((C.peek(1) == '-' || C.peek(1) == '+') && isdigit(C.peek(2))))) {
399 while (isdigit(C.peek()))
402 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
406 static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
407 if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
411 while (isdigit(C.peek()))
414 return lexFloatingPointLiteral(Range, C, Token);
415 StringRef StrVal = Range.upto(C);
416 Token.reset(MIToken::IntegerLiteral, StrVal).setIntegerValue(APSInt(StrVal));
420 static MIToken::TokenKind symbolToken(char C) {
423 return MIToken::comma;
425 return MIToken::equal;
427 return MIToken::colon;
429 return MIToken::exclaim;
431 return MIToken::lparen;
433 return MIToken::rparen;
435 return MIToken::plus;
437 return MIToken::minus;
439 return MIToken::Error;
443 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
444 MIToken::TokenKind Kind;
446 if (C.peek() == ':' && C.peek(1) == ':') {
447 Kind = MIToken::coloncolon;
450 Kind = symbolToken(C.peek());
451 if (Kind == MIToken::Error)
455 Token.reset(Kind, Range.upto(C));
459 StringRef llvm::lexMIToken(
460 StringRef Source, MIToken &Token,
461 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
462 auto C = skipWhitespace(Cursor(Source));
464 Token.reset(MIToken::Eof, C.remaining());
465 return C.remaining();
468 if (Cursor R = maybeLexIntegerType(C, Token))
469 return R.remaining();
470 if (Cursor R = maybeLexIdentifier(C, Token))
471 return R.remaining();
472 if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
473 return R.remaining();
474 if (Cursor R = maybeLexJumpTableIndex(C, Token))
475 return R.remaining();
476 if (Cursor R = maybeLexStackObject(C, Token))
477 return R.remaining();
478 if (Cursor R = maybeLexFixedStackObject(C, Token))
479 return R.remaining();
480 if (Cursor R = maybeLexConstantPoolItem(C, Token))
481 return R.remaining();
482 if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
483 return R.remaining();
484 if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
485 return R.remaining();
486 if (Cursor R = maybeLexRegister(C, Token))
487 return R.remaining();
488 if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
489 return R.remaining();
490 if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
491 return R.remaining();
492 if (Cursor R = maybeLexHexFloatingPointLiteral(C, Token))
493 return R.remaining();
494 if (Cursor R = maybeLexNumericalLiteral(C, Token))
495 return R.remaining();
496 if (Cursor R = maybeLexSymbol(C, Token))
497 return R.remaining();
499 Token.reset(MIToken::Error, C.remaining());
500 ErrorCallback(C.location(),
501 Twine("unexpected character '") + Twine(C.peek()) + "'");
502 return C.remaining();