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