request.hh revision 3170
12381SN/A/* 22381SN/A * Copyright (c) 2002-2005 The Regents of The University of Michigan 32381SN/A * All rights reserved. 42381SN/A * 52381SN/A * Redistribution and use in source and binary forms, with or without 62381SN/A * modification, are permitted provided that the following conditions are 72381SN/A * met: redistributions of source code must retain the above copyright 82381SN/A * notice, this list of conditions and the following disclaimer; 92381SN/A * redistributions in binary form must reproduce the above copyright 102381SN/A * notice, this list of conditions and the following disclaimer in the 112381SN/A * documentation and/or other materials provided with the distribution; 122381SN/A * neither the name of the copyright holders nor the names of its 132381SN/A * contributors may be used to endorse or promote products derived from 142381SN/A * this software without specific prior written permission. 152381SN/A * 162381SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 172381SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 182381SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 192381SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 202381SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 212381SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 222381SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 232381SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 242381SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 252381SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 262381SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272665Ssaidi@eecs.umich.edu * 282665Ssaidi@eecs.umich.edu * Authors: Ron Dreslinski 292665Ssaidi@eecs.umich.edu * Steve Reinhardt 302665Ssaidi@eecs.umich.edu * Ali Saidi 312381SN/A */ 322381SN/A 332381SN/A/** 342982Sstever@eecs.umich.edu * @file 352982Sstever@eecs.umich.edu * Declaration of a request, the overall memory request consisting of 362381SN/A the parts of the request that are persistent throughout the transaction. 372381SN/A */ 382381SN/A 392381SN/A#ifndef __MEM_REQUEST_HH__ 402381SN/A#define __MEM_REQUEST_HH__ 412381SN/A 422980Sgblack@eecs.umich.edu#include "sim/host.hh" 432972Sgblack@eecs.umich.edu#include "sim/root.hh" 442394SN/A 452989Ssaidi@eecs.umich.edu#include <cassert> 462989Ssaidi@eecs.umich.edu 472394SN/Aclass Request; 482394SN/A 492394SN/Atypedef Request* RequestPtr; 502394SN/A 512812Srdreslin@umich.edu 522395SN/A/** The request is a Load locked/store conditional. */ 532395SN/Aconst unsigned LOCKED = 0x001; 542395SN/A/** The virtual address is also the physical address. */ 552395SN/Aconst unsigned PHYSICAL = 0x002; 562395SN/A/** The request is an ALPHA VPTE pal access (hw_ld). */ 572395SN/Aconst unsigned VPTE = 0x004; 582395SN/A/** Use the alternate mode bits in ALPHA. */ 592395SN/Aconst unsigned ALTMODE = 0x008; 602395SN/A/** The request is to an uncacheable address. */ 612395SN/Aconst unsigned UNCACHEABLE = 0x010; 622395SN/A/** The request should not cause a page fault. */ 632395SN/Aconst unsigned NO_FAULT = 0x020; 642397SN/A/** The request should be prefetched into the exclusive state. */ 652397SN/Aconst unsigned PF_EXCLUSIVE = 0x100; 662397SN/A/** The request should be marked as LRU. */ 672397SN/Aconst unsigned EVICT_NEXT = 0x200; 682495SN/A/** The request should ignore unaligned access faults */ 692495SN/Aconst unsigned NO_ALIGN_FAULT = 0x400; 702814Srdreslin@umich.edu/** The request was an instruction read. */ 712814Srdreslin@umich.educonst unsigned INST_READ = 0x800; 722395SN/A 732381SN/Aclass Request 742381SN/A{ 752663Sstever@eecs.umich.edu private: 762663Sstever@eecs.umich.edu /** 772663Sstever@eecs.umich.edu * The physical address of the request. Valid only if validPaddr 782663Sstever@eecs.umich.edu * is set. */ 792663Sstever@eecs.umich.edu Addr paddr; 802532SN/A 812663Sstever@eecs.umich.edu /** 822663Sstever@eecs.umich.edu * The size of the request. This field must be set when vaddr or 832663Sstever@eecs.umich.edu * paddr is written via setVirt() or setPhys(), so it is always 842663Sstever@eecs.umich.edu * valid as long as one of the address fields is valid. */ 852381SN/A int size; 862395SN/A 872532SN/A /** Flag structure for the request. */ 882395SN/A uint32_t flags; 892384SN/A 902663Sstever@eecs.umich.edu /** 912663Sstever@eecs.umich.edu * The time this request was started. Used to calculate 922663Sstever@eecs.umich.edu * latencies. This field is set to curTick any time paddr or vaddr 932663Sstever@eecs.umich.edu * is written. */ 942663Sstever@eecs.umich.edu Tick time; 952384SN/A 962384SN/A /** The address space ID. */ 972384SN/A int asid; 982663Sstever@eecs.umich.edu /** The virtual address of the request. */ 992663Sstever@eecs.umich.edu Addr vaddr; 1002384SN/A 1012384SN/A /** The return value of store conditional. */ 1022384SN/A uint64_t scResult; 1032384SN/A 1042663Sstever@eecs.umich.edu /** The cpu number (for statistics, typically). */ 1052384SN/A int cpuNum; 1062663Sstever@eecs.umich.edu /** The requesting thread id (for statistics, typically). */ 1072384SN/A int threadNum; 1082384SN/A 1092381SN/A /** program counter of initiating access; for tracing/debugging */ 1102381SN/A Addr pc; 1112663Sstever@eecs.umich.edu 1122663Sstever@eecs.umich.edu /** Whether or not paddr is valid (has been written yet). */ 1132663Sstever@eecs.umich.edu bool validPaddr; 1142663Sstever@eecs.umich.edu /** Whether or not the asid & vaddr are valid. */ 1152663Sstever@eecs.umich.edu bool validAsidVaddr; 1162663Sstever@eecs.umich.edu /** Whether or not the sc result is valid. */ 1172663Sstever@eecs.umich.edu bool validScResult; 1182663Sstever@eecs.umich.edu /** Whether or not the cpu number & thread ID are valid. */ 1192663Sstever@eecs.umich.edu bool validCpuAndThreadNums; 1202663Sstever@eecs.umich.edu /** Whether or not the pc is valid. */ 1212532SN/A bool validPC; 1222532SN/A 1232532SN/A public: 1242663Sstever@eecs.umich.edu /** Minimal constructor. No fields are initialized. */ 1252663Sstever@eecs.umich.edu Request() 1262663Sstever@eecs.umich.edu : validPaddr(false), validAsidVaddr(false), 1272663Sstever@eecs.umich.edu validScResult(false), validCpuAndThreadNums(false), validPC(false) 1282663Sstever@eecs.umich.edu {} 1292532SN/A 1302663Sstever@eecs.umich.edu /** 1312663Sstever@eecs.umich.edu * Constructor for physical (e.g. device) requests. Initializes 1322663Sstever@eecs.umich.edu * just physical address, size, flags, and timestamp (to curTick). 1332663Sstever@eecs.umich.edu * These fields are adequate to perform a request. */ 1342663Sstever@eecs.umich.edu Request(Addr _paddr, int _size, int _flags) 1352663Sstever@eecs.umich.edu : validCpuAndThreadNums(false) 1362663Sstever@eecs.umich.edu { setPhys(_paddr, _size, _flags); } 1372532SN/A 1382669Sktlim@umich.edu Request(int _asid, Addr _vaddr, int _size, int _flags, Addr _pc, 1392669Sktlim@umich.edu int _cpuNum, int _threadNum) 1402669Sktlim@umich.edu { 1412669Sktlim@umich.edu setThreadContext(_cpuNum, _threadNum); 1422669Sktlim@umich.edu setVirt(_asid, _vaddr, _size, _flags, _pc); 1432669Sktlim@umich.edu } 1442669Sktlim@umich.edu 1452663Sstever@eecs.umich.edu /** 1462663Sstever@eecs.umich.edu * Set up CPU and thread numbers. */ 1472663Sstever@eecs.umich.edu void setThreadContext(int _cpuNum, int _threadNum) 1482663Sstever@eecs.umich.edu { 1492663Sstever@eecs.umich.edu cpuNum = _cpuNum; 1502663Sstever@eecs.umich.edu threadNum = _threadNum; 1512663Sstever@eecs.umich.edu validCpuAndThreadNums = true; 1522663Sstever@eecs.umich.edu } 1532532SN/A 1542663Sstever@eecs.umich.edu /** 1552663Sstever@eecs.umich.edu * Set up a physical (e.g. device) request in a previously 1562663Sstever@eecs.umich.edu * allocated Request object. */ 1572663Sstever@eecs.umich.edu void setPhys(Addr _paddr, int _size, int _flags) 1582663Sstever@eecs.umich.edu { 1592663Sstever@eecs.umich.edu paddr = _paddr; 1602663Sstever@eecs.umich.edu size = _size; 1612663Sstever@eecs.umich.edu flags = _flags; 1622663Sstever@eecs.umich.edu time = curTick; 1632663Sstever@eecs.umich.edu validPaddr = true; 1642663Sstever@eecs.umich.edu validAsidVaddr = false; 1652663Sstever@eecs.umich.edu validPC = false; 1662663Sstever@eecs.umich.edu validScResult = false; 1672663Sstever@eecs.umich.edu } 1682532SN/A 1692663Sstever@eecs.umich.edu /** 1702663Sstever@eecs.umich.edu * Set up a virtual (e.g., CPU) request in a previously 1712663Sstever@eecs.umich.edu * allocated Request object. */ 1722663Sstever@eecs.umich.edu void setVirt(int _asid, Addr _vaddr, int _size, int _flags, Addr _pc) 1732663Sstever@eecs.umich.edu { 1742663Sstever@eecs.umich.edu asid = _asid; 1752663Sstever@eecs.umich.edu vaddr = _vaddr; 1762663Sstever@eecs.umich.edu size = _size; 1772663Sstever@eecs.umich.edu flags = _flags; 1782663Sstever@eecs.umich.edu pc = _pc; 1792663Sstever@eecs.umich.edu time = curTick; 1802663Sstever@eecs.umich.edu validPaddr = false; 1812663Sstever@eecs.umich.edu validAsidVaddr = true; 1822663Sstever@eecs.umich.edu validPC = true; 1832663Sstever@eecs.umich.edu validScResult = false; 1842663Sstever@eecs.umich.edu } 1852532SN/A 1862663Sstever@eecs.umich.edu /** Set just the physical address. This should only be used to 1872663Sstever@eecs.umich.edu * record the result of a translation, and thus the vaddr must be 1882663Sstever@eecs.umich.edu * valid before this method is called. Otherwise, use setPhys() 1892663Sstever@eecs.umich.edu * to guarantee that the size and flags are also set. 1902663Sstever@eecs.umich.edu */ 1912663Sstever@eecs.umich.edu void setPaddr(Addr _paddr) 1922663Sstever@eecs.umich.edu { 1932663Sstever@eecs.umich.edu assert(validAsidVaddr); 1942663Sstever@eecs.umich.edu paddr = _paddr; 1952663Sstever@eecs.umich.edu validPaddr = true; 1962663Sstever@eecs.umich.edu } 1972532SN/A 1982663Sstever@eecs.umich.edu /** Accessor for paddr. */ 1992663Sstever@eecs.umich.edu Addr getPaddr() { assert(validPaddr); return paddr; } 2002663Sstever@eecs.umich.edu 2012663Sstever@eecs.umich.edu /** Accessor for size. */ 2022663Sstever@eecs.umich.edu int getSize() { assert(validPaddr || validAsidVaddr); return size; } 2032663Sstever@eecs.umich.edu /** Accessor for time. */ 2042663Sstever@eecs.umich.edu Tick getTime() { assert(validPaddr || validAsidVaddr); return time; } 2052663Sstever@eecs.umich.edu 2062663Sstever@eecs.umich.edu /** Accessor for flags. */ 2072663Sstever@eecs.umich.edu uint32_t getFlags() { assert(validPaddr || validAsidVaddr); return flags; } 2082663Sstever@eecs.umich.edu /** Accessor for paddr. */ 2092663Sstever@eecs.umich.edu void setFlags(uint32_t _flags) 2102663Sstever@eecs.umich.edu { assert(validPaddr || validAsidVaddr); flags = _flags; } 2112663Sstever@eecs.umich.edu 2122663Sstever@eecs.umich.edu /** Accessor function for vaddr.*/ 2132663Sstever@eecs.umich.edu Addr getVaddr() { assert(validAsidVaddr); return vaddr; } 2142663Sstever@eecs.umich.edu 2152663Sstever@eecs.umich.edu /** Accessor function for asid.*/ 2162663Sstever@eecs.umich.edu int getAsid() { assert(validAsidVaddr); return asid; } 2172663Sstever@eecs.umich.edu 2182679Sktlim@umich.edu /** Accessor function to check if sc result is valid. */ 2192679Sktlim@umich.edu bool scResultValid() { return validScResult; } 2202663Sstever@eecs.umich.edu /** Accessor function for store conditional return value.*/ 2212663Sstever@eecs.umich.edu uint64_t getScResult() { assert(validScResult); return scResult; } 2222663Sstever@eecs.umich.edu /** Accessor function for store conditional return value.*/ 2232663Sstever@eecs.umich.edu void setScResult(uint64_t _scResult) 2242663Sstever@eecs.umich.edu { scResult = _scResult; validScResult = true; } 2252663Sstever@eecs.umich.edu 2262663Sstever@eecs.umich.edu /** Accessor function for cpu number.*/ 2272663Sstever@eecs.umich.edu int getCpuNum() { assert(validCpuAndThreadNums); return cpuNum; } 2282663Sstever@eecs.umich.edu /** Accessor function for thread number.*/ 2292663Sstever@eecs.umich.edu int getThreadNum() { assert(validCpuAndThreadNums); return threadNum; } 2302663Sstever@eecs.umich.edu 2312663Sstever@eecs.umich.edu /** Accessor function for pc.*/ 2322663Sstever@eecs.umich.edu Addr getPC() { assert(validPC); return pc; } 2332532SN/A 2342811Srdreslin@umich.edu /** Accessor Function to Check Cacheability. */ 2353170Sstever@eecs.umich.edu bool isUncacheable() { return (getFlags() & UNCACHEABLE) != 0; } 2362811Srdreslin@umich.edu 2373170Sstever@eecs.umich.edu bool isInstRead() { return (getFlags() & INST_READ) != 0; } 2383170Sstever@eecs.umich.edu 2393170Sstever@eecs.umich.edu bool isLocked() { return (getFlags() & LOCKED) != 0; } 2402814Srdreslin@umich.edu 2412641Sstever@eecs.umich.edu friend class Packet; 2422384SN/A}; 2432381SN/A 2442381SN/A#endif // __MEM_REQUEST_HH__ 245