gem5/src/mem/request.hh
Gabe Black b289966a78 Mem: Reclaim some request flags used by MIPS for alignment checking.
These flags were being used to identify what alignment a request needed, but
the same information is available using the request size. This change also
eliminates the isMisaligned function. If more complicated alignment checks are
needed, they can be signaled using the ASI_BITS space in the flags vector like
is currently done with ARM.
2010-10-16 00:00:54 -07:00

460 lines
14 KiB
C++

/*
* Copyright (c) 2002-2005 The Regents of The University of Michigan
* All rights reserved.
*
* 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.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Authors: Ron Dreslinski
* Steve Reinhardt
* Ali Saidi
*/
/**
* @file
* Declaration of a request, the overall memory request consisting of
the parts of the request that are persistent throughout the transaction.
*/
#ifndef __MEM_REQUEST_HH__
#define __MEM_REQUEST_HH__
#include <cassert>
#include "base/fast_alloc.hh"
#include "base/flags.hh"
#include "base/misc.hh"
#include "base/types.hh"
#include "sim/core.hh"
class Request;
typedef Request* RequestPtr;
class Request : public FastAlloc
{
public:
typedef uint32_t FlagsType;
typedef ::Flags<FlagsType> Flags;
/** ASI information for this request if it exists. */
static const FlagsType ASI_BITS = 0x000000FF;
/** The request was an instruction fetch. */
static const FlagsType INST_FETCH = 0x00000100;
/** The virtual address is also the physical address. */
static const FlagsType PHYSICAL = 0x00000200;
/** The request is an ALPHA VPTE pal access (hw_ld). */
static const FlagsType VPTE = 0x00000400;
/** Use the alternate mode bits in ALPHA. */
static const FlagsType ALTMODE = 0x00000800;
/** The request is to an uncacheable address. */
static const FlagsType UNCACHEABLE = 0x00001000;
/** This request is to a memory mapped register. */
static const FlagsType MMAPED_IPR = 0x00002000;
/** This request is a clear exclusive. */
static const FlagsType CLEAR_LL = 0x00004000;
/** The request should not cause a memory access. */
static const FlagsType NO_ACCESS = 0x00080000;
/** This request will lock or unlock the accessed memory. When used with
* a load, the access locks the particular chunk of memory. When used
* with a store, it unlocks. The rule is that locked accesses have to be
* made up of a locked load, some operation on the data, and then a locked
* store.
*/
static const FlagsType LOCKED = 0x00100000;
/** The request is a Load locked/store conditional. */
static const FlagsType LLSC = 0x00200000;
/** This request is for a memory swap. */
static const FlagsType MEM_SWAP = 0x00400000;
static const FlagsType MEM_SWAP_COND = 0x00800000;
/** The request is a prefetch. */
static const FlagsType PREFETCH = 0x01000000;
/** The request should be prefetched into the exclusive state. */
static const FlagsType PF_EXCLUSIVE = 0x02000000;
/** The request should be marked as LRU. */
static const FlagsType EVICT_NEXT = 0x04000000;
/** These flags are *not* cleared when a Request object is reused
(assigned a new address). */
static const FlagsType STICKY_FLAGS = INST_FETCH;
private:
typedef uint8_t PrivateFlagsType;
typedef ::Flags<PrivateFlagsType> PrivateFlags;
/** Whether or not the size is valid. */
static const PrivateFlagsType VALID_SIZE = 0x00000001;
/** Whether or not paddr is valid (has been written yet). */
static const PrivateFlagsType VALID_PADDR = 0x00000002;
/** Whether or not the vaddr & asid are valid. */
static const PrivateFlagsType VALID_VADDR = 0x00000004;
/** Whether or not the pc is valid. */
static const PrivateFlagsType VALID_PC = 0x00000010;
/** Whether or not the context ID is valid. */
static const PrivateFlagsType VALID_CONTEXT_ID = 0x00000020;
static const PrivateFlagsType VALID_THREAD_ID = 0x00000040;
/** Whether or not the sc result is valid. */
static const PrivateFlagsType VALID_EXTRA_DATA = 0x00000080;
/** These flags are *not* cleared when a Request object is reused
(assigned a new address). */
static const PrivateFlagsType STICKY_PRIVATE_FLAGS =
VALID_CONTEXT_ID | VALID_THREAD_ID;
private:
/**
* The physical address of the request. Valid only if validPaddr
* is set.
*/
Addr _paddr;
/**
* The size of the request. This field must be set when vaddr or
* paddr is written via setVirt() or setPhys(), so it is always
* valid as long as one of the address fields is valid.
*/
int _size;
/** Flag structure for the request. */
Flags _flags;
/** Private flags for field validity checking. */
PrivateFlags privateFlags;
/**
* The time this request was started. Used to calculate
* latencies. This field is set to curTick any time paddr or vaddr
* is written.
*/
Tick _time;
/** The address space ID. */
int _asid;
/** The virtual address of the request. */
Addr _vaddr;
/**
* Extra data for the request, such as the return value of
* store conditional or the compare value for a CAS. */
uint64_t _extraData;
/** The context ID (for statistics, typically). */
int _contextId;
/** The thread ID (id within this CPU) */
int _threadId;
/** program counter of initiating access; for tracing/debugging */
Addr _pc;
public:
/** Minimal constructor. No fields are initialized.
* (Note that _flags and privateFlags are cleared by Flags
* default constructor.)
*/
Request()
{}
/**
* Constructor for physical (e.g. device) requests. Initializes
* just physical address, size, flags, and timestamp (to curTick).
* These fields are adequate to perform a request.
*/
Request(Addr paddr, int size, Flags flags)
{
setPhys(paddr, size, flags);
}
Request(Addr paddr, int size, Flags flags, Tick time)
{
setPhys(paddr, size, flags, time);
}
Request(Addr paddr, int size, Flags flags, Tick time, Addr pc)
{
setPhys(paddr, size, flags, time);
privateFlags.set(VALID_PC);
_pc = pc;
}
Request(int asid, Addr vaddr, int size, Flags flags, Addr pc,
int cid, ThreadID tid)
{
setVirt(asid, vaddr, size, flags, pc);
setThreadContext(cid, tid);
}
~Request() {} // for FastAlloc
/**
* Set up CPU and thread numbers.
*/
void
setThreadContext(int context_id, ThreadID tid)
{
_contextId = context_id;
_threadId = tid;
privateFlags.set(VALID_CONTEXT_ID|VALID_THREAD_ID);
}
/**
* Set up a physical (e.g. device) request in a previously
* allocated Request object.
*/
void
setPhys(Addr paddr, int size, Flags flags, Tick time)
{
assert(size >= 0);
_paddr = paddr;
_size = size;
_time = time;
_flags.clear(~STICKY_FLAGS);
_flags.set(flags);
privateFlags.clear(~STICKY_PRIVATE_FLAGS);
privateFlags.set(VALID_PADDR|VALID_SIZE);
}
void
setPhys(Addr paddr, int size, Flags flags)
{
setPhys(paddr, size, flags, curTick);
}
/**
* Set up a virtual (e.g., CPU) request in a previously
* allocated Request object.
*/
void
setVirt(int asid, Addr vaddr, int size, Flags flags, Addr pc)
{
assert(size >= 0);
_asid = asid;
_vaddr = vaddr;
_size = size;
_pc = pc;
_time = curTick;
_flags.clear(~STICKY_FLAGS);
_flags.set(flags);
privateFlags.clear(~STICKY_PRIVATE_FLAGS);
privateFlags.set(VALID_VADDR|VALID_SIZE|VALID_PC);
}
/**
* Set just the physical address. This should only be used to
* record the result of a translation, and thus the vaddr must be
* valid before this method is called. Otherwise, use setPhys()
* to guarantee that the size and flags are also set.
*/
void
setPaddr(Addr paddr)
{
assert(privateFlags.isSet(VALID_VADDR));
_paddr = paddr;
privateFlags.set(VALID_PADDR);
}
/**
* Generate two requests as if this request had been split into two
* pieces. The original request can't have been translated already.
*/
void splitOnVaddr(Addr split_addr, RequestPtr &req1, RequestPtr &req2)
{
assert(privateFlags.isSet(VALID_VADDR));
assert(privateFlags.noneSet(VALID_PADDR));
assert(split_addr > _vaddr && split_addr < _vaddr + _size);
req1 = new Request;
*req1 = *this;
req2 = new Request;
*req2 = *this;
req1->_size = split_addr - _vaddr;
req2->_vaddr = split_addr;
req2->_size = _size - req1->_size;
}
/**
* Accessor for paddr.
*/
bool
hasPaddr()
{
return privateFlags.isSet(VALID_PADDR);
}
Addr
getPaddr()
{
assert(privateFlags.isSet(VALID_PADDR));
return _paddr;
}
/**
* Accessor for size.
*/
bool
hasSize()
{
return privateFlags.isSet(VALID_SIZE);
}
int
getSize()
{
assert(privateFlags.isSet(VALID_SIZE));
return _size;
}
/** Accessor for time. */
Tick
time() const
{
assert(privateFlags.isSet(VALID_PADDR|VALID_VADDR));
return _time;
}
void
time(Tick time)
{
assert(privateFlags.isSet(VALID_PADDR|VALID_VADDR));
_time = time;
}
/** Accessor for flags. */
Flags
getFlags()
{
assert(privateFlags.isSet(VALID_PADDR|VALID_VADDR));
return _flags;
}
/** Note that unlike other accessors, this function sets *specific
flags* (ORs them in); it does not assign its argument to the
_flags field. Thus this method should rightly be called
setFlags() and not just flags(). */
void
setFlags(Flags flags)
{
assert(privateFlags.isSet(VALID_PADDR|VALID_VADDR));
_flags.set(flags);
}
/** Accessor function for vaddr.*/
Addr
getVaddr()
{
assert(privateFlags.isSet(VALID_VADDR));
return _vaddr;
}
/** Accessor function for asid.*/
int
getAsid()
{
assert(privateFlags.isSet(VALID_VADDR));
return _asid;
}
/** Accessor function for asi.*/
uint8_t
getAsi()
{
assert(privateFlags.isSet(VALID_VADDR));
return _flags & ASI_BITS;
}
/** Accessor function to check if sc result is valid. */
bool
extraDataValid()
{
return privateFlags.isSet(VALID_EXTRA_DATA);
}
/** Accessor function for store conditional return value.*/
uint64_t
getExtraData() const
{
assert(privateFlags.isSet(VALID_EXTRA_DATA));
return _extraData;
}
/** Accessor function for store conditional return value.*/
void
setExtraData(uint64_t extraData)
{
_extraData = extraData;
privateFlags.set(VALID_EXTRA_DATA);
}
bool
hasContextId() const
{
return privateFlags.isSet(VALID_CONTEXT_ID);
}
/** Accessor function for context ID.*/
int
contextId() const
{
assert(privateFlags.isSet(VALID_CONTEXT_ID));
return _contextId;
}
/** Accessor function for thread ID. */
int
threadId() const
{
assert(privateFlags.isSet(VALID_THREAD_ID));
return _threadId;
}
bool
hasPC() const
{
return privateFlags.isSet(VALID_PC);
}
/** Accessor function for pc.*/
Addr
getPC() const
{
assert(privateFlags.isSet(VALID_PC));
return _pc;
}
/** Accessor functions for flags. Note that these are for testing
only; setting flags should be done via setFlags(). */
bool isUncacheable() const { return _flags.isSet(UNCACHEABLE); }
bool isInstFetch() const { return _flags.isSet(INST_FETCH); }
bool isPrefetch() const { return _flags.isSet(PREFETCH); }
bool isLLSC() const { return _flags.isSet(LLSC); }
bool isLocked() const { return _flags.isSet(LOCKED); }
bool isSwap() const { return _flags.isSet(MEM_SWAP|MEM_SWAP_COND); }
bool isCondSwap() const { return _flags.isSet(MEM_SWAP_COND); }
bool isMmapedIpr() const { return _flags.isSet(MMAPED_IPR); }
bool isClearLL() const { return _flags.isSet(CLEAR_LL); }
};
#endif // __MEM_REQUEST_HH__