ethertap.hh revision 4981 
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 "base/pollevent.hh"
42#include "dev/etherobject.hh"
43#include "dev/etherint.hh"
44#include "dev/etherpkt.hh"
45#include "params/EtherTap.hh"
46#include "sim/eventq.hh"
47#include "sim/sim_object.hh"
48
49class TapEvent;
50class TapListener;
51class EtherTapInt;
52
53/*
54 * Interface to connect a simulated ethernet device to the real world
55 */
56class EtherTap : public EtherObject
57{
58  protected:
59    friend class TapEvent;
60    TapEvent *event;
61
62  protected:
63    friend class TapListener;
64    TapListener *listener;
65    int socket;
66    char *buffer;
67    int buflen;
68    int32_t buffer_offset;
69    int32_t data_len;
70
71    EtherDump *dump;
72
73    void attach(int fd);
74    void detach();
75
76  protected:
77    std::string device;
78    std::queue<EthPacketPtr> packetBuffer;
79    EtherTapInt *interface;
80
81    void process(int revent);
82    void enqueue(EthPacketData *packet);
83    void retransmit();
84
85    /*
86     */
87    class TxEvent : public Event
88    {
89      protected:
90        EtherTap *tap;
91
92      public:
93        TxEvent(EtherTap *_tap)
94            : Event(&mainEventQueue), tap(_tap) {}
95        void process() { tap->retransmit(); }
96        virtual const char *description() { return "EtherTap retransmit"; }
97    };
98
99    friend class TxEvent;
100    TxEvent txEvent;
101
102  public:
103    typedef EtherTapParams Params;
104    EtherTap(const Params *p);
105    virtual ~EtherTap();
106
107    const Params *
108    params() const
109    {
110        return dynamic_cast<const Params *>(_params);
111    }
112
113    virtual EtherInt *getEthPort(const std::string &if_name, int idx);
114
115    virtual bool recvPacket(EthPacketPtr packet);
116    virtual void sendDone();
117
118    virtual void serialize(std::ostream &os);
119    virtual void unserialize(Checkpoint *cp, const std::string &section);
120};
121
122class EtherTapInt : public EtherInt
123{
124  private:
125    EtherTap *tap;
126  public:
127    EtherTapInt(const std::string &name, EtherTap *t)
128            : EtherInt(name), tap(t)
129    { }
130
131    virtual bool recvPacket(EthPacketPtr pkt) { return tap->recvPacket(pkt); }
132    virtual void sendDone() { tap->sendDone(); }
133};
134
135
136#endif // __ETHERTAP_HH__
137