specop.isa revision 4539:6eeeea62b7c4 
1// Copyright (c) 2007 The Hewlett-Packard Development Company
2// All rights reserved.
3//
4// Redistribution and use of this software in source and binary forms,
5// with or without modification, are permitted provided that the
6// following conditions are met:
7//
8// The software must be used only for Non-Commercial Use which means any
9// use which is NOT directed to receiving any direct monetary
10// compensation for, or commercial advantage from such use.  Illustrative
11// examples of non-commercial use are academic research, personal study,
12// teaching, education and corporate research & development.
13// Illustrative examples of commercial use are distributing products for
14// commercial advantage and providing services using the software for
15// commercial advantage.
16//
17// If you wish to use this software or functionality therein that may be
18// covered by patents for commercial use, please contact:
19//     Director of Intellectual Property Licensing
20//     Office of Strategy and Technology
21//     Hewlett-Packard Company
22//     1501 Page Mill Road
23//     Palo Alto, California  94304
24//
25// Redistributions of source code must retain the above copyright notice,
26// this list of conditions and the following disclaimer.  Redistributions
27// in binary form must reproduce the above copyright notice, this list of
28// conditions and the following disclaimer in the documentation and/or
29// other materials provided with the distribution.  Neither the name of
30// the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
31// contributors may be used to endorse or promote products derived from
32// this software without specific prior written permission.  No right of
33// sublicense is granted herewith.  Derivatives of the software and
34// output created using the software may be prepared, but only for
35// Non-Commercial Uses.  Derivatives of the software may be shared with
36// others provided: (i) the others agree to abide by the list of
37// conditions herein which includes the Non-Commercial Use restrictions;
38// and (ii) such Derivatives of the software include the above copyright
39// notice to acknowledge the contribution from this software where
40// applicable, this list of conditions and the disclaimer below.
41//
42// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
43// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
44// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
45// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
46// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
47// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
48// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
49// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
50// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
51// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
52// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
53//
54// Authors: Gabe Black
55
56//////////////////////////////////////////////////////////////////////////
57//
58// Fault Microop
59//
60//////////////////////////////////////////////////////////////////////////
61
62def template MicroFaultExecute {{
63        Fault %(class_name)s ::execute(%(CPU_exec_context)s *xc,
64                Trace::InstRecord *traceData) const
65        {
66            //Return the fault we were constructed with
67            return fault;
68        }
69}};
70
71def template MicroFaultDeclare {{
72    class %(class_name)s : public X86MicroopBase
73    {
74      protected:
75        Fault fault;
76        void buildMe();
77
78      public:
79        %(class_name)s(ExtMachInst _machInst,
80                const char * instMnem,
81                bool isMicro, bool isDelayed, bool isFirst, bool isLast,
82                Fault _fault);
83
84        %(class_name)s(ExtMachInst _machInst,
85                const char * instMnem,
86                Fault _fault);
87
88        %(BasicExecDeclare)s
89    };
90}};
91
92def template MicroFaultConstructor {{
93
94    inline void %(class_name)s::buildMe()
95    {
96        %(constructor)s;
97    }
98
99    inline %(class_name)s::%(class_name)s(
100            ExtMachInst machInst, const char * instMnem, Fault _fault) :
101        %(base_class)s(machInst, "%(mnemonic)s", instMnem,
102                false, false, false, false, %(op_class)s), fault(_fault)
103    {
104        buildMe();
105    }
106
107    inline %(class_name)s::%(class_name)s(
108            ExtMachInst machInst, const char * instMnem,
109            bool isMicro, bool isDelayed, bool isFirst, bool isLast,
110            Fault _fault) :
111        %(base_class)s(machInst, "%(mnemonic)s", instMnem,
112                isMicro, isDelayed, isFirst, isLast, %(op_class)s),
113                fault(_fault)
114    {
115        buildMe();
116    }
117}};
118
119let {{
120    # This microop takes in a single parameter, a fault to return.
121    iop = InstObjParams("fault", "GenFault", 'X86MicroopBase', {"code" : ""})
122    header_output += MicroFaultDeclare.subst(iop)
123    decoder_output += MicroFaultConstructor.subst(iop)
124    exec_output += MicroFaultExecute.subst(iop)
125}};
126