ldstflags.hh revision 6622
1/*
2 * Copyright (c) 2007 The Hewlett-Packard Development Company
3 * All rights reserved.
4 *
5 * Redistribution and use of this software in source and binary forms,
6 * with or without modification, are permitted provided that the
7 * following conditions are met:
8 *
9 * The software must be used only for Non-Commercial Use which means any
10 * use which is NOT directed to receiving any direct monetary
11 * compensation for, or commercial advantage from such use.  Illustrative
12 * examples of non-commercial use are academic research, personal study,
13 * teaching, education and corporate research & development.
14 * Illustrative examples of commercial use are distributing products for
15 * commercial advantage and providing services using the software for
16 * commercial advantage.
17 *
18 * If you wish to use this software or functionality therein that may be
19 * covered by patents for commercial use, please contact:
20 *     Director of Intellectual Property Licensing
21 *     Office of Strategy and Technology
22 *     Hewlett-Packard Company
23 *     1501 Page Mill Road
24 *     Palo Alto, California  94304
25 *
26 * Redistributions of source code must retain the above copyright notice,
27 * this list of conditions and the following disclaimer.  Redistributions
28 * in binary form must reproduce the above copyright notice, this list of
29 * conditions and the following disclaimer in the documentation and/or
30 * other materials provided with the distribution.  Neither the name of
31 * the COPYRIGHT HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
32 * contributors may be used to endorse or promote products derived from
33 * this software without specific prior written permission.  No right of
34 * sublicense is granted herewith.  Derivatives of the software and
35 * output created using the software may be prepared, but only for
36 * Non-Commercial Uses.  Derivatives of the software may be shared with
37 * others provided: (i) the others agree to abide by the list of
38 * conditions herein which includes the Non-Commercial Use restrictions;
39 * and (ii) such Derivatives of the software include the above copyright
40 * notice to acknowledge the contribution from this software where
41 * applicable, this list of conditions and the disclaimer below.
42 *
43 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
44 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
45 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
46 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
47 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
48 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
49 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
50 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
51 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
52 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
53 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
54 *
55 * Authors: Gabe Black
56 */
57
58#ifndef __ARCH_X86_INSTS_MICROLDSTOP_HH__
59#define __ARCH_X86_INSTS_MICROLDSTOP_HH__
60
61#include "arch/x86/insts/microop.hh"
62#include "mem/packet.hh"
63#include "mem/request.hh"
64
65namespace X86ISA
66{
67    const Request::FlagsType SegmentFlagMask = mask(4);
68    const int FlagShift = 4;
69    enum FlagBit {
70        CPL0FlagBit = 1,
71        AddrSizeFlagBit = 2,
72        StoreCheck = 4
73    };
74
75    /**
76     * Base class for load and store ops
77     */
78    class LdStOp : public X86MicroopBase
79    {
80      protected:
81        const uint8_t scale;
82        const RegIndex index;
83        const RegIndex base;
84        const uint64_t disp;
85        const uint8_t segment;
86        const RegIndex data;
87        const uint8_t dataSize;
88        const uint8_t addressSize;
89        const Request::FlagsType memFlags;
90        RegIndex foldOBit, foldABit;
91
92        //Constructor
93        LdStOp(ExtMachInst _machInst,
94                const char * mnem, const char * _instMnem,
95                bool isMicro, bool isDelayed, bool isFirst, bool isLast,
96                uint8_t _scale, InstRegIndex _index, InstRegIndex _base,
97                uint64_t _disp, InstRegIndex _segment,
98                InstRegIndex _data,
99                uint8_t _dataSize, uint8_t _addressSize,
100                Request::FlagsType _memFlags,
101                OpClass __opClass) :
102        X86MicroopBase(machInst, mnem, _instMnem,
103                isMicro, isDelayed, isFirst, isLast, __opClass),
104                scale(_scale), index(_index.idx), base(_base.idx),
105                disp(_disp), segment(_segment.idx),
106                data(_data.idx),
107                dataSize(_dataSize), addressSize(_addressSize),
108                memFlags(_memFlags | _segment.idx)
109        {
110            assert(_segment.idx < NUM_SEGMENTREGS);
111            foldOBit = (dataSize == 1 && !_machInst.rex.present) ? 1 << 6 : 0;
112            foldABit =
113                (addressSize == 1 && !_machInst.rex.present) ? 1 << 6 : 0;
114        }
115
116        std::string generateDisassembly(Addr pc,
117            const SymbolTable *symtab) const;
118
119        template<class Context, class MemType>
120        Fault read(Context *xc, Addr EA, MemType & Mem, unsigned flags) const
121        {
122            Fault fault = NoFault;
123            switch(dataSize)
124            {
125              case 1:
126                fault = xc->read(EA, (uint8_t&)Mem, flags);
127                break;
128              case 2:
129                fault = xc->read(EA, (uint16_t&)Mem, flags);
130                break;
131              case 4:
132                fault = xc->read(EA, (uint32_t&)Mem, flags);
133                break;
134              case 8:
135                fault = xc->read(EA, (uint64_t&)Mem, flags);
136                break;
137              default:
138                panic("Bad operand size %d for read at %#x.\n", dataSize, EA);
139            }
140            return fault;
141        }
142
143        template<class Context, class MemType>
144        Fault write(Context *xc, MemType & Mem, Addr EA, unsigned flags) const
145        {
146            Fault fault = NoFault;
147            switch(dataSize)
148            {
149              case 1:
150                fault = xc->write((uint8_t&)Mem, EA, flags, 0);
151                break;
152              case 2:
153                fault = xc->write((uint16_t&)Mem, EA, flags, 0);
154                break;
155              case 4:
156                fault = xc->write((uint32_t&)Mem, EA, flags, 0);
157                break;
158              case 8:
159                fault = xc->write((uint64_t&)Mem, EA, flags, 0);
160                break;
161              default:
162                panic("Bad operand size %d for write at %#x.\n", dataSize, EA);
163            }
164            return fault;
165        }
166
167        uint64_t
168        get(PacketPtr pkt) const
169        {
170            switch(dataSize)
171            {
172              case 1:
173                return pkt->get<uint8_t>();
174              case 2:
175                return pkt->get<uint16_t>();
176              case 4:
177                return pkt->get<uint32_t>();
178              case 8:
179                return pkt->get<uint64_t>();
180              default:
181                panic("Bad operand size %d for read at %#x.\n",
182                        dataSize, pkt->getAddr());
183            }
184        }
185    };
186}
187
188#endif //__ARCH_X86_INSTS_MICROLDSTOP_HH__
189