blob: a5643bdbfb6eb2ed8be20e0c7303308c2b1727ff [file] [log] [blame]
Chris Lattner9562add2002-11-17 21:03:35 +00001//===-- X86InstrBuilder.h - Functions to aid building x86 insts -*- C++ -*-===//
John Criswell856ba762003-10-21 15:17:13 +00002//
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//===----------------------------------------------------------------------===//
Chris Lattner9562add2002-11-17 21:03:35 +00009//
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//
Brian Gaekeed6902c2002-12-13 09:28:50 +000019// For reference, the order of operands for memory references is:
20// (Operand), Base, Scale, Index, Displacement.
21//
Chris Lattner9562add2002-11-17 21:03:35 +000022//===----------------------------------------------------------------------===//
23
24#ifndef X86INSTRBUILDER_H
25#define X86INSTRBUILDER_H
26
27#include "llvm/CodeGen/MachineInstrBuilder.h"
28
Brian Gaeked0fde302003-11-11 22:41:34 +000029namespace llvm {
30
Chris Lattner9562add2002-11-17 21:03:35 +000031/// addDirectMem - This function is used to add a direct memory reference to the
Chris Lattnera1826c22002-12-28 20:26:58 +000032/// current instruction -- that is, a dereference of an address in a register,
33/// with no scale, index or displacement. An example is: DWORD PTR [EAX].
34///
Chris Lattner9562add2002-11-17 21:03:35 +000035inline const MachineInstrBuilder &addDirectMem(const MachineInstrBuilder &MIB,
36 unsigned Reg) {
Brian Gaekeed6902c2002-12-13 09:28:50 +000037 // Because memory references are always represented with four
38 // values, this adds: Reg, [1, NoReg, 0] to the instruction.
Chris Lattner1a57ccd2003-01-15 00:04:14 +000039 return MIB.addReg(Reg).addZImm(1).addReg(0).addSImm(0);
Chris Lattner9562add2002-11-17 21:03:35 +000040}
41
Misha Brukmanfaf0b8c2002-11-22 22:42:12 +000042
Chris Lattnera1826c22002-12-28 20:26:58 +000043/// addRegOffset - This function is used to add a memory reference of the form
44/// [Reg + Offset], i.e., one with no scale or index, but with a
45/// displacement. An example is: DWORD PTR [EAX + 4].
46///
Misha Brukmanfaf0b8c2002-11-22 22:42:12 +000047inline const MachineInstrBuilder &addRegOffset(const MachineInstrBuilder &MIB,
Chris Lattnera1826c22002-12-28 20:26:58 +000048 unsigned Reg, int Offset) {
Chris Lattner1a57ccd2003-01-15 00:04:14 +000049 return MIB.addReg(Reg).addZImm(1).addReg(0).addSImm(Offset);
Misha Brukmanfaf0b8c2002-11-22 22:42:12 +000050}
51
Chris Lattnera1826c22002-12-28 20:26:58 +000052/// addFrameReference - This function is used to add a reference to the base of
53/// an abstract object on the stack frame of the current function. This
Chris Lattner987e8ba2003-01-13 00:45:53 +000054/// reference has base register as the FrameIndex offset until it is resolved.
55/// This allows a constant offset to be specified as well...
Chris Lattnera1826c22002-12-28 20:26:58 +000056///
57inline const MachineInstrBuilder &
Chris Lattner987e8ba2003-01-13 00:45:53 +000058addFrameReference(const MachineInstrBuilder &MIB, int FI, int Offset = 0) {
Chris Lattner1a57ccd2003-01-15 00:04:14 +000059 return MIB.addFrameIndex(FI).addZImm(1).addReg(0).addSImm(Offset);
Chris Lattner987e8ba2003-01-13 00:45:53 +000060}
61
62/// addConstantPoolReference - This function is used to add a reference to the
63/// base of a constant value spilled to the per-function constant pool. The
64/// reference has base register ConstantPoolIndex offset which is retained until
65/// either machine code emission or assembly output. This allows an optional
66/// offset to be added as well.
67///
68inline const MachineInstrBuilder &
69addConstantPoolReference(const MachineInstrBuilder &MIB, unsigned CPI,
Misha Brukman2e385b42003-10-22 03:10:26 +000070 int Offset = 0) {
Chris Lattner1a57ccd2003-01-15 00:04:14 +000071 return MIB.addConstantPoolIndex(CPI).addZImm(1).addReg(0).addSImm(Offset);
Chris Lattnera1826c22002-12-28 20:26:58 +000072}
73
Brian Gaeked0fde302003-11-11 22:41:34 +000074} // End llvm namespace
75
Chris Lattner9562add2002-11-17 21:03:35 +000076#endif