packet.cc revision 8229
12568SN/A/* 22568SN/A * Copyright (c) 2006 The Regents of The University of Michigan 37636Ssteve.reinhardt@amd.com * Copyright (c) 2010 Advanced Micro Devices, Inc. 42568SN/A * All rights reserved. 52568SN/A * 62568SN/A * Redistribution and use in source and binary forms, with or without 72568SN/A * modification, are permitted provided that the following conditions are 82568SN/A * met: redistributions of source code must retain the above copyright 92568SN/A * notice, this list of conditions and the following disclaimer; 102568SN/A * redistributions in binary form must reproduce the above copyright 112568SN/A * notice, this list of conditions and the following disclaimer in the 122568SN/A * documentation and/or other materials provided with the distribution; 132568SN/A * neither the name of the copyright holders nor the names of its 142568SN/A * contributors may be used to endorse or promote products derived from 152568SN/A * this software without specific prior written permission. 162568SN/A * 172568SN/A * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 182568SN/A * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 192568SN/A * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 202568SN/A * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 212568SN/A * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 222568SN/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 232568SN/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 242568SN/A * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 252568SN/A * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 262568SN/A * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 272568SN/A * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 282665Ssaidi@eecs.umich.edu * 292665Ssaidi@eecs.umich.edu * Authors: Ali Saidi 302665Ssaidi@eecs.umich.edu * Steve Reinhardt 312568SN/A */ 322568SN/A 332568SN/A/** 342568SN/A * @file 352568SN/A * Definition of the Packet Class, a packet is a transaction occuring 362568SN/A * between a single level of the memory heirarchy (ie L1->L2). 372568SN/A */ 383260Ssaidi@eecs.umich.edu 398229Snate@binkert.org#include <cstring> 403260Ssaidi@eecs.umich.edu#include <iostream> 418229Snate@binkert.org 425314Sstever@gmail.com#include "base/cprintf.hh" 432590SN/A#include "base/misc.hh" 443348Sbinkertn@umich.edu#include "base/trace.hh" 452568SN/A#include "mem/packet.hh" 462568SN/A 475735Snate@binkert.orgusing namespace std; 485735Snate@binkert.org 494022Sstever@eecs.umich.edu// The one downside to bitsets is that static initializers can get ugly. 504022Sstever@eecs.umich.edu#define SET1(a1) (1 << (a1)) 514022Sstever@eecs.umich.edu#define SET2(a1, a2) (SET1(a1) | SET1(a2)) 524022Sstever@eecs.umich.edu#define SET3(a1, a2, a3) (SET2(a1, a2) | SET1(a3)) 534022Sstever@eecs.umich.edu#define SET4(a1, a2, a3, a4) (SET3(a1, a2, a3) | SET1(a4)) 544022Sstever@eecs.umich.edu#define SET5(a1, a2, a3, a4, a5) (SET4(a1, a2, a3, a4) | SET1(a5)) 554022Sstever@eecs.umich.edu#define SET6(a1, a2, a3, a4, a5, a6) (SET5(a1, a2, a3, a4, a5) | SET1(a6)) 562641Sstever@eecs.umich.edu 574022Sstever@eecs.umich.educonst MemCmd::CommandInfo 584022Sstever@eecs.umich.eduMemCmd::commandInfo[] = 592641Sstever@eecs.umich.edu{ 604022Sstever@eecs.umich.edu /* InvalidCmd */ 614022Sstever@eecs.umich.edu { 0, InvalidCmd, "InvalidCmd" }, 624022Sstever@eecs.umich.edu /* ReadReq */ 634022Sstever@eecs.umich.edu { SET3(IsRead, IsRequest, NeedsResponse), ReadResp, "ReadReq" }, 644473Sstever@eecs.umich.edu /* ReadResp */ 654473Sstever@eecs.umich.edu { SET3(IsRead, IsResponse, HasData), InvalidCmd, "ReadResp" }, 665319Sstever@gmail.com /* ReadRespWithInvalidate */ 675319Sstever@gmail.com { SET4(IsRead, IsResponse, HasData, IsInvalidate), 685319Sstever@gmail.com InvalidCmd, "ReadRespWithInvalidate" }, 694022Sstever@eecs.umich.edu /* WriteReq */ 704626Sstever@eecs.umich.edu { SET5(IsWrite, NeedsExclusive, IsRequest, NeedsResponse, HasData), 714022Sstever@eecs.umich.edu WriteResp, "WriteReq" }, 724022Sstever@eecs.umich.edu /* WriteResp */ 734626Sstever@eecs.umich.edu { SET3(IsWrite, NeedsExclusive, IsResponse), InvalidCmd, "WriteResp" }, 744022Sstever@eecs.umich.edu /* Writeback */ 754628Sstever@eecs.umich.edu { SET4(IsWrite, NeedsExclusive, IsRequest, HasData), 764628Sstever@eecs.umich.edu InvalidCmd, "Writeback" }, 774022Sstever@eecs.umich.edu /* SoftPFReq */ 784022Sstever@eecs.umich.edu { SET4(IsRead, IsRequest, IsSWPrefetch, NeedsResponse), 794022Sstever@eecs.umich.edu SoftPFResp, "SoftPFReq" }, 804022Sstever@eecs.umich.edu /* HardPFReq */ 814022Sstever@eecs.umich.edu { SET4(IsRead, IsRequest, IsHWPrefetch, NeedsResponse), 824022Sstever@eecs.umich.edu HardPFResp, "HardPFReq" }, 834022Sstever@eecs.umich.edu /* SoftPFResp */ 844022Sstever@eecs.umich.edu { SET4(IsRead, IsResponse, IsSWPrefetch, HasData), 854022Sstever@eecs.umich.edu InvalidCmd, "SoftPFResp" }, 864022Sstever@eecs.umich.edu /* HardPFResp */ 874022Sstever@eecs.umich.edu { SET4(IsRead, IsResponse, IsHWPrefetch, HasData), 884022Sstever@eecs.umich.edu InvalidCmd, "HardPFResp" }, 894022Sstever@eecs.umich.edu /* WriteInvalidateReq */ 904626Sstever@eecs.umich.edu { SET6(IsWrite, NeedsExclusive, IsInvalidate, 914626Sstever@eecs.umich.edu IsRequest, HasData, NeedsResponse), 924022Sstever@eecs.umich.edu WriteInvalidateResp, "WriteInvalidateReq" }, 934022Sstever@eecs.umich.edu /* WriteInvalidateResp */ 945319Sstever@gmail.com { SET3(IsWrite, NeedsExclusive, IsResponse), 954022Sstever@eecs.umich.edu InvalidCmd, "WriteInvalidateResp" }, 964022Sstever@eecs.umich.edu /* UpgradeReq */ 977465Ssteve.reinhardt@amd.com { SET5(IsInvalidate, NeedsExclusive, IsUpgrade, IsRequest, NeedsResponse), 984628Sstever@eecs.umich.edu UpgradeResp, "UpgradeReq" }, 997465Ssteve.reinhardt@amd.com /* SCUpgradeReq: response could be UpgradeResp or UpgradeFailResp */ 1007465Ssteve.reinhardt@amd.com { SET6(IsInvalidate, NeedsExclusive, IsUpgrade, IsLlsc, 1017465Ssteve.reinhardt@amd.com IsRequest, NeedsResponse), 1027465Ssteve.reinhardt@amd.com UpgradeResp, "SCUpgradeReq" }, 1034628Sstever@eecs.umich.edu /* UpgradeResp */ 1047465Ssteve.reinhardt@amd.com { SET3(NeedsExclusive, IsUpgrade, IsResponse), 1057465Ssteve.reinhardt@amd.com InvalidCmd, "UpgradeResp" }, 1067465Ssteve.reinhardt@amd.com /* SCUpgradeFailReq: generates UpgradeFailResp ASAP */ 1077465Ssteve.reinhardt@amd.com { SET5(IsInvalidate, NeedsExclusive, IsLlsc, 1087465Ssteve.reinhardt@amd.com IsRequest, NeedsResponse), 1097465Ssteve.reinhardt@amd.com UpgradeFailResp, "SCUpgradeFailReq" }, 1107465Ssteve.reinhardt@amd.com /* UpgradeFailResp */ 1115319Sstever@gmail.com { SET2(NeedsExclusive, IsResponse), 1127465Ssteve.reinhardt@amd.com InvalidCmd, "UpgradeFailResp" }, 1134022Sstever@eecs.umich.edu /* ReadExReq */ 1144626Sstever@eecs.umich.edu { SET5(IsRead, NeedsExclusive, IsInvalidate, IsRequest, NeedsResponse), 1154022Sstever@eecs.umich.edu ReadExResp, "ReadExReq" }, 1164022Sstever@eecs.umich.edu /* ReadExResp */ 1175319Sstever@gmail.com { SET4(IsRead, NeedsExclusive, IsResponse, HasData), 1184040Ssaidi@eecs.umich.edu InvalidCmd, "ReadExResp" }, 1195507Sstever@gmail.com /* LoadLockedReq: note that we use plain ReadResp as response, so that 1205507Sstever@gmail.com * we can also use ReadRespWithInvalidate when needed */ 1216076Sgblack@eecs.umich.edu { SET4(IsRead, IsLlsc, IsRequest, NeedsResponse), 1225507Sstever@gmail.com ReadResp, "LoadLockedReq" }, 1234626Sstever@eecs.umich.edu /* StoreCondReq */ 1246076Sgblack@eecs.umich.edu { SET6(IsWrite, NeedsExclusive, IsLlsc, 1254626Sstever@eecs.umich.edu IsRequest, NeedsResponse, HasData), 1264626Sstever@eecs.umich.edu StoreCondResp, "StoreCondReq" }, 1277669Ssteve.reinhardt@amd.com /* StoreCondFailReq: generates failing StoreCondResp ASAP */ 1287669Ssteve.reinhardt@amd.com { SET6(IsWrite, NeedsExclusive, IsLlsc, 1297669Ssteve.reinhardt@amd.com IsRequest, NeedsResponse, HasData), 1307669Ssteve.reinhardt@amd.com StoreCondResp, "StoreCondFailReq" }, 1314626Sstever@eecs.umich.edu /* StoreCondResp */ 1326076Sgblack@eecs.umich.edu { SET4(IsWrite, NeedsExclusive, IsLlsc, IsResponse), 1334626Sstever@eecs.umich.edu InvalidCmd, "StoreCondResp" }, 1344040Ssaidi@eecs.umich.edu /* SwapReq -- for Swap ldstub type operations */ 1354626Sstever@eecs.umich.edu { SET6(IsRead, IsWrite, NeedsExclusive, IsRequest, HasData, NeedsResponse), 1364040Ssaidi@eecs.umich.edu SwapResp, "SwapReq" }, 1374040Ssaidi@eecs.umich.edu /* SwapResp -- for Swap ldstub type operations */ 1384626Sstever@eecs.umich.edu { SET5(IsRead, IsWrite, NeedsExclusive, IsResponse, HasData), 1394870Sstever@eecs.umich.edu InvalidCmd, "SwapResp" }, 1405650Sgblack@eecs.umich.edu /* IntReq -- for interrupts */ 1415650Sgblack@eecs.umich.edu { SET4(IsWrite, IsRequest, NeedsResponse, HasData), 1426063Sgblack@eecs.umich.edu MessageResp, "MessageReq" }, 1435650Sgblack@eecs.umich.edu /* IntResp -- for interrupts */ 1446063Sgblack@eecs.umich.edu { SET2(IsWrite, IsResponse), InvalidCmd, "MessageResp" }, 1454870Sstever@eecs.umich.edu /* NetworkNackError -- nacked at network layer (not by protocol) */ 1464986Ssaidi@eecs.umich.edu { SET2(IsResponse, IsError), InvalidCmd, "NetworkNackError" }, 1474870Sstever@eecs.umich.edu /* InvalidDestError -- packet dest field invalid */ 1484986Ssaidi@eecs.umich.edu { SET2(IsResponse, IsError), InvalidCmd, "InvalidDestError" }, 1494870Sstever@eecs.umich.edu /* BadAddressError -- memory address invalid */ 1505314Sstever@gmail.com { SET2(IsResponse, IsError), InvalidCmd, "BadAddressError" }, 1515314Sstever@gmail.com /* PrintReq */ 1528184Ssomayeh@cs.wisc.edu { SET2(IsRequest, IsPrint), InvalidCmd, "PrintReq" }, 1538184Ssomayeh@cs.wisc.edu /* Flush Request */ 1548184Ssomayeh@cs.wisc.edu { SET3(IsRequest, IsFlush, NeedsExclusive), InvalidCmd, "FlushReq" } 1554022Sstever@eecs.umich.edu}; 1562592SN/A 1573607Srdreslin@umich.edubool 1585314Sstever@gmail.comPacket::checkFunctional(Printable *obj, Addr addr, int size, uint8_t *data) 1592641Sstever@eecs.umich.edu{ 1604626Sstever@eecs.umich.edu Addr func_start = getAddr(); 1614626Sstever@eecs.umich.edu Addr func_end = getAddr() + getSize() - 1; 1624626Sstever@eecs.umich.edu Addr val_start = addr; 1634626Sstever@eecs.umich.edu Addr val_end = val_start + size - 1; 1643260Ssaidi@eecs.umich.edu 1654626Sstever@eecs.umich.edu if (func_start > val_end || val_start > func_end) { 1664626Sstever@eecs.umich.edu // no intersection 1674626Sstever@eecs.umich.edu return false; 1684626Sstever@eecs.umich.edu } 1693260Ssaidi@eecs.umich.edu 1705314Sstever@gmail.com // check print first since it doesn't require data 1715314Sstever@gmail.com if (isPrint()) { 1725314Sstever@gmail.com dynamic_cast<PrintReqState*>(senderState)->printObj(obj); 1735314Sstever@gmail.com return false; 1745314Sstever@gmail.com } 1755314Sstever@gmail.com 1765314Sstever@gmail.com // if there's no data, there's no need to look further 1775314Sstever@gmail.com if (!data) { 1785314Sstever@gmail.com return false; 1795314Sstever@gmail.com } 1805314Sstever@gmail.com 1814626Sstever@eecs.umich.edu // offset of functional request into supplied value (could be 1824626Sstever@eecs.umich.edu // negative if partial overlap) 1834626Sstever@eecs.umich.edu int offset = func_start - val_start; 1843260Ssaidi@eecs.umich.edu 1854626Sstever@eecs.umich.edu if (isRead()) { 1864626Sstever@eecs.umich.edu if (func_start >= val_start && func_end <= val_end) { 1874626Sstever@eecs.umich.edu allocate(); 1885735Snate@binkert.org memcpy(getPtr<uint8_t>(), data + offset, getSize()); 1894626Sstever@eecs.umich.edu return true; 1903260Ssaidi@eecs.umich.edu } else { 1914489Sstever@eecs.umich.edu // In this case the timing packet only partially satisfies 1924489Sstever@eecs.umich.edu // the request, so we would need more information to make 1934489Sstever@eecs.umich.edu // this work. Like bytes valid in the packet or 1944489Sstever@eecs.umich.edu // something, so the request could continue and get this 1954489Sstever@eecs.umich.edu // bit of possibly newer data along with the older data 1964489Sstever@eecs.umich.edu // not written to yet. 1974626Sstever@eecs.umich.edu panic("Memory value only partially satisfies the functional " 1984626Sstever@eecs.umich.edu "request. Now what?"); 1993260Ssaidi@eecs.umich.edu } 2004626Sstever@eecs.umich.edu } else if (isWrite()) { 2014626Sstever@eecs.umich.edu if (offset >= 0) { 2025735Snate@binkert.org memcpy(data + offset, getPtr<uint8_t>(), 2035735Snate@binkert.org (min(func_end, val_end) - func_start) + 1); 2045735Snate@binkert.org } else { 2055735Snate@binkert.org // val_start > func_start 2065735Snate@binkert.org memcpy(data, getPtr<uint8_t>() - offset, 2075735Snate@binkert.org (min(func_end, val_end) - val_start) + 1); 2083260Ssaidi@eecs.umich.edu } 2095314Sstever@gmail.com } else { 2104626Sstever@eecs.umich.edu panic("Don't know how to handle command %s\n", cmdString()); 2115314Sstever@gmail.com } 2125314Sstever@gmail.com 2135314Sstever@gmail.com // keep going with request by default 2145314Sstever@gmail.com return false; 2152641Sstever@eecs.umich.edu} 2163260Ssaidi@eecs.umich.edu 2175314Sstever@gmail.comvoid 2185735Snate@binkert.orgPacket::print(ostream &o, const int verbosity, const string &prefix) const 2193260Ssaidi@eecs.umich.edu{ 2205314Sstever@gmail.com ccprintf(o, "%s[%x:%x] %s\n", prefix, 2215314Sstever@gmail.com getAddr(), getAddr() + getSize() - 1, cmdString()); 2223260Ssaidi@eecs.umich.edu} 2233260Ssaidi@eecs.umich.edu 2245735Snate@binkert.orgPacket::PrintReqState::PrintReqState(ostream &_os, int _verbosity) 2255735Snate@binkert.org : curPrefixPtr(new string("")), os(_os), verbosity(_verbosity) 2265314Sstever@gmail.com{ 2275314Sstever@gmail.com labelStack.push_back(LabelStackEntry("", curPrefixPtr)); 2285314Sstever@gmail.com} 2295314Sstever@gmail.com 2305314Sstever@gmail.comPacket::PrintReqState::~PrintReqState() 2315314Sstever@gmail.com{ 2325314Sstever@gmail.com labelStack.pop_back(); 2335314Sstever@gmail.com assert(labelStack.empty()); 2345314Sstever@gmail.com delete curPrefixPtr; 2355314Sstever@gmail.com} 2365314Sstever@gmail.com 2375314Sstever@gmail.comPacket::PrintReqState:: 2385735Snate@binkert.orgLabelStackEntry::LabelStackEntry(const string &_label, string *_prefix) 2395314Sstever@gmail.com : label(_label), prefix(_prefix), labelPrinted(false) 2405314Sstever@gmail.com{ 2415314Sstever@gmail.com} 2425314Sstever@gmail.com 2435314Sstever@gmail.comvoid 2445735Snate@binkert.orgPacket::PrintReqState::pushLabel(const string &lbl, const string &prefix) 2455314Sstever@gmail.com{ 2465314Sstever@gmail.com labelStack.push_back(LabelStackEntry(lbl, curPrefixPtr)); 2475735Snate@binkert.org curPrefixPtr = new string(*curPrefixPtr); 2485314Sstever@gmail.com *curPrefixPtr += prefix; 2495314Sstever@gmail.com} 2505314Sstever@gmail.com 2515314Sstever@gmail.comvoid 2525314Sstever@gmail.comPacket::PrintReqState::popLabel() 2535314Sstever@gmail.com{ 2545314Sstever@gmail.com delete curPrefixPtr; 2555314Sstever@gmail.com curPrefixPtr = labelStack.back().prefix; 2565314Sstever@gmail.com labelStack.pop_back(); 2575314Sstever@gmail.com assert(!labelStack.empty()); 2585314Sstever@gmail.com} 2595314Sstever@gmail.com 2605314Sstever@gmail.comvoid 2615314Sstever@gmail.comPacket::PrintReqState::printLabels() 2625314Sstever@gmail.com{ 2635314Sstever@gmail.com if (!labelStack.back().labelPrinted) { 2645314Sstever@gmail.com LabelStack::iterator i = labelStack.begin(); 2655314Sstever@gmail.com LabelStack::iterator end = labelStack.end(); 2665314Sstever@gmail.com while (i != end) { 2675314Sstever@gmail.com if (!i->labelPrinted) { 2685314Sstever@gmail.com ccprintf(os, "%s%s\n", *(i->prefix), i->label); 2695314Sstever@gmail.com i->labelPrinted = true; 2705314Sstever@gmail.com } 2715314Sstever@gmail.com i++; 2725314Sstever@gmail.com } 2735314Sstever@gmail.com } 2745314Sstever@gmail.com} 2755314Sstever@gmail.com 2765314Sstever@gmail.com 2775314Sstever@gmail.comvoid 2785314Sstever@gmail.comPacket::PrintReqState::printObj(Printable *obj) 2795314Sstever@gmail.com{ 2805314Sstever@gmail.com printLabels(); 2815314Sstever@gmail.com obj->print(os, verbosity, curPrefix()); 2825314Sstever@gmail.com} 283