lib/Target/X86/X86InstrBuilder.h

   1 //===-- X86InstrBuilder.h - Functions to aid building x86 insts -*- C++ -*-===//
   2 //
   3 // This file exposes functions that may be used with BuildMI from the
   4 // MachineInstrBuilder.h file to handle X86'isms in a clean way.
   5 //
   6 // The BuildMem function may be used with the BuildMI function to add entire
   7 // memory references in a single, typed, function call.  X86 memory references
   8 // can be very complex expressions (described in the README), so wrapping them
   9 // up behind an easier to use interface makes sense.  Descriptions of the
  10 // functions are included below.
  11 //
  12 // For reference, the order of operands for memory references is:
  13 // (Operand), Base, Scale, Index, Displacement.
  14 //
  15 //===----------------------------------------------------------------------===//
  16
  17 #ifndef X86INSTRBUILDER_H
  18 #define X86INSTRBUILDER_H
  19
  20 #include "llvm/CodeGen/MachineInstrBuilder.h"
  21
  22 /// addDirectMem - This function is used to add a direct memory reference to the
  23 /// current instruction -- that is, a dereference of an address in a register,
  24 /// with no scale, index or displacement. An example is: DWORD PTR [EAX].
  25 ///
  26 inline const MachineInstrBuilder &addDirectMem(const MachineInstrBuilder &MIB,
  27                                                unsigned Reg) {
  28   // Because memory references are always represented with four
  29   // values, this adds: Reg, [1, NoReg, 0] to the instruction.
  30   return MIB.addReg(Reg).addZImm(1).addMReg(0).addSImm(0);
  31 }
  32
  33
  34 /// addRegOffset - This function is used to add a memory reference of the form
  35 /// [Reg + Offset], i.e., one with no scale or index, but with a
  36 /// displacement. An example is: DWORD PTR [EAX + 4].
  37 ///
  38 inline const MachineInstrBuilder &addRegOffset(const MachineInstrBuilder &MIB,
  39                                                unsigned Reg, int Offset) {
  40   return MIB.addReg(Reg).addZImm(1).addMReg(0).addSImm(Offset);
  41 }
  42
  43 /// addFrameReference - This function is used to add a reference to the base of
  44 /// an abstract object on the stack frame of the current function.  This
  45 /// reference has base register <noreg> and a FrameIndex offset until it is
  46 /// resolved.
  47 ///
  48 inline const MachineInstrBuilder &
  49 addFrameReference(const MachineInstrBuilder &MIB, int FI) {
  50   return MIB.addReg(0).addZImm(1).addMReg(0).addFrameIndex(FI);
  51 }
  52
  53 #endif