-
Notifications
You must be signed in to change notification settings - Fork 0
/
netsim_base.py
468 lines (395 loc) · 14.6 KB
/
netsim_base.py
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
from __future__ import annotations
from abc import ABC, abstractmethod
from dataclasses import dataclass
import logging
from typing import Dict, List, Optional, Set, Type, Union, Generator, Any
from netsim.netsim_common import (
InterfaceBW,
NetSimObjectID,
NetSimObjectName,
PacketAction,
PacketFlowID,
PacketID,
PacketSize,
)
from netsim.netsim_stat import PacketQueueStat, PacketStat
from netsim.sim_common import SimTime
from netsim.simcore import (
Coro,
Process,
QueueFIFO,
SimContext,
)
from netsim.simstat import Stat
from netsim.stat_base import DistrBuilder, DistrFunc
LOG_FMT = "%(levelname)s - %(message)s"
logging.basicConfig(level=logging.INFO, format=LOG_FMT)
logger = logging.getLogger(__name__)
class NetSimObject(ABC):
_next_netsim_id: NetSimObjectID = 0
def __init__(
self,
ctx: SimContext,
name: Optional[NetSimObjectName] = None,
stat_type: Optional[Type[Stat]] = None,
):
self._ctx: SimContext = ctx
self.ns_id, NetSimObject._next_netsim_id = (
NetSimObject._next_netsim_id,
NetSimObject._next_netsim_id + 1,
)
self.name: NetSimObjectName = (
name if name else f"{type(self).__name__}_{self.ns_id}"
)
self.process: Process = ctx.create_process(self.run(), self.name)
self.process.extend_name("_proc")
self.stat: Stat = Stat(self._ctx) if not stat_type else stat_type(self._ctx)
def __repr__(self) -> str:
return f"{self.name}(process={self.process.name})"
def extend_name(self, extension: str, prepend: bool = False) -> None:
if prepend:
self.name = extension + self.name
else:
self.name = self.name + extension
@abstractmethod
def run(self, *args: List[Any], **kwargs: Dict[str, Any]) -> Coro:
raise NotImplementedError(self)
class Packet:
_next_packet_id: PacketID = 0
def __init__(
self,
ctx: SimContext,
size: PacketSize,
flow_id: PacketFlowID = 0,
):
self._ctx = ctx
self.packet_id, Packet._next_packet_id = (
Packet._next_packet_id,
Packet._next_packet_id + 1,
)
self.flow_id = flow_id
self.size = size
self.generated_timestamp = ctx.now
self.touched_timestamp: Optional[SimTime] = None
self.touched_by: Optional[NetSimObjectName] = None
self.last_action: Optional[PacketAction] = None
def __repr__(self) -> str:
type_name = type(self).__name__
return f"{type_name}(packet_id={self.packet_id}, flow_id={self.flow_id}, size={self.size}, timestamp={self.generated_timestamp})"
@classmethod
def reset_packet_id(cls):
cls.next_packet_id: PacketID = 0
def touched(self, ns_obj: NetSimObject, action: PacketAction) -> None:
self.touched_timestamp = self._ctx.now
self.touched_by = ns_obj.name
self.last_action = action
def todict(self) -> Dict[str, Any]:
return {
field: getattr(self, field)
for field in vars(self)
if not field.startswith("_")
}
class Sender(NetSimObject):
def __init__(
self,
ctx: SimContext,
name: Optional[NetSimObjectName] = None,
stat_type: Optional[Type[Stat]] = None,
):
super().__init__(ctx, name=name, stat_type=stat_type or PacketStat)
self.stat: PacketStat = self.stat
self._subscribers: List[Receiver] = []
self.process.add_stat_callback(self.stat.advance_time)
def subscribe(
self, receiver: Receiver, *args: List[Any], **kwargs: Dict[str, Any]
) -> None:
_, _ = args, kwargs
self._subscribers.append(receiver)
receiver.add_subscription(self)
def _packet_sent(self, packet: Packet) -> None:
packet.touched(self, action=PacketAction.SENT)
self.stat.packet_sent(packet)
def _packet_received(self, packet: Packet) -> None:
packet.touched(self, action=PacketAction.RECEIVED)
self.stat.packet_received(packet)
def _packet_dropped(self, packet: Packet) -> None:
packet.touched(self, action=PacketAction.DROPPED)
self.stat.packet_dropped(packet)
class Receiver(NetSimObject):
def __init__(
self,
ctx: SimContext,
name: Optional[NetSimObjectName] = None,
stat_type: Optional[Type[Stat]] = None,
):
super().__init__(ctx, name=name, stat_type=stat_type or PacketStat)
self.stat: PacketStat = self.stat
self.process.add_stat_callback(self.stat.advance_time)
self._subscriptions: Set[Union[Sender, SenderReceiver]] = set()
@abstractmethod
def put(
self,
item: Any,
source: NetSimObject,
*args: List[Any],
**kwargs: Dict[str, Any],
) -> None:
raise NotImplementedError(self)
def add_subscription(self, ns_obj: Union[Sender, SenderReceiver]) -> None:
self._subscriptions.add(ns_obj)
def get_subscriptions(self) -> Set[Union[Sender, SenderReceiver]]:
return self._subscriptions
def _packet_received(self, packet: Packet) -> None:
packet.touched(self, action=PacketAction.RECEIVED)
self.stat.packet_received(packet)
def _packet_dropped(self, packet: Packet) -> None:
packet.touched(self, action=PacketAction.DROPPED)
self.stat.packet_dropped(packet)
class SenderReceiver(NetSimObject):
def __init__(
self,
ctx: SimContext,
name: Optional[NetSimObjectName] = None,
stat_type: Optional[Type[Stat]] = None,
):
super().__init__(ctx, name=name, stat_type=stat_type or PacketStat)
self.stat: PacketStat = self.stat
self._subscribers: List[Receiver] = []
self._subscriptions: Set[Union[Sender, SenderReceiver]] = set()
self.process.add_stat_callback(self.stat.advance_time)
@abstractmethod
def put(
self,
item: Any,
source: NetSimObject,
*args: List[Any],
**kwargs: Dict[str, Any],
) -> None:
raise NotImplementedError(self)
def subscribe(
self, receiver: Receiver, *args: List[Any], **kwargs: Dict[str, Any]
) -> None:
_, _ = args, kwargs
self._subscribers.append(receiver)
receiver.add_subscription(self)
def add_subscription(self, ns_obj: Union[Sender, SenderReceiver]) -> None:
self._subscriptions.add(ns_obj)
def get_subscriptions(self) -> Set[Union[Sender, SenderReceiver]]:
return self._subscriptions
def _packet_sent(self, packet: Packet) -> None:
packet.touched(self, action=PacketAction.SENT)
self.stat.packet_sent(packet)
def _packet_received(self, packet: Packet) -> None:
packet.touched(self, action=PacketAction.RECEIVED)
self.stat.packet_received(packet)
def _packet_dropped(self, packet: Packet) -> None:
packet.touched(self, action=PacketAction.DROPPED)
self.stat.packet_dropped(packet)
@dataclass
class PacketSourceProfile:
arrival_time_distr: DistrFunc
arrival_distr_params: Dict[str, Any]
size_distr: DistrFunc
size_distr_params: Dict[str, Any]
flow_distr: DistrFunc
flow_distr_params: Dict[str, Any]
initial_delay: SimTime = 0
@classmethod
def from_dict(cls, params: Dict[str, Any]):
arrival_time_distr = DistrFunc[params["arrival_time_distr"]]
arrival_distr_params = params["arrival_distr_params"]
size_distr = DistrFunc[params["size_distr"]]
size_distr_params = params["size_distr_params"]
flow_distr = DistrFunc[params["flow_distr"]]
flow_distr_params = params["flow_distr_params"]
initial_delay = params["initial_delay"] if "initial_delay" in params else 0
return cls(
arrival_time_distr,
arrival_distr_params,
size_distr,
size_distr_params,
flow_distr,
flow_distr_params,
initial_delay,
)
class PacketSource(Sender):
def __init__(
self,
ctx: SimContext,
arrival_func: Generator,
size_func: Generator,
flow_func: Optional[Generator] = None,
initial_delay: SimTime = 0,
name: Optional[NetSimObjectName] = None,
):
super().__init__(ctx, name=name)
self._arrival_func: Generator = arrival_func
self._size_func: Generator = size_func
self._flow_func: Optional[Generator] = flow_func
self._initial_delay: SimTime = initial_delay
@classmethod
def create(
cls, ctx: SimContext, name: NetSimObjectName, profile: PacketSourceProfile
) -> PacketSource:
arrival_func = DistrBuilder.create(
profile.arrival_time_distr, profile.arrival_distr_params
)
size_func = DistrBuilder.create(profile.size_distr, profile.size_distr_params)
flow_func = DistrBuilder.create(profile.flow_distr, profile.flow_distr_params)
return cls(ctx, arrival_func, size_func, flow_func, profile.initial_delay, name)
def run(self, *args: List[Any], **kwargs: Dict[str, Any]) -> Coro:
yield self.process.timeout(self._initial_delay)
while True:
arrival = next(self._arrival_func, None)
if arrival is None:
return
yield self.process.timeout(arrival)
size = next(self._size_func, None)
flow = next(self._flow_func, 0) if self._flow_func else 0
if size is None:
return
packet = Packet(self._ctx, size, flow_id=flow)
self._packet_sent(packet)
for subscriber in self._subscribers:
subscriber.put(packet, self)
class PacketSink(Receiver):
def put(
self,
item: Packet,
source: Union[Sender, SenderReceiver],
*args: List[Any],
**kwargs: Dict[str, Any],
) -> None:
self._packet_received(item)
def run(self, *args: List[Any], **kwargs: Dict[str, Any]) -> Coro:
yield
class PacketQueue(SenderReceiver):
def __init__(
self,
ctx: SimContext,
capacity: Optional[int] = None,
name: Optional[NetSimObjectName] = None,
):
super().__init__(ctx, name=name, stat_type=PacketQueueStat)
self.stat: PacketQueueStat = self.stat
self._queue = QueueFIFO(ctx, capacity, name=self.name)
self._queue.extend_name("_QueueFIFO")
def run(self, *args: List[Any], **kwargs: Dict[str, Any]) -> Coro:
while True:
packet: Packet = yield self._queue.get()
if packet:
self._packet_get(packet)
for subscriber in self._subscribers:
subscriber.put(packet, self)
self._packet_sent(packet)
else:
raise RuntimeError(f"{packet}")
def put(
self,
item: Packet,
source: Union[Sender, SenderReceiver],
*args: List[Any],
**kwargs: Dict[str, Any],
) -> None:
self._queue.put(item)
self._packet_received(item)
self._packet_put(item)
def _packet_put(self, packet: Packet) -> None:
self.stat.packet_put(packet)
def _packet_get(self, packet: Packet) -> None:
self.stat.packet_get(packet)
def _packet_dropped(self, packet: Packet) -> None:
self.stat.packet_dropped(packet)
self.stat.packet_dropped(packet)
class PacketInterfaceRx(PacketQueue):
def __init__(
self,
ctx: SimContext,
propagation_delay: Optional[SimTime] = None,
transmission_len_limit: Optional[int] = None,
name: Optional[NetSimObjectName] = None,
):
super().__init__(ctx, name=name)
self._propagation_delay: Optional[SimTime] = propagation_delay
self._transmission_len_limit: Optional[int] = transmission_len_limit
def run(self, *args: List[Any], **kwargs: Dict[str, Any]) -> Coro:
while True:
packet: Packet = yield self._queue.get()
if packet:
if self._propagation_delay:
yield self.process.timeout(self._propagation_delay)
self._packet_get(packet)
for subscriber in self._subscribers:
subscriber.put(packet, self)
self._packet_sent(packet)
else:
raise RuntimeError(
f"Resumed {self} without packet at {self._ctx.now}",
)
def put(
self,
item: Packet,
source: Union[Sender, SenderReceiver],
*args: List[Any],
**kwargs: Dict[str, Any],
) -> None:
# this is effectively a transmission media
if self._queue_admission_tail_drop(packet=item):
self._queue.put(item)
self._packet_put(item)
self._packet_received(item)
else:
self._packet_dropped(item)
def _queue_admission_tail_drop(self, packet: Packet):
_ = packet
if (
not self._transmission_len_limit
or len(self._queue) < self._transmission_len_limit
):
return True
return False
class PacketInterfaceTx(PacketQueue):
def __init__(
self,
ctx: SimContext,
bw: InterfaceBW,
queue_len_limit: Optional[int] = None,
name: Optional[NetSimObjectName] = None,
):
super().__init__(ctx, name=name)
self._bw: InterfaceBW = bw
self._queue_len_limit: Optional[int] = queue_len_limit
self._busy: bool = False
def run(self, *args: List[Any], **kwargs: Dict[str, Any]) -> Coro:
while True:
packet: Packet = yield self._queue.get()
if packet:
self._busy = True
self._packet_get(packet)
yield self.process.timeout(packet.size * 8 / self._bw)
for subscriber in self._subscribers:
subscriber.put(packet, self)
self._packet_sent(packet)
self._busy = False
else:
raise RuntimeError(
f"Resumed {self} without packet at {self._ctx.now}",
)
def put(
self,
item: Packet,
source: Union[Sender, SenderReceiver],
*args: List[Any],
**kwargs: Dict[str, Any],
):
self._packet_received(item)
if self._queue_admission_tail_drop(packet=item):
self._queue.put(item)
self._packet_put(item)
else:
self._packet_dropped(item)
def _queue_admission_tail_drop(self, packet: Packet):
_ = packet
if not self._queue_len_limit or len(self._queue) < self._queue_len_limit:
return True
return False