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 maybeLexIntegerType(Cursor C, MIToken &Token) {
177 if (C.peek() != 'i' || !isdigit(C.peek(1)))
180 C.advance(); // Skip 'i'
181 while (isdigit(C.peek()))
183 Token.reset(MIToken::IntegerType, Range.upto(C));
187 static MIToken::TokenKind getIdentifierKind(StringRef Identifier) {
188 return StringSwitch<MIToken::TokenKind>(Identifier)
189 .Case("_", MIToken::underscore)
190 .Case("implicit", MIToken::kw_implicit)
191 .Case("implicit-def", MIToken::kw_implicit_define)
192 .Case("def", MIToken::kw_def)
193 .Case("dead", MIToken::kw_dead)
194 .Case("killed", MIToken::kw_killed)
195 .Case("undef", MIToken::kw_undef)
196 .Case("internal", MIToken::kw_internal)
197 .Case("early-clobber", MIToken::kw_early_clobber)
198 .Case("debug-use", MIToken::kw_debug_use)
199 .Case("tied-def", MIToken::kw_tied_def)
200 .Case("frame-setup", MIToken::kw_frame_setup)
201 .Case("debug-location", MIToken::kw_debug_location)
202 .Case(".cfi_same_value", MIToken::kw_cfi_same_value)
203 .Case(".cfi_offset", MIToken::kw_cfi_offset)
204 .Case(".cfi_def_cfa_register", MIToken::kw_cfi_def_cfa_register)
205 .Case(".cfi_def_cfa_offset", MIToken::kw_cfi_def_cfa_offset)
206 .Case(".cfi_def_cfa", MIToken::kw_cfi_def_cfa)
207 .Case("blockaddress", MIToken::kw_blockaddress)
208 .Case("target-index", MIToken::kw_target_index)
209 .Case("half", MIToken::kw_half)
210 .Case("float", MIToken::kw_float)
211 .Case("double", MIToken::kw_double)
212 .Case("x86_fp80", MIToken::kw_x86_fp80)
213 .Case("fp128", MIToken::kw_fp128)
214 .Case("ppc_fp128", MIToken::kw_ppc_fp128)
215 .Case("target-flags", MIToken::kw_target_flags)
216 .Case("volatile", MIToken::kw_volatile)
217 .Case("non-temporal", MIToken::kw_non_temporal)
218 .Case("invariant", MIToken::kw_invariant)
219 .Case("align", MIToken::kw_align)
220 .Case("stack", MIToken::kw_stack)
221 .Case("got", MIToken::kw_got)
222 .Case("jump-table", MIToken::kw_jump_table)
223 .Case("constant-pool", MIToken::kw_constant_pool)
224 .Case("call-entry", MIToken::kw_call_entry)
225 .Case("liveout", MIToken::kw_liveout)
226 .Case("address-taken", MIToken::kw_address_taken)
227 .Case("landing-pad", MIToken::kw_landing_pad)
228 .Case("liveins", MIToken::kw_liveins)
229 .Case("successors", MIToken::kw_successors)
230 .Default(MIToken::Identifier);
233 static Cursor maybeLexIdentifier(Cursor C, MIToken &Token) {
234 if (!isalpha(C.peek()) && C.peek() != '_' && C.peek() != '.')
237 while (isIdentifierChar(C.peek()))
239 auto Identifier = Range.upto(C);
240 Token.reset(getIdentifierKind(Identifier), Identifier)
241 .setStringValue(Identifier);
245 static Cursor maybeLexMachineBasicBlock(Cursor C, MIToken &Token,
246 ErrorCallbackType ErrorCallback) {
247 bool IsReference = C.remaining().startswith("%bb.");
248 if (!IsReference && !C.remaining().startswith("bb."))
251 unsigned PrefixLength = IsReference ? 4 : 3;
252 C.advance(PrefixLength); // Skip '%bb.' or 'bb.'
253 if (!isdigit(C.peek())) {
254 Token.reset(MIToken::Error, C.remaining());
255 ErrorCallback(C.location(), "expected a number after '%bb.'");
258 auto NumberRange = C;
259 while (isdigit(C.peek()))
261 StringRef Number = NumberRange.upto(C);
262 unsigned StringOffset = PrefixLength + Number.size(); // Drop '%bb.<id>'
263 if (C.peek() == '.') {
264 C.advance(); // Skip '.'
266 while (isIdentifierChar(C.peek()))
269 Token.reset(IsReference ? MIToken::MachineBasicBlock
270 : MIToken::MachineBasicBlockLabel,
272 .setIntegerValue(APSInt(Number))
273 .setStringValue(Range.upto(C).drop_front(StringOffset));
277 static Cursor maybeLexIndex(Cursor C, MIToken &Token, StringRef Rule,
278 MIToken::TokenKind Kind) {
279 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
282 C.advance(Rule.size());
283 auto NumberRange = C;
284 while (isdigit(C.peek()))
286 Token.reset(Kind, Range.upto(C)).setIntegerValue(APSInt(NumberRange.upto(C)));
290 static Cursor maybeLexIndexAndName(Cursor C, MIToken &Token, StringRef Rule,
291 MIToken::TokenKind Kind) {
292 if (!C.remaining().startswith(Rule) || !isdigit(C.peek(Rule.size())))
295 C.advance(Rule.size());
296 auto NumberRange = C;
297 while (isdigit(C.peek()))
299 StringRef Number = NumberRange.upto(C);
300 unsigned StringOffset = Rule.size() + Number.size();
301 if (C.peek() == '.') {
304 while (isIdentifierChar(C.peek()))
307 Token.reset(Kind, Range.upto(C))
308 .setIntegerValue(APSInt(Number))
309 .setStringValue(Range.upto(C).drop_front(StringOffset));
313 static Cursor maybeLexJumpTableIndex(Cursor C, MIToken &Token) {
314 return maybeLexIndex(C, Token, "%jump-table.", MIToken::JumpTableIndex);
317 static Cursor maybeLexStackObject(Cursor C, MIToken &Token) {
318 return maybeLexIndexAndName(C, Token, "%stack.", MIToken::StackObject);
321 static Cursor maybeLexFixedStackObject(Cursor C, MIToken &Token) {
322 return maybeLexIndex(C, Token, "%fixed-stack.", MIToken::FixedStackObject);
325 static Cursor maybeLexConstantPoolItem(Cursor C, MIToken &Token) {
326 return maybeLexIndex(C, Token, "%const.", MIToken::ConstantPoolItem);
329 static Cursor maybeLexSubRegisterIndex(Cursor C, MIToken &Token,
330 ErrorCallbackType ErrorCallback) {
331 const StringRef Rule = "%subreg.";
332 if (!C.remaining().startswith(Rule))
334 return lexName(C, Token, MIToken::SubRegisterIndex, Rule.size(),
338 static Cursor maybeLexIRBlock(Cursor C, MIToken &Token,
339 ErrorCallbackType ErrorCallback) {
340 const StringRef Rule = "%ir-block.";
341 if (!C.remaining().startswith(Rule))
343 if (isdigit(C.peek(Rule.size())))
344 return maybeLexIndex(C, Token, Rule, MIToken::IRBlock);
345 return lexName(C, Token, MIToken::NamedIRBlock, Rule.size(), ErrorCallback);
348 static Cursor maybeLexIRValue(Cursor C, MIToken &Token,
349 ErrorCallbackType ErrorCallback) {
350 const StringRef Rule = "%ir.";
351 if (!C.remaining().startswith(Rule))
353 if (isdigit(C.peek(Rule.size())))
354 return maybeLexIndex(C, Token, Rule, MIToken::IRValue);
355 return lexName(C, Token, MIToken::NamedIRValue, Rule.size(), ErrorCallback);
358 static Cursor lexVirtualRegister(Cursor C, MIToken &Token) {
360 C.advance(); // Skip '%'
361 auto NumberRange = C;
362 while (isdigit(C.peek()))
364 Token.reset(MIToken::VirtualRegister, Range.upto(C))
365 .setIntegerValue(APSInt(NumberRange.upto(C)));
369 static Cursor maybeLexRegister(Cursor C, MIToken &Token) {
372 if (isdigit(C.peek(1)))
373 return lexVirtualRegister(C, Token);
375 C.advance(); // Skip '%'
376 while (isIdentifierChar(C.peek()))
378 Token.reset(MIToken::NamedRegister, Range.upto(C))
379 .setStringValue(Range.upto(C).drop_front(1)); // Drop the '%'
383 static Cursor maybeLexGlobalValue(Cursor C, MIToken &Token,
384 ErrorCallbackType ErrorCallback) {
387 if (!isdigit(C.peek(1)))
388 return lexName(C, Token, MIToken::NamedGlobalValue, /*PrefixLength=*/1,
391 C.advance(1); // Skip the '@'
392 auto NumberRange = C;
393 while (isdigit(C.peek()))
395 Token.reset(MIToken::GlobalValue, Range.upto(C))
396 .setIntegerValue(APSInt(NumberRange.upto(C)));
400 static Cursor maybeLexExternalSymbol(Cursor C, MIToken &Token,
401 ErrorCallbackType ErrorCallback) {
404 return lexName(C, Token, MIToken::ExternalSymbol, /*PrefixLength=*/1,
408 static bool isValidHexFloatingPointPrefix(char C) {
409 return C == 'H' || C == 'K' || C == 'L' || C == 'M';
412 static Cursor maybeLexHexFloatingPointLiteral(Cursor C, MIToken &Token) {
413 if (C.peek() != '0' || C.peek(1) != 'x')
416 C.advance(2); // Skip '0x'
417 if (isValidHexFloatingPointPrefix(C.peek()))
419 while (isxdigit(C.peek()))
421 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
425 static Cursor lexFloatingPointLiteral(Cursor Range, Cursor C, MIToken &Token) {
427 // Skip over [0-9]*([eE][-+]?[0-9]+)?
428 while (isdigit(C.peek()))
430 if ((C.peek() == 'e' || C.peek() == 'E') &&
431 (isdigit(C.peek(1)) ||
432 ((C.peek(1) == '-' || C.peek(1) == '+') && isdigit(C.peek(2))))) {
434 while (isdigit(C.peek()))
437 Token.reset(MIToken::FloatingPointLiteral, Range.upto(C));
441 static Cursor maybeLexNumericalLiteral(Cursor C, MIToken &Token) {
442 if (!isdigit(C.peek()) && (C.peek() != '-' || !isdigit(C.peek(1))))
446 while (isdigit(C.peek()))
449 return lexFloatingPointLiteral(Range, C, Token);
450 StringRef StrVal = Range.upto(C);
451 Token.reset(MIToken::IntegerLiteral, StrVal).setIntegerValue(APSInt(StrVal));
455 static MIToken::TokenKind getMetadataKeywordKind(StringRef Identifier) {
456 return StringSwitch<MIToken::TokenKind>(Identifier)
457 .Case("!tbaa", MIToken::md_tbaa)
458 .Case("!alias.scope", MIToken::md_alias_scope)
459 .Case("!noalias", MIToken::md_noalias)
460 .Case("!range", MIToken::md_range)
461 .Default(MIToken::Error);
464 static Cursor maybeLexExlaim(Cursor C, MIToken &Token,
465 ErrorCallbackType ErrorCallback) {
470 if (isdigit(C.peek()) || !isIdentifierChar(C.peek())) {
471 Token.reset(MIToken::exclaim, Range.upto(C));
474 while (isIdentifierChar(C.peek()))
476 StringRef StrVal = Range.upto(C);
477 Token.reset(getMetadataKeywordKind(StrVal), StrVal);
479 ErrorCallback(Token.location(),
480 "use of unknown metadata keyword '" + StrVal + "'");
484 static MIToken::TokenKind symbolToken(char C) {
487 return MIToken::comma;
489 return MIToken::equal;
491 return MIToken::colon;
493 return MIToken::lparen;
495 return MIToken::rparen;
497 return MIToken::lbrace;
499 return MIToken::rbrace;
501 return MIToken::plus;
503 return MIToken::minus;
505 return MIToken::less;
507 return MIToken::greater;
509 return MIToken::Error;
513 static Cursor maybeLexSymbol(Cursor C, MIToken &Token) {
514 MIToken::TokenKind Kind;
516 if (C.peek() == ':' && C.peek(1) == ':') {
517 Kind = MIToken::coloncolon;
520 Kind = symbolToken(C.peek());
521 if (Kind == MIToken::Error)
525 Token.reset(Kind, Range.upto(C));
529 static Cursor maybeLexNewline(Cursor C, MIToken &Token) {
530 if (!isNewlineChar(C.peek()))
534 Token.reset(MIToken::Newline, Range.upto(C));
538 static Cursor maybeLexEscapedIRValue(Cursor C, MIToken &Token,
539 ErrorCallbackType ErrorCallback) {
545 while (C.peek() != '`') {
546 if (C.isEOF() || isNewlineChar(C.peek())) {
549 "end of machine instruction reached before the closing '`'");
550 Token.reset(MIToken::Error, Range.remaining());
555 StringRef Value = StrRange.upto(C);
557 Token.reset(MIToken::QuotedIRValue, Range.upto(C)).setStringValue(Value);
561 StringRef llvm::lexMIToken(StringRef Source, MIToken &Token,
562 ErrorCallbackType ErrorCallback) {
563 auto C = skipComment(skipWhitespace(Cursor(Source)));
565 Token.reset(MIToken::Eof, C.remaining());
566 return C.remaining();
569 if (Cursor R = maybeLexIntegerType(C, Token))
570 return R.remaining();
571 if (Cursor R = maybeLexMachineBasicBlock(C, Token, ErrorCallback))
572 return R.remaining();
573 if (Cursor R = maybeLexIdentifier(C, Token))
574 return R.remaining();
575 if (Cursor R = maybeLexJumpTableIndex(C, Token))
576 return R.remaining();
577 if (Cursor R = maybeLexStackObject(C, Token))
578 return R.remaining();
579 if (Cursor R = maybeLexFixedStackObject(C, Token))
580 return R.remaining();
581 if (Cursor R = maybeLexConstantPoolItem(C, Token))
582 return R.remaining();
583 if (Cursor R = maybeLexSubRegisterIndex(C, Token, ErrorCallback))
584 return R.remaining();
585 if (Cursor R = maybeLexIRBlock(C, Token, ErrorCallback))
586 return R.remaining();
587 if (Cursor R = maybeLexIRValue(C, Token, ErrorCallback))
588 return R.remaining();
589 if (Cursor R = maybeLexRegister(C, Token))
590 return R.remaining();
591 if (Cursor R = maybeLexGlobalValue(C, Token, ErrorCallback))
592 return R.remaining();
593 if (Cursor R = maybeLexExternalSymbol(C, Token, ErrorCallback))
594 return R.remaining();
595 if (Cursor R = maybeLexHexFloatingPointLiteral(C, Token))
596 return R.remaining();
597 if (Cursor R = maybeLexNumericalLiteral(C, Token))
598 return R.remaining();
599 if (Cursor R = maybeLexExlaim(C, Token, ErrorCallback))
600 return R.remaining();
601 if (Cursor R = maybeLexSymbol(C, Token))
602 return R.remaining();
603 if (Cursor R = maybeLexNewline(C, Token))
604 return R.remaining();
605 if (Cursor R = maybeLexEscapedIRValue(C, Token, ErrorCallback))
606 return R.remaining();
608 Token.reset(MIToken::Error, C.remaining());
609 ErrorCallback(C.location(),
610 Twine("unexpected character '") + Twine(C.peek()) + "'");
611 return C.remaining();