packet.cc revision 6076
12568SN/A/* 22568SN/A * Copyright (c) 2006 The Regents of The University of Michigan 32568SN/A * All rights reserved. 42568SN/A * 52568SN/A * Redistribution and use in source and binary forms, with or without 62568SN/A * modification, are permitted provided that the following conditions are 72568SN/A * met: redistributions of source code must retain the above copyright 82568SN/A * notice, this list of conditions and the following disclaimer; 92568SN/A * redistributions in binary form must reproduce the above copyright 102568SN/A * notice, this list of conditions and the following disclaimer in the 112568SN/A * documentation and/or other materials provided with the distribution; 122568SN/A * neither the name of the copyright holders nor the names of its 132568SN/A * contributors may be used to endorse or promote products derived from 142568SN/A * this software without specific prior written permission. 152568SN/A * 162568SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 172568SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 182568SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 192568SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 202568SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 212568SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 222568SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 232568SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 242568SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 252568SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 262568SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 272665Ssaidi@eecs.umich.edu * 282665Ssaidi@eecs.umich.edu * Authors: Ali Saidi 292665Ssaidi@eecs.umich.edu * Steve Reinhardt 302568SN/A */ 312568SN/A 322568SN/A/** 332568SN/A * @file 342568SN/A * Definition of the Packet Class, a packet is a transaction occuring 352568SN/A * between a single level of the memory heirarchy (ie L1->L2). 362568SN/A */ 373260Ssaidi@eecs.umich.edu 383260Ssaidi@eecs.umich.edu#include <iostream> 393918Ssaidi@eecs.umich.edu#include <cstring> 405314Sstever@gmail.com#include "base/cprintf.hh" 412590SN/A#include "base/misc.hh" 423348Sbinkertn@umich.edu#include "base/trace.hh" 432568SN/A#include "mem/packet.hh" 442568SN/A 455735Snate@binkert.orgusing namespace std; 465735Snate@binkert.org 474022Sstever@eecs.umich.edu// The one downside to bitsets is that static initializers can get ugly. 484022Sstever@eecs.umich.edu#define SET1(a1) (1 << (a1)) 494022Sstever@eecs.umich.edu#define SET2(a1, a2) (SET1(a1) | SET1(a2)) 504022Sstever@eecs.umich.edu#define SET3(a1, a2, a3) (SET2(a1, a2) | SET1(a3)) 514022Sstever@eecs.umich.edu#define SET4(a1, a2, a3, a4) (SET3(a1, a2, a3) | SET1(a4)) 524022Sstever@eecs.umich.edu#define SET5(a1, a2, a3, a4, a5) (SET4(a1, a2, a3, a4) | SET1(a5)) 534022Sstever@eecs.umich.edu#define SET6(a1, a2, a3, a4, a5, a6) (SET5(a1, a2, a3, a4, a5) | SET1(a6)) 542641Sstever@eecs.umich.edu 554022Sstever@eecs.umich.educonst MemCmd::CommandInfo 564022Sstever@eecs.umich.eduMemCmd::commandInfo[] = 572641Sstever@eecs.umich.edu{ 584022Sstever@eecs.umich.edu /* InvalidCmd */ 594022Sstever@eecs.umich.edu { 0, InvalidCmd, "InvalidCmd" }, 604022Sstever@eecs.umich.edu /* ReadReq */ 614022Sstever@eecs.umich.edu { SET3(IsRead, IsRequest, NeedsResponse), ReadResp, "ReadReq" }, 624473Sstever@eecs.umich.edu /* ReadResp */ 634473Sstever@eecs.umich.edu { SET3(IsRead, IsResponse, HasData), InvalidCmd, "ReadResp" }, 645319Sstever@gmail.com /* ReadRespWithInvalidate */ 655319Sstever@gmail.com { SET4(IsRead, IsResponse, HasData, IsInvalidate), 665319Sstever@gmail.com InvalidCmd, "ReadRespWithInvalidate" }, 674022Sstever@eecs.umich.edu /* WriteReq */ 684626Sstever@eecs.umich.edu { SET5(IsWrite, NeedsExclusive, IsRequest, NeedsResponse, HasData), 694022Sstever@eecs.umich.edu WriteResp, "WriteReq" }, 704022Sstever@eecs.umich.edu /* WriteResp */ 714626Sstever@eecs.umich.edu { SET3(IsWrite, NeedsExclusive, IsResponse), InvalidCmd, "WriteResp" }, 724022Sstever@eecs.umich.edu /* Writeback */ 734628Sstever@eecs.umich.edu { SET4(IsWrite, NeedsExclusive, IsRequest, HasData), 744628Sstever@eecs.umich.edu InvalidCmd, "Writeback" }, 754022Sstever@eecs.umich.edu /* SoftPFReq */ 764022Sstever@eecs.umich.edu { SET4(IsRead, IsRequest, IsSWPrefetch, NeedsResponse), 774022Sstever@eecs.umich.edu SoftPFResp, "SoftPFReq" }, 784022Sstever@eecs.umich.edu /* HardPFReq */ 794022Sstever@eecs.umich.edu { SET4(IsRead, IsRequest, IsHWPrefetch, NeedsResponse), 804022Sstever@eecs.umich.edu HardPFResp, "HardPFReq" }, 814022Sstever@eecs.umich.edu /* SoftPFResp */ 824022Sstever@eecs.umich.edu { SET4(IsRead, IsResponse, IsSWPrefetch, HasData), 834022Sstever@eecs.umich.edu InvalidCmd, "SoftPFResp" }, 844022Sstever@eecs.umich.edu /* HardPFResp */ 854022Sstever@eecs.umich.edu { SET4(IsRead, IsResponse, IsHWPrefetch, HasData), 864022Sstever@eecs.umich.edu InvalidCmd, "HardPFResp" }, 874022Sstever@eecs.umich.edu /* WriteInvalidateReq */ 884626Sstever@eecs.umich.edu { SET6(IsWrite, NeedsExclusive, IsInvalidate, 894626Sstever@eecs.umich.edu IsRequest, HasData, NeedsResponse), 904022Sstever@eecs.umich.edu WriteInvalidateResp, "WriteInvalidateReq" }, 914022Sstever@eecs.umich.edu /* WriteInvalidateResp */ 925319Sstever@gmail.com { SET3(IsWrite, NeedsExclusive, IsResponse), 934022Sstever@eecs.umich.edu InvalidCmd, "WriteInvalidateResp" }, 944022Sstever@eecs.umich.edu /* UpgradeReq */ 954628Sstever@eecs.umich.edu { SET4(IsInvalidate, NeedsExclusive, IsRequest, NeedsResponse), 964628Sstever@eecs.umich.edu UpgradeResp, "UpgradeReq" }, 974628Sstever@eecs.umich.edu /* UpgradeResp */ 985319Sstever@gmail.com { SET2(NeedsExclusive, IsResponse), 994628Sstever@eecs.umich.edu InvalidCmd, "UpgradeResp" }, 1004022Sstever@eecs.umich.edu /* ReadExReq */ 1014626Sstever@eecs.umich.edu { SET5(IsRead, NeedsExclusive, IsInvalidate, IsRequest, NeedsResponse), 1024022Sstever@eecs.umich.edu ReadExResp, "ReadExReq" }, 1034022Sstever@eecs.umich.edu /* ReadExResp */ 1045319Sstever@gmail.com { SET4(IsRead, NeedsExclusive, IsResponse, HasData), 1054040Ssaidi@eecs.umich.edu InvalidCmd, "ReadExResp" }, 1065507Sstever@gmail.com /* LoadLockedReq: note that we use plain ReadResp as response, so that 1075507Sstever@gmail.com * we can also use ReadRespWithInvalidate when needed */ 1086076Sgblack@eecs.umich.edu { SET4(IsRead, IsLlsc, IsRequest, NeedsResponse), 1095507Sstever@gmail.com ReadResp, "LoadLockedReq" }, 1104626Sstever@eecs.umich.edu /* StoreCondReq */ 1116076Sgblack@eecs.umich.edu { SET6(IsWrite, NeedsExclusive, IsLlsc, 1124626Sstever@eecs.umich.edu IsRequest, NeedsResponse, HasData), 1134626Sstever@eecs.umich.edu StoreCondResp, "StoreCondReq" }, 1144626Sstever@eecs.umich.edu /* StoreCondResp */ 1156076Sgblack@eecs.umich.edu { SET4(IsWrite, NeedsExclusive, IsLlsc, IsResponse), 1164626Sstever@eecs.umich.edu InvalidCmd, "StoreCondResp" }, 1174040Ssaidi@eecs.umich.edu /* SwapReq -- for Swap ldstub type operations */ 1184626Sstever@eecs.umich.edu { SET6(IsRead, IsWrite, NeedsExclusive, IsRequest, HasData, NeedsResponse), 1194040Ssaidi@eecs.umich.edu SwapResp, "SwapReq" }, 1204040Ssaidi@eecs.umich.edu /* SwapResp -- for Swap ldstub type operations */ 1214626Sstever@eecs.umich.edu { SET5(IsRead, IsWrite, NeedsExclusive, IsResponse, HasData), 1224870Sstever@eecs.umich.edu InvalidCmd, "SwapResp" }, 1235650Sgblack@eecs.umich.edu /* IntReq -- for interrupts */ 1245650Sgblack@eecs.umich.edu { SET4(IsWrite, IsRequest, NeedsResponse, HasData), 1256063Sgblack@eecs.umich.edu MessageResp, "MessageReq" }, 1265650Sgblack@eecs.umich.edu /* IntResp -- for interrupts */ 1276063Sgblack@eecs.umich.edu { SET2(IsWrite, IsResponse), InvalidCmd, "MessageResp" }, 1284870Sstever@eecs.umich.edu /* NetworkNackError -- nacked at network layer (not by protocol) */ 1294986Ssaidi@eecs.umich.edu { SET2(IsResponse, IsError), InvalidCmd, "NetworkNackError" }, 1304870Sstever@eecs.umich.edu /* InvalidDestError -- packet dest field invalid */ 1314986Ssaidi@eecs.umich.edu { SET2(IsResponse, IsError), InvalidCmd, "InvalidDestError" }, 1324870Sstever@eecs.umich.edu /* BadAddressError -- memory address invalid */ 1335314Sstever@gmail.com { SET2(IsResponse, IsError), InvalidCmd, "BadAddressError" }, 1345314Sstever@gmail.com /* PrintReq */ 1355314Sstever@gmail.com { SET2(IsRequest, IsPrint), InvalidCmd, "PrintReq" } 1364022Sstever@eecs.umich.edu}; 1372592SN/A 1383607Srdreslin@umich.edubool 1395314Sstever@gmail.comPacket::checkFunctional(Printable *obj, Addr addr, int size, uint8_t *data) 1402641Sstever@eecs.umich.edu{ 1414626Sstever@eecs.umich.edu Addr func_start = getAddr(); 1424626Sstever@eecs.umich.edu Addr func_end = getAddr() + getSize() - 1; 1434626Sstever@eecs.umich.edu Addr val_start = addr; 1444626Sstever@eecs.umich.edu Addr val_end = val_start + size - 1; 1453260Ssaidi@eecs.umich.edu 1464626Sstever@eecs.umich.edu if (func_start > val_end || val_start > func_end) { 1474626Sstever@eecs.umich.edu // no intersection 1484626Sstever@eecs.umich.edu return false; 1494626Sstever@eecs.umich.edu } 1503260Ssaidi@eecs.umich.edu 1515314Sstever@gmail.com // check print first since it doesn't require data 1525314Sstever@gmail.com if (isPrint()) { 1535314Sstever@gmail.com dynamic_cast<PrintReqState*>(senderState)->printObj(obj); 1545314Sstever@gmail.com return false; 1555314Sstever@gmail.com } 1565314Sstever@gmail.com 1575314Sstever@gmail.com // if there's no data, there's no need to look further 1585314Sstever@gmail.com if (!data) { 1595314Sstever@gmail.com return false; 1605314Sstever@gmail.com } 1615314Sstever@gmail.com 1624626Sstever@eecs.umich.edu // offset of functional request into supplied value (could be 1634626Sstever@eecs.umich.edu // negative if partial overlap) 1644626Sstever@eecs.umich.edu int offset = func_start - val_start; 1653260Ssaidi@eecs.umich.edu 1664626Sstever@eecs.umich.edu if (isRead()) { 1674626Sstever@eecs.umich.edu if (func_start >= val_start && func_end <= val_end) { 1684626Sstever@eecs.umich.edu allocate(); 1695735Snate@binkert.org memcpy(getPtr<uint8_t>(), data + offset, getSize()); 1704870Sstever@eecs.umich.edu makeResponse(); 1714626Sstever@eecs.umich.edu return true; 1723260Ssaidi@eecs.umich.edu } else { 1734489Sstever@eecs.umich.edu // In this case the timing packet only partially satisfies 1744489Sstever@eecs.umich.edu // the request, so we would need more information to make 1754489Sstever@eecs.umich.edu // this work. Like bytes valid in the packet or 1764489Sstever@eecs.umich.edu // something, so the request could continue and get this 1774489Sstever@eecs.umich.edu // bit of possibly newer data along with the older data 1784489Sstever@eecs.umich.edu // not written to yet. 1794626Sstever@eecs.umich.edu panic("Memory value only partially satisfies the functional " 1804626Sstever@eecs.umich.edu "request. Now what?"); 1813260Ssaidi@eecs.umich.edu } 1824626Sstever@eecs.umich.edu } else if (isWrite()) { 1834626Sstever@eecs.umich.edu if (offset >= 0) { 1845735Snate@binkert.org memcpy(data + offset, getPtr<uint8_t>(), 1855735Snate@binkert.org (min(func_end, val_end) - func_start) + 1); 1865735Snate@binkert.org } else { 1875735Snate@binkert.org // val_start > func_start 1885735Snate@binkert.org memcpy(data, getPtr<uint8_t>() - offset, 1895735Snate@binkert.org (min(func_end, val_end) - val_start) + 1); 1903260Ssaidi@eecs.umich.edu } 1915314Sstever@gmail.com } else { 1924626Sstever@eecs.umich.edu panic("Don't know how to handle command %s\n", cmdString()); 1935314Sstever@gmail.com } 1945314Sstever@gmail.com 1955314Sstever@gmail.com // keep going with request by default 1965314Sstever@gmail.com return false; 1972641Sstever@eecs.umich.edu} 1983260Ssaidi@eecs.umich.edu 1995314Sstever@gmail.comvoid 2005735Snate@binkert.orgPacket::print(ostream &o, const int verbosity, const string &prefix) const 2013260Ssaidi@eecs.umich.edu{ 2025314Sstever@gmail.com ccprintf(o, "%s[%x:%x] %s\n", prefix, 2035314Sstever@gmail.com getAddr(), getAddr() + getSize() - 1, cmdString()); 2043260Ssaidi@eecs.umich.edu} 2053260Ssaidi@eecs.umich.edu 2065735Snate@binkert.orgPacket::PrintReqState::PrintReqState(ostream &_os, int _verbosity) 2075735Snate@binkert.org : curPrefixPtr(new string("")), os(_os), verbosity(_verbosity) 2085314Sstever@gmail.com{ 2095314Sstever@gmail.com labelStack.push_back(LabelStackEntry("", curPrefixPtr)); 2105314Sstever@gmail.com} 2115314Sstever@gmail.com 2125314Sstever@gmail.comPacket::PrintReqState::~PrintReqState() 2135314Sstever@gmail.com{ 2145314Sstever@gmail.com labelStack.pop_back(); 2155314Sstever@gmail.com assert(labelStack.empty()); 2165314Sstever@gmail.com delete curPrefixPtr; 2175314Sstever@gmail.com} 2185314Sstever@gmail.com 2195314Sstever@gmail.comPacket::PrintReqState:: 2205735Snate@binkert.orgLabelStackEntry::LabelStackEntry(const string &_label, string *_prefix) 2215314Sstever@gmail.com : label(_label), prefix(_prefix), labelPrinted(false) 2225314Sstever@gmail.com{ 2235314Sstever@gmail.com} 2245314Sstever@gmail.com 2255314Sstever@gmail.comvoid 2265735Snate@binkert.orgPacket::PrintReqState::pushLabel(const string &lbl, const string &prefix) 2275314Sstever@gmail.com{ 2285314Sstever@gmail.com labelStack.push_back(LabelStackEntry(lbl, curPrefixPtr)); 2295735Snate@binkert.org curPrefixPtr = new string(*curPrefixPtr); 2305314Sstever@gmail.com *curPrefixPtr += prefix; 2315314Sstever@gmail.com} 2325314Sstever@gmail.com 2335314Sstever@gmail.comvoid 2345314Sstever@gmail.comPacket::PrintReqState::popLabel() 2355314Sstever@gmail.com{ 2365314Sstever@gmail.com delete curPrefixPtr; 2375314Sstever@gmail.com curPrefixPtr = labelStack.back().prefix; 2385314Sstever@gmail.com labelStack.pop_back(); 2395314Sstever@gmail.com assert(!labelStack.empty()); 2405314Sstever@gmail.com} 2415314Sstever@gmail.com 2425314Sstever@gmail.comvoid 2435314Sstever@gmail.comPacket::PrintReqState::printLabels() 2445314Sstever@gmail.com{ 2455314Sstever@gmail.com if (!labelStack.back().labelPrinted) { 2465314Sstever@gmail.com LabelStack::iterator i = labelStack.begin(); 2475314Sstever@gmail.com LabelStack::iterator end = labelStack.end(); 2485314Sstever@gmail.com while (i != end) { 2495314Sstever@gmail.com if (!i->labelPrinted) { 2505314Sstever@gmail.com ccprintf(os, "%s%s\n", *(i->prefix), i->label); 2515314Sstever@gmail.com i->labelPrinted = true; 2525314Sstever@gmail.com } 2535314Sstever@gmail.com i++; 2545314Sstever@gmail.com } 2555314Sstever@gmail.com } 2565314Sstever@gmail.com} 2575314Sstever@gmail.com 2585314Sstever@gmail.com 2595314Sstever@gmail.comvoid 2605314Sstever@gmail.comPacket::PrintReqState::printObj(Printable *obj) 2615314Sstever@gmail.com{ 2625314Sstever@gmail.com printLabels(); 2635314Sstever@gmail.com obj->print(os, verbosity, curPrefix()); 2645314Sstever@gmail.com} 265