1// -*- mode:c++ -*-
2
3// Copyright (c) 2007 The Hewlett-Packard Development Company
4// All rights reserved.
5//
6// Redistribution and use of this software in source and binary forms,
7// with or without modification, are permitted provided that the
8// following conditions are met:
9//
10// The software must be used only for Non-Commercial Use which means any
11// use which is NOT directed to receiving any direct monetary
12// compensation for, or commercial advantage from such use. Illustrative
13// examples of non-commercial use are academic research, personal study,
14// teaching, education and corporate research & development.
15// Illustrative examples of commercial use are distributing products for
16// commercial advantage and providing services using the software for
17// commercial advantage.
18//
19// If you wish to use this software or functionality therein that may be
20// covered by patents for commercial use, please contact:
21// Director of Intellectual Property Licensing
22// Office of Strategy and Technology
23// Hewlett-Packard Company
24// 1501 Page Mill Road
25// Palo Alto, California 94304
26//
27// Redistributions of source code must retain the above copyright notice,
28// this list of conditions and the following disclaimer. Redistributions
29// in binary form must reproduce the above copyright notice, this list of
30// conditions and the following disclaimer in the documentation and/or
31// other materials provided with the distribution. Neither the name of
32// the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
33// contributors may be used to endorse or promote products derived from
34// this software without specific prior written permission. No right of
35// sublicense is granted herewith. Derivatives of the software and
36// output created using the software may be prepared, but only for
37// Non-Commercial Uses. Derivatives of the software may be shared with
38// others provided: (i) the others agree to abide by the list of
39// conditions herein which includes the Non-Commercial Use restrictions;
40// and (ii) such Derivatives of the software include the above copyright
41// notice to acknowledge the contribution from this software where
42// applicable, this list of conditions and the disclaimer below.
43//
44// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
45// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
46// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
47// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
48// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
50// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
54// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55//
56// Authors: Gabe Black
57
58//////////////////////////////////////////////////////////////////////////////
59//
60// Architecture independent
61//
62
63// Execute method for macroops.
64def template MacroExecPanic {{
65 Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
66 {
67 panic("Tried to execute macroop directly!");
68 return NoFault;
69 }
70}};
71
72output header {{
73
74 // Base class for combinationally generated macroops
75 class Macroop : public StaticInst
76 {
77 protected:
78 const uint32_t numMicroops;
79
80 //Constructor.
81 Macroop(const char *mnem, ExtMachInst _machInst,
82 uint32_t _numMicroops)
83 : StaticInst(mnem, _machInst, No_OpClass),
84 numMicroops(_numMicroops)
85 {
86 assert(numMicroops);
87 microops = new StaticInstPtr[numMicroops];
88 flags[IsMacroop] = true;
89 }
90
91 ~Macroop()
92 {
93 delete [] microops;
94 }
95
96 StaticInstPtr * microops;
97
98 StaticInstPtr fetchMicroop(MicroPC microPC)
99 {
100 assert(microPC < numMicroops);
101 return microops[microPC];
102 }
103
104 std::string generateDisassembly(Addr pc,
105 const SymbolTable *symtab) const
106 {
107 return mnemonic;
108 }
109
110 %(MacroExecPanic)s
111 };
112}};
113
114// Basic instruction class declaration template.
115def template MacroDeclare {{
116 namespace X86Macroop
117 {
118 /**
119 * Static instruction class for "%(mnemonic)s".
120 */
121 class %(class_name)s : public %(base_class)s
122 {
123 public:
124 // Constructor.
125 %(class_name)s(ExtMachInst machInst, EmulEnv env);
126 };
127 };
128}};
129
130// Basic instruction class constructor template.
131def template MacroConstructor {{
132 inline X86Macroop::%(class_name)s::%(class_name)s(ExtMachInst machInst, EmulEnv env)
133 : %(base_class)s("%(mnemonic)s", machInst, %(num_microops)s)
134 {
135 %(adjust_env)s;
136 %(constructor)s;
137 //alloc_microops is the code that sets up the microops
138 //array in the parent class.
139 %(alloc_microops)s;
140 }
141}};
142
143//////////////////////////////////////////////////////////////////////////////
144//
145// X86 specific
146//
147
148let {{
149 from micro_asm import Combinational_Macroop, Rom_Macroop
150 class X86Macroop(Combinational_Macroop):
151 def setAdjustEnv(self, val):
152 self.adjust_env = val
153 def __init__(self, name):
154 super(X86Macroop, self).__init__(name)
155 self.directives = {
156 "adjust_env" : self.setAdjustEnv
157 }
158 self.declared = False
159 self.adjust_env = ""
160 def getAllocator(self, env):
161 return "new X86Macroop::%s(machInst, %s)" % (self.name, env.getAllocator())
162 def getDeclaration(self):
163 #FIXME This first parameter should be the mnemonic. I need to
164 #write some code which pulls that out
165 iop = InstObjParams(self.name, self.name, "Macroop", {"code" : ""})
166 return MacroDeclare.subst(iop);
167 def getDefinition(self):
168 #FIXME This first parameter should be the mnemonic. I need to
169 #write some code which pulls that out
170 numMicroops = len(self.microops)
171 allocMicroops = ''
172 micropc = 0
173 for op in self.microops:
174 allocMicroops += \
175 "microops[%d] = %s;\n" % \
176 (micropc, op.getAllocator(True, False,
177 micropc == 0,
178 micropc == numMicroops - 1))
179 micropc += 1
180 iop = InstObjParams(self.name, self.name, "Macroop",
181 {"code" : "", "num_microops" : numMicroops,
182 "alloc_microops" : allocMicroops,
183 "adjust_env" : self.adjust_env})
184 return MacroConstructor.subst(iop);
185}};
186
187output header {{
188 struct EmulEnv
189 {
190 X86ISA::RegIndex reg;
191 X86ISA::RegIndex regm;
| 1// -*- mode:c++ -*-
2
3// Copyright (c) 2007 The Hewlett-Packard Development Company
4// All rights reserved.
5//
6// Redistribution and use of this software in source and binary forms,
7// with or without modification, are permitted provided that the
8// following conditions are met:
9//
10// The software must be used only for Non-Commercial Use which means any
11// use which is NOT directed to receiving any direct monetary
12// compensation for, or commercial advantage from such use. Illustrative
13// examples of non-commercial use are academic research, personal study,
14// teaching, education and corporate research & development.
15// Illustrative examples of commercial use are distributing products for
16// commercial advantage and providing services using the software for
17// commercial advantage.
18//
19// If you wish to use this software or functionality therein that may be
20// covered by patents for commercial use, please contact:
21// Director of Intellectual Property Licensing
22// Office of Strategy and Technology
23// Hewlett-Packard Company
24// 1501 Page Mill Road
25// Palo Alto, California 94304
26//
27// Redistributions of source code must retain the above copyright notice,
28// this list of conditions and the following disclaimer. Redistributions
29// in binary form must reproduce the above copyright notice, this list of
30// conditions and the following disclaimer in the documentation and/or
31// other materials provided with the distribution. Neither the name of
32// the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
33// contributors may be used to endorse or promote products derived from
34// this software without specific prior written permission. No right of
35// sublicense is granted herewith. Derivatives of the software and
36// output created using the software may be prepared, but only for
37// Non-Commercial Uses. Derivatives of the software may be shared with
38// others provided: (i) the others agree to abide by the list of
39// conditions herein which includes the Non-Commercial Use restrictions;
40// and (ii) such Derivatives of the software include the above copyright
41// notice to acknowledge the contribution from this software where
42// applicable, this list of conditions and the disclaimer below.
43//
44// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
45// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
46// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
47// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
48// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
50// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
54// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55//
56// Authors: Gabe Black
57
58//////////////////////////////////////////////////////////////////////////////
59//
60// Architecture independent
61//
62
63// Execute method for macroops.
64def template MacroExecPanic {{
65 Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
66 {
67 panic("Tried to execute macroop directly!");
68 return NoFault;
69 }
70}};
71
72output header {{
73
74 // Base class for combinationally generated macroops
75 class Macroop : public StaticInst
76 {
77 protected:
78 const uint32_t numMicroops;
79
80 //Constructor.
81 Macroop(const char *mnem, ExtMachInst _machInst,
82 uint32_t _numMicroops)
83 : StaticInst(mnem, _machInst, No_OpClass),
84 numMicroops(_numMicroops)
85 {
86 assert(numMicroops);
87 microops = new StaticInstPtr[numMicroops];
88 flags[IsMacroop] = true;
89 }
90
91 ~Macroop()
92 {
93 delete [] microops;
94 }
95
96 StaticInstPtr * microops;
97
98 StaticInstPtr fetchMicroop(MicroPC microPC)
99 {
100 assert(microPC < numMicroops);
101 return microops[microPC];
102 }
103
104 std::string generateDisassembly(Addr pc,
105 const SymbolTable *symtab) const
106 {
107 return mnemonic;
108 }
109
110 %(MacroExecPanic)s
111 };
112}};
113
114// Basic instruction class declaration template.
115def template MacroDeclare {{
116 namespace X86Macroop
117 {
118 /**
119 * Static instruction class for "%(mnemonic)s".
120 */
121 class %(class_name)s : public %(base_class)s
122 {
123 public:
124 // Constructor.
125 %(class_name)s(ExtMachInst machInst, EmulEnv env);
126 };
127 };
128}};
129
130// Basic instruction class constructor template.
131def template MacroConstructor {{
132 inline X86Macroop::%(class_name)s::%(class_name)s(ExtMachInst machInst, EmulEnv env)
133 : %(base_class)s("%(mnemonic)s", machInst, %(num_microops)s)
134 {
135 %(adjust_env)s;
136 %(constructor)s;
137 //alloc_microops is the code that sets up the microops
138 //array in the parent class.
139 %(alloc_microops)s;
140 }
141}};
142
143//////////////////////////////////////////////////////////////////////////////
144//
145// X86 specific
146//
147
148let {{
149 from micro_asm import Combinational_Macroop, Rom_Macroop
150 class X86Macroop(Combinational_Macroop):
151 def setAdjustEnv(self, val):
152 self.adjust_env = val
153 def __init__(self, name):
154 super(X86Macroop, self).__init__(name)
155 self.directives = {
156 "adjust_env" : self.setAdjustEnv
157 }
158 self.declared = False
159 self.adjust_env = ""
160 def getAllocator(self, env):
161 return "new X86Macroop::%s(machInst, %s)" % (self.name, env.getAllocator())
162 def getDeclaration(self):
163 #FIXME This first parameter should be the mnemonic. I need to
164 #write some code which pulls that out
165 iop = InstObjParams(self.name, self.name, "Macroop", {"code" : ""})
166 return MacroDeclare.subst(iop);
167 def getDefinition(self):
168 #FIXME This first parameter should be the mnemonic. I need to
169 #write some code which pulls that out
170 numMicroops = len(self.microops)
171 allocMicroops = ''
172 micropc = 0
173 for op in self.microops:
174 allocMicroops += \
175 "microops[%d] = %s;\n" % \
176 (micropc, op.getAllocator(True, False,
177 micropc == 0,
178 micropc == numMicroops - 1))
179 micropc += 1
180 iop = InstObjParams(self.name, self.name, "Macroop",
181 {"code" : "", "num_microops" : numMicroops,
182 "alloc_microops" : allocMicroops,
183 "adjust_env" : self.adjust_env})
184 return MacroConstructor.subst(iop);
185}};
186
187output header {{
188 struct EmulEnv
189 {
190 X86ISA::RegIndex reg;
191 X86ISA::RegIndex regm;
|