xref: /gem5/src/arch/arm/isa/insts/str.isa

// -*- mode:c++ -*-

// Copyright (c) 2010 ARM Limited
// All rights reserved
//
// The license below extends only to copyright in the software and shall
// not be construed as granting a license to any other intellectual
// property including but not limited to intellectual property relating
// to a hardware implementation of the functionality of the software
// licensed hereunder.  You may use the software subject to the license
// terms below provided that you ensure that this notice is replicated
// unmodified and in its entirety in all distributions of the software,
// modified or unmodified, in source code or in binary form.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met: redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer;
// redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution;
// neither the name of the copyright holders nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: Gabe Black

let {{

    header_output = ""
    decoder_output = ""
    exec_output = ""

    def storeImmClassName(post, add, writeback, \
                          size=4, sign=False, user=False):
        return memClassName("STORE_IMM", post, add, writeback,
                            size, sign, user)

    def storeRegClassName(post, add, writeback, \
                          size=4, sign=False, user=False):
        return memClassName("STORE_REG", post, add, writeback,
                            size, sign, user)

    def storeDoubleImmClassName(post, add, writeback):
        return memClassName("STORE_IMMD", post, add, writeback,
                            4, False, False)

    def storeDoubleRegClassName(post, add, writeback):
        return memClassName("STORE_REGD", post, add, writeback,
                            4, False, False)

    def emitStore(name, Name, imm, eaCode, accCode, postAccCode, \
                  memFlags, instFlags, base, double=False, strex=False,
                  execTemplateBase = 'Store'):
        global header_output, decoder_output, exec_output

        (newHeader,
         newDecoder,
         newExec) = loadStoreBase(name, Name, imm,
                                  eaCode, accCode, postAccCode,
                                  memFlags, instFlags, double, strex,
                                  base, execTemplateBase = execTemplateBase)

        header_output += newHeader
        decoder_output += newDecoder
        exec_output += newExec

    def buildImmStore(mnem, post, add, writeback, \
                      size=4, sign=False, user=False, \
                      strex=False, vstr=False):
        name = mnem
        Name = storeImmClassName(post, add, writeback, \
                                 size, sign, user)

        if add:
            op = " +"
        else:
            op = " -"

        offset = op + " imm"
        eaCode = "EA = Base"
        if not post:
            eaCode += offset
        eaCode += ";"

        if vstr:
            accCode = '''
            Mem%(suffix)s = cSwap(FpDest.uw, ((CPSR)Cpsr).e);
            ''' % { "suffix" : buildMemSuffix(sign, size) }
        else:
            accCode = '''
            Mem%(suffix)s = cSwap(Dest%(suffix)s, ((CPSR)Cpsr).e);
            ''' % { "suffix" : buildMemSuffix(sign, size) }
        if writeback:
            accCode += "Base = Base %s;\n" % offset

        memFlags = ["ArmISA::TLB::MustBeOne", "%d" % (size - 1)]
        if strex:
            memFlags.append("Request::LLSC")
            Name = "%s_%s" % (mnem.upper(), Name)
            base = buildMemBase("MemoryExImm", post, writeback)
            postAccCode = "Result = !writeResult;"
            execTemplateBase = 'StoreEx'
        else:
            if vstr:
                Name = "%s_%s" % (mnem.upper(), Name)
            else:
                memFlags.append("ArmISA::TLB::AllowUnaligned")
            base = buildMemBase("MemoryImm", post, writeback)
            postAccCode = ""
            execTemplateBase = 'Store'

        emitStore(name, Name, True, eaCode, accCode, postAccCode, \
                  memFlags, [], base, strex=strex,
                  execTemplateBase = execTemplateBase)

    def buildSrsStore(mnem, post, add, writeback):
        name = mnem
        Name = "SRS_" + storeImmClassName(post, add, writeback, 8)

        offset = 0
        if post != add:
            offset += 4
        if not add:
            offset -= 8

        eaCode = "EA = SpMode + %d;" % offset

        wbDiff = -8
        if add:
            wbDiff = 8
        accCode = '''
        CPSR cpsr = Cpsr;
        Mem.ud = (uint64_t)cSwap(LR.uw, cpsr.e) |
                 ((uint64_t)cSwap(Spsr.uw, cpsr.e) << 32);
        '''
        if writeback:
            accCode += "SpMode = SpMode + %s;\n" % wbDiff

        global header_output, decoder_output, exec_output

        (newHeader,
         newDecoder,
         newExec) = SrsBase(name, Name, eaCode, accCode,
             ["ArmISA::TLB::AlignWord", "ArmISA::TLB::MustBeOne"], [])

        header_output += newHeader
        decoder_output += newDecoder
        exec_output += newExec

    def buildRegStore(mnem, post, add, writeback, \
                      size=4, sign=False, user=False, strex=False):
        name = mnem
        Name = storeRegClassName(post, add, writeback,
                                 size, sign, user)

        if add:
            op = " +"
        else:
            op = " -"

        offset = op + " shift_rm_imm(Index, shiftAmt," + \
                      " shiftType, CondCodes<29:>)"
        eaCode = "EA = Base"
        if not post:
            eaCode += offset
        eaCode += ";"

        accCode = "Mem%(suffix)s = cSwap(Dest%(suffix)s, ((CPSR)Cpsr).e);" % \
            { "suffix" : buildMemSuffix(sign, size) }
        if writeback:
            accCode += "Base = Base %s;\n" % offset
        base = buildMemBase("MemoryReg", post, writeback)

        emitStore(name, Name, False, eaCode, accCode, "",\
                ["ArmISA::TLB::MustBeOne", \
                 "ArmISA::TLB::AllowUnaligned", \
                 "%d" % (size - 1)], [], base)

    def buildDoubleImmStore(mnem, post, add, writeback, \
                            strex=False, vstr=False):
        name = mnem
        Name = storeDoubleImmClassName(post, add, writeback)

        if add:
            op = " +"
        else:
            op = " -"

        offset = op + " imm"
        eaCode = "EA = Base"
        if not post:
            eaCode += offset
        eaCode += ";"

        if vstr:
            accCode = '''
            uint64_t swappedMem  = (uint64_t)FpDest.uw |
                                   ((uint64_t)FpDest2.uw << 32);
            Mem.ud = cSwap(swappedMem, ((CPSR)Cpsr).e);
            '''
        else:
            accCode = '''
            CPSR cpsr = Cpsr;
            Mem.ud = (uint64_t)cSwap(Dest.uw, cpsr.e) |
                     ((uint64_t)cSwap(Dest2.uw, cpsr.e) << 32);
            '''
        if writeback:
            accCode += "Base = Base %s;\n" % offset

        memFlags = ["ArmISA::TLB::MustBeOne",
                    "ArmISA::TLB::AlignWord"]
        if strex:
            memFlags.append("Request::LLSC")
            base = buildMemBase("MemoryExDImm", post, writeback)
            postAccCode = "Result = !writeResult;"
        else:
            base = buildMemBase("MemoryDImm", post, writeback)
            postAccCode = ""
        if vstr or strex:
            Name = "%s_%s" % (mnem.upper(), Name)

        emitStore(name, Name, True, eaCode, accCode, postAccCode, \
                  memFlags, [], base, double=True, strex=strex)

    def buildDoubleRegStore(mnem, post, add, writeback):
        name = mnem
        Name = storeDoubleRegClassName(post, add, writeback)

        if add:
            op = " +"
        else:
            op = " -"

        offset = op + " shift_rm_imm(Index, shiftAmt," + \
                      " shiftType, CondCodes<29:>)"
        eaCode = "EA = Base"
        if not post:
            eaCode += offset
        eaCode += ";"

        accCode = '''
        CPSR cpsr = Cpsr;
        Mem.ud = (uint64_t)cSwap(Dest.uw, cpsr.e) |
                 ((uint64_t)cSwap(Dest2.uw, cpsr.e) << 32);
        '''
        if writeback:
            accCode += "Base = Base %s;\n" % offset
        base = buildMemBase("MemoryDReg", post, writeback)

        memFlags = ["ArmISA::TLB::MustBeOne",
                    "ArmISA::TLB::AlignWord"]

        emitStore(name, Name, False, eaCode, accCode, "", \
                  memFlags, [], base, double=True)

    def buildStores(mnem, size=4, sign=False, user=False):
        buildImmStore(mnem, True, True, True, size, sign, user)
        buildRegStore(mnem, True, True, True, size, sign, user)
        buildImmStore(mnem, True, False, True, size, sign, user)
        buildRegStore(mnem, True, False, True, size, sign, user)
        buildImmStore(mnem, False, True, True, size, sign, user)
        buildRegStore(mnem, False, True, True, size, sign, user)
        buildImmStore(mnem, False, False, True, size, sign, user)
        buildRegStore(mnem, False, False, True, size, sign, user)
        buildImmStore(mnem, False, True, False, size, sign, user)
        buildRegStore(mnem, False, True, False, size, sign, user)
        buildImmStore(mnem, False, False, False, size, sign, user)
        buildRegStore(mnem, False, False, False, size, sign, user)

    def buildDoubleStores(mnem):
        buildDoubleImmStore(mnem, True, True, True)
        buildDoubleRegStore(mnem, True, True, True)
        buildDoubleImmStore(mnem, True, False, True)
        buildDoubleRegStore(mnem, True, False, True)
        buildDoubleImmStore(mnem, False, True, True)
        buildDoubleRegStore(mnem, False, True, True)
        buildDoubleImmStore(mnem, False, False, True)
        buildDoubleRegStore(mnem, False, False, True)
        buildDoubleImmStore(mnem, False, True, False)
        buildDoubleRegStore(mnem, False, True, False)
        buildDoubleImmStore(mnem, False, False, False)
        buildDoubleRegStore(mnem, False, False, False)

    def buildSrsStores(mnem):
        buildSrsStore(mnem, True, True, True)
        buildSrsStore(mnem, True, True, False)
        buildSrsStore(mnem, True, False, True)
        buildSrsStore(mnem, True, False, False)
        buildSrsStore(mnem, False, True, True)
        buildSrsStore(mnem, False, True, False)
        buildSrsStore(mnem, False, False, True)
        buildSrsStore(mnem, False, False, False)

    buildStores("str")
    buildStores("strt", user=True)
    buildStores("strb", size=1)
    buildStores("strbt", size=1, user=True)
    buildStores("strh", size=2)
    buildStores("strht", size=2, user=True)

    buildSrsStores("srs")

    buildDoubleStores("strd")

    buildImmStore("strex", False, True, False, size=4, strex=True)
    buildImmStore("strexh", False, True, False, size=2, strex=True)
    buildImmStore("strexb", False, True, False, size=1, strex=True)
    buildDoubleImmStore("strexd", False, True, False, strex=True)

    buildImmStore("vstr", False, True, False, size=4, vstr=True)
    buildImmStore("vstr", False, False, False, size=4, vstr=True)
    buildDoubleImmStore("vstr", False, True, False, vstr=True)
    buildDoubleImmStore("vstr", False, False, False, vstr=True)
}};