data64.isa revision 12508
1// -*- mode:c++ -*-
2
3// Copyright (c) 2011-2013, 2016-2018 ARM Limited
4// All rights reserved
5//
6// The license below extends only to copyright in the software and shall
7// not be construed as granting a license to any other intellectual
8// property including but not limited to intellectual property relating
9// to a hardware implementation of the functionality of the software
10// licensed hereunder.  You may use the software subject to the license
11// terms below provided that you ensure that this notice is replicated
12// unmodified and in its entirety in all distributions of the software,
13// modified or unmodified, in source code or in binary form.
14//
15// Redistribution and use in source and binary forms, with or without
16// modification, are permitted provided that the following conditions are
17// met: redistributions of source code must retain the above copyright
18// notice, this list of conditions and the following disclaimer;
19// redistributions in binary form must reproduce the above copyright
20// notice, this list of conditions and the following disclaimer in the
21// documentation and/or other materials provided with the distribution;
22// neither the name of the copyright holders nor the names of its
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Authors: Gabe Black
39
40let {{
41
42    header_output = ""
43    decoder_output = ""
44    exec_output = ""
45
46    def createCcCode64(carry, overflow):
47        code = ""
48        code += '''
49            uint16_t _iz, _in;
50            _in = bits(resTemp, intWidth - 1);
51            _iz = ((resTemp & mask(intWidth)) == 0);
52            CondCodesNZ = (_in << 1) | _iz;
53            DPRINTF(Arm, "(in, iz) = (%d, %d)\\n", _in, _iz);
54        '''
55        if overflow and overflow != "none":
56            code +=  '''
57                uint16_t _iv;
58                _iv = %s & 1;
59                CondCodesV = _iv;
60                DPRINTF(Arm, "(iv) = (%%d)\\n", _iv);
61            ''' % overflow
62        if carry and carry != "none":
63            code += '''
64                uint16_t _ic;
65                _ic = %s & 1;
66                CondCodesC = _ic;
67                DPRINTF(Arm, "(ic) = (%%d)\\n", _ic);
68            ''' % carry
69        return code
70
71    oldC = 'CondCodesC'
72    oldV = 'CondCodesV'
73    # Dicts of ways to set the carry flag.
74    carryCode64 = {
75        "none": "none",
76        "add": 'findCarry(intWidth, resTemp, Op164, secOp)',
77        "sub": 'findCarry(intWidth, resTemp, Op164, ~secOp)',
78        "logic": '0'
79    }
80    # Dict of ways to set the overflow flag.
81    overflowCode64 = {
82        "none": "none",
83        "add": 'findOverflow(intWidth, resTemp, Op164, secOp)',
84        "sub": 'findOverflow(intWidth, resTemp, Op164, ~secOp)',
85        "logic": '0'
86    }
87
88    immOp2 = "uint64_t secOp M5_VAR_USED = imm;"
89    sRegOp2 = "uint64_t secOp M5_VAR_USED = " + \
90              "shiftReg64(Op264, shiftAmt, shiftType, intWidth);"
91    eRegOp2 = "uint64_t secOp M5_VAR_USED = " + \
92              "extendReg64(Op264, extendType, shiftAmt, intWidth);"
93
94    def buildDataWork(mnem, code, flagType, suffix, buildCc, buildNonCc,
95                      base, templateBase):
96        code = '''
97        uint64_t resTemp M5_VAR_USED = 0;
98        ''' + code
99        ccCode = createCcCode64(carryCode64[flagType], overflowCode64[flagType])
100        Name = mnem.capitalize() + suffix
101        iop = InstObjParams(mnem, Name, base, code)
102        iopCc = InstObjParams(mnem + "s", Name + "Cc", base, code + ccCode)
103
104        def subst(iop):
105            global header_output, decoder_output, exec_output
106            header_output += eval(templateBase + "Declare").subst(iop)
107            decoder_output += eval(templateBase + "Constructor").subst(iop)
108            exec_output += BasicExecute.subst(iop)
109
110        if buildNonCc:
111            subst(iop)
112        if buildCc:
113            subst(iopCc)
114
115    def buildXImmDataInst(mnem, code, flagType = "logic", \
116                          buildCc = True, buildNonCc = True, \
117                          suffix = "XImm"):
118        buildDataWork(mnem, immOp2 + code, flagType, suffix,
119                      buildCc, buildNonCc, "DataXImmOp", "DataXImm")
120
121    def buildXSRegDataInst(mnem, code, flagType = "logic", \
122                           buildCc = True, buildNonCc = True, \
123                           suffix = "XSReg"):
124        buildDataWork(mnem, sRegOp2 + code, flagType, suffix,
125                      buildCc, buildNonCc, "DataXSRegOp", "DataXSReg")
126
127    def buildXERegDataInst(mnem, code, flagType = "logic", \
128                           buildCc = True, buildNonCc = True, \
129                           suffix = "XEReg"):
130        buildDataWork(mnem, eRegOp2 + code, flagType, suffix,
131                      buildCc, buildNonCc, "DataXERegOp", "DataXEReg")
132
133    def buildDataInst(mnem, code, flagType = "logic",
134                      buildCc = True, buildNonCc = True):
135        buildXImmDataInst(mnem, code, flagType, buildCc, buildNonCc)
136        buildXSRegDataInst(mnem, code, flagType, buildCc, buildNonCc)
137        buildXERegDataInst(mnem, code, flagType, buildCc, buildNonCc)
138
139    buildXImmDataInst("adr", "Dest64 = RawPC + imm", buildCc = False);
140    buildXImmDataInst("adrp", "Dest64 = (RawPC & ~mask(12)) + imm",
141                      buildCc = False);
142    buildDataInst("and", "Dest64 = resTemp = Op164 & secOp;")
143    buildDataInst("eor", "Dest64 = Op164 ^ secOp;", buildCc = False)
144    buildXSRegDataInst("eon", "Dest64 = Op164 ^ ~secOp;", buildCc = False)
145    buildDataInst("sub", "Dest64 = resTemp = Op164 - secOp;", "sub")
146    buildDataInst("add", "Dest64 = resTemp = Op164 + secOp;", "add")
147    buildXSRegDataInst("adc",
148            "Dest64 = resTemp = Op164 + secOp + %s;" % oldC, "add")
149    buildXSRegDataInst("sbc",
150            "Dest64 = resTemp = Op164 - secOp - !%s;" % oldC, "sub")
151    buildDataInst("orr", "Dest64 = Op164 | secOp;", buildCc = False)
152    buildXSRegDataInst("orn", "Dest64 = Op164 | ~secOp;", buildCc = False)
153    buildXSRegDataInst("bic", "Dest64 = resTemp = Op164 & ~secOp;")
154
155    def buildDataXImmInst(mnem, code, optArgs = []):
156        global header_output, decoder_output, exec_output
157        classNamePrefix = mnem[0].upper() + mnem[1:]
158        templateBase = "DataXImm"
159        iop = InstObjParams(mnem, classNamePrefix + "64",
160                            templateBase + "Op", code, optArgs)
161        header_output += eval(templateBase + "Declare").subst(iop)
162        decoder_output += eval(templateBase + "Constructor").subst(iop)
163        exec_output += BasicExecute.subst(iop)
164
165    def buildDataXRegInst(mnem, regOps, code, optArgs = [],
166                          overrideOpClass=None):
167        global header_output, decoder_output, exec_output
168        templateBase = "DataX%dReg" % regOps
169        classNamePrefix = mnem[0].upper() + mnem[1:]
170        if overrideOpClass:
171            iop = InstObjParams(mnem, classNamePrefix + "64",
172                                templateBase + "Op",
173                                { 'code': code, 'op_class': overrideOpClass},
174                                optArgs)
175        else:
176            iop = InstObjParams(mnem, classNamePrefix + "64",
177                                templateBase + "Op", code, optArgs)
178        header_output += eval(templateBase + "Declare").subst(iop)
179        decoder_output += eval(templateBase + "Constructor").subst(iop)
180        exec_output += BasicExecute.subst(iop)
181
182    buildDataXRegInst("madd", 3, "Dest64 = Op164 + Op264 * Op364",
183        overrideOpClass="IntMultOp")
184    buildDataXRegInst("msub", 3, "Dest64 = Op164 - Op264 * Op364",
185        overrideOpClass="IntMultOp")
186    buildDataXRegInst("smaddl", 3,
187        "XDest = XOp1 + sext<32>(WOp2) * sext<32>(WOp3)",
188        overrideOpClass="IntMultOp")
189    buildDataXRegInst("smsubl", 3,
190        "XDest = XOp1 - sext<32>(WOp2) * sext<32>(WOp3)",
191        overrideOpClass="IntMultOp")
192    buildDataXRegInst("smulh", 2, '''
193        uint64_t op1H = (int32_t)(XOp1 >> 32);
194        uint64_t op1L = (uint32_t)XOp1;
195        uint64_t op2H = (int32_t)(XOp2 >> 32);
196        uint64_t op2L = (uint32_t)XOp2;
197        uint64_t mid1 = ((op1L * op2L) >> 32) + op1H * op2L;
198        uint64_t mid2 = op1L * op2H;
199        uint64_t result = ((uint64_t)(uint32_t)mid1 + (uint32_t)mid2) >> 32;
200        result += shiftReg64(mid1, 32, ASR, intWidth);
201        result += shiftReg64(mid2, 32, ASR, intWidth);
202        XDest = result + op1H * op2H;
203    ''', overrideOpClass="IntMultOp")
204    buildDataXRegInst("umaddl", 3, "XDest = XOp1 + WOp2 * WOp3",
205        overrideOpClass="IntMultOp")
206    buildDataXRegInst("umsubl", 3, "XDest = XOp1 - WOp2 * WOp3",
207        overrideOpClass="IntMultOp")
208    buildDataXRegInst("umulh", 2, '''
209        uint64_t op1H = (uint32_t)(XOp1 >> 32);
210        uint64_t op1L = (uint32_t)XOp1;
211        uint64_t op2H = (uint32_t)(XOp2 >> 32);
212        uint64_t op2L = (uint32_t)XOp2;
213        uint64_t mid1 = ((op1L * op2L) >> 32) + op1H * op2L;
214        uint64_t mid2 = op1L * op2H;
215        uint64_t result = ((uint64_t)(uint32_t)mid1 + (uint32_t)mid2) >> 32;
216        result += mid1 >> 32;
217        result += mid2 >> 32;
218        XDest = result + op1H * op2H;
219    ''', overrideOpClass="IntMultOp")
220
221    buildDataXRegInst("asrv", 2,
222        "Dest64 = shiftReg64(Op164, Op264, ASR, intWidth)")
223    buildDataXRegInst("lslv", 2,
224        "Dest64 = shiftReg64(Op164, Op264, LSL, intWidth)")
225    buildDataXRegInst("lsrv", 2,
226        "Dest64 = shiftReg64(Op164, Op264, LSR, intWidth)")
227    buildDataXRegInst("rorv", 2,
228        "Dest64 = shiftReg64(Op164, Op264, ROR, intWidth)")
229
230    crcCode = '''
231    constexpr uint8_t size_bytes = %(sz)d;
232    constexpr uint32_t poly = %(polynom)s;
233
234    // Initial value is often a previously evaluated
235    // crc value hence is always 32bit in CRC32
236    uint32_t initial_crc = Op164 & 0xFFFFFFFF;
237
238    uint64_t data = htole(Op264);
239    auto data_buffer = reinterpret_cast<uint8_t*>(&data);
240
241    Dest = crc32<poly>(
242        data_buffer,   /* Message register */
243        initial_crc,   /* Initial value of the CRC */
244        size_bytes     /* Size of the original Message */
245    );
246    '''
247    buildDataXRegInst("crc32b", 2,
248        crcCode % {"sz": 1, "polynom": "0x04C11DB7"})
249    buildDataXRegInst("crc32h", 2,
250        crcCode % {"sz": 2, "polynom": "0x04C11DB7"})
251    buildDataXRegInst("crc32w", 2,
252        crcCode % {"sz": 4, "polynom": "0x04C11DB7"})
253    buildDataXRegInst("crc32x", 2,
254        crcCode % {"sz": 8, "polynom": "0x04C11DB7"})
255
256    buildDataXRegInst("crc32cb", 2,
257        crcCode % {"sz": 1, "polynom": "0x1EDC6F41"})
258    buildDataXRegInst("crc32ch", 2,
259        crcCode % {"sz": 2, "polynom": "0x1EDC6F41"})
260    buildDataXRegInst("crc32cw", 2,
261        crcCode % {"sz": 4, "polynom": "0x1EDC6F41"})
262    buildDataXRegInst("crc32cx", 2,
263        crcCode % {"sz": 8, "polynom": "0x1EDC6F41"})
264
265    buildDataXRegInst("sdiv", 2, '''
266        int64_t op1 = Op164;
267        int64_t op2 = Op264;
268        if (intWidth == 32) {
269            op1 = sext<32>(op1);
270            op2 = sext<32>(op2);
271        }
272        Dest64 = op2 == -1 ? -op1 : op2 ? op1 / op2 : 0;
273    ''', overrideOpClass="IntDivOp")
274    buildDataXRegInst("udiv", 2, "Dest64 = Op264 ? Op164 / Op264 : 0",
275        overrideOpClass="IntDivOp")
276
277    buildDataXRegInst("cls", 1, '''
278        uint64_t op1 = Op164;
279        if (bits(op1, intWidth - 1))
280            op1 ^= mask(intWidth);
281        Dest64 = (op1 == 0) ? intWidth - 1 : (intWidth - 2 - findMsbSet(op1));
282    ''')
283    buildDataXRegInst("clz", 1, '''
284        Dest64 = (Op164 == 0) ? intWidth : (intWidth - 1 - findMsbSet(Op164));
285    ''')
286    buildDataXRegInst("rbit", 1, '''
287        Dest64 = reverseBits(Op164, intWidth/8);
288    ''')
289    buildDataXRegInst("rev", 1, '''
290        if (intWidth == 32)
291            Dest64 = betole<uint32_t>(Op164);
292        else
293            Dest64 = betole<uint64_t>(Op164);
294    ''')
295    buildDataXRegInst("rev16", 1, '''
296        int count = intWidth / 16;
297        uint64_t result = 0;
298        for (unsigned i = 0; i < count; i++) {
299            uint16_t hw = Op164 >> (i * 16);
300            result |= (uint64_t)betole<uint16_t>(hw) << (i * 16);
301        }
302        Dest64 = result;
303    ''')
304    buildDataXRegInst("rev32", 1, '''
305        int count = intWidth / 32;
306        uint64_t result = 0;
307        for (unsigned i = 0; i < count; i++) {
308            uint32_t hw = Op164 >> (i * 32);
309            result |= (uint64_t)betole<uint32_t>(hw) << (i * 32);
310        }
311        Dest64 = result;
312    ''')
313
314    msrMrs64EnabledCheckCode = '''
315        // Check for read/write access right
316        if (!can%sAArch64SysReg(flat_idx, Scr64, cpsr, xc->tcBase())) {
317            if (flat_idx == MISCREG_DAIF ||
318                flat_idx == MISCREG_DC_ZVA_Xt ||
319                flat_idx == MISCREG_DC_CVAC_Xt ||
320                flat_idx == MISCREG_DC_CIVAC_Xt
321                )
322                return std::make_shared<UndefinedInstruction>(
323                                    machInst, 0, EC_TRAPPED_MSR_MRS_64,
324                                    mnemonic);
325            return std::make_shared<UndefinedInstruction>(machInst, false,
326                                                          mnemonic);
327        }
328
329        // Check for traps to supervisor (FP/SIMD regs)
330        if (el <= EL1 && msrMrs64TrapToSup(flat_idx, el, Cpacr64))
331            return std::make_shared<SupervisorTrap>(machInst, 0x1E00000,
332                                                    EC_TRAPPED_SIMD_FP);
333
334        bool is_vfp_neon = false;
335
336        // Check for traps to hypervisor
337        if ((ArmSystem::haveVirtualization(xc->tcBase()) && el <= EL2) &&
338            msrMrs64TrapToHyp(flat_idx, el, %s, CptrEl264, Hcr64, &is_vfp_neon)) {
339            return std::make_shared<HypervisorTrap>(
340                machInst, is_vfp_neon ? 0x1E00000 : imm,
341                is_vfp_neon ? EC_TRAPPED_SIMD_FP : EC_TRAPPED_MSR_MRS_64);
342        }
343
344        // Check for traps to secure monitor
345        if ((ArmSystem::haveSecurity(xc->tcBase()) && el <= EL3) &&
346            msrMrs64TrapToMon(flat_idx, CptrEl364, el, &is_vfp_neon)) {
347            return std::make_shared<SecureMonitorTrap>(
348                machInst,
349                is_vfp_neon ? 0x1E00000 : imm,
350                is_vfp_neon ? EC_TRAPPED_SIMD_FP : EC_TRAPPED_MSR_MRS_64);
351        }
352    '''
353
354    mrsCode = '''
355        MiscRegIndex flat_idx = (MiscRegIndex) xc->tcBase()->
356            flattenRegId(RegId(MiscRegClass, op1)).index();
357        CPSR cpsr = Cpsr;
358        ExceptionLevel el = (ExceptionLevel) (uint8_t) cpsr.el;
359        %s
360        XDest = MiscOp1_ud;
361    ''' % (msrMrs64EnabledCheckCode % ('Read', 'true'),)
362
363    mrsIop = InstObjParams("mrs", "Mrs64", "RegMiscRegImmOp64",
364                           mrsCode,
365                           ["IsSerializeBefore"])
366    header_output += RegMiscRegOp64Declare.subst(mrsIop)
367    decoder_output += RegMiscRegOp64Constructor.subst(mrsIop)
368    exec_output += BasicExecute.subst(mrsIop)
369
370    buildDataXRegInst("mrsNZCV", 1, '''
371        CPSR cpsr = 0;
372        cpsr.nz = CondCodesNZ;
373        cpsr.c = CondCodesC;
374        cpsr.v = CondCodesV;
375        XDest = cpsr;
376    ''')
377
378    msrCode = '''
379        MiscRegIndex flat_idx = (MiscRegIndex) xc->tcBase()->
380            flattenRegId(RegId(MiscRegClass, dest)).index();
381        CPSR cpsr = Cpsr;
382        ExceptionLevel el = (ExceptionLevel) (uint8_t) cpsr.el;
383        %s
384        MiscDest_ud = XOp1;
385    ''' % (msrMrs64EnabledCheckCode % ('Write', 'false'),)
386
387    msrIop = InstObjParams("msr", "Msr64", "MiscRegRegImmOp64",
388                           msrCode,
389                           ["IsSerializeAfter", "IsNonSpeculative"])
390    header_output += MiscRegRegOp64Declare.subst(msrIop)
391    decoder_output += MiscRegRegOp64Constructor.subst(msrIop)
392    exec_output += BasicExecute.subst(msrIop)
393
394
395    buildDataXRegInst("msrNZCV", 1, '''
396        CPSR cpsr = XOp1;
397        CondCodesNZ = cpsr.nz;
398        CondCodesC = cpsr.c;
399        CondCodesV = cpsr.v;
400    ''')
401
402    msr_check_code = '''
403        MiscRegIndex flat_idx = (MiscRegIndex) xc->tcBase()->
404            flattenRegId(RegId(MiscRegClass, dest)).index();
405        CPSR cpsr = Cpsr;
406        ExceptionLevel el = (ExceptionLevel) (uint8_t) cpsr.el;
407        %s
408    ''' % (msrMrs64EnabledCheckCode % ('Write', 'false'),)
409
410
411    msrdczva_ea_code = msr_check_code
412    msrdczva_ea_code += '''
413           Request::Flags memAccessFlags = Request::CACHE_BLOCK_ZERO |
414               ArmISA::TLB::MustBeOne;
415           EA = XBase;
416           assert(!(Dczid & 0x10));
417           uint64_t op_size = power(2, Dczid + 2);
418           EA &= ~(op_size - 1);
419
420   '''
421
422    msrDCZVAIop = InstObjParams("dc zva", "Dczva", "SysDC64",
423                                { "ea_code" : msrdczva_ea_code,
424                                  "memacc_code" : ';',
425                                  "use_uops" : 0,
426                                  "op_wb" : ";",
427                                  "fa_code" : ";"},
428                                ['IsStore', 'IsMemRef']);
429    header_output += DCStore64Declare.subst(msrDCZVAIop);
430    decoder_output += DCStore64Constructor.subst(msrDCZVAIop);
431    exec_output += DCStore64Execute.subst(msrDCZVAIop);
432    exec_output += DCStore64InitiateAcc.subst(msrDCZVAIop);
433    exec_output += Store64CompleteAcc.subst(msrDCZVAIop);
434
435
436    msrdccvau_ea_code = msr_check_code
437    msrdccvau_ea_code += '''
438           Request::Flags memAccessFlags = Request::CLEAN | Request::DST_POU |
439              ArmISA::TLB::MustBeOne;
440           EA = XBase;
441           System *sys = xc->tcBase()->getSystemPtr();
442           Addr op_size = sys->cacheLineSize();
443           EA &= ~(op_size - 1);
444    '''
445
446    msrDCCVAUIop = InstObjParams("dc cvau", "Dccvau", "SysDC64",
447                                 { "ea_code" : msrdccvau_ea_code,
448                                   "memacc_code" : ';',
449                                   "use_uops" : 0,
450                                   "op_wb" : ";", "fa_code" : ";"},
451                                 ['IsStore', 'IsMemRef']);
452    header_output += DCStore64Declare.subst(msrDCCVAUIop);
453    decoder_output += DCStore64Constructor.subst(msrDCCVAUIop);
454    exec_output += DCStore64Execute.subst(msrDCCVAUIop);
455    exec_output += DCStore64InitiateAcc.subst(msrDCCVAUIop);
456    exec_output += Store64CompleteAcc.subst(msrDCCVAUIop);
457
458
459    msrdccvac_ea_code = msr_check_code
460    msrdccvac_ea_code += '''
461           Request::Flags memAccessFlags = Request::CLEAN | Request::DST_POC |
462              ArmISA::TLB::MustBeOne;
463           EA = XBase;
464           System *sys = xc->tcBase()->getSystemPtr();
465           Addr op_size = sys->cacheLineSize();
466           EA &= ~(op_size - 1);
467    '''
468
469    msrDCCVACIop = InstObjParams("dc cvac", "Dccvac", "SysDC64",
470                                 { "ea_code" : msrdccvac_ea_code,
471                                   "memacc_code" : ';',
472                                   "use_uops" : 0,
473                                   "op_wb" : ";", "fa_code" : ";"},
474                                 ['IsStore', 'IsMemRef']);
475    header_output += DCStore64Declare.subst(msrDCCVACIop);
476    decoder_output += DCStore64Constructor.subst(msrDCCVACIop);
477    exec_output += DCStore64Execute.subst(msrDCCVACIop);
478    exec_output += DCStore64InitiateAcc.subst(msrDCCVACIop);
479    exec_output += Store64CompleteAcc.subst(msrDCCVACIop);
480
481
482    msrdccivac_ea_code = msr_check_code
483    msrdccivac_ea_code += '''
484           Request::Flags memAccessFlags = Request::CLEAN |
485              Request::INVALIDATE | Request::DST_POC | ArmISA::TLB::MustBeOne;
486           EA = XBase;
487           System *sys = xc->tcBase()->getSystemPtr();
488           Addr op_size = sys->cacheLineSize();
489           EA &= ~(op_size - 1);
490    '''
491
492    msrDCCIVACIop = InstObjParams("dc civac", "Dccivac", "SysDC64",
493                                  { "ea_code" : msrdccivac_ea_code,
494                                    "memacc_code" : ';',
495                                    "use_uops" : 0,
496                                    "op_wb" : ";", "fa_code" : ";"},
497                                  ['IsStore', 'IsMemRef']);
498    header_output += DCStore64Declare.subst(msrDCCIVACIop);
499    decoder_output += DCStore64Constructor.subst(msrDCCIVACIop);
500    exec_output += DCStore64Execute.subst(msrDCCIVACIop);
501    exec_output += DCStore64InitiateAcc.subst(msrDCCIVACIop);
502    exec_output += Store64CompleteAcc.subst(msrDCCIVACIop);
503
504
505    msrdcivac_ea_code = msr_check_code
506    msrdcivac_ea_code += '''
507           Request::Flags memAccessFlags = Request::INVALIDATE |
508              Request::DST_POC | ArmISA::TLB::MustBeOne;
509           EA = XBase;
510           HCR hcr = Hcr64;
511           SCR scr = Scr64;
512           if (el == EL1 && ArmSystem::haveVirtualization(xc->tcBase()) &&
513               hcr.vm && (scr.ns || !ArmSystem::haveSecurity(xc->tcBase()))) {
514               memAccessFlags = memAccessFlags | Request::CLEAN;
515           }
516           System *sys = xc->tcBase()->getSystemPtr();
517           Addr op_size = sys->cacheLineSize();
518           EA &= ~(op_size - 1);
519    '''
520
521    msrDCIVACIop = InstObjParams("dc ivac", "Dcivac", "SysDC64",
522                                 { "ea_code" : msrdcivac_ea_code,
523                                   "memacc_code" : ';',
524                                   "use_uops" : 0,
525                                   "op_wb" : ";", "fa_code" : ";"},
526                                 ['IsStore', 'IsMemRef']);
527    header_output += DCStore64Declare.subst(msrDCIVACIop);
528    decoder_output += DCStore64Constructor.subst(msrDCIVACIop);
529    exec_output += DCStore64Execute.subst(msrDCIVACIop);
530    exec_output += DCStore64InitiateAcc.subst(msrDCIVACIop);
531    exec_output += Store64CompleteAcc.subst(msrDCIVACIop);
532
533
534    buildDataXImmInst("msrSP", '''
535        if (!canWriteAArch64SysReg(
536                (MiscRegIndex) xc->tcBase()->flattenRegId(
537                   RegId(MiscRegClass, dest)).index(),
538                Scr64, Cpsr, xc->tcBase())) {
539            return std::make_shared<UndefinedInstruction>(machInst, false,
540                                                          mnemonic);
541        }
542        MiscDest_ud = imm;
543    ''', optArgs = ["IsSerializeAfter", "IsNonSpeculative"])
544
545    buildDataXImmInst("msrDAIFSet", '''
546        if (!canWriteAArch64SysReg(
547                (MiscRegIndex) xc->tcBase()->flattenRegId(
548                   RegId(MiscRegClass, dest)).index(),
549                Scr64, Cpsr, xc->tcBase())) {
550            return std::make_shared<UndefinedInstruction>(
551                            machInst, 0, EC_TRAPPED_MSR_MRS_64,
552                            mnemonic);
553        }
554        CPSR cpsr = Cpsr;
555        cpsr.daif = cpsr.daif | imm;
556        Cpsr = cpsr;
557    ''', optArgs = ["IsSerializeAfter", "IsNonSpeculative"])
558
559    buildDataXImmInst("msrDAIFClr", '''
560        if (!canWriteAArch64SysReg(
561                (MiscRegIndex) xc->tcBase()->flattenRegId(
562                   RegId(MiscRegClass, dest)).index(),
563                Scr64, Cpsr, xc->tcBase())) {
564            return std::make_shared<UndefinedInstruction>(
565                                machInst, 0, EC_TRAPPED_MSR_MRS_64,
566                                mnemonic);
567        }
568        CPSR cpsr = Cpsr;
569        cpsr.daif = cpsr.daif & ~imm;
570        Cpsr = cpsr;
571    ''', optArgs = ["IsSerializeAfter", "IsNonSpeculative"])
572
573    def buildDataXCompInst(mnem, instType, suffix, code):
574        global header_output, decoder_output, exec_output
575        templateBase = "DataXCond%s" % instType
576        iop = InstObjParams(mnem, mnem.capitalize() + suffix + "64",
577                            templateBase + "Op", code)
578        header_output += eval(templateBase + "Declare").subst(iop)
579        decoder_output += eval(templateBase + "Constructor").subst(iop)
580        exec_output += BasicExecute.subst(iop)
581
582    def buildDataXCondImmInst(mnem, code):
583        buildDataXCompInst(mnem, "CompImm", "Imm", code)
584    def buildDataXCondRegInst(mnem, code):
585        buildDataXCompInst(mnem, "CompReg", "Reg", code)
586    def buildDataXCondSelInst(mnem, code):
587        buildDataXCompInst(mnem, "Sel", "", code)
588
589    def condCompCode(flagType, op, imm):
590        ccCode = createCcCode64(carryCode64[flagType], overflowCode64[flagType])
591        opDecl = "uint64_t secOp M5_VAR_USED = imm;"
592        if not imm:
593            opDecl = "uint64_t secOp M5_VAR_USED = Op264;"
594        return opDecl + '''
595            if (testPredicate(CondCodesNZ, CondCodesC, CondCodesV, condCode)) {
596                uint64_t resTemp = Op164 ''' + op + ''' secOp;
597        ''' + ccCode + '''
598            } else {
599                CondCodesNZ = (defCc >> 2) & 0x3;
600                CondCodesC = (defCc >> 1) & 0x1;
601                CondCodesV = defCc & 0x1;
602            }
603        '''
604
605    buildDataXCondImmInst("ccmn", condCompCode("add", "+", True))
606    buildDataXCondImmInst("ccmp", condCompCode("sub", "-", True))
607    buildDataXCondRegInst("ccmn", condCompCode("add", "+", False))
608    buildDataXCondRegInst("ccmp", condCompCode("sub", "-", False))
609
610    condSelCode = '''
611        if (testPredicate(CondCodesNZ, CondCodesC, CondCodesV, condCode)) {
612            Dest64 = Op164;
613        } else {
614            Dest64 = %(altVal)s;
615        }
616    '''
617    buildDataXCondSelInst("csel", condSelCode % {"altVal" : "Op264"})
618    buildDataXCondSelInst("csinc", condSelCode % {"altVal" : "Op264 + 1"})
619    buildDataXCondSelInst("csinv", condSelCode % {"altVal" : "~Op264"})
620    buildDataXCondSelInst("csneg", condSelCode % {"altVal" : "-Op264"})
621}};
622