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