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("stack", MIToken::kw_stack)
205 .Case("got", MIToken::kw_got)
206 .Case("constant-pool", MIToken::kw_constant_pool)
207 .Case("liveout", MIToken::kw_liveout)
208 .Default(MIToken::Identifier);
211 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
212 if (!isalpha(C.peek()) && C.peek() != '_' && C.peek() != '.')
215 while (isIdentifierChar(C.peek()))
217 auto Identifier = Range.upto(C);
218 Token.reset(getIdentifierKind(Identifier), Identifier)
219 .setStringValue(Identifier);
223 static Cursor maybeLexMachineBasicBlock(
224 Cursor C, MIToken &Token,
225 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
226 if (!C.remaining().startswith("%bb."))
229 C.advance(4); // Skip '%bb.'
230 if (!isdigit(C.peek())) {
231 Token.reset(MIToken::Error, C.remaining());
232 ErrorCallback(C.location(), "expected a number after '%bb.'");
235 auto NumberRange = C;
236 while (isdigit(C.peek()))
238 StringRef Number = NumberRange.upto(C);
239 unsigned StringOffset = 4 + Number.size(); // Drop '%bb.<id>'
240 if (C.peek() == '.') {
241 C.advance(); // Skip '.'
243 while (isIdentifierChar(C.peek()))
246 Token.reset(MIToken::MachineBasicBlock, Range.upto(C))
247 .setIntegerValue(APSInt(Number))
248 .setStringValue(Range.upto(C).drop_front(StringOffset));
252 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
253 MIToken::TokenKind Kind) {
254 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
257 C.advance(Rule.size());
258 auto NumberRange = C;
259 while (isdigit(C.peek()))
261 Token.reset(Kind, Range.upto(C)).setIntegerValue(APSInt(NumberRange.upto(C)));
265 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
266 MIToken::TokenKind Kind) {
267 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
270 C.advance(Rule.size());
271 auto NumberRange = C;
272 while (isdigit(C.peek()))
274 StringRef Number = NumberRange.upto(C);
275 unsigned StringOffset = Rule.size() + Number.size();
276 if (C.peek() == '.') {
279 while (isIdentifierChar(C.peek()))
282 Token.reset(Kind, Range.upto(C))
283 .setIntegerValue(APSInt(Number))
284 .setStringValue(Range.upto(C).drop_front(StringOffset));
288 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
289 return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
292 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
293 return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
296 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
297 return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
300 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
301 return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
304 static Cursor maybeLexIRBlock(
305 Cursor C, MIToken &Token,
306 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
307 const StringRef Rule = "%ir-block.";
308 if (!C.remaining().startswith(Rule))
310 if (isdigit(C.peek(Rule.size())))
311 return maybeLexIndex(C, Token, Rule, MIToken::IRBlock);
312 return lexName(C, Token, MIToken::NamedIRBlock, Rule.size(), ErrorCallback);
315 static Cursor maybeLexIRValue(
316 Cursor C, MIToken &Token,
317 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
318 const StringRef Rule = "%ir.";
319 if (!C.remaining().startswith(Rule))
321 return lexName(C, Token, MIToken::NamedIRValue, Rule.size(), ErrorCallback);
324 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
326 C.advance(); // Skip '%'
327 auto NumberRange = C;
328 while (isdigit(C.peek()))
330 Token.reset(MIToken::VirtualRegister, Range.upto(C))
331 .setIntegerValue(APSInt(NumberRange.upto(C)));
335 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
338 if (isdigit(C.peek(1)))
339 return lexVirtualRegister(C, Token);
341 C.advance(); // Skip '%'
342 while (isIdentifierChar(C.peek()))
344 Token.reset(MIToken::NamedRegister, Range.upto(C))
345 .setStringValue(Range.upto(C).drop_front(1)); // Drop the '%'
349 static Cursor maybeLexGlobalValue(
350 Cursor C, MIToken &Token,
351 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
354 if (!isdigit(C.peek(1)))
355 return lexName(C, Token, MIToken::NamedGlobalValue, /*PrefixLength=*/1,
358 C.advance(1); // Skip the '@'
359 auto NumberRange = C;
360 while (isdigit(C.peek()))
362 Token.reset(MIToken::GlobalValue, Range.upto(C))
363 .setIntegerValue(APSInt(NumberRange.upto(C)));
367 static Cursor maybeLexExternalSymbol(
368 Cursor C, MIToken &Token,
369 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
372 return lexName(C, Token, MIToken::ExternalSymbol, /*PrefixLength=*/1,
376 static bool isValidHexFloatingPointPrefix(char C) {
377 return C == 'H' || C == 'K' || C == 'L' || C == 'M';
380 static Cursor maybeLexHexFloatingPointLiteral(Cursor C, MIToken &Token) {
381 if (C.peek() != '0' || C.peek(1) != 'x')
384 C.advance(2); // Skip '0x'
385 if (isValidHexFloatingPointPrefix(C.peek()))
387 while (isxdigit(C.peek()))
389 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
393 static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
395 // Skip over [0-9]*([eE][-+]?[0-9]+)?
396 while (isdigit(C.peek()))
398 if ((C.peek() == 'e' || C.peek() == 'E') &&
399 (isdigit(C.peek(1)) ||
400 ((C.peek(1) == '-' || C.peek(1) == '+') && isdigit(C.peek(2))))) {
402 while (isdigit(C.peek()))
405 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
409 static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
410 if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
414 while (isdigit(C.peek()))
417 return lexFloatingPointLiteral(Range, C, Token);
418 StringRef StrVal = Range.upto(C);
419 Token.reset(MIToken::IntegerLiteral, StrVal).setIntegerValue(APSInt(StrVal));
423 static MIToken::TokenKind symbolToken(char C) {
426 return MIToken::comma;
428 return MIToken::equal;
430 return MIToken::colon;
432 return MIToken::exclaim;
434 return MIToken::lparen;
436 return MIToken::rparen;
438 return MIToken::plus;
440 return MIToken::minus;
442 return MIToken::Error;
446 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
447 MIToken::TokenKind Kind;
449 if (C.peek() == ':' && C.peek(1) == ':') {
450 Kind = MIToken::coloncolon;
453 Kind = symbolToken(C.peek());
454 if (Kind == MIToken::Error)
458 Token.reset(Kind, Range.upto(C));
462 StringRef llvm::lexMIToken(
463 StringRef Source, MIToken &Token,
464 function_ref<void(StringRef::iterator Loc, const Twine &)> ErrorCallback) {
465 auto C = skipWhitespace(Cursor(Source));
467 Token.reset(MIToken::Eof, C.remaining());
468 return C.remaining();
471 if (Cursor R = maybeLexIntegerType(C, Token))
472 return R.remaining();
473 if (Cursor R = maybeLexIdentifier(C, Token))
474 return R.remaining();
475 if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
476 return R.remaining();
477 if (Cursor R = maybeLexJumpTableIndex(C, Token))
478 return R.remaining();
479 if (Cursor R = maybeLexStackObject(C, Token))
480 return R.remaining();
481 if (Cursor R = maybeLexFixedStackObject(C, Token))
482 return R.remaining();
483 if (Cursor R = maybeLexConstantPoolItem(C, Token))
484 return R.remaining();
485 if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
486 return R.remaining();
487 if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
488 return R.remaining();
489 if (Cursor R = maybeLexRegister(C, Token))
490 return R.remaining();
491 if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
492 return R.remaining();
493 if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
494 return R.remaining();
495 if (Cursor R = maybeLexHexFloatingPointLiteral(C, Token))
496 return R.remaining();
497 if (Cursor R = maybeLexNumericalLiteral(C, Token))
498 return R.remaining();
499 if (Cursor R = maybeLexSymbol(C, Token))
500 return R.remaining();
502 Token.reset(MIToken::Error, C.remaining());
503 ErrorCallback(C.location(),
504 Twine("unexpected character '") + Twine(C.peek()) + "'");
505 return C.remaining();