pktfifo.hh revision 1762
112837Sgabeblack@google.com/* 212837Sgabeblack@google.com * Copyright (c) 2004-2005 The Regents of The University of Michigan 312837Sgabeblack@google.com * All rights reserved. 412837Sgabeblack@google.com * 512837Sgabeblack@google.com * Redistribution and use in source and binary forms, with or without 612837Sgabeblack@google.com * modification, are permitted provided that the following conditions are 712837Sgabeblack@google.com * met: redistributions of source code must retain the above copyright 812837Sgabeblack@google.com * notice, this list of conditions and the following disclaimer; 912837Sgabeblack@google.com * redistributions in binary form must reproduce the above copyright 1012837Sgabeblack@google.com * notice, this list of conditions and the following disclaimer in the 1112837Sgabeblack@google.com * documentation and/or other materials provided with the distribution; 1212837Sgabeblack@google.com * neither the name of the copyright holders nor the names of its 1312837Sgabeblack@google.com * contributors may be used to endorse or promote products derived from 1412837Sgabeblack@google.com * this software without specific prior written permission. 1512837Sgabeblack@google.com * 1612837Sgabeblack@google.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 1712837Sgabeblack@google.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 1812837Sgabeblack@google.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 1912837Sgabeblack@google.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2012837Sgabeblack@google.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 2112837Sgabeblack@google.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 2212837Sgabeblack@google.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 2312837Sgabeblack@google.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 2412837Sgabeblack@google.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 2512837Sgabeblack@google.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 2612837Sgabeblack@google.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 2712837Sgabeblack@google.com */ 2812837Sgabeblack@google.com 2912837Sgabeblack@google.com#ifndef __DEV_PKTFIFO_HH__ 3012837Sgabeblack@google.com#define __DEV_PKTFIFO_HH__ 3112837Sgabeblack@google.com 3212837Sgabeblack@google.com#include <iosfwd> 3312837Sgabeblack@google.com#include <list> 3412898Sgabeblack@google.com#include <string> 3512837Sgabeblack@google.com 3612837Sgabeblack@google.com#include "dev/etherpkt.hh" 3712837Sgabeblack@google.com#include "sim/serialize.hh" 3812837Sgabeblack@google.com 3912837Sgabeblack@google.comclass Checkpoint; 4012837Sgabeblack@google.comclass PacketFifo 4112837Sgabeblack@google.com{ 4212948Sgabeblack@google.com protected: 4312948Sgabeblack@google.com std::list<PacketPtr> fifo; 4412837Sgabeblack@google.com int _maxsize; 4512837Sgabeblack@google.com int _size; 4612837Sgabeblack@google.com int _reserved; 4712837Sgabeblack@google.com 4812837Sgabeblack@google.com public: 4912837Sgabeblack@google.com explicit PacketFifo(int max) : _maxsize(max), _size(0), _reserved(0) {} 5012837Sgabeblack@google.com virtual ~PacketFifo() {} 5112837Sgabeblack@google.com 5212948Sgabeblack@google.com int packets() const { return fifo.size(); } 5312948Sgabeblack@google.com int maxsize() const { return _maxsize; } 5412837Sgabeblack@google.com int size() const { return _size; } 5512837Sgabeblack@google.com int reserved() const { return _reserved; } 5612837Sgabeblack@google.com int avail() const { return _maxsize - _size - _reserved; } 5712837Sgabeblack@google.com bool empty() const { return size() <= 0; } 5812837Sgabeblack@google.com bool full() const { return avail() <= 0; } 5912837Sgabeblack@google.com 6012948Sgabeblack@google.com int reserve(int len = 0) 6112837Sgabeblack@google.com { 6212837Sgabeblack@google.com _reserved += len; 6312948Sgabeblack@google.com assert(avail() >= 0); 6412837Sgabeblack@google.com return _reserved; 6512837Sgabeblack@google.com } 6612948Sgabeblack@google.com 6712948Sgabeblack@google.com bool push(PacketPtr ptr) 6812837Sgabeblack@google.com { 6912837Sgabeblack@google.com assert(_reserved <= ptr->length); 7012837Sgabeblack@google.com if (avail() < ptr->length - _reserved) 7112837Sgabeblack@google.com return false; 7212837Sgabeblack@google.com 7312837Sgabeblack@google.com _size += ptr->length; 7412837Sgabeblack@google.com fifo.push_back(ptr); 7512837Sgabeblack@google.com _reserved = 0; 7612837Sgabeblack@google.com return true; 7712837Sgabeblack@google.com } 7812837Sgabeblack@google.com 7912837Sgabeblack@google.com PacketPtr front() { return fifo.front(); } 8012948Sgabeblack@google.com 8112948Sgabeblack@google.com void pop() 8212837Sgabeblack@google.com { 8312837Sgabeblack@google.com if (empty()) 8412837Sgabeblack@google.com return; 8512837Sgabeblack@google.com 8612837Sgabeblack@google.com _size -= fifo.front()->length; 8712898Sgabeblack@google.com fifo.front() = NULL; 8812898Sgabeblack@google.com fifo.pop_front(); 8912898Sgabeblack@google.com } 9012898Sgabeblack@google.com 9112898Sgabeblack@google.com void clear() 9212898Sgabeblack@google.com { 9312898Sgabeblack@google.com fifo.clear(); 9412898Sgabeblack@google.com _size = 0; 9512898Sgabeblack@google.com _reserved = 0; 9612898Sgabeblack@google.com } 9712898Sgabeblack@google.com 9812898Sgabeblack@google.com/** 9912898Sgabeblack@google.com * Serialization stuff 10012898Sgabeblack@google.com */ 10112898Sgabeblack@google.com public: 10212898Sgabeblack@google.com void serialize(const std::string &base, std::ostream &os); 10312898Sgabeblack@google.com void unserialize(const std::string &base, 10412898Sgabeblack@google.com Checkpoint *cp, const std::string §ion); 10512898Sgabeblack@google.com}; 10612898Sgabeblack@google.com 10712898Sgabeblack@google.com#endif // __DEV_PKTFIFO_HH__ 10812898Sgabeblack@google.com