limmop.isa revision 6524
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        RegIndex foldOBit;
82        void buildMe();
83
84        std::string generateDisassembly(Addr pc,
85            const SymbolTable *symtab) const;
86
87      public:
88        %(class_name)s(ExtMachInst _machInst,
89                const char * instMnem,
90                bool isMicro, bool isDelayed, bool isFirst, bool isLast,
91                InstRegIndex _dest, uint64_t _imm, uint8_t _dataSize);
92
93        %(class_name)s(ExtMachInst _machInst,
94                const char * instMnem,
95                InstRegIndex _dest, uint64_t _imm, uint8_t _dataSize);
96
97        %(BasicExecDeclare)s
98    };
99}};
100
101def template MicroLimmOpDisassembly {{
102    std::string %(class_name)s::generateDisassembly(Addr pc,
103            const SymbolTable *symtab) const
104    {
105        std::stringstream response;
106
107        printMnemonic(response, instMnem, mnemonic);
108        printDestReg(response, 0, dataSize);
109        response << ", ";
110        ccprintf(response, "%#x", imm);
111        return response.str();
112    }
113}};
114
115def template MicroLimmOpConstructor {{
116
117    inline void %(class_name)s::buildMe()
118    {
119        foldOBit = (dataSize == 1 && !machInst.rex.present) ? 1 << 6 : 0;
120        %(constructor)s;
121    }
122
123    inline %(class_name)s::%(class_name)s(
124            ExtMachInst machInst, const char * instMnem,
125            InstRegIndex _dest, uint64_t _imm, uint8_t _dataSize) :
126        %(base_class)s(machInst, "%(mnemonic)s", instMnem,
127                false, false, false, false, %(op_class)s),
128                dest(_dest.idx), imm(_imm), dataSize(_dataSize)
129    {
130        buildMe();
131    }
132
133    inline %(class_name)s::%(class_name)s(
134            ExtMachInst machInst, const char * instMnem,
135            bool isMicro, bool isDelayed, bool isFirst, bool isLast,
136            InstRegIndex _dest, uint64_t _imm, uint8_t _dataSize) :
137        %(base_class)s(machInst, "%(mnemonic)s", instMnem,
138                isMicro, isDelayed, isFirst, isLast, %(op_class)s),
139                dest(_dest.idx), imm(_imm), dataSize(_dataSize)
140    {
141        buildMe();
142    }
143}};
144
145let {{
146    class LimmOp(X86Microop):
147        def __init__(self, dest, imm, dataSize="env.dataSize"):
148            self.className = "Limm"
149            self.mnemonic = "limm"
150            self.dest = dest
151            if isinstance(imm, (int, long)):
152                imm = "ULL(%d)" % imm
153            self.imm = imm
154            self.dataSize = dataSize
155
156        def getAllocator(self, *microFlags):
157            allocator = '''new %(class_name)s(machInst, macrocodeBlock
158                    %(flags)s, %(dest)s, %(imm)s, %(dataSize)s)''' % {
159                "class_name" : self.className,
160                "mnemonic" : self.mnemonic,
161                "flags" : self.microFlagsText(microFlags),
162                "dest" : self.dest, "imm" : self.imm,
163                "dataSize" : self.dataSize}
164            return allocator
165
166    microopClasses["limm"] = LimmOp
167
168    class LfpimmOp(X86Microop):
169        def __init__(self, dest, imm, dataSize="env.dataSize"):
170            self.className = "Lfpimm"
171            self.mnemonic = "lfpimm"
172            self.dest = dest
173            if isinstance(imm, (int, long)):
174                imm = "ULL(%d)" % imm
175            if isinstance(imm, float):
176                imm = "reinterpret_cast<uint64_t>((double)(%d))"
177            self.imm = imm
178            self.dataSize = dataSize
179
180        def getAllocator(self, *microFlags):
181            allocator = '''new %(class_name)s(machInst, macrocodeBlock
182                    %(flags)s, %(dest)s, %(imm)s, %(dataSize)s)''' % {
183                "class_name" : self.className,
184                "mnemonic" : self.mnemonic,
185                "flags" : self.microFlagsText(microFlags),
186                "dest" : self.dest, "imm" : self.imm,
187                "dataSize" : self.dataSize}
188            return allocator
189
190    microopClasses["lfpimm"] = LfpimmOp
191}};
192
193let {{
194    # Build up the all register version of this micro op
195    iop = InstObjParams("limm", "Limm", 'X86MicroopBase',
196            {"code" : "DestReg = merge(DestReg, imm, dataSize);"})
197    header_output += MicroLimmOpDeclare.subst(iop)
198    decoder_output += MicroLimmOpConstructor.subst(iop)
199    decoder_output += MicroLimmOpDisassembly.subst(iop)
200    exec_output += MicroLimmOpExecute.subst(iop)
201
202    iop = InstObjParams("lfpimm", "Lfpimm", 'X86MicroopBase',
203            {"code" : "FpDestReg.uqw = imm"})
204    header_output += MicroLimmOpDeclare.subst(iop)
205    decoder_output += MicroLimmOpConstructor.subst(iop)
206    decoder_output += MicroLimmOpDisassembly.subst(iop)
207    exec_output += MicroLimmOpExecute.subst(iop)
208}};
209