basic.isa revision 12616:4b463b4dc098 
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// Basic instruction class declaration template.
44def template BasicDeclare {{
45        /**
46         * Static instruction class for "%(mnemonic)s".
47         */
48        class %(class_name)s : public %(base_class)s
49        {
50          public:
51                /// Constructor.
52                %(class_name)s(ExtMachInst machInst);
53                Fault execute(ExecContext *,
54                              Trace::InstRecord *) const override;
55        };
56}};
57
58// Basic instruction class constructor template.
59def template BasicConstructor {{
60        %(class_name)s::%(class_name)s(ExtMachInst machInst)  : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
61        {
62                %(constructor)s;
63                if (!(condCode == COND_AL || condCode == COND_UC)) {
64                    for (int x = 0; x < _numDestRegs; x++) {
65                        _srcRegIdx[_numSrcRegs++] = _destRegIdx[x];
66                    }
67                }
68        }
69}};
70
71def template BasicConstructor64 {{
72        %(class_name)s::%(class_name)s(ExtMachInst machInst)  : %(base_class)s("%(mnemonic)s", machInst, %(op_class)s)
73        {
74            %(constructor)s;
75        }
76}};
77
78
79// Basic instruction class execute method template.
80def template BasicExecute {{
81        Fault %(class_name)s::execute(
82            ExecContext *xc, Trace::InstRecord *traceData) const
83        {
84                Fault fault = NoFault;
85
86                %(op_decl)s;
87                %(op_rd)s;
88                %(code)s;
89
90                if (fault == NoFault)
91                {
92                    %(op_wb)s;
93                }
94                return fault;
95        }
96}};
97
98// Basic decode template.
99def template BasicDecode {{
100        return new %(class_name)s(machInst);
101}};
102
103// Basic decode template, passing mnemonic in as string arg to constructor.
104def template BasicDecodeWithMnemonic {{
105        return new %(class_name)s("%(mnemonic)s", machInst);
106}};
107