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