dev/etherlink.cc

   1 /*
   2  * Copyright (c) 2002-2004 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  * Device module for modelling a fixed bandwidth full duplex ethernet link
  31  */
  32
  33 #include <cmath>
  34 #include <deque>
  35 #include <string>
  36 #include <vector>
  37
  38 #include "base/trace.hh"
  39 #include "dev/etherdump.hh"
  40 #include "dev/etherint.hh"
  41 #include "dev/etherlink.hh"
  42 #include "dev/etherpkt.hh"
  43 #include "sim/builder.hh"
  44 #include "sim/serialize.hh"
  45 #include "sim/system.hh"
  46 #include "sim/root.hh"
  47
  48 using namespace std;
  49
  50 EtherLink::EtherLink(const string &name, EtherInt *peer0, EtherInt *peer1,
  51                      double rate, Tick delay, EtherDump *dump)
  52     : SimObject(name)
  53 {
  54     link[0] = new Link(name + ".link0", this, 0, rate, delay, dump);
  55     link[1] = new Link(name + ".link1", this, 1, rate, delay, dump);
  56
  57     interface[0] = new Interface(name + ".int0", link[0], link[1]);
  58     interface[1] = new Interface(name + ".int1", link[1], link[0]);
  59
  60     interface[0]->setPeer(peer0);
  61     peer0->setPeer(interface[0]);
  62     interface[1]->setPeer(peer1);
  63     peer1->setPeer(interface[1]);
  64 }
  65
  66 EtherLink::~EtherLink()
  67 {
  68     delete link[0];
  69     delete link[1];
  70
  71     delete interface[0];
  72     delete interface[1];
  73 }
  74
  75 EtherLink::Interface::Interface(const string &name, Link *tx, Link *rx)
  76     : EtherInt(name), txlink(tx)
  77 {
  78     tx->setTxInt(this);
  79     rx->setRxInt(this);
  80 }
  81
  82 EtherLink::Link::Link(const string &name, EtherLink *p, int num,
  83                       double rate, Tick delay, EtherDump *d)
  84     : objName(name), parent(p), number(num), txint(NULL), rxint(NULL),
  85       ticksPerByte(rate), linkDelay(delay), dump(d),
  86       doneEvent(this)
  87 { }
  88
  89 void
  90 EtherLink::serialize(ostream &os)
  91 {
  92     link[0]->serialize("link0", os);
  93     link[1]->serialize("link1", os);
  94 }
  95
  96 void
  97 EtherLink::unserialize(Checkpoint *cp, const string &section)
  98 {
  99     link[0]->unserialize("link0", cp, section);
 100     link[1]->unserialize("link1", cp, section);
 101 }
 102
 103 void
 104 EtherLink::Link::txComplete(PacketPtr packet)
 105 {
 106     DPRINTF(Ethernet, "packet received: len=%d\n", packet->length);
 107     DDUMP(EthernetData, packet->data, packet->length);
 108     rxint->sendPacket(packet);
 109 }
 110
 111 class LinkDelayEvent : public Event
 112 {
 113   protected:
 114     EtherLink::Link *link;
 115     PacketPtr packet;
 116
 117   public:
 118     // non-scheduling version for createForUnserialize()
 119     LinkDelayEvent();
 120     LinkDelayEvent(EtherLink::Link *link, PacketPtr pkt, Tick when);
 121
 122     void process();
 123
 124     virtual void serialize(ostream &os);
 125     virtual void unserialize(Checkpoint *cp, const string &section);
 126     static Serializable *createForUnserialize(Checkpoint *cp,
 127                                               const string &section);
 128 };
 129
 130 void
 131 EtherLink::Link::txDone()
 132 {
 133     if (dump)
 134         dump->dump(packet);
 135
 136     if (linkDelay > 0) {
 137         DPRINTF(Ethernet, "packet delayed: delay=%d\n", linkDelay);
 138         new LinkDelayEvent(this, packet, curTick + linkDelay);
 139     } else {
 140         txComplete(packet);
 141     }
 142
 143     packet = 0;
 144     assert(!busy());
 145
 146     txint->sendDone();
 147 }
 148
 149 bool
 150 EtherLink::Link::transmit(PacketPtr pkt)
 151 {
 152     if (busy()) {
 153         DPRINTF(Ethernet, "packet not sent, link busy\n");
 154         return false;
 155     }
 156
 157     DPRINTF(Ethernet, "packet sent: len=%d\n", pkt->length);
 158     DDUMP(EthernetData, pkt->data, pkt->length);
 159
 160     packet = pkt;
 161     Tick delay = (Tick)ceil(((double)pkt->length * ticksPerByte) + 1.0);
 162     DPRINTF(Ethernet, "scheduling packet: delay=%d, (rate=%f)\n",
 163             delay, ticksPerByte);
 164     doneEvent.schedule(curTick + delay);
 165
 166     return true;
 167 }
 168
 169 void
 170 EtherLink::Link::serialize(const string &base, ostream &os)
 171 {
 172     bool packet_exists = packet;
 173     paramOut(os, base + ".packet_exists", packet_exists);
 174     if (packet_exists)
 175         packet->serialize(base + ".packet", os);
 176
 177     bool event_scheduled = doneEvent.scheduled();
 178     paramOut(os, base + ".event_scheduled", event_scheduled);
 179     if (event_scheduled) {
 180         Tick event_time = doneEvent.when();
 181         paramOut(os, base + ".event_time", event_time);
 182     }
 183
 184 }
 185
 186 void
 187 EtherLink::Link::unserialize(const string &base, Checkpoint *cp,
 188                              const string &section)
 189 {
 190     bool packet_exists;
 191     paramIn(cp, section, base + ".packet_exists", packet_exists);
 192     if (packet_exists) {
 193         packet = new PacketData(16384);
 194         packet->unserialize(base + ".packet", cp, section);
 195     }
 196
 197     bool event_scheduled;
 198     paramIn(cp, section, base + ".event_scheduled", event_scheduled);
 199     if (event_scheduled) {
 200         Tick event_time;
 201         paramIn(cp, section, base + ".event_time", event_time);
 202         doneEvent.schedule(event_time);
 203     }
 204 }
 205
 206 LinkDelayEvent::LinkDelayEvent()
 207     : Event(&mainEventQueue), link(NULL)
 208 {
 209     setFlags(AutoSerialize);
 210     setFlags(AutoDelete);
 211 }
 212
 213 LinkDelayEvent::LinkDelayEvent(EtherLink::Link *l, PacketPtr p, Tick when)
 214     : Event(&mainEventQueue), link(l), packet(p)
 215 {
 216     setFlags(AutoSerialize);
 217     setFlags(AutoDelete);
 218     schedule(when);
 219 }
 220
 221 void
 222 LinkDelayEvent::process()
 223 {
 224     link->txComplete(packet);
 225 }
 226
 227 void
 228 LinkDelayEvent::serialize(ostream &os)
 229 {
 230     paramOut(os, "type", string("LinkDelayEvent"));
 231     Event::serialize(os);
 232
 233     EtherLink *parent = link->parent;
 234     bool number = link->number;
 235     SERIALIZE_OBJPTR(parent);
 236     SERIALIZE_SCALAR(number);
 237
 238     packet->serialize("packet", os);
 239 }
 240
 241
 242 void
 243 LinkDelayEvent::unserialize(Checkpoint *cp, const string &section)
 244 {
 245     Event::unserialize(cp, section);
 246
 247     EtherLink *parent;
 248     bool number;
 249     UNSERIALIZE_OBJPTR(parent);
 250     UNSERIALIZE_SCALAR(number);
 251
 252     link = parent->link[number];
 253
 254     packet = new PacketData(16384);
 255     packet->unserialize("packet", cp, section);
 256 }
 257
 258
 259 Serializable *
 260 LinkDelayEvent::createForUnserialize(Checkpoint *cp, const string &section)
 261 {
 262     return new LinkDelayEvent();
 263 }
 264
 265 REGISTER_SERIALIZEABLE("LinkDelayEvent", LinkDelayEvent)
 266
 267 BEGIN_DECLARE_SIM_OBJECT_PARAMS(EtherLink)
 268
 269     SimObjectParam<EtherInt *> int1;
 270     SimObjectParam<EtherInt *> int2;
 271     Param<double> speed;
 272     Param<Tick> delay;
 273     SimObjectParam<EtherDump *> dump;
 274
 275 END_DECLARE_SIM_OBJECT_PARAMS(EtherLink)
 276
 277 BEGIN_INIT_SIM_OBJECT_PARAMS(EtherLink)
 278
 279     INIT_PARAM(int1, "interface 1"),
 280     INIT_PARAM(int2, "interface 2"),
 281     INIT_PARAM(speed, "link speed in bits per second"),
 282     INIT_PARAM(delay, "transmit delay of packets in us"),
 283     INIT_PARAM(dump, "object to dump network packets to")
 284
 285 END_INIT_SIM_OBJECT_PARAMS(EtherLink)
 286
 287 CREATE_SIM_OBJECT(EtherLink)
 288 {
 289     return new EtherLink(getInstanceName(), int1, int2, speed, delay, dump);
 290 }
 291
 292 REGISTER_SIM_OBJECT("EtherLink", EtherLink)