Fixed spelling and grammar.
[oota-llvm.git] / lib / Target / X86 / X86.h
1 //===-- X86.h - Top-level interface for X86 representation ------*- C++ -*-===//
2 //
3 // This file contains the entry points for global functions defined in the x86
4 // target library, as used by the LLVM JIT.
5 //
6 // FIXME: This file will be dramatically changed in the future
7 //
8 //===----------------------------------------------------------------------===//
9
10 #ifndef TARGET_X86_H
11 #define TARGET_X86_H
12
13 #include <iosfwd>
14 class MFunction;
15 class Function;
16
17 /// X86PrintCode - Print out the specified machine code function to the
18 /// specified stream.  This function should work regardless of whether or not
19 /// the function is in SSA form or not.
20 ///
21 void X86PrintCode(const MFunction *MF, std::ostream &O);
22
23 /// X86SimpleInstructionSelection - This function converts an LLVM function into
24 /// a machine code representation is a very simple peep-hole fashion.  The
25 /// generated code sucks but the implementation is nice and simple.
26 ///
27 MFunction *X86SimpleInstructionSelection(Function &F);
28
29 /// X86SimpleRegisterAllocation - This function converts the specified machine
30 /// code function from SSA form to use explicit registers by spilling every
31 /// register.  Wow, great policy huh?
32 ///
33 inline void X86SimpleRegisterAllocation(MFunction *MF) {}
34
35 /// X86EmitCodeToMemory - This function converts a register allocated function
36 /// into raw machine code in a dynamically allocated chunk of memory.  A pointer
37 /// to the start of the function is returned.
38 ///
39 inline void *X86EmitCodeToMemory(MFunction *MF) { return 0; }
40
41
42 // Put symbolic names in a namespace to avoid causing these to clash with all
43 // kinds of other things...
44 //
45 namespace X86 {
46   // Defines a large number of symbolic names for X86 registers.  This defines a
47   // mapping from register name to register number.
48   //
49   enum Register {
50 #define R(ENUM, NAME, FLAGS, TSFLAGS) ENUM,
51 #include "X86RegisterInfo.def"
52   };
53
54   // This defines a large number of symbolic names for X86 instruction opcodes.
55   enum Opcode {
56 #define I(ENUM, NAME, FLAGS, TSFLAGS) ENUM,
57 #include "X86InstructionInfo.def"
58   };
59 }
60
61 #endif