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
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
|
from collections import namedtuple, OrderedDict
from .trex_stl_packet_builder_scapy import STLPktBuilder
from .trex_stl_streams import STLStream
from .trex_stl_types import *
from . import trex_stl_stats
from .utils.constants import FLOW_CTRL_DICT_REVERSED
import base64
import copy
from datetime import datetime, timedelta
StreamOnPort = namedtuple('StreamOnPort', ['compiled_stream', 'metadata'])
########## utlity ############
def mult_to_factor (mult, max_bps_l2, max_pps, line_util):
if mult['type'] == 'raw':
return mult['value']
if mult['type'] == 'bps':
return mult['value'] / max_bps_l2
if mult['type'] == 'pps':
return mult['value'] / max_pps
if mult['type'] == 'percentage':
return mult['value'] / line_util
# describes a single port
class Port(object):
STATE_DOWN = 0
STATE_IDLE = 1
STATE_STREAMS = 2
STATE_TX = 3
STATE_PAUSE = 4
STATE_PCAP_TX = 5
MASK_ALL = ((1 << 64) - 1)
PortState = namedtuple('PortState', ['state_id', 'state_name'])
STATES_MAP = {STATE_DOWN: "DOWN",
STATE_IDLE: "IDLE",
STATE_STREAMS: "IDLE",
STATE_TX: "ACTIVE",
STATE_PAUSE: "PAUSE",
STATE_PCAP_TX : "ACTIVE"}
def __init__ (self, port_id, user, comm_link, session_id, info):
self.port_id = port_id
self.state = self.STATE_IDLE
self.handler = None
self.comm_link = comm_link
self.transmit = comm_link.transmit
self.transmit_batch = comm_link.transmit_batch
self.user = user
self.info = dict(info)
self.streams = {}
self.profile = None
self.session_id = session_id
self.attr = {}
self.port_stats = trex_stl_stats.CPortStats(self)
self.next_available_id = 1
self.tx_stopped_ts = None
self.has_rx_streams = False
self.owner = ''
self.last_factor_type = None
# decorator to verify port is up
def up(func):
def func_wrapper(*args):
port = args[0]
if not port.is_up():
return port.err("{0} - port is down".format(func.__name__))
return func(*args)
return func_wrapper
# owned
def owned(func):
def func_wrapper(*args):
port = args[0]
if not port.is_up():
return port.err("{0} - port is down".format(func.__name__))
if not port.is_acquired():
return port.err("{0} - port is not owned".format(func.__name__))
return func(*args)
return func_wrapper
# decorator to check server is readable (port not down and etc.)
def writeable(func):
def func_wrapper(*args, **kwargs):
port = args[0]
if not port.is_up():
return port.err("{0} - port is down".format(func.__name__))
if not port.is_acquired():
return port.err("{0} - port is not owned".format(func.__name__))
if not port.is_writeable():
return port.err("{0} - port is not in a writeable state".format(func.__name__))
return func(*args, **kwargs)
return func_wrapper
def err(self, msg):
return RC_ERR("port {0} : {1}\n".format(self.port_id, msg))
def ok(self, data = ""):
return RC_OK(data)
def get_speed_bps (self):
return (self.info['speed'] * 1000 * 1000 * 1000)
def get_formatted_speed (self):
return "{0} Gbps".format(self.info['speed'])
def is_acquired(self):
return (self.handler != None)
def is_up (self):
return (self.state != self.STATE_DOWN)
def is_active(self):
return (self.state == self.STATE_TX ) or (self.state == self.STATE_PAUSE) or (self.state == self.STATE_PCAP_TX)
def is_transmitting (self):
return (self.state == self.STATE_TX) or (self.state == self.STATE_PCAP_TX)
def is_paused (self):
return (self.state == self.STATE_PAUSE)
def is_writeable (self):
# operations on port can be done on state idle or state streams
return ((self.state == self.STATE_IDLE) or (self.state == self.STATE_STREAMS))
def get_owner (self):
if self.is_acquired():
return self.user
else:
return self.owner
def __allocate_stream_id (self):
id = self.next_available_id
self.next_available_id += 1
return id
# take the port
@up
def acquire(self, force = False, sync_streams = True):
params = {"port_id": self.port_id,
"user": self.user,
"session_id": self.session_id,
"force": force}
rc = self.transmit("acquire", params)
if not rc:
return self.err(rc.err())
self.handler = rc.data()
if sync_streams:
return self.sync_streams()
else:
return self.ok()
# sync all the streams with the server
@up
def sync_streams (self):
params = {"port_id": self.port_id}
rc = self.transmit("get_all_streams", params)
if rc.bad():
return self.err(rc.err())
for k, v in rc.data()['streams'].items():
self.streams[k] = {'next_id': v['next_stream_id'],
'pkt' : base64.b64decode(v['packet']['binary']),
'mode' : v['mode']['type'],
'rate' : STLStream.get_rate_from_field(v['mode']['rate'])}
return self.ok()
# release the port
@up
def release(self):
params = {"port_id": self.port_id,
"handler": self.handler}
rc = self.transmit("release", params)
if rc.good():
self.handler = None
self.owner = ''
return self.ok()
else:
return self.err(rc.err())
@up
def sync(self):
params = {"port_id": self.port_id}
rc = self.transmit("get_port_status", params)
if rc.bad():
return self.err(rc.err())
# sync the port
port_state = rc.data()['state']
if port_state == "DOWN":
self.state = self.STATE_DOWN
elif port_state == "IDLE":
self.state = self.STATE_IDLE
elif port_state == "STREAMS":
self.state = self.STATE_STREAMS
elif port_state == "TX":
self.state = self.STATE_TX
elif port_state == "PAUSE":
self.state = self.STATE_PAUSE
elif port_state == "PCAP_TX":
self.state = self.STATE_PCAP_TX
else:
raise Exception("port {0}: bad state received from server '{1}'".format(self.port_id, port_state))
self.owner = rc.data()['owner']
self.next_available_id = int(rc.data()['max_stream_id']) + 1
# attributes
self.attr = ['attr']
if 'speed' in rc.data():
self.info['speed'] = rc.data()['speed'] // 1000
return self.ok()
# add streams
@writeable
def add_streams (self, streams_list):
# listify
streams_list = streams_list if isinstance(streams_list, list) else [streams_list]
lookup = {}
# allocate IDs
for stream in streams_list:
# allocate stream id
stream_id = stream.get_id() if stream.get_id() is not None else self.__allocate_stream_id()
if stream_id in self.streams:
return self.err('Stream ID: {0} already exists'.format(stream_id))
# name
name = stream.get_name() if stream.get_name() is not None else id(stream)
if name in lookup:
return self.err("multiple streams with duplicate name: '{0}'".format(name))
lookup[name] = stream_id
batch = []
for stream in streams_list:
name = stream.get_name() if stream.get_name() is not None else id(stream)
stream_id = lookup[name]
next_id = -1
next = stream.get_next()
if next:
if not next in lookup:
return self.err("stream dependency error - unable to find '{0}'".format(next))
next_id = lookup[next]
stream_json = stream.to_json()
stream_json['next_stream_id'] = next_id
params = {"handler": self.handler,
"port_id": self.port_id,
"stream_id": stream_id,
"stream": stream_json}
cmd = RpcCmdData('add_stream', params, 'core')
batch.append(cmd)
rc = self.transmit_batch(batch)
ret = RC()
for i, single_rc in enumerate(rc):
if single_rc.rc:
stream_id = batch[i].params['stream_id']
next_id = batch[i].params['stream']['next_stream_id']
self.streams[stream_id] = {'next_id' : next_id,
'pkt' : streams_list[i].get_pkt(),
'mode' : streams_list[i].get_mode(),
'rate' : streams_list[i].get_rate(),
'has_flow_stats' : streams_list[i].has_flow_stats()}
ret.add(RC_OK(data = stream_id))
self.has_rx_streams = self.has_rx_streams or streams_list[i].has_flow_stats()
else:
ret.add(RC(*single_rc))
self.state = self.STATE_STREAMS if (len(self.streams) > 0) else self.STATE_IDLE
return ret if ret else self.err(str(ret))
# remove stream from port
@writeable
def remove_streams (self, stream_id_list):
# single element to list
stream_id_list = stream_id_list if isinstance(stream_id_list, list) else [stream_id_list]
# verify existance
if not all([stream_id in self.streams for stream_id in stream_id_list]):
return self.err("stream {0} does not exists".format(stream_id))
batch = []
for stream_id in stream_id_list:
params = {"handler": self.handler,
"port_id": self.port_id,
"stream_id": stream_id}
cmd = RpcCmdData('remove_stream', params, 'core')
batch.append(cmd)
rc = self.transmit_batch(batch)
for i, single_rc in enumerate(rc):
if single_rc:
id = batch[i].params['stream_id']
del self.streams[id]
self.state = self.STATE_STREAMS if (len(self.streams) > 0) else self.STATE_IDLE
# recheck if any RX stats streams present on the port
self.has_rx_streams = any([stream['has_flow_stats'] for stream in self.streams.values()])
return self.ok() if rc else self.err(rc.err())
# remove all the streams
@writeable
def remove_all_streams (self):
params = {"handler": self.handler,
"port_id": self.port_id}
rc = self.transmit("remove_all_streams", params)
if not rc:
return self.err(rc.err())
self.streams = {}
self.state = self.STATE_IDLE
self.has_rx_streams = False
return self.ok()
# get a specific stream
def get_stream (self, stream_id):
if stream_id in self.streams:
return self.streams[stream_id]
else:
return None
def get_all_streams (self):
return self.streams
@writeable
def start (self, mul, duration, force, mask):
if self.state == self.STATE_IDLE:
return self.err("unable to start traffic - no streams attached to port")
params = {"handler": self.handler,
"port_id": self.port_id,
"mul": mul,
"duration": duration,
"force": force,
"core_mask": mask if mask is not None else self.MASK_ALL}
# must set this before to avoid race with the async response
last_state = self.state
self.state = self.STATE_TX
rc = self.transmit("start_traffic", params)
if rc.bad():
self.state = last_state
return self.err(rc.err())
# save this for TUI
self.last_factor_type = mul['type']
return self.ok()
# stop traffic
# with force ignores the cached state and sends the command
@owned
def stop (self, force = False):
# if not is not active and not force - go back
if not self.is_active() and not force:
return self.ok()
params = {"handler": self.handler,
"port_id": self.port_id}
rc = self.transmit("stop_traffic", params)
if rc.bad():
return self.err(rc.err())
self.state = self.STATE_STREAMS
self.last_factor_type = None
# timestamp for last tx
self.tx_stopped_ts = datetime.now()
return self.ok()
# return True if port has any stream configured with RX stats
def has_rx_enabled (self):
return self.has_rx_streams
# return true if rx_delay_ms has passed since the last port stop
def has_rx_delay_expired (self, rx_delay_ms):
assert(self.has_rx_enabled())
# if active - it's not safe to remove RX filters
if self.is_active():
return False
# either no timestamp present or time has already passed
return not self.tx_stopped_ts or (datetime.now() - self.tx_stopped_ts) > timedelta(milliseconds = rx_delay_ms)
@writeable
def remove_rx_filters (self):
assert(self.has_rx_enabled())
if self.state == self.STATE_IDLE:
return self.ok()
params = {"handler": self.handler,
"port_id": self.port_id}
rc = self.transmit("remove_rx_filters", params)
if rc.bad():
return self.err(rc.err())
return self.ok()
@owned
def pause (self):
if (self.state == self.STATE_PCAP_TX) :
return self.err("pause is not supported during PCAP TX")
if (self.state != self.STATE_TX) :
return self.err("port is not transmitting")
params = {"handler": self.handler,
"port_id": self.port_id}
rc = self.transmit("pause_traffic", params)
if rc.bad():
return self.err(rc.err())
self.state = self.STATE_PAUSE
return self.ok()
@owned
def resume (self):
if (self.state != self.STATE_PAUSE) :
return self.err("port is not in pause mode")
params = {"handler": self.handler,
"port_id": self.port_id}
# only valid state after stop
rc = self.transmit("resume_traffic", params)
if rc.bad():
return self.err(rc.err())
self.state = self.STATE_TX
return self.ok()
@owned
def update (self, mul, force):
if (self.state == self.STATE_PCAP_TX) :
return self.err("update is not supported during PCAP TX")
if (self.state != self.STATE_TX) :
return self.err("port is not transmitting")
params = {"handler": self.handler,
"port_id": self.port_id,
"mul": mul,
"force": force}
rc = self.transmit("update_traffic", params)
if rc.bad():
return self.err(rc.err())
# save this for TUI
self.last_factor_type = mul['type']
return self.ok()
@owned
def validate (self):
if (self.state == self.STATE_IDLE):
return self.err("no streams attached to port")
params = {"handler": self.handler,
"port_id": self.port_id}
rc = self.transmit("validate", params)
if rc.bad():
return self.err(rc.err())
self.profile = rc.data()
return self.ok()
@owned
def set_attr (self, attr_dict):
params = {"handler": self.handler,
"port_id": self.port_id,
"attr": attr_dict}
rc = self.transmit("set_port_attr", params)
if rc.bad():
return self.err(rc.err())
#self.attr.update(attr_dict)
return self.ok()
@writeable
def push_remote (self, pcap_filename, ipg_usec, speedup, count, duration, is_dual, slave_handler):
params = {"handler": self.handler,
"port_id": self.port_id,
"pcap_filename": pcap_filename,
"ipg_usec": ipg_usec if ipg_usec is not None else -1,
"speedup": speedup,
"count": count,
"duration": duration,
"is_dual": is_dual,
"slave_handler": slave_handler}
rc = self.transmit("push_remote", params)
if rc.bad():
return self.err(rc.err())
self.state = self.STATE_PCAP_TX
return self.ok()
def get_profile (self):
return self.profile
def print_profile (self, mult, duration):
if not self.get_profile():
return
rate = self.get_profile()['rate']
graph = self.get_profile()['graph']
print(format_text("Profile Map Per Port\n", 'underline', 'bold'))
factor = mult_to_factor(mult, rate['max_bps_l2'], rate['max_pps'], rate['max_line_util'])
print("Profile max BPS L2 (base / req): {:^12} / {:^12}".format(format_num(rate['max_bps_l2'], suffix = "bps"),
format_num(rate['max_bps_l2'] * factor, suffix = "bps")))
print("Profile max BPS L1 (base / req): {:^12} / {:^12}".format(format_num(rate['max_bps_l1'], suffix = "bps"),
format_num(rate['max_bps_l1'] * factor, suffix = "bps")))
print("Profile max PPS (base / req): {:^12} / {:^12}".format(format_num(rate['max_pps'], suffix = "pps"),
format_num(rate['max_pps'] * factor, suffix = "pps"),))
print("Profile line util. (base / req): {:^12} / {:^12}".format(format_percentage(rate['max_line_util']),
format_percentage(rate['max_line_util'] * factor)))
# duration
exp_time_base_sec = graph['expected_duration'] / (1000 * 1000)
exp_time_factor_sec = exp_time_base_sec / factor
# user configured a duration
if duration > 0:
if exp_time_factor_sec > 0:
exp_time_factor_sec = min(exp_time_factor_sec, duration)
else:
exp_time_factor_sec = duration
print("Duration (base / req): {:^12} / {:^12}".format(format_time(exp_time_base_sec),
format_time(exp_time_factor_sec)))
print("\n")
# generate port info
def get_info (self):
info = dict(self.info)
info['status'] = self.get_port_state_name()
if 'link' in self.attr:
info['link'] = 'UP' if self.attr['link']['up'] else 'DOWN'
else:
info['link'] = 'N/A'
if 'fc' in self.attr:
info['fc'] = FLOW_CTRL_DICT_REVERSED.get(self.attr['fc']['mode'], 'N/A')
else:
info['fc'] = 'N/A'
if 'promiscuous' in self.attr:
info['prom'] = "on" if self.attr['promiscuous']['enabled'] else "off"
else:
info['prom'] = "N/A"
if 'description' in info:
if len(info['description']) > 18:
info['description'] = info['description'][:18]
else:
info['description'] = "N/A"
if 'is_fc_supported' in info:
info['fc_supported'] = 'yes' if info['is_fc_supported'] else 'no'
else:
info['fc_supported'] = 'N/A'
if 'is_led_supported' in info:
info['led_change_supported'] = 'yes' if info['is_led_supported'] else 'no'
else:
info['led_change_supported'] = 'N/A'
if 'is_link_supported' in info:
info['link_change_supported'] = 'yes' if info['is_link_supported'] else 'no'
else:
info['link_change_supported'] = 'N/A'
if 'is_virtual' in info:
info['is_virtual'] = 'yes' if info['is_virtual'] else 'no'
else:
info['is_virtual'] = 'N/A'
return info
def get_port_state_name(self):
return self.STATES_MAP.get(self.state, "Unknown")
################# stats handler ######################
def generate_port_stats(self):
return self.port_stats.generate_stats()
def generate_port_status(self):
info = self.get_info()
return {"driver": info['driver'],
"description": info.get('description', 'N/A'),
"HW src mac": info['hw_macaddr'],
"SW src mac": info['src_macaddr'],
"SW dst mac": info['dst_macaddr'],
"PCI Address": info['pci_addr'],
"NUMA Node": info['numa'],
"--": "",
"---": "",
"link speed": "{speed} Gb/s".format(speed=info['speed']),
"status": '%s (link %s)' % (info['status'], info['link']),
"promiscuous" : info['prom'],
"flow ctrl" : info['fc'],
}
def clear_stats(self):
return self.port_stats.clear_stats()
def get_stats (self):
return self.port_stats.get_stats()
def invalidate_stats(self):
return self.port_stats.invalidate()
################# stream printout ######################
def generate_loaded_streams_sum(self):
if self.state == self.STATE_DOWN:
return {}
data = {}
for id, obj in self.streams.items():
# lazy build scapy repr.
if not 'pkt_type' in obj:
obj['pkt_type'] = STLPktBuilder.pkt_layers_desc_from_buffer(obj['pkt'])
data[id] = OrderedDict([ ('id', id),
('packet_type', obj['pkt_type']),
('L2 len', len(obj['pkt']) + 4),
('mode', obj['mode']),
('rate', obj['rate']),
('next_stream', obj['next_id'] if not '-1' else 'None')
])
return {"streams" : OrderedDict(sorted(data.items())) }
################# events handler ######################
def async_event_port_job_done (self):
# until thread is locked - order is important
self.tx_stopped_ts = datetime.now()
self.state = self.STATE_STREAMS
self.last_factor_type = None
def async_event_port_attr_changed (self, attr):
self.info['speed'] = attr['speed'] // 1000
self.attr = attr
# rest of the events are used for TUI / read only sessions
def async_event_port_stopped (self):
if not self.is_acquired():
self.state = self.STATE_STREAMS
def async_event_port_paused (self):
if not self.is_acquired():
self.state = self.STATE_PAUSE
def async_event_port_started (self):
if not self.is_acquired():
self.state = self.STATE_TX
def async_event_port_resumed (self):
if not self.is_acquired():
self.state = self.STATE_TX
def async_event_acquired (self, who):
self.handler = None
self.owner = who
def async_event_released (self):
self.owner = ''
|