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