lib/Target/ARM/AsmParser/ARMAsmParser.cpp

   1 //===-- ARMAsmParser.cpp - Parse ARM assembly to MCInst instructions ------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #include "ARM.h"
  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"
  27 using namespace llvm;
  28
  29 // The shift types for register controlled shifts in arm memory addressing
  30 enum ShiftType {
  31   Lsl,
  32   Lsr,
  33   Asr,
  34   Ror,
  35   Rrx
  36 };
  37
  38 namespace {
  39
  40 class ARMOperand;
  41
  42 class ARMAsmParser : public TargetAsmParser {
  43   MCAsmParser &Parser;
  44   TargetMachine &TM;
  45
  46   MCAsmParser &getParser() const { return Parser; }
  47   MCAsmLexer &getLexer() const { return Parser.getLexer(); }
  48
  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); }
  51
  52   int TryParseRegister();
  53   ARMOperand *TryParseRegisterWithWriteBack();
  54   ARMOperand *ParseRegisterList();
  55   ARMOperand *ParseMemory();
  56   ARMOperand *ParseOperand();
  57
  58   bool ParseMemoryOffsetReg(bool &Negative,
  59                             bool &OffsetRegShifted,
  60                             enum ShiftType &ShiftType,
  61                             const MCExpr *&ShiftAmount,
  62                             const MCExpr *&Offset,
  63                             bool &OffsetIsReg,
  64                             int &OffsetRegNum,
  65                             SMLoc &E);
  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);
  72
  73   bool MatchAndEmitInstruction(SMLoc IDLoc,
  74                                SmallVectorImpl<MCParsedAsmOperand*> &Operands,
  75                                MCStreamer &Out);
  76
  77   /// @name Auto-generated Match Functions
  78   /// {
  79
  80 #define GET_ASSEMBLER_HEADER
  81 #include "ARMGenAsmMatcher.inc"
  82
  83   /// }
  84
  85 public:
  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>()));
  91     }
  92
  93   virtual bool ParseInstruction(StringRef Name, SMLoc NameLoc,
  94                                 SmallVectorImpl<MCParsedAsmOperand*> &Operands);
  95   virtual bool ParseDirective(AsmToken DirectiveID);
  96 };
  97 } // end anonymous namespace
  98
  99 namespace {
 100
 101 /// ARMOperand - Instances of this class represent a parsed ARM machine
 102 /// instruction.
 103 class ARMOperand : public MCParsedAsmOperand {
 104   enum KindTy {
 105     CondCode,
 106     Immediate,
 107     Memory,
 108     Register,
 109     RegisterList,
 110     Token
 111   } Kind;
 112
 113   SMLoc StartLoc, EndLoc;
 114
 115   union {
 116     struct {
 117       ARMCC::CondCodes Val;
 118     } CC;
 119
 120     struct {
 121       const char *Data;
 122       unsigned Length;
 123     } Tok;
 124
 125     struct {
 126       unsigned RegNum;
 127       bool Writeback;
 128     } Reg;
 129
 130     struct {
 131       std::vector<unsigned> *Registers;
 132     } RegList;
 133
 134     struct {
 135       const MCExpr *Val;
 136     } Imm;
 137
 138     // This is for all forms of ARM address expressions
 139     struct {
 140       unsigned BaseRegNum;
 141       unsigned OffsetRegNum;         // used when OffsetIsReg is true
 142       const MCExpr *Offset;          // used when OffsetIsReg is false
 143       const MCExpr *ShiftAmount;     // used when OffsetRegShifted is true
 144       enum ShiftType ShiftType;      // used when OffsetRegShifted is true
 145       unsigned OffsetRegShifted : 1; // only used when OffsetIsReg is true
 146       unsigned Preindexed : 1;
 147       unsigned Postindexed : 1;
 148       unsigned OffsetIsReg : 1;
 149       unsigned Negative : 1;         // only used when OffsetIsReg is true
 150       unsigned Writeback : 1;
 151     } Mem;
 152   };
 153
 154   ARMOperand(KindTy K) : MCParsedAsmOperand(), Kind(K) {}
 155 public:
 156   ARMOperand(const ARMOperand &o) : MCParsedAsmOperand() {
 157     Kind = o.Kind;
 158     StartLoc = o.StartLoc;
 159     EndLoc = o.EndLoc;
 160     switch (Kind) {
 161     case CondCode:
 162       CC = o.CC;
 163       break;
 164     case Token:
 165       Tok = o.Tok;
 166       break;
 167     case Register:
 168       Reg = o.Reg;
 169       break;
 170     case RegisterList:
 171       RegList = o.RegList;
 172       break;
 173     case Immediate:
 174       Imm = o.Imm;
 175       break;
 176     case Memory:
 177       Mem = o.Mem;
 178       break;
 179     }
 180   }
 181   ~ARMOperand() {
 182     if (isRegList())
 183       delete RegList.Registers;
 184   }
 185
 186   /// getStartLoc - Get the location of the first token of this operand.
 187   SMLoc getStartLoc() const { return StartLoc; }
 188   /// getEndLoc - Get the location of the last token of this operand.
 189   SMLoc getEndLoc() const { return EndLoc; }
 190
 191   ARMCC::CondCodes getCondCode() const {
 192     assert(Kind == CondCode && "Invalid access!");
 193     return CC.Val;
 194   }
 195
 196   StringRef getToken() const {
 197     assert(Kind == Token && "Invalid access!");
 198     return StringRef(Tok.Data, Tok.Length);
 199   }
 200
 201   unsigned getReg() const {
 202     assert(Kind == Register && "Invalid access!");
 203     return Reg.RegNum;
 204   }
 205
 206   const std::vector<unsigned> &getRegList() const {
 207     assert(Kind == RegisterList && "Invalid access!");
 208     return *RegList.Registers;
 209   }
 210
 211   const MCExpr *getImm() const {
 212     assert(Kind == Immediate && "Invalid access!");
 213     return Imm.Val;
 214   }
 215
 216   bool isCondCode() const { return Kind == CondCode; }
 217   bool isImm() const { return Kind == Immediate; }
 218   bool isReg() const { return Kind == Register; }
 219   bool isRegList() const { return Kind == RegisterList; }
 220   bool isToken() const { return Kind == Token; }
 221   bool isMemory() const { return Kind == Memory; }
 222   bool isMemMode5() const {
 223     if (!isMemory() || Mem.OffsetIsReg || Mem.OffsetRegShifted ||
 224         Mem.Writeback || Mem.Negative)
 225       return false;
 226     // If there is an offset expression, make sure it's valid.
 227     if (!Mem.Offset)
 228       return true;
 229     const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(Mem.Offset);
 230     if (!CE)
 231       return false;
 232     // The offset must be a multiple of 4 in the range 0-1020.
 233     int64_t Value = CE->getValue();
 234     return ((Value & 0x3) == 0 && Value <= 1020 && Value >= -1020);
 235   }
 236
 237   void addExpr(MCInst &Inst, const MCExpr *Expr) const {
 238     // Add as immediates when possible.  Null MCExpr = 0.
 239     if (Expr == 0)
 240       Inst.addOperand(MCOperand::CreateImm(0));
 241     else if (const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(Expr))
 242       Inst.addOperand(MCOperand::CreateImm(CE->getValue()));
 243     else
 244       Inst.addOperand(MCOperand::CreateExpr(Expr));
 245   }
 246
 247   void addCondCodeOperands(MCInst &Inst, unsigned N) const {
 248     assert(N == 2 && "Invalid number of operands!");
 249     Inst.addOperand(MCOperand::CreateImm(unsigned(getCondCode())));
 250     // FIXME: What belongs here?
 251     Inst.addOperand(MCOperand::CreateReg(0));
 252   }
 253
 254   void addRegOperands(MCInst &Inst, unsigned N) const {
 255     assert(N == 1 && "Invalid number of operands!");
 256     Inst.addOperand(MCOperand::CreateReg(getReg()));
 257   }
 258
 259   void addRegListOperands(MCInst &Inst, unsigned N) const {
 260     assert(N == 1 && "Invalid number of operands!");
 261     const std::vector<unsigned> &RegList = getRegList();
 262     for (std::vector<unsigned>::const_iterator
 263            I = RegList.begin(), E = RegList.end(); I != E; ++I)
 264       Inst.addOperand(MCOperand::CreateReg(*I));
 265   }
 266
 267   void addImmOperands(MCInst &Inst, unsigned N) const {
 268     assert(N == 1 && "Invalid number of operands!");
 269     addExpr(Inst, getImm());
 270   }
 271
 272   void addMemMode5Operands(MCInst &Inst, unsigned N) const {
 273     assert(N == 2 && isMemMode5() && "Invalid number of operands!");
 274
 275     Inst.addOperand(MCOperand::CreateReg(Mem.BaseRegNum));
 276     assert(!Mem.OffsetIsReg && "Invalid mode 5 operand");
 277
 278     // FIXME: #-0 is encoded differently than #0. Does the parser preserve
 279     // the difference?
 280     if (Mem.Offset) {
 281       const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(Mem.Offset);
 282       assert(CE && "Non-constant mode 5 offset operand!");
 283
 284       // The MCInst offset operand doesn't include the low two bits (like
 285       // the instruction encoding).
 286       int64_t Offset = CE->getValue() / 4;
 287       if (Offset >= 0)
 288         Inst.addOperand(MCOperand::CreateImm(ARM_AM::getAM5Opc(ARM_AM::add,
 289                                                                Offset)));
 290       else
 291         Inst.addOperand(MCOperand::CreateImm(ARM_AM::getAM5Opc(ARM_AM::sub,
 292                                                                -Offset)));
 293     } else {
 294       Inst.addOperand(MCOperand::CreateImm(0));
 295     }
 296   }
 297
 298   virtual void dump(raw_ostream &OS) const;
 299
 300   static ARMOperand *CreateCondCode(ARMCC::CondCodes CC, SMLoc S) {
 301     ARMOperand *Op = new ARMOperand(CondCode);
 302     Op->CC.Val = CC;
 303     Op->StartLoc = S;
 304     Op->EndLoc = S;
 305     return Op;
 306   }
 307
 308   static ARMOperand *CreateToken(StringRef Str, SMLoc S) {
 309     ARMOperand *Op = new ARMOperand(Token);
 310     Op->Tok.Data = Str.data();
 311     Op->Tok.Length = Str.size();
 312     Op->StartLoc = S;
 313     Op->EndLoc = S;
 314     return Op;
 315   }
 316
 317   static ARMOperand *CreateReg(unsigned RegNum, bool Writeback, SMLoc S,
 318                                SMLoc E) {
 319     ARMOperand *Op = new ARMOperand(Register);
 320     Op->Reg.RegNum = RegNum;
 321     Op->Reg.Writeback = Writeback;
 322     Op->StartLoc = S;
 323     Op->EndLoc = E;
 324     return Op;
 325   }
 326
 327   static ARMOperand *
 328   CreateRegList(std::vector<std::pair<unsigned, SMLoc> > &Regs,
 329                 SMLoc S, SMLoc E) {
 330     ARMOperand *Op = new ARMOperand(RegisterList);
 331     Op->RegList.Registers = new std::vector<unsigned>();
 332     for (std::vector<std::pair<unsigned, SMLoc> >::iterator
 333            I = Regs.begin(), E = Regs.end(); I != E; ++I)
 334       Op->RegList.Registers->push_back(I->first);
 335     std::sort(Op->RegList.Registers->begin(), Op->RegList.Registers->end());
 336     Op->StartLoc = S;
 337     Op->EndLoc = E;
 338     return Op;
 339   }
 340
 341   static ARMOperand *CreateImm(const MCExpr *Val, SMLoc S, SMLoc E) {
 342     ARMOperand *Op = new ARMOperand(Immediate);
 343     Op->Imm.Val = Val;
 344     Op->StartLoc = S;
 345     Op->EndLoc = E;
 346     return Op;
 347   }
 348
 349   static ARMOperand *CreateMem(unsigned BaseRegNum, bool OffsetIsReg,
 350                                const MCExpr *Offset, unsigned OffsetRegNum,
 351                                bool OffsetRegShifted, enum ShiftType ShiftType,
 352                                const MCExpr *ShiftAmount, bool Preindexed,
 353                                bool Postindexed, bool Negative, bool Writeback,
 354                                SMLoc S, SMLoc E) {
 355     ARMOperand *Op = new ARMOperand(Memory);
 356     Op->Mem.BaseRegNum = BaseRegNum;
 357     Op->Mem.OffsetIsReg = OffsetIsReg;
 358     Op->Mem.Offset = Offset;
 359     Op->Mem.OffsetRegNum = OffsetRegNum;
 360     Op->Mem.OffsetRegShifted = OffsetRegShifted;
 361     Op->Mem.ShiftType = ShiftType;
 362     Op->Mem.ShiftAmount = ShiftAmount;
 363     Op->Mem.Preindexed = Preindexed;
 364     Op->Mem.Postindexed = Postindexed;
 365     Op->Mem.Negative = Negative;
 366     Op->Mem.Writeback = Writeback;
 367
 368     Op->StartLoc = S;
 369     Op->EndLoc = E;
 370     return Op;
 371   }
 372 };
 373
 374 } // end anonymous namespace.
 375
 376 void ARMOperand::dump(raw_ostream &OS) const {
 377   switch (Kind) {
 378   case CondCode:
 379     OS << ARMCondCodeToString(getCondCode());
 380     break;
 381   case Immediate:
 382     getImm()->print(OS);
 383     break;
 384   case Memory:
 385     OS << "<memory>";
 386     break;
 387   case Register:
 388     OS << "<register " << getReg() << ">";
 389     break;
 390   case RegisterList: {
 391     OS << "<register_list ";
 392
 393     const std::vector<unsigned> &RegList = getRegList();
 394     for (std::vector<unsigned>::const_iterator
 395            I = RegList.begin(), E = RegList.end(); I != E; ) {
 396       OS << *I;
 397       if (++I < E) OS << ", ";
 398     }
 399
 400     OS << ">";
 401     break;
 402   }
 403   case Token:
 404     OS << "'" << getToken() << "'";
 405     break;
 406   }
 407 }
 408
 409 /// @name Auto-generated Match Functions
 410 /// {
 411
 412 static unsigned MatchRegisterName(StringRef Name);
 413
 414 /// }
 415
 416 /// Try to parse a register name.  The token must be an Identifier when called,
 417 /// and if it is a register name the token is eaten and the register number is
 418 /// returned.  Otherwise return -1.
 419 ///
 420 int ARMAsmParser::TryParseRegister() {
 421   const AsmToken &Tok = Parser.getTok();
 422   assert(Tok.is(AsmToken::Identifier) && "Token is not an Identifier");
 423
 424   // FIXME: Validate register for the current architecture; we have to do
 425   // validation later, so maybe there is no need for this here.
 426   unsigned RegNum = MatchRegisterName(Tok.getString());
 427   if (RegNum == 0)
 428     return -1;
 429   Parser.Lex(); // Eat identifier token.
 430   return RegNum;
 431 }
 432
 433
 434 /// Try to parse a register name.  The token must be an Identifier when called,
 435 /// and if it is a register name the token is eaten and the register number is
 436 /// returned.  Otherwise return -1.
 437 ///
 438 /// TODO this is likely to change to allow different register types and or to
 439 /// parse for a specific register type.
 440 ARMOperand *ARMAsmParser::TryParseRegisterWithWriteBack() {
 441   SMLoc S = Parser.getTok().getLoc();
 442   int RegNo = TryParseRegister();
 443   if (RegNo == -1)
 444     return 0;
 445
 446   SMLoc E = Parser.getTok().getLoc();
 447
 448   bool Writeback = false;
 449   const AsmToken &ExclaimTok = Parser.getTok();
 450   if (ExclaimTok.is(AsmToken::Exclaim)) {
 451     E = ExclaimTok.getLoc();
 452     Writeback = true;
 453     Parser.Lex(); // Eat exclaim token
 454   }
 455
 456   return ARMOperand::CreateReg(RegNo, Writeback, S, E);
 457 }
 458
 459 /// Parse a register list, return it if successful else return null.  The first
 460 /// token must be a '{' when called.
 461 ARMOperand *ARMAsmParser::ParseRegisterList() {
 462   assert(Parser.getTok().is(AsmToken::LCurly) &&
 463          "Token is not a Left Curly Brace");
 464   SMLoc S = Parser.getTok().getLoc();
 465
 466   // Read the rest of the registers in the list.
 467   unsigned PrevRegNum = 0;
 468   std::vector<std::pair<unsigned, SMLoc> > Registers;
 469   Registers.reserve(32);
 470
 471   do {
 472     bool IsRange = Parser.getTok().is(AsmToken::Minus);
 473     Parser.Lex(); // Eat non-identifier token.
 474
 475     const AsmToken &RegTok = Parser.getTok();
 476     SMLoc RegLoc = RegTok.getLoc();
 477     if (RegTok.isNot(AsmToken::Identifier)) {
 478       Error(RegLoc, "register expected");
 479       return 0;
 480     }
 481
 482     int RegNum = TryParseRegister();
 483     if (RegNum == -1) {
 484       Error(RegLoc, "register expected");
 485       return 0;
 486     }
 487
 488     if (IsRange) {
 489       int Reg = PrevRegNum;
 490       do {
 491         ++Reg;
 492         Registers.push_back(std::make_pair(Reg, RegLoc));
 493       } while (Reg != RegNum);
 494     } else {
 495       Registers.push_back(std::make_pair(RegNum, RegLoc));
 496     }
 497
 498     PrevRegNum = RegNum;
 499   } while (Parser.getTok().is(AsmToken::Comma) ||
 500            Parser.getTok().is(AsmToken::Minus));
 501
 502   // Process the right curly brace of the list.
 503   const AsmToken &RCurlyTok = Parser.getTok();
 504   if (RCurlyTok.isNot(AsmToken::RCurly)) {
 505     Error(RCurlyTok.getLoc(), "'}' expected");
 506     return 0;
 507   }
 508
 509   SMLoc E = RCurlyTok.getLoc();
 510   Parser.Lex(); // Eat right curly brace token.
 511
 512   // Verify the register list.
 513   std::vector<std::pair<unsigned, SMLoc> >::const_iterator
 514     RI = Registers.begin(), RE = Registers.end();
 515
 516   unsigned HighRegNum = RI->first;
 517   DenseMap<unsigned, bool> RegMap;
 518   RegMap[RI->first] = true;
 519
 520   for (++RI; RI != RE; ++RI) {
 521     const std::pair<unsigned, SMLoc> &RegInfo = *RI;
 522
 523     if (RegMap[RegInfo.first]) {
 524       Error(RegInfo.second, "register duplicated in register list");
 525       return 0;
 526     }
 527
 528     if (RegInfo.first < HighRegNum)
 529       Warning(RegInfo.second,
 530               "register not in ascending order in register list");
 531
 532     RegMap[RegInfo.first] = true;
 533     HighRegNum = std::max(RegInfo.first, HighRegNum);
 534   }
 535
 536   return ARMOperand::CreateRegList(Registers, S, E);
 537 }
 538
 539 /// Parse an ARM memory expression, return false if successful else return true
 540 /// or an error.  The first token must be a '[' when called.
 541 /// TODO Only preindexing and postindexing addressing are started, unindexed
 542 /// with option, etc are still to do.
 543 ARMOperand *ARMAsmParser::ParseMemory() {
 544   SMLoc S, E;
 545   assert(Parser.getTok().is(AsmToken::LBrac) &&
 546          "Token is not a Left Bracket");
 547   S = Parser.getTok().getLoc();
 548   Parser.Lex(); // Eat left bracket token.
 549
 550   const AsmToken &BaseRegTok = Parser.getTok();
 551   if (BaseRegTok.isNot(AsmToken::Identifier)) {
 552     Error(BaseRegTok.getLoc(), "register expected");
 553     return 0;
 554   }
 555   int BaseRegNum = TryParseRegister();
 556   if (BaseRegNum == -1) {
 557     Error(BaseRegTok.getLoc(), "register expected");
 558     return 0;
 559   }
 560
 561   bool Preindexed = false;
 562   bool Postindexed = false;
 563   bool OffsetIsReg = false;
 564   bool Negative = false;
 565   bool Writeback = false;
 566
 567   // First look for preindexed address forms, that is after the "[Rn" we now
 568   // have to see if the next token is a comma.
 569   const AsmToken &Tok = Parser.getTok();
 570   if (Tok.is(AsmToken::Comma)) {
 571     Preindexed = true;
 572     Parser.Lex(); // Eat comma token.
 573     int OffsetRegNum;
 574     bool OffsetRegShifted;
 575     enum ShiftType ShiftType;
 576     const MCExpr *ShiftAmount;
 577     const MCExpr *Offset;
 578     if (ParseMemoryOffsetReg(Negative, OffsetRegShifted, ShiftType, ShiftAmount,
 579                              Offset, OffsetIsReg, OffsetRegNum, E))
 580       return 0;
 581     const AsmToken &RBracTok = Parser.getTok();
 582     if (RBracTok.isNot(AsmToken::RBrac)) {
 583       Error(RBracTok.getLoc(), "']' expected");
 584       return 0;
 585     }
 586     E = RBracTok.getLoc();
 587     Parser.Lex(); // Eat right bracket token.
 588
 589     const AsmToken &ExclaimTok = Parser.getTok();
 590     if (ExclaimTok.is(AsmToken::Exclaim)) {
 591       E = ExclaimTok.getLoc();
 592       Writeback = true;
 593       Parser.Lex(); // Eat exclaim token
 594     }
 595     return ARMOperand::CreateMem(BaseRegNum, OffsetIsReg, Offset, OffsetRegNum,
 596                                  OffsetRegShifted, ShiftType, ShiftAmount,
 597                                  Preindexed, Postindexed, Negative, Writeback,
 598                                  S, E);
 599   }
 600   // The "[Rn" we have so far was not followed by a comma.
 601   else if (Tok.is(AsmToken::RBrac)) {
 602     // If there's anything other than the right brace, this is a post indexing
 603     // addressing form.
 604     E = Tok.getLoc();
 605     Parser.Lex(); // Eat right bracket token.
 606
 607     int OffsetRegNum = 0;
 608     bool OffsetRegShifted = false;
 609     enum ShiftType ShiftType;
 610     const MCExpr *ShiftAmount;
 611     const MCExpr *Offset = 0;
 612
 613     const AsmToken &NextTok = Parser.getTok();
 614     if (NextTok.isNot(AsmToken::EndOfStatement)) {
 615       Postindexed = true;
 616       Writeback = true;
 617       if (NextTok.isNot(AsmToken::Comma)) {
 618         Error(NextTok.getLoc(), "',' expected");
 619         return 0;
 620       }
 621       Parser.Lex(); // Eat comma token.
 622       if (ParseMemoryOffsetReg(Negative, OffsetRegShifted, ShiftType,
 623                                ShiftAmount, Offset, OffsetIsReg, OffsetRegNum,
 624                                E))
 625         return 0;
 626     }
 627
 628     return ARMOperand::CreateMem(BaseRegNum, OffsetIsReg, Offset, OffsetRegNum,
 629                                  OffsetRegShifted, ShiftType, ShiftAmount,
 630                                  Preindexed, Postindexed, Negative, Writeback,
 631                                  S, E);
 632   }
 633
 634   return 0;
 635 }
 636
 637 /// Parse the offset of a memory operand after we have seen "[Rn," or "[Rn],"
 638 /// we will parse the following (were +/- means that a plus or minus is
 639 /// optional):
 640 ///   +/-Rm
 641 ///   +/-Rm, shift
 642 ///   #offset
 643 /// we return false on success or an error otherwise.
 644 bool ARMAsmParser::ParseMemoryOffsetReg(bool &Negative,
 645                                         bool &OffsetRegShifted,
 646                                         enum ShiftType &ShiftType,
 647                                         const MCExpr *&ShiftAmount,
 648                                         const MCExpr *&Offset,
 649                                         bool &OffsetIsReg,
 650                                         int &OffsetRegNum,
 651                                         SMLoc &E) {
 652   Negative = false;
 653   OffsetRegShifted = false;
 654   OffsetIsReg = false;
 655   OffsetRegNum = -1;
 656   const AsmToken &NextTok = Parser.getTok();
 657   E = NextTok.getLoc();
 658   if (NextTok.is(AsmToken::Plus))
 659     Parser.Lex(); // Eat plus token.
 660   else if (NextTok.is(AsmToken::Minus)) {
 661     Negative = true;
 662     Parser.Lex(); // Eat minus token
 663   }
 664   // See if there is a register following the "[Rn," or "[Rn]," we have so far.
 665   const AsmToken &OffsetRegTok = Parser.getTok();
 666   if (OffsetRegTok.is(AsmToken::Identifier)) {
 667     SMLoc CurLoc = OffsetRegTok.getLoc();
 668     OffsetRegNum = TryParseRegister();
 669     if (OffsetRegNum != -1) {
 670       OffsetIsReg = true;
 671       E = CurLoc;
 672     }
 673   }
 674
 675   // If we parsed a register as the offset then there can be a shift after that.
 676   if (OffsetRegNum != -1) {
 677     // Look for a comma then a shift
 678     const AsmToken &Tok = Parser.getTok();
 679     if (Tok.is(AsmToken::Comma)) {
 680       Parser.Lex(); // Eat comma token.
 681
 682       const AsmToken &Tok = Parser.getTok();
 683       if (ParseShift(ShiftType, ShiftAmount, E))
 684         return Error(Tok.getLoc(), "shift expected");
 685       OffsetRegShifted = true;
 686     }
 687   }
 688   else { // the "[Rn," or "[Rn,]" we have so far was not followed by "Rm"
 689     // Look for #offset following the "[Rn," or "[Rn],"
 690     const AsmToken &HashTok = Parser.getTok();
 691     if (HashTok.isNot(AsmToken::Hash))
 692       return Error(HashTok.getLoc(), "'#' expected");
 693
 694     Parser.Lex(); // Eat hash token.
 695
 696     if (getParser().ParseExpression(Offset))
 697      return true;
 698     E = SMLoc::getFromPointer(Parser.getTok().getLoc().getPointer() - 1);
 699   }
 700   return false;
 701 }
 702
 703 /// ParseShift as one of these two:
 704 ///   ( lsl | lsr | asr | ror ) , # shift_amount
 705 ///   rrx
 706 /// and returns true if it parses a shift otherwise it returns false.
 707 bool ARMAsmParser::ParseShift(ShiftType &St, const MCExpr *&ShiftAmount,
 708                               SMLoc &E) {
 709   const AsmToken &Tok = Parser.getTok();
 710   if (Tok.isNot(AsmToken::Identifier))
 711     return true;
 712   StringRef ShiftName = Tok.getString();
 713   if (ShiftName == "lsl" || ShiftName == "LSL")
 714     St = Lsl;
 715   else if (ShiftName == "lsr" || ShiftName == "LSR")
 716     St = Lsr;
 717   else if (ShiftName == "asr" || ShiftName == "ASR")
 718     St = Asr;
 719   else if (ShiftName == "ror" || ShiftName == "ROR")
 720     St = Ror;
 721   else if (ShiftName == "rrx" || ShiftName == "RRX")
 722     St = Rrx;
 723   else
 724     return true;
 725   Parser.Lex(); // Eat shift type token.
 726
 727   // Rrx stands alone.
 728   if (St == Rrx)
 729     return false;
 730
 731   // Otherwise, there must be a '#' and a shift amount.
 732   const AsmToken &HashTok = Parser.getTok();
 733   if (HashTok.isNot(AsmToken::Hash))
 734     return Error(HashTok.getLoc(), "'#' expected");
 735   Parser.Lex(); // Eat hash token.
 736
 737   if (getParser().ParseExpression(ShiftAmount))
 738     return true;
 739
 740   return false;
 741 }
 742
 743 /// Parse a arm instruction operand.  For now this parses the operand regardless
 744 /// of the mnemonic.
 745 ARMOperand *ARMAsmParser::ParseOperand() {
 746   SMLoc S, E;
 747   switch (getLexer().getKind()) {
 748   default:
 749     Error(Parser.getTok().getLoc(), "unexpected token in operand");
 750     return 0;
 751   case AsmToken::Identifier:
 752     if (ARMOperand *Op = TryParseRegisterWithWriteBack())
 753       return Op;
 754
 755     // This was not a register so parse other operands that start with an
 756     // identifier (like labels) as expressions and create them as immediates.
 757     const MCExpr *IdVal;
 758     S = Parser.getTok().getLoc();
 759     if (getParser().ParseExpression(IdVal))
 760       return 0;
 761     E = SMLoc::getFromPointer(Parser.getTok().getLoc().getPointer() - 1);
 762     return ARMOperand::CreateImm(IdVal, S, E);
 763   case AsmToken::LBrac:
 764     return ParseMemory();
 765   case AsmToken::LCurly:
 766     return ParseRegisterList();
 767   case AsmToken::Hash:
 768     // #42 -> immediate.
 769     // TODO: ":lower16:" and ":upper16:" modifiers after # before immediate
 770     S = Parser.getTok().getLoc();
 771     Parser.Lex();
 772     const MCExpr *ImmVal;
 773     if (getParser().ParseExpression(ImmVal))
 774       return 0;
 775     E = SMLoc::getFromPointer(Parser.getTok().getLoc().getPointer() - 1);
 776     return ARMOperand::CreateImm(ImmVal, S, E);
 777   }
 778 }
 779
 780 /// Parse an arm instruction mnemonic followed by its operands.
 781 bool ARMAsmParser::ParseInstruction(StringRef Name, SMLoc NameLoc,
 782                                SmallVectorImpl<MCParsedAsmOperand*> &Operands) {
 783   // Create the leading tokens for the mnemonic, split by '.' characters.
 784   size_t Start = 0, Next = Name.find('.');
 785   StringRef Head = Name.slice(Start, Next);
 786
 787   // Determine the predicate, if any.
 788   //
 789   // FIXME: We need a way to check whether a prefix supports predication,
 790   // otherwise we will end up with an ambiguity for instructions that happen to
 791   // end with a predicate name.
 792   // FIXME: Likewise, some arithmetic instructions have an 's' prefix which
 793   // indicates to update the condition codes. Those instructions have an
 794   // additional immediate operand which encodes the prefix as reg0 or CPSR.
 795   // Just checking for a suffix of 's' definitely creates ambiguities; e.g,
 796   // the SMMLS instruction.
 797   unsigned CC = StringSwitch<unsigned>(Head.substr(Head.size()-2))
 798     .Case("eq", ARMCC::EQ)
 799     .Case("ne", ARMCC::NE)
 800     .Case("hs", ARMCC::HS)
 801     .Case("lo", ARMCC::LO)
 802     .Case("mi", ARMCC::MI)
 803     .Case("pl", ARMCC::PL)
 804     .Case("vs", ARMCC::VS)
 805     .Case("vc", ARMCC::VC)
 806     .Case("hi", ARMCC::HI)
 807     .Case("ls", ARMCC::LS)
 808     .Case("ge", ARMCC::GE)
 809     .Case("lt", ARMCC::LT)
 810     .Case("gt", ARMCC::GT)
 811     .Case("le", ARMCC::LE)
 812     .Case("al", ARMCC::AL)
 813     .Default(~0U);
 814
 815   if (CC == ~0U ||
 816       (CC == ARMCC::LS && (Head == "vmls" || Head == "vnmls"))) {
 817     CC = ARMCC::AL;
 818   } else {
 819     Head = Head.slice(0, Head.size() - 2);
 820   }
 821
 822   Operands.push_back(ARMOperand::CreateToken(Head, NameLoc));
 823   // FIXME: Should only add this operand for predicated instructions
 824   Operands.push_back(ARMOperand::CreateCondCode(ARMCC::CondCodes(CC), NameLoc));
 825
 826   // Add the remaining tokens in the mnemonic.
 827   while (Next != StringRef::npos) {
 828     Start = Next;
 829     Next = Name.find('.', Start + 1);
 830     Head = Name.slice(Start, Next);
 831
 832     Operands.push_back(ARMOperand::CreateToken(Head, NameLoc));
 833   }
 834
 835   // Read the remaining operands.
 836   if (getLexer().isNot(AsmToken::EndOfStatement)) {
 837     // Read the first operand.
 838     if (ARMOperand *Op = ParseOperand())
 839       Operands.push_back(Op);
 840     else {
 841       Parser.EatToEndOfStatement();
 842       return true;
 843     }
 844
 845     while (getLexer().is(AsmToken::Comma)) {
 846       Parser.Lex();  // Eat the comma.
 847
 848       // Parse and remember the operand.
 849       if (ARMOperand *Op = ParseOperand())
 850         Operands.push_back(Op);
 851       else {
 852         Parser.EatToEndOfStatement();
 853         return true;
 854       }
 855     }
 856   }
 857
 858   if (getLexer().isNot(AsmToken::EndOfStatement)) {
 859     Parser.EatToEndOfStatement();
 860     return TokError("unexpected token in argument list");
 861   }
 862
 863   Parser.Lex(); // Consume the EndOfStatement
 864   return false;
 865 }
 866
 867 bool ARMAsmParser::
 868 MatchAndEmitInstruction(SMLoc IDLoc,
 869                         SmallVectorImpl<MCParsedAsmOperand*> &Operands,
 870                         MCStreamer &Out) {
 871   MCInst Inst;
 872   unsigned ErrorInfo;
 873   switch (MatchInstructionImpl(Operands, Inst, ErrorInfo)) {
 874   case Match_Success:
 875     Out.EmitInstruction(Inst);
 876     return false;
 877   case Match_MissingFeature:
 878     Error(IDLoc, "instruction requires a CPU feature not currently enabled");
 879     return true;
 880   case Match_InvalidOperand: {
 881     SMLoc ErrorLoc = IDLoc;
 882     if (ErrorInfo != ~0U) {
 883       if (ErrorInfo >= Operands.size())
 884         return Error(IDLoc, "too few operands for instruction");
 885
 886       ErrorLoc = ((ARMOperand*)Operands[ErrorInfo])->getStartLoc();
 887       if (ErrorLoc == SMLoc()) ErrorLoc = IDLoc;
 888     }
 889
 890     return Error(ErrorLoc, "invalid operand for instruction");
 891   }
 892   case Match_MnemonicFail:
 893     return Error(IDLoc, "unrecognized instruction mnemonic");
 894   }
 895
 896   llvm_unreachable("Implement any new match types added!");
 897   return true;
 898 }
 899
 900 /// ParseDirective parses the arm specific directives
 901 bool ARMAsmParser::ParseDirective(AsmToken DirectiveID) {
 902   StringRef IDVal = DirectiveID.getIdentifier();
 903   if (IDVal == ".word")
 904     return ParseDirectiveWord(4, DirectiveID.getLoc());
 905   else if (IDVal == ".thumb")
 906     return ParseDirectiveThumb(DirectiveID.getLoc());
 907   else if (IDVal == ".thumb_func")
 908     return ParseDirectiveThumbFunc(DirectiveID.getLoc());
 909   else if (IDVal == ".code")
 910     return ParseDirectiveCode(DirectiveID.getLoc());
 911   else if (IDVal == ".syntax")
 912     return ParseDirectiveSyntax(DirectiveID.getLoc());
 913   return true;
 914 }
 915
 916 /// ParseDirectiveWord
 917 ///  ::= .word [ expression (, expression)* ]
 918 bool ARMAsmParser::ParseDirectiveWord(unsigned Size, SMLoc L) {
 919   if (getLexer().isNot(AsmToken::EndOfStatement)) {
 920     for (;;) {
 921       const MCExpr *Value;
 922       if (getParser().ParseExpression(Value))
 923         return true;
 924
 925       getParser().getStreamer().EmitValue(Value, Size, 0/*addrspace*/);
 926
 927       if (getLexer().is(AsmToken::EndOfStatement))
 928         break;
 929
 930       // FIXME: Improve diagnostic.
 931       if (getLexer().isNot(AsmToken::Comma))
 932         return Error(L, "unexpected token in directive");
 933       Parser.Lex();
 934     }
 935   }
 936
 937   Parser.Lex();
 938   return false;
 939 }
 940
 941 /// ParseDirectiveThumb
 942 ///  ::= .thumb
 943 bool ARMAsmParser::ParseDirectiveThumb(SMLoc L) {
 944   if (getLexer().isNot(AsmToken::EndOfStatement))
 945     return Error(L, "unexpected token in directive");
 946   Parser.Lex();
 947
 948   // TODO: set thumb mode
 949   // TODO: tell the MC streamer the mode
 950   // getParser().getStreamer().Emit???();
 951   return false;
 952 }
 953
 954 /// ParseDirectiveThumbFunc
 955 ///  ::= .thumbfunc symbol_name
 956 bool ARMAsmParser::ParseDirectiveThumbFunc(SMLoc L) {
 957   const AsmToken &Tok = Parser.getTok();
 958   if (Tok.isNot(AsmToken::Identifier) && Tok.isNot(AsmToken::String))
 959     return Error(L, "unexpected token in .thumb_func directive");
 960   StringRef Name = Tok.getString();
 961   Parser.Lex(); // Consume the identifier token.
 962   if (getLexer().isNot(AsmToken::EndOfStatement))
 963     return Error(L, "unexpected token in directive");
 964   Parser.Lex();
 965
 966   // Mark symbol as a thumb symbol.
 967   MCSymbol *Func = getParser().getContext().GetOrCreateSymbol(Name);
 968   getParser().getStreamer().EmitThumbFunc(Func);
 969   return false;
 970 }
 971
 972 /// ParseDirectiveSyntax
 973 ///  ::= .syntax unified | divided
 974 bool ARMAsmParser::ParseDirectiveSyntax(SMLoc L) {
 975   const AsmToken &Tok = Parser.getTok();
 976   if (Tok.isNot(AsmToken::Identifier))
 977     return Error(L, "unexpected token in .syntax directive");
 978   StringRef Mode = Tok.getString();
 979   if (Mode == "unified" || Mode == "UNIFIED")
 980     Parser.Lex();
 981   else if (Mode == "divided" || Mode == "DIVIDED")
 982     Parser.Lex();
 983   else
 984     return Error(L, "unrecognized syntax mode in .syntax directive");
 985
 986   if (getLexer().isNot(AsmToken::EndOfStatement))
 987     return Error(Parser.getTok().getLoc(), "unexpected token in directive");
 988   Parser.Lex();
 989
 990   // TODO tell the MC streamer the mode
 991   // getParser().getStreamer().Emit???();
 992   return false;
 993 }
 994
 995 /// ParseDirectiveCode
 996 ///  ::= .code 16 | 32
 997 bool ARMAsmParser::ParseDirectiveCode(SMLoc L) {
 998   const AsmToken &Tok = Parser.getTok();
 999   if (Tok.isNot(AsmToken::Integer))
1000     return Error(L, "unexpected token in .code directive");
1001   int64_t Val = Parser.getTok().getIntVal();
1002   if (Val == 16)
1003     Parser.Lex();
1004   else if (Val == 32)
1005     Parser.Lex();
1006   else
1007     return Error(L, "invalid operand to .code directive");
1008
1009   if (getLexer().isNot(AsmToken::EndOfStatement))
1010     return Error(Parser.getTok().getLoc(), "unexpected token in directive");
1011   Parser.Lex();
1012
1013   if (Val == 16)
1014     getParser().getStreamer().EmitAssemblerFlag(MCAF_Code16);
1015   else
1016     getParser().getStreamer().EmitAssemblerFlag(MCAF_Code32);
1017
1018   return false;
1019 }
1020
1021 extern "C" void LLVMInitializeARMAsmLexer();
1022
1023 /// Force static initialization.
1024 extern "C" void LLVMInitializeARMAsmParser() {
1025   RegisterAsmParser<ARMAsmParser> X(TheARMTarget);
1026   RegisterAsmParser<ARMAsmParser> Y(TheThumbTarget);
1027   LLVMInitializeARMAsmLexer();
1028 }
1029
1030 #define GET_REGISTER_MATCHER
1031 #define GET_MATCHER_IMPLEMENTATION
1032 #include "ARMGenAsmMatcher.inc"