summaryrefslogtreecommitdiff
path: root/src/dev/net/ethertap.hh
blob: 9b4e175e1105aae7c659cd332d4bb94269b3ae49 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
 * Copyright (c) 2003-2005 The Regents of The University of Michigan
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met: redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer;
 * redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution;
 * neither the name of the copyright holders nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Authors: Nathan Binkert
 */

/* @file
 * Interface to connect a simulated ethernet device to the real world
 */

#ifndef __DEV_NET_ETHERTAP_HH__
#define __DEV_NET_ETHERTAP_HH__

#include <queue>
#include <string>

#include "base/pollevent.hh"
#include "config/use_tuntap.hh"
#include "dev/net/etherint.hh"
#include "dev/net/etherobject.hh"
#include "dev/net/etherpkt.hh"

#if USE_TUNTAP
#include "params/EtherTap.hh"

#endif

#include "params/EtherTapStub.hh"
#include "sim/eventq.hh"
#include "sim/sim_object.hh"

class TapEvent;
class EtherTapInt;

class EtherTapBase : public EtherObject
{
  public:
    typedef EtherTapBaseParams Params;
    EtherTapBase(const Params *p);
    virtual ~EtherTapBase();

    const Params *
    params() const
    {
        return dynamic_cast<const Params *>(_params);
    }

    void serialize(CheckpointOut &cp) const override;
    void unserialize(CheckpointIn &cp) override;

  protected:
    uint8_t *buffer;
    int buflen;

    EtherDump *dump;


    /*
     * Interface to the real network.
     */
  protected:
    friend class TapEvent;
    TapEvent *event;
    void pollFd(int fd);
    void stopPolling();

    // Receive data from the real network.
    virtual void recvReal(int revent) = 0;
    // Prepare and send data out to the real network.
    virtual bool sendReal(const void *data, size_t len) = 0;


    /*
     * Interface to the simulated network.
     */
  protected:
    EtherTapInt *interface;

  public:
    EtherInt *getEthPort(const std::string &if_name, int idx) override;

    bool recvSimulated(EthPacketPtr packet);
    void sendSimulated(void *data, size_t len);

  protected:
    std::queue<EthPacketPtr> packetBuffer;
    void retransmit();
    EventFunctionWrapper txEvent;
};

class EtherTapInt : public EtherInt
{
  private:
    EtherTapBase *tap;
  public:
    EtherTapInt(const std::string &name, EtherTapBase *t) :
            EtherInt(name), tap(t)
    { }

    bool recvPacket(EthPacketPtr pkt) override
        { return tap->recvSimulated(pkt); }
    void sendDone() override {}
};


class TapListener;

/*
 * Interface to connect a simulated ethernet device to the real world. An
 * external helper program bridges between this object's TCP port and a
 * source/sink for Ethernet frames. Each frame going in either direction is
 * prepended with the frame's length in a 32 bit integer in network byte order.
 */
class EtherTapStub : public EtherTapBase
{
  public:
    typedef EtherTapStubParams Params;
    EtherTapStub(const Params *p);
    ~EtherTapStub();

    const Params *
    params() const
    {
        return dynamic_cast<const Params *>(_params);
    }

    void serialize(CheckpointOut &cp) const override;
    void unserialize(CheckpointIn &cp) override;


  protected:
    friend class TapListener;
    TapListener *listener;

    int socket;

    void attach(int fd);
    void detach();

    uint32_t buffer_used;
    uint32_t frame_len;

    void recvReal(int revent) override;
    bool sendReal(const void *data, size_t len) override;
};


#if USE_TUNTAP
class EtherTap : public EtherTapBase
{
  public:
    typedef EtherTapParams Params;
    EtherTap(const Params *p);
    ~EtherTap();

    const Params *
    params() const
    {
        return dynamic_cast<const Params *>(_params);
    }


  protected:
    int tap;

    void recvReal(int revent) override;
    bool sendReal(const void *data, size_t len) override;
};
#endif


#endif // __DEV_NET_ETHERTAP_HH__