2 * Copyright (c) 2002-2004 The Regents of The University of Michigan
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.
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.
30 * Device module for modelling a fixed bandwidth full duplex ethernet link
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/universe.hh"
50 EtherLink::EtherLink(const string
&name
, EtherInt
*peer0
, EtherInt
*peer1
,
51 double rate
, Tick delay
, EtherDump
*dump
)
54 link
[0] = new Link(name
+ ".link0", this, 0, rate
, delay
, dump
);
55 link
[1] = new Link(name
+ ".link1", this, 1, rate
, delay
, dump
);
57 interface
[0] = new Interface(name
+ ".int0", link
[0], link
[1]);
58 interface
[1] = new Interface(name
+ ".int1", link
[1], link
[0]);
60 interface
[0]->setPeer(peer0
);
61 peer0
->setPeer(interface
[0]);
62 interface
[1]->setPeer(peer1
);
63 peer1
->setPeer(interface
[1]);
66 EtherLink::~EtherLink()
75 EtherLink::Interface::Interface(const string
&name
, Link
*tx
, Link
*rx
)
76 : EtherInt(name
), txlink(tx
)
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
),
90 EtherLink::serialize(ostream
&os
)
92 link
[0]->serialize("link0", os
);
93 link
[1]->serialize("link1", os
);
97 EtherLink::unserialize(Checkpoint
*cp
, const string
§ion
)
99 link
[0]->unserialize("link0", cp
, section
);
100 link
[1]->unserialize("link1", cp
, section
);
104 EtherLink::Link::txComplete(PacketPtr packet
)
106 DPRINTF(Ethernet
, "packet received: len=%d\n", packet
->length
);
107 DDUMP(EthernetData
, packet
->data
, packet
->length
);
108 rxint
->sendPacket(packet
);
111 class LinkDelayEvent
: public Event
114 EtherLink::Link
*link
;
118 // non-scheduling version for createForUnserialize()
120 LinkDelayEvent(EtherLink::Link
*link
, PacketPtr pkt
, Tick when
);
124 virtual void serialize(ostream
&os
);
125 virtual void unserialize(Checkpoint
*cp
, const string
§ion
);
126 static Serializable
*createForUnserialize(Checkpoint
*cp
,
127 const string
§ion
);
131 EtherLink::Link::txDone()
137 DPRINTF(Ethernet
, "packet delayed: delay=%d\n", linkDelay
);
138 new LinkDelayEvent(this, packet
, curTick
+ linkDelay
);
150 EtherLink::Link::transmit(PacketPtr pkt
)
153 DPRINTF(Ethernet
, "packet not sent, link busy\n");
157 DPRINTF(Ethernet
, "packet sent: len=%d\n", pkt
->length
);
158 DDUMP(EthernetData
, pkt
->data
, pkt
->length
);
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
);
170 EtherLink::Link::serialize(const string
&base
, ostream
&os
)
172 bool packet_exists
= packet
;
173 paramOut(os
, base
+ ".packet_exists", packet_exists
);
175 packet
->serialize(base
+ ".packet", os
);
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
);
187 EtherLink::Link::unserialize(const string
&base
, Checkpoint
*cp
,
188 const string
§ion
)
191 paramIn(cp
, section
, base
+ ".packet_exists", packet_exists
);
193 packet
= new PacketData(16384);
194 packet
->unserialize(base
+ ".packet", cp
, section
);
197 bool event_scheduled
;
198 paramIn(cp
, section
, base
+ ".event_scheduled", event_scheduled
);
199 if (event_scheduled
) {
201 paramIn(cp
, section
, base
+ ".event_time", event_time
);
202 doneEvent
.schedule(event_time
);
206 LinkDelayEvent::LinkDelayEvent()
207 : Event(&mainEventQueue
), link(NULL
)
209 setFlags(AutoSerialize
);
210 setFlags(AutoDelete
);
213 LinkDelayEvent::LinkDelayEvent(EtherLink::Link
*l
, PacketPtr p
, Tick when
)
214 : Event(&mainEventQueue
), link(l
), packet(p
)
216 setFlags(AutoSerialize
);
217 setFlags(AutoDelete
);
222 LinkDelayEvent::process()
224 link
->txComplete(packet
);
228 LinkDelayEvent::serialize(ostream
&os
)
230 paramOut(os
, "type", string("LinkDelayEvent"));
231 Event::serialize(os
);
233 EtherLink
*parent
= link
->parent
;
234 bool number
= link
->number
;
235 SERIALIZE_OBJPTR(parent
);
236 SERIALIZE_SCALAR(number
);
238 packet
->serialize("packet", os
);
243 LinkDelayEvent::unserialize(Checkpoint
*cp
, const string
§ion
)
245 Event::unserialize(cp
, section
);
249 UNSERIALIZE_OBJPTR(parent
);
250 UNSERIALIZE_SCALAR(number
);
252 link
= parent
->link
[number
];
254 packet
= new PacketData(16384);
255 packet
->unserialize("packet", cp
, section
);
260 LinkDelayEvent::createForUnserialize(Checkpoint
*cp
, const string
§ion
)
262 return new LinkDelayEvent();
265 REGISTER_SERIALIZEABLE("LinkDelayEvent", LinkDelayEvent
)
267 BEGIN_DECLARE_SIM_OBJECT_PARAMS(EtherLink
)
269 SimObjectParam
<EtherInt
*> int1
;
270 SimObjectParam
<EtherInt
*> int2
;
273 SimObjectParam
<EtherDump
*> dump
;
275 END_DECLARE_SIM_OBJECT_PARAMS(EtherLink
)
277 BEGIN_INIT_SIM_OBJECT_PARAMS(EtherLink
)
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")
285 END_INIT_SIM_OBJECT_PARAMS(EtherLink
)
287 CREATE_SIM_OBJECT(EtherLink
)
289 return new EtherLink(getInstanceName(), int1
, int2
, speed
, delay
, dump
);
292 REGISTER_SIM_OBJECT("EtherLink", EtherLink
)