src/arch/generic/memhelpers.hh

   1 /*
   2  * Copyright (c) 2011 Google
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Gabe Black
  29  */
  30
  31 #ifndef __ARCH_GENERIC_MEMHELPERS_HH__
  32 #define __ARCH_GENERIC_MEMHELPERS_HH__
  33
  34 #include "base/types.hh"
  35 #include "sim/byteswap.hh"
  36 #include "sim/fault_fwd.hh"
  37 #include "sim/insttracer.hh"
  38
  39 /// Read from memory in timing mode.
  40 template <class XC, class MemT>
  41 Fault
  42 readMemTiming(XC *xc, Trace::InstRecord *traceData, Addr addr,
  43         MemT &mem, unsigned flags)
  44 {
  45     return xc->readMem(addr, (uint8_t *)&mem, sizeof(MemT), flags);
  46 }
  47
  48 /// Extract the data returned from a timing mode read.
  49 template <class MemT>
  50 void
  51 getMem(PacketPtr pkt, MemT &mem, Trace::InstRecord *traceData)
  52 {
  53     mem = pkt->get<MemT>();
  54     if (traceData)
  55         traceData->setData(mem);
  56 }
  57
  58 /// Read from memory in atomic mode.
  59 template <class XC, class MemT>
  60 Fault
  61 readMemAtomic(XC *xc, Trace::InstRecord *traceData, Addr addr, MemT &mem,
  62         unsigned flags)
  63 {
  64     memset(&mem, 0, sizeof(mem));
  65     Fault fault = readMemTiming(xc, traceData, addr, mem, flags);
  66     if (fault == NoFault) {
  67         mem = gtoh(mem);
  68         if (traceData)
  69             traceData->setData(mem);
  70     }
  71     return fault;
  72 }
  73
  74 /// Write to memory in timing mode.
  75 template <class XC, class MemT>
  76 Fault
  77 writeMemTiming(XC *xc, Trace::InstRecord *traceData, MemT mem, Addr addr,
  78         unsigned flags, uint64_t *res)
  79 {
  80     if (traceData) {
  81         traceData->setData(mem);
  82     }
  83     mem = TheISA::htog(mem);
  84     return xc->writeMem((uint8_t *)&mem, sizeof(MemT), addr, flags, res);
  85 }
  86
  87 /// Write to memory in atomic mode.
  88 template <class XC, class MemT>
  89 Fault
  90 writeMemAtomic(XC *xc, Trace::InstRecord *traceData, const MemT &mem,
  91         Addr addr, unsigned flags, uint64_t *res)
  92 {
  93     Fault fault = writeMemTiming(xc, traceData, mem, addr, flags, res);
  94     if (fault == NoFault && res != NULL) {
  95         *res = gtoh((MemT)*res);
  96     }
  97     return fault;
  98 }
  99
 100 #endif