etherlink.hh revision 4981 
1/*
2 * Copyright (c) 2002-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 * Device module for modelling a fixed bandwidth full duplex ethernet link
33 */
34
35#ifndef __DEV_ETHERLINK_HH__
36#define __DEV_ETHERLINK_HH__
37
38#include "dev/etherobject.hh"
39#include "dev/etherint.hh"
40#include "dev/etherpkt.hh"
41#include "params/EtherLink.hh"
42#include "sim/eventq.hh"
43#include "sim/host.hh"
44#include "sim/sim_object.hh"
45
46class EtherDump;
47class Checkpoint;
48/*
49 * Model for a fixed bandwidth full duplex ethernet link
50 */
51class EtherLink : public EtherObject
52{
53  protected:
54    class Interface;
55
56    friend class LinkDelayEvent;
57     /*
58      * Model for a single uni-directional link
59      */
60    class Link
61    {
62      protected:
63        std::string objName;
64
65        EtherLink *parent;
66        int number;
67
68        Interface *txint;
69        Interface *rxint;
70
71        double ticksPerByte;
72        Tick linkDelay;
73        Tick delayVar;
74        EtherDump *dump;
75
76      protected:
77        /*
78         * Transfer is complete
79         */
80        EthPacketPtr packet;
81        void txDone();
82        typedef EventWrapper<Link, &Link::txDone> DoneEvent;
83        friend void DoneEvent::process();
84        DoneEvent doneEvent;
85
86        friend class LinkDelayEvent;
87        void txComplete(EthPacketPtr packet);
88
89      public:
90        Link(const std::string &name, EtherLink *p, int num,
91             double rate, Tick delay, Tick delay_var, EtherDump *dump);
92        ~Link() {}
93
94        const std::string name() const { return objName; }
95
96        bool busy() const { return (bool)packet; }
97        bool transmit(EthPacketPtr packet);
98
99        void setTxInt(Interface *i) { assert(!txint); txint = i; }
100        void setRxInt(Interface *i) { assert(!rxint); rxint = i; }
101
102        void serialize(const std::string &base, std::ostream &os);
103        void unserialize(const std::string &base, Checkpoint *cp,
104                                 const std::string &section);
105    };
106
107    /*
108     * Interface at each end of the link
109     */
110    class Interface : public EtherInt
111    {
112      private:
113        Link *txlink;
114
115      public:
116        Interface(const std::string &name, Link *txlink, Link *rxlink);
117        bool recvPacket(EthPacketPtr packet) { return txlink->transmit(packet); }
118        void sendDone() { peer->sendDone(); }
119        bool isBusy() { return txlink->busy(); }
120    };
121
122    Link *link[2];
123    Interface *interface[2];
124
125  public:
126    typedef EtherLinkParams Params;
127    EtherLink(const Params *p);
128    virtual ~EtherLink();
129
130    const Params *
131    params() const
132    {
133        return dynamic_cast<const Params *>(_params);
134    }
135
136    virtual EtherInt *getEthPort(const std::string &if_name, int idx);
137
138    virtual void serialize(std::ostream &os);
139    virtual void unserialize(Checkpoint *cp, const std::string &section);
140
141};
142
143#endif // __ETHERLINK_HH__
144