macroop.isa revision 4343:3f11bcf873b3 
1// -*- mode:c++ -*-
2
3// Copyright (c) 2007 The Hewlett-Packard Development Company
4// All rights reserved.
5//
6// Redistribution and use of this software in source and binary forms,
7// with or without modification, are permitted provided that the
8// following conditions are met:
9//
10// The software must be used only for Non-Commercial Use which means any
11// use which is NOT directed to receiving any direct monetary
12// compensation for, or commercial advantage from such use.  Illustrative
13// examples of non-commercial use are academic research, personal study,
14// teaching, education and corporate research & development.
15// Illustrative examples of commercial use are distributing products for
16// commercial advantage and providing services using the software for
17// commercial advantage.
18//
19// If you wish to use this software or functionality therein that may be
20// covered by patents for commercial use, please contact:
21//     Director of Intellectual Property Licensing
22//     Office of Strategy and Technology
23//     Hewlett-Packard Company
24//     1501 Page Mill Road
25//     Palo Alto, California  94304
26//
27// Redistributions of source code must retain the above copyright notice,
28// this list of conditions and the following disclaimer.  Redistributions
29// in binary form must reproduce the above copyright notice, this list of
30// conditions and the following disclaimer in the documentation and/or
31// other materials provided with the distribution.  Neither the name of
32// the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
33// contributors may be used to endorse or promote products derived from
34// this software without specific prior written permission.  No right of
35// sublicense is granted herewith.  Derivatives of the software and
36// output created using the software may be prepared, but only for
37// Non-Commercial Uses.  Derivatives of the software may be shared with
38// others provided: (i) the others agree to abide by the list of
39// conditions herein which includes the Non-Commercial Use restrictions;
40// and (ii) such Derivatives of the software include the above copyright
41// notice to acknowledge the contribution from this software where
42// applicable, this list of conditions and the disclaimer below.
43//
44// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
45// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
46// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
47// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
48// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
49// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
50// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
51// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
52// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
53// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
54// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
55//
56// Authors: Gabe Black
57
58// Execute method for macroops.
59def template MacroExecPanic {{
60        Fault execute(%(CPU_exec_context)s *, Trace::InstRecord *) const
61        {
62            panic("Tried to execute macroop directly!");
63            M5_DUMMY_RETURN
64        }
65}};
66
67output header {{
68
69        // Base class for most macroops, except ones that need to commit as
70        // they go.
71        class X86MacroInst : public StaticInst
72        {
73          protected:
74            const uint32_t numMicroOps;
75
76            //Constructor.
77            X86MacroInst(const char *mnem, ExtMachInst _machInst,
78                    uint32_t _numMicroOps)
79                        : StaticInst(mnem, _machInst, No_OpClass),
80                        numMicroOps(_numMicroOps)
81            {
82                assert(numMicroOps);
83                microOps = new StaticInstPtr[numMicroOps];
84                flags[IsMacroOp] = true;
85            }
86
87            ~X86MacroInst()
88            {
89                delete [] microOps;
90            }
91
92            StaticInstPtr * microOps;
93
94            StaticInstPtr fetchMicroOp(MicroPC microPC)
95            {
96                assert(microPC < numMicroOps);
97                return microOps[microPC];
98            }
99
100            %(MacroExecPanic)s
101        };
102}};
103
104// Basic instruction class constructor template.
105def template MacroConstructor {{
106        inline %(class_name)s::%(class_name)s(ExtMachInst machInst)
107            : %(base_class)s("%(mnemonic)s", machInst, %(num_micro_ops)s)
108        {
109                %(constructor)s;
110                //alloc_micro_ops is the code that sets up the microOps
111                //array in the parent class.
112                %(alloc_micro_ops)s;
113        }
114}};
115
116let {{
117    def genMacroOp(name, Name, opSeq):
118        baseClass = 'X86MacroInst'
119        numMicroOps = len(opSeq.ops)
120        allocMicroOps = ''
121        micropc = 0
122        for op in opSeq.ops:
123            allocMicroOps += \
124                "microOps[%d] = %s;\n" % \
125                (micropc, op.getAllocator(True, op.delayed,
126                                          micropc == 0,
127                                          micropc == numMicroOps - 1))
128            micropc += 1
129        iop = InstObjParams(name, Name, baseClass,
130                {'code' : '', 'num_micro_ops' : numMicroOps,
131                'alloc_micro_ops' : allocMicroOps})
132        header_output = BasicDeclare.subst(iop)
133        decoder_output = MacroConstructor.subst(iop)
134        decode_block = BasicDecode.subst(iop)
135        exec_output = ''
136        return (header_output, decoder_output, decode_block, exec_output)
137}};
138