basic.isa revision 3275 
1// Copyright (c) 2006 The Regents of The University of Michigan
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met: redistributions of source code must retain the above copyright
7// notice, this list of conditions and the following disclaimer;
8// redistributions in binary form must reproduce the above copyright
9// notice, this list of conditions and the following disclaimer in the
10// documentation and/or other materials provided with the distribution;
11// neither the name of the copyright holders nor the names of its
12// contributors may be used to endorse or promote products derived from
13// this software without specific prior written permission.
14//
15// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
19// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26//
27// Authors: Ali Saidi
28//          Gabe Black
29//          Steve Reinhardt
30
31// Declarations for execute() methods.
32def template BasicExecDeclare {{
33        Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const;
34}};
35
36// Definitions of execute methods that panic.
37def template BasicExecPanic {{
38        Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
39        {
40            panic("Execute method called when it shouldn't!");
41        }
42}};
43
44// Basic instruction class declaration template.
45def template BasicDeclare {{
46        /**
47         * Static instruction class for "%(mnemonic)s".
48         */
49        class %(class_name)s : public %(base_class)s
50        {
51          public:
52            // Constructor.
53            %(class_name)s(MachInst machInst);
54            %(BasicExecDeclare)s
55        };
56}};
57
58// Basic instruction class constructor template.
59def template BasicConstructor {{
60        inline %(class_name)s::%(class_name)s(MachInst machInst)
61            : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
62        {
63                %(constructor)s;
64        }
65}};
66
67// Basic instruction class execute method template.
68def template BasicExecute {{
69        Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
70                Trace::InstRecord *traceData) const
71        {
72            Fault fault = NoFault;
73
74            %(op_decl)s;
75            %(op_rd)s;
76            %(code)s;
77
78            if(fault == NoFault)
79            {
80                %(op_wb)s;
81            }
82            return fault;
83        }
84}};
85
86// Basic decode template.
87def template BasicDecode {{
88        return new %(class_name)s(machInst);
89}};
90
91// Basic decode template, passing mnemonic in as string arg to constructor.
92def template BasicDecodeWithMnemonic {{
93    return new %(class_name)s("%(mnemonic)s", machInst);
94}};
95
96// The most basic instruction format... used only for a few misc. insts
97def format BasicOperate(code, *flags) {{
98        iop = InstObjParams(name, Name, 'SparcStaticInst',
99                CodeBlock(code), flags)
100        header_output = BasicDeclare.subst(iop)
101        decoder_output = BasicConstructor.subst(iop)
102        decode_block = BasicDecode.subst(iop)
103        exec_output = BasicExecute.subst(iop)
104}};
105