src/dev/ethertap.hh

   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 __ETHERTAP_HH__
  36 #define __ETHERTAP_HH__
  37
  38 #include <queue>
  39 #include <string>
  40
  41 #include "dev/etherint.hh"
  42 #include "dev/etherpkt.hh"
  43 #include "sim/eventq.hh"
  44 #include "base/pollevent.hh"
  45 #include "sim/sim_object.hh"
  46
  47 class TapEvent;
  48 class TapListener;
  49
  50 /*
  51  * Interface to connect a simulated ethernet device to the real world
  52  */
  53 class EtherTap : public EtherInt
  54 {
  55   protected:
  56     friend class TapEvent;
  57     TapEvent *event;
  58
  59   protected:
  60     friend class TapListener;
  61     TapListener *listener;
  62     int socket;
  63     char *buffer;
  64     int buflen;
  65     int32_t buffer_offset;
  66     int32_t data_len;
  67
  68     EtherDump *dump;
  69
  70     void attach(int fd);
  71     void detach();
  72
  73   protected:
  74     std::string device;
  75     std::queue<EthPacketPtr> packetBuffer;
  76
  77     void process(int revent);
  78     void enqueue(EthPacketData *packet);
  79     void retransmit();
  80
  81     /*
  82      */
  83     class TxEvent : public Event
  84     {
  85       protected:
  86         EtherTap *tap;
  87
  88       public:
  89         TxEvent(EtherTap *_tap)
  90             : Event(&mainEventQueue), tap(_tap) {}
  91         void process() { tap->retransmit(); }
  92         virtual const char *description() { return "EtherTap retransmit"; }
  93     };
  94
  95     friend class TxEvent;
  96     TxEvent txEvent;
  97
  98   public:
  99     EtherTap(const std::string &name, EtherDump *dump, int port, int bufsz);
 100     virtual ~EtherTap();
 101
 102     virtual bool recvPacket(EthPacketPtr packet);
 103     virtual void sendDone();
 104
 105     virtual void serialize(std::ostream &os);
 106     virtual void unserialize(Checkpoint *cp, const std::string &section);
 107 };
 108
 109 #endif // __ETHERTAP_HH__