lib/Target/X86/AsmParser/X86AsmParser.cpp

   1 //===-- X86AsmParser.cpp - Parse X86 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 "llvm/Target/TargetAsmParser.h"
  11 #include "X86.h"
  12 #include "X86Subtarget.h"
  13 #include "llvm/Target/TargetRegistry.h"
  14 #include "llvm/Target/TargetAsmParser.h"
  15 #include "llvm/MC/MCStreamer.h"
  16 #include "llvm/MC/MCExpr.h"
  17 #include "llvm/MC/MCInst.h"
  18 #include "llvm/MC/MCParser/MCAsmLexer.h"
  19 #include "llvm/MC/MCParser/MCAsmParser.h"
  20 #include "llvm/MC/MCParser/MCParsedAsmOperand.h"
  21 #include "llvm/ADT/SmallString.h"
  22 #include "llvm/ADT/SmallVector.h"
  23 #include "llvm/ADT/StringExtras.h"
  24 #include "llvm/ADT/StringSwitch.h"
  25 #include "llvm/ADT/Twine.h"
  26 #include "llvm/Support/SourceMgr.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 using namespace llvm;
  29
  30 namespace {
  31 struct X86Operand;
  32
  33 class X86ATTAsmParser : public TargetAsmParser {
  34   MCAsmParser &Parser;
  35   TargetMachine &TM;
  36
  37 protected:
  38   unsigned Is64Bit : 1;
  39
  40 private:
  41   MCAsmParser &getParser() const { return Parser; }
  42
  43   MCAsmLexer &getLexer() const { return Parser.getLexer(); }
  44
  45   bool Error(SMLoc L, const Twine &Msg) { return Parser.Error(L, Msg); }
  46
  47   bool ParseRegister(unsigned &RegNo, SMLoc &StartLoc, SMLoc &EndLoc);
  48
  49   X86Operand *ParseOperand();
  50   X86Operand *ParseMemOperand(unsigned SegReg, SMLoc StartLoc);
  51
  52   bool ParseDirectiveWord(unsigned Size, SMLoc L);
  53
  54   bool MatchAndEmitInstruction(SMLoc IDLoc,
  55                                SmallVectorImpl<MCParsedAsmOperand*> &Operands,
  56                                MCStreamer &Out);
  57
  58   /// @name Auto-generated Matcher Functions
  59   /// {
  60
  61 #define GET_ASSEMBLER_HEADER
  62 #include "X86GenAsmMatcher.inc"
  63
  64   /// }
  65
  66 public:
  67   X86ATTAsmParser(const Target &T, MCAsmParser &parser, TargetMachine &TM)
  68     : TargetAsmParser(T), Parser(parser), TM(TM) {
  69
  70     // Initialize the set of available features.
  71     setAvailableFeatures(ComputeAvailableFeatures(
  72                            &TM.getSubtarget<X86Subtarget>()));
  73   }
  74
  75   virtual bool ParseInstruction(StringRef Name, SMLoc NameLoc,
  76                                 SmallVectorImpl<MCParsedAsmOperand*> &Operands);
  77
  78   virtual bool ParseDirective(AsmToken DirectiveID);
  79 };
  80
  81 class X86_32ATTAsmParser : public X86ATTAsmParser {
  82 public:
  83   X86_32ATTAsmParser(const Target &T, MCAsmParser &Parser, TargetMachine &TM)
  84     : X86ATTAsmParser(T, Parser, TM) {
  85     Is64Bit = false;
  86   }
  87 };
  88
  89 class X86_64ATTAsmParser : public X86ATTAsmParser {
  90 public:
  91   X86_64ATTAsmParser(const Target &T, MCAsmParser &Parser, TargetMachine &TM)
  92     : X86ATTAsmParser(T, Parser, TM) {
  93     Is64Bit = true;
  94   }
  95 };
  96
  97 } // end anonymous namespace
  98
  99 /// @name Auto-generated Match Functions
 100 /// {
 101
 102 static unsigned MatchRegisterName(StringRef Name);
 103
 104 /// }
 105
 106 namespace {
 107
 108 /// X86Operand - Instances of this class represent a parsed X86 machine
 109 /// instruction.
 110 struct X86Operand : public MCParsedAsmOperand {
 111   enum KindTy {
 112     Token,
 113     Register,
 114     Immediate,
 115     Memory
 116   } Kind;
 117
 118   SMLoc StartLoc, EndLoc;
 119
 120   union {
 121     struct {
 122       const char *Data;
 123       unsigned Length;
 124     } Tok;
 125
 126     struct {
 127       unsigned RegNo;
 128     } Reg;
 129
 130     struct {
 131       const MCExpr *Val;
 132     } Imm;
 133
 134     struct {
 135       unsigned SegReg;
 136       const MCExpr *Disp;
 137       unsigned BaseReg;
 138       unsigned IndexReg;
 139       unsigned Scale;
 140     } Mem;
 141   };
 142
 143   X86Operand(KindTy K, SMLoc Start, SMLoc End)
 144     : Kind(K), StartLoc(Start), EndLoc(End) {}
 145
 146   /// getStartLoc - Get the location of the first token of this operand.
 147   SMLoc getStartLoc() const { return StartLoc; }
 148   /// getEndLoc - Get the location of the last token of this operand.
 149   SMLoc getEndLoc() const { return EndLoc; }
 150
 151   virtual void dump(raw_ostream &OS) const {}
 152
 153   StringRef getToken() const {
 154     assert(Kind == Token && "Invalid access!");
 155     return StringRef(Tok.Data, Tok.Length);
 156   }
 157   void setTokenValue(StringRef Value) {
 158     assert(Kind == Token && "Invalid access!");
 159     Tok.Data = Value.data();
 160     Tok.Length = Value.size();
 161   }
 162
 163   unsigned getReg() const {
 164     assert(Kind == Register && "Invalid access!");
 165     return Reg.RegNo;
 166   }
 167
 168   const MCExpr *getImm() const {
 169     assert(Kind == Immediate && "Invalid access!");
 170     return Imm.Val;
 171   }
 172
 173   const MCExpr *getMemDisp() const {
 174     assert(Kind == Memory && "Invalid access!");
 175     return Mem.Disp;
 176   }
 177   unsigned getMemSegReg() const {
 178     assert(Kind == Memory && "Invalid access!");
 179     return Mem.SegReg;
 180   }
 181   unsigned getMemBaseReg() const {
 182     assert(Kind == Memory && "Invalid access!");
 183     return Mem.BaseReg;
 184   }
 185   unsigned getMemIndexReg() const {
 186     assert(Kind == Memory && "Invalid access!");
 187     return Mem.IndexReg;
 188   }
 189   unsigned getMemScale() const {
 190     assert(Kind == Memory && "Invalid access!");
 191     return Mem.Scale;
 192   }
 193
 194   bool isToken() const {return Kind == Token; }
 195
 196   bool isImm() const { return Kind == Immediate; }
 197
 198   bool isImmSExti16i8() const {
 199     if (!isImm())
 200       return false;
 201
 202     // If this isn't a constant expr, just assume it fits and let relaxation
 203     // handle it.
 204     const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(getImm());
 205     if (!CE)
 206       return true;
 207
 208     // Otherwise, check the value is in a range that makes sense for this
 209     // extension.
 210     uint64_t Value = CE->getValue();
 211     return ((                                  Value <= 0x000000000000007FULL)||
 212             (0x000000000000FF80ULL <= Value && Value <= 0x000000000000FFFFULL)||
 213             (0xFFFFFFFFFFFFFF80ULL <= Value && Value <= 0xFFFFFFFFFFFFFFFFULL));
 214   }
 215   bool isImmSExti32i8() const {
 216     if (!isImm())
 217       return false;
 218
 219     // If this isn't a constant expr, just assume it fits and let relaxation
 220     // handle it.
 221     const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(getImm());
 222     if (!CE)
 223       return true;
 224
 225     // Otherwise, check the value is in a range that makes sense for this
 226     // extension.
 227     uint64_t Value = CE->getValue();
 228     return ((                                  Value <= 0x000000000000007FULL)||
 229             (0x00000000FFFFFF80ULL <= Value && Value <= 0x00000000FFFFFFFFULL)||
 230             (0xFFFFFFFFFFFFFF80ULL <= Value && Value <= 0xFFFFFFFFFFFFFFFFULL));
 231   }
 232   bool isImmSExti64i8() const {
 233     if (!isImm())
 234       return false;
 235
 236     // If this isn't a constant expr, just assume it fits and let relaxation
 237     // handle it.
 238     const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(getImm());
 239     if (!CE)
 240       return true;
 241
 242     // Otherwise, check the value is in a range that makes sense for this
 243     // extension.
 244     uint64_t Value = CE->getValue();
 245     return ((                                  Value <= 0x000000000000007FULL)||
 246             (0xFFFFFFFFFFFFFF80ULL <= Value && Value <= 0xFFFFFFFFFFFFFFFFULL));
 247   }
 248   bool isImmSExti64i32() const {
 249     if (!isImm())
 250       return false;
 251
 252     // If this isn't a constant expr, just assume it fits and let relaxation
 253     // handle it.
 254     const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(getImm());
 255     if (!CE)
 256       return true;
 257
 258     // Otherwise, check the value is in a range that makes sense for this
 259     // extension.
 260     uint64_t Value = CE->getValue();
 261     return ((                                  Value <= 0x000000007FFFFFFFULL)||
 262             (0xFFFFFFFF80000000ULL <= Value && Value <= 0xFFFFFFFFFFFFFFFFULL));
 263   }
 264
 265   bool isMem() const { return Kind == Memory; }
 266
 267   bool isAbsMem() const {
 268     return Kind == Memory && !getMemSegReg() && !getMemBaseReg() &&
 269       !getMemIndexReg() && getMemScale() == 1;
 270   }
 271
 272   bool isReg() const { return Kind == Register; }
 273
 274   void addExpr(MCInst &Inst, const MCExpr *Expr) const {
 275     // Add as immediates when possible.
 276     if (const MCConstantExpr *CE = dyn_cast<MCConstantExpr>(Expr))
 277       Inst.addOperand(MCOperand::CreateImm(CE->getValue()));
 278     else
 279       Inst.addOperand(MCOperand::CreateExpr(Expr));
 280   }
 281
 282   void addRegOperands(MCInst &Inst, unsigned N) const {
 283     assert(N == 1 && "Invalid number of operands!");
 284     Inst.addOperand(MCOperand::CreateReg(getReg()));
 285   }
 286
 287   void addImmOperands(MCInst &Inst, unsigned N) const {
 288     assert(N == 1 && "Invalid number of operands!");
 289     addExpr(Inst, getImm());
 290   }
 291
 292   void addMemOperands(MCInst &Inst, unsigned N) const {
 293     assert((N == 5) && "Invalid number of operands!");
 294     Inst.addOperand(MCOperand::CreateReg(getMemBaseReg()));
 295     Inst.addOperand(MCOperand::CreateImm(getMemScale()));
 296     Inst.addOperand(MCOperand::CreateReg(getMemIndexReg()));
 297     addExpr(Inst, getMemDisp());
 298     Inst.addOperand(MCOperand::CreateReg(getMemSegReg()));
 299   }
 300
 301   void addAbsMemOperands(MCInst &Inst, unsigned N) const {
 302     assert((N == 1) && "Invalid number of operands!");
 303     Inst.addOperand(MCOperand::CreateExpr(getMemDisp()));
 304   }
 305
 306   static X86Operand *CreateToken(StringRef Str, SMLoc Loc) {
 307     X86Operand *Res = new X86Operand(Token, Loc, Loc);
 308     Res->Tok.Data = Str.data();
 309     Res->Tok.Length = Str.size();
 310     return Res;
 311   }
 312
 313   static X86Operand *CreateReg(unsigned RegNo, SMLoc StartLoc, SMLoc EndLoc) {
 314     X86Operand *Res = new X86Operand(Register, StartLoc, EndLoc);
 315     Res->Reg.RegNo = RegNo;
 316     return Res;
 317   }
 318
 319   static X86Operand *CreateImm(const MCExpr *Val, SMLoc StartLoc, SMLoc EndLoc){
 320     X86Operand *Res = new X86Operand(Immediate, StartLoc, EndLoc);
 321     Res->Imm.Val = Val;
 322     return Res;
 323   }
 324
 325   /// Create an absolute memory operand.
 326   static X86Operand *CreateMem(const MCExpr *Disp, SMLoc StartLoc,
 327                                SMLoc EndLoc) {
 328     X86Operand *Res = new X86Operand(Memory, StartLoc, EndLoc);
 329     Res->Mem.SegReg   = 0;
 330     Res->Mem.Disp     = Disp;
 331     Res->Mem.BaseReg  = 0;
 332     Res->Mem.IndexReg = 0;
 333     Res->Mem.Scale    = 1;
 334     return Res;
 335   }
 336
 337   /// Create a generalized memory operand.
 338   static X86Operand *CreateMem(unsigned SegReg, const MCExpr *Disp,
 339                                unsigned BaseReg, unsigned IndexReg,
 340                                unsigned Scale, SMLoc StartLoc, SMLoc EndLoc) {
 341     // We should never just have a displacement, that should be parsed as an
 342     // absolute memory operand.
 343     assert((SegReg || BaseReg || IndexReg) && "Invalid memory operand!");
 344
 345     // The scale should always be one of {1,2,4,8}.
 346     assert(((Scale == 1 || Scale == 2 || Scale == 4 || Scale == 8)) &&
 347            "Invalid scale!");
 348     X86Operand *Res = new X86Operand(Memory, StartLoc, EndLoc);
 349     Res->Mem.SegReg   = SegReg;
 350     Res->Mem.Disp     = Disp;
 351     Res->Mem.BaseReg  = BaseReg;
 352     Res->Mem.IndexReg = IndexReg;
 353     Res->Mem.Scale    = Scale;
 354     return Res;
 355   }
 356 };
 357
 358 } // end anonymous namespace.
 359
 360
 361 bool X86ATTAsmParser::ParseRegister(unsigned &RegNo,
 362                                     SMLoc &StartLoc, SMLoc &EndLoc) {
 363   RegNo = 0;
 364   const AsmToken &TokPercent = Parser.getTok();
 365   assert(TokPercent.is(AsmToken::Percent) && "Invalid token kind!");
 366   StartLoc = TokPercent.getLoc();
 367   Parser.Lex(); // Eat percent token.
 368
 369   const AsmToken &Tok = Parser.getTok();
 370   if (Tok.isNot(AsmToken::Identifier))
 371     return Error(Tok.getLoc(), "invalid register name");
 372
 373   // FIXME: Validate register for the current architecture; we have to do
 374   // validation later, so maybe there is no need for this here.
 375   RegNo = MatchRegisterName(Tok.getString());
 376
 377   // If the match failed, try the register name as lowercase.
 378   if (RegNo == 0)
 379     RegNo = MatchRegisterName(LowercaseString(Tok.getString()));
 380
 381   // FIXME: This should be done using Requires<In32BitMode> and
 382   // Requires<In64BitMode> so "eiz" usage in 64-bit instructions
 383   // can be also checked.
 384   if (RegNo == X86::RIZ && !Is64Bit)
 385     return Error(Tok.getLoc(), "riz register in 64-bit mode only");
 386
 387   // Parse "%st" as "%st(0)" and "%st(1)", which is multiple tokens.
 388   if (RegNo == 0 && (Tok.getString() == "st" || Tok.getString() == "ST")) {
 389     RegNo = X86::ST0;
 390     EndLoc = Tok.getLoc();
 391     Parser.Lex(); // Eat 'st'
 392
 393     // Check to see if we have '(4)' after %st.
 394     if (getLexer().isNot(AsmToken::LParen))
 395       return false;
 396     // Lex the paren.
 397     getParser().Lex();
 398
 399     const AsmToken &IntTok = Parser.getTok();
 400     if (IntTok.isNot(AsmToken::Integer))
 401       return Error(IntTok.getLoc(), "expected stack index");
 402     switch (IntTok.getIntVal()) {
 403     case 0: RegNo = X86::ST0; break;
 404     case 1: RegNo = X86::ST1; break;
 405     case 2: RegNo = X86::ST2; break;
 406     case 3: RegNo = X86::ST3; break;
 407     case 4: RegNo = X86::ST4; break;
 408     case 5: RegNo = X86::ST5; break;
 409     case 6: RegNo = X86::ST6; break;
 410     case 7: RegNo = X86::ST7; break;
 411     default: return Error(IntTok.getLoc(), "invalid stack index");
 412     }
 413
 414     if (getParser().Lex().isNot(AsmToken::RParen))
 415       return Error(Parser.getTok().getLoc(), "expected ')'");
 416
 417     EndLoc = Tok.getLoc();
 418     Parser.Lex(); // Eat ')'
 419     return false;
 420   }
 421
 422   // If this is "db[0-7]", match it as an alias
 423   // for dr[0-7].
 424   if (RegNo == 0 && Tok.getString().size() == 3 &&
 425       Tok.getString().startswith("db")) {
 426     switch (Tok.getString()[2]) {
 427     case '0': RegNo = X86::DR0; break;
 428     case '1': RegNo = X86::DR1; break;
 429     case '2': RegNo = X86::DR2; break;
 430     case '3': RegNo = X86::DR3; break;
 431     case '4': RegNo = X86::DR4; break;
 432     case '5': RegNo = X86::DR5; break;
 433     case '6': RegNo = X86::DR6; break;
 434     case '7': RegNo = X86::DR7; break;
 435     }
 436
 437     if (RegNo != 0) {
 438       EndLoc = Tok.getLoc();
 439       Parser.Lex(); // Eat it.
 440       return false;
 441     }
 442   }
 443
 444   if (RegNo == 0)
 445     return Error(Tok.getLoc(), "invalid register name");
 446
 447   EndLoc = Tok.getLoc();
 448   Parser.Lex(); // Eat identifier token.
 449   return false;
 450 }
 451
 452 X86Operand *X86ATTAsmParser::ParseOperand() {
 453   switch (getLexer().getKind()) {
 454   default:
 455     // Parse a memory operand with no segment register.
 456     return ParseMemOperand(0, Parser.getTok().getLoc());
 457   case AsmToken::Percent: {
 458     // Read the register.
 459     unsigned RegNo;
 460     SMLoc Start, End;
 461     if (ParseRegister(RegNo, Start, End)) return 0;
 462     if (RegNo == X86::EIZ || RegNo == X86::RIZ) {
 463       Error(Start, "eiz and riz can only be used as index registers");
 464       return 0;
 465     }
 466
 467     // If this is a segment register followed by a ':', then this is the start
 468     // of a memory reference, otherwise this is a normal register reference.
 469     if (getLexer().isNot(AsmToken::Colon))
 470       return X86Operand::CreateReg(RegNo, Start, End);
 471
 472
 473     getParser().Lex(); // Eat the colon.
 474     return ParseMemOperand(RegNo, Start);
 475   }
 476   case AsmToken::Dollar: {
 477     // $42 -> immediate.
 478     SMLoc Start = Parser.getTok().getLoc(), End;
 479     Parser.Lex();
 480     const MCExpr *Val;
 481     if (getParser().ParseExpression(Val, End))
 482       return 0;
 483     return X86Operand::CreateImm(Val, Start, End);
 484   }
 485   }
 486 }
 487
 488 /// ParseMemOperand: segment: disp(basereg, indexreg, scale).  The '%ds:' prefix
 489 /// has already been parsed if present.
 490 X86Operand *X86ATTAsmParser::ParseMemOperand(unsigned SegReg, SMLoc MemStart) {
 491
 492   // We have to disambiguate a parenthesized expression "(4+5)" from the start
 493   // of a memory operand with a missing displacement "(%ebx)" or "(,%eax)".  The
 494   // only way to do this without lookahead is to eat the '(' and see what is
 495   // after it.
 496   const MCExpr *Disp = MCConstantExpr::Create(0, getParser().getContext());
 497   if (getLexer().isNot(AsmToken::LParen)) {
 498     SMLoc ExprEnd;
 499     if (getParser().ParseExpression(Disp, ExprEnd)) return 0;
 500
 501     // After parsing the base expression we could either have a parenthesized
 502     // memory address or not.  If not, return now.  If so, eat the (.
 503     if (getLexer().isNot(AsmToken::LParen)) {
 504       // Unless we have a segment register, treat this as an immediate.
 505       if (SegReg == 0)
 506         return X86Operand::CreateMem(Disp, MemStart, ExprEnd);
 507       return X86Operand::CreateMem(SegReg, Disp, 0, 0, 1, MemStart, ExprEnd);
 508     }
 509
 510     // Eat the '('.
 511     Parser.Lex();
 512   } else {
 513     // Okay, we have a '('.  We don't know if this is an expression or not, but
 514     // so we have to eat the ( to see beyond it.
 515     SMLoc LParenLoc = Parser.getTok().getLoc();
 516     Parser.Lex(); // Eat the '('.
 517
 518     if (getLexer().is(AsmToken::Percent) || getLexer().is(AsmToken::Comma)) {
 519       // Nothing to do here, fall into the code below with the '(' part of the
 520       // memory operand consumed.
 521     } else {
 522       SMLoc ExprEnd;
 523
 524       // It must be an parenthesized expression, parse it now.
 525       if (getParser().ParseParenExpression(Disp, ExprEnd))
 526         return 0;
 527
 528       // After parsing the base expression we could either have a parenthesized
 529       // memory address or not.  If not, return now.  If so, eat the (.
 530       if (getLexer().isNot(AsmToken::LParen)) {
 531         // Unless we have a segment register, treat this as an immediate.
 532         if (SegReg == 0)
 533           return X86Operand::CreateMem(Disp, LParenLoc, ExprEnd);
 534         return X86Operand::CreateMem(SegReg, Disp, 0, 0, 1, MemStart, ExprEnd);
 535       }
 536
 537       // Eat the '('.
 538       Parser.Lex();
 539     }
 540   }
 541
 542   // If we reached here, then we just ate the ( of the memory operand.  Process
 543   // the rest of the memory operand.
 544   unsigned BaseReg = 0, IndexReg = 0, Scale = 1;
 545
 546   if (getLexer().is(AsmToken::Percent)) {
 547     SMLoc L;
 548     if (ParseRegister(BaseReg, L, L)) return 0;
 549     if (BaseReg == X86::EIZ || BaseReg == X86::RIZ) {
 550       Error(L, "eiz and riz can only be used as index registers");
 551       return 0;
 552     }
 553   }
 554
 555   if (getLexer().is(AsmToken::Comma)) {
 556     Parser.Lex(); // Eat the comma.
 557
 558     // Following the comma we should have either an index register, or a scale
 559     // value. We don't support the later form, but we want to parse it
 560     // correctly.
 561     //
 562     // Not that even though it would be completely consistent to support syntax
 563     // like "1(%eax,,1)", the assembler doesn't. Use "eiz" or "riz" for this.
 564     if (getLexer().is(AsmToken::Percent)) {
 565       SMLoc L;
 566       if (ParseRegister(IndexReg, L, L)) return 0;
 567
 568       if (getLexer().isNot(AsmToken::RParen)) {
 569         // Parse the scale amount:
 570         //  ::= ',' [scale-expression]
 571         if (getLexer().isNot(AsmToken::Comma)) {
 572           Error(Parser.getTok().getLoc(),
 573                 "expected comma in scale expression");
 574           return 0;
 575         }
 576         Parser.Lex(); // Eat the comma.
 577
 578         if (getLexer().isNot(AsmToken::RParen)) {
 579           SMLoc Loc = Parser.getTok().getLoc();
 580
 581           int64_t ScaleVal;
 582           if (getParser().ParseAbsoluteExpression(ScaleVal))
 583             return 0;
 584
 585           // Validate the scale amount.
 586           if (ScaleVal != 1 && ScaleVal != 2 && ScaleVal != 4 && ScaleVal != 8){
 587             Error(Loc, "scale factor in address must be 1, 2, 4 or 8");
 588             return 0;
 589           }
 590           Scale = (unsigned)ScaleVal;
 591         }
 592       }
 593     } else if (getLexer().isNot(AsmToken::RParen)) {
 594       // A scale amount without an index is ignored.
 595       // index.
 596       SMLoc Loc = Parser.getTok().getLoc();
 597
 598       int64_t Value;
 599       if (getParser().ParseAbsoluteExpression(Value))
 600         return 0;
 601
 602       if (Value != 1)
 603         Warning(Loc, "scale factor without index register is ignored");
 604       Scale = 1;
 605     }
 606   }
 607
 608   // Ok, we've eaten the memory operand, verify we have a ')' and eat it too.
 609   if (getLexer().isNot(AsmToken::RParen)) {
 610     Error(Parser.getTok().getLoc(), "unexpected token in memory operand");
 611     return 0;
 612   }
 613   SMLoc MemEnd = Parser.getTok().getLoc();
 614   Parser.Lex(); // Eat the ')'.
 615
 616   return X86Operand::CreateMem(SegReg, Disp, BaseReg, IndexReg, Scale,
 617                                MemStart, MemEnd);
 618 }
 619
 620 bool X86ATTAsmParser::
 621 ParseInstruction(StringRef Name, SMLoc NameLoc,
 622                  SmallVectorImpl<MCParsedAsmOperand*> &Operands) {
 623   StringRef PatchedName = Name;
 624
 625   // FIXME: Hack to recognize cmp<comparison code>{ss,sd,ps,pd}.
 626   const MCExpr *ExtraImmOp = 0;
 627   if ((PatchedName.startswith("cmp") || PatchedName.startswith("vcmp")) &&
 628       (PatchedName.endswith("ss") || PatchedName.endswith("sd") ||
 629        PatchedName.endswith("ps") || PatchedName.endswith("pd"))) {
 630     bool IsVCMP = PatchedName.startswith("vcmp");
 631     unsigned SSECCIdx = IsVCMP ? 4 : 3;
 632     unsigned SSEComparisonCode = StringSwitch<unsigned>(
 633       PatchedName.slice(SSECCIdx, PatchedName.size() - 2))
 634       .Case("eq",          0)
 635       .Case("lt",          1)
 636       .Case("le",          2)
 637       .Case("unord",       3)
 638       .Case("neq",         4)
 639       .Case("nlt",         5)
 640       .Case("nle",         6)
 641       .Case("ord",         7)
 642       .Case("eq_uq",       8)
 643       .Case("nge",         9)
 644       .Case("ngt",      0x0A)
 645       .Case("false",    0x0B)
 646       .Case("neq_oq",   0x0C)
 647       .Case("ge",       0x0D)
 648       .Case("gt",       0x0E)
 649       .Case("true",     0x0F)
 650       .Case("eq_os",    0x10)
 651       .Case("lt_oq",    0x11)
 652       .Case("le_oq",    0x12)
 653       .Case("unord_s",  0x13)
 654       .Case("neq_us",   0x14)
 655       .Case("nlt_uq",   0x15)
 656       .Case("nle_uq",   0x16)
 657       .Case("ord_s",    0x17)
 658       .Case("eq_us",    0x18)
 659       .Case("nge_uq",   0x19)
 660       .Case("ngt_uq",   0x1A)
 661       .Case("false_os", 0x1B)
 662       .Case("neq_os",   0x1C)
 663       .Case("ge_oq",    0x1D)
 664       .Case("gt_oq",    0x1E)
 665       .Case("true_us",  0x1F)
 666       .Default(~0U);
 667     if (SSEComparisonCode != ~0U) {
 668       ExtraImmOp = MCConstantExpr::Create(SSEComparisonCode,
 669                                           getParser().getContext());
 670       if (PatchedName.endswith("ss")) {
 671         PatchedName = IsVCMP ? "vcmpss" : "cmpss";
 672       } else if (PatchedName.endswith("sd")) {
 673         PatchedName = IsVCMP ? "vcmpsd" : "cmpsd";
 674       } else if (PatchedName.endswith("ps")) {
 675         PatchedName = IsVCMP ? "vcmpps" : "cmpps";
 676       } else {
 677         assert(PatchedName.endswith("pd") && "Unexpected mnemonic!");
 678         PatchedName = IsVCMP ? "vcmppd" : "cmppd";
 679       }
 680     }
 681   }
 682
 683   // FIXME: Hack to recognize vpclmul<src1_quadword, src2_quadword>dq
 684   if (PatchedName.startswith("vpclmul")) {
 685     unsigned CLMULQuadWordSelect = StringSwitch<unsigned>(
 686       PatchedName.slice(7, PatchedName.size() - 2))
 687       .Case("lqlq", 0x00) // src1[63:0],   src2[63:0]
 688       .Case("hqlq", 0x01) // src1[127:64], src2[63:0]
 689       .Case("lqhq", 0x10) // src1[63:0],   src2[127:64]
 690       .Case("hqhq", 0x11) // src1[127:64], src2[127:64]
 691       .Default(~0U);
 692     if (CLMULQuadWordSelect != ~0U) {
 693       ExtraImmOp = MCConstantExpr::Create(CLMULQuadWordSelect,
 694                                           getParser().getContext());
 695       assert(PatchedName.endswith("dq") && "Unexpected mnemonic!");
 696       PatchedName = "vpclmulqdq";
 697     }
 698   }
 699
 700   Operands.push_back(X86Operand::CreateToken(PatchedName, NameLoc));
 701
 702   if (ExtraImmOp)
 703     Operands.push_back(X86Operand::CreateImm(ExtraImmOp, NameLoc, NameLoc));
 704
 705
 706   // Determine whether this is an instruction prefix.
 707   bool isPrefix =
 708     Name == "lock" || Name == "rep" ||
 709     Name == "repe" || Name == "repz" ||
 710     Name == "repne" || Name == "repnz";
 711
 712
 713   // This does the actual operand parsing.  Don't parse any more if we have a
 714   // prefix juxtaposed with an operation like "lock incl 4(%rax)", because we
 715   // just want to parse the "lock" as the first instruction and the "incl" as
 716   // the next one.
 717   if (getLexer().isNot(AsmToken::EndOfStatement) && !isPrefix) {
 718
 719     // Parse '*' modifier.
 720     if (getLexer().is(AsmToken::Star)) {
 721       SMLoc Loc = Parser.getTok().getLoc();
 722       Operands.push_back(X86Operand::CreateToken("*", Loc));
 723       Parser.Lex(); // Eat the star.
 724     }
 725
 726     // Read the first operand.
 727     if (X86Operand *Op = ParseOperand())
 728       Operands.push_back(Op);
 729     else {
 730       Parser.EatToEndOfStatement();
 731       return true;
 732     }
 733
 734     while (getLexer().is(AsmToken::Comma)) {
 735       Parser.Lex();  // Eat the comma.
 736
 737       // Parse and remember the operand.
 738       if (X86Operand *Op = ParseOperand())
 739         Operands.push_back(Op);
 740       else {
 741         Parser.EatToEndOfStatement();
 742         return true;
 743       }
 744     }
 745
 746     if (getLexer().isNot(AsmToken::EndOfStatement)) {
 747       Parser.EatToEndOfStatement();
 748       return TokError("unexpected token in argument list");
 749     }
 750   }
 751
 752   if (getLexer().is(AsmToken::EndOfStatement))
 753     Parser.Lex(); // Consume the EndOfStatement
 754
 755   // This is a terrible hack to handle "out[bwl]? %al, (%dx)" ->
 756   // "outb %al, %dx".  Out doesn't take a memory form, but this is a widely
 757   // documented form in various unofficial manuals, so a lot of code uses it.
 758   if ((Name == "outb" || Name == "outw" || Name == "outl" || Name == "out") &&
 759       Operands.size() == 3) {
 760     X86Operand &Op = *(X86Operand*)Operands.back();
 761     if (Op.isMem() && Op.Mem.SegReg == 0 &&
 762         isa<MCConstantExpr>(Op.Mem.Disp) &&
 763         cast<MCConstantExpr>(Op.Mem.Disp)->getValue() == 0 &&
 764         Op.Mem.BaseReg == MatchRegisterName("dx") && Op.Mem.IndexReg == 0) {
 765       SMLoc Loc = Op.getEndLoc();
 766       Operands.back() = X86Operand::CreateReg(Op.Mem.BaseReg, Loc, Loc);
 767       delete &Op;
 768     }
 769   }
 770
 771   // FIXME: Hack to handle recognize s{hr,ar,hl} $1, <op>.  Canonicalize to
 772   // "shift <op>".
 773   if ((Name.startswith("shr") || Name.startswith("sar") ||
 774        Name.startswith("shl") || Name.startswith("sal")) &&
 775       Operands.size() == 3) {
 776     X86Operand *Op1 = static_cast<X86Operand*>(Operands[1]);
 777     if (Op1->isImm() && isa<MCConstantExpr>(Op1->getImm()) &&
 778         cast<MCConstantExpr>(Op1->getImm())->getValue() == 1) {
 779       delete Operands[1];
 780       Operands.erase(Operands.begin() + 1);
 781     }
 782   }
 783
 784   // FIXME: Hack to handle recognize "rc[lr] <op>" -> "rcl $1, <op>".
 785   if ((Name.startswith("rcl") || Name.startswith("rcr")) &&
 786       Operands.size() == 2) {
 787     const MCExpr *One = MCConstantExpr::Create(1, getParser().getContext());
 788     Operands.push_back(X86Operand::CreateImm(One, NameLoc, NameLoc));
 789     std::swap(Operands[1], Operands[2]);
 790   }
 791
 792   // FIXME: Hack to handle recognize "sh[lr]d op,op" -> "shld $1, op,op".
 793   if ((Name.startswith("shld") || Name.startswith("shrd")) &&
 794       Operands.size() == 3) {
 795     const MCExpr *One = MCConstantExpr::Create(1, getParser().getContext());
 796     Operands.insert(Operands.begin()+1,
 797                     X86Operand::CreateImm(One, NameLoc, NameLoc));
 798   }
 799
 800   return false;
 801 }
 802
 803 bool X86ATTAsmParser::
 804 MatchAndEmitInstruction(SMLoc IDLoc,
 805                         SmallVectorImpl<MCParsedAsmOperand*> &Operands,
 806                         MCStreamer &Out) {
 807   assert(!Operands.empty() && "Unexpect empty operand list!");
 808   X86Operand *Op = static_cast<X86Operand*>(Operands[0]);
 809   assert(Op->isToken() && "Leading operand should always be a mnemonic!");
 810
 811   // First, handle aliases that expand to multiple instructions.
 812   // FIXME: This should be replaced with a real .td file alias mechanism.
 813   // Also, MatchInstructionImpl should do actually *do* the EmitInstruction
 814   // call.
 815   if (Op->getToken() == "fstsw" || Op->getToken() == "fstcw" ||
 816       Op->getToken() == "fstsww" || Op->getToken() == "fstcww" ||
 817       Op->getToken() == "finit" || Op->getToken() == "fsave" ||
 818       Op->getToken() == "fstenv" || Op->getToken() == "fclex") {
 819     MCInst Inst;
 820     Inst.setOpcode(X86::WAIT);
 821     Out.EmitInstruction(Inst);
 822
 823     const char *Repl =
 824       StringSwitch<const char*>(Op->getToken())
 825         .Case("finit",  "fninit")
 826         .Case("fsave",  "fnsave")
 827         .Case("fstcw",  "fnstcw")
 828         .Case("fstcww",  "fnstcw")
 829         .Case("fstenv", "fnstenv")
 830         .Case("fstsw",  "fnstsw")
 831         .Case("fstsww", "fnstsw")
 832         .Case("fclex",  "fnclex")
 833         .Default(0);
 834     assert(Repl && "Unknown wait-prefixed instruction");
 835     delete Operands[0];
 836     Operands[0] = X86Operand::CreateToken(Repl, IDLoc);
 837   }
 838
 839   bool WasOriginallyInvalidOperand = false;
 840   unsigned OrigErrorInfo;
 841   MCInst Inst;
 842
 843   // First, try a direct match.
 844   switch (MatchInstructionImpl(Operands, Inst, OrigErrorInfo)) {
 845   case Match_Success:
 846     Out.EmitInstruction(Inst);
 847     return false;
 848   case Match_MissingFeature:
 849     Error(IDLoc, "instruction requires a CPU feature not currently enabled");
 850     return true;
 851   case Match_InvalidOperand:
 852     WasOriginallyInvalidOperand = true;
 853     break;
 854   case Match_MnemonicFail:
 855     break;
 856   }
 857
 858   // FIXME: Ideally, we would only attempt suffix matches for things which are
 859   // valid prefixes, and we could just infer the right unambiguous
 860   // type. However, that requires substantially more matcher support than the
 861   // following hack.
 862
 863   // Change the operand to point to a temporary token.
 864   StringRef Base = Op->getToken();
 865   SmallString<16> Tmp;
 866   Tmp += Base;
 867   Tmp += ' ';
 868   Op->setTokenValue(Tmp.str());
 869
 870   // If this instruction starts with an 'f', then it is a floating point stack
 871   // instruction.  These come in up to three forms for 32-bit, 64-bit, and
 872   // 80-bit floating point, which use the suffixes s,l,t respectively.
 873   //
 874   // Otherwise, we assume that this may be an integer instruction, which comes
 875   // in 8/16/32/64-bit forms using the b,w,l,q suffixes respectively.
 876   const char *Suffixes = Base[0] != 'f' ? "bwlq" : "slt\0";
 877
 878   // Check for the various suffix matches.
 879   Tmp[Base.size()] = Suffixes[0];
 880   unsigned ErrorInfoIgnore;
 881   MatchResultTy Match1, Match2, Match3, Match4;
 882
 883   Match1 = MatchInstructionImpl(Operands, Inst, ErrorInfoIgnore);
 884   Tmp[Base.size()] = Suffixes[1];
 885   Match2 = MatchInstructionImpl(Operands, Inst, ErrorInfoIgnore);
 886   Tmp[Base.size()] = Suffixes[2];
 887   Match3 = MatchInstructionImpl(Operands, Inst, ErrorInfoIgnore);
 888   Tmp[Base.size()] = Suffixes[3];
 889   Match4 = MatchInstructionImpl(Operands, Inst, ErrorInfoIgnore);
 890
 891   // Restore the old token.
 892   Op->setTokenValue(Base);
 893
 894   // If exactly one matched, then we treat that as a successful match (and the
 895   // instruction will already have been filled in correctly, since the failing
 896   // matches won't have modified it).
 897   unsigned NumSuccessfulMatches =
 898     (Match1 == Match_Success) + (Match2 == Match_Success) +
 899     (Match3 == Match_Success) + (Match4 == Match_Success);
 900   if (NumSuccessfulMatches == 1) {
 901     Out.EmitInstruction(Inst);
 902     return false;
 903   }
 904
 905   // Otherwise, the match failed, try to produce a decent error message.
 906
 907   // If we had multiple suffix matches, then identify this as an ambiguous
 908   // match.
 909   if (NumSuccessfulMatches > 1) {
 910     char MatchChars[4];
 911     unsigned NumMatches = 0;
 912     if (Match1 == Match_Success) MatchChars[NumMatches++] = Suffixes[0];
 913     if (Match2 == Match_Success) MatchChars[NumMatches++] = Suffixes[1];
 914     if (Match3 == Match_Success) MatchChars[NumMatches++] = Suffixes[2];
 915     if (Match4 == Match_Success) MatchChars[NumMatches++] = Suffixes[3];
 916
 917     SmallString<126> Msg;
 918     raw_svector_ostream OS(Msg);
 919     OS << "ambiguous instructions require an explicit suffix (could be ";
 920     for (unsigned i = 0; i != NumMatches; ++i) {
 921       if (i != 0)
 922         OS << ", ";
 923       if (i + 1 == NumMatches)
 924         OS << "or ";
 925       OS << "'" << Base << MatchChars[i] << "'";
 926     }
 927     OS << ")";
 928     Error(IDLoc, OS.str());
 929     return true;
 930   }
 931
 932   // Okay, we know that none of the variants matched successfully.
 933
 934   // If all of the instructions reported an invalid mnemonic, then the original
 935   // mnemonic was invalid.
 936   if ((Match1 == Match_MnemonicFail) && (Match2 == Match_MnemonicFail) &&
 937       (Match3 == Match_MnemonicFail) && (Match4 == Match_MnemonicFail)) {
 938     if (!WasOriginallyInvalidOperand) {
 939       Error(IDLoc, "invalid instruction mnemonic '" + Base + "'");
 940       return true;
 941     }
 942
 943     // Recover location info for the operand if we know which was the problem.
 944     SMLoc ErrorLoc = IDLoc;
 945     if (OrigErrorInfo != ~0U) {
 946       if (OrigErrorInfo >= Operands.size())
 947         return Error(IDLoc, "too few operands for instruction");
 948
 949       ErrorLoc = ((X86Operand*)Operands[OrigErrorInfo])->getStartLoc();
 950       if (ErrorLoc == SMLoc()) ErrorLoc = IDLoc;
 951     }
 952
 953     return Error(ErrorLoc, "invalid operand for instruction");
 954   }
 955
 956   // If one instruction matched with a missing feature, report this as a
 957   // missing feature.
 958   if ((Match1 == Match_MissingFeature) + (Match2 == Match_MissingFeature) +
 959       (Match3 == Match_MissingFeature) + (Match4 == Match_MissingFeature) == 1){
 960     Error(IDLoc, "instruction requires a CPU feature not currently enabled");
 961     return true;
 962   }
 963
 964   // If one instruction matched with an invalid operand, report this as an
 965   // operand failure.
 966   if ((Match1 == Match_InvalidOperand) + (Match2 == Match_InvalidOperand) +
 967       (Match3 == Match_InvalidOperand) + (Match4 == Match_InvalidOperand) == 1){
 968     Error(IDLoc, "invalid operand for instruction");
 969     return true;
 970   }
 971
 972   // If all of these were an outright failure, report it in a useless way.
 973   // FIXME: We should give nicer diagnostics about the exact failure.
 974   Error(IDLoc, "unknown use of instruction mnemonic without a size suffix");
 975   return true;
 976 }
 977
 978
 979 bool X86ATTAsmParser::ParseDirective(AsmToken DirectiveID) {
 980   StringRef IDVal = DirectiveID.getIdentifier();
 981   if (IDVal == ".word")
 982     return ParseDirectiveWord(2, DirectiveID.getLoc());
 983   return true;
 984 }
 985
 986 /// ParseDirectiveWord
 987 ///  ::= .word [ expression (, expression)* ]
 988 bool X86ATTAsmParser::ParseDirectiveWord(unsigned Size, SMLoc L) {
 989   if (getLexer().isNot(AsmToken::EndOfStatement)) {
 990     for (;;) {
 991       const MCExpr *Value;
 992       if (getParser().ParseExpression(Value))
 993         return true;
 994
 995       getParser().getStreamer().EmitValue(Value, Size, 0 /*addrspace*/);
 996
 997       if (getLexer().is(AsmToken::EndOfStatement))
 998         break;
 999
1000       // FIXME: Improve diagnostic.
1001       if (getLexer().isNot(AsmToken::Comma))
1002         return Error(L, "unexpected token in directive");
1003       Parser.Lex();
1004     }
1005   }
1006
1007   Parser.Lex();
1008   return false;
1009 }
1010
1011
1012
1013
1014 extern "C" void LLVMInitializeX86AsmLexer();
1015
1016 // Force static initialization.
1017 extern "C" void LLVMInitializeX86AsmParser() {
1018   RegisterAsmParser<X86_32ATTAsmParser> X(TheX86_32Target);
1019   RegisterAsmParser<X86_64ATTAsmParser> Y(TheX86_64Target);
1020   LLVMInitializeX86AsmLexer();
1021 }
1022
1023 #define GET_REGISTER_MATCHER
1024 #define GET_MATCHER_IMPLEMENTATION
1025 #include "X86GenAsmMatcher.inc"