1// -*- mode:c++ -*-
2
3// Copyright (c) 2006 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// Korey Sewell
31
32// Declarations for execute() methods.
33def template BasicExecDeclare {{
34 Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const;
35}};
36
37// Basic instruction class declaration template.
38def template BasicDeclare {{
39 /**
40 * Static instruction class for "%(mnemonic)s".
41 */
42 class %(class_name)s : public %(base_class)s
43 {
44 public:
45 /// Constructor.
46 %(class_name)s(MachInst machInst);
47 %(BasicExecDeclare)s
48 };
49}};
50
51// Basic instruction class constructor template.
52def template BasicConstructor {{
53 inline %(class_name)s::%(class_name)s(MachInst machInst) : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
54 {
55 %(constructor)s;
56 }
57}};
58
59
60// Basic instruction class execute method template.
61def template BasicExecute {{
62 Fault %(class_name)s::execute(%(CPU_exec_context)s *xc, Trace::InstRecord *traceData) const
63 {
64 Fault fault = NoFault;
65
66 %(fp_enable_check)s;
67 %(op_decl)s;
68 %(op_rd)s;
69 %(code)s;
70
71 if(fault == NoFault)
72 {
73 %(op_wb)s;
74 }
75 return fault;
76 }
77}};
78
79// Basic decode template.
80def template BasicDecode {{
81 return new %(class_name)s(machInst);
82}};
83
84// Basic decode template, passing mnemonic in as string arg to constructor.
85def template BasicDecodeWithMnemonic {{
86 return new %(class_name)s("%(mnemonic)s", machInst);
87}};
88
89// The most basic instruction format...
90def format BasicOp(code, *flags) {{
91 iop = InstObjParams(name, Name, 'MipsStaticInst', code, flags)
92 header_output = BasicDeclare.subst(iop)
93 decoder_output = BasicConstructor.subst(iop)
94 decode_block = BasicDecode.subst(iop)
95 exec_output = BasicExecute.subst(iop)
96}};