lib/Target/X86/X86InstrBuilder.h

   1 //===-- X86InstrBuilder.h - Functions to aid building x86 insts -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file exposes functions that may be used with BuildMI from the
  11 // MachineInstrBuilder.h file to handle X86'isms in a clean way.
  12 //
  13 // The BuildMem function may be used with the BuildMI function to add entire
  14 // memory references in a single, typed, function call.  X86 memory references
  15 // can be very complex expressions (described in the README), so wrapping them
  16 // up behind an easier to use interface makes sense.  Descriptions of the
  17 // functions are included below.
  18 //
  19 // For reference, the order of operands for memory references is:
  20 // (Operand), Base, Scale, Index, Displacement.
  21 //
  22 //===----------------------------------------------------------------------===//
  23
  24 #ifndef X86INSTRBUILDER_H
  25 #define X86INSTRBUILDER_H
  26
  27 #include "llvm/CodeGen/MachineInstrBuilder.h"
  28
  29 namespace llvm {
  30
  31 /// X86AddressMode - This struct holds a generalized full x86 address mode.
  32 /// The base register can be a frame index, which will eventually be replaced
  33 /// with BP or SP and Disp being offsetted accordingly.  The displacement may
  34 /// also include the offset of a global value.
  35 struct X86AddressMode {
  36     enum {
  37       UnknownBase,
  38       RegBase,
  39       FrameIndexBase,
  40     } BaseType;
  41
  42     union {
  43       unsigned Reg;
  44       int FrameIndex;
  45     } Base;
  46
  47     unsigned Scale;
  48     unsigned IndexReg;
  49     unsigned Disp;
  50     GlobalValue *GV;
  51
  52     X86AddressMode() : BaseType(UnknownBase), GV(NULL) {}
  53 };
  54
  55 /// addDirectMem - This function is used to add a direct memory reference to the
  56 /// current instruction -- that is, a dereference of an address in a register,
  57 /// with no scale, index or displacement. An example is: DWORD PTR [EAX].
  58 ///
  59 inline const MachineInstrBuilder &addDirectMem(const MachineInstrBuilder &MIB,
  60                                                unsigned Reg) {
  61   // Because memory references are always represented with four
  62   // values, this adds: Reg, [1, NoReg, 0] to the instruction.
  63   return MIB.addReg(Reg).addZImm(1).addReg(0).addSImm(0);
  64 }
  65
  66
  67 /// addRegOffset - This function is used to add a memory reference of the form
  68 /// [Reg + Offset], i.e., one with no scale or index, but with a
  69 /// displacement. An example is: DWORD PTR [EAX + 4].
  70 ///
  71 inline const MachineInstrBuilder &addRegOffset(const MachineInstrBuilder &MIB,
  72                                                unsigned Reg, int Offset) {
  73   return MIB.addReg(Reg).addZImm(1).addReg(0).addSImm(Offset);
  74 }
  75
  76 inline const MachineInstrBuilder &addFullAddress(const MachineInstrBuilder &MIB,
  77                                                  const X86AddressMode &AM) {
  78   assert (AM.Scale == 1 || AM.Scale == 2 || AM.Scale == 4 || AM.Scale == 8);
  79
  80   if (AM.BaseType == X86AddressMode::RegBase)
  81     MIB.addReg(AM.Base.Reg);
  82   else if (AM.BaseType == X86AddressMode::FrameIndexBase)
  83     MIB.addFrameIndex(AM.Base.FrameIndex);
  84   else
  85     assert (0);
  86   MIB.addZImm(AM.Scale).addReg(AM.IndexReg);
  87   if (AM.GV)
  88     return MIB.addGlobalAddress(AM.GV, false, AM.Disp);
  89   else
  90     return MIB.addSImm(AM.Disp);
  91 }
  92
  93 /// addFrameReference - This function is used to add a reference to the base of
  94 /// an abstract object on the stack frame of the current function.  This
  95 /// reference has base register as the FrameIndex offset until it is resolved.
  96 /// This allows a constant offset to be specified as well...
  97 ///
  98 inline const MachineInstrBuilder &
  99 addFrameReference(const MachineInstrBuilder &MIB, int FI, int Offset = 0) {
 100   return MIB.addFrameIndex(FI).addZImm(1).addReg(0).addSImm(Offset);
 101 }
 102
 103 /// addConstantPoolReference - This function is used to add a reference to the
 104 /// base of a constant value spilled to the per-function constant pool.  The
 105 /// reference has base register ConstantPoolIndex offset which is retained until
 106 /// either machine code emission or assembly output.  This allows an optional
 107 /// offset to be added as well.
 108 ///
 109 inline const MachineInstrBuilder &
 110 addConstantPoolReference(const MachineInstrBuilder &MIB, unsigned CPI,
 111                          int Offset = 0) {
 112   return MIB.addConstantPoolIndex(CPI).addZImm(1).addReg(0).addSImm(Offset);
 113 }
 114
 115 } // End llvm namespace
 116
 117 #endif