mem-cache: Add multiple eviction stats
[gem5.git] / src / arch / x86 / utility.hh
index 3f3f1cca3fbf4822b71b8c9be2af068d2e586b6e..87d5cbb6c91349b558d96fde4179a8b192aa3653 100644 (file)
@@ -2,43 +2,25 @@
  * Copyright (c) 2007 The Hewlett-Packard Development Company
  * All rights reserved.
  *
- * Redistribution and use of this software in source and binary forms,
- * with or without modification, are permitted provided that the
- * following conditions are met:
+ * 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.
  *
- * The software must be used only for Non-Commercial Use which means any
- * use which is NOT directed to receiving any direct monetary
- * compensation for, or commercial advantage from such use.  Illustrative
- * examples of non-commercial use are academic research, personal study,
- * teaching, education and corporate research & development.
- * Illustrative examples of commercial use are distributing products for
- * commercial advantage and providing services using the software for
- * commercial advantage.
- *
- * If you wish to use this software or functionality therein that may be
- * covered by patents for commercial use, please contact:
- *     Director of Intellectual Property Licensing
- *     Office of Strategy and Technology
- *     Hewlett-Packard Company
- *     1501 Page Mill Road
- *     Palo Alto, California  94304
- *
- * 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 HOLDER(s), HEWLETT-PACKARD COMPANY, nor the names of its
+ * 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.  No right of
- * sublicense is granted herewith.  Derivatives of the software and
- * output created using the software may be prepared, but only for
- * Non-Commercial Uses.  Derivatives of the software may be shared with
- * others provided: (i) the others agree to abide by the list of
- * conditions herein which includes the Non-Commercial Use restrictions;
- * and (ii) such Derivatives of the software include the above copyright
- * notice to acknowledge the contribution from this software where
- * applicable, this list of conditions and the disclaimer below.
+ * 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
 #ifndef __ARCH_X86_UTILITY_HH__
 #define __ARCH_X86_UTILITY_HH__
 
-#include "arch/x86/types.hh"
-#include "base/hashmap.hh"
-#include "base/misc.hh"
+#include "cpu/static_inst.hh"
 #include "cpu/thread_context.hh"
-#include "sim/host.hh"
-
-class ThreadContext;
-
-namespace __hash_namespace {
-    template<>
-    struct hash<X86ISA::ExtMachInst> {
-        size_t operator()(const X86ISA::ExtMachInst &emi) const {
-            return (((uint64_t)emi.legacy << 56) |
-                    ((uint64_t)emi.rex  << 48) |
-                    ((uint64_t)emi.modRM << 40) |
-                    ((uint64_t)emi.sib << 32) |
-                    ((uint64_t)emi.opcode.num << 24) |
-                    ((uint64_t)emi.opcode.prefixA << 16) |
-                    ((uint64_t)emi.opcode.prefixB << 8) |
-                    ((uint64_t)emi.opcode.op)) ^
-                    emi.immediate ^ emi.displacement ^
-                    emi.mode ^
-                    emi.opSize ^ emi.addrSize ^ emi.stackSize;
-        };
-    };
-}
+#include "sim/full_system.hh"
 
 namespace X86ISA
 {
+
+    inline PCState
+    buildRetPC(const PCState &curPC, const PCState &callPC)
+    {
+        PCState retPC = callPC;
+        retPC.uEnd();
+        return retPC;
+    }
+
+    uint64_t
+    getArgument(ThreadContext *tc, int &number, uint16_t size, bool fp);
+
     static inline bool
     inUserMode(ThreadContext *tc)
     {
-        return false;
+        if (!FullSystem) {
+            return true;
+        } else {
+            HandyM5Reg m5reg = tc->readMiscRegNoEffect(MISCREG_M5_REG);
+            return m5reg.cpl == 3;
+        }
     }
 
-    inline bool isCallerSaveIntegerRegister(unsigned int reg) {
-        panic("register classification not implemented");
-        return false;
-    }
+    /**
+     * Function to insure ISA semantics about 0 registers.
+     * @param tc The thread context.
+     */
+    template <class TC>
+    void zeroRegisters(TC *tc);
 
-    inline bool isCalleeSaveIntegerRegister(unsigned int reg) {
-        panic("register classification not implemented");
-        return false;
-    }
+    void initCPU(ThreadContext *tc, int cpuId);
 
-    inline bool isCallerSaveFloatRegister(unsigned int reg) {
-        panic("register classification not implemented");
-        return false;
-    }
+    void startupCPU(ThreadContext *tc, int cpuId);
 
-    inline bool isCalleeSaveFloatRegister(unsigned int reg) {
-        panic("register classification not implemented");
-        return false;
-    }
+    void copyRegs(ThreadContext *src, ThreadContext *dest);
 
-    // Instruction address compression hooks
-    inline Addr realPCToFetchPC(const Addr &addr)
-    {
-        return addr;
-    }
+    void copyMiscRegs(ThreadContext *src, ThreadContext *dest);
+
+    void skipFunction(ThreadContext *tc);
 
-    inline Addr fetchPCToRealPC(const Addr &addr)
+    inline void
+    advancePC(PCState &pc, const StaticInstPtr &inst)
     {
-        return addr;
+        inst->advancePC(pc);
     }
 
-    // the size of "fetched" instructions (not necessarily the size
-    // of real instructions for PISA)
-    inline size_t fetchInstSize()
+    inline uint64_t
+    getExecutingAsid(ThreadContext *tc)
     {
-        return sizeof(MachInst);
+        return 0;
     }
 
+
     /**
-     * Function to insure ISA semantics about 0 registers.
-     * @param tc The thread context.
+     * Reconstruct the rflags register from the internal gem5 register
+     * state.
+     *
+     * gem5 stores rflags in several different registers to avoid
+     * pipeline dependencies. In order to get the true rflags value,
+     * we can't simply read the value of MISCREG_RFLAGS. Instead, we
+     * need to read out various state from microcode registers and
+     * merge that with MISCREG_RFLAGS.
+     *
+     * @param tc Thread context to read rflags from.
+     * @return rflags as seen by the guest.
      */
-    template <class TC>
-    void zeroRegisters(TC *tc);
+    uint64_t getRFlags(ThreadContext *tc);
 
-    inline void initCPU(ThreadContext *tc, int cpuId)
-    {
-        panic("initCPU not implemented!\n");
-    }
+    /**
+     * Set update the rflags register and internal gem5 state.
+     *
+     * @note This function does not update MISCREG_M5_REG. You might
+     * need to update this register by writing anything to
+     * MISCREG_M5_REG with side-effects.
+     *
+     * @see X86ISA::getRFlags()
+     *
+     * @param tc Thread context to update
+     * @param val New rflags value to store in TC
+     */
+    void setRFlags(ThreadContext *tc, uint64_t val);
 
-    inline void startupCPU(ThreadContext *tc, int cpuId)
-    {
-        tc->activate(0);
+    /**
+     * Extract the bit string representing a double value.
+     */
+    inline uint64_t getDoubleBits(double val) {
+        return *(uint64_t *)(&val);
     }
-};
+
+    /**
+     * Convert an x87 tag word to abridged tag format.
+     *
+     * Convert from the x87 tag representation to the tag abridged
+     * representation used in the FXSAVE area. The classic format uses
+     * 2 bits per stack position to indicate if a position is valid,
+     * zero, special, or empty. The abridged format only stores
+     * whether a position is empty or not.
+     *
+     * @param ftw Tag word in classic x87 format.
+     * @return Tag word in the abridged format.
+     */
+    uint8_t convX87TagsToXTags(uint16_t ftw);
+
+    /**
+     * Convert an x87 xtag word to normal tags format.
+     *
+     * Convert from the abridged x87 tag representation used in the
+     * FXSAVE area to a full x87 tag. The classic format uses 2 bits
+     * per stack position to indicate if a position is valid, zero,
+     * special, or empty. The abridged format only stores whether a
+     * position is empty or not.
+     *
+     * @todo Reconstruct the correct state of stack positions instead
+     * of just valid/invalid.
+     *
+     * @param ftwx Tag word in the abridged format.
+     * @return Tag word in classic x87 format.
+     */
+    uint16_t convX87XTagsToTags(uint8_t ftwx);
+
+    /**
+     * Generate and updated x87 tag register after a push/pop
+     * operation.
+     *
+     * @note There is currently no support for setting other tags than
+     * valid and invalid. A real x87 will set the tag value to zero or
+     * special for some special floating point values.
+     *
+     * @param ftw Current value of the FTW register.
+     * @param top Current x87 TOP value.
+     * @param spm Stack displacement.
+     * @return New value of the FTW register.
+     */
+    uint16_t genX87Tags(uint16_t ftw, uint8_t top, int8_t spm);
+
+    /**
+     * Load an 80-bit float from memory and convert it to double.
+     *
+     * @param mem Pointer to an 80-bit float.
+     * @return double representation of the 80-bit float.
+     */
+    double loadFloat80(const void *mem);
+
+    /**
+     * Convert and store a double as an 80-bit float.
+     *
+     * @param mem Pointer to destination for the 80-bit float.
+     * @param value Double precision float to store.
+     */
+    void storeFloat80(void *mem, double value);
+}
 
 #endif // __ARCH_X86_UTILITY_HH__