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, with
  24 /// no scale, index or displacement. An example is: DWORD PTR [EAX].
  25 inline const MachineInstrBuilder &addDirectMem(const MachineInstrBuilder &MIB,
  26                                                unsigned Reg) {
  27   // Because memory references are always represented with four
  28   // values, this adds: Reg, [1, NoReg, 0] to the instruction.
  29   return MIB.addReg(Reg).addZImm(1).addMReg(0).addSImm(0);
  30 }
  31
  32
  33 /// addRegOffset - This function is used to add a memory reference of
  34 /// the form [Reg + Offset], i.e., one with no scale or index, but
  35 /// with a displacement. An example is: DWORD PTR [EAX + 4].
  36 inline const MachineInstrBuilder &addRegOffset(const MachineInstrBuilder &MIB,
  37                                                unsigned Reg, unsigned Offset) {
  38   return MIB.addReg(Reg).addZImm(1).addMReg(0).addSImm(Offset);
  39 }
  40
  41 #endif