lib/Target/X86/X86ISelSimple.cpp

   1 //===-- InstSelectSimple.cpp - A simple instruction selector for x86 ------===//
   2 //
   3 // This file defines a simple peephole instruction selector for the x86 platform
   4 //
   5 //===----------------------------------------------------------------------===//
   6
   7 #include "X86.h"
   8 #include "X86InstrInfo.h"
   9 #include "X86InstrBuilder.h"
  10 #include "llvm/Function.h"
  11 #include "llvm/iTerminators.h"
  12 #include "llvm/iOperators.h"
  13 #include "llvm/iOther.h"
  14 #include "llvm/iPHINode.h"
  15 #include "llvm/iMemory.h"
  16 #include "llvm/Type.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Constants.h"
  19 #include "llvm/Pass.h"
  20 #include "llvm/CodeGen/MachineFunction.h"
  21 #include "llvm/CodeGen/MachineInstrBuilder.h"
  22 #include "llvm/Target/TargetMachine.h"
  23 #include "llvm/Support/InstVisitor.h"
  24 #include "llvm/Target/MRegisterInfo.h"
  25 #include <map>
  26
  27 using namespace MOTy;  // Get Use, Def, UseAndDef
  28
  29
  30 /// BMI - A special BuildMI variant that takes an iterator to insert the
  31 /// instruction at as well as a basic block.
  32 /// this is the version for when you have a destination register in mind.
  33 inline static MachineInstrBuilder BMI(MachineBasicBlock *MBB,
  34                                       MachineBasicBlock::iterator &I,
  35                                       MachineOpCode Opcode,
  36                                       unsigned NumOperands,
  37                                       unsigned DestReg) {
  38   MachineInstr *MI = new MachineInstr(Opcode, NumOperands+1, true, true);
  39   I = ++MBB->insert(I, MI);
  40   return MachineInstrBuilder(MI).addReg(DestReg, MOTy::Def);
  41 }
  42
  43 /// BMI - A special BuildMI variant that takes an iterator to insert the
  44 /// instruction at as well as a basic block.
  45 inline static MachineInstrBuilder BMI(MachineBasicBlock *MBB,
  46                                       MachineBasicBlock::iterator &I,
  47                                       MachineOpCode Opcode,
  48                                       unsigned NumOperands) {
  49   MachineInstr *MI = new MachineInstr(Opcode, NumOperands, true, true);
  50   I = ++MBB->insert(I, MI);
  51   return MachineInstrBuilder(MI);
  52 }
  53
  54
  55 namespace {
  56   struct ISel : public FunctionPass, InstVisitor<ISel> {
  57     TargetMachine &TM;
  58     MachineFunction *F;                    // The function we are compiling into
  59     MachineBasicBlock *BB;                 // The current MBB we are compiling
  60
  61     unsigned CurReg;
  62     std::map<Value*, unsigned> RegMap;  // Mapping between Val's and SSA Regs
  63
  64     // MBBMap - Mapping between LLVM BB -> Machine BB
  65     std::map<const BasicBlock*, MachineBasicBlock*> MBBMap;
  66
  67     ISel(TargetMachine &tm)
  68       : TM(tm), F(0), BB(0), CurReg(MRegisterInfo::FirstVirtualRegister) {}
  69
  70     /// runOnFunction - Top level implementation of instruction selection for
  71     /// the entire function.
  72     ///
  73     bool runOnFunction(Function &Fn) {
  74       F = &MachineFunction::construct(&Fn, TM);
  75
  76       for (Function::iterator I = Fn.begin(), E = Fn.end(); I != E; ++I)
  77         F->getBasicBlockList().push_back(MBBMap[I] = new MachineBasicBlock(I));
  78
  79       // Instruction select everything except PHI nodes
  80       visit(Fn);
  81
  82       // Select the PHI nodes
  83       SelectPHINodes();
  84
  85       RegMap.clear();
  86       MBBMap.clear();
  87       CurReg = MRegisterInfo::FirstVirtualRegister;
  88       F = 0;
  89       return false;  // We never modify the LLVM itself.
  90     }
  91
  92     /// visitBasicBlock - This method is called when we are visiting a new basic
  93     /// block.  This simply creates a new MachineBasicBlock to emit code into
  94     /// and adds it to the current MachineFunction.  Subsequent visit* for
  95     /// instructions will be invoked for all instructions in the basic block.
  96     ///
  97     void visitBasicBlock(BasicBlock &LLVM_BB) {
  98       BB = MBBMap[&LLVM_BB];
  99     }
 100
 101
 102     /// SelectPHINodes - Insert machine code to generate phis.  This is tricky
 103     /// because we have to generate our sources into the source basic blocks,
 104     /// not the current one.
 105     ///
 106     void SelectPHINodes();
 107
 108     // Visitation methods for various instructions.  These methods simply emit
 109     // fixed X86 code for each instruction.
 110     //
 111
 112     // Control flow operators
 113     void visitReturnInst(ReturnInst &RI);
 114     void visitBranchInst(BranchInst &BI);
 115     void visitCallInst(CallInst &I);
 116
 117     // Arithmetic operators
 118     void visitSimpleBinary(BinaryOperator &B, unsigned OpcodeClass);
 119     void visitAdd(BinaryOperator &B) { visitSimpleBinary(B, 0); }
 120     void visitSub(BinaryOperator &B) { visitSimpleBinary(B, 1); }
 121     void doMultiply(unsigned destReg, const Type *resultType,
 122                     unsigned op0Reg, unsigned op1Reg,
 123                     MachineBasicBlock *MBB,
 124                     MachineBasicBlock::iterator &MBBI);
 125     void visitMul(BinaryOperator &B);
 126
 127     void visitDiv(BinaryOperator &B) { visitDivRem(B); }
 128     void visitRem(BinaryOperator &B) { visitDivRem(B); }
 129     void visitDivRem(BinaryOperator &B);
 130
 131     // Bitwise operators
 132     void visitAnd(BinaryOperator &B) { visitSimpleBinary(B, 2); }
 133     void visitOr (BinaryOperator &B) { visitSimpleBinary(B, 3); }
 134     void visitXor(BinaryOperator &B) { visitSimpleBinary(B, 4); }
 135
 136     // Binary comparison operators
 137     void visitSetCCInst(SetCondInst &I, unsigned OpNum);
 138     void visitSetEQ(SetCondInst &I) { visitSetCCInst(I, 0); }
 139     void visitSetNE(SetCondInst &I) { visitSetCCInst(I, 1); }
 140     void visitSetLT(SetCondInst &I) { visitSetCCInst(I, 2); }
 141     void visitSetGT(SetCondInst &I) { visitSetCCInst(I, 3); }
 142     void visitSetLE(SetCondInst &I) { visitSetCCInst(I, 4); }
 143     void visitSetGE(SetCondInst &I) { visitSetCCInst(I, 5); }
 144
 145     // Memory Instructions
 146     void visitLoadInst(LoadInst &I);
 147     void visitStoreInst(StoreInst &I);
 148     void visitGetElementPtrInst(GetElementPtrInst &I);
 149     void visitMallocInst(MallocInst &I);
 150     void visitFreeInst(FreeInst &I);
 151     void visitAllocaInst(AllocaInst &I);
 152
 153     // Other operators
 154     void visitShiftInst(ShiftInst &I);
 155     void visitPHINode(PHINode &I) {}      // PHI nodes handled by second pass
 156     void visitCastInst(CastInst &I);
 157
 158     void visitInstruction(Instruction &I) {
 159       std::cerr << "Cannot instruction select: " << I;
 160       abort();
 161     }
 162
 163     /// promote32 - Make a value 32-bits wide, and put it somewhere.
 164     void promote32 (const unsigned targetReg, Value *v);
 165
 166     // emitGEPOperation - Common code shared between visitGetElementPtrInst and
 167     // constant expression GEP support.
 168     //
 169     void emitGEPOperation(MachineBasicBlock *BB, MachineBasicBlock::iterator&IP,
 170                           Value *Src, User::op_iterator IdxBegin,
 171                           User::op_iterator IdxEnd, unsigned TargetReg);
 172
 173     /// copyConstantToRegister - Output the instructions required to put the
 174     /// specified constant into the specified register.
 175     ///
 176     void copyConstantToRegister(Constant *C, unsigned Reg,
 177                                 MachineBasicBlock *MBB,
 178                                 MachineBasicBlock::iterator &MBBI);
 179
 180     /// makeAnotherReg - This method returns the next register number
 181     /// we haven't yet used.
 182     unsigned makeAnotherReg(const Type *Ty) {
 183       // Add the mapping of regnumber => reg class to MachineFunction
 184       F->addRegMap(CurReg, TM.getRegisterInfo()->getRegClassForType(Ty));
 185       return CurReg++;
 186     }
 187
 188     /// getReg - This method turns an LLVM value into a register number.  This
 189     /// is guaranteed to produce the same register number for a particular value
 190     /// every time it is queried.
 191     ///
 192     unsigned getReg(Value &V) { return getReg(&V); }  // Allow references
 193     unsigned getReg(Value *V) {
 194       // Just append to the end of the current bb.
 195       MachineBasicBlock::iterator It = BB->end();
 196       return getReg(V, BB, It);
 197     }
 198     unsigned getReg(Value *V, MachineBasicBlock *MBB,
 199                     MachineBasicBlock::iterator &IPt) {
 200       unsigned &Reg = RegMap[V];
 201       if (Reg == 0) {
 202         Reg = makeAnotherReg(V->getType());
 203         RegMap[V] = Reg;
 204       }
 205
 206       // If this operand is a constant, emit the code to copy the constant into
 207       // the register here...
 208       //
 209       if (Constant *C = dyn_cast<Constant>(V)) {
 210         copyConstantToRegister(C, Reg, MBB, IPt);
 211       } else if (GlobalValue *GV = dyn_cast<GlobalValue>(V)) {
 212         // Move the address of the global into the register
 213         BMI(MBB, IPt, X86::MOVir32, 1, Reg).addReg(GV);
 214       } else if (Argument *A = dyn_cast<Argument>(V)) {
 215         // Find the position of the argument in the argument list.
 216         const Function *f = F->getFunction ();
 217         // The function's arguments look like this:
 218         // [EBP]     -- copy of old EBP
 219         // [EBP + 4] -- return address
 220         // [EBP + 8] -- first argument (leftmost lexically)
 221         // So we want to start with counter = 2.
 222         int counter = 2, argPos = -1;
 223         for (Function::const_aiterator ai = f->abegin (), ae = f->aend ();
 224              ai != ae; ++ai) {
 225           if (&(*ai) == A) {
 226             argPos = counter;
 227             break; // Only need to find it once. ;-)
 228           }
 229           ++counter;
 230         }
 231         assert (argPos != -1
 232                 && "Argument not found in current function's argument list");
 233         // Load it out of the stack frame at EBP + 4*argPos.
 234         addRegOffset(BMI(MBB, IPt, X86::MOVmr32, 4, Reg), X86::EBP, 4*argPos);
 235       }
 236
 237       return Reg;
 238     }
 239   };
 240 }
 241
 242 /// TypeClass - Used by the X86 backend to group LLVM types by their basic X86
 243 /// Representation.
 244 ///
 245 enum TypeClass {
 246   cByte, cShort, cInt, cLong, cFloat, cDouble
 247 };
 248
 249 /// getClass - Turn a primitive type into a "class" number which is based on the
 250 /// size of the type, and whether or not it is floating point.
 251 ///
 252 static inline TypeClass getClass(const Type *Ty) {
 253   switch (Ty->getPrimitiveID()) {
 254   case Type::SByteTyID:
 255   case Type::UByteTyID:   return cByte;      // Byte operands are class #0
 256   case Type::ShortTyID:
 257   case Type::UShortTyID:  return cShort;     // Short operands are class #1
 258   case Type::IntTyID:
 259   case Type::UIntTyID:
 260   case Type::PointerTyID: return cInt;       // Int's and pointers are class #2
 261
 262   case Type::LongTyID:
 263   case Type::ULongTyID:   //return cLong;      // Longs are class #3
 264     return cInt;          // FIXME: LONGS ARE TREATED AS INTS!
 265
 266   case Type::FloatTyID:   return cFloat;     // Float is class #4
 267   case Type::DoubleTyID:  return cDouble;    // Doubles are class #5
 268   default:
 269     assert(0 && "Invalid type to getClass!");
 270     return cByte;  // not reached
 271   }
 272 }
 273
 274
 275 /// copyConstantToRegister - Output the instructions required to put the
 276 /// specified constant into the specified register.
 277 ///
 278 void ISel::copyConstantToRegister(Constant *C, unsigned R,
 279                                   MachineBasicBlock *MBB,
 280                                   MachineBasicBlock::iterator &IP) {
 281   if (ConstantExpr *CE = dyn_cast<ConstantExpr>(C)) {
 282     if (CE->getOpcode() == Instruction::GetElementPtr) {
 283       emitGEPOperation(BB, IP, CE->getOperand(0),
 284                        CE->op_begin()+1, CE->op_end(), R);
 285       return;
 286     }
 287
 288     std::cerr << "Offending expr: " << C << "\n";
 289     assert (0 && "Constant expressions not yet handled!\n");
 290   }
 291
 292   if (C->getType()->isIntegral()) {
 293     unsigned Class = getClass(C->getType());
 294     assert(Class != 3 && "Type not handled yet!");
 295
 296     static const unsigned IntegralOpcodeTab[] = {
 297       X86::MOVir8, X86::MOVir16, X86::MOVir32
 298     };
 299
 300     if (C->getType()->isSigned()) {
 301       ConstantSInt *CSI = cast<ConstantSInt>(C);
 302       BMI(MBB, IP, IntegralOpcodeTab[Class], 1, R).addSImm(CSI->getValue());
 303     } else {
 304       ConstantUInt *CUI = cast<ConstantUInt>(C);
 305       BMI(MBB, IP, IntegralOpcodeTab[Class], 1, R).addZImm(CUI->getValue());
 306     }
 307   } else if (isa<ConstantPointerNull>(C)) {
 308     // Copy zero (null pointer) to the register.
 309     BMI(MBB, IP, X86::MOVir32, 1, R).addZImm(0);
 310   } else if (ConstantPointerRef *CPR = dyn_cast<ConstantPointerRef>(C)) {
 311     unsigned SrcReg = getReg(CPR->getValue(), BB, IP);
 312     BMI(MBB, IP, X86::MOVrr32, 1, R).addReg(SrcReg);
 313   } else {
 314     std::cerr << "Offending constant: " << C << "\n";
 315     assert(0 && "Type not handled yet!");
 316   }
 317 }
 318
 319 /// SelectPHINodes - Insert machine code to generate phis.  This is tricky
 320 /// because we have to generate our sources into the source basic blocks, not
 321 /// the current one.
 322 ///
 323 void ISel::SelectPHINodes() {
 324   const Function &LF = *F->getFunction();  // The LLVM function...
 325   for (Function::const_iterator I = LF.begin(), E = LF.end(); I != E; ++I) {
 326     const BasicBlock *BB = I;
 327     MachineBasicBlock *MBB = MBBMap[I];
 328
 329     // Loop over all of the PHI nodes in the LLVM basic block...
 330     unsigned NumPHIs = 0;
 331     for (BasicBlock::const_iterator I = BB->begin();
 332          PHINode *PN = (PHINode*)dyn_cast<PHINode>(&*I); ++I) {
 333       // Create a new machine instr PHI node, and insert it.
 334       MachineInstr *MI = BuildMI(X86::PHI, PN->getNumOperands(), getReg(*PN));
 335       MBB->insert(MBB->begin()+NumPHIs++, MI); // Insert it at the top of the BB
 336
 337       for (unsigned i = 0, e = PN->getNumIncomingValues(); i != e; ++i) {
 338         MachineBasicBlock *PredMBB = MBBMap[PN->getIncomingBlock(i)];
 339
 340         // Get the incoming value into a virtual register.  If it is not already
 341         // available in a virtual register, insert the computation code into
 342         // PredMBB
 343         //
 344
 345         MachineBasicBlock::iterator PI = PredMBB->begin();
 346         while ((*PI)->getOpcode() == X86::PHI) ++PI;
 347
 348         MI->addRegOperand(getReg(PN->getIncomingValue(i), PredMBB, PI));
 349
 350         // FIXME: Pass in the MachineBasicBlocks instead of the basic blocks...
 351         MI->addPCDispOperand(PN->getIncomingBlock(i));  // PredMBB
 352       }
 353     }
 354   }
 355 }
 356
 357
 358
 359 /// SetCC instructions - Here we just emit boilerplate code to set a byte-sized
 360 /// register, then move it to wherever the result should be.
 361 /// We handle FP setcc instructions by pushing them, doing a
 362 /// compare-and-pop-twice, and then copying the concodes to the main
 363 /// processor's concodes (I didn't make this up, it's in the Intel manual)
 364 ///
 365 void ISel::visitSetCCInst(SetCondInst &I, unsigned OpNum) {
 366   // The arguments are already supposed to be of the same type.
 367   const Type *CompTy = I.getOperand(0)->getType();
 368   unsigned reg1 = getReg(I.getOperand(0));
 369   unsigned reg2 = getReg(I.getOperand(1));
 370
 371   unsigned Class = getClass(CompTy);
 372   switch (Class) {
 373     // Emit: cmp <var1>, <var2> (do the comparison).  We can
 374     // compare 8-bit with 8-bit, 16-bit with 16-bit, 32-bit with
 375     // 32-bit.
 376   case cByte:
 377     BuildMI (BB, X86::CMPrr8, 2).addReg (reg1).addReg (reg2);
 378     break;
 379   case cShort:
 380     BuildMI (BB, X86::CMPrr16, 2).addReg (reg1).addReg (reg2);
 381     break;
 382   case cInt:
 383     BuildMI (BB, X86::CMPrr32, 2).addReg (reg1).addReg (reg2);
 384     break;
 385
 386     // Push the variables on the stack with fldl opcodes.
 387     // FIXME: assuming var1, var2 are in memory, if not, spill to
 388     // stack first
 389   case cFloat:  // Floats
 390     BuildMI (BB, X86::FLDr32, 1).addReg (reg1);
 391     BuildMI (BB, X86::FLDr32, 1).addReg (reg2);
 392     break;
 393   case cDouble:  // Doubles
 394     BuildMI (BB, X86::FLDr64, 1).addReg (reg1);
 395     BuildMI (BB, X86::FLDr64, 1).addReg (reg2);
 396     break;
 397   case cLong:
 398   default:
 399     visitInstruction(I);
 400   }
 401
 402   if (CompTy->isFloatingPoint()) {
 403     // (Non-trapping) compare and pop twice.
 404     BuildMI (BB, X86::FUCOMPP, 0);
 405     // Move fp status word (concodes) to ax.
 406     BuildMI (BB, X86::FNSTSWr8, 1, X86::AX);
 407     // Load real concodes from ax.
 408     BuildMI (BB, X86::SAHF, 1).addReg(X86::AH);
 409   }
 410
 411   // Emit setOp instruction (extract concode; clobbers ax),
 412   // using the following mapping:
 413   // LLVM  -> X86 signed  X86 unsigned
 414   // -----    -----       -----
 415   // seteq -> sete        sete
 416   // setne -> setne       setne
 417   // setlt -> setl        setb
 418   // setgt -> setg        seta
 419   // setle -> setle       setbe
 420   // setge -> setge       setae
 421
 422   static const unsigned OpcodeTab[2][6] = {
 423     {X86::SETEr, X86::SETNEr, X86::SETBr, X86::SETAr, X86::SETBEr, X86::SETAEr},
 424     {X86::SETEr, X86::SETNEr, X86::SETLr, X86::SETGr, X86::SETLEr, X86::SETGEr},
 425   };
 426
 427   BuildMI(BB, OpcodeTab[CompTy->isSigned()][OpNum], 0, X86::AL);
 428
 429   // Put it in the result using a move.
 430   BuildMI (BB, X86::MOVrr8, 1, getReg(I)).addReg(X86::AL);
 431 }
 432
 433 /// promote32 - Emit instructions to turn a narrow operand into a 32-bit-wide
 434 /// operand, in the specified target register.
 435 void
 436 ISel::promote32 (unsigned targetReg, Value *v)
 437 {
 438   unsigned vReg = getReg (v);
 439   unsigned Class = getClass (v->getType ());
 440   bool isUnsigned = v->getType ()->isUnsigned ();
 441   assert (((Class == cByte) || (Class == cShort) || (Class == cInt))
 442           && "Unpromotable operand class in promote32");
 443   switch (Class)
 444     {
 445     case cByte:
 446       // Extend value into target register (8->32)
 447       if (isUnsigned)
 448         BuildMI (BB, X86::MOVZXr32r8, 1, targetReg).addReg (vReg);
 449       else
 450         BuildMI (BB, X86::MOVSXr32r8, 1, targetReg).addReg (vReg);
 451       break;
 452     case cShort:
 453       // Extend value into target register (16->32)
 454       if (isUnsigned)
 455         BuildMI (BB, X86::MOVZXr32r16, 1, targetReg).addReg (vReg);
 456       else
 457         BuildMI (BB, X86::MOVSXr32r16, 1, targetReg).addReg (vReg);
 458       break;
 459     case cInt:
 460       // Move value into target register (32->32)
 461       BuildMI (BB, X86::MOVrr32, 1, targetReg).addReg (vReg);
 462       break;
 463     }
 464 }
 465
 466 /// 'ret' instruction - Here we are interested in meeting the x86 ABI.  As such,
 467 /// we have the following possibilities:
 468 ///
 469 ///   ret void: No return value, simply emit a 'ret' instruction
 470 ///   ret sbyte, ubyte : Extend value into EAX and return
 471 ///   ret short, ushort: Extend value into EAX and return
 472 ///   ret int, uint    : Move value into EAX and return
 473 ///   ret pointer      : Move value into EAX and return
 474 ///   ret long, ulong  : Move value into EAX/EDX and return
 475 ///   ret float/double : Top of FP stack
 476 ///
 477 void
 478 ISel::visitReturnInst (ReturnInst &I)
 479 {
 480   if (I.getNumOperands () == 0)
 481     {
 482       // Emit a 'ret' instruction
 483       BuildMI (BB, X86::RET, 0);
 484       return;
 485     }
 486   Value *rv = I.getOperand (0);
 487   unsigned Class = getClass (rv->getType ());
 488   switch (Class)
 489     {
 490       // integral return values: extend or move into EAX and return.
 491     case cByte:
 492     case cShort:
 493     case cInt:
 494       promote32 (X86::EAX, rv);
 495       break;
 496       // ret float/double: top of FP stack
 497       // FLD <val>
 498     case cFloat:                // Floats
 499       BuildMI (BB, X86::FLDr32, 1).addReg (getReg (rv));
 500       break;
 501     case cDouble:               // Doubles
 502       BuildMI (BB, X86::FLDr64, 1).addReg (getReg (rv));
 503       break;
 504     case cLong:
 505       // ret long: use EAX(least significant 32 bits)/EDX (most
 506       // significant 32)...uh, I think so Brain, but how do i call
 507       // up the two parts of the value from inside this mouse
 508       // cage? *zort*
 509     default:
 510       visitInstruction (I);
 511     }
 512   // Emit a 'ret' instruction
 513   BuildMI (BB, X86::RET, 0);
 514 }
 515
 516 /// visitBranchInst - Handle conditional and unconditional branches here.  Note
 517 /// that since code layout is frozen at this point, that if we are trying to
 518 /// jump to a block that is the immediate successor of the current block, we can
 519 /// just make a fall-through. (but we don't currently).
 520 ///
 521 void
 522 ISel::visitBranchInst (BranchInst & BI)
 523 {
 524   if (BI.isConditional ())
 525     {
 526       BasicBlock *ifTrue = BI.getSuccessor (0);
 527       BasicBlock *ifFalse = BI.getSuccessor (1); // this is really unobvious
 528
 529       // simplest thing I can think of: compare condition with zero,
 530       // followed by jump-if-equal to ifFalse, and jump-if-nonequal to
 531       // ifTrue
 532       unsigned int condReg = getReg (BI.getCondition ());
 533       BuildMI (BB, X86::CMPri8, 2).addReg (condReg).addZImm (0);
 534       BuildMI (BB, X86::JNE, 1).addPCDisp (BI.getSuccessor (0));
 535       BuildMI (BB, X86::JE, 1).addPCDisp (BI.getSuccessor (1));
 536     }
 537   else // unconditional branch
 538     {
 539       BuildMI (BB, X86::JMP, 1).addPCDisp (BI.getSuccessor (0));
 540     }
 541 }
 542
 543 /// visitCallInst - Push args on stack and do a procedure call instruction.
 544 void
 545 ISel::visitCallInst (CallInst & CI)
 546 {
 547   // keep a counter of how many bytes we pushed on the stack
 548   unsigned bytesPushed = 0;
 549
 550   // Push the arguments on the stack in reverse order, as specified by
 551   // the ABI.
 552   for (unsigned i = CI.getNumOperands()-1; i >= 1; --i)
 553     {
 554       Value *v = CI.getOperand (i);
 555       switch (getClass (v->getType ()))
 556         {
 557         case cByte:
 558         case cShort:
 559           // Promote V to 32 bits wide, and move the result into EAX,
 560           // then push EAX.
 561           promote32 (X86::EAX, v);
 562           BuildMI (BB, X86::PUSHr32, 1).addReg (X86::EAX);
 563           bytesPushed += 4;
 564           break;
 565         case cInt:
 566         case cFloat: {
 567           unsigned Reg = getReg(v);
 568           BuildMI (BB, X86::PUSHr32, 1).addReg(Reg);
 569           bytesPushed += 4;
 570           break;
 571         }
 572         default:
 573           // FIXME: long/ulong/double args not handled.
 574           visitInstruction (CI);
 575           break;
 576         }
 577     }
 578   // Emit a CALL instruction with PC-relative displacement.
 579   BuildMI (BB, X86::CALLpcrel32, 1).addPCDisp (CI.getCalledValue ());
 580
 581   // Adjust the stack by `bytesPushed' amount if non-zero
 582   if (bytesPushed > 0)
 583     BuildMI (BB, X86::ADDri32, 2).addReg(X86::ESP).addZImm(bytesPushed);
 584
 585   // If there is a return value, scavenge the result from the location the call
 586   // leaves it in...
 587   //
 588   if (CI.getType() != Type::VoidTy) {
 589     unsigned resultTypeClass = getClass (CI.getType ());
 590     switch (resultTypeClass) {
 591     case cByte:
 592     case cShort:
 593     case cInt: {
 594       // Integral results are in %eax, or the appropriate portion
 595       // thereof.
 596       static const unsigned regRegMove[] = {
 597         X86::MOVrr8, X86::MOVrr16, X86::MOVrr32
 598       };
 599       static const unsigned AReg[] = { X86::AL, X86::AX, X86::EAX };
 600       BuildMI (BB, regRegMove[resultTypeClass], 1,
 601                getReg (CI)).addReg (AReg[resultTypeClass]);
 602       break;
 603     }
 604     case cFloat:
 605       // Floating-point return values live in %st(0) (i.e., the top of
 606       // the FP stack.) The general way to approach this is to do a
 607       // FSTP to save the top of the FP stack on the real stack, then
 608       // do a MOV to load the top of the real stack into the target
 609       // register.
 610       visitInstruction (CI); // FIXME: add the right args for the calls below
 611       // BuildMI (BB, X86::FSTPm32, 0);
 612       // BuildMI (BB, X86::MOVmr32, 0);
 613       break;
 614     default:
 615       std::cerr << "Cannot get return value for call of type '"
 616                 << *CI.getType() << "'\n";
 617       visitInstruction(CI);
 618     }
 619   }
 620 }
 621
 622 /// visitSimpleBinary - Implement simple binary operators for integral types...
 623 /// OperatorClass is one of: 0 for Add, 1 for Sub, 2 for And, 3 for Or,
 624 /// 4 for Xor.
 625 ///
 626 void ISel::visitSimpleBinary(BinaryOperator &B, unsigned OperatorClass) {
 627   if (B.getType() == Type::BoolTy)  // FIXME: Handle bools for logicals
 628     visitInstruction(B);
 629
 630   unsigned Class = getClass(B.getType());
 631   if (Class > 2)  // FIXME: Handle longs
 632     visitInstruction(B);
 633
 634   static const unsigned OpcodeTab[][4] = {
 635     // Arithmetic operators
 636     { X86::ADDrr8, X86::ADDrr16, X86::ADDrr32, 0 },  // ADD
 637     { X86::SUBrr8, X86::SUBrr16, X86::SUBrr32, 0 },  // SUB
 638
 639     // Bitwise operators
 640     { X86::ANDrr8, X86::ANDrr16, X86::ANDrr32, 0 },  // AND
 641     { X86:: ORrr8, X86:: ORrr16, X86:: ORrr32, 0 },  // OR
 642     { X86::XORrr8, X86::XORrr16, X86::XORrr32, 0 },  // XOR
 643   };
 644
 645   unsigned Opcode = OpcodeTab[OperatorClass][Class];
 646   unsigned Op0r = getReg(B.getOperand(0));
 647   unsigned Op1r = getReg(B.getOperand(1));
 648   BuildMI(BB, Opcode, 2, getReg(B)).addReg(Op0r).addReg(Op1r);
 649 }
 650
 651 /// doMultiply - Emit appropriate instructions to multiply together
 652 /// the registers op0Reg and op1Reg, and put the result in destReg.
 653 /// The type of the result should be given as resultType.
 654 void
 655 ISel::doMultiply(unsigned destReg, const Type *resultType,
 656                  unsigned op0Reg, unsigned op1Reg,
 657                  MachineBasicBlock *MBB, MachineBasicBlock::iterator &MBBI)
 658 {
 659   unsigned Class = getClass (resultType);
 660
 661   // FIXME:
 662   assert (Class <= 2 && "Someday, we will learn how to multiply"
 663           "longs and floating-point numbers. This is not that day.");
 664
 665   static const unsigned Regs[]     ={ X86::AL    , X86::AX     , X86::EAX     };
 666   static const unsigned MulOpcode[]={ X86::MULrr8, X86::MULrr16, X86::MULrr32 };
 667   static const unsigned MovOpcode[]={ X86::MOVrr8, X86::MOVrr16, X86::MOVrr32 };
 668   unsigned Reg     = Regs[Class];
 669
 670   // Emit a MOV to put the first operand into the appropriately-sized
 671   // subreg of EAX.
 672   BMI(MBB, MBBI, MovOpcode[Class], 1, Reg).addReg (op0Reg);
 673
 674   // Emit the appropriate multiply instruction.
 675   BMI(MBB, MBBI, MulOpcode[Class], 1).addReg (op1Reg);
 676
 677   // Emit another MOV to put the result into the destination register.
 678   BMI(MBB, MBBI, MovOpcode[Class], 1, destReg).addReg (Reg);
 679 }
 680
 681 /// visitMul - Multiplies are not simple binary operators because they must deal
 682 /// with the EAX register explicitly.
 683 ///
 684 void ISel::visitMul(BinaryOperator &I) {
 685   MachineBasicBlock::iterator MBBI = BB->end();
 686   doMultiply (getReg (I), I.getType (),
 687               getReg (I.getOperand (0)), getReg (I.getOperand (1)),
 688               BB, MBBI);
 689 }
 690
 691
 692 /// visitDivRem - Handle division and remainder instructions... these
 693 /// instruction both require the same instructions to be generated, they just
 694 /// select the result from a different register.  Note that both of these
 695 /// instructions work differently for signed and unsigned operands.
 696 ///
 697 void ISel::visitDivRem(BinaryOperator &I) {
 698   unsigned Class = getClass(I.getType());
 699   if (Class > 2)  // FIXME: Handle longs
 700     visitInstruction(I);
 701
 702   static const unsigned Regs[]     ={ X86::AL    , X86::AX     , X86::EAX     };
 703   static const unsigned MovOpcode[]={ X86::MOVrr8, X86::MOVrr16, X86::MOVrr32 };
 704   static const unsigned ExtOpcode[]={ X86::CBW   , X86::CWD    , X86::CDQ     };
 705   static const unsigned ClrOpcode[]={ X86::XORrr8, X86::XORrr16, X86::XORrr32 };
 706   static const unsigned ExtRegs[]  ={ X86::AH    , X86::DX     , X86::EDX     };
 707
 708   static const unsigned DivOpcode[][4] = {
 709     { X86::DIVrr8 , X86::DIVrr16 , X86::DIVrr32 , 0 },  // Unsigned division
 710     { X86::IDIVrr8, X86::IDIVrr16, X86::IDIVrr32, 0 },  // Signed division
 711   };
 712
 713   bool isSigned   = I.getType()->isSigned();
 714   unsigned Reg    = Regs[Class];
 715   unsigned ExtReg = ExtRegs[Class];
 716   unsigned Op0Reg = getReg(I.getOperand(0));
 717   unsigned Op1Reg = getReg(I.getOperand(1));
 718
 719   // Put the first operand into one of the A registers...
 720   BuildMI(BB, MovOpcode[Class], 1, Reg).addReg(Op0Reg);
 721
 722   if (isSigned) {
 723     // Emit a sign extension instruction...
 724     BuildMI(BB, ExtOpcode[Class], 0);
 725   } else {
 726     // If unsigned, emit a zeroing instruction... (reg = xor reg, reg)
 727     BuildMI(BB, ClrOpcode[Class], 2, ExtReg).addReg(ExtReg).addReg(ExtReg);
 728   }
 729
 730   // Emit the appropriate divide or remainder instruction...
 731   BuildMI(BB, DivOpcode[isSigned][Class], 1).addReg(Op1Reg);
 732
 733   // Figure out which register we want to pick the result out of...
 734   unsigned DestReg = (I.getOpcode() == Instruction::Div) ? Reg : ExtReg;
 735
 736   // Put the result into the destination register...
 737   BuildMI(BB, MovOpcode[Class], 1, getReg(I)).addReg(DestReg);
 738 }
 739
 740
 741 /// Shift instructions: 'shl', 'sar', 'shr' - Some special cases here
 742 /// for constant immediate shift values, and for constant immediate
 743 /// shift values equal to 1. Even the general case is sort of special,
 744 /// because the shift amount has to be in CL, not just any old register.
 745 ///
 746 void ISel::visitShiftInst (ShiftInst &I) {
 747   unsigned Op0r = getReg (I.getOperand(0));
 748   unsigned DestReg = getReg(I);
 749   bool isLeftShift = I.getOpcode() == Instruction::Shl;
 750   bool isOperandSigned = I.getType()->isUnsigned();
 751   unsigned OperandClass = getClass(I.getType());
 752
 753   if (OperandClass > 2)
 754     visitInstruction(I); // Can't handle longs yet!
 755
 756   if (ConstantUInt *CUI = dyn_cast <ConstantUInt> (I.getOperand (1)))
 757     {
 758       // The shift amount is constant, guaranteed to be a ubyte. Get its value.
 759       assert(CUI->getType() == Type::UByteTy && "Shift amount not a ubyte?");
 760       unsigned char shAmt = CUI->getValue();
 761
 762       static const unsigned ConstantOperand[][4] = {
 763         { X86::SHRir8, X86::SHRir16, X86::SHRir32, 0 },  // SHR
 764         { X86::SARir8, X86::SARir16, X86::SARir32, 0 },  // SAR
 765         { X86::SHLir8, X86::SHLir16, X86::SHLir32, 0 },  // SHL
 766         { X86::SHLir8, X86::SHLir16, X86::SHLir32, 0 },  // SAL = SHL
 767       };
 768
 769       const unsigned *OpTab = // Figure out the operand table to use
 770         ConstantOperand[isLeftShift*2+isOperandSigned];
 771
 772       // Emit: <insn> reg, shamt  (shift-by-immediate opcode "ir" form.)
 773       BuildMI(BB, OpTab[OperandClass], 2, DestReg).addReg(Op0r).addZImm(shAmt);
 774     }
 775   else
 776     {
 777       // The shift amount is non-constant.
 778       //
 779       // In fact, you can only shift with a variable shift amount if
 780       // that amount is already in the CL register, so we have to put it
 781       // there first.
 782       //
 783
 784       // Emit: move cl, shiftAmount (put the shift amount in CL.)
 785       BuildMI(BB, X86::MOVrr8, 1, X86::CL).addReg(getReg(I.getOperand(1)));
 786
 787       // This is a shift right (SHR).
 788       static const unsigned NonConstantOperand[][4] = {
 789         { X86::SHRrr8, X86::SHRrr16, X86::SHRrr32, 0 },  // SHR
 790         { X86::SARrr8, X86::SARrr16, X86::SARrr32, 0 },  // SAR
 791         { X86::SHLrr8, X86::SHLrr16, X86::SHLrr32, 0 },  // SHL
 792         { X86::SHLrr8, X86::SHLrr16, X86::SHLrr32, 0 },  // SAL = SHL
 793       };
 794
 795       const unsigned *OpTab = // Figure out the operand table to use
 796         NonConstantOperand[isLeftShift*2+isOperandSigned];
 797
 798       BuildMI(BB, OpTab[OperandClass], 1, DestReg).addReg(Op0r);
 799     }
 800 }
 801
 802
 803 /// visitLoadInst - Implement LLVM load instructions in terms of the x86 'mov'
 804 /// instruction.
 805 ///
 806 void ISel::visitLoadInst(LoadInst &I) {
 807   unsigned Class = getClass(I.getType());
 808   if (Class > 2)  // FIXME: Handle longs and others...
 809     visitInstruction(I);
 810
 811   static const unsigned Opcode[] = { X86::MOVmr8, X86::MOVmr16, X86::MOVmr32 };
 812
 813   unsigned AddressReg = getReg(I.getOperand(0));
 814   addDirectMem(BuildMI(BB, Opcode[Class], 4, getReg(I)), AddressReg);
 815 }
 816
 817
 818 /// visitStoreInst - Implement LLVM store instructions in terms of the x86 'mov'
 819 /// instruction.
 820 ///
 821 void ISel::visitStoreInst(StoreInst &I) {
 822   unsigned Class = getClass(I.getOperand(0)->getType());
 823   if (Class > 2)  // FIXME: Handle longs and others...
 824     visitInstruction(I);
 825
 826   static const unsigned Opcode[] = { X86::MOVrm8, X86::MOVrm16, X86::MOVrm32 };
 827
 828   unsigned ValReg = getReg(I.getOperand(0));
 829   unsigned AddressReg = getReg(I.getOperand(1));
 830   addDirectMem(BuildMI(BB, Opcode[Class], 1+4), AddressReg).addReg(ValReg);
 831 }
 832
 833
 834 /// visitCastInst - Here we have various kinds of copying with or without
 835 /// sign extension going on.
 836 void
 837 ISel::visitCastInst (CastInst &CI)
 838 {
 839   const Type *targetType = CI.getType ();
 840   Value *operand = CI.getOperand (0);
 841   unsigned int operandReg = getReg (operand);
 842   const Type *sourceType = operand->getType ();
 843   unsigned int destReg = getReg (CI);
 844   //
 845   // Currently we handle:
 846   //
 847   // 1) cast * to bool
 848   //
 849   // 2) cast {sbyte, ubyte} to {sbyte, ubyte}
 850   //    cast {short, ushort} to {ushort, short}
 851   //    cast {int, uint, ptr} to {int, uint, ptr}
 852   //
 853   // 3) cast {sbyte, ubyte} to {ushort, short}
 854   //    cast {sbyte, ubyte} to {int, uint, ptr}
 855   //    cast {short, ushort} to {int, uint, ptr}
 856   //
 857   // 4) cast {int, uint, ptr} to {short, ushort}
 858   //    cast {int, uint, ptr} to {sbyte, ubyte}
 859   //    cast {short, ushort} to {sbyte, ubyte}
 860
 861   // 1) Implement casts to bool by using compare on the operand followed
 862   // by set if not zero on the result.
 863   if (targetType == Type::BoolTy)
 864     {
 865       BuildMI (BB, X86::CMPri8, 2).addReg (operandReg).addZImm (0);
 866       BuildMI (BB, X86::SETNEr, 1, destReg);
 867       return;
 868     }
 869
 870   // 2) Implement casts between values of the same type class (as determined
 871   // by getClass) by using a register-to-register move.
 872   unsigned srcClass = sourceType == Type::BoolTy ? cByte : getClass(sourceType);
 873   unsigned targClass = getClass (targetType);
 874   static const unsigned regRegMove[] = {
 875     X86::MOVrr8, X86::MOVrr16, X86::MOVrr32
 876   };
 877   if ((srcClass < 3) && (targClass < 3) && (srcClass == targClass))
 878     {
 879       BuildMI (BB, regRegMove[srcClass], 1, destReg).addReg (operandReg);
 880       return;
 881     }
 882   // 3) Handle cast of SMALLER int to LARGER int using a move with sign
 883   // extension or zero extension, depending on whether the source type
 884   // was signed.
 885   if ((srcClass < 3) && (targClass < 3) && (srcClass < targClass))
 886     {
 887       static const unsigned ops[] = {
 888         X86::MOVSXr16r8, X86::MOVSXr32r8, X86::MOVSXr32r16,
 889         X86::MOVZXr16r8, X86::MOVZXr32r8, X86::MOVZXr32r16
 890       };
 891       unsigned srcSigned = sourceType->isSigned ();
 892       BuildMI (BB, ops[3 * srcSigned + srcClass + targClass - 1], 1,
 893                destReg).addReg (operandReg);
 894       return;
 895     }
 896   // 4) Handle cast of LARGER int to SMALLER int using a move to EAX
 897   // followed by a move out of AX or AL.
 898   if ((srcClass < 3) && (targClass < 3) && (srcClass > targClass))
 899     {
 900       static const unsigned AReg[] = { X86::AL, X86::AX, X86::EAX };
 901       BuildMI (BB, regRegMove[srcClass], 1,
 902                AReg[srcClass]).addReg (operandReg);
 903       BuildMI (BB, regRegMove[targClass], 1, destReg).addReg (AReg[srcClass]);
 904       return;
 905     }
 906   // Anything we haven't handled already, we can't (yet) handle at all.
 907   //
 908   // FP to integral casts can be handled with FISTP to store onto the
 909   // stack while converting to integer, followed by a MOV to load from
 910   // the stack into the result register. Integral to FP casts can be
 911   // handled with MOV to store onto the stack, followed by a FILD to
 912   // load from the stack while converting to FP. For the moment, I
 913   // can't quite get straight in my head how to borrow myself some
 914   // stack space and write on it. Otherwise, this would be trivial.
 915   visitInstruction (CI);
 916 }
 917
 918 /// visitGetElementPtrInst - I don't know, most programs don't have
 919 /// getelementptr instructions, right? That means we can put off
 920 /// implementing this, right? Right. This method emits machine
 921 /// instructions to perform type-safe pointer arithmetic. I am
 922 /// guessing this could be cleaned up somewhat to use fewer temporary
 923 /// registers.
 924 void
 925 ISel::visitGetElementPtrInst (GetElementPtrInst &I)
 926 {
 927   MachineBasicBlock::iterator MI = BB->end();
 928   emitGEPOperation(BB, MI, I.getOperand(0),
 929                    I.op_begin()+1, I.op_end(), getReg(I));
 930 }
 931
 932 void ISel::emitGEPOperation(MachineBasicBlock *MBB,
 933                             MachineBasicBlock::iterator &IP,
 934                             Value *Src, User::op_iterator IdxBegin,
 935                             User::op_iterator IdxEnd, unsigned TargetReg) {
 936   const TargetData &TD = TM.getTargetData();
 937   const Type *Ty = Src->getType();
 938   unsigned basePtrReg = getReg(Src, BB, IP);
 939
 940   // GEPs have zero or more indices; we must perform a struct access
 941   // or array access for each one.
 942   for (GetElementPtrInst::op_iterator oi = IdxBegin,
 943          oe = IdxEnd; oi != oe; ++oi) {
 944     Value *idx = *oi;
 945     unsigned nextBasePtrReg = makeAnotherReg(Type::UIntTy);
 946     if (const StructType *StTy = dyn_cast <StructType> (Ty)) {
 947       // It's a struct access.  idx is the index into the structure,
 948       // which names the field. This index must have ubyte type.
 949       const ConstantUInt *CUI = cast <ConstantUInt> (idx);
 950       assert (CUI->getType () == Type::UByteTy
 951               && "Funny-looking structure index in GEP");
 952       // Use the TargetData structure to pick out what the layout of
 953       // the structure is in memory.  Since the structure index must
 954       // be constant, we can get its value and use it to find the
 955       // right byte offset from the StructLayout class's list of
 956       // structure member offsets.
 957       unsigned idxValue = CUI->getValue ();
 958       unsigned memberOffset =
 959         TD.getStructLayout (StTy)->MemberOffsets[idxValue];
 960       // Emit an ADD to add memberOffset to the basePtr.
 961       BMI(MBB, IP, X86::ADDri32, 2,
 962           nextBasePtrReg).addReg (basePtrReg).addZImm (memberOffset);
 963       // The next type is the member of the structure selected by the
 964       // index.
 965       Ty = StTy->getElementTypes ()[idxValue];
 966     } else if (const SequentialType *SqTy = cast <SequentialType> (Ty)) {
 967       // It's an array or pointer access: [ArraySize x ElementType].
 968       const Type *typeOfSequentialTypeIndex = SqTy->getIndexType ();
 969       // idx is the index into the array.  Unlike with structure
 970       // indices, we may not know its actual value at code-generation
 971       // time.
 972       assert (idx->getType () == typeOfSequentialTypeIndex
 973               && "Funny-looking array index in GEP");
 974       // We want to add basePtrReg to (idxReg * sizeof
 975       // ElementType). First, we must find the size of the pointed-to
 976       // type.  (Not coincidentally, the next type is the type of the
 977       // elements in the array.)
 978       Ty = SqTy->getElementType ();
 979       unsigned elementSize = TD.getTypeSize (Ty);
 980       unsigned elementSizeReg = makeAnotherReg(typeOfSequentialTypeIndex);
 981       copyConstantToRegister(ConstantSInt::get(typeOfSequentialTypeIndex,
 982                                               elementSize), elementSizeReg,
 983                              BB, IP);
 984
 985       unsigned idxReg = getReg(idx, BB, IP);
 986       // Emit a MUL to multiply the register holding the index by
 987       // elementSize, putting the result in memberOffsetReg.
 988       unsigned memberOffsetReg = makeAnotherReg(Type::UIntTy);
 989       doMultiply (memberOffsetReg, typeOfSequentialTypeIndex,
 990                   elementSizeReg, idxReg, BB, IP);
 991       // Emit an ADD to add memberOffsetReg to the basePtr.
 992       BMI(MBB, IP, X86::ADDrr32, 2,
 993           nextBasePtrReg).addReg (basePtrReg).addReg (memberOffsetReg);
 994     }
 995     // Now that we are here, further indices refer to subtypes of this
 996     // one, so we don't need to worry about basePtrReg itself, anymore.
 997     basePtrReg = nextBasePtrReg;
 998   }
 999   // After we have processed all the indices, the result is left in
1000   // basePtrReg.  Move it to the register where we were expected to
1001   // put the answer.  A 32-bit move should do it, because we are in
1002   // ILP32 land.
1003   BMI(MBB, IP, X86::MOVrr32, 1, TargetReg).addReg (basePtrReg);
1004 }
1005
1006
1007 /// visitMallocInst - I know that personally, whenever I want to remember
1008 /// something, I have to clear off some space in my brain.
1009 void
1010 ISel::visitMallocInst (MallocInst &I)
1011 {
1012   // We assume that by this point, malloc instructions have been
1013   // lowered to calls, and dlsym will magically find malloc for us.
1014   // So we do not want to see malloc instructions here.
1015   visitInstruction (I);
1016 }
1017
1018
1019 /// visitFreeInst - same story as MallocInst
1020 void
1021 ISel::visitFreeInst (FreeInst &I)
1022 {
1023   // We assume that by this point, free instructions have been
1024   // lowered to calls, and dlsym will magically find free for us.
1025   // So we do not want to see free instructions here.
1026   visitInstruction (I);
1027 }
1028
1029
1030 /// visitAllocaInst - I want some stack space. Come on, man, I said I
1031 /// want some freakin' stack space.
1032 void
1033 ISel::visitAllocaInst (AllocaInst &I)
1034 {
1035   // Find the data size of the alloca inst's getAllocatedType.
1036   const Type *allocatedType = I.getAllocatedType ();
1037   const TargetData &TD = TM.DataLayout;
1038   unsigned allocatedTypeSize = TD.getTypeSize (allocatedType);
1039   // Keep stack 32-bit aligned.
1040   unsigned int allocatedTypeWords = allocatedTypeSize / 4;
1041   if (allocatedTypeSize % 4 != 0) { allocatedTypeWords++; }
1042   // Subtract size from stack pointer, thereby allocating some space.
1043   BuildMI (BB, X86::SUBri32, 1, X86::ESP).addZImm (allocatedTypeWords * 4);
1044   // Put a pointer to the space into the result register, by copying
1045   // the stack pointer.
1046   BuildMI (BB, X86::MOVrr32, 1, getReg (I)).addReg (X86::ESP);
1047 }
1048
1049
1050 /// createSimpleX86InstructionSelector - This pass converts an LLVM function
1051 /// into a machine code representation is a very simple peep-hole fashion.  The
1052 /// generated code sucks but the implementation is nice and simple.
1053 ///
1054 Pass *createSimpleX86InstructionSelector(TargetMachine &TM) {
1055   return new ISel(TM);
1056 }