limmop.isa revision 4792 
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// LIMMOp Microop templates
59//
60//////////////////////////////////////////////////////////////////////////
61
62def template MicroLimmOpExecute {{
63        Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
64                Trace::InstRecord *traceData) const
65        {
66            %(op_decl)s;
67            %(op_rd)s;
68            %(code)s;
69            %(op_wb)s;
70            return NoFault;
71        }
72}};
73
74def template MicroLimmOpDeclare {{
75    class %(class_name)s : public X86ISA::X86MicroopBase
76    {
77      protected:
78        const RegIndex dest;
79        const uint64_t imm;
80        const uint8_t dataSize;
81        void buildMe();
82
83        std::string generateDisassembly(Addr pc,
84            const SymbolTable *symtab) const;
85
86      public:
87        %(class_name)s(ExtMachInst _machInst,
88                const char * instMnem,
89                bool isMicro, bool isDelayed, bool isFirst, bool isLast,
90                RegIndex _dest, uint64_t _imm, uint8_t _dataSize);
91
92        %(class_name)s(ExtMachInst _machInst,
93                const char * instMnem,
94                RegIndex _dest, uint64_t _imm, uint8_t _dataSize);
95
96        %(BasicExecDeclare)s
97    };
98}};
99
100def template MicroLimmOpDisassembly {{
101    std::string %(class_name)s::generateDisassembly(Addr pc,
102            const SymbolTable *symtab) const
103    {
104        std::stringstream response;
105
106        printMnemonic(response, instMnem, mnemonic);
107        printReg(response, dest, dataSize);
108        response << ", ";
109        ccprintf(response, "%#x", imm);
110        return response.str();
111    }
112}};
113
114def template MicroLimmOpConstructor {{
115
116    inline void %(class_name)s::buildMe()
117    {
118        %(constructor)s;
119    }
120
121    inline %(class_name)s::%(class_name)s(
122            ExtMachInst machInst, const char * instMnem,
123            RegIndex _dest, uint64_t _imm, uint8_t _dataSize) :
124        %(base_class)s(machInst, "%(mnemonic)s", instMnem,
125                false, false, false, false, %(op_class)s),
126                dest(_dest), imm(_imm), dataSize(_dataSize)
127    {
128        buildMe();
129    }
130
131    inline %(class_name)s::%(class_name)s(
132            ExtMachInst machInst, const char * instMnem,
133            bool isMicro, bool isDelayed, bool isFirst, bool isLast,
134            RegIndex _dest, uint64_t _imm, uint8_t _dataSize) :
135        %(base_class)s(machInst, "%(mnemonic)s", instMnem,
136                isMicro, isDelayed, isFirst, isLast, %(op_class)s),
137                dest(_dest), imm(_imm), dataSize(_dataSize)
138    {
139        buildMe();
140    }
141}};
142
143let {{
144    class LimmOp(X86Microop):
145        def __init__(self, dest, imm, dataSize="env.dataSize"):
146            self.className = "Limm"
147            self.mnemonic = "limm"
148            self.dest = dest
149            self.imm = imm
150            self.dataSize = dataSize
151
152        def getAllocator(self, *microFlags):
153            allocator = '''new %(class_name)s(machInst, mnemonic
154                    %(flags)s, %(dest)s, %(imm)s, %(dataSize)s)''' % {
155                "class_name" : self.className,
156                "mnemonic" : self.mnemonic,
157                "flags" : self.microFlagsText(microFlags),
158                "dest" : self.dest, "imm" : self.imm,
159                "dataSize" : self.dataSize}
160            return allocator
161
162    microopClasses["limm"] = LimmOp
163}};
164
165let {{
166    # Build up the all register version of this micro op
167    iop = InstObjParams("limm", "Limm", 'X86MicroopBase',
168            {"code" : "DestReg = merge(DestReg, imm, dataSize);"})
169    header_output += MicroLimmOpDeclare.subst(iop)
170    decoder_output += MicroLimmOpConstructor.subst(iop)
171    decoder_output += MicroLimmOpDisassembly.subst(iop)
172    exec_output += MicroLimmOpExecute.subst(iop)
173}};
174