1 //===-- ARMAsmParser.cpp - Parse ARM assembly to MCInst instructions ------===//
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 //===----------------------------------------------------------------------===//
11 #include "ARMAddressingModes.h"
12 #include "ARMSubtarget.h"
13 #include "llvm/MC/MCParser/MCAsmLexer.h"
14 #include "llvm/MC/MCParser/MCAsmParser.h"
15 #include "llvm/MC/MCParser/MCParsedAsmOperand.h"
16 #include "llvm/MC/MCContext.h"
17 #include "llvm/MC/MCStreamer.h"
18 #include "llvm/MC/MCExpr.h"
19 #include "llvm/MC/MCInst.h"
20 #include "llvm/Target/TargetRegistry.h"
21 #include "llvm/Target/TargetAsmParser.h"
22 #include "llvm/Support/SourceMgr.h"
23 #include "llvm/Support/raw_ostream.h"
24 #include "llvm/ADT/SmallVector.h"
25 #include "llvm/ADT/StringSwitch.h"
26 #include "llvm/ADT/Twine.h"
29 /// Shift types used for register controlled shifts in ARM memory addressing.
42 class ARMAsmParser : public TargetAsmParser {
46 MCAsmParser &getParser() const { return Parser; }
47 MCAsmLexer &getLexer() const { return Parser.getLexer(); }
49 void Warning(SMLoc L, const Twine &Msg) { Parser.Warning(L, Msg); }
50 bool Error(SMLoc L, const Twine &Msg) { return Parser.Error(L, Msg); }
52 int TryParseRegister();
53 bool TryParseRegisterWithWriteBack(SmallVectorImpl<MCParsedAsmOperand*> &);
54 bool ParseRegisterList(SmallVectorImpl<MCParsedAsmOperand*> &);
55 bool ParseMemory(SmallVectorImpl<MCParsedAsmOperand*> &);
56 bool ParseOperand(SmallVectorImpl<MCParsedAsmOperand*> &);
58 bool ParseMemoryOffsetReg(bool &Negative,
59 bool &OffsetRegShifted,
60 enum ShiftType &ShiftType,
61 const MCExpr *&ShiftAmount,
62 const MCExpr *&Offset,
66 bool ParseShift(enum ShiftType &St, const MCExpr *&ShiftAmount, SMLoc &E);
67 bool ParseDirectiveWord(unsigned Size, SMLoc L);
68 bool ParseDirectiveThumb(SMLoc L);
69 bool ParseDirectiveThumbFunc(SMLoc L);
70 bool ParseDirectiveCode(SMLoc L);
71 bool ParseDirectiveSyntax(SMLoc L);
73 bool MatchAndEmitInstruction(SMLoc IDLoc,
74 SmallVectorImpl<MCParsedAsmOperand*> &Operands,
77 /// @name Auto-generated Match Functions
80 #define GET_ASSEMBLER_HEADER
81 #include "ARMGenAsmMatcher.inc"
86 ARMAsmParser(const Target &T, MCAsmParser &_Parser, TargetMachine &_TM)
87 : TargetAsmParser(T), Parser(_Parser), TM(_TM) {
88 // Initialize the set of available features.
89 setAvailableFeatures(ComputeAvailableFeatures(
90 &TM.getSubtarget<ARMSubtarget>()));
93 virtual bool ParseInstruction(StringRef Name, SMLoc NameLoc,
94 SmallVectorImpl<MCParsedAsmOperand*> &Operands);
95 virtual bool ParseDirective(AsmToken DirectiveID);
97 } // end anonymous namespace
101 /// ARMOperand - Instances of this class represent a parsed ARM machine
103 class ARMOperand : public MCParsedAsmOperand {
116 SMLoc StartLoc, EndLoc;
117 SmallVector<unsigned, 8> Registers;
121 ARMCC::CondCodes Val;
137 /// Combined record for all forms of ARM address expressions.
140 unsigned OffsetRegNum; // used when OffsetIsReg is true
141 const MCExpr *Offset; // used when OffsetIsReg is false
142 const MCExpr *ShiftAmount; // used when OffsetRegShifted is true
143 enum ShiftType ShiftType; // used when OffsetRegShifted is true
144 unsigned OffsetRegShifted : 1; // only used when OffsetIsReg is true
145 unsigned Preindexed : 1;
146 unsigned Postindexed : 1;
147 unsigned OffsetIsReg : 1;
148 unsigned Negative : 1; // only used when OffsetIsReg is true
149 unsigned Writeback : 1;
153 ARMOperand(KindTy K) : MCParsedAsmOperand(), Kind(K) {}
155 ARMOperand(const ARMOperand &o) : MCParsedAsmOperand() {
157 StartLoc = o.StartLoc;
171 case DPRRegisterList:
172 case SPRRegisterList:
173 Registers = o.Registers;
184 /// getStartLoc - Get the location of the first token of this operand.
185 SMLoc getStartLoc() const { return StartLoc; }
186 /// getEndLoc - Get the location of the last token of this operand.
187 SMLoc getEndLoc() const { return EndLoc; }
189 ARMCC::CondCodes getCondCode() const {
190 assert(Kind == CondCode && "Invalid access!");
194 StringRef getToken() const {
195 assert(Kind == Token && "Invalid access!");
196 return StringRef(Tok.Data, Tok.Length);
199 unsigned getReg() const {
200 assert((Kind == Register || Kind == CCOut) && "Invalid access!");
204 const SmallVectorImpl<unsigned> &getRegList() const {
205 assert((Kind == RegisterList || Kind == DPRRegisterList ||
206 Kind == SPRRegisterList) && "Invalid access!");
210 const MCExpr *getImm() const {
211 assert(Kind == Immediate && "Invalid access!");
215 bool isCondCode() const { return Kind == CondCode; }
216 bool isCCOut() const { return Kind == CCOut; }
217 bool isImm() const { return Kind == Immediate; }
218 bool isReg() const { return Kind == Register; }
219 bool isRegList() const { return Kind == RegisterList; }
220 bool isDPRRegList() const { return Kind == DPRRegisterList; }
221 bool isSPRRegList() const { return Kind == SPRRegisterList; }
222 bool isToken() const { return Kind == Token; }
223 bool isMemory() const { return Kind == Memory; }
224 bool isMemMode5() const {
225 if (!isMemory() || Mem.OffsetIsReg || Mem.OffsetRegShifted ||
226 Mem.Writeback || Mem.Negative)
229 // If there is an offset expression, make sure it's valid.
230 if (!Mem.Offset) return true;
232 const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(Mem.Offset);
233 if (!CE) return false;
235 // The offset must be a multiple of 4 in the range 0-1020.
236 int64_t Value = CE->getValue();
237 return ((Value & 0x3) == 0 && Value <= 1020 && Value >= -1020);
239 bool isMemModeRegThumb() const {
240 if (!isMemory() || (!Mem.OffsetIsReg && !Mem.Offset) || Mem.Writeback)
242 return !Mem.Offset || !isa<MCConstantExpr>(Mem.Offset);
244 bool isMemModeImmThumb() const {
245 if (!isMemory() || (!Mem.OffsetIsReg && !Mem.Offset) || Mem.Writeback)
248 if (!Mem.Offset) return false;
250 const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(Mem.Offset);
251 if (!CE) return false;
253 // The offset must be a multiple of 4 in the range 0-124.
254 uint64_t Value = CE->getValue();
255 return ((Value & 0x3) == 0 && Value <= 124);
258 void addExpr(MCInst &Inst, const MCExpr *Expr) const {
259 // Add as immediates when possible. Null MCExpr = 0.
261 Inst.addOperand(MCOperand::CreateImm(0));
262 else if (const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(Expr))
263 Inst.addOperand(MCOperand::CreateImm(CE->getValue()));
265 Inst.addOperand(MCOperand::CreateExpr(Expr));
268 void addCondCodeOperands(MCInst &Inst, unsigned N) const {
269 assert(N == 2 && "Invalid number of operands!");
270 Inst.addOperand(MCOperand::CreateImm(unsigned(getCondCode())));
271 unsigned RegNum = getCondCode() == ARMCC::AL ? 0: ARM::CPSR;
272 Inst.addOperand(MCOperand::CreateReg(RegNum));
275 void addCCOutOperands(MCInst &Inst, unsigned N) const {
276 assert(N == 1 && "Invalid number of operands!");
277 Inst.addOperand(MCOperand::CreateReg(getReg()));
280 void addRegOperands(MCInst &Inst, unsigned N) const {
281 assert(N == 1 && "Invalid number of operands!");
282 Inst.addOperand(MCOperand::CreateReg(getReg()));
285 void addRegListOperands(MCInst &Inst, unsigned N) const {
286 assert(N == 1 && "Invalid number of operands!");
287 const SmallVectorImpl<unsigned> &RegList = getRegList();
288 for (SmallVectorImpl<unsigned>::const_iterator
289 I = RegList.begin(), E = RegList.end(); I != E; ++I)
290 Inst.addOperand(MCOperand::CreateReg(*I));
293 void addDPRRegListOperands(MCInst &Inst, unsigned N) const {
294 addRegListOperands(Inst, N);
297 void addSPRRegListOperands(MCInst &Inst, unsigned N) const {
298 addRegListOperands(Inst, N);
301 void addImmOperands(MCInst &Inst, unsigned N) const {
302 assert(N == 1 && "Invalid number of operands!");
303 addExpr(Inst, getImm());
306 void addMemMode5Operands(MCInst &Inst, unsigned N) const {
307 assert(N == 2 && isMemMode5() && "Invalid number of operands!");
309 Inst.addOperand(MCOperand::CreateReg(Mem.BaseRegNum));
310 assert(!Mem.OffsetIsReg && "Invalid mode 5 operand");
312 // FIXME: #-0 is encoded differently than #0. Does the parser preserve
315 const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(Mem.Offset);
316 assert(CE && "Non-constant mode 5 offset operand!");
318 // The MCInst offset operand doesn't include the low two bits (like
319 // the instruction encoding).
320 int64_t Offset = CE->getValue() / 4;
322 Inst.addOperand(MCOperand::CreateImm(ARM_AM::getAM5Opc(ARM_AM::add,
325 Inst.addOperand(MCOperand::CreateImm(ARM_AM::getAM5Opc(ARM_AM::sub,
328 Inst.addOperand(MCOperand::CreateImm(0));
332 void addMemModeRegThumbOperands(MCInst &Inst, unsigned N) const {
333 assert(N == 2 && isMemModeRegThumb() && "Invalid number of operands!");
334 Inst.addOperand(MCOperand::CreateReg(Mem.BaseRegNum));
335 Inst.addOperand(MCOperand::CreateReg(Mem.OffsetRegNum));
338 void addMemModeImmThumbOperands(MCInst &Inst, unsigned N) const {
339 assert(N == 2 && isMemModeImmThumb() && "Invalid number of operands!");
340 Inst.addOperand(MCOperand::CreateReg(Mem.BaseRegNum));
341 const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(Mem.Offset);
342 assert(CE && "Non-constant mode offset operand!");
343 Inst.addOperand(MCOperand::CreateImm(CE->getValue()));
346 virtual void dump(raw_ostream &OS) const;
348 static ARMOperand *CreateCondCode(ARMCC::CondCodes CC, SMLoc S) {
349 ARMOperand *Op = new ARMOperand(CondCode);
356 static ARMOperand *CreateCCOut(unsigned RegNum, SMLoc S) {
357 ARMOperand *Op = new ARMOperand(CCOut);
358 Op->Reg.RegNum = RegNum;
364 static ARMOperand *CreateToken(StringRef Str, SMLoc S) {
365 ARMOperand *Op = new ARMOperand(Token);
366 Op->Tok.Data = Str.data();
367 Op->Tok.Length = Str.size();
373 static ARMOperand *CreateReg(unsigned RegNum, SMLoc S, SMLoc E) {
374 ARMOperand *Op = new ARMOperand(Register);
375 Op->Reg.RegNum = RegNum;
382 CreateRegList(const SmallVectorImpl<std::pair<unsigned, SMLoc> > &Regs,
383 SMLoc StartLoc, SMLoc EndLoc) {
384 KindTy Kind = RegisterList;
386 if (ARM::DPRRegClass.contains(Regs.front().first))
387 Kind = DPRRegisterList;
388 else if (ARM::SPRRegClass.contains(Regs.front().first))
389 Kind = SPRRegisterList;
391 ARMOperand *Op = new ARMOperand(Kind);
392 for (SmallVectorImpl<std::pair<unsigned, SMLoc> >::const_iterator
393 I = Regs.begin(), E = Regs.end(); I != E; ++I)
394 Op->Registers.push_back(I->first);
395 array_pod_sort(Op->Registers.begin(), Op->Registers.end());
396 Op->StartLoc = StartLoc;
401 static ARMOperand *CreateImm(const MCExpr *Val, SMLoc S, SMLoc E) {
402 ARMOperand *Op = new ARMOperand(Immediate);
409 static ARMOperand *CreateMem(unsigned BaseRegNum, bool OffsetIsReg,
410 const MCExpr *Offset, unsigned OffsetRegNum,
411 bool OffsetRegShifted, enum ShiftType ShiftType,
412 const MCExpr *ShiftAmount, bool Preindexed,
413 bool Postindexed, bool Negative, bool Writeback,
415 ARMOperand *Op = new ARMOperand(Memory);
416 Op->Mem.BaseRegNum = BaseRegNum;
417 Op->Mem.OffsetIsReg = OffsetIsReg;
418 Op->Mem.Offset = Offset;
419 Op->Mem.OffsetRegNum = OffsetRegNum;
420 Op->Mem.OffsetRegShifted = OffsetRegShifted;
421 Op->Mem.ShiftType = ShiftType;
422 Op->Mem.ShiftAmount = ShiftAmount;
423 Op->Mem.Preindexed = Preindexed;
424 Op->Mem.Postindexed = Postindexed;
425 Op->Mem.Negative = Negative;
426 Op->Mem.Writeback = Writeback;
434 } // end anonymous namespace.
436 void ARMOperand::dump(raw_ostream &OS) const {
439 OS << "<ARMCC::" << ARMCondCodeToString(getCondCode()) << ">";
442 OS << "<ccout " << getReg() << ">";
451 OS << "<register " << getReg() << ">";
454 case DPRRegisterList:
455 case SPRRegisterList: {
456 OS << "<register_list ";
458 const SmallVectorImpl<unsigned> &RegList = getRegList();
459 for (SmallVectorImpl<unsigned>::const_iterator
460 I = RegList.begin(), E = RegList.end(); I != E; ) {
462 if (++I < E) OS << ", ";
469 OS << "'" << getToken() << "'";
474 /// @name Auto-generated Match Functions
477 static unsigned MatchRegisterName(StringRef Name);
481 /// Try to parse a register name. The token must be an Identifier when called,
482 /// and if it is a register name the token is eaten and the register number is
483 /// returned. Otherwise return -1.
485 int ARMAsmParser::TryParseRegister() {
486 const AsmToken &Tok = Parser.getTok();
487 assert(Tok.is(AsmToken::Identifier) && "Token is not an Identifier");
489 // FIXME: Validate register for the current architecture; we have to do
490 // validation later, so maybe there is no need for this here.
491 unsigned RegNum = MatchRegisterName(Tok.getString());
494 Parser.Lex(); // Eat identifier token.
499 /// Try to parse a register name. The token must be an Identifier when called.
500 /// If it's a register, an AsmOperand is created. Another AsmOperand is created
501 /// if there is a "writeback". 'true' if it's not a register.
503 /// TODO this is likely to change to allow different register types and or to
504 /// parse for a specific register type.
506 TryParseRegisterWithWriteBack(SmallVectorImpl<MCParsedAsmOperand*> &Operands) {
507 SMLoc S = Parser.getTok().getLoc();
508 int RegNo = TryParseRegister();
512 Operands.push_back(ARMOperand::CreateReg(RegNo, S, Parser.getTok().getLoc()));
514 const AsmToken &ExclaimTok = Parser.getTok();
515 if (ExclaimTok.is(AsmToken::Exclaim)) {
516 Operands.push_back(ARMOperand::CreateToken(ExclaimTok.getString(),
517 ExclaimTok.getLoc()));
518 Parser.Lex(); // Eat exclaim token
524 /// Parse a register list, return it if successful else return null. The first
525 /// token must be a '{' when called.
527 ParseRegisterList(SmallVectorImpl<MCParsedAsmOperand*> &Operands) {
528 assert(Parser.getTok().is(AsmToken::LCurly) &&
529 "Token is not a Left Curly Brace");
530 SMLoc S = Parser.getTok().getLoc();
532 // Read the rest of the registers in the list.
533 unsigned PrevRegNum = 0;
534 SmallVector<std::pair<unsigned, SMLoc>, 32> Registers;
537 bool IsRange = Parser.getTok().is(AsmToken::Minus);
538 Parser.Lex(); // Eat non-identifier token.
540 const AsmToken &RegTok = Parser.getTok();
541 SMLoc RegLoc = RegTok.getLoc();
542 if (RegTok.isNot(AsmToken::Identifier)) {
543 Error(RegLoc, "register expected");
547 int RegNum = TryParseRegister();
549 Error(RegLoc, "register expected");
554 int Reg = PrevRegNum;
557 Registers.push_back(std::make_pair(Reg, RegLoc));
558 } while (Reg != RegNum);
560 Registers.push_back(std::make_pair(RegNum, RegLoc));
564 } while (Parser.getTok().is(AsmToken::Comma) ||
565 Parser.getTok().is(AsmToken::Minus));
567 // Process the right curly brace of the list.
568 const AsmToken &RCurlyTok = Parser.getTok();
569 if (RCurlyTok.isNot(AsmToken::RCurly)) {
570 Error(RCurlyTok.getLoc(), "'}' expected");
574 SMLoc E = RCurlyTok.getLoc();
575 Parser.Lex(); // Eat right curly brace token.
577 // Verify the register list.
578 SmallVectorImpl<std::pair<unsigned, SMLoc> >::const_iterator
579 RI = Registers.begin(), RE = Registers.end();
581 DenseMap<unsigned, bool> RegMap;
582 RegMap[RI->first] = true;
584 unsigned HighRegNum = RI->first;
585 bool EmittedWarning = false;
587 for (++RI; RI != RE; ++RI) {
588 const std::pair<unsigned, SMLoc> &RegInfo = *RI;
589 unsigned Reg = RegInfo.first;
592 Error(RegInfo.second, "register duplicated in register list");
596 if (!EmittedWarning && Reg < HighRegNum)
597 Warning(RegInfo.second,
598 "register not in ascending order in register list");
601 HighRegNum = std::max(Reg, HighRegNum);
604 Operands.push_back(ARMOperand::CreateRegList(Registers, S, E));
608 /// Parse an ARM memory expression, return false if successful else return true
609 /// or an error. The first token must be a '[' when called.
611 /// TODO Only preindexing and postindexing addressing are started, unindexed
612 /// with option, etc are still to do.
614 ParseMemory(SmallVectorImpl<MCParsedAsmOperand*> &Operands) {
616 assert(Parser.getTok().is(AsmToken::LBrac) &&
617 "Token is not a Left Bracket");
618 S = Parser.getTok().getLoc();
619 Parser.Lex(); // Eat left bracket token.
621 const AsmToken &BaseRegTok = Parser.getTok();
622 if (BaseRegTok.isNot(AsmToken::Identifier)) {
623 Error(BaseRegTok.getLoc(), "register expected");
626 int BaseRegNum = TryParseRegister();
627 if (BaseRegNum == -1) {
628 Error(BaseRegTok.getLoc(), "register expected");
632 bool Preindexed = false;
633 bool Postindexed = false;
634 bool OffsetIsReg = false;
635 bool Negative = false;
636 bool Writeback = false;
638 // First look for preindexed address forms, that is after the "[Rn" we now
639 // have to see if the next token is a comma.
640 const AsmToken &Tok = Parser.getTok();
641 if (Tok.is(AsmToken::Comma)) {
643 Parser.Lex(); // Eat comma token.
645 bool OffsetRegShifted;
646 enum ShiftType ShiftType;
647 const MCExpr *ShiftAmount = 0;
648 const MCExpr *Offset = 0;
649 if (ParseMemoryOffsetReg(Negative, OffsetRegShifted, ShiftType, ShiftAmount,
650 Offset, OffsetIsReg, OffsetRegNum, E))
652 const AsmToken &RBracTok = Parser.getTok();
653 if (RBracTok.isNot(AsmToken::RBrac)) {
654 Error(RBracTok.getLoc(), "']' expected");
657 E = RBracTok.getLoc();
658 Parser.Lex(); // Eat right bracket token.
661 const AsmToken &ExclaimTok = Parser.getTok();
662 ARMOperand *WBOp = 0;
663 if (ExclaimTok.is(AsmToken::Exclaim)) {
664 WBOp = ARMOperand::CreateToken(ExclaimTok.getString(),
665 ExclaimTok.getLoc());
667 Parser.Lex(); // Eat exclaim token
670 Operands.push_back(ARMOperand::CreateMem(BaseRegNum, OffsetIsReg, Offset,
671 OffsetRegNum, OffsetRegShifted,
672 ShiftType, ShiftAmount, Preindexed,
673 Postindexed, Negative, Writeback,
676 Operands.push_back(WBOp);
680 // The "[Rn" we have so far was not followed by a comma.
681 else if (Tok.is(AsmToken::RBrac)) {
682 // If there's anything other than the right brace, this is a post indexing
685 Parser.Lex(); // Eat right bracket token.
687 int OffsetRegNum = 0;
688 bool OffsetRegShifted = false;
689 enum ShiftType ShiftType = Lsl;
690 const MCExpr *ShiftAmount = 0;
691 const MCExpr *Offset = 0;
693 const AsmToken &NextTok = Parser.getTok();
695 if (NextTok.isNot(AsmToken::EndOfStatement)) {
699 if (NextTok.isNot(AsmToken::Comma)) {
700 Error(NextTok.getLoc(), "',' expected");
704 Parser.Lex(); // Eat comma token.
706 if (ParseMemoryOffsetReg(Negative, OffsetRegShifted, ShiftType,
707 ShiftAmount, Offset, OffsetIsReg, OffsetRegNum,
712 Operands.push_back(ARMOperand::CreateMem(BaseRegNum, OffsetIsReg, Offset,
713 OffsetRegNum, OffsetRegShifted,
714 ShiftType, ShiftAmount, Preindexed,
715 Postindexed, Negative, Writeback,
723 /// Parse the offset of a memory operand after we have seen "[Rn," or "[Rn],"
724 /// we will parse the following (were +/- means that a plus or minus is
729 /// we return false on success or an error otherwise.
730 bool ARMAsmParser::ParseMemoryOffsetReg(bool &Negative,
731 bool &OffsetRegShifted,
732 enum ShiftType &ShiftType,
733 const MCExpr *&ShiftAmount,
734 const MCExpr *&Offset,
739 OffsetRegShifted = false;
742 const AsmToken &NextTok = Parser.getTok();
743 E = NextTok.getLoc();
744 if (NextTok.is(AsmToken::Plus))
745 Parser.Lex(); // Eat plus token.
746 else if (NextTok.is(AsmToken::Minus)) {
748 Parser.Lex(); // Eat minus token
750 // See if there is a register following the "[Rn," or "[Rn]," we have so far.
751 const AsmToken &OffsetRegTok = Parser.getTok();
752 if (OffsetRegTok.is(AsmToken::Identifier)) {
753 SMLoc CurLoc = OffsetRegTok.getLoc();
754 OffsetRegNum = TryParseRegister();
755 if (OffsetRegNum != -1) {
761 // If we parsed a register as the offset then there can be a shift after that.
762 if (OffsetRegNum != -1) {
763 // Look for a comma then a shift
764 const AsmToken &Tok = Parser.getTok();
765 if (Tok.is(AsmToken::Comma)) {
766 Parser.Lex(); // Eat comma token.
768 const AsmToken &Tok = Parser.getTok();
769 if (ParseShift(ShiftType, ShiftAmount, E))
770 return Error(Tok.getLoc(), "shift expected");
771 OffsetRegShifted = true;
774 else { // the "[Rn," or "[Rn,]" we have so far was not followed by "Rm"
775 // Look for #offset following the "[Rn," or "[Rn],"
776 const AsmToken &HashTok = Parser.getTok();
777 if (HashTok.isNot(AsmToken::Hash))
778 return Error(HashTok.getLoc(), "'#' expected");
780 Parser.Lex(); // Eat hash token.
782 if (getParser().ParseExpression(Offset))
784 E = SMLoc::getFromPointer(Parser.getTok().getLoc().getPointer() - 1);
789 /// ParseShift as one of these two:
790 /// ( lsl | lsr | asr | ror ) , # shift_amount
792 /// and returns true if it parses a shift otherwise it returns false.
793 bool ARMAsmParser::ParseShift(ShiftType &St, const MCExpr *&ShiftAmount,
795 const AsmToken &Tok = Parser.getTok();
796 if (Tok.isNot(AsmToken::Identifier))
798 StringRef ShiftName = Tok.getString();
799 if (ShiftName == "lsl" || ShiftName == "LSL")
801 else if (ShiftName == "lsr" || ShiftName == "LSR")
803 else if (ShiftName == "asr" || ShiftName == "ASR")
805 else if (ShiftName == "ror" || ShiftName == "ROR")
807 else if (ShiftName == "rrx" || ShiftName == "RRX")
811 Parser.Lex(); // Eat shift type token.
817 // Otherwise, there must be a '#' and a shift amount.
818 const AsmToken &HashTok = Parser.getTok();
819 if (HashTok.isNot(AsmToken::Hash))
820 return Error(HashTok.getLoc(), "'#' expected");
821 Parser.Lex(); // Eat hash token.
823 if (getParser().ParseExpression(ShiftAmount))
829 /// Parse a arm instruction operand. For now this parses the operand regardless
831 bool ARMAsmParser::ParseOperand(SmallVectorImpl<MCParsedAsmOperand*> &Operands){
833 switch (getLexer().getKind()) {
835 Error(Parser.getTok().getLoc(), "unexpected token in operand");
837 case AsmToken::Identifier: {
838 if (!TryParseRegisterWithWriteBack(Operands))
841 // This was not a register so parse other operands that start with an
842 // identifier (like labels) as expressions and create them as immediates.
844 S = Parser.getTok().getLoc();
845 if (getParser().ParseExpression(IdVal))
847 E = SMLoc::getFromPointer(Parser.getTok().getLoc().getPointer() - 1);
848 Operands.push_back(ARMOperand::CreateImm(IdVal, S, E));
851 case AsmToken::LBrac:
852 return ParseMemory(Operands);
853 case AsmToken::LCurly:
854 return ParseRegisterList(Operands);
857 // TODO: ":lower16:" and ":upper16:" modifiers after # before immediate
858 S = Parser.getTok().getLoc();
860 const MCExpr *ImmVal;
861 if (getParser().ParseExpression(ImmVal))
863 E = SMLoc::getFromPointer(Parser.getTok().getLoc().getPointer() - 1);
864 Operands.push_back(ARMOperand::CreateImm(ImmVal, S, E));
869 /// \brief Given a mnemonic, split out possible predication code and carry
870 /// setting letters to form a canonical mnemonic and flags.
872 // FIXME: Would be nice to autogen this.
873 static StringRef SplitMnemonicAndCC(StringRef Mnemonic,
874 unsigned &PredicationCode,
875 bool &CarrySetting) {
876 PredicationCode = ARMCC::AL;
877 CarrySetting = false;
879 // Ignore some mnemonics we know aren't predicated forms.
881 // FIXME: Would be nice to autogen this.
882 if (Mnemonic == "teq" || Mnemonic == "vceq" ||
883 Mnemonic == "movs" ||
885 (Mnemonic == "mls" || Mnemonic == "smmls" || Mnemonic == "vcls" ||
886 Mnemonic == "vmls" || Mnemonic == "vnmls") ||
887 Mnemonic == "vacge" || Mnemonic == "vcge" ||
888 Mnemonic == "vclt" ||
889 Mnemonic == "vacgt" || Mnemonic == "vcgt" ||
890 Mnemonic == "vcle" ||
891 (Mnemonic == "smlal" || Mnemonic == "umaal" || Mnemonic == "umlal" ||
892 Mnemonic == "vabal" || Mnemonic == "vmlal" || Mnemonic == "vpadal" ||
893 Mnemonic == "vqdmlal"))
896 // First, split out any predication code.
897 unsigned CC = StringSwitch<unsigned>(Mnemonic.substr(Mnemonic.size()-2))
898 .Case("eq", ARMCC::EQ)
899 .Case("ne", ARMCC::NE)
900 .Case("hs", ARMCC::HS)
901 .Case("lo", ARMCC::LO)
902 .Case("mi", ARMCC::MI)
903 .Case("pl", ARMCC::PL)
904 .Case("vs", ARMCC::VS)
905 .Case("vc", ARMCC::VC)
906 .Case("hi", ARMCC::HI)
907 .Case("ls", ARMCC::LS)
908 .Case("ge", ARMCC::GE)
909 .Case("lt", ARMCC::LT)
910 .Case("gt", ARMCC::GT)
911 .Case("le", ARMCC::LE)
912 .Case("al", ARMCC::AL)
915 Mnemonic = Mnemonic.slice(0, Mnemonic.size() - 2);
916 PredicationCode = CC;
919 // Next, determine if we have a carry setting bit. We explicitly ignore all
920 // the instructions we know end in 's'.
921 if (Mnemonic.endswith("s") &&
922 !(Mnemonic == "asrs" || Mnemonic == "cps" || Mnemonic == "mls" ||
923 Mnemonic == "movs" || Mnemonic == "mrs" || Mnemonic == "smmls" ||
924 Mnemonic == "vabs" || Mnemonic == "vcls" || Mnemonic == "vmls" ||
925 Mnemonic == "vmrs" || Mnemonic == "vnmls" || Mnemonic == "vqabs" ||
926 Mnemonic == "vrecps" || Mnemonic == "vrsqrts")) {
927 Mnemonic = Mnemonic.slice(0, Mnemonic.size() - 1);
935 /// Parse an arm instruction mnemonic followed by its operands.
936 bool ARMAsmParser::ParseInstruction(StringRef Name, SMLoc NameLoc,
937 SmallVectorImpl<MCParsedAsmOperand*> &Operands) {
938 // Create the leading tokens for the mnemonic, split by '.' characters.
939 size_t Start = 0, Next = Name.find('.');
940 StringRef Head = Name.slice(Start, Next);
942 // Split out the predication code and carry setting flag from the mnemonic.
943 unsigned PredicationCode;
945 Head = SplitMnemonicAndCC(Head, PredicationCode, CarrySetting);
947 Operands.push_back(ARMOperand::CreateToken(Head, NameLoc));
949 // FIXME: Should only add this operand for predicated instructions
950 if (Head != "trap") {
951 Operands.push_back(ARMOperand::CreateCondCode(ARMCC::CondCodes(CC),
955 // Add the remaining tokens in the mnemonic.
956 while (Next != StringRef::npos) {
958 Next = Name.find('.', Start + 1);
959 Head = Name.slice(Start, Next);
961 Operands.push_back(ARMOperand::CreateToken(Head, NameLoc));
964 // Read the remaining operands.
965 if (getLexer().isNot(AsmToken::EndOfStatement)) {
966 // Read the first operand.
967 if (ParseOperand(Operands)) {
968 Parser.EatToEndOfStatement();
972 while (getLexer().is(AsmToken::Comma)) {
973 Parser.Lex(); // Eat the comma.
975 // Parse and remember the operand.
976 if (ParseOperand(Operands)) {
977 Parser.EatToEndOfStatement();
983 if (getLexer().isNot(AsmToken::EndOfStatement)) {
984 Parser.EatToEndOfStatement();
985 return TokError("unexpected token in argument list");
988 Parser.Lex(); // Consume the EndOfStatement
993 MatchAndEmitInstruction(SMLoc IDLoc,
994 SmallVectorImpl<MCParsedAsmOperand*> &Operands,
998 MatchResultTy MatchResult, MatchResult2;
999 MatchResult = MatchInstructionImpl(Operands, Inst, ErrorInfo);
1000 if (MatchResult != Match_Success) {
1001 // If we get a Match_InvalidOperand it might be some arithmetic instruction
1002 // that does not update the condition codes. So try adding a CCOut operand
1003 // with a value of reg0.
1004 if (MatchResult == Match_InvalidOperand) {
1005 Operands.insert(Operands.begin() + 1,
1006 ARMOperand::CreateCCOut(0,
1007 ((ARMOperand*)Operands[0])->getStartLoc()));
1008 MatchResult2 = MatchInstructionImpl(Operands, Inst, ErrorInfo);
1009 if (MatchResult2 == Match_Success)
1010 MatchResult = Match_Success;
1012 ARMOperand *CCOut = ((ARMOperand*)Operands[1]);
1013 Operands.erase(Operands.begin() + 1);
1017 // If we get a Match_MnemonicFail it might be some arithmetic instruction
1018 // that updates the condition codes if it ends in 's'. So see if the
1019 // mnemonic ends in 's' and if so try removing the 's' and adding a CCOut
1020 // operand with a value of CPSR.
1021 else if(MatchResult == Match_MnemonicFail) {
1022 // Get the instruction mnemonic, which is the first token.
1023 StringRef Mnemonic = ((ARMOperand*)Operands[0])->getToken();
1024 if (Mnemonic.substr(Mnemonic.size()-1) == "s") {
1025 // removed the 's' from the mnemonic for matching.
1026 StringRef MnemonicNoS = Mnemonic.slice(0, Mnemonic.size() - 1);
1027 SMLoc NameLoc = ((ARMOperand*)Operands[0])->getStartLoc();
1028 ARMOperand *OldMnemonic = ((ARMOperand*)Operands[0]);
1029 Operands.erase(Operands.begin());
1031 Operands.insert(Operands.begin(),
1032 ARMOperand::CreateToken(MnemonicNoS, NameLoc));
1033 Operands.insert(Operands.begin() + 1,
1034 ARMOperand::CreateCCOut(ARM::CPSR, NameLoc));
1035 MatchResult2 = MatchInstructionImpl(Operands, Inst, ErrorInfo);
1036 if (MatchResult2 == Match_Success)
1037 MatchResult = Match_Success;
1039 ARMOperand *OldMnemonic = ((ARMOperand*)Operands[0]);
1040 Operands.erase(Operands.begin());
1042 Operands.insert(Operands.begin(),
1043 ARMOperand::CreateToken(Mnemonic, NameLoc));
1044 ARMOperand *CCOut = ((ARMOperand*)Operands[1]);
1045 Operands.erase(Operands.begin() + 1);
1051 switch (MatchResult) {
1053 Out.EmitInstruction(Inst);
1055 case Match_MissingFeature:
1056 Error(IDLoc, "instruction requires a CPU feature not currently enabled");
1058 case Match_InvalidOperand: {
1059 SMLoc ErrorLoc = IDLoc;
1060 if (ErrorInfo != ~0U) {
1061 if (ErrorInfo >= Operands.size())
1062 return Error(IDLoc, "too few operands for instruction");
1064 ErrorLoc = ((ARMOperand*)Operands[ErrorInfo])->getStartLoc();
1065 if (ErrorLoc == SMLoc()) ErrorLoc = IDLoc;
1068 return Error(ErrorLoc, "invalid operand for instruction");
1070 case Match_MnemonicFail:
1071 return Error(IDLoc, "unrecognized instruction mnemonic");
1074 llvm_unreachable("Implement any new match types added!");
1078 /// ParseDirective parses the arm specific directives
1079 bool ARMAsmParser::ParseDirective(AsmToken DirectiveID) {
1080 StringRef IDVal = DirectiveID.getIdentifier();
1081 if (IDVal == ".word")
1082 return ParseDirectiveWord(4, DirectiveID.getLoc());
1083 else if (IDVal == ".thumb")
1084 return ParseDirectiveThumb(DirectiveID.getLoc());
1085 else if (IDVal == ".thumb_func")
1086 return ParseDirectiveThumbFunc(DirectiveID.getLoc());
1087 else if (IDVal == ".code")
1088 return ParseDirectiveCode(DirectiveID.getLoc());
1089 else if (IDVal == ".syntax")
1090 return ParseDirectiveSyntax(DirectiveID.getLoc());
1094 /// ParseDirectiveWord
1095 /// ::= .word [ expression (, expression)* ]
1096 bool ARMAsmParser::ParseDirectiveWord(unsigned Size, SMLoc L) {
1097 if (getLexer().isNot(AsmToken::EndOfStatement)) {
1099 const MCExpr *Value;
1100 if (getParser().ParseExpression(Value))
1103 getParser().getStreamer().EmitValue(Value, Size, 0/*addrspace*/);
1105 if (getLexer().is(AsmToken::EndOfStatement))
1108 // FIXME: Improve diagnostic.
1109 if (getLexer().isNot(AsmToken::Comma))
1110 return Error(L, "unexpected token in directive");
1119 /// ParseDirectiveThumb
1121 bool ARMAsmParser::ParseDirectiveThumb(SMLoc L) {
1122 if (getLexer().isNot(AsmToken::EndOfStatement))
1123 return Error(L, "unexpected token in directive");
1126 // TODO: set thumb mode
1127 // TODO: tell the MC streamer the mode
1128 // getParser().getStreamer().Emit???();
1132 /// ParseDirectiveThumbFunc
1133 /// ::= .thumbfunc symbol_name
1134 bool ARMAsmParser::ParseDirectiveThumbFunc(SMLoc L) {
1135 const AsmToken &Tok = Parser.getTok();
1136 if (Tok.isNot(AsmToken::Identifier) && Tok.isNot(AsmToken::String))
1137 return Error(L, "unexpected token in .thumb_func directive");
1138 StringRef Name = Tok.getString();
1139 Parser.Lex(); // Consume the identifier token.
1140 if (getLexer().isNot(AsmToken::EndOfStatement))
1141 return Error(L, "unexpected token in directive");
1144 // Mark symbol as a thumb symbol.
1145 MCSymbol *Func = getParser().getContext().GetOrCreateSymbol(Name);
1146 getParser().getStreamer().EmitThumbFunc(Func);
1150 /// ParseDirectiveSyntax
1151 /// ::= .syntax unified | divided
1152 bool ARMAsmParser::ParseDirectiveSyntax(SMLoc L) {
1153 const AsmToken &Tok = Parser.getTok();
1154 if (Tok.isNot(AsmToken::Identifier))
1155 return Error(L, "unexpected token in .syntax directive");
1156 StringRef Mode = Tok.getString();
1157 if (Mode == "unified" || Mode == "UNIFIED")
1159 else if (Mode == "divided" || Mode == "DIVIDED")
1162 return Error(L, "unrecognized syntax mode in .syntax directive");
1164 if (getLexer().isNot(AsmToken::EndOfStatement))
1165 return Error(Parser.getTok().getLoc(), "unexpected token in directive");
1168 // TODO tell the MC streamer the mode
1169 // getParser().getStreamer().Emit???();
1173 /// ParseDirectiveCode
1174 /// ::= .code 16 | 32
1175 bool ARMAsmParser::ParseDirectiveCode(SMLoc L) {
1176 const AsmToken &Tok = Parser.getTok();
1177 if (Tok.isNot(AsmToken::Integer))
1178 return Error(L, "unexpected token in .code directive");
1179 int64_t Val = Parser.getTok().getIntVal();
1185 return Error(L, "invalid operand to .code directive");
1187 if (getLexer().isNot(AsmToken::EndOfStatement))
1188 return Error(Parser.getTok().getLoc(), "unexpected token in directive");
1192 getParser().getStreamer().EmitAssemblerFlag(MCAF_Code16);
1194 getParser().getStreamer().EmitAssemblerFlag(MCAF_Code32);
1199 extern "C" void LLVMInitializeARMAsmLexer();
1201 /// Force static initialization.
1202 extern "C" void LLVMInitializeARMAsmParser() {
1203 RegisterAsmParser<ARMAsmParser> X(TheARMTarget);
1204 RegisterAsmParser<ARMAsmParser> Y(TheThumbTarget);
1205 LLVMInitializeARMAsmLexer();
1208 #define GET_REGISTER_MATCHER
1209 #define GET_MATCHER_IMPLEMENTATION
1210 #include "ARMGenAsmMatcher.inc"