lib/Target/X86/X86FrameLowering.cpp

   1 //=======- X86FrameLowering.cpp - X86 Frame Information ------------*- C++ -*-====//
   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 // This file contains the X86 implementation of TargetFrameLowering class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "X86FrameLowering.h"
  15 #include "X86InstrBuilder.h"
  16 #include "X86InstrInfo.h"
  17 #include "X86MachineFunctionInfo.h"
  18 #include "X86TargetMachine.h"
  19 #include "llvm/Function.h"
  20 #include "llvm/CodeGen/MachineFrameInfo.h"
  21 #include "llvm/CodeGen/MachineFunction.h"
  22 #include "llvm/CodeGen/MachineInstrBuilder.h"
  23 #include "llvm/CodeGen/MachineModuleInfo.h"
  24 #include "llvm/CodeGen/MachineRegisterInfo.h"
  25 #include "llvm/Target/TargetData.h"
  26 #include "llvm/Target/TargetOptions.h"
  27 #include "llvm/Support/CommandLine.h"
  28 #include "llvm/ADT/SmallSet.h"
  29
  30 using namespace llvm;
  31
  32 // FIXME: completely move here.
  33 extern cl::opt<bool> ForceStackAlign;
  34
  35 bool X86FrameLowering::hasReservedCallFrame(const MachineFunction &MF) const {
  36   return !MF.getFrameInfo()->hasVarSizedObjects();
  37 }
  38
  39 /// hasFP - Return true if the specified function should have a dedicated frame
  40 /// pointer register.  This is true if the function has variable sized allocas
  41 /// or if frame pointer elimination is disabled.
  42 bool X86FrameLowering::hasFP(const MachineFunction &MF) const {
  43   const MachineFrameInfo *MFI = MF.getFrameInfo();
  44   const MachineModuleInfo &MMI = MF.getMMI();
  45   const TargetRegisterInfo *RI = TM.getRegisterInfo();
  46
  47   return (DisableFramePointerElim(MF) ||
  48           RI->needsStackRealignment(MF) ||
  49           MFI->hasVarSizedObjects() ||
  50           MFI->isFrameAddressTaken() ||
  51           MF.getInfo<X86MachineFunctionInfo>()->getForceFramePointer() ||
  52           MMI.callsUnwindInit());
  53 }
  54
  55 static unsigned getSUBriOpcode(unsigned is64Bit, int64_t Imm) {
  56   if (is64Bit) {
  57     if (isInt<8>(Imm))
  58       return X86::SUB64ri8;
  59     return X86::SUB64ri32;
  60   } else {
  61     if (isInt<8>(Imm))
  62       return X86::SUB32ri8;
  63     return X86::SUB32ri;
  64   }
  65 }
  66
  67 static unsigned getADDriOpcode(unsigned is64Bit, int64_t Imm) {
  68   if (is64Bit) {
  69     if (isInt<8>(Imm))
  70       return X86::ADD64ri8;
  71     return X86::ADD64ri32;
  72   } else {
  73     if (isInt<8>(Imm))
  74       return X86::ADD32ri8;
  75     return X86::ADD32ri;
  76   }
  77 }
  78
  79 /// findDeadCallerSavedReg - Return a caller-saved register that isn't live
  80 /// when it reaches the "return" instruction. We can then pop a stack object
  81 /// to this register without worry about clobbering it.
  82 static unsigned findDeadCallerSavedReg(MachineBasicBlock &MBB,
  83                                        MachineBasicBlock::iterator &MBBI,
  84                                        const TargetRegisterInfo &TRI,
  85                                        bool Is64Bit) {
  86   const MachineFunction *MF = MBB.getParent();
  87   const Function *F = MF->getFunction();
  88   if (!F || MF->getMMI().callsEHReturn())
  89     return 0;
  90
  91   static const unsigned CallerSavedRegs32Bit[] = {
  92     X86::EAX, X86::EDX, X86::ECX
  93   };
  94
  95   static const unsigned CallerSavedRegs64Bit[] = {
  96     X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,
  97     X86::R8,  X86::R9,  X86::R10, X86::R11
  98   };
  99
 100   unsigned Opc = MBBI->getOpcode();
 101   switch (Opc) {
 102   default: return 0;
 103   case X86::RET:
 104   case X86::RETI:
 105   case X86::TCRETURNdi:
 106   case X86::TCRETURNri:
 107   case X86::TCRETURNmi:
 108   case X86::TCRETURNdi64:
 109   case X86::TCRETURNri64:
 110   case X86::TCRETURNmi64:
 111   case X86::EH_RETURN:
 112   case X86::EH_RETURN64: {
 113     SmallSet<unsigned, 8> Uses;
 114     for (unsigned i = 0, e = MBBI->getNumOperands(); i != e; ++i) {
 115       MachineOperand &MO = MBBI->getOperand(i);
 116       if (!MO.isReg() || MO.isDef())
 117         continue;
 118       unsigned Reg = MO.getReg();
 119       if (!Reg)
 120         continue;
 121       for (const unsigned *AsI = TRI.getOverlaps(Reg); *AsI; ++AsI)
 122         Uses.insert(*AsI);
 123     }
 124
 125     const unsigned *CS = Is64Bit ? CallerSavedRegs64Bit : CallerSavedRegs32Bit;
 126     for (; *CS; ++CS)
 127       if (!Uses.count(*CS))
 128         return *CS;
 129   }
 130   }
 131
 132   return 0;
 133 }
 134
 135
 136 /// emitSPUpdate - Emit a series of instructions to increment / decrement the
 137 /// stack pointer by a constant value.
 138 static
 139 void emitSPUpdate(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
 140                   unsigned StackPtr, int64_t NumBytes,
 141                   bool Is64Bit, const TargetInstrInfo &TII,
 142                   const TargetRegisterInfo &TRI) {
 143   bool isSub = NumBytes < 0;
 144   uint64_t Offset = isSub ? -NumBytes : NumBytes;
 145   unsigned Opc = isSub ?
 146     getSUBriOpcode(Is64Bit, Offset) :
 147     getADDriOpcode(Is64Bit, Offset);
 148   uint64_t Chunk = (1LL << 31) - 1;
 149   DebugLoc DL = MBB.findDebugLoc(MBBI);
 150
 151   while (Offset) {
 152     uint64_t ThisVal = (Offset > Chunk) ? Chunk : Offset;
 153     if (ThisVal == (Is64Bit ? 8 : 4)) {
 154       // Use push / pop instead.
 155       unsigned Reg = isSub
 156         ? (unsigned)(Is64Bit ? X86::RAX : X86::EAX)
 157         : findDeadCallerSavedReg(MBB, MBBI, TRI, Is64Bit);
 158       if (Reg) {
 159         Opc = isSub
 160           ? (Is64Bit ? X86::PUSH64r : X86::PUSH32r)
 161           : (Is64Bit ? X86::POP64r  : X86::POP32r);
 162         BuildMI(MBB, MBBI, DL, TII.get(Opc))
 163           .addReg(Reg, getDefRegState(!isSub) | getUndefRegState(isSub));
 164         Offset -= ThisVal;
 165         continue;
 166       }
 167     }
 168
 169     MachineInstr *MI =
 170       BuildMI(MBB, MBBI, DL, TII.get(Opc), StackPtr)
 171       .addReg(StackPtr)
 172       .addImm(ThisVal);
 173     MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
 174     Offset -= ThisVal;
 175   }
 176 }
 177
 178 /// mergeSPUpdatesUp - Merge two stack-manipulating instructions upper iterator.
 179 static
 180 void mergeSPUpdatesUp(MachineBasicBlock &MBB, MachineBasicBlock::iterator &MBBI,
 181                       unsigned StackPtr, uint64_t *NumBytes = NULL) {
 182   if (MBBI == MBB.begin()) return;
 183
 184   MachineBasicBlock::iterator PI = prior(MBBI);
 185   unsigned Opc = PI->getOpcode();
 186   if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
 187        Opc == X86::ADD32ri || Opc == X86::ADD32ri8) &&
 188       PI->getOperand(0).getReg() == StackPtr) {
 189     if (NumBytes)
 190       *NumBytes += PI->getOperand(2).getImm();
 191     MBB.erase(PI);
 192   } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
 193               Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
 194              PI->getOperand(0).getReg() == StackPtr) {
 195     if (NumBytes)
 196       *NumBytes -= PI->getOperand(2).getImm();
 197     MBB.erase(PI);
 198   }
 199 }
 200
 201 /// mergeSPUpdatesDown - Merge two stack-manipulating instructions lower iterator.
 202 static
 203 void mergeSPUpdatesDown(MachineBasicBlock &MBB,
 204                         MachineBasicBlock::iterator &MBBI,
 205                         unsigned StackPtr, uint64_t *NumBytes = NULL) {
 206   // FIXME: THIS ISN'T RUN!!!
 207   return;
 208
 209   if (MBBI == MBB.end()) return;
 210
 211   MachineBasicBlock::iterator NI = llvm::next(MBBI);
 212   if (NI == MBB.end()) return;
 213
 214   unsigned Opc = NI->getOpcode();
 215   if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
 216        Opc == X86::ADD32ri || Opc == X86::ADD32ri8) &&
 217       NI->getOperand(0).getReg() == StackPtr) {
 218     if (NumBytes)
 219       *NumBytes -= NI->getOperand(2).getImm();
 220     MBB.erase(NI);
 221     MBBI = NI;
 222   } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
 223               Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
 224              NI->getOperand(0).getReg() == StackPtr) {
 225     if (NumBytes)
 226       *NumBytes += NI->getOperand(2).getImm();
 227     MBB.erase(NI);
 228     MBBI = NI;
 229   }
 230 }
 231
 232 /// mergeSPUpdates - Checks the instruction before/after the passed
 233 /// instruction. If it is an ADD/SUB instruction it is deleted argument and the
 234 /// stack adjustment is returned as a positive value for ADD and a negative for
 235 /// SUB.
 236 static int mergeSPUpdates(MachineBasicBlock &MBB,
 237                            MachineBasicBlock::iterator &MBBI,
 238                            unsigned StackPtr,
 239                            bool doMergeWithPrevious) {
 240   if ((doMergeWithPrevious && MBBI == MBB.begin()) ||
 241       (!doMergeWithPrevious && MBBI == MBB.end()))
 242     return 0;
 243
 244   MachineBasicBlock::iterator PI = doMergeWithPrevious ? prior(MBBI) : MBBI;
 245   MachineBasicBlock::iterator NI = doMergeWithPrevious ? 0 : llvm::next(MBBI);
 246   unsigned Opc = PI->getOpcode();
 247   int Offset = 0;
 248
 249   if ((Opc == X86::ADD64ri32 || Opc == X86::ADD64ri8 ||
 250        Opc == X86::ADD32ri || Opc == X86::ADD32ri8) &&
 251       PI->getOperand(0).getReg() == StackPtr){
 252     Offset += PI->getOperand(2).getImm();
 253     MBB.erase(PI);
 254     if (!doMergeWithPrevious) MBBI = NI;
 255   } else if ((Opc == X86::SUB64ri32 || Opc == X86::SUB64ri8 ||
 256               Opc == X86::SUB32ri || Opc == X86::SUB32ri8) &&
 257              PI->getOperand(0).getReg() == StackPtr) {
 258     Offset -= PI->getOperand(2).getImm();
 259     MBB.erase(PI);
 260     if (!doMergeWithPrevious) MBBI = NI;
 261   }
 262
 263   return Offset;
 264 }
 265
 266 static bool isEAXLiveIn(MachineFunction &MF) {
 267   for (MachineRegisterInfo::livein_iterator II = MF.getRegInfo().livein_begin(),
 268        EE = MF.getRegInfo().livein_end(); II != EE; ++II) {
 269     unsigned Reg = II->first;
 270
 271     if (Reg == X86::EAX || Reg == X86::AX ||
 272         Reg == X86::AH || Reg == X86::AL)
 273       return true;
 274   }
 275
 276   return false;
 277 }
 278
 279 void X86FrameLowering::emitCalleeSavedFrameMoves(MachineFunction &MF,
 280                                              MCSymbol *Label,
 281                                              unsigned FramePtr) const {
 282   MachineFrameInfo *MFI = MF.getFrameInfo();
 283   MachineModuleInfo &MMI = MF.getMMI();
 284
 285   // Add callee saved registers to move list.
 286   const std::vector<CalleeSavedInfo> &CSI = MFI->getCalleeSavedInfo();
 287   if (CSI.empty()) return;
 288
 289   std::vector<MachineMove> &Moves = MMI.getFrameMoves();
 290   const TargetData *TD = TM.getTargetData();
 291   bool HasFP = hasFP(MF);
 292
 293   // Calculate amount of bytes used for return address storing.
 294   int stackGrowth = -TD->getPointerSize();
 295
 296   // FIXME: This is dirty hack. The code itself is pretty mess right now.
 297   // It should be rewritten from scratch and generalized sometimes.
 298
 299   // Determine maximum offset (minumum due to stack growth).
 300   int64_t MaxOffset = 0;
 301   for (std::vector<CalleeSavedInfo>::const_iterator
 302          I = CSI.begin(), E = CSI.end(); I != E; ++I)
 303     MaxOffset = std::min(MaxOffset,
 304                          MFI->getObjectOffset(I->getFrameIdx()));
 305
 306   // Calculate offsets.
 307   int64_t saveAreaOffset = (HasFP ? 3 : 2) * stackGrowth;
 308   for (std::vector<CalleeSavedInfo>::const_iterator
 309          I = CSI.begin(), E = CSI.end(); I != E; ++I) {
 310     int64_t Offset = MFI->getObjectOffset(I->getFrameIdx());
 311     unsigned Reg = I->getReg();
 312     Offset = MaxOffset - Offset + saveAreaOffset;
 313
 314     // Don't output a new machine move if we're re-saving the frame
 315     // pointer. This happens when the PrologEpilogInserter has inserted an extra
 316     // "PUSH" of the frame pointer -- the "emitPrologue" method automatically
 317     // generates one when frame pointers are used. If we generate a "machine
 318     // move" for this extra "PUSH", the linker will lose track of the fact that
 319     // the frame pointer should have the value of the first "PUSH" when it's
 320     // trying to unwind.
 321     //
 322     // FIXME: This looks inelegant. It's possibly correct, but it's covering up
 323     //        another bug. I.e., one where we generate a prolog like this:
 324     //
 325     //          pushl  %ebp
 326     //          movl   %esp, %ebp
 327     //          pushl  %ebp
 328     //          pushl  %esi
 329     //           ...
 330     //
 331     //        The immediate re-push of EBP is unnecessary. At the least, it's an
 332     //        optimization bug. EBP can be used as a scratch register in certain
 333     //        cases, but probably not when we have a frame pointer.
 334     if (HasFP && FramePtr == Reg)
 335       continue;
 336
 337     MachineLocation CSDst(MachineLocation::VirtualFP, Offset);
 338     MachineLocation CSSrc(Reg);
 339     Moves.push_back(MachineMove(Label, CSDst, CSSrc));
 340   }
 341 }
 342
 343 /// emitPrologue - Push callee-saved registers onto the stack, which
 344 /// automatically adjust the stack pointer. Adjust the stack pointer to allocate
 345 /// space for local variables. Also emit labels used by the exception handler to
 346 /// generate the exception handling frames.
 347 void X86FrameLowering::emitPrologue(MachineFunction &MF) const {
 348   MachineBasicBlock &MBB = MF.front(); // Prologue goes in entry BB.
 349   MachineBasicBlock::iterator MBBI = MBB.begin();
 350   MachineFrameInfo *MFI = MF.getFrameInfo();
 351   const Function *Fn = MF.getFunction();
 352   const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
 353   const X86InstrInfo &TII = *TM.getInstrInfo();
 354   MachineModuleInfo &MMI = MF.getMMI();
 355   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 356   bool needsFrameMoves = MMI.hasDebugInfo() ||
 357                           !Fn->doesNotThrow() || UnwindTablesMandatory;
 358   uint64_t MaxAlign  = MFI->getMaxAlignment(); // Desired stack alignment.
 359   uint64_t StackSize = MFI->getStackSize();    // Number of bytes to allocate.
 360   bool HasFP = hasFP(MF);
 361   bool Is64Bit = STI.is64Bit();
 362   bool IsWin64 = STI.isTargetWin64();
 363   unsigned StackAlign = getStackAlignment();
 364   unsigned SlotSize = RegInfo->getSlotSize();
 365   unsigned FramePtr = RegInfo->getFrameRegister(MF);
 366   unsigned StackPtr = RegInfo->getStackRegister();
 367
 368   DebugLoc DL;
 369
 370   // If we're forcing a stack realignment we can't rely on just the frame
 371   // info, we need to know the ABI stack alignment as well in case we
 372   // have a call out.  Otherwise just make sure we have some alignment - we'll
 373   // go with the minimum SlotSize.
 374   if (ForceStackAlign) {
 375     if (MFI->hasCalls())
 376       MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
 377     else if (MaxAlign < SlotSize)
 378       MaxAlign = SlotSize;
 379   }
 380
 381   // Add RETADDR move area to callee saved frame size.
 382   int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
 383   if (TailCallReturnAddrDelta < 0)
 384     X86FI->setCalleeSavedFrameSize(
 385       X86FI->getCalleeSavedFrameSize() - TailCallReturnAddrDelta);
 386
 387   // If this is x86-64 and the Red Zone is not disabled, if we are a leaf
 388   // function, and use up to 128 bytes of stack space, don't have a frame
 389   // pointer, calls, or dynamic alloca then we do not need to adjust the
 390   // stack pointer (we fit in the Red Zone).
 391   if (Is64Bit && !Fn->hasFnAttr(Attribute::NoRedZone) &&
 392       !RegInfo->needsStackRealignment(MF) &&
 393       !MFI->hasVarSizedObjects() &&                // No dynamic alloca.
 394       !MFI->adjustsStack() &&                      // No calls.
 395       !IsWin64) {                                  // Win64 has no Red Zone
 396     uint64_t MinSize = X86FI->getCalleeSavedFrameSize();
 397     if (HasFP) MinSize += SlotSize;
 398     StackSize = std::max(MinSize, StackSize > 128 ? StackSize - 128 : 0);
 399     MFI->setStackSize(StackSize);
 400   }
 401
 402   // Insert stack pointer adjustment for later moving of return addr.  Only
 403   // applies to tail call optimized functions where the callee argument stack
 404   // size is bigger than the callers.
 405   if (TailCallReturnAddrDelta < 0) {
 406     MachineInstr *MI =
 407       BuildMI(MBB, MBBI, DL,
 408               TII.get(getSUBriOpcode(Is64Bit, -TailCallReturnAddrDelta)),
 409               StackPtr)
 410         .addReg(StackPtr)
 411         .addImm(-TailCallReturnAddrDelta);
 412     MI->getOperand(3).setIsDead(); // The EFLAGS implicit def is dead.
 413   }
 414
 415   // Mapping for machine moves:
 416   //
 417   //   DST: VirtualFP AND
 418   //        SRC: VirtualFP              => DW_CFA_def_cfa_offset
 419   //        ELSE                        => DW_CFA_def_cfa
 420   //
 421   //   SRC: VirtualFP AND
 422   //        DST: Register               => DW_CFA_def_cfa_register
 423   //
 424   //   ELSE
 425   //        OFFSET < 0                  => DW_CFA_offset_extended_sf
 426   //        REG < 64                    => DW_CFA_offset + Reg
 427   //        ELSE                        => DW_CFA_offset_extended
 428
 429   std::vector<MachineMove> &Moves = MMI.getFrameMoves();
 430   const TargetData *TD = MF.getTarget().getTargetData();
 431   uint64_t NumBytes = 0;
 432   int stackGrowth = -TD->getPointerSize();
 433
 434   if (HasFP) {
 435     // Calculate required stack adjustment.
 436     uint64_t FrameSize = StackSize - SlotSize;
 437     if (RegInfo->needsStackRealignment(MF))
 438       FrameSize = (FrameSize + MaxAlign - 1) / MaxAlign * MaxAlign;
 439
 440     NumBytes = FrameSize - X86FI->getCalleeSavedFrameSize();
 441
 442     // Get the offset of the stack slot for the EBP register, which is
 443     // guaranteed to be the last slot by processFunctionBeforeFrameFinalized.
 444     // Update the frame offset adjustment.
 445     MFI->setOffsetAdjustment(-NumBytes);
 446
 447     // Save EBP/RBP into the appropriate stack slot.
 448     BuildMI(MBB, MBBI, DL, TII.get(Is64Bit ? X86::PUSH64r : X86::PUSH32r))
 449       .addReg(FramePtr, RegState::Kill);
 450
 451     if (needsFrameMoves) {
 452       // Mark the place where EBP/RBP was saved.
 453       MCSymbol *FrameLabel = MMI.getContext().CreateTempSymbol();
 454       BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL)).addSym(FrameLabel);
 455
 456       // Define the current CFA rule to use the provided offset.
 457       if (StackSize) {
 458         MachineLocation SPDst(MachineLocation::VirtualFP);
 459         MachineLocation SPSrc(MachineLocation::VirtualFP, 2 * stackGrowth);
 460         Moves.push_back(MachineMove(FrameLabel, SPDst, SPSrc));
 461       } else {
 462         MachineLocation SPDst(StackPtr);
 463         MachineLocation SPSrc(StackPtr, stackGrowth);
 464         Moves.push_back(MachineMove(FrameLabel, SPDst, SPSrc));
 465       }
 466
 467       // Change the rule for the FramePtr to be an "offset" rule.
 468       MachineLocation FPDst(MachineLocation::VirtualFP, 2 * stackGrowth);
 469       MachineLocation FPSrc(FramePtr);
 470       Moves.push_back(MachineMove(FrameLabel, FPDst, FPSrc));
 471     }
 472
 473     // Update EBP with the new base value...
 474     BuildMI(MBB, MBBI, DL,
 475             TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr), FramePtr)
 476         .addReg(StackPtr);
 477
 478     if (needsFrameMoves) {
 479       // Mark effective beginning of when frame pointer becomes valid.
 480       MCSymbol *FrameLabel = MMI.getContext().CreateTempSymbol();
 481       BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL)).addSym(FrameLabel);
 482
 483       // Define the current CFA to use the EBP/RBP register.
 484       MachineLocation FPDst(FramePtr);
 485       MachineLocation FPSrc(MachineLocation::VirtualFP);
 486       Moves.push_back(MachineMove(FrameLabel, FPDst, FPSrc));
 487     }
 488
 489     // Mark the FramePtr as live-in in every block except the entry.
 490     for (MachineFunction::iterator I = llvm::next(MF.begin()), E = MF.end();
 491          I != E; ++I)
 492       I->addLiveIn(FramePtr);
 493
 494     // Realign stack
 495     if (RegInfo->needsStackRealignment(MF)) {
 496       MachineInstr *MI =
 497         BuildMI(MBB, MBBI, DL,
 498                 TII.get(Is64Bit ? X86::AND64ri32 : X86::AND32ri),
 499                 StackPtr).addReg(StackPtr).addImm(-MaxAlign);
 500
 501       // The EFLAGS implicit def is dead.
 502       MI->getOperand(3).setIsDead();
 503     }
 504   } else {
 505     NumBytes = StackSize - X86FI->getCalleeSavedFrameSize();
 506   }
 507
 508   // Skip the callee-saved push instructions.
 509   bool PushedRegs = false;
 510   int StackOffset = 2 * stackGrowth;
 511
 512   while (MBBI != MBB.end() &&
 513          (MBBI->getOpcode() == X86::PUSH32r ||
 514           MBBI->getOpcode() == X86::PUSH64r)) {
 515     PushedRegs = true;
 516     ++MBBI;
 517
 518     if (!HasFP && needsFrameMoves) {
 519       // Mark callee-saved push instruction.
 520       MCSymbol *Label = MMI.getContext().CreateTempSymbol();
 521       BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL)).addSym(Label);
 522
 523       // Define the current CFA rule to use the provided offset.
 524       unsigned Ptr = StackSize ?
 525         MachineLocation::VirtualFP : StackPtr;
 526       MachineLocation SPDst(Ptr);
 527       MachineLocation SPSrc(Ptr, StackOffset);
 528       Moves.push_back(MachineMove(Label, SPDst, SPSrc));
 529       StackOffset += stackGrowth;
 530     }
 531   }
 532
 533   DL = MBB.findDebugLoc(MBBI);
 534
 535   // If there is an SUB32ri of ESP immediately before this instruction, merge
 536   // the two. This can be the case when tail call elimination is enabled and
 537   // the callee has more arguments then the caller.
 538   NumBytes -= mergeSPUpdates(MBB, MBBI, StackPtr, true);
 539
 540   // If there is an ADD32ri or SUB32ri of ESP immediately after this
 541   // instruction, merge the two instructions.
 542   mergeSPUpdatesDown(MBB, MBBI, StackPtr, &NumBytes);
 543
 544   // Adjust stack pointer: ESP -= numbytes.
 545
 546   // Windows and cygwin/mingw require a prologue helper routine when allocating
 547   // more than 4K bytes on the stack.  Windows uses __chkstk and cygwin/mingw
 548   // uses __alloca.  __alloca and the 32-bit version of __chkstk will probe the
 549   // stack and adjust the stack pointer in one go.  The 64-bit version of
 550   // __chkstk is only responsible for probing the stack.  The 64-bit prologue is
 551   // responsible for adjusting the stack pointer.  Touching the stack at 4K
 552   // increments is necessary to ensure that the guard pages used by the OS
 553   // virtual memory manager are allocated in correct sequence.
 554   if (NumBytes >= 4096 &&
 555       (STI.isTargetCygMing() || STI.isTargetWin32()) &&
 556       !STI.isTargetEnvMacho()) {
 557     // Check whether EAX is livein for this function.
 558     bool isEAXAlive = isEAXLiveIn(MF);
 559
 560     const char *StackProbeSymbol =
 561       STI.isTargetWindows() ? "_chkstk" : "_alloca";
 562     if (Is64Bit && STI.isTargetCygMing())
 563       StackProbeSymbol = "__chkstk";
 564     unsigned CallOp = Is64Bit ? X86::CALL64pcrel32 : X86::CALLpcrel32;
 565     if (!isEAXAlive) {
 566       BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
 567         .addImm(NumBytes);
 568       BuildMI(MBB, MBBI, DL, TII.get(CallOp))
 569         .addExternalSymbol(StackProbeSymbol)
 570         .addReg(StackPtr,    RegState::Define | RegState::Implicit)
 571         .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit);
 572     } else {
 573       // Save EAX
 574       BuildMI(MBB, MBBI, DL, TII.get(X86::PUSH32r))
 575         .addReg(X86::EAX, RegState::Kill);
 576
 577       // Allocate NumBytes-4 bytes on stack. We'll also use 4 already
 578       // allocated bytes for EAX.
 579       BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
 580         .addImm(NumBytes - 4);
 581       BuildMI(MBB, MBBI, DL, TII.get(CallOp))
 582         .addExternalSymbol(StackProbeSymbol)
 583         .addReg(StackPtr,    RegState::Define | RegState::Implicit)
 584         .addReg(X86::EFLAGS, RegState::Define | RegState::Implicit);
 585
 586       // Restore EAX
 587       MachineInstr *MI = addRegOffset(BuildMI(MF, DL, TII.get(X86::MOV32rm),
 588                                               X86::EAX),
 589                                       StackPtr, false, NumBytes - 4);
 590       MBB.insert(MBBI, MI);
 591     }
 592   } else if (NumBytes >= 4096 &&
 593              STI.isTargetWin64() &&
 594              !STI.isTargetEnvMacho()) {
 595     // Sanity check that EAX is not livein for this function.  It should
 596     // not be, so throw an assert.
 597     assert(!isEAXLiveIn(MF) && "EAX is livein in the Win64 case!");
 598
 599     // Handle the 64-bit Windows ABI case where we need to call __chkstk.
 600     // Function prologue is responsible for adjusting the stack pointer.
 601     BuildMI(MBB, MBBI, DL, TII.get(X86::MOV32ri), X86::EAX)
 602       .addImm(NumBytes);
 603     BuildMI(MBB, MBBI, DL, TII.get(X86::WINCALL64pcrel32))
 604       .addExternalSymbol("__chkstk")
 605       .addReg(StackPtr, RegState::Define | RegState::Implicit);
 606     emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit,
 607                  TII, *RegInfo);
 608   } else if (NumBytes)
 609     emitSPUpdate(MBB, MBBI, StackPtr, -(int64_t)NumBytes, Is64Bit,
 610                  TII, *RegInfo);
 611
 612   if ((NumBytes || PushedRegs) && needsFrameMoves) {
 613     // Mark end of stack pointer adjustment.
 614     MCSymbol *Label = MMI.getContext().CreateTempSymbol();
 615     BuildMI(MBB, MBBI, DL, TII.get(X86::PROLOG_LABEL)).addSym(Label);
 616
 617     if (!HasFP && NumBytes) {
 618       // Define the current CFA rule to use the provided offset.
 619       if (StackSize) {
 620         MachineLocation SPDst(MachineLocation::VirtualFP);
 621         MachineLocation SPSrc(MachineLocation::VirtualFP,
 622                               -StackSize + stackGrowth);
 623         Moves.push_back(MachineMove(Label, SPDst, SPSrc));
 624       } else {
 625         MachineLocation SPDst(StackPtr);
 626         MachineLocation SPSrc(StackPtr, stackGrowth);
 627         Moves.push_back(MachineMove(Label, SPDst, SPSrc));
 628       }
 629     }
 630
 631     // Emit DWARF info specifying the offsets of the callee-saved registers.
 632     if (PushedRegs)
 633       emitCalleeSavedFrameMoves(MF, Label, HasFP ? FramePtr : StackPtr);
 634   }
 635 }
 636
 637 void X86FrameLowering::emitEpilogue(MachineFunction &MF,
 638                                 MachineBasicBlock &MBB) const {
 639   const MachineFrameInfo *MFI = MF.getFrameInfo();
 640   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 641   const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
 642   const X86InstrInfo &TII = *TM.getInstrInfo();
 643   MachineBasicBlock::iterator MBBI = MBB.getLastNonDebugInstr();
 644   assert(MBBI != MBB.end() && "Returning block has no instructions");
 645   unsigned RetOpcode = MBBI->getOpcode();
 646   DebugLoc DL = MBBI->getDebugLoc();
 647   bool Is64Bit = STI.is64Bit();
 648   unsigned StackAlign = getStackAlignment();
 649   unsigned SlotSize = RegInfo->getSlotSize();
 650   unsigned FramePtr = RegInfo->getFrameRegister(MF);
 651   unsigned StackPtr = RegInfo->getStackRegister();
 652
 653   switch (RetOpcode) {
 654   default:
 655     llvm_unreachable("Can only insert epilog into returning blocks");
 656   case X86::RET:
 657   case X86::RETI:
 658   case X86::TCRETURNdi:
 659   case X86::TCRETURNri:
 660   case X86::TCRETURNmi:
 661   case X86::TCRETURNdi64:
 662   case X86::TCRETURNri64:
 663   case X86::TCRETURNmi64:
 664   case X86::EH_RETURN:
 665   case X86::EH_RETURN64:
 666     break;  // These are ok
 667   }
 668
 669   // Get the number of bytes to allocate from the FrameInfo.
 670   uint64_t StackSize = MFI->getStackSize();
 671   uint64_t MaxAlign  = MFI->getMaxAlignment();
 672   unsigned CSSize = X86FI->getCalleeSavedFrameSize();
 673   uint64_t NumBytes = 0;
 674
 675   // If we're forcing a stack realignment we can't rely on just the frame
 676   // info, we need to know the ABI stack alignment as well in case we
 677   // have a call out.  Otherwise just make sure we have some alignment - we'll
 678   // go with the minimum.
 679   if (ForceStackAlign) {
 680     if (MFI->hasCalls())
 681       MaxAlign = (StackAlign > MaxAlign) ? StackAlign : MaxAlign;
 682     else
 683       MaxAlign = MaxAlign ? MaxAlign : 4;
 684   }
 685
 686   if (hasFP(MF)) {
 687     // Calculate required stack adjustment.
 688     uint64_t FrameSize = StackSize - SlotSize;
 689     if (RegInfo->needsStackRealignment(MF))
 690       FrameSize = (FrameSize + MaxAlign - 1)/MaxAlign*MaxAlign;
 691
 692     NumBytes = FrameSize - CSSize;
 693
 694     // Pop EBP.
 695     BuildMI(MBB, MBBI, DL,
 696             TII.get(Is64Bit ? X86::POP64r : X86::POP32r), FramePtr);
 697   } else {
 698     NumBytes = StackSize - CSSize;
 699   }
 700
 701   // Skip the callee-saved pop instructions.
 702   MachineBasicBlock::iterator LastCSPop = MBBI;
 703   while (MBBI != MBB.begin()) {
 704     MachineBasicBlock::iterator PI = prior(MBBI);
 705     unsigned Opc = PI->getOpcode();
 706
 707     if (Opc != X86::POP32r && Opc != X86::POP64r && Opc != X86::DBG_VALUE &&
 708         !PI->getDesc().isTerminator())
 709       break;
 710
 711     --MBBI;
 712   }
 713
 714   DL = MBBI->getDebugLoc();
 715
 716   // If there is an ADD32ri or SUB32ri of ESP immediately before this
 717   // instruction, merge the two instructions.
 718   if (NumBytes || MFI->hasVarSizedObjects())
 719     mergeSPUpdatesUp(MBB, MBBI, StackPtr, &NumBytes);
 720
 721   // If dynamic alloca is used, then reset esp to point to the last callee-saved
 722   // slot before popping them off! Same applies for the case, when stack was
 723   // realigned.
 724   if (RegInfo->needsStackRealignment(MF)) {
 725     // We cannot use LEA here, because stack pointer was realigned. We need to
 726     // deallocate local frame back.
 727     if (CSSize) {
 728       emitSPUpdate(MBB, MBBI, StackPtr, NumBytes, Is64Bit, TII, *RegInfo);
 729       MBBI = prior(LastCSPop);
 730     }
 731
 732     BuildMI(MBB, MBBI, DL,
 733             TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr),
 734             StackPtr).addReg(FramePtr);
 735   } else if (MFI->hasVarSizedObjects()) {
 736     if (CSSize) {
 737       unsigned Opc = Is64Bit ? X86::LEA64r : X86::LEA32r;
 738       MachineInstr *MI =
 739         addRegOffset(BuildMI(MF, DL, TII.get(Opc), StackPtr),
 740                      FramePtr, false, -CSSize);
 741       MBB.insert(MBBI, MI);
 742     } else {
 743       BuildMI(MBB, MBBI, DL,
 744               TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr), StackPtr)
 745         .addReg(FramePtr);
 746     }
 747   } else if (NumBytes) {
 748     // Adjust stack pointer back: ESP += numbytes.
 749     emitSPUpdate(MBB, MBBI, StackPtr, NumBytes, Is64Bit, TII, *RegInfo);
 750   }
 751
 752   // We're returning from function via eh_return.
 753   if (RetOpcode == X86::EH_RETURN || RetOpcode == X86::EH_RETURN64) {
 754     MBBI = MBB.getLastNonDebugInstr();
 755     MachineOperand &DestAddr  = MBBI->getOperand(0);
 756     assert(DestAddr.isReg() && "Offset should be in register!");
 757     BuildMI(MBB, MBBI, DL,
 758             TII.get(Is64Bit ? X86::MOV64rr : X86::MOV32rr),
 759             StackPtr).addReg(DestAddr.getReg());
 760   } else if (RetOpcode == X86::TCRETURNri || RetOpcode == X86::TCRETURNdi ||
 761              RetOpcode == X86::TCRETURNmi ||
 762              RetOpcode == X86::TCRETURNri64 || RetOpcode == X86::TCRETURNdi64 ||
 763              RetOpcode == X86::TCRETURNmi64) {
 764     bool isMem = RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64;
 765     // Tail call return: adjust the stack pointer and jump to callee.
 766     MBBI = MBB.getLastNonDebugInstr();
 767     MachineOperand &JumpTarget = MBBI->getOperand(0);
 768     MachineOperand &StackAdjust = MBBI->getOperand(isMem ? 5 : 1);
 769     assert(StackAdjust.isImm() && "Expecting immediate value.");
 770
 771     // Adjust stack pointer.
 772     int StackAdj = StackAdjust.getImm();
 773     int MaxTCDelta = X86FI->getTCReturnAddrDelta();
 774     int Offset = 0;
 775     assert(MaxTCDelta <= 0 && "MaxTCDelta should never be positive");
 776
 777     // Incoporate the retaddr area.
 778     Offset = StackAdj-MaxTCDelta;
 779     assert(Offset >= 0 && "Offset should never be negative");
 780
 781     if (Offset) {
 782       // Check for possible merge with preceeding ADD instruction.
 783       Offset += mergeSPUpdates(MBB, MBBI, StackPtr, true);
 784       emitSPUpdate(MBB, MBBI, StackPtr, Offset, Is64Bit, TII, *RegInfo);
 785     }
 786
 787     // Jump to label or value in register.
 788     if (RetOpcode == X86::TCRETURNdi || RetOpcode == X86::TCRETURNdi64) {
 789       MachineInstrBuilder MIB =
 790         BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNdi)
 791                                        ? X86::TAILJMPd : X86::TAILJMPd64));
 792       if (JumpTarget.isGlobal())
 793         MIB.addGlobalAddress(JumpTarget.getGlobal(), JumpTarget.getOffset(),
 794                              JumpTarget.getTargetFlags());
 795       else {
 796         assert(JumpTarget.isSymbol());
 797         MIB.addExternalSymbol(JumpTarget.getSymbolName(),
 798                               JumpTarget.getTargetFlags());
 799       }
 800     } else if (RetOpcode == X86::TCRETURNmi || RetOpcode == X86::TCRETURNmi64) {
 801       MachineInstrBuilder MIB =
 802         BuildMI(MBB, MBBI, DL, TII.get((RetOpcode == X86::TCRETURNmi)
 803                                        ? X86::TAILJMPm : X86::TAILJMPm64));
 804       for (unsigned i = 0; i != 5; ++i)
 805         MIB.addOperand(MBBI->getOperand(i));
 806     } else if (RetOpcode == X86::TCRETURNri64) {
 807       BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr64)).
 808         addReg(JumpTarget.getReg(), RegState::Kill);
 809     } else {
 810       BuildMI(MBB, MBBI, DL, TII.get(X86::TAILJMPr)).
 811         addReg(JumpTarget.getReg(), RegState::Kill);
 812     }
 813
 814     MachineInstr *NewMI = prior(MBBI);
 815     for (unsigned i = 2, e = MBBI->getNumOperands(); i != e; ++i)
 816       NewMI->addOperand(MBBI->getOperand(i));
 817
 818     // Delete the pseudo instruction TCRETURN.
 819     MBB.erase(MBBI);
 820   } else if ((RetOpcode == X86::RET || RetOpcode == X86::RETI) &&
 821              (X86FI->getTCReturnAddrDelta() < 0)) {
 822     // Add the return addr area delta back since we are not tail calling.
 823     int delta = -1*X86FI->getTCReturnAddrDelta();
 824     MBBI = MBB.getLastNonDebugInstr();
 825
 826     // Check for possible merge with preceeding ADD instruction.
 827     delta += mergeSPUpdates(MBB, MBBI, StackPtr, true);
 828     emitSPUpdate(MBB, MBBI, StackPtr, delta, Is64Bit, TII, *RegInfo);
 829   }
 830 }
 831
 832 void
 833 X86FrameLowering::getInitialFrameState(std::vector<MachineMove> &Moves) const {
 834   // Calculate amount of bytes used for return address storing
 835   int stackGrowth = (STI.is64Bit() ? -8 : -4);
 836   const X86RegisterInfo *RI = TM.getRegisterInfo();
 837
 838   // Initial state of the frame pointer is esp+stackGrowth.
 839   MachineLocation Dst(MachineLocation::VirtualFP);
 840   MachineLocation Src(RI->getStackRegister(), stackGrowth);
 841   Moves.push_back(MachineMove(0, Dst, Src));
 842
 843   // Add return address to move list
 844   MachineLocation CSDst(RI->getStackRegister(), stackGrowth);
 845   MachineLocation CSSrc(RI->getRARegister());
 846   Moves.push_back(MachineMove(0, CSDst, CSSrc));
 847 }
 848
 849 int X86FrameLowering::getFrameIndexOffset(const MachineFunction &MF, int FI) const {
 850   const X86RegisterInfo *RI =
 851     static_cast<const X86RegisterInfo*>(MF.getTarget().getRegisterInfo());
 852   const MachineFrameInfo *MFI = MF.getFrameInfo();
 853   int Offset = MFI->getObjectOffset(FI) - getOffsetOfLocalArea();
 854   uint64_t StackSize = MFI->getStackSize();
 855
 856   if (RI->needsStackRealignment(MF)) {
 857     if (FI < 0) {
 858       // Skip the saved EBP.
 859       Offset += RI->getSlotSize();
 860     } else {
 861       unsigned Align = MFI->getObjectAlignment(FI);
 862       assert((-(Offset + StackSize)) % Align == 0);
 863       Align = 0;
 864       return Offset + StackSize;
 865     }
 866     // FIXME: Support tail calls
 867   } else {
 868     if (!hasFP(MF))
 869       return Offset + StackSize;
 870
 871     // Skip the saved EBP.
 872     Offset += RI->getSlotSize();
 873
 874     // Skip the RETADDR move area
 875     const X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 876     int TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
 877     if (TailCallReturnAddrDelta < 0)
 878       Offset -= TailCallReturnAddrDelta;
 879   }
 880
 881   return Offset;
 882 }
 883
 884 bool X86FrameLowering::spillCalleeSavedRegisters(MachineBasicBlock &MBB,
 885                                              MachineBasicBlock::iterator MI,
 886                                         const std::vector<CalleeSavedInfo> &CSI,
 887                                           const TargetRegisterInfo *TRI) const {
 888   if (CSI.empty())
 889     return false;
 890
 891   DebugLoc DL = MBB.findDebugLoc(MI);
 892
 893   MachineFunction &MF = *MBB.getParent();
 894
 895   bool isWin64 = STI.isTargetWin64();
 896   unsigned SlotSize = STI.is64Bit() ? 8 : 4;
 897   unsigned FPReg = TRI->getFrameRegister(MF);
 898   unsigned CalleeFrameSize = 0;
 899
 900   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 901   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 902
 903   unsigned Opc = STI.is64Bit() ? X86::PUSH64r : X86::PUSH32r;
 904   for (unsigned i = CSI.size(); i != 0; --i) {
 905     unsigned Reg = CSI[i-1].getReg();
 906     // Add the callee-saved register as live-in. It's killed at the spill.
 907     MBB.addLiveIn(Reg);
 908     if (Reg == FPReg)
 909       // X86RegisterInfo::emitPrologue will handle spilling of frame register.
 910       continue;
 911     if (!X86::VR128RegClass.contains(Reg) && !isWin64) {
 912       CalleeFrameSize += SlotSize;
 913       BuildMI(MBB, MI, DL, TII.get(Opc)).addReg(Reg, RegState::Kill);
 914     } else {
 915       const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
 916       TII.storeRegToStackSlot(MBB, MI, Reg, true, CSI[i-1].getFrameIdx(),
 917                               RC, TRI);
 918     }
 919   }
 920
 921   X86FI->setCalleeSavedFrameSize(CalleeFrameSize);
 922   return true;
 923 }
 924
 925 bool X86FrameLowering::restoreCalleeSavedRegisters(MachineBasicBlock &MBB,
 926                                                MachineBasicBlock::iterator MI,
 927                                         const std::vector<CalleeSavedInfo> &CSI,
 928                                           const TargetRegisterInfo *TRI) const {
 929   if (CSI.empty())
 930     return false;
 931
 932   DebugLoc DL = MBB.findDebugLoc(MI);
 933
 934   MachineFunction &MF = *MBB.getParent();
 935   const TargetInstrInfo &TII = *MF.getTarget().getInstrInfo();
 936   unsigned FPReg = TRI->getFrameRegister(MF);
 937   bool isWin64 = STI.isTargetWin64();
 938   unsigned Opc = STI.is64Bit() ? X86::POP64r : X86::POP32r;
 939   for (unsigned i = 0, e = CSI.size(); i != e; ++i) {
 940     unsigned Reg = CSI[i].getReg();
 941     if (Reg == FPReg)
 942       // X86RegisterInfo::emitEpilogue will handle restoring of frame register.
 943       continue;
 944     if (!X86::VR128RegClass.contains(Reg) && !isWin64) {
 945       BuildMI(MBB, MI, DL, TII.get(Opc), Reg);
 946     } else {
 947       const TargetRegisterClass *RC = TRI->getMinimalPhysRegClass(Reg);
 948       TII.loadRegFromStackSlot(MBB, MI, Reg, CSI[i].getFrameIdx(),
 949                                RC, TRI);
 950     }
 951   }
 952   return true;
 953 }
 954
 955 void
 956 X86FrameLowering::processFunctionBeforeCalleeSavedScan(MachineFunction &MF,
 957                                                    RegScavenger *RS) const {
 958   MachineFrameInfo *MFI = MF.getFrameInfo();
 959   const X86RegisterInfo *RegInfo = TM.getRegisterInfo();
 960   unsigned SlotSize = RegInfo->getSlotSize();
 961
 962   X86MachineFunctionInfo *X86FI = MF.getInfo<X86MachineFunctionInfo>();
 963   int32_t TailCallReturnAddrDelta = X86FI->getTCReturnAddrDelta();
 964
 965   if (TailCallReturnAddrDelta < 0) {
 966     // create RETURNADDR area
 967     //   arg
 968     //   arg
 969     //   RETADDR
 970     //   { ...
 971     //     RETADDR area
 972     //     ...
 973     //   }
 974     //   [EBP]
 975     MFI->CreateFixedObject(-TailCallReturnAddrDelta,
 976                            (-1U*SlotSize)+TailCallReturnAddrDelta, true);
 977   }
 978
 979   if (hasFP(MF)) {
 980     assert((TailCallReturnAddrDelta <= 0) &&
 981            "The Delta should always be zero or negative");
 982     const TargetFrameLowering &TFI = *MF.getTarget().getFrameLowering();
 983
 984     // Create a frame entry for the EBP register that must be saved.
 985     int FrameIdx = MFI->CreateFixedObject(SlotSize,
 986                                           -(int)SlotSize +
 987                                           TFI.getOffsetOfLocalArea() +
 988                                           TailCallReturnAddrDelta,
 989                                           true);
 990     assert(FrameIdx == MFI->getObjectIndexBegin() &&
 991            "Slot for EBP register must be last in order to be found!");
 992     FrameIdx = 0;
 993   }
 994 }