1// -*- mode:c++ -*-
2
3// Copyright (c) 2003-2005 The Regents of The University of Michigan
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: Steve Reinhardt
30
31////////////////////////////////////////////////////////////////////
32//
33// Alpha ISA description file.
34//
35////////////////////////////////////////////////////////////////////
36
37
38////////////////////////////////////////////////////////////////////
39//
40// Output include file directives.
41//
42
43output header {{
44#include <iomanip>
45#include <iostream>
46#include <sstream>
47
48#include "arch/alpha/faults.hh"
49#include "arch/alpha/types.hh"
50#include "config/ss_compatible_fp.hh"
51#include "cpu/static_inst.hh"
52#include "mem/packet.hh"
53#include "mem/request.hh" // some constructors use MemReq flags
54}};
55
56output decoder {{
57#include <cmath>
58
59#include "arch/alpha/decoder.hh"
60#include "arch/alpha/registers.hh"
61#include "arch/alpha/regredir.hh"
62#include "base/loader/symtab.hh"
63#include "base/cprintf.hh"
64#include "base/fenv.hh"
65#include "config/ss_compatible_fp.hh"
66#include "cpu/thread_context.hh" // for Jump::branchTarget()
67#include "mem/packet.hh"
68#include "sim/full_system.hh"
69
70using namespace AlphaISA;
71}};
72
73output exec {{
74#include <cmath>
75
76#include "arch/alpha/registers.hh"
77#include "arch/alpha/regredir.hh"
78#include "arch/generic/memhelpers.hh"
79#include "base/cp_annotate.hh"
80#include "base/fenv.hh"
81#include "config/ss_compatible_fp.hh"
82#include "cpu/base.hh"
83#include "cpu/exetrace.hh"
84#include "mem/packet.hh"
85#include "mem/packet_access.hh"
86#include "sim/full_system.hh"
87#include "sim/pseudo_inst.hh"
88#include "sim/sim_exit.hh"
89
90using namespace AlphaISA;
91}};
92
93////////////////////////////////////////////////////////////////////
94//
95// Namespace statement. Everything below this line will be in the
96// AlphaISAInst namespace.
97//
98
99
100namespace AlphaISA;
101
102////////////////////////////////////////////////////////////////////
103//
104// Bitfield definitions.
105//
106
107// Universal (format-independent) fields
108def bitfield PALMODE <32:32>;
109def bitfield OPCODE <31:26>;
110def bitfield RA <25:21>;
111def bitfield RB <20:16>;
112
113// Memory format
114def signed bitfield MEMDISP <15: 0>; // displacement
115def bitfield MEMFUNC <15: 0>; // function code (same field, unsigned)
116
117// Memory-format jumps
118def bitfield JMPFUNC <15:14>; // function code (disp<15:14>)
119def bitfield JMPHINT <13: 0>; // tgt Icache idx hint (disp<13:0>)
120
121// Branch format
122def signed bitfield BRDISP <20: 0>; // displacement
123
124// Integer operate format(s>;
125def bitfield INTIMM <20:13>; // integer immediate (literal)
126def bitfield IMM <12:12>; // immediate flag
127def bitfield INTFUNC <11: 5>; // function code
128def bitfield RC < 4: 0>; // dest reg
129
130// Floating-point operate format
131def bitfield FA <25:21>;
132def bitfield FB <20:16>;
133def bitfield FP_FULLFUNC <15: 5>; // complete function code
134 def bitfield FP_TRAPMODE <15:13>; // trapping mode
135 def bitfield FP_ROUNDMODE <12:11>; // rounding mode
136 def bitfield FP_TYPEFUNC <10: 5>; // type+func: handiest for decoding
137 def bitfield FP_SRCTYPE <10: 9>; // source reg type
138 def bitfield FP_SHORTFUNC < 8: 5>; // short function code
139 def bitfield FP_SHORTFUNC_TOP2 <8:7>; // top 2 bits of short func code
140def bitfield FC < 4: 0>; // dest reg
141
142// PALcode format
143def bitfield PALFUNC <25: 0>; // function code
144
145// EV5 PAL instructions:
146// HW_LD/HW_ST
147def bitfield HW_LDST_PHYS <15>; // address is physical
148def bitfield HW_LDST_ALT <14>; // use ALT_MODE IPR
149def bitfield HW_LDST_WRTCK <13>; // HW_LD only: fault if no write acc
150def bitfield HW_LDST_QUAD <12>; // size: 0=32b, 1=64b
151def bitfield HW_LDST_VPTE <11>; // HW_LD only: is PTE fetch
152def bitfield HW_LDST_LOCK <10>; // HW_LD only: is load locked
153def bitfield HW_LDST_COND <10>; // HW_ST only: is store conditional
154def signed bitfield HW_LDST_DISP <9:0>; // signed displacement
155
156// HW_REI
157def bitfield HW_REI_TYP <15:14>; // type: stalling vs. non-stallingk
158def bitfield HW_REI_MBZ <13: 0>; // must be zero
159
160// HW_MTPR/MW_MFPR
161def bitfield HW_IPR_IDX <15:0>; // IPR index
162
163// M5 instructions
164def bitfield M5FUNC <7:0>;
165
166def operand_types {{
167 'sb' : 'int8_t',
168 'ub' : 'uint8_t',
169 'sw' : 'int16_t',
170 'uw' : 'uint16_t',
171 'sl' : 'int32_t',
172 'ul' : 'uint32_t',
173 'sq' : 'int64_t',
174 'uq' : 'uint64_t',
175 'sf' : 'float',
176 'df' : 'double'
177}};
178
179def operands {{
180 # Int regs default to unsigned, but code should not count on this.
181 # For clarity, descriptions that depend on unsigned behavior should
182 # explicitly specify '_uq'.
183 'Ra': ('IntReg', 'uq', 'PALMODE ? reg_redir[RA] : RA',
184 'IsInteger', 1),
185 'Rb': ('IntReg', 'uq', 'PALMODE ? reg_redir[RB] : RB',
186 'IsInteger', 2),
187 'Rc': ('IntReg', 'uq', 'PALMODE ? reg_redir[RC] : RC',
188 'IsInteger', 3),
189 'Fa': ('FloatReg', 'df', 'FA', 'IsFloating', 1),
190 'Fb': ('FloatReg', 'df', 'FB', 'IsFloating', 2),
191 'Fc': ('FloatReg', 'df', 'FC', 'IsFloating', 3),
192 'Mem': ('Mem', 'uq', None, ('IsMemRef', 'IsLoad', 'IsStore'), 4),
193 'PC': ('PCState', 'uq', 'pc', ( None, None, 'IsControl' ), 4),
194 'NPC': ('PCState', 'uq', 'npc', ( None, None, 'IsControl' ), 4),
195 'Runiq': ('ControlReg', 'uq', 'MISCREG_UNIQ', None, 1),
196 'FPCR': ('ControlReg', 'uq', 'MISCREG_FPCR', None, 1),
197 'IntrFlag': ('ControlReg', 'uq', 'MISCREG_INTR', None, 1),
198 # The next two are hacks for non-full-system call-pal emulation
199 'R0': ('IntReg', 'uq', '0', None, 1),
200 'R16': ('IntReg', 'uq', '16', None, 1),
201 'R17': ('IntReg', 'uq', '17', None, 1),
202 'R18': ('IntReg', 'uq', '18', None, 1)
203}};
204
205////////////////////////////////////////////////////////////////////
206//
207// Basic instruction classes/templates/formats etc.
208//
209
210output header {{
211// uncomment the following to get SimpleScalar-compatible disassembly
212// (useful for diffing output traces).
213// #define SS_COMPATIBLE_DISASSEMBLY
214
215 /**
216 * Base class for all Alpha static instructions.
217 */
218 class AlphaStaticInst : public StaticInst
219 {
220 protected:
221
222 /// Make AlphaISA register dependence tags directly visible in
223 /// this class and derived classes. Maybe these should really
224 /// live here and not in the AlphaISA namespace.
225 enum DependenceTags {
226 FP_Base_DepTag = AlphaISA::FP_Base_DepTag
227 };
228
229 /// Constructor.
230 AlphaStaticInst(const char *mnem, ExtMachInst _machInst,
231 OpClass __opClass)
232 : StaticInst(mnem, _machInst, __opClass)
233 {
234 }
235
236 /// Print a register name for disassembly given the unique
237 /// dependence tag number (FP or int).
238 void printReg(std::ostream &os, int reg) const;
239
240 std::string
241 generateDisassembly(Addr pc, const SymbolTable *symtab) const;
242
243 void
244 advancePC(AlphaISA::PCState &pcState) const
245 {
246 pcState.advance();
247 }
248 };
249}};
250
251output decoder {{
252 void
253 AlphaStaticInst::printReg(std::ostream &os, int reg) const
254 {
255 if (reg < FP_Base_DepTag) {
256 ccprintf(os, "r%d", reg);
257 }
258 else {
259 ccprintf(os, "f%d", reg - FP_Base_DepTag);
260 }
261 }
262
263 std::string
264 AlphaStaticInst::generateDisassembly(Addr pc,
265 const SymbolTable *symtab) const
266 {
267 std::stringstream ss;
268
269 ccprintf(ss, "%-10s ", mnemonic);
270
271 // just print the first two source regs... if there's
272 // a third one, it's a read-modify-write dest (Rc),
273 // e.g. for CMOVxx
274 if (_numSrcRegs > 0) {
275 printReg(ss, _srcRegIdx[0]);
276 }
277 if (_numSrcRegs > 1) {
278 ss << ",";
279 printReg(ss, _srcRegIdx[1]);
280 }
281
282 // just print the first dest... if there's a second one,
283 // it's generally implicit
284 if (_numDestRegs > 0) {
285 if (_numSrcRegs > 0)
286 ss << ",";
287 printReg(ss, _destRegIdx[0]);
288 }
289
290 return ss.str();
291 }
292}};
293
294// Declarations for execute() methods.
295def template BasicExecDeclare {{
296 Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const;
297}};
298
299// Basic instruction class declaration template.
300def template BasicDeclare {{
301 /**
302 * Static instruction class for "%(mnemonic)s".
303 */
304 class %(class_name)s : public %(base_class)s
305 {
306 public:
307 /// Constructor.
308 %(class_name)s(ExtMachInst machInst);
309
310 %(BasicExecDeclare)s
311 };
312}};
313
314// Basic instruction class constructor template.
315def template BasicConstructor {{
316 inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
317 : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
318 {
319 %(constructor)s;
320 }
321}};
322
323// Basic instruction class execute method template.
324def template BasicExecute {{
325 Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
326 Trace::InstRecord *traceData) const
327 {
328 Fault fault = NoFault;
329
330 %(fp_enable_check)s;
331 %(op_decl)s;
332 %(op_rd)s;
333 %(code)s;
334
335 if (fault == NoFault) {
336 %(op_wb)s;
337 }
338
339 return fault;
340 }
341}};
342
343// Basic decode template.
344def template BasicDecode {{
345 return new %(class_name)s(machInst);
346}};
347
348// Basic decode template, passing mnemonic in as string arg to constructor.
349def template BasicDecodeWithMnemonic {{
350 return new %(class_name)s("%(mnemonic)s", machInst);
351}};
352
353// The most basic instruction format... used only for a few misc. insts
354def format BasicOperate(code, *flags) {{
355 iop = InstObjParams(name, Name, 'AlphaStaticInst', code, flags)
356 header_output = BasicDeclare.subst(iop)
357 decoder_output = BasicConstructor.subst(iop)
358 decode_block = BasicDecode.subst(iop)
359 exec_output = BasicExecute.subst(iop)
360}};
361
362
363
364////////////////////////////////////////////////////////////////////
365//
366// Nop
367//
368
369output header {{
370 /**
371 * Static instruction class for no-ops. This is a leaf class.
372 */
373 class Nop : public AlphaStaticInst
374 {
375 /// Disassembly of original instruction.
376 const std::string originalDisassembly;
377
378 public:
379 /// Constructor
380 Nop(const std::string _originalDisassembly, ExtMachInst _machInst)
381 : AlphaStaticInst("nop", _machInst, No_OpClass),
382 originalDisassembly(_originalDisassembly)
383 {
384 flags[IsNop] = true;
385 }
386
387 ~Nop() { }
388
389 std::string
390 generateDisassembly(Addr pc, const SymbolTable *symtab) const;
391
392 %(BasicExecDeclare)s
393 };
394
395 /// Helper function for decoding nops. Substitute Nop object
396 /// for original inst passed in as arg (and delete latter).
397 static inline
398 AlphaStaticInst *
399 makeNop(AlphaStaticInst *inst)
400 {
401 AlphaStaticInst *nop = new Nop(inst->disassemble(0), inst->machInst);
402 delete inst;
403 return nop;
404 }
405}};
406
407output decoder {{
408 std::string Nop::generateDisassembly(Addr pc,
409 const SymbolTable *symtab) const
410 {
411#ifdef SS_COMPATIBLE_DISASSEMBLY
412 return originalDisassembly;
413#else
414 return csprintf("%-10s (%s)", "nop", originalDisassembly);
415#endif
416 }
417}};
418
419output exec {{
420 Fault
421 Nop::execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
422 {
423 return NoFault;
424 }
425}};
426
427// integer & FP operate instructions use Rc as dest, so check for
428// Rc == 31 to detect nops
429def template OperateNopCheckDecode {{
430 {
431 AlphaStaticInst *i = new %(class_name)s(machInst);
432 if (RC == 31) {
433 i = makeNop(i);
434 }
435 return i;
436 }
437}};
438
439// Like BasicOperate format, but generates NOP if RC/FC == 31
440def format BasicOperateWithNopCheck(code, *opt_args) {{
441 iop = InstObjParams(name, Name, 'AlphaStaticInst', code, opt_args)
442 header_output = BasicDeclare.subst(iop)
443 decoder_output = BasicConstructor.subst(iop)
444 decode_block = OperateNopCheckDecode.subst(iop)
445 exec_output = BasicExecute.subst(iop)
446}};
447
448// Integer instruction templates, formats, etc.
449##include "int.isa"
450
451// Floating-point instruction templates, formats, etc.
452##include "fp.isa"
453
454// Memory instruction templates, formats, etc.
455##include "mem.isa"
456
457// Branch/jump instruction templates, formats, etc.
458##include "branch.isa"
459
460// PAL instruction templates, formats, etc.
461##include "pal.isa"
462
463// Opcdec fault instruction templates, formats, etc.
464##include "opcdec.isa"
465
466// Unimplemented instruction templates, formats, etc.
467##include "unimp.isa"
468
469// Unknown instruction templates, formats, etc.
470##include "unknown.isa"
471
472// Execution utility functions
473##include "util.isa"
474
475// The actual decoder
476##include "decoder.isa"