basic.isa revision 3272 
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// Basic instruction class declaration template.
37def template BasicDeclare {{
38        /**
39         * Static instruction class for "%(mnemonic)s".
40         */
41        class %(class_name)s : public %(base_class)s
42        {
43          public:
44            // Constructor.
45            %(class_name)s(MachInst machInst);
46            %(BasicExecDeclare)s
47        };
48}};
49
50// Basic instruction class constructor template.
51def template BasicConstructor {{
52        inline %(class_name)s::%(class_name)s(MachInst machInst)
53            : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
54        {
55                %(constructor)s;
56        }
57}};
58
59// Basic instruction class execute method template.
60def template BasicExecute {{
61        Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
62                Trace::InstRecord *traceData) const
63        {
64            Fault fault = NoFault;
65
66            %(op_decl)s;
67            %(op_rd)s;
68            %(code)s;
69
70            if(fault == NoFault)
71            {
72                %(op_wb)s;
73            }
74            return fault;
75        }
76}};
77
78// Basic decode template.
79def template BasicDecode {{
80        return new %(class_name)s(machInst);
81}};
82
83// Basic decode template, passing mnemonic in as string arg to constructor.
84def template BasicDecodeWithMnemonic {{
85    return new %(class_name)s("%(mnemonic)s", machInst);
86}};
87
88// The most basic instruction format... used only for a few misc. insts
89def format BasicOperate(code, *flags) {{
90        iop = InstObjParams(name, Name, 'SparcStaticInst',
91                CodeBlock(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}};
97