basic.isa revision 10196:be0e1724eb39 
1// -*- mode:c++ -*-
2
3// Copyright (c) 2011 ARM Limited
4// All rights reserved
5//
6// The license below extends only to copyright in the software and shall
7// not be construed as granting a license to any other intellectual
8// property including but not limited to intellectual property relating
9// to a hardware implementation of the functionality of the software
10// licensed hereunder.  You may use the software subject to the license
11// terms below provided that you ensure that this notice is replicated
12// unmodified and in its entirety in all distributions of the software,
13// modified or unmodified, in source code or in binary form.
14//
15// Copyright (c) 2007-2008 The Florida State University
16// All rights reserved.
17//
18// Redistribution and use in source and binary forms, with or without
19// modification, are permitted provided that the following conditions are
20// met: redistributions of source code must retain the above copyright
21// notice, this list of conditions and the following disclaimer;
22// redistributions in binary form must reproduce the above copyright
23// notice, this list of conditions and the following disclaimer in the
24// documentation and/or other materials provided with the distribution;
25// neither the name of the copyright holders nor the names of its
26// contributors may be used to endorse or promote products derived from
27// this software without specific prior written permission.
28//
29// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
30// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
31// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
32// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
33// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
34// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
35// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
36// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
37// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
38// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
39// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40//
41// Authors: Stephen Hines
42
43// Declarations for execute() methods.
44def template BasicExecDeclare {{
45        Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const;
46}};
47
48// Basic instruction class declaration template.
49def template BasicDeclare {{
50        /**
51         * Static instruction class for "%(mnemonic)s".
52         */
53        class %(class_name)s : public %(base_class)s
54        {
55          public:
56                /// Constructor.
57                %(class_name)s(ExtMachInst machInst);
58                %(BasicExecDeclare)s
59        };
60}};
61
62// Basic instruction class constructor template.
63def template BasicConstructor {{
64        %(class_name)s::%(class_name)s(ExtMachInst machInst)  : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
65        {
66                %(constructor)s;
67                if (!(condCode == COND_AL || condCode == COND_UC)) {
68                    for (int x = 0; x < _numDestRegs; x++) {
69                        _srcRegIdx[_numSrcRegs++] = _destRegIdx[x];
70                    }
71                }
72        }
73}};
74
75def template BasicConstructor64 {{
76        %(class_name)s::%(class_name)s(ExtMachInst machInst)  : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
77        {
78            %(constructor)s;
79        }
80}};
81
82
83// Basic instruction class execute method template.
84def template BasicExecute {{
85        Fault %(class_name)s::execute(CPU_EXEC_CONTEXT *xc, Trace::InstRecord *traceData) const
86        {
87                Fault fault = NoFault;
88
89                %(op_decl)s;
90                %(op_rd)s;
91                %(code)s;
92
93                if (fault == NoFault)
94                {
95                    %(op_wb)s;
96                }
97                return fault;
98        }
99}};
100
101// Basic decode template.
102def template BasicDecode {{
103        return new %(class_name)s(machInst);
104}};
105
106// Basic decode template, passing mnemonic in as string arg to constructor.
107def template BasicDecodeWithMnemonic {{
108        return new %(class_name)s("%(mnemonic)s", machInst);
109}};
110
111// Definitions of execute methods that panic.
112def template BasicExecPanic {{
113Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
114{
115        panic("Execute method called when it shouldn't!");
116        // GCC < 4.3 fail to recognize the above panic as no return
117        return NoFault;
118}
119}};
120