mem.hh revision 7118
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_MEM_HH__
43#define __ARCH_ARM_MEM_HH__
44
45#include "arch/arm/insts/pred_inst.hh"
46
47namespace ArmISA
48{
49
50class MemoryNew : public PredOp
51{
52  public:
53    enum AddrMode {
54        AddrMd_Offset,
55        AddrMd_PreIndex,
56        AddrMd_PostIndex
57    };
58
59  protected:
60
61    IntRegIndex dest;
62    IntRegIndex base;
63    bool add;
64
65    MemoryNew(const char *mnem, ExtMachInst _machInst, OpClass __opClass,
66              IntRegIndex _dest, IntRegIndex _base, bool _add)
67        : PredOp(mnem, _machInst, __opClass),
68          dest(_dest), base(_base), add(_add)
69    {}
70
71    virtual void
72    printOffset(std::ostream &os) const
73    {}
74
75    void printInst(std::ostream &os, AddrMode addrMode) const;
76};
77
78// The address is a base register plus an immediate.
79class MemoryNewImm : public MemoryNew
80{
81  protected:
82    int32_t imm;
83
84    MemoryNewImm(const char *mnem, ExtMachInst _machInst, OpClass __opClass,
85                 IntRegIndex _dest, IntRegIndex _base, bool _add, int32_t _imm)
86        : MemoryNew(mnem, _machInst, __opClass, _dest, _base, _add), imm(_imm)
87    {}
88
89    void
90    printOffset(std::ostream &os) const
91    {
92        int32_t pImm = imm;
93        if (!add)
94            pImm = -pImm;
95        ccprintf(os, "#%d", pImm);
96    }
97};
98
99// The address is a shifted register plus an immediate
100class MemoryNewReg : public MemoryNew
101{
102  protected:
103    int32_t shiftAmt;
104    ArmShiftType shiftType;
105    IntRegIndex index;
106
107    MemoryNewReg(const char *mnem, ExtMachInst _machInst, OpClass __opClass,
108                 IntRegIndex _dest, IntRegIndex _base, bool _add,
109                 int32_t _shiftAmt, ArmShiftType _shiftType,
110                 IntRegIndex _index)
111        : MemoryNew(mnem, _machInst, __opClass, _dest, _base, _add),
112          shiftAmt(_shiftAmt), shiftType(_shiftType), index(_index)
113    {}
114
115    void
116    printOffset(std::ostream &os) const
117    {
118        if (!add)
119            os << "-";
120        printReg(os, index);
121        if (shiftType != LSL || shiftAmt != 0) {
122            switch (shiftType) {
123              case LSL:
124                ccprintf(os, " LSL #%d", shiftAmt);
125                break;
126              case LSR:
127                if (shiftAmt == 0) {
128                    ccprintf(os, " LSR #%d", 32);
129                } else {
130                    ccprintf(os, " LSR #%d", shiftAmt);
131                }
132                break;
133              case ASR:
134                if (shiftAmt == 0) {
135                    ccprintf(os, " ASR #%d", 32);
136                } else {
137                    ccprintf(os, " ASR #%d", shiftAmt);
138                }
139                break;
140              case ROR:
141                if (shiftAmt == 0) {
142                    ccprintf(os, " RRX");
143                } else {
144                    ccprintf(os, " ROR #%d", shiftAmt);
145                }
146                break;
147            }
148        }
149    }
150};
151
152template<class Base>
153class MemoryNewOffset : public Base
154{
155  protected:
156    MemoryNewOffset(const char *mnem, ExtMachInst _machInst,
157                    OpClass __opClass, IntRegIndex _dest, IntRegIndex _base,
158                    bool _add, int32_t _imm)
159        : Base(mnem, _machInst, __opClass, _dest, _base, _add, _imm)
160    {}
161
162    MemoryNewOffset(const char *mnem, ExtMachInst _machInst,
163                    OpClass __opClass, IntRegIndex _dest, IntRegIndex _base,
164                    bool _add, int32_t _shiftAmt, ArmShiftType _shiftType,
165                    IntRegIndex _index)
166        : Base(mnem, _machInst, __opClass, _dest, _base, _add,
167                _shiftAmt, _shiftType, _index)
168    {}
169
170    std::string
171    generateDisassembly(Addr pc, const SymbolTable *symtab) const
172    {
173        std::stringstream ss;
174        this->printInst(ss, MemoryNew::AddrMd_Offset);
175        return ss.str();
176    }
177};
178
179template<class Base>
180class MemoryNewPreIndex : public Base
181{
182  protected:
183    MemoryNewPreIndex(const char *mnem, ExtMachInst _machInst,
184                      OpClass __opClass, IntRegIndex _dest, IntRegIndex _base,
185                      bool _add, int32_t _imm)
186        : Base(mnem, _machInst, __opClass, _dest, _base, _add, _imm)
187    {}
188
189    MemoryNewPreIndex(const char *mnem, ExtMachInst _machInst,
190                      OpClass __opClass, IntRegIndex _dest, IntRegIndex _base,
191                      bool _add, int32_t _shiftAmt, ArmShiftType _shiftType,
192                      IntRegIndex _index)
193        : Base(mnem, _machInst, __opClass, _dest, _base, _add,
194                _shiftAmt, _shiftType, _index)
195    {}
196
197    std::string
198    generateDisassembly(Addr pc, const SymbolTable *symtab) const
199    {
200        std::stringstream ss;
201        this->printInst(ss, MemoryNew::AddrMd_PreIndex);
202        return ss.str();
203    }
204};
205
206template<class Base>
207class MemoryNewPostIndex : public Base
208{
209  protected:
210    MemoryNewPostIndex(const char *mnem, ExtMachInst _machInst,
211                       OpClass __opClass, IntRegIndex _dest, IntRegIndex _base,
212                       bool _add, int32_t _imm)
213        : Base(mnem, _machInst, __opClass, _dest, _base, _add, _imm)
214    {}
215
216    MemoryNewPostIndex(const char *mnem, ExtMachInst _machInst,
217                       OpClass __opClass, IntRegIndex _dest, IntRegIndex _base,
218                       bool _add, int32_t _shiftAmt, ArmShiftType _shiftType,
219                       IntRegIndex _index)
220        : Base(mnem, _machInst, __opClass, _dest, _base, _add,
221                _shiftAmt, _shiftType, _index)
222    {}
223
224    std::string
225    generateDisassembly(Addr pc, const SymbolTable *symtab) const
226    {
227        std::stringstream ss;
228        this->printInst(ss, MemoryNew::AddrMd_PostIndex);
229        return ss.str();
230    }
231};
232
233/**
234 * Base class for general Arm memory-format instructions.
235 */
236class Memory : public PredOp
237{
238  protected:
239
240    /// Memory request flags.  See mem_req_base.hh.
241    unsigned memAccessFlags;
242
243    /// Displacement for EA calculation (signed).
244    int32_t disp;
245    int32_t disp8;
246    int32_t up;
247    int32_t hilo,
248            shift_size,
249            shift;
250
251    /// Constructor
252    Memory(const char *mnem, ExtMachInst _machInst, OpClass __opClass)
253        : PredOp(mnem, _machInst, __opClass),
254                 memAccessFlags(0),
255                 disp(machInst.immed11_0),
256                 disp8(machInst.immed7_0 << 2),
257                 up(machInst.puswl.up),
258                 hilo((machInst.immedHi11_8 << 4) | machInst.immedLo3_0),
259                 shift_size(machInst.shiftSize), shift(machInst.shift)
260    {
261    }
262
263    std::string
264    generateDisassembly(Addr pc, const SymbolTable *symtab) const;
265
266    virtual void
267    printOffset(std::ostream &os) const
268    {}
269};
270
271class MemoryDisp : public Memory
272{
273  protected:
274    /// Constructor
275    MemoryDisp(const char *mnem, ExtMachInst _machInst, OpClass __opClass)
276        : Memory(mnem, _machInst, __opClass)
277    {
278    }
279
280    void
281    printOffset(std::ostream &os) const
282    {
283        ccprintf(os, "#%#x", (machInst.puswl.up ? disp : -disp));
284    }
285};
286
287class MemoryHilo : public Memory
288{
289  protected:
290    /// Constructor
291    MemoryHilo(const char *mnem, ExtMachInst _machInst, OpClass __opClass)
292        : Memory(mnem, _machInst, __opClass)
293    {
294    }
295
296    void
297    printOffset(std::ostream &os) const
298    {
299        ccprintf(os, "#%#x", (machInst.puswl.up ? hilo : -hilo));
300    }
301};
302
303class MemoryShift : public Memory
304{
305  protected:
306    /// Constructor
307    MemoryShift(const char *mnem, ExtMachInst _machInst, OpClass __opClass)
308        : Memory(mnem, _machInst, __opClass)
309    {
310    }
311
312    void
313    printOffset(std::ostream &os) const
314    {
315        printShiftOperand(os);
316    }
317};
318
319class MemoryReg : public Memory
320{
321  protected:
322    /// Constructor
323    MemoryReg(const char *mnem, ExtMachInst _machInst, OpClass __opClass)
324        : Memory(mnem, _machInst, __opClass)
325    {
326    }
327
328    void
329    printOffset(std::ostream &os) const
330    {
331        os << (machInst.puswl.up ? "+ " : "- ");
332        printReg(os, machInst.rm);
333    }
334};
335}
336
337#endif //__ARCH_ARM_INSTS_MEM_HH__
338