etherlink.hh revision 4419
1/* 2 * Copyright (c) 2002-2005 The Regents of The University of Michigan 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer; 9 * redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution; 12 * neither the name of the copyright holders nor the names of its 13 * contributors may be used to endorse or promote products derived from 14 * this software without specific prior written permission. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 17 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 20 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * Authors: Nathan Binkert 29 */ 30 31/* @file 32 * Device module for modelling a fixed bandwidth full duplex ethernet link 33 */ 34 35#ifndef __DEV_ETHERLINK_HH__ 36#define __DEV_ETHERLINK_HH__ 37 38#include "dev/etherint.hh" 39#include "dev/etherpkt.hh" 40#include "sim/eventq.hh" 41#include "sim/host.hh" 42#include "sim/sim_object.hh" 43 44class EtherDump; 45class Checkpoint; 46/* 47 * Model for a fixed bandwidth full duplex ethernet link 48 */ 49class EtherLink : public SimObject 50{ 51 protected: 52 class Interface; 53 54 friend class LinkDelayEvent; 55 /* 56 * Model for a single uni-directional link 57 */ 58 class Link 59 { 60 protected: 61 std::string objName; 62 63 EtherLink *parent; 64 int number; 65 66 Interface *txint; 67 Interface *rxint; 68 69 double ticksPerByte; 70 Tick linkDelay; 71 Tick delayVar; 72 EtherDump *dump; 73 74 protected: 75 /* 76 * Transfer is complete 77 */ 78 EthPacketPtr packet; 79 void txDone(); 80 typedef EventWrapper<Link, &Link::txDone> DoneEvent; 81 friend void DoneEvent::process(); 82 DoneEvent doneEvent; 83 84 friend class LinkDelayEvent; 85 void txComplete(EthPacketPtr packet); 86 87 public: 88 Link(const std::string &name, EtherLink *p, int num, 89 double rate, Tick delay, Tick delay_var, EtherDump *dump); 90 ~Link() {} 91 92 const std::string name() const { return objName; } 93 94 bool busy() const { return (bool)packet; } 95 bool transmit(EthPacketPtr packet); 96 97 void setTxInt(Interface *i) { assert(!txint); txint = i; } 98 void setRxInt(Interface *i) { assert(!rxint); rxint = i; } 99 100 void serialize(const std::string &base, std::ostream &os); 101 void unserialize(const std::string &base, Checkpoint *cp, 102 const std::string §ion); 103 }; 104 105 /* 106 * Interface at each end of the link 107 */ 108 class Interface : public EtherInt 109 { 110 private: 111 Link *txlink; 112 113 public: 114 Interface(const std::string &name, Link *txlink, Link *rxlink); 115 bool recvPacket(EthPacketPtr packet) { return txlink->transmit(packet); } 116 void sendDone() { peer->sendDone(); } 117 bool isBusy() { return txlink->busy(); } 118 }; 119 120 Link *link[2]; 121 EtherInt *interface[2]; 122 123 public: 124 EtherLink(const std::string &name, EtherInt *peer0, EtherInt *peer1, 125 double rate, Tick delay, Tick delayVar, EtherDump *dump); 126 virtual ~EtherLink(); 127 128 virtual void serialize(std::ostream &os); 129 virtual void unserialize(Checkpoint *cp, const std::string §ion); 130 131}; 132 133#endif // __ETHERLINK_HH__ 134