utility.hh revision 6437:ecebd7cccb06 
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_UTILITY_HH__
59#define __ARCH_X86_UTILITY_HH__
60
61#include "arch/x86/miscregs.hh"
62#include "arch/x86/types.hh"
63#include "base/hashmap.hh"
64#include "base/misc.hh"
65#include "base/types.hh"
66#include "config/full_system.hh"
67#include "cpu/thread_context.hh"
68
69class ThreadContext;
70
71namespace __hash_namespace {
72    template<>
73    struct hash<X86ISA::ExtMachInst> {
74        size_t operator()(const X86ISA::ExtMachInst &emi) const {
75            return (((uint64_t)emi.legacy << 56) |
76                    ((uint64_t)emi.rex  << 48) |
77                    ((uint64_t)emi.modRM << 40) |
78                    ((uint64_t)emi.sib << 32) |
79                    ((uint64_t)emi.opcode.num << 24) |
80                    ((uint64_t)emi.opcode.prefixA << 16) |
81                    ((uint64_t)emi.opcode.prefixB << 8) |
82                    ((uint64_t)emi.opcode.op)) ^
83                    emi.immediate ^ emi.displacement ^
84                    emi.mode ^
85                    emi.opSize ^ emi.addrSize ^
86                    emi.stackSize ^ emi.dispSize;
87        };
88    };
89}
90
91namespace X86ISA
92{
93    uint64_t getArgument(ThreadContext *tc, int number, bool fp);
94
95    static inline bool
96    inUserMode(ThreadContext *tc)
97    {
98#if FULL_SYSTEM
99        HandyM5Reg m5reg = tc->readMiscRegNoEffect(MISCREG_M5_REG);
100        return m5reg.cpl == 3;
101#else
102        return true;
103#endif
104    }
105
106    inline bool isCallerSaveIntegerRegister(unsigned int reg) {
107        panic("register classification not implemented");
108        return false;
109    }
110
111    inline bool isCalleeSaveIntegerRegister(unsigned int reg) {
112        panic("register classification not implemented");
113        return false;
114    }
115
116    inline bool isCallerSaveFloatRegister(unsigned int reg) {
117        panic("register classification not implemented");
118        return false;
119    }
120
121    inline bool isCalleeSaveFloatRegister(unsigned int reg) {
122        panic("register classification not implemented");
123        return false;
124    }
125
126    // Instruction address compression hooks
127    inline Addr realPCToFetchPC(const Addr &addr)
128    {
129        return addr;
130    }
131
132    inline Addr fetchPCToRealPC(const Addr &addr)
133    {
134        return addr;
135    }
136
137    // the size of "fetched" instructions (not necessarily the size
138    // of real instructions for PISA)
139    inline size_t fetchInstSize()
140    {
141        return sizeof(MachInst);
142    }
143
144    /**
145     * Function to insure ISA semantics about 0 registers.
146     * @param tc The thread context.
147     */
148    template <class TC>
149    void zeroRegisters(TC *tc);
150
151#if FULL_SYSTEM
152
153    void initCPU(ThreadContext *tc, int cpuId);
154
155#endif
156
157    void startupCPU(ThreadContext *tc, int cpuId);
158
159    void copyRegs(ThreadContext *src, ThreadContext *dest);
160
161    void copyMiscRegs(ThreadContext *src, ThreadContext *dest);
162};
163
164#endif // __ARCH_X86_UTILITY_HH__
165