dev/etherlink.cc

   1 /*
   2  * Copyright (c) 2003 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/universe.hh"
  45
  46 using namespace std;
  47
  48 EtherLink::EtherLink(const std::string &name, EtherInt *i1, EtherInt *i2,
  49                      Tick speed, EtherDump *dump)
  50     : SimObject(name)
  51 {
  52     double rate = ((double)ticksPerSecond * 8.0) / (double)speed;
  53
  54     link1 = new Link(name + ".link1", rate, dump);
  55     link2 = new Link(name + ".link2", rate, dump);
  56
  57     int1 = new Interface(name + ".int1", link1, link2);
  58     int2 = new Interface(name + ".int2", link2, link1);
  59
  60     int1->setPeer(i1);
  61     i1->setPeer(int1);
  62     int2->setPeer(i2);
  63     i2->setPeer(int2);
  64 }
  65
  66 EtherLink::~EtherLink()
  67 {
  68     delete link1;
  69     delete link2;
  70
  71     delete int1;
  72     delete int2;
  73 }
  74
  75 EtherLink::Interface::Interface(const std::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 std::string &name, double rate, EtherDump *d)
  83     : objName(name), txint(NULL), rxint(NULL), ticks_per_byte(rate),
  84       dump(d), event(&mainEventQueue, this)
  85 {}
  86
  87 void
  88 EtherLink::Link::txDone()
  89 {
  90     if (dump)
  91         dump->dump(packet);
  92
  93     DPRINTF(Ethernet, "EtherLink packet received: len=%d\n", packet->length);
  94     DDUMP(EthernetData, packet->data, packet->length);
  95
  96     rxint->sendPacket(packet);
  97
  98     packet = 0;
  99     assert(!busy());
 100
 101     txint->sendDone();
 102 }
 103
 104 bool
 105 EtherLink::Link::transmit(PacketPtr pkt)
 106 {
 107     if (busy()) {
 108         DPRINTF(Ethernet, "EtherLink packet not sent, link busy\n");
 109         return false;
 110     }
 111
 112     DPRINTF(Ethernet, "EtherLink packet sent: len=%d\n", pkt->length);
 113     DDUMP(EthernetData, pkt->data, pkt->length);
 114
 115     packet = pkt;
 116     int delay = (int)ceil(((double)pkt->length * ticks_per_byte) + 1.0);
 117     DPRINTF(Ethernet, "EtherLink scheduling packet: delay=%d, (rate=%f)\n",
 118             delay, ticks_per_byte);
 119     event.schedule(curTick + delay);
 120
 121     return true;
 122 }
 123
 124 BEGIN_DECLARE_SIM_OBJECT_PARAMS(EtherLink)
 125
 126     SimObjectParam<EtherInt *> interface1;
 127     SimObjectParam<EtherInt *> interface2;
 128     Param<Tick> link_speed;
 129     SimObjectParam<EtherDump *> packet_dump;
 130
 131 END_DECLARE_SIM_OBJECT_PARAMS(EtherLink)
 132
 133 BEGIN_INIT_SIM_OBJECT_PARAMS(EtherLink)
 134
 135     INIT_PARAM(interface1, "interface 1"),
 136     INIT_PARAM(interface2, "interface 2"),
 137     INIT_PARAM_DFLT(link_speed, "link speed in bits per second", 100000000),
 138     INIT_PARAM_DFLT(packet_dump, "object to dump network packets to", NULL)
 139
 140 END_INIT_SIM_OBJECT_PARAMS(EtherLink)
 141
 142 CREATE_SIM_OBJECT(EtherLink)
 143 {
 144     return new EtherLink(getInstanceName(), interface1, interface2, link_speed,
 145                          packet_dump);
 146 }
 147
 148 REGISTER_SIM_OBJECT("EtherLink", EtherLink)