1// -*- mode:c++ -*-
2
3// Copyright (c) 2009 The University of Edinburgh
4// All rights reserved.
5//
6// Redistribution and use in source and binary forms, with or without
7// modification, are permitted provided that the following conditions are
8// met: redistributions of source code must retain the above copyright
9// notice, this list of conditions and the following disclaimer;
10// redistributions in binary form must reproduce the above copyright
11// notice, this list of conditions and the following disclaimer in the
12// documentation and/or other materials provided with the distribution;
13// neither the name of the copyright holders nor the names of its
14// contributors may be used to endorse or promote products derived from
15// this software without specific prior written permission.
16//
17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28//
29// Authors: Timothy M. Jones
30
31////////////////////////////////////////////////////////////////////
32//
33// Memory-format instructions
34//
35
36def template LoadStoreDeclare {{
37 /**
38 * Static instruction class for "%(mnemonic)s".
39 */
40 class %(class_name)s : public %(base_class)s
41 {
42 public:
43
44 /// Constructor.
45 %(class_name)s(ExtMachInst machInst);
46
47 %(BasicExecDeclare)s
48
49 %(InitiateAccDeclare)s
50
51 %(CompleteAccDeclare)s
52 };
53}};
54
55
56def template InitiateAccDeclare {{
57 Fault initiateAcc(%(CPU_exec_context)s *, Trace::InstRecord *) const;
58}};
59
60
61def template CompleteAccDeclare {{
62 Fault completeAcc(PacketPtr, %(CPU_exec_context)s *, Trace::InstRecord *) const;
63}};
64
65
66def template LoadStoreConstructor {{
67 inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
68 : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
69 {
70 %(constructor)s;
71 }
72}};
73
74
75def template LoadExecute {{
76 Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
77 Trace::InstRecord *traceData) const
78 {
79 Addr EA;
80 Fault fault = NoFault;
81
82 %(op_decl)s;
83 %(op_rd)s;
84 %(ea_code)s;
85
86 if (fault == NoFault) {
87 fault = xc->read(EA, (uint%(mem_acc_size)d_t&)Mem, memAccessFlags);
88 %(memacc_code)s;
89 }
90
91 if (fault == NoFault) {
92 %(op_wb)s;
93 }
94
95 return fault;
96 }
97}};
98
99
100def template LoadInitiateAcc {{
101 Fault %(class_name)s::initiateAcc(%(CPU_exec_context)s *xc,
102 Trace::InstRecord *traceData) const
103 {
104 Addr EA;
105 Fault fault = NoFault;
106
107 %(op_src_decl)s;
108 %(op_rd)s;
109 %(ea_code)s;
110
111 if (fault == NoFault) {
112 fault = xc->read(EA, (uint%(mem_acc_size)d_t &)Mem, memAccessFlags);
113 xc->setEA(EA);
114 }
115
116 return fault;
117 }
118}};
119
120
121def template LoadCompleteAcc {{
122 Fault %(class_name)s::completeAcc(PacketPtr pkt,
123 %(CPU_exec_context)s *xc,
124 Trace::InstRecord *traceData) const
125 {
126 Addr EA;
127 Fault fault = NoFault;
128 uint%(mem_acc_size)d_t val;
129
130 %(op_decl)s;
131 %(op_rd)s;
132
133 EA = xc->getEA();
134
135 val = pkt->get<uint%(mem_acc_size)d_t>();
136 *((uint%(mem_acc_size)d_t*)&Mem) = val;
137
138 if (fault == NoFault) {
139 %(memacc_code)s;
140 }
141
142 if (fault == NoFault) {
143 %(op_wb)s;
144 }
145
146 return fault;
147 }
148}};
149
150
151def template StoreExecute {{
152 Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
153 Trace::InstRecord *traceData) const
154 {
155 Addr EA;
156 Fault fault = NoFault;
157
158 %(op_decl)s;
159 %(op_rd)s;
160 %(ea_code)s;
161
162 if (fault == NoFault) {
163 %(memacc_code)s;
164 }
165
166 if (fault == NoFault) {
167 fault = xc->write((uint%(mem_acc_size)d_t&)Mem, EA,
168 memAccessFlags, NULL);
169 }
170
171 if (fault == NoFault) {
172 %(op_wb)s;
173 }
174
175 return fault;
176 }
177}};
178
179
180def template StoreInitiateAcc {{
181 Fault %(class_name)s::initiateAcc(%(CPU_exec_context)s *xc,
182 Trace::InstRecord *traceData) const
183 {
184 Addr EA;
185 Fault fault = NoFault;
186
187 %(op_decl)s;
188 %(op_rd)s;
189 %(ea_code)s;
190
191 if (fault == NoFault) {
192 %(memacc_code)s;
193 }
194
195 if (fault == NoFault) {
196 fault = xc->write((uint%(mem_acc_size)d_t&)Mem, EA,
197 memAccessFlags, NULL);
198 }
199
200 // Need to write back any potential address register update
201 if (fault == NoFault) {
202 %(op_wb)s;
203 }
204
205 return fault;
206 }
207}};
208
209
210def template StoreCompleteAcc {{
211 Fault %(class_name)s::completeAcc(PacketPtr pkt,
212 %(CPU_exec_context)s *xc,
213 Trace::InstRecord *traceData) const
214 {
|
216 }
217}};
218
219
220// The generic memory operation generator. This is called when two versions
221// of an instruction are needed - when Ra == 0 and otherwise. This is so
222// that instructions can use the value 0 when Ra == 0 but avoid having a
223// dependence on Ra.
224let {{
225
226def GenMemOp(name, Name, memacc_code, ea_code, ea_code_ra0, base,
227 load_or_store, mem_flags = [], inst_flags = []):
228
229 # First the version where Ra is non-zero
230 (header_output, decoder_output, decode_block, exec_output) = \
231 LoadStoreBase(name, Name, ea_code, memacc_code, mem_flags, inst_flags,
232 base_class = base,
233 decode_template = CheckRaDecode,
234 exec_template_base = load_or_store)
235
236 # Now another version where Ra == 0
237 (header_output_ra0, decoder_output_ra0, _, exec_output_ra0) = \
238 LoadStoreBase(name, Name + 'RaZero', ea_code_ra0, memacc_code,
239 mem_flags, inst_flags,
240 base_class = base,
241 exec_template_base = load_or_store)
242
243 # Finally, add to the other outputs
244 header_output += header_output_ra0
245 decoder_output += decoder_output_ra0
246 exec_output += exec_output_ra0
247 return (header_output, decoder_output, decode_block, exec_output)
248
249}};
250
251
252def format LoadIndexOp(memacc_code, ea_code = {{ EA = Ra + Rb; }},
253 ea_code_ra0 = {{ EA = Rb; }},
254 mem_flags = [], inst_flags = []) {{
255 (header_output, decoder_output, decode_block, exec_output) = \
256 GenMemOp(name, Name, memacc_code, ea_code, ea_code_ra0,
257 'MemOp', 'Load', mem_flags, inst_flags)
258}};
259
260
261def format StoreIndexOp(memacc_code, ea_code = {{ EA = Ra + Rb; }},
262 ea_code_ra0 = {{ EA = Rb; }},
263 mem_flags = [], inst_flags = []) {{
264 (header_output, decoder_output, decode_block, exec_output) = \
265 GenMemOp(name, Name, memacc_code, ea_code, ea_code_ra0,
266 'MemOp', 'Store', mem_flags, inst_flags)
267}};
268
269
270def format LoadIndexUpdateOp(memacc_code, ea_code = {{ EA = Ra + Rb; }},
271 mem_flags = [], inst_flags = []) {{
272
273 # Add in the update code
274 memacc_code += 'Ra = EA;'
275
276 # Generate the class
277 (header_output, decoder_output, decode_block, exec_output) = \
278 LoadStoreBase(name, Name, ea_code, memacc_code, mem_flags, inst_flags,
279 base_class = 'MemOp',
280 exec_template_base = 'Load')
281}};
282
283
284def format StoreIndexUpdateOp(memacc_code, ea_code = {{ EA = Ra + Rb; }},
285 mem_flags = [], inst_flags = []) {{
286
287 # Add in the update code
288 memacc_code += 'Ra = EA;'
289
290 # Generate the class
291 (header_output, decoder_output, decode_block, exec_output) = \
292 LoadStoreBase(name, Name, ea_code, memacc_code, mem_flags, inst_flags,
293 base_class = 'MemOp',
294 exec_template_base = 'Store')
295}};
296
297
298def format LoadDispOp(memacc_code, ea_code = {{ EA = Ra + disp; }},
299 ea_code_ra0 = {{ EA = disp; }},
300 mem_flags = [], inst_flags = []) {{
301 (header_output, decoder_output, decode_block, exec_output) = \
302 GenMemOp(name, Name, memacc_code, ea_code, ea_code_ra0,
303 'MemDispOp', 'Load', mem_flags, inst_flags)
304}};
305
306
307def format StoreDispOp(memacc_code, ea_code = {{ EA = Ra + disp; }},
308 ea_code_ra0 = {{ EA = disp; }},
309 mem_flags = [], inst_flags = []) {{
310 (header_output, decoder_output, decode_block, exec_output) = \
311 GenMemOp(name, Name, memacc_code, ea_code, ea_code_ra0,
312 'MemDispOp', 'Store', mem_flags, inst_flags)
313}};
314
315
316def format LoadDispUpdateOp(memacc_code, ea_code = {{ EA = Ra + disp; }},
317 mem_flags = [], inst_flags = []) {{
318
319 # Add in the update code
320 memacc_code += 'Ra = EA;'
321
322 # Generate the class
323 (header_output, decoder_output, decode_block, exec_output) = \
324 LoadStoreBase(name, Name, ea_code, memacc_code, mem_flags, inst_flags,
325 base_class = 'MemDispOp',
326 exec_template_base = 'Load')
327}};
328
329
330def format StoreDispUpdateOp(memacc_code, ea_code = {{ EA = Ra + disp; }},
331 mem_flags = [], inst_flags = []) {{
332
333 # Add in the update code
334 memacc_code += 'Ra = EA;'
335
336 # Generate the class
337 (header_output, decoder_output, decode_block, exec_output) = \
338 LoadStoreBase(name, Name, ea_code, memacc_code, mem_flags, inst_flags,
339 base_class = 'MemDispOp',
340 exec_template_base = 'Store')
341}};
|