1 //===- AsmParser.cpp - Parser for Assembly Files --------------------------===//
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 class implements the parser for assembly files.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/ADT/SmallString.h"
15 #include "llvm/ADT/StringMap.h"
16 #include "llvm/ADT/StringSwitch.h"
17 #include "llvm/ADT/Twine.h"
18 #include "llvm/MC/MCAsmInfo.h"
19 #include "llvm/MC/MCContext.h"
20 #include "llvm/MC/MCExpr.h"
21 #include "llvm/MC/MCInst.h"
22 #include "llvm/MC/MCParser/AsmCond.h"
23 #include "llvm/MC/MCParser/AsmLexer.h"
24 #include "llvm/MC/MCParser/MCAsmParser.h"
25 #include "llvm/MC/MCParser/MCParsedAsmOperand.h"
26 #include "llvm/MC/MCSectionMachO.h"
27 #include "llvm/MC/MCStreamer.h"
28 #include "llvm/MC/MCSymbol.h"
29 #include "llvm/MC/MCDwarf.h"
30 #include "llvm/Support/Compiler.h"
31 #include "llvm/Support/MemoryBuffer.h"
32 #include "llvm/Support/SourceMgr.h"
33 #include "llvm/Support/raw_ostream.h"
34 #include "llvm/Target/TargetAsmParser.h"
40 /// \brief Helper class for tracking macro definitions.
46 Macro(StringRef N, StringRef B) : Name(N), Body(B) {}
49 /// \brief Helper class for storing information about an active macro
51 struct MacroInstantiation {
52 /// The macro being instantiated.
53 const Macro *TheMacro;
55 /// The macro instantiation with substitutions.
56 MemoryBuffer *Instantiation;
58 /// The location of the instantiation.
59 SMLoc InstantiationLoc;
61 /// The location where parsing should resume upon instantiation completion.
65 MacroInstantiation(const Macro *M, SMLoc IL, SMLoc EL,
66 const std::vector<std::vector<AsmToken> > &A);
69 /// \brief The concrete assembly parser instance.
70 class AsmParser : public MCAsmParser {
71 friend class GenericAsmParser;
73 AsmParser(const AsmParser &); // DO NOT IMPLEMENT
74 void operator=(const AsmParser &); // DO NOT IMPLEMENT
80 MCAsmParserExtension *GenericParser;
81 MCAsmParserExtension *PlatformParser;
83 /// This is the current buffer index we're lexing from as managed by the
88 std::vector<AsmCond> TheCondStack;
90 /// DirectiveMap - This is a table handlers for directives. Each handler is
91 /// invoked after the directive identifier is read and is responsible for
92 /// parsing and validating the rest of the directive. The handler is passed
93 /// in the directive name and the location of the directive keyword.
94 StringMap<std::pair<MCAsmParserExtension*, DirectiveHandler> > DirectiveMap;
96 /// MacroMap - Map of currently defined macros.
97 StringMap<Macro*> MacroMap;
99 /// ActiveMacros - Stack of active macro instantiations.
100 std::vector<MacroInstantiation*> ActiveMacros;
102 /// Boolean tracking whether macro substitution is enabled.
103 unsigned MacrosEnabled : 1;
105 /// Flag tracking whether any errors have been encountered.
106 unsigned HadError : 1;
109 AsmParser(const Target &T, SourceMgr &SM, MCContext &Ctx, MCStreamer &Out,
110 const MCAsmInfo &MAI);
113 virtual bool Run(bool NoInitialTextSection, bool NoFinalize = false);
115 void AddDirectiveHandler(MCAsmParserExtension *Object,
117 DirectiveHandler Handler) {
118 DirectiveMap[Directive] = std::make_pair(Object, Handler);
122 /// @name MCAsmParser Interface
125 virtual SourceMgr &getSourceManager() { return SrcMgr; }
126 virtual MCAsmLexer &getLexer() { return Lexer; }
127 virtual MCContext &getContext() { return Ctx; }
128 virtual MCStreamer &getStreamer() { return Out; }
130 virtual void Warning(SMLoc L, const Twine &Meg);
131 virtual bool Error(SMLoc L, const Twine &Msg);
133 const AsmToken &Lex();
135 bool ParseExpression(const MCExpr *&Res);
136 virtual bool ParseExpression(const MCExpr *&Res, SMLoc &EndLoc);
137 virtual bool ParseParenExpression(const MCExpr *&Res, SMLoc &EndLoc);
138 virtual bool ParseAbsoluteExpression(int64_t &Res);
143 void CheckForValidSection();
145 bool ParseStatement();
147 bool HandleMacroEntry(StringRef Name, SMLoc NameLoc, const Macro *M);
148 void HandleMacroExit();
150 void PrintMacroInstantiations();
151 void PrintMessage(SMLoc Loc, const std::string &Msg, const char *Type) const;
153 /// EnterIncludeFile - Enter the specified file. This returns true on failure.
154 bool EnterIncludeFile(const std::string &Filename);
156 /// \brief Reset the current lexer position to that given by \arg Loc. The
157 /// current token is not set; clients should ensure Lex() is called
159 void JumpToLoc(SMLoc Loc);
161 void EatToEndOfStatement();
163 /// \brief Parse up to the end of statement and a return the contents from the
164 /// current token until the end of the statement; the current token on exit
165 /// will be either the EndOfStatement or EOF.
166 StringRef ParseStringToEndOfStatement();
168 bool ParseAssignment(StringRef Name);
170 bool ParsePrimaryExpr(const MCExpr *&Res, SMLoc &EndLoc);
171 bool ParseBinOpRHS(unsigned Precedence, const MCExpr *&Res, SMLoc &EndLoc);
172 bool ParseParenExpr(const MCExpr *&Res, SMLoc &EndLoc);
174 /// ParseIdentifier - Parse an identifier or string (as a quoted identifier)
175 /// and set \arg Res to the identifier contents.
176 bool ParseIdentifier(StringRef &Res);
178 // Directive Parsing.
179 bool ParseDirectiveAscii(bool ZeroTerminated); // ".ascii", ".asciiz"
180 bool ParseDirectiveValue(unsigned Size); // ".byte", ".long", ...
181 bool ParseDirectiveFill(); // ".fill"
182 bool ParseDirectiveSpace(); // ".space"
183 bool ParseDirectiveZero(); // ".zero"
184 bool ParseDirectiveSet(); // ".set"
185 bool ParseDirectiveOrg(); // ".org"
186 // ".align{,32}", ".p2align{,w,l}"
187 bool ParseDirectiveAlign(bool IsPow2, unsigned ValueSize);
189 /// ParseDirectiveSymbolAttribute - Parse a directive like ".globl" which
190 /// accepts a single symbol (which should be a label or an external).
191 bool ParseDirectiveSymbolAttribute(MCSymbolAttr Attr);
192 bool ParseDirectiveELFType(); // ELF specific ".type"
194 bool ParseDirectiveComm(bool IsLocal); // ".comm" and ".lcomm"
196 bool ParseDirectiveAbort(); // ".abort"
197 bool ParseDirectiveInclude(); // ".include"
199 bool ParseDirectiveIf(SMLoc DirectiveLoc); // ".if"
200 bool ParseDirectiveElseIf(SMLoc DirectiveLoc); // ".elseif"
201 bool ParseDirectiveElse(SMLoc DirectiveLoc); // ".else"
202 bool ParseDirectiveEndIf(SMLoc DirectiveLoc); // .endif
204 /// ParseEscapedString - Parse the current token as a string which may include
205 /// escaped characters and return the string contents.
206 bool ParseEscapedString(std::string &Data);
208 const MCExpr *ApplyModifierToExpr(const MCExpr *E,
209 MCSymbolRefExpr::VariantKind Variant);
212 /// \brief Generic implementations of directive handling, etc. which is shared
213 /// (or the default, at least) for all assembler parser.
214 class GenericAsmParser : public MCAsmParserExtension {
215 template<bool (GenericAsmParser::*Handler)(StringRef, SMLoc)>
216 void AddDirectiveHandler(StringRef Directive) {
217 getParser().AddDirectiveHandler(this, Directive,
218 HandleDirective<GenericAsmParser, Handler>);
222 GenericAsmParser() {}
224 AsmParser &getParser() {
225 return (AsmParser&) this->MCAsmParserExtension::getParser();
228 virtual void Initialize(MCAsmParser &Parser) {
229 // Call the base implementation.
230 this->MCAsmParserExtension::Initialize(Parser);
232 // Debugging directives.
233 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveFile>(".file");
234 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveLine>(".line");
235 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveLoc>(".loc");
238 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveMacrosOnOff>(
240 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveMacrosOnOff>(
242 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveMacro>(".macro");
243 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveEndMacro>(".endm");
244 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveEndMacro>(".endmacro");
246 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveLEB128>(".sleb128");
247 AddDirectiveHandler<&GenericAsmParser::ParseDirectiveLEB128>(".uleb128");
250 bool ParseDirectiveFile(StringRef, SMLoc DirectiveLoc);
251 bool ParseDirectiveLine(StringRef, SMLoc DirectiveLoc);
252 bool ParseDirectiveLoc(StringRef, SMLoc DirectiveLoc);
254 bool ParseDirectiveMacrosOnOff(StringRef, SMLoc DirectiveLoc);
255 bool ParseDirectiveMacro(StringRef, SMLoc DirectiveLoc);
256 bool ParseDirectiveEndMacro(StringRef, SMLoc DirectiveLoc);
258 void ParseUleb128(uint64_t Value);
259 void ParseSleb128(int64_t Value);
260 bool ParseDirectiveLEB128(StringRef, SMLoc);
267 extern MCAsmParserExtension *createDarwinAsmParser();
268 extern MCAsmParserExtension *createELFAsmParser();
272 enum { DEFAULT_ADDRSPACE = 0 };
274 AsmParser::AsmParser(const Target &T, SourceMgr &_SM, MCContext &_Ctx,
275 MCStreamer &_Out, const MCAsmInfo &_MAI)
276 : Lexer(_MAI), Ctx(_Ctx), Out(_Out), SrcMgr(_SM),
277 GenericParser(new GenericAsmParser), PlatformParser(0),
278 CurBuffer(0), MacrosEnabled(true) {
279 Lexer.setBuffer(SrcMgr.getMemoryBuffer(CurBuffer));
281 // Initialize the generic parser.
282 GenericParser->Initialize(*this);
284 // Initialize the platform / file format parser.
286 // FIXME: This is a hack, we need to (majorly) cleanup how these objects are
288 if (_MAI.hasSubsectionsViaSymbols()) {
289 PlatformParser = createDarwinAsmParser();
290 PlatformParser->Initialize(*this);
292 PlatformParser = createELFAsmParser();
293 PlatformParser->Initialize(*this);
297 AsmParser::~AsmParser() {
298 assert(ActiveMacros.empty() && "Unexpected active macro instantiation!");
300 // Destroy any macros.
301 for (StringMap<Macro*>::iterator it = MacroMap.begin(),
302 ie = MacroMap.end(); it != ie; ++it)
303 delete it->getValue();
305 delete PlatformParser;
306 delete GenericParser;
309 void AsmParser::PrintMacroInstantiations() {
310 // Print the active macro instantiation stack.
311 for (std::vector<MacroInstantiation*>::const_reverse_iterator
312 it = ActiveMacros.rbegin(), ie = ActiveMacros.rend(); it != ie; ++it)
313 PrintMessage((*it)->InstantiationLoc, "while in macro instantiation",
317 void AsmParser::Warning(SMLoc L, const Twine &Msg) {
318 PrintMessage(L, Msg.str(), "warning");
319 PrintMacroInstantiations();
322 bool AsmParser::Error(SMLoc L, const Twine &Msg) {
324 PrintMessage(L, Msg.str(), "error");
325 PrintMacroInstantiations();
329 void AsmParser::PrintMessage(SMLoc Loc, const std::string &Msg,
330 const char *Type) const {
331 SrcMgr.PrintMessage(Loc, Msg, Type);
334 bool AsmParser::EnterIncludeFile(const std::string &Filename) {
335 int NewBuf = SrcMgr.AddIncludeFile(Filename, Lexer.getLoc());
341 Lexer.setBuffer(SrcMgr.getMemoryBuffer(CurBuffer));
346 void AsmParser::JumpToLoc(SMLoc Loc) {
347 CurBuffer = SrcMgr.FindBufferContainingLoc(Loc);
348 Lexer.setBuffer(SrcMgr.getMemoryBuffer(CurBuffer), Loc.getPointer());
351 const AsmToken &AsmParser::Lex() {
352 const AsmToken *tok = &Lexer.Lex();
354 if (tok->is(AsmToken::Eof)) {
355 // If this is the end of an included file, pop the parent file off the
357 SMLoc ParentIncludeLoc = SrcMgr.getParentIncludeLoc(CurBuffer);
358 if (ParentIncludeLoc != SMLoc()) {
359 JumpToLoc(ParentIncludeLoc);
364 if (tok->is(AsmToken::Error))
365 Error(Lexer.getErrLoc(), Lexer.getErr());
370 bool AsmParser::Run(bool NoInitialTextSection, bool NoFinalize) {
371 // Create the initial section, if requested.
372 if (!NoInitialTextSection)
379 AsmCond StartingCondState = TheCondState;
381 // While we have input, parse each statement.
382 while (Lexer.isNot(AsmToken::Eof)) {
383 if (!ParseStatement()) continue;
385 // We had an error, validate that one was emitted and recover by skipping to
387 assert(HadError && "Parse statement returned an error, but none emitted!");
388 EatToEndOfStatement();
391 if (TheCondState.TheCond != StartingCondState.TheCond ||
392 TheCondState.Ignore != StartingCondState.Ignore)
393 return TokError("unmatched .ifs or .elses");
395 // Check to see there are no empty DwarfFile slots.
396 const std::vector<MCDwarfFile *> &MCDwarfFiles =
397 getContext().getMCDwarfFiles();
398 for (unsigned i = 1; i < MCDwarfFiles.size(); i++) {
399 if (!MCDwarfFiles[i])
400 TokError("unassigned file number: " + Twine(i) + " for .file directives");
403 // Finalize the output stream if there are no errors and if the client wants
405 if (!HadError && !NoFinalize)
411 void AsmParser::CheckForValidSection() {
412 if (!getStreamer().getCurrentSection()) {
413 TokError("expected section directive before assembly directive");
414 Out.SwitchSection(Ctx.getMachOSection(
416 MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS,
417 0, SectionKind::getText()));
421 /// EatToEndOfStatement - Throw away the rest of the line for testing purposes.
422 void AsmParser::EatToEndOfStatement() {
423 while (Lexer.isNot(AsmToken::EndOfStatement) &&
424 Lexer.isNot(AsmToken::Eof))
428 if (Lexer.is(AsmToken::EndOfStatement))
432 StringRef AsmParser::ParseStringToEndOfStatement() {
433 const char *Start = getTok().getLoc().getPointer();
435 while (Lexer.isNot(AsmToken::EndOfStatement) &&
436 Lexer.isNot(AsmToken::Eof))
439 const char *End = getTok().getLoc().getPointer();
440 return StringRef(Start, End - Start);
443 /// ParseParenExpr - Parse a paren expression and return it.
444 /// NOTE: This assumes the leading '(' has already been consumed.
446 /// parenexpr ::= expr)
448 bool AsmParser::ParseParenExpr(const MCExpr *&Res, SMLoc &EndLoc) {
449 if (ParseExpression(Res)) return true;
450 if (Lexer.isNot(AsmToken::RParen))
451 return TokError("expected ')' in parentheses expression");
452 EndLoc = Lexer.getLoc();
457 /// ParsePrimaryExpr - Parse a primary expression and return it.
458 /// primaryexpr ::= (parenexpr
459 /// primaryexpr ::= symbol
460 /// primaryexpr ::= number
461 /// primaryexpr ::= '.'
462 /// primaryexpr ::= ~,+,- primaryexpr
463 bool AsmParser::ParsePrimaryExpr(const MCExpr *&Res, SMLoc &EndLoc) {
464 switch (Lexer.getKind()) {
466 return TokError("unknown token in expression");
467 case AsmToken::Exclaim:
468 Lex(); // Eat the operator.
469 if (ParsePrimaryExpr(Res, EndLoc))
471 Res = MCUnaryExpr::CreateLNot(Res, getContext());
473 case AsmToken::Dollar:
474 case AsmToken::String:
475 case AsmToken::Identifier: {
476 EndLoc = Lexer.getLoc();
478 StringRef Identifier;
479 if (ParseIdentifier(Identifier))
482 // This is a symbol reference.
483 std::pair<StringRef, StringRef> Split = Identifier.split('@');
484 MCSymbol *Sym = getContext().GetOrCreateSymbol(Split.first);
486 // Mark the symbol as used in an expression.
487 Sym->setUsedInExpr(true);
489 // Lookup the symbol variant if used.
490 MCSymbolRefExpr::VariantKind Variant = MCSymbolRefExpr::VK_None;
491 if (Split.first.size() != Identifier.size()) {
492 Variant = MCSymbolRefExpr::getVariantKindForName(Split.second);
493 if (Variant == MCSymbolRefExpr::VK_Invalid) {
494 Variant = MCSymbolRefExpr::VK_None;
495 TokError("invalid variant '" + Split.second + "'");
499 // If this is an absolute variable reference, substitute it now to preserve
500 // semantics in the face of reassignment.
501 if (Sym->isVariable() && isa<MCConstantExpr>(Sym->getVariableValue())) {
503 return Error(EndLoc, "unexpected modified on variable reference");
505 Res = Sym->getVariableValue();
509 // Otherwise create a symbol ref.
510 Res = MCSymbolRefExpr::Create(Sym, Variant, getContext());
513 case AsmToken::Integer: {
514 SMLoc Loc = getTok().getLoc();
515 int64_t IntVal = getTok().getIntVal();
516 Res = MCConstantExpr::Create(IntVal, getContext());
517 EndLoc = Lexer.getLoc();
519 // Look for 'b' or 'f' following an Integer as a directional label
520 if (Lexer.getKind() == AsmToken::Identifier) {
521 StringRef IDVal = getTok().getString();
522 if (IDVal == "f" || IDVal == "b"){
523 MCSymbol *Sym = Ctx.GetDirectionalLocalSymbol(IntVal,
524 IDVal == "f" ? 1 : 0);
525 Res = MCSymbolRefExpr::Create(Sym, MCSymbolRefExpr::VK_None,
527 if(IDVal == "b" && Sym->isUndefined())
528 return Error(Loc, "invalid reference to undefined symbol");
529 EndLoc = Lexer.getLoc();
530 Lex(); // Eat identifier.
535 case AsmToken::Dot: {
536 // This is a '.' reference, which references the current PC. Emit a
537 // temporary label to the streamer and refer to it.
538 MCSymbol *Sym = Ctx.CreateTempSymbol();
540 Res = MCSymbolRefExpr::Create(Sym, MCSymbolRefExpr::VK_None, getContext());
541 EndLoc = Lexer.getLoc();
542 Lex(); // Eat identifier.
546 case AsmToken::LParen:
547 Lex(); // Eat the '('.
548 return ParseParenExpr(Res, EndLoc);
549 case AsmToken::Minus:
550 Lex(); // Eat the operator.
551 if (ParsePrimaryExpr(Res, EndLoc))
553 Res = MCUnaryExpr::CreateMinus(Res, getContext());
556 Lex(); // Eat the operator.
557 if (ParsePrimaryExpr(Res, EndLoc))
559 Res = MCUnaryExpr::CreatePlus(Res, getContext());
561 case AsmToken::Tilde:
562 Lex(); // Eat the operator.
563 if (ParsePrimaryExpr(Res, EndLoc))
565 Res = MCUnaryExpr::CreateNot(Res, getContext());
570 bool AsmParser::ParseExpression(const MCExpr *&Res) {
572 return ParseExpression(Res, EndLoc);
576 AsmParser::ApplyModifierToExpr(const MCExpr *E,
577 MCSymbolRefExpr::VariantKind Variant) {
578 // Recurse over the given expression, rebuilding it to apply the given variant
579 // if there is exactly one symbol.
580 switch (E->getKind()) {
582 case MCExpr::Constant:
585 case MCExpr::SymbolRef: {
586 const MCSymbolRefExpr *SRE = cast<MCSymbolRefExpr>(E);
588 if (SRE->getKind() != MCSymbolRefExpr::VK_None) {
589 TokError("invalid variant on expression '" +
590 getTok().getIdentifier() + "' (already modified)");
594 return MCSymbolRefExpr::Create(&SRE->getSymbol(), Variant, getContext());
597 case MCExpr::Unary: {
598 const MCUnaryExpr *UE = cast<MCUnaryExpr>(E);
599 const MCExpr *Sub = ApplyModifierToExpr(UE->getSubExpr(), Variant);
602 return MCUnaryExpr::Create(UE->getOpcode(), Sub, getContext());
605 case MCExpr::Binary: {
606 const MCBinaryExpr *BE = cast<MCBinaryExpr>(E);
607 const MCExpr *LHS = ApplyModifierToExpr(BE->getLHS(), Variant);
608 const MCExpr *RHS = ApplyModifierToExpr(BE->getRHS(), Variant);
613 if (!LHS) LHS = BE->getLHS();
614 if (!RHS) RHS = BE->getRHS();
616 return MCBinaryExpr::Create(BE->getOpcode(), LHS, RHS, getContext());
620 assert(0 && "Invalid expression kind!");
624 /// ParseExpression - Parse an expression and return it.
626 /// expr ::= expr +,- expr -> lowest.
627 /// expr ::= expr |,^,&,! expr -> middle.
628 /// expr ::= expr *,/,%,<<,>> expr -> highest.
629 /// expr ::= primaryexpr
631 bool AsmParser::ParseExpression(const MCExpr *&Res, SMLoc &EndLoc) {
632 // Parse the expression.
634 if (ParsePrimaryExpr(Res, EndLoc) || ParseBinOpRHS(1, Res, EndLoc))
637 // As a special case, we support 'a op b @ modifier' by rewriting the
638 // expression to include the modifier. This is inefficient, but in general we
639 // expect users to use 'a@modifier op b'.
640 if (Lexer.getKind() == AsmToken::At) {
643 if (Lexer.isNot(AsmToken::Identifier))
644 return TokError("unexpected symbol modifier following '@'");
646 MCSymbolRefExpr::VariantKind Variant =
647 MCSymbolRefExpr::getVariantKindForName(getTok().getIdentifier());
648 if (Variant == MCSymbolRefExpr::VK_Invalid)
649 return TokError("invalid variant '" + getTok().getIdentifier() + "'");
651 const MCExpr *ModifiedRes = ApplyModifierToExpr(Res, Variant);
653 return TokError("invalid modifier '" + getTok().getIdentifier() +
654 "' (no symbols present)");
662 // Try to constant fold it up front, if possible.
664 if (Res->EvaluateAsAbsolute(Value))
665 Res = MCConstantExpr::Create(Value, getContext());
670 bool AsmParser::ParseParenExpression(const MCExpr *&Res, SMLoc &EndLoc) {
672 return ParseParenExpr(Res, EndLoc) ||
673 ParseBinOpRHS(1, Res, EndLoc);
676 bool AsmParser::ParseAbsoluteExpression(int64_t &Res) {
679 SMLoc StartLoc = Lexer.getLoc();
680 if (ParseExpression(Expr))
683 if (!Expr->EvaluateAsAbsolute(Res))
684 return Error(StartLoc, "expected absolute expression");
689 static unsigned getBinOpPrecedence(AsmToken::TokenKind K,
690 MCBinaryExpr::Opcode &Kind) {
693 return 0; // not a binop.
695 // Lowest Precedence: &&, ||, @
696 case AsmToken::AmpAmp:
697 Kind = MCBinaryExpr::LAnd;
699 case AsmToken::PipePipe:
700 Kind = MCBinaryExpr::LOr;
703 // Low Precedence: +, -, ==, !=, <>, <, <=, >, >=
705 Kind = MCBinaryExpr::Add;
707 case AsmToken::Minus:
708 Kind = MCBinaryExpr::Sub;
710 case AsmToken::EqualEqual:
711 Kind = MCBinaryExpr::EQ;
713 case AsmToken::ExclaimEqual:
714 case AsmToken::LessGreater:
715 Kind = MCBinaryExpr::NE;
718 Kind = MCBinaryExpr::LT;
720 case AsmToken::LessEqual:
721 Kind = MCBinaryExpr::LTE;
723 case AsmToken::Greater:
724 Kind = MCBinaryExpr::GT;
726 case AsmToken::GreaterEqual:
727 Kind = MCBinaryExpr::GTE;
730 // Intermediate Precedence: |, &, ^
732 // FIXME: gas seems to support '!' as an infix operator?
734 Kind = MCBinaryExpr::Or;
736 case AsmToken::Caret:
737 Kind = MCBinaryExpr::Xor;
740 Kind = MCBinaryExpr::And;
743 // Highest Precedence: *, /, %, <<, >>
745 Kind = MCBinaryExpr::Mul;
747 case AsmToken::Slash:
748 Kind = MCBinaryExpr::Div;
750 case AsmToken::Percent:
751 Kind = MCBinaryExpr::Mod;
753 case AsmToken::LessLess:
754 Kind = MCBinaryExpr::Shl;
756 case AsmToken::GreaterGreater:
757 Kind = MCBinaryExpr::Shr;
763 /// ParseBinOpRHS - Parse all binary operators with precedence >= 'Precedence'.
764 /// Res contains the LHS of the expression on input.
765 bool AsmParser::ParseBinOpRHS(unsigned Precedence, const MCExpr *&Res,
768 MCBinaryExpr::Opcode Kind = MCBinaryExpr::Add;
769 unsigned TokPrec = getBinOpPrecedence(Lexer.getKind(), Kind);
771 // If the next token is lower precedence than we are allowed to eat, return
772 // successfully with what we ate already.
773 if (TokPrec < Precedence)
778 // Eat the next primary expression.
780 if (ParsePrimaryExpr(RHS, EndLoc)) return true;
782 // If BinOp binds less tightly with RHS than the operator after RHS, let
783 // the pending operator take RHS as its LHS.
784 MCBinaryExpr::Opcode Dummy;
785 unsigned NextTokPrec = getBinOpPrecedence(Lexer.getKind(), Dummy);
786 if (TokPrec < NextTokPrec) {
787 if (ParseBinOpRHS(Precedence+1, RHS, EndLoc)) return true;
790 // Merge LHS and RHS according to operator.
791 Res = MCBinaryExpr::Create(Kind, Res, RHS, getContext());
799 /// ::= EndOfStatement
800 /// ::= Label* Directive ...Operands... EndOfStatement
801 /// ::= Label* Identifier OperandList* EndOfStatement
802 bool AsmParser::ParseStatement() {
803 if (Lexer.is(AsmToken::EndOfStatement)) {
809 // Statements always start with an identifier.
810 AsmToken ID = getTok();
811 SMLoc IDLoc = ID.getLoc();
813 int64_t LocalLabelVal = -1;
814 // GUESS allow an integer followed by a ':' as a directional local label
815 if (Lexer.is(AsmToken::Integer)) {
816 LocalLabelVal = getTok().getIntVal();
817 if (LocalLabelVal < 0) {
818 if (!TheCondState.Ignore)
819 return TokError("unexpected token at start of statement");
823 IDVal = getTok().getString();
824 Lex(); // Consume the integer token to be used as an identifier token.
825 if (Lexer.getKind() != AsmToken::Colon) {
826 if (!TheCondState.Ignore)
827 return TokError("unexpected token at start of statement");
831 else if (ParseIdentifier(IDVal)) {
832 if (!TheCondState.Ignore)
833 return TokError("unexpected token at start of statement");
837 // Handle conditional assembly here before checking for skipping. We
838 // have to do this so that .endif isn't skipped in a ".if 0" block for
841 return ParseDirectiveIf(IDLoc);
842 if (IDVal == ".elseif")
843 return ParseDirectiveElseIf(IDLoc);
844 if (IDVal == ".else")
845 return ParseDirectiveElse(IDLoc);
846 if (IDVal == ".endif")
847 return ParseDirectiveEndIf(IDLoc);
849 // If we are in a ".if 0" block, ignore this statement.
850 if (TheCondState.Ignore) {
851 EatToEndOfStatement();
855 // FIXME: Recurse on local labels?
857 // See what kind of statement we have.
858 switch (Lexer.getKind()) {
859 case AsmToken::Colon: {
860 CheckForValidSection();
862 // identifier ':' -> Label.
865 // Diagnose attempt to use a variable as a label.
867 // FIXME: Diagnostics. Note the location of the definition as a label.
868 // FIXME: This doesn't diagnose assignment to a symbol which has been
869 // implicitly marked as external.
871 if (LocalLabelVal == -1)
872 Sym = getContext().GetOrCreateSymbol(IDVal);
874 Sym = Ctx.CreateDirectionalLocalSymbol(LocalLabelVal);
875 if (!Sym->isUndefined() || Sym->isVariable())
876 return Error(IDLoc, "invalid symbol redefinition");
881 // Consume any end of statement token, if present, to avoid spurious
882 // AddBlankLine calls().
883 if (Lexer.is(AsmToken::EndOfStatement)) {
885 if (Lexer.is(AsmToken::Eof))
889 return ParseStatement();
892 case AsmToken::Equal:
893 // identifier '=' ... -> assignment statement
896 return ParseAssignment(IDVal);
898 default: // Normal instruction or directive.
902 // If macros are enabled, check to see if this is a macro instantiation.
904 if (const Macro *M = MacroMap.lookup(IDVal))
905 return HandleMacroEntry(IDVal, IDLoc, M);
907 // Otherwise, we have a normal instruction or directive.
908 if (IDVal[0] == '.') {
909 // Assembler features
911 return ParseDirectiveSet();
915 if (IDVal == ".ascii")
916 return ParseDirectiveAscii(false);
917 if (IDVal == ".asciz")
918 return ParseDirectiveAscii(true);
920 if (IDVal == ".byte")
921 return ParseDirectiveValue(1);
922 if (IDVal == ".short")
923 return ParseDirectiveValue(2);
924 if (IDVal == ".long")
925 return ParseDirectiveValue(4);
926 if (IDVal == ".quad")
927 return ParseDirectiveValue(8);
929 if (IDVal == ".align") {
930 bool IsPow2 = !getContext().getAsmInfo().getAlignmentIsInBytes();
931 return ParseDirectiveAlign(IsPow2, /*ExprSize=*/1);
933 if (IDVal == ".align32") {
934 bool IsPow2 = !getContext().getAsmInfo().getAlignmentIsInBytes();
935 return ParseDirectiveAlign(IsPow2, /*ExprSize=*/4);
937 if (IDVal == ".balign")
938 return ParseDirectiveAlign(/*IsPow2=*/false, /*ExprSize=*/1);
939 if (IDVal == ".balignw")
940 return ParseDirectiveAlign(/*IsPow2=*/false, /*ExprSize=*/2);
941 if (IDVal == ".balignl")
942 return ParseDirectiveAlign(/*IsPow2=*/false, /*ExprSize=*/4);
943 if (IDVal == ".p2align")
944 return ParseDirectiveAlign(/*IsPow2=*/true, /*ExprSize=*/1);
945 if (IDVal == ".p2alignw")
946 return ParseDirectiveAlign(/*IsPow2=*/true, /*ExprSize=*/2);
947 if (IDVal == ".p2alignl")
948 return ParseDirectiveAlign(/*IsPow2=*/true, /*ExprSize=*/4);
951 return ParseDirectiveOrg();
953 if (IDVal == ".fill")
954 return ParseDirectiveFill();
955 if (IDVal == ".space")
956 return ParseDirectiveSpace();
957 if (IDVal == ".zero")
958 return ParseDirectiveZero();
960 // Symbol attribute directives
962 if (IDVal == ".globl" || IDVal == ".global")
963 return ParseDirectiveSymbolAttribute(MCSA_Global);
964 // ELF only? Should it be here?
965 if (IDVal == ".local")
966 return ParseDirectiveSymbolAttribute(MCSA_Local);
967 if (IDVal == ".hidden")
968 return ParseDirectiveSymbolAttribute(MCSA_Hidden);
969 if (IDVal == ".indirect_symbol")
970 return ParseDirectiveSymbolAttribute(MCSA_IndirectSymbol);
971 if (IDVal == ".internal")
972 return ParseDirectiveSymbolAttribute(MCSA_Internal);
973 if (IDVal == ".lazy_reference")
974 return ParseDirectiveSymbolAttribute(MCSA_LazyReference);
975 if (IDVal == ".no_dead_strip")
976 return ParseDirectiveSymbolAttribute(MCSA_NoDeadStrip);
977 if (IDVal == ".private_extern")
978 return ParseDirectiveSymbolAttribute(MCSA_PrivateExtern);
979 if (IDVal == ".protected")
980 return ParseDirectiveSymbolAttribute(MCSA_Protected);
981 if (IDVal == ".reference")
982 return ParseDirectiveSymbolAttribute(MCSA_Reference);
983 if (IDVal == ".type")
984 return ParseDirectiveELFType();
985 if (IDVal == ".weak")
986 return ParseDirectiveSymbolAttribute(MCSA_Weak);
987 if (IDVal == ".weak_definition")
988 return ParseDirectiveSymbolAttribute(MCSA_WeakDefinition);
989 if (IDVal == ".weak_reference")
990 return ParseDirectiveSymbolAttribute(MCSA_WeakReference);
991 if (IDVal == ".weak_def_can_be_hidden")
992 return ParseDirectiveSymbolAttribute(MCSA_WeakDefAutoPrivate);
994 if (IDVal == ".comm")
995 return ParseDirectiveComm(/*IsLocal=*/false);
996 if (IDVal == ".lcomm")
997 return ParseDirectiveComm(/*IsLocal=*/true);
999 if (IDVal == ".abort")
1000 return ParseDirectiveAbort();
1001 if (IDVal == ".include")
1002 return ParseDirectiveInclude();
1004 // Look up the handler in the handler table.
1005 std::pair<MCAsmParserExtension*, DirectiveHandler> Handler =
1006 DirectiveMap.lookup(IDVal);
1008 return (*Handler.second)(Handler.first, IDVal, IDLoc);
1010 // Target hook for parsing target specific directives.
1011 if (!getTargetParser().ParseDirective(ID))
1014 Warning(IDLoc, "ignoring directive for now");
1015 EatToEndOfStatement();
1019 CheckForValidSection();
1021 // Canonicalize the opcode to lower case.
1022 SmallString<128> Opcode;
1023 for (unsigned i = 0, e = IDVal.size(); i != e; ++i)
1024 Opcode.push_back(tolower(IDVal[i]));
1026 SmallVector<MCParsedAsmOperand*, 8> ParsedOperands;
1027 bool HadError = getTargetParser().ParseInstruction(Opcode.str(), IDLoc,
1030 // Dump the parsed representation, if requested.
1031 if (getShowParsedOperands()) {
1032 SmallString<256> Str;
1033 raw_svector_ostream OS(Str);
1034 OS << "parsed instruction: [";
1035 for (unsigned i = 0; i != ParsedOperands.size(); ++i) {
1038 ParsedOperands[i]->dump(OS);
1042 PrintMessage(IDLoc, OS.str(), "note");
1045 // If parsing succeeded, match the instruction.
1048 if (!getTargetParser().MatchInstruction(IDLoc, ParsedOperands, Inst)) {
1049 // Emit the instruction on success.
1050 Out.EmitInstruction(Inst);
1055 // Free any parsed operands.
1056 for (unsigned i = 0, e = ParsedOperands.size(); i != e; ++i)
1057 delete ParsedOperands[i];
1059 // Don't skip the rest of the line, the instruction parser is responsible for
1064 MacroInstantiation::MacroInstantiation(const Macro *M, SMLoc IL, SMLoc EL,
1065 const std::vector<std::vector<AsmToken> > &A)
1066 : TheMacro(M), InstantiationLoc(IL), ExitLoc(EL)
1068 // Macro instantiation is lexical, unfortunately. We construct a new buffer
1069 // to hold the macro body with substitutions.
1070 SmallString<256> Buf;
1071 raw_svector_ostream OS(Buf);
1073 StringRef Body = M->Body;
1074 while (!Body.empty()) {
1075 // Scan for the next substitution.
1076 std::size_t End = Body.size(), Pos = 0;
1077 for (; Pos != End; ++Pos) {
1078 // Check for a substitution or escape.
1079 if (Body[Pos] != '$' || Pos + 1 == End)
1082 char Next = Body[Pos + 1];
1083 if (Next == '$' || Next == 'n' || isdigit(Next))
1088 OS << Body.slice(0, Pos);
1090 // Check if we reached the end.
1094 switch (Body[Pos+1]) {
1100 // $n => number of arguments
1105 // $[0-9] => argument
1107 // Missing arguments are ignored.
1108 unsigned Index = Body[Pos+1] - '0';
1109 if (Index >= A.size())
1112 // Otherwise substitute with the token values, with spaces eliminated.
1113 for (std::vector<AsmToken>::const_iterator it = A[Index].begin(),
1114 ie = A[Index].end(); it != ie; ++it)
1115 OS << it->getString();
1120 // Update the scan point.
1121 Body = Body.substr(Pos + 2);
1124 // We include the .endmacro in the buffer as our queue to exit the macro
1126 OS << ".endmacro\n";
1128 Instantiation = MemoryBuffer::getMemBufferCopy(OS.str(), "<instantiation>");
1131 bool AsmParser::HandleMacroEntry(StringRef Name, SMLoc NameLoc,
1133 // Arbitrarily limit macro nesting depth, to match 'as'. We can eliminate
1134 // this, although we should protect against infinite loops.
1135 if (ActiveMacros.size() == 20)
1136 return TokError("macros cannot be nested more than 20 levels deep");
1138 // Parse the macro instantiation arguments.
1139 std::vector<std::vector<AsmToken> > MacroArguments;
1140 MacroArguments.push_back(std::vector<AsmToken>());
1141 unsigned ParenLevel = 0;
1143 if (Lexer.is(AsmToken::Eof))
1144 return TokError("unexpected token in macro instantiation");
1145 if (Lexer.is(AsmToken::EndOfStatement))
1148 // If we aren't inside parentheses and this is a comma, start a new token
1150 if (ParenLevel == 0 && Lexer.is(AsmToken::Comma)) {
1151 MacroArguments.push_back(std::vector<AsmToken>());
1153 // Adjust the current parentheses level.
1154 if (Lexer.is(AsmToken::LParen))
1156 else if (Lexer.is(AsmToken::RParen) && ParenLevel)
1159 // Append the token to the current argument list.
1160 MacroArguments.back().push_back(getTok());
1165 // Create the macro instantiation object and add to the current macro
1166 // instantiation stack.
1167 MacroInstantiation *MI = new MacroInstantiation(M, NameLoc,
1170 ActiveMacros.push_back(MI);
1172 // Jump to the macro instantiation and prime the lexer.
1173 CurBuffer = SrcMgr.AddNewSourceBuffer(MI->Instantiation, SMLoc());
1174 Lexer.setBuffer(SrcMgr.getMemoryBuffer(CurBuffer));
1180 void AsmParser::HandleMacroExit() {
1181 // Jump to the EndOfStatement we should return to, and consume it.
1182 JumpToLoc(ActiveMacros.back()->ExitLoc);
1185 // Pop the instantiation entry.
1186 delete ActiveMacros.back();
1187 ActiveMacros.pop_back();
1190 bool AsmParser::ParseAssignment(StringRef Name) {
1191 // FIXME: Use better location, we should use proper tokens.
1192 SMLoc EqualLoc = Lexer.getLoc();
1194 const MCExpr *Value;
1195 if (ParseExpression(Value))
1198 if (Lexer.isNot(AsmToken::EndOfStatement))
1199 return TokError("unexpected token in assignment");
1201 // Eat the end of statement marker.
1204 // Validate that the LHS is allowed to be a variable (either it has not been
1205 // used as a symbol, or it is an absolute symbol).
1206 MCSymbol *Sym = getContext().LookupSymbol(Name);
1208 // Diagnose assignment to a label.
1210 // FIXME: Diagnostics. Note the location of the definition as a label.
1211 // FIXME: Diagnose assignment to protected identifier (e.g., register name).
1212 if (Sym->isUndefined() && !Sym->isUsedInExpr())
1213 ; // Allow redefinitions of undefined symbols only used in directives.
1214 else if (!Sym->isUndefined() && !Sym->isAbsolute())
1215 return Error(EqualLoc, "redefinition of '" + Name + "'");
1216 else if (!Sym->isVariable())
1217 return Error(EqualLoc, "invalid assignment to '" + Name + "'");
1218 else if (!isa<MCConstantExpr>(Sym->getVariableValue()))
1219 return Error(EqualLoc, "invalid reassignment of non-absolute variable '" +
1222 Sym = getContext().GetOrCreateSymbol(Name);
1224 // FIXME: Handle '.'.
1226 Sym->setUsedInExpr(true);
1228 // Do the assignment.
1229 Out.EmitAssignment(Sym, Value);
1234 /// ParseIdentifier:
1237 bool AsmParser::ParseIdentifier(StringRef &Res) {
1238 // The assembler has relaxed rules for accepting identifiers, in particular we
1239 // allow things like '.globl $foo', which would normally be separate
1240 // tokens. At this level, we have already lexed so we cannot (currently)
1241 // handle this as a context dependent token, instead we detect adjacent tokens
1242 // and return the combined identifier.
1243 if (Lexer.is(AsmToken::Dollar)) {
1244 SMLoc DollarLoc = getLexer().getLoc();
1246 // Consume the dollar sign, and check for a following identifier.
1248 if (Lexer.isNot(AsmToken::Identifier))
1251 // We have a '$' followed by an identifier, make sure they are adjacent.
1252 if (DollarLoc.getPointer() + 1 != getTok().getLoc().getPointer())
1255 // Construct the joined identifier and consume the token.
1256 Res = StringRef(DollarLoc.getPointer(),
1257 getTok().getIdentifier().size() + 1);
1262 if (Lexer.isNot(AsmToken::Identifier) &&
1263 Lexer.isNot(AsmToken::String))
1266 Res = getTok().getIdentifier();
1268 Lex(); // Consume the identifier token.
1273 /// ParseDirectiveSet:
1274 /// ::= .set identifier ',' expression
1275 bool AsmParser::ParseDirectiveSet() {
1278 if (ParseIdentifier(Name))
1279 return TokError("expected identifier after '.set' directive");
1281 if (getLexer().isNot(AsmToken::Comma))
1282 return TokError("unexpected token in '.set'");
1285 return ParseAssignment(Name);
1288 bool AsmParser::ParseEscapedString(std::string &Data) {
1289 assert(getLexer().is(AsmToken::String) && "Unexpected current token!");
1292 StringRef Str = getTok().getStringContents();
1293 for (unsigned i = 0, e = Str.size(); i != e; ++i) {
1294 if (Str[i] != '\\') {
1299 // Recognize escaped characters. Note that this escape semantics currently
1300 // loosely follows Darwin 'as'. Notably, it doesn't support hex escapes.
1303 return TokError("unexpected backslash at end of string");
1305 // Recognize octal sequences.
1306 if ((unsigned) (Str[i] - '0') <= 7) {
1307 // Consume up to three octal characters.
1308 unsigned Value = Str[i] - '0';
1310 if (i + 1 != e && ((unsigned) (Str[i + 1] - '0')) <= 7) {
1312 Value = Value * 8 + (Str[i] - '0');
1314 if (i + 1 != e && ((unsigned) (Str[i + 1] - '0')) <= 7) {
1316 Value = Value * 8 + (Str[i] - '0');
1321 return TokError("invalid octal escape sequence (out of range)");
1323 Data += (unsigned char) Value;
1327 // Otherwise recognize individual escapes.
1330 // Just reject invalid escape sequences for now.
1331 return TokError("invalid escape sequence (unrecognized character)");
1333 case 'b': Data += '\b'; break;
1334 case 'f': Data += '\f'; break;
1335 case 'n': Data += '\n'; break;
1336 case 'r': Data += '\r'; break;
1337 case 't': Data += '\t'; break;
1338 case '"': Data += '"'; break;
1339 case '\\': Data += '\\'; break;
1346 /// ParseDirectiveAscii:
1347 /// ::= ( .ascii | .asciz ) [ "string" ( , "string" )* ]
1348 bool AsmParser::ParseDirectiveAscii(bool ZeroTerminated) {
1349 if (getLexer().isNot(AsmToken::EndOfStatement)) {
1350 CheckForValidSection();
1353 if (getLexer().isNot(AsmToken::String))
1354 return TokError("expected string in '.ascii' or '.asciz' directive");
1357 if (ParseEscapedString(Data))
1360 getStreamer().EmitBytes(Data, DEFAULT_ADDRSPACE);
1362 getStreamer().EmitBytes(StringRef("\0", 1), DEFAULT_ADDRSPACE);
1366 if (getLexer().is(AsmToken::EndOfStatement))
1369 if (getLexer().isNot(AsmToken::Comma))
1370 return TokError("unexpected token in '.ascii' or '.asciz' directive");
1379 /// ParseDirectiveValue
1380 /// ::= (.byte | .short | ... ) [ expression (, expression)* ]
1381 bool AsmParser::ParseDirectiveValue(unsigned Size) {
1382 if (getLexer().isNot(AsmToken::EndOfStatement)) {
1383 CheckForValidSection();
1386 const MCExpr *Value;
1387 SMLoc ATTRIBUTE_UNUSED StartLoc = getLexer().getLoc();
1388 if (ParseExpression(Value))
1391 // Special case constant expressions to match code generator.
1392 if (const MCConstantExpr *MCE = dyn_cast<MCConstantExpr>(Value))
1393 getStreamer().EmitIntValue(MCE->getValue(), Size, DEFAULT_ADDRSPACE);
1395 getStreamer().EmitValue(Value, Size, DEFAULT_ADDRSPACE);
1397 if (getLexer().is(AsmToken::EndOfStatement))
1400 // FIXME: Improve diagnostic.
1401 if (getLexer().isNot(AsmToken::Comma))
1402 return TokError("unexpected token in directive");
1411 /// ParseDirectiveSpace
1412 /// ::= .space expression [ , expression ]
1413 bool AsmParser::ParseDirectiveSpace() {
1414 CheckForValidSection();
1417 if (ParseAbsoluteExpression(NumBytes))
1420 int64_t FillExpr = 0;
1421 if (getLexer().isNot(AsmToken::EndOfStatement)) {
1422 if (getLexer().isNot(AsmToken::Comma))
1423 return TokError("unexpected token in '.space' directive");
1426 if (ParseAbsoluteExpression(FillExpr))
1429 if (getLexer().isNot(AsmToken::EndOfStatement))
1430 return TokError("unexpected token in '.space' directive");
1436 return TokError("invalid number of bytes in '.space' directive");
1438 // FIXME: Sometimes the fill expr is 'nop' if it isn't supplied, instead of 0.
1439 getStreamer().EmitFill(NumBytes, FillExpr, DEFAULT_ADDRSPACE);
1444 /// ParseDirectiveZero
1445 /// ::= .zero expression
1446 bool AsmParser::ParseDirectiveZero() {
1447 CheckForValidSection();
1450 if (ParseAbsoluteExpression(NumBytes))
1453 if (getLexer().isNot(AsmToken::EndOfStatement))
1454 return TokError("unexpected token in '.zero' directive");
1458 getStreamer().EmitFill(NumBytes, 0, DEFAULT_ADDRSPACE);
1463 /// ParseDirectiveFill
1464 /// ::= .fill expression , expression , expression
1465 bool AsmParser::ParseDirectiveFill() {
1466 CheckForValidSection();
1469 if (ParseAbsoluteExpression(NumValues))
1472 if (getLexer().isNot(AsmToken::Comma))
1473 return TokError("unexpected token in '.fill' directive");
1477 if (ParseAbsoluteExpression(FillSize))
1480 if (getLexer().isNot(AsmToken::Comma))
1481 return TokError("unexpected token in '.fill' directive");
1485 if (ParseAbsoluteExpression(FillExpr))
1488 if (getLexer().isNot(AsmToken::EndOfStatement))
1489 return TokError("unexpected token in '.fill' directive");
1493 if (FillSize != 1 && FillSize != 2 && FillSize != 4 && FillSize != 8)
1494 return TokError("invalid '.fill' size, expected 1, 2, 4, or 8");
1496 for (uint64_t i = 0, e = NumValues; i != e; ++i)
1497 getStreamer().EmitIntValue(FillExpr, FillSize, DEFAULT_ADDRSPACE);
1502 /// ParseDirectiveOrg
1503 /// ::= .org expression [ , expression ]
1504 bool AsmParser::ParseDirectiveOrg() {
1505 CheckForValidSection();
1507 const MCExpr *Offset;
1508 if (ParseExpression(Offset))
1511 // Parse optional fill expression.
1512 int64_t FillExpr = 0;
1513 if (getLexer().isNot(AsmToken::EndOfStatement)) {
1514 if (getLexer().isNot(AsmToken::Comma))
1515 return TokError("unexpected token in '.org' directive");
1518 if (ParseAbsoluteExpression(FillExpr))
1521 if (getLexer().isNot(AsmToken::EndOfStatement))
1522 return TokError("unexpected token in '.org' directive");
1527 // FIXME: Only limited forms of relocatable expressions are accepted here, it
1528 // has to be relative to the current section.
1529 getStreamer().EmitValueToOffset(Offset, FillExpr);
1534 /// ParseDirectiveAlign
1535 /// ::= {.align, ...} expression [ , expression [ , expression ]]
1536 bool AsmParser::ParseDirectiveAlign(bool IsPow2, unsigned ValueSize) {
1537 CheckForValidSection();
1539 SMLoc AlignmentLoc = getLexer().getLoc();
1541 if (ParseAbsoluteExpression(Alignment))
1545 bool HasFillExpr = false;
1546 int64_t FillExpr = 0;
1547 int64_t MaxBytesToFill = 0;
1548 if (getLexer().isNot(AsmToken::EndOfStatement)) {
1549 if (getLexer().isNot(AsmToken::Comma))
1550 return TokError("unexpected token in directive");
1553 // The fill expression can be omitted while specifying a maximum number of
1554 // alignment bytes, e.g:
1556 if (getLexer().isNot(AsmToken::Comma)) {
1558 if (ParseAbsoluteExpression(FillExpr))
1562 if (getLexer().isNot(AsmToken::EndOfStatement)) {
1563 if (getLexer().isNot(AsmToken::Comma))
1564 return TokError("unexpected token in directive");
1567 MaxBytesLoc = getLexer().getLoc();
1568 if (ParseAbsoluteExpression(MaxBytesToFill))
1571 if (getLexer().isNot(AsmToken::EndOfStatement))
1572 return TokError("unexpected token in directive");
1581 // Compute alignment in bytes.
1583 // FIXME: Diagnose overflow.
1584 if (Alignment >= 32) {
1585 Error(AlignmentLoc, "invalid alignment value");
1589 Alignment = 1ULL << Alignment;
1592 // Diagnose non-sensical max bytes to align.
1593 if (MaxBytesLoc.isValid()) {
1594 if (MaxBytesToFill < 1) {
1595 Error(MaxBytesLoc, "alignment directive can never be satisfied in this "
1596 "many bytes, ignoring maximum bytes expression");
1600 if (MaxBytesToFill >= Alignment) {
1601 Warning(MaxBytesLoc, "maximum bytes expression exceeds alignment and "
1607 // Check whether we should use optimal code alignment for this .align
1610 // FIXME: This should be using a target hook.
1611 bool UseCodeAlign = false;
1612 if (const MCSectionMachO *S = dyn_cast<MCSectionMachO>(
1613 getStreamer().getCurrentSection()))
1614 UseCodeAlign = S->hasAttribute(MCSectionMachO::S_ATTR_PURE_INSTRUCTIONS);
1615 if ((!HasFillExpr || Lexer.getMAI().getTextAlignFillValue() == FillExpr) &&
1616 ValueSize == 1 && UseCodeAlign) {
1617 getStreamer().EmitCodeAlignment(Alignment, MaxBytesToFill);
1619 // FIXME: Target specific behavior about how the "extra" bytes are filled.
1620 getStreamer().EmitValueToAlignment(Alignment, FillExpr, ValueSize,
1627 /// ParseDirectiveSymbolAttribute
1628 /// ::= { ".globl", ".weak", ... } [ identifier ( , identifier )* ]
1629 bool AsmParser::ParseDirectiveSymbolAttribute(MCSymbolAttr Attr) {
1630 if (getLexer().isNot(AsmToken::EndOfStatement)) {
1634 if (ParseIdentifier(Name))
1635 return TokError("expected identifier in directive");
1637 MCSymbol *Sym = getContext().GetOrCreateSymbol(Name);
1639 getStreamer().EmitSymbolAttribute(Sym, Attr);
1641 if (getLexer().is(AsmToken::EndOfStatement))
1644 if (getLexer().isNot(AsmToken::Comma))
1645 return TokError("unexpected token in directive");
1654 /// ParseDirectiveELFType
1655 /// ::= .type identifier , @attribute
1656 bool AsmParser::ParseDirectiveELFType() {
1658 if (ParseIdentifier(Name))
1659 return TokError("expected identifier in directive");
1661 // Handle the identifier as the key symbol.
1662 MCSymbol *Sym = getContext().GetOrCreateSymbol(Name);
1664 if (getLexer().isNot(AsmToken::Comma))
1665 return TokError("unexpected token in '.type' directive");
1668 if (getLexer().isNot(AsmToken::At))
1669 return TokError("expected '@' before type");
1675 TypeLoc = getLexer().getLoc();
1676 if (ParseIdentifier(Type))
1677 return TokError("expected symbol type in directive");
1679 MCSymbolAttr Attr = StringSwitch<MCSymbolAttr>(Type)
1680 .Case("function", MCSA_ELF_TypeFunction)
1681 .Case("object", MCSA_ELF_TypeObject)
1682 .Case("tls_object", MCSA_ELF_TypeTLS)
1683 .Case("common", MCSA_ELF_TypeCommon)
1684 .Case("notype", MCSA_ELF_TypeNoType)
1685 .Default(MCSA_Invalid);
1687 if (Attr == MCSA_Invalid)
1688 return Error(TypeLoc, "unsupported attribute in '.type' directive");
1690 if (getLexer().isNot(AsmToken::EndOfStatement))
1691 return TokError("unexpected token in '.type' directive");
1695 getStreamer().EmitSymbolAttribute(Sym, Attr);
1700 /// ParseDirectiveComm
1701 /// ::= ( .comm | .lcomm ) identifier , size_expression [ , align_expression ]
1702 bool AsmParser::ParseDirectiveComm(bool IsLocal) {
1703 CheckForValidSection();
1705 SMLoc IDLoc = getLexer().getLoc();
1707 if (ParseIdentifier(Name))
1708 return TokError("expected identifier in directive");
1710 // Handle the identifier as the key symbol.
1711 MCSymbol *Sym = getContext().GetOrCreateSymbol(Name);
1713 if (getLexer().isNot(AsmToken::Comma))
1714 return TokError("unexpected token in directive");
1718 SMLoc SizeLoc = getLexer().getLoc();
1719 if (ParseAbsoluteExpression(Size))
1722 int64_t Pow2Alignment = 0;
1723 SMLoc Pow2AlignmentLoc;
1724 if (getLexer().is(AsmToken::Comma)) {
1726 Pow2AlignmentLoc = getLexer().getLoc();
1727 if (ParseAbsoluteExpression(Pow2Alignment))
1730 // If this target takes alignments in bytes (not log) validate and convert.
1731 if (Lexer.getMAI().getAlignmentIsInBytes()) {
1732 if (!isPowerOf2_64(Pow2Alignment))
1733 return Error(Pow2AlignmentLoc, "alignment must be a power of 2");
1734 Pow2Alignment = Log2_64(Pow2Alignment);
1738 if (getLexer().isNot(AsmToken::EndOfStatement))
1739 return TokError("unexpected token in '.comm' or '.lcomm' directive");
1743 // NOTE: a size of zero for a .comm should create a undefined symbol
1744 // but a size of .lcomm creates a bss symbol of size zero.
1746 return Error(SizeLoc, "invalid '.comm' or '.lcomm' directive size, can't "
1747 "be less than zero");
1749 // NOTE: The alignment in the directive is a power of 2 value, the assembler
1750 // may internally end up wanting an alignment in bytes.
1751 // FIXME: Diagnose overflow.
1752 if (Pow2Alignment < 0)
1753 return Error(Pow2AlignmentLoc, "invalid '.comm' or '.lcomm' directive "
1754 "alignment, can't be less than zero");
1756 if (!Sym->isUndefined())
1757 return Error(IDLoc, "invalid symbol redefinition");
1759 // '.lcomm' is equivalent to '.zerofill'.
1760 // Create the Symbol as a common or local common with Size and Pow2Alignment
1762 getStreamer().EmitZerofill(Ctx.getMachOSection(
1763 "__DATA", "__bss", MCSectionMachO::S_ZEROFILL,
1764 0, SectionKind::getBSS()),
1765 Sym, Size, 1 << Pow2Alignment);
1769 getStreamer().EmitCommonSymbol(Sym, Size, 1 << Pow2Alignment);
1773 /// ParseDirectiveAbort
1774 /// ::= .abort [... message ...]
1775 bool AsmParser::ParseDirectiveAbort() {
1776 // FIXME: Use loc from directive.
1777 SMLoc Loc = getLexer().getLoc();
1779 StringRef Str = ParseStringToEndOfStatement();
1780 if (getLexer().isNot(AsmToken::EndOfStatement))
1781 return TokError("unexpected token in '.abort' directive");
1786 Error(Loc, ".abort detected. Assembly stopping.");
1788 Error(Loc, ".abort '" + Str + "' detected. Assembly stopping.");
1789 // FIXME: Actually abort assembly here.
1794 /// ParseDirectiveInclude
1795 /// ::= .include "filename"
1796 bool AsmParser::ParseDirectiveInclude() {
1797 if (getLexer().isNot(AsmToken::String))
1798 return TokError("expected string in '.include' directive");
1800 std::string Filename = getTok().getString();
1801 SMLoc IncludeLoc = getLexer().getLoc();
1804 if (getLexer().isNot(AsmToken::EndOfStatement))
1805 return TokError("unexpected token in '.include' directive");
1807 // Strip the quotes.
1808 Filename = Filename.substr(1, Filename.size()-2);
1810 // Attempt to switch the lexer to the included file before consuming the end
1811 // of statement to avoid losing it when we switch.
1812 if (EnterIncludeFile(Filename)) {
1813 Error(IncludeLoc, "Could not find include file '" + Filename + "'");
1820 /// ParseDirectiveIf
1821 /// ::= .if expression
1822 bool AsmParser::ParseDirectiveIf(SMLoc DirectiveLoc) {
1823 TheCondStack.push_back(TheCondState);
1824 TheCondState.TheCond = AsmCond::IfCond;
1825 if(TheCondState.Ignore) {
1826 EatToEndOfStatement();
1830 if (ParseAbsoluteExpression(ExprValue))
1833 if (getLexer().isNot(AsmToken::EndOfStatement))
1834 return TokError("unexpected token in '.if' directive");
1838 TheCondState.CondMet = ExprValue;
1839 TheCondState.Ignore = !TheCondState.CondMet;
1845 /// ParseDirectiveElseIf
1846 /// ::= .elseif expression
1847 bool AsmParser::ParseDirectiveElseIf(SMLoc DirectiveLoc) {
1848 if (TheCondState.TheCond != AsmCond::IfCond &&
1849 TheCondState.TheCond != AsmCond::ElseIfCond)
1850 Error(DirectiveLoc, "Encountered a .elseif that doesn't follow a .if or "
1852 TheCondState.TheCond = AsmCond::ElseIfCond;
1854 bool LastIgnoreState = false;
1855 if (!TheCondStack.empty())
1856 LastIgnoreState = TheCondStack.back().Ignore;
1857 if (LastIgnoreState || TheCondState.CondMet) {
1858 TheCondState.Ignore = true;
1859 EatToEndOfStatement();
1863 if (ParseAbsoluteExpression(ExprValue))
1866 if (getLexer().isNot(AsmToken::EndOfStatement))
1867 return TokError("unexpected token in '.elseif' directive");
1870 TheCondState.CondMet = ExprValue;
1871 TheCondState.Ignore = !TheCondState.CondMet;
1877 /// ParseDirectiveElse
1879 bool AsmParser::ParseDirectiveElse(SMLoc DirectiveLoc) {
1880 if (getLexer().isNot(AsmToken::EndOfStatement))
1881 return TokError("unexpected token in '.else' directive");
1885 if (TheCondState.TheCond != AsmCond::IfCond &&
1886 TheCondState.TheCond != AsmCond::ElseIfCond)
1887 Error(DirectiveLoc, "Encountered a .else that doesn't follow a .if or an "
1889 TheCondState.TheCond = AsmCond::ElseCond;
1890 bool LastIgnoreState = false;
1891 if (!TheCondStack.empty())
1892 LastIgnoreState = TheCondStack.back().Ignore;
1893 if (LastIgnoreState || TheCondState.CondMet)
1894 TheCondState.Ignore = true;
1896 TheCondState.Ignore = false;
1901 /// ParseDirectiveEndIf
1903 bool AsmParser::ParseDirectiveEndIf(SMLoc DirectiveLoc) {
1904 if (getLexer().isNot(AsmToken::EndOfStatement))
1905 return TokError("unexpected token in '.endif' directive");
1909 if ((TheCondState.TheCond == AsmCond::NoCond) ||
1910 TheCondStack.empty())
1911 Error(DirectiveLoc, "Encountered a .endif that doesn't follow a .if or "
1913 if (!TheCondStack.empty()) {
1914 TheCondState = TheCondStack.back();
1915 TheCondStack.pop_back();
1921 /// ParseDirectiveFile
1922 /// ::= .file [number] string
1923 bool GenericAsmParser::ParseDirectiveFile(StringRef, SMLoc DirectiveLoc) {
1924 // FIXME: I'm not sure what this is.
1925 int64_t FileNumber = -1;
1926 SMLoc FileNumberLoc = getLexer().getLoc();
1927 if (getLexer().is(AsmToken::Integer)) {
1928 FileNumber = getTok().getIntVal();
1932 return TokError("file number less than one");
1935 if (getLexer().isNot(AsmToken::String))
1936 return TokError("unexpected token in '.file' directive");
1938 StringRef Filename = getTok().getString();
1939 Filename = Filename.substr(1, Filename.size()-2);
1942 if (getLexer().isNot(AsmToken::EndOfStatement))
1943 return TokError("unexpected token in '.file' directive");
1945 if (FileNumber == -1)
1946 getStreamer().EmitFileDirective(Filename);
1948 if (getContext().GetDwarfFile(Filename, FileNumber) == 0)
1949 Error(FileNumberLoc, "file number already allocated");
1950 getStreamer().EmitDwarfFileDirective(FileNumber, Filename);
1956 /// ParseDirectiveLine
1957 /// ::= .line [number]
1958 bool GenericAsmParser::ParseDirectiveLine(StringRef, SMLoc DirectiveLoc) {
1959 if (getLexer().isNot(AsmToken::EndOfStatement)) {
1960 if (getLexer().isNot(AsmToken::Integer))
1961 return TokError("unexpected token in '.line' directive");
1963 int64_t LineNumber = getTok().getIntVal();
1967 // FIXME: Do something with the .line.
1970 if (getLexer().isNot(AsmToken::EndOfStatement))
1971 return TokError("unexpected token in '.line' directive");
1977 /// ParseDirectiveLoc
1978 /// ::= .loc FileNumber [LineNumber] [ColumnPos] [basic_block] [prologue_end]
1979 /// [epilogue_begin] [is_stmt VALUE] [isa VALUE]
1980 /// The first number is a file number, must have been previously assigned with
1981 /// a .file directive, the second number is the line number and optionally the
1982 /// third number is a column position (zero if not specified). The remaining
1983 /// optional items are .loc sub-directives.
1984 bool GenericAsmParser::ParseDirectiveLoc(StringRef, SMLoc DirectiveLoc) {
1986 if (getLexer().isNot(AsmToken::Integer))
1987 return TokError("unexpected token in '.loc' directive");
1988 int64_t FileNumber = getTok().getIntVal();
1990 return TokError("file number less than one in '.loc' directive");
1991 if (!getContext().ValidateDwarfFileNumber(FileNumber))
1992 return TokError("unassigned file number in '.loc' directive");
1995 int64_t LineNumber = 0;
1996 if (getLexer().is(AsmToken::Integer)) {
1997 LineNumber = getTok().getIntVal();
1999 return TokError("line number less than one in '.loc' directive");
2003 int64_t ColumnPos = 0;
2004 if (getLexer().is(AsmToken::Integer)) {
2005 ColumnPos = getTok().getIntVal();
2007 return TokError("column position less than zero in '.loc' directive");
2013 if (getLexer().isNot(AsmToken::EndOfStatement)) {
2015 if (getLexer().is(AsmToken::EndOfStatement))
2019 SMLoc Loc = getTok().getLoc();
2020 if (getParser().ParseIdentifier(Name))
2021 return TokError("unexpected token in '.loc' directive");
2023 if (Name == "basic_block")
2024 Flags |= DWARF2_FLAG_BASIC_BLOCK;
2025 else if (Name == "prologue_end")
2026 Flags |= DWARF2_FLAG_PROLOGUE_END;
2027 else if (Name == "epilogue_begin")
2028 Flags |= DWARF2_FLAG_EPILOGUE_BEGIN;
2029 else if (Name == "is_stmt") {
2030 SMLoc Loc = getTok().getLoc();
2031 const MCExpr *Value;
2032 if (getParser().ParseExpression(Value))
2034 // The expression must be the constant 0 or 1.
2035 if (const MCConstantExpr *MCE = dyn_cast<MCConstantExpr>(Value)) {
2036 int Value = MCE->getValue();
2038 Flags &= ~DWARF2_FLAG_IS_STMT;
2039 else if (Value == 1)
2040 Flags |= DWARF2_FLAG_IS_STMT;
2042 return Error(Loc, "is_stmt value not 0 or 1");
2045 return Error(Loc, "is_stmt value not the constant value of 0 or 1");
2048 else if (Name == "isa") {
2049 SMLoc Loc = getTok().getLoc();
2050 const MCExpr *Value;
2051 if (getParser().ParseExpression(Value))
2053 // The expression must be a constant greater or equal to 0.
2054 if (const MCConstantExpr *MCE = dyn_cast<MCConstantExpr>(Value)) {
2055 int Value = MCE->getValue();
2057 return Error(Loc, "isa number less than zero");
2061 return Error(Loc, "isa number not a constant value");
2065 return Error(Loc, "unknown sub-directive in '.loc' directive");
2068 if (getLexer().is(AsmToken::EndOfStatement))
2073 getContext().setCurrentDwarfLoc(FileNumber, LineNumber, ColumnPos, Flags,Isa);
2078 /// ParseDirectiveMacrosOnOff
2081 bool GenericAsmParser::ParseDirectiveMacrosOnOff(StringRef Directive,
2082 SMLoc DirectiveLoc) {
2083 if (getLexer().isNot(AsmToken::EndOfStatement))
2084 return Error(getLexer().getLoc(),
2085 "unexpected token in '" + Directive + "' directive");
2087 getParser().MacrosEnabled = Directive == ".macros_on";
2092 /// ParseDirectiveMacro
2094 bool GenericAsmParser::ParseDirectiveMacro(StringRef Directive,
2095 SMLoc DirectiveLoc) {
2097 if (getParser().ParseIdentifier(Name))
2098 return TokError("expected identifier in directive");
2100 if (getLexer().isNot(AsmToken::EndOfStatement))
2101 return TokError("unexpected token in '.macro' directive");
2103 // Eat the end of statement.
2106 AsmToken EndToken, StartToken = getTok();
2108 // Lex the macro definition.
2110 // Check whether we have reached the end of the file.
2111 if (getLexer().is(AsmToken::Eof))
2112 return Error(DirectiveLoc, "no matching '.endmacro' in definition");
2114 // Otherwise, check whether we have reach the .endmacro.
2115 if (getLexer().is(AsmToken::Identifier) &&
2116 (getTok().getIdentifier() == ".endm" ||
2117 getTok().getIdentifier() == ".endmacro")) {
2118 EndToken = getTok();
2120 if (getLexer().isNot(AsmToken::EndOfStatement))
2121 return TokError("unexpected token in '" + EndToken.getIdentifier() +
2126 // Otherwise, scan til the end of the statement.
2127 getParser().EatToEndOfStatement();
2130 if (getParser().MacroMap.lookup(Name)) {
2131 return Error(DirectiveLoc, "macro '" + Name + "' is already defined");
2134 const char *BodyStart = StartToken.getLoc().getPointer();
2135 const char *BodyEnd = EndToken.getLoc().getPointer();
2136 StringRef Body = StringRef(BodyStart, BodyEnd - BodyStart);
2137 getParser().MacroMap[Name] = new Macro(Name, Body);
2141 /// ParseDirectiveEndMacro
2144 bool GenericAsmParser::ParseDirectiveEndMacro(StringRef Directive,
2145 SMLoc DirectiveLoc) {
2146 if (getLexer().isNot(AsmToken::EndOfStatement))
2147 return TokError("unexpected token in '" + Directive + "' directive");
2149 // If we are inside a macro instantiation, terminate the current
2151 if (!getParser().ActiveMacros.empty()) {
2152 getParser().HandleMacroExit();
2156 // Otherwise, this .endmacro is a stray entry in the file; well formed
2157 // .endmacro directives are handled during the macro definition parsing.
2158 return TokError("unexpected '" + Directive + "' in file, "
2159 "no current macro definition");
2162 void GenericAsmParser::ParseUleb128(uint64_t Value) {
2163 const uint64_t Mask = (1 << 7) - 1;
2165 unsigned Byte = Value & Mask;
2167 if (Value) // Not the last one
2169 getStreamer().EmitIntValue(Byte, 1, DEFAULT_ADDRSPACE);
2173 void GenericAsmParser::ParseSleb128(int64_t Value) {
2174 const int64_t Mask = (1 << 7) - 1;
2176 unsigned Byte = Value & Mask;
2178 bool Done = ((Value == 0 && (Byte & 0x40) == 0) ||
2179 (Value == -1 && (Byte & 0x40) != 0));
2182 getStreamer().EmitIntValue(Byte, 1, DEFAULT_ADDRSPACE);
2188 bool GenericAsmParser::ParseDirectiveLEB128(StringRef DirName, SMLoc) {
2190 if (getParser().ParseAbsoluteExpression(Value))
2193 if (getLexer().isNot(AsmToken::EndOfStatement))
2194 return TokError("unexpected token in directive");
2196 if (DirName[1] == 's')
2197 ParseSleb128(Value);
2199 ParseUleb128(Value);
2204 /// \brief Create an MCAsmParser instance.
2205 MCAsmParser *llvm::createMCAsmParser(const Target &T, SourceMgr &SM,
2206 MCContext &C, MCStreamer &Out,
2207 const MCAsmInfo &MAI) {
2208 return new AsmParser(T, SM, C, Out, MAI);