static_inst.hh revision 7147:53c74014d4ef
1/*
2 * Copyright (c) 2010 ARM Limited
3 * All rights reserved
4 *
5 * The license below extends only to copyright in the software and shall
6 * not be construed as granting a license to any other intellectual
7 * property including but not limited to intellectual property relating
8 * to a hardware implementation of the functionality of the software
9 * licensed hereunder.  You may use the software subject to the license
10 * terms below provided that you ensure that this notice is replicated
11 * unmodified and in its entirety in all distributions of the software,
12 * modified or unmodified, in source code or in binary form.
13 *
14 * Copyright (c) 2007-2008 The Florida State University
15 * All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions are
19 * met: redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer;
21 * redistributions in binary form must reproduce the above copyright
22 * notice, this list of conditions and the following disclaimer in the
23 * documentation and/or other materials provided with the distribution;
24 * neither the name of the copyright holders nor the names of its
25 * contributors may be used to endorse or promote products derived from
26 * this software without specific prior written permission.
27 *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 *
40 * Authors: Stephen Hines
41 */
42#ifndef __ARCH_ARM_INSTS_STATICINST_HH__
43#define __ARCH_ARM_INSTS_STATICINST_HH__
44
45#include "base/trace.hh"
46#include "cpu/static_inst.hh"
47
48namespace ArmISA
49{
50class ArmStaticInstBase : public StaticInst
51{
52  protected:
53    int32_t shift_rm_imm(uint32_t base, uint32_t shamt,
54                         uint32_t type, uint32_t cfval) const;
55    int32_t shift_rm_rs(uint32_t base, uint32_t shamt,
56                        uint32_t type, uint32_t cfval) const;
57
58    bool shift_carry_imm(uint32_t base, uint32_t shamt,
59                         uint32_t type, uint32_t cfval) const;
60    bool shift_carry_rs(uint32_t base, uint32_t shamt,
61                        uint32_t type, uint32_t cfval) const;
62
63    // Constructor
64    ArmStaticInstBase(const char *mnem, ExtMachInst _machInst,
65            OpClass __opClass)
66        : StaticInst(mnem, _machInst, __opClass)
67    {
68    }
69
70    /// Print a register name for disassembly given the unique
71    /// dependence tag number (FP or int).
72    void printReg(std::ostream &os, int reg) const;
73    void printMnemonic(std::ostream &os,
74                       const std::string &suffix = "",
75                       bool withPred = true) const;
76    void printMemSymbol(std::ostream &os, const SymbolTable *symtab,
77                        const std::string &prefix, const Addr addr,
78                        const std::string &suffix) const;
79    void printShiftOperand(std::ostream &os, IntRegIndex rm,
80                           bool immShift, uint32_t shiftAmt,
81                           IntRegIndex rs, ArmShiftType type) const;
82
83
84    void printDataInst(std::ostream &os, bool withImm) const;
85    void printDataInst(std::ostream &os, bool withImm, bool immShift, bool s,
86                       IntRegIndex rd, IntRegIndex rn, IntRegIndex rm,
87                       IntRegIndex rs, uint32_t shiftAmt, ArmShiftType type,
88                       uint32_t imm) const;
89
90    std::string generateDisassembly(Addr pc, const SymbolTable *symtab) const;
91
92    static uint32_t
93    cpsrWriteByInstr(CPSR cpsr, uint32_t val,
94            uint8_t byteMask, bool affectState)
95    {
96        bool privileged = (cpsr.mode != MODE_USER);
97
98        uint32_t bitMask = 0;
99
100        if (bits(byteMask, 3)) {
101            unsigned lowIdx = affectState ? 24 : 27;
102            bitMask = bitMask | mask(31, lowIdx);
103        }
104        if (bits(byteMask, 2)) {
105            bitMask = bitMask | mask(19, 16);
106        }
107        if (bits(byteMask, 1)) {
108            unsigned highIdx = affectState ? 15 : 9;
109            unsigned lowIdx = privileged ? 8 : 9;
110            bitMask = bitMask | mask(highIdx, lowIdx);
111        }
112        if (bits(byteMask, 0)) {
113            if (privileged) {
114                bitMask = bitMask | mask(7, 6);
115                bitMask = bitMask | mask(5);
116            }
117            if (affectState)
118                bitMask = bitMask | (1 << 5);
119        }
120
121        return ((uint32_t)cpsr & ~bitMask) | (val & bitMask);
122    }
123
124    static uint32_t
125    spsrWriteByInstr(uint32_t spsr, uint32_t val,
126            uint8_t byteMask, bool affectState)
127    {
128        uint32_t bitMask = 0;
129
130        if (bits(byteMask, 3))
131            bitMask = bitMask | mask(31, 24);
132        if (bits(byteMask, 2))
133            bitMask = bitMask | mask(19, 16);
134        if (bits(byteMask, 1))
135            bitMask = bitMask | mask(15, 8);
136        if (bits(byteMask, 0))
137            bitMask = bitMask | mask(7, 0);
138
139        return ((spsr & ~bitMask) | (val & bitMask));
140    }
141
142    template<class XC>
143    static Addr
144    readPC(XC *xc)
145    {
146        Addr pc = xc->readPC();
147        Addr tBit = pc & (ULL(1) << PcTBitShift);
148        if (tBit)
149            return pc + 4;
150        else
151            return pc + 8;
152    }
153
154    template<class XC>
155    static void
156    setNextPC(XC *xc, Addr val)
157    {
158        xc->setNextPC((xc->readNextPC() & PcModeMask) |
159                      (val & ~PcModeMask));
160    }
161};
162
163class ArmStaticInst : public ArmStaticInstBase
164{
165  protected:
166    ArmStaticInst(const char *mnem, ExtMachInst _machInst, OpClass __opClass)
167        : ArmStaticInstBase(mnem, _machInst, __opClass)
168    {
169    }
170
171    template<class XC>
172    static void
173    setNextPC(XC *xc, Addr val)
174    {
175        xc->setNextPC((xc->readNextPC() & PcModeMask) |
176                      (val & ~PcModeMask));
177    }
178};
179
180class ArmInterWorking : public ArmStaticInstBase
181{
182  protected:
183    ArmInterWorking(const char *mnem, ExtMachInst _machInst, OpClass __opClass)
184        : ArmStaticInstBase(mnem, _machInst, __opClass)
185    {
186    }
187
188    template<class XC>
189    static void
190    setNextPC(XC *xc, Addr val)
191    {
192        Addr stateBits = xc->readPC() & PcModeMask;
193        Addr jBit = (ULL(1) << PcJBitShift);
194        Addr tBit = (ULL(1) << PcTBitShift);
195        bool thumbEE = (stateBits == (tBit | jBit));
196
197        Addr newPc = (val & ~PcModeMask);
198        if (thumbEE) {
199            if (bits(newPc, 0)) {
200                warn("Bad thumbEE interworking branch address %#x.\n", newPc);
201            } else {
202                newPc = newPc & ~mask(1);
203            }
204        } else {
205            if (bits(newPc, 0)) {
206                stateBits = tBit;
207                newPc = newPc & ~mask(1);
208            } else if (!bits(newPc, 1)) {
209                stateBits = 0;
210            } else {
211                warn("Bad interworking branch address %#x.\n", newPc);
212            }
213        }
214        newPc = newPc | stateBits;
215        xc->setNextPC(newPc);
216    }
217};
218}
219
220#endif //__ARCH_ARM_INSTS_STATICINST_HH__
221