ethertap.hh revision 12055:945e851d846b
1/* 2 * Copyright (c) 2003-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 * Interface to connect a simulated ethernet device to the real world 33 */ 34 35#ifndef __DEV_NET_ETHERTAP_HH__ 36#define __DEV_NET_ETHERTAP_HH__ 37 38#include <queue> 39#include <string> 40 41#include "base/pollevent.hh" 42#include "dev/net/etherint.hh" 43#include "dev/net/etherobject.hh" 44#include "dev/net/etherpkt.hh" 45#include "params/EtherTapStub.hh" 46#include "sim/eventq.hh" 47#include "sim/sim_object.hh" 48 49class TapEvent; 50class EtherTapInt; 51 52class EtherTapBase : public EtherObject 53{ 54 public: 55 typedef EtherTapBaseParams Params; 56 EtherTapBase(const Params *p); 57 virtual ~EtherTapBase(); 58 59 const Params * 60 params() const 61 { 62 return dynamic_cast<const Params *>(_params); 63 } 64 65 void serialize(CheckpointOut &cp) const override; 66 void unserialize(CheckpointIn &cp) override; 67 68 protected: 69 uint8_t *buffer; 70 int buflen; 71 72 EtherDump *dump; 73 74 75 /* 76 * Interface to the real network. 77 */ 78 protected: 79 friend class TapEvent; 80 TapEvent *event; 81 void pollFd(int fd); 82 void stopPolling(); 83 84 // Receive data from the real network. 85 virtual void recvReal(int revent) = 0; 86 // Prepare and send data out to the real network. 87 virtual bool sendReal(const void *data, size_t len) = 0; 88 89 90 /* 91 * Interface to the simulated network. 92 */ 93 protected: 94 EtherTapInt *interface; 95 96 public: 97 EtherInt *getEthPort(const std::string &if_name, int idx) override; 98 99 bool recvSimulated(EthPacketPtr packet); 100 void sendSimulated(void *data, size_t len); 101 102 protected: 103 std::queue<EthPacketPtr> packetBuffer; 104 void retransmit(); 105 106 class TxEvent : public Event 107 { 108 protected: 109 EtherTapBase *tap; 110 111 public: 112 TxEvent(EtherTapBase *_tap) : tap(_tap) {} 113 void process() { tap->retransmit(); } 114 virtual const char *description() const 115 { return "EtherTapBase retransmit"; } 116 }; 117 118 friend class TxEvent; 119 TxEvent txEvent; 120}; 121 122class EtherTapInt : public EtherInt 123{ 124 private: 125 EtherTapBase *tap; 126 public: 127 EtherTapInt(const std::string &name, EtherTapBase *t) : 128 EtherInt(name), tap(t) 129 { } 130 131 bool recvPacket(EthPacketPtr pkt) override 132 { return tap->recvSimulated(pkt); } 133 void sendDone() override {} 134}; 135 136 137class TapListener; 138 139/* 140 * Interface to connect a simulated ethernet device to the real world. An 141 * external helper program bridges between this object's TCP port and a 142 * source/sink for Ethernet frames. Each frame going in either direction is 143 * prepended with the frame's length in a 32 bit integer in network byte order. 144 */ 145class EtherTapStub : public EtherTapBase 146{ 147 public: 148 typedef EtherTapStubParams Params; 149 EtherTapStub(const Params *p); 150 ~EtherTapStub(); 151 152 const Params * 153 params() const 154 { 155 return dynamic_cast<const Params *>(_params); 156 } 157 158 void serialize(CheckpointOut &cp) const override; 159 void unserialize(CheckpointIn &cp) override; 160 161 162 protected: 163 friend class TapListener; 164 TapListener *listener; 165 166 int socket; 167 168 void attach(int fd); 169 void detach(); 170 171 uint32_t buffer_used; 172 uint32_t frame_len; 173 174 void recvReal(int revent) override; 175 bool sendReal(const void *data, size_t len) override; 176}; 177 178 179#endif // __DEV_NET_ETHERTAP_HH__ 180