fpop.isa revision 8588:ef28ed90449d 
1// Copyright (c) 2007 The Hewlett-Packard Development Company
2// All rights reserved.
3//
4// The license below extends only to copyright in the software and shall
5// not be construed as granting a license to any other intellectual
6// property including but not limited to intellectual property relating
7// to a hardware implementation of the functionality of the software
8// licensed hereunder.  You may use the software subject to the license
9// terms below provided that you ensure that this notice is replicated
10// unmodified and in its entirety in all distributions of the software,
11// modified or unmodified, in source code or in binary form.
12//
13// Redistribution and use in source and binary forms, with or without
14// modification, are permitted provided that the following conditions are
15// met: redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer;
17// redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution;
20// neither the name of the copyright holders nor the names of its
21// contributors may be used to endorse or promote products derived from
22// this software without specific prior written permission.
23//
24// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
25// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
26// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
27// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
28// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
29// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
30// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
31// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
32// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
33// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
34// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35//
36// Authors: Gabe Black
37
38//////////////////////////////////////////////////////////////////////////
39//
40// FpOp Microop templates
41//
42//////////////////////////////////////////////////////////////////////////
43
44def template MicroFpOpExecute {{
45        Fault %(class_name)s::execute(%(CPU_exec_context)s *xc,
46                Trace::InstRecord *traceData) const
47        {
48            Fault fault = NoFault;
49
50            DPRINTF(X86, "The data size is %d\n", dataSize);
51            %(op_decl)s;
52            %(op_rd)s;
53
54            if(%(cond_check)s)
55            {
56                %(code)s;
57                %(flag_code)s;
58                %(top_code)s;
59            }
60            else
61            {
62                %(else_code)s;
63            }
64
65            //Write the resulting state to the execution context
66            if(fault == NoFault)
67            {
68                %(op_wb)s;
69            }
70            return fault;
71        }
72}};
73
74def template MicroFpOpDeclare {{
75    class %(class_name)s : public %(base_class)s
76    {
77      public:
78        %(class_name)s(ExtMachInst _machInst,
79                const char * instMnem, uint64_t setFlags,
80                InstRegIndex _src1, InstRegIndex _src2, InstRegIndex _dest,
81                uint8_t _dataSize, int8_t _spm);
82
83        %(BasicExecDeclare)s
84    };
85}};
86
87def template MicroFpOpConstructor {{
88    inline %(class_name)s::%(class_name)s(
89            ExtMachInst machInst, const char * instMnem, uint64_t setFlags,
90            InstRegIndex _src1, InstRegIndex _src2, InstRegIndex _dest,
91            uint8_t _dataSize, int8_t _spm) :
92        %(base_class)s(machInst, "%(mnemonic)s", instMnem, setFlags,
93                _src1, _src2, _dest, _dataSize, _spm,
94                %(op_class)s)
95    {
96        %(constructor)s;
97    }
98}};
99
100let {{
101    # Make these empty strings so that concatenating onto
102    # them will always work.
103    header_output = ""
104    decoder_output = ""
105    exec_output = ""
106
107    class FpOpMeta(type):
108        def buildCppClasses(self, name, Name, suffix, \
109                code, flag_code, cond_check, else_code):
110
111            # Globals to stick the output in
112            global header_output
113            global decoder_output
114            global exec_output
115
116            # Stick all the code together so it can be searched at once
117            allCode = "|".join((code, flag_code, cond_check, else_code))
118
119            # If there's something optional to do with flags, generate
120            # a version without it and fix up this version to use it.
121            if flag_code is not "" or cond_check is not "true":
122                self.buildCppClasses(name, Name, suffix,
123                        code, "", "true", else_code)
124                suffix = "Flags" + suffix
125
126            base = "X86ISA::FpOp"
127
128            # Get everything ready for the substitution
129            iop_top = InstObjParams(name, Name + suffix + "Top", base,
130                    {"code" : code,
131                     "flag_code" : flag_code,
132                     "cond_check" : cond_check,
133                     "else_code" : else_code,
134                     "top_code" : "TOP = (TOP + spm + 8) % 8;"})
135            iop = InstObjParams(name, Name + suffix, base,
136                    {"code" : code,
137                     "flag_code" : flag_code,
138                     "cond_check" : cond_check,
139                     "else_code" : else_code,
140                     "top_code" : ";"})
141
142            # Generate the actual code (finally!)
143            header_output += MicroFpOpDeclare.subst(iop_top)
144            decoder_output += MicroFpOpConstructor.subst(iop_top)
145            exec_output += MicroFpOpExecute.subst(iop_top)
146            header_output += MicroFpOpDeclare.subst(iop)
147            decoder_output += MicroFpOpConstructor.subst(iop)
148            exec_output += MicroFpOpExecute.subst(iop)
149
150
151        def __new__(mcls, Name, bases, dict):
152            abstract = False
153            name = Name.lower()
154            if "abstract" in dict:
155                abstract = dict['abstract']
156                del dict['abstract']
157
158            cls = super(FpOpMeta, mcls).__new__(mcls, Name, bases, dict)
159            if not abstract:
160                cls.className = Name
161                cls.mnemonic = name
162                code = cls.code
163                flag_code = cls.flag_code
164                cond_check = cls.cond_check
165                else_code = cls.else_code
166
167                # Set up the C++ classes
168                mcls.buildCppClasses(cls, name, Name, "",
169                        code, flag_code, cond_check, else_code)
170
171                # Hook into the microassembler dict
172                global microopClasses
173                microopClasses[name] = cls
174
175            return cls
176
177
178    class FpOp(X86Microop):
179        __metaclass__ = FpOpMeta
180        # This class itself doesn't act as a microop
181        abstract = True
182
183        # Default template parameter values
184        flag_code = ""
185        cond_check = "true"
186        else_code = ";"
187
188        def __init__(self, dest, src1, src2, spm=0, \
189                SetStatus=False, dataSize="env.dataSize"):
190            self.dest = dest
191            self.src1 = src1
192            self.src2 = src2
193            self.spm = spm
194            self.dataSize = dataSize
195            if SetStatus:
196                self.className += "Flags"
197            if spm:
198                self.className += "Top"
199
200        def getAllocator(self, microFlags):
201            return '''new %(class_name)s(machInst, macrocodeBlock,
202                    %(flags)s, %(src1)s, %(src2)s, %(dest)s,
203                    %(dataSize)s, %(spm)d)''' % {
204                "class_name" : self.className,
205                "flags" : self.microFlagsText(microFlags),
206                "src1" : self.src1, "src2" : self.src2,
207                "dest" : self.dest,
208                "dataSize" : self.dataSize,
209                "spm" : self.spm}
210
211    class Movfp(FpOp):
212        def __init__(self, dest, src1, spm=0, \
213                SetStatus=False, dataSize="env.dataSize"):
214            super(Movfp, self).__init__(dest, src1, "InstRegIndex(0)", \
215                    spm, SetStatus, dataSize)
216        code = 'FpDestReg_uqw = FpSrcReg1_uqw;'
217        else_code = 'FpDestReg_uqw = FpDestReg_uqw;'
218        cond_check = "checkCondition(ccFlagBits, src2)"
219
220    class Xorfp(FpOp):
221        code = 'FpDestReg_uqw = FpSrcReg1_uqw ^ FpSrcReg2_uqw;'
222
223    class Sqrtfp(FpOp):
224        code = 'FpDestReg = sqrt(FpSrcReg2);'
225
226    # Conversion microops
227    class ConvOp(FpOp):
228        abstract = True
229        def __init__(self, dest, src1):
230            super(ConvOp, self).__init__(dest, src1, \
231                    "InstRegIndex(FLOATREG_MICROFP0)")
232
233    # These probably shouldn't look at the ExtMachInst directly to figure
234    # out what size to use and should instead delegate that to the macroop's
235    # constructor. That would be more efficient, and it would make the
236    # microops a little more modular.
237    class cvtf_i2d(ConvOp):
238        code = '''
239            X86IntReg intReg = SSrcReg1;
240            if (REX_W)
241                FpDestReg = intReg.SR;
242            else
243                FpDestReg = intReg.SE;
244            '''
245
246    class cvtf_i2d_hi(ConvOp):
247        code = 'FpDestReg = bits(SSrcReg1, 63, 32);'
248
249    class cvtf_d2i(ConvOp):
250        code = '''
251            int64_t intSrcReg1 = static_cast<int64_t>(FpSrcReg1);
252            if (REX_W)
253                SDestReg = intSrcReg1;
254            else
255                SDestReg = merge(SDestReg, intSrcReg1, 4);
256            '''
257
258    # These need to consider size at some point. They'll always use doubles
259    # for the moment.
260    class addfp(FpOp):
261        code = 'FpDestReg = FpSrcReg1 + FpSrcReg2;'
262
263    class mulfp(FpOp):
264        code = 'FpDestReg = FpSrcReg1 * FpSrcReg2;'
265
266    class divfp(FpOp):
267        code = 'FpDestReg = FpSrcReg1 / FpSrcReg2;'
268
269    class subfp(FpOp):
270        code = 'FpDestReg = FpSrcReg1 - FpSrcReg2;'
271
272    class Compfp(FpOp):
273        def __init__(self, src1, src2, spm=0, setStatus=False, \
274                dataSize="env.dataSize"):
275            super(Compfp, self).__init__("InstRegIndex(FLOATREG_MICROFP0)", \
276                    src1, src2, spm, setStatus, dataSize)
277        # This class sets the condition codes in rflags according to the
278        # rules for comparing floating point.
279        code = '''
280            //               ZF PF CF
281            // Unordered      1  1  1
282            // Greater than   0  0  0
283            // Less than      0  0  1
284            // Equal          1  0  0
285            //           OF = SF = AF = 0
286            ccFlagBits = ccFlagBits & ~(OFBit | SFBit | AFBit |
287                                        ZFBit | PFBit | CFBit);
288            if (isnan(FpSrcReg1) || isnan(FpSrcReg2))
289                ccFlagBits = ccFlagBits | (ZFBit | PFBit | CFBit);
290            else if(FpSrcReg1 < FpSrcReg2)
291                ccFlagBits = ccFlagBits | CFBit;
292            else if(FpSrcReg1 == FpSrcReg2)
293                ccFlagBits = ccFlagBits | ZFBit;
294        '''
295}};
296