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