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
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
|
#!/router/bin/python
try:
# support import for Python 2
import outer_packages
except ImportError:
# support import for Python 3
import client.outer_packages
from client_utils.jsonrpc_client import JsonRpcClient, BatchMessage
from client_utils.packet_builder import CTRexPktBuilder
import json
from common.trex_stats import *
from common.trex_streams import *
from collections import namedtuple
from common.text_opts import *
import parsing_opts
import time
import datetime
from trex_async_client import CTRexAsyncClient
RpcCmdData = namedtuple('RpcCmdData', ['method', 'params'])
class RpcResponseStatus(namedtuple('RpcResponseStatus', ['success', 'id', 'msg'])):
__slots__ = ()
def __str__(self):
return "{id:^3} - {msg} ({stat})".format(id=self.id,
msg=self.msg,
stat="success" if self.success else "fail")
# simple class to represent complex return value
class RC:
def __init__ (self, rc = None, data = None):
self.rc_list = []
if (rc != None) and (data != None):
tuple_rc = namedtuple('RC', ['rc', 'data'])
self.rc_list.append(tuple_rc(rc, data))
def add (self, rc):
self.rc_list += rc.rc_list
def good (self):
return all([x.rc for x in self.rc_list])
def bad (self):
return not self.good()
def data (self):
return [x.data if x.rc else "" for x in self.rc_list]
def err (self):
return [x.data if not x.rc else "" for x in self.rc_list]
def annotate (self, desc = None):
if desc:
print format_text('\n{:<60}'.format(desc), 'bold'),
if self.bad():
# print all the errors
print ""
for x in self.rc_list:
if not x.rc:
print format_text("\n{0}".format(x.data), 'bold')
print ""
print format_text("[FAILED]\n", 'red', 'bold')
else:
print format_text("[SUCCESS]\n", 'green', 'bold')
def RC_OK(data = None):
return RC(True, data)
def RC_ERR (err):
return RC(False, err)
LoadedStreamList = namedtuple('LoadedStreamList', ['loaded', 'compiled'])
# describes a stream DB
class CStreamsDB(object):
def __init__(self):
self.stream_packs = {}
def load_yaml_file (self, filename):
stream_pack_name = filename
if stream_pack_name in self.get_loaded_streams_names():
self.remove_stream_packs(stream_pack_name)
stream_list = CStreamList()
loaded_obj = stream_list.load_yaml(filename)
try:
compiled_streams = stream_list.compile_streams()
rc = self.load_streams(stream_pack_name,
LoadedStreamList(loaded_obj,
[StreamPack(v.stream_id, v.stream.dump())
for k, v in compiled_streams.items()]))
except Exception as e:
return None
return self.get_stream_pack(stream_pack_name)
def load_streams(self, name, LoadedStreamList_obj):
if name in self.stream_packs:
return False
else:
self.stream_packs[name] = LoadedStreamList_obj
return True
def remove_stream_packs(self, *names):
removed_streams = []
for name in names:
removed = self.stream_packs.pop(name)
if removed:
removed_streams.append(name)
return removed_streams
def clear(self):
self.stream_packs.clear()
def get_loaded_streams_names(self):
return self.stream_packs.keys()
def stream_pack_exists (self, name):
return name in self.get_loaded_streams_names()
def get_stream_pack(self, name):
if not self.stream_pack_exists(name):
return None
else:
return self.stream_packs.get(name)
# describes a single port
class Port(object):
STATE_DOWN = 0
STATE_IDLE = 1
STATE_STREAMS = 2
STATE_TX = 3
STATE_PAUSE = 4
def __init__ (self, port_id, speed, driver, user, comm_link):
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.driver = driver
self.speed = speed
self.streams = {}
self.profile = None
def err(self, msg):
return RC_ERR("port {0} : {1}".format(self.port_id, msg))
def ok(self, data = None):
return RC_OK(data)
def get_speed_bps (self):
return (self.speed * 1000 * 1000 * 1000)
# take the port
def acquire(self, force = False):
params = {"port_id": self.port_id,
"user": self.user,
"force": force}
command = RpcCmdData("acquire", params)
rc = self.transmit(command.method, command.params)
if rc.success:
self.handler = rc.data
return self.ok()
else:
return self.err(rc.data)
# release the port
def release(self):
params = {"port_id": self.port_id,
"handler": self.handler}
command = RpcCmdData("release", params)
rc = self.transmit(command.method, command.params)
if rc.success:
self.handler = rc.data
return self.ok()
else:
return self.err(rc.data)
def is_acquired(self):
return (self.handler != None)
def is_active(self):
return(self.state == self.STATE_TX ) or (self.state == self.STATE_PAUSE)
def sync(self, sync_data):
self.handler = sync_data['handler']
port_state = sync_data['state'].upper()
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
else:
raise Exception("port {0}: bad state received from server '{1}'".format(self.port_id, sync_data['state']))
return self.ok()
# return TRUE if write commands
def is_port_writable (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))
# add stream to the port
def add_stream (self, stream_id, stream_obj):
if not self.is_port_writable():
return self.err("Please stop port before attempting to add streams")
params = {"handler": self.handler,
"port_id": self.port_id,
"stream_id": stream_id,
"stream": stream_obj}
rc, data = self.transmit("add_stream", params)
if not rc:
r = self.err(data)
print r.good()
# add the stream
self.streams[stream_id] = stream_obj
# the only valid state now
self.state = self.STATE_STREAMS
return self.ok()
# add multiple streams
def add_streams (self, streams_list):
batch = []
for stream in streams_list:
params = {"handler": self.handler,
"port_id": self.port_id,
"stream_id": stream.stream_id,
"stream": stream.stream}
cmd = RpcCmdData('add_stream', params)
batch.append(cmd)
rc, data = self.transmit_batch(batch)
if not rc:
return self.err(data)
# add the stream
for stream in streams_list:
self.streams[stream.stream_id] = stream.stream
# the only valid state now
self.state = self.STATE_STREAMS
return self.ok()
# remove stream from port
def remove_stream (self, stream_id):
if not stream_id in self.streams:
return self.err("stream {0} does not exists".format(stream_id))
params = {"handler": self.handler,
"port_id": self.port_id,
"stream_id": stream_id}
rc, data = self.transmit("remove_stream", params)
if not rc:
return self.err(data)
self.streams[stream_id] = None
return self.ok()
# remove all the streams
def remove_all_streams (self):
params = {"handler": self.handler,
"port_id": self.port_id}
rc, data = self.transmit("remove_all_streams", params)
if not rc:
return self.err(data)
self.streams = {}
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
# start traffic
def start (self, mul, duration):
if self.state == self.STATE_DOWN:
return self.err("Unable to start traffic - port is down")
if self.state == self.STATE_IDLE:
return self.err("Unable to start traffic - no streams attached to port")
if self.state == self.STATE_TX:
return self.err("Unable to start traffic - port is already transmitting")
params = {"handler": self.handler,
"port_id": self.port_id,
"mul": mul,
"duration": duration}
rc, data = self.transmit("start_traffic", params)
if not rc:
return self.err(data)
self.state = self.STATE_TX
return self.ok()
# stop traffic
# with force ignores the cached state and sends the command
def stop (self, force = False):
if (not force) and (self.state != self.STATE_TX) and (self.state != self.STATE_PAUSE):
return self.err("port is not transmitting")
params = {"handler": self.handler,
"port_id": self.port_id}
rc, data = self.transmit("stop_traffic", params)
if not rc:
return self.err(data)
# only valid state after stop
self.state = self.STATE_STREAMS
return self.ok()
def pause (self):
if (self.state != self.STATE_TX) :
return self.err("port is not transmitting")
params = {"handler": self.handler,
"port_id": self.port_id}
rc, data = self.transmit("pause_traffic", params)
if not rc:
return self.err(data)
# only valid state after stop
self.state = self.STATE_PAUSE
return self.ok()
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}
rc, data = self.transmit("resume_traffic", params)
if not rc:
return self.err(data)
# only valid state after stop
self.state = self.STATE_TX
return self.ok()
def update (self, mul):
if (self.state != self.STATE_TX) :
return self.err("port is not transmitting")
params = {"handler": self.handler,
"port_id": self.port_id,
"mul": mul}
rc, data = self.transmit("update_traffic", params)
if not rc:
return self.err(data)
return self.ok()
def validate (self):
if (self.state == self.STATE_DOWN):
return self.err("port is down")
if (self.state == self.STATE_IDLE):
return self.err("no streams attached to port")
params = {"handler": self.handler,
"port_id": self.port_id}
rc, data = self.transmit("validate", params)
if not rc:
return self.err(data)
self.profile = data
return self.ok()
def get_profile (self):
return self.profile
################# events handler ######################
def async_event_port_stopped (self):
self.state = self.STATE_STREAMS
class CTRexStatelessClient(object):
"""docstring for CTRexStatelessClient"""
def __init__(self, username, server="localhost", sync_port = 5050, async_port = 4500, virtual=False):
super(CTRexStatelessClient, self).__init__()
self.user = username
self.comm_link = CTRexStatelessClient.CCommLink(server, sync_port, virtual)
self.verbose = False
self.ports = []
self._conn_handler = {}
self._active_ports = set()
self._system_info = None
self._server_version = None
self.__err_log = None
self.async_client = CTRexAsyncClient(server, async_port, self)
self.streams_db = CStreamsDB()
self.events = []
self.connected = False
################# events handler ######################
def add_event_log (self, msg, ev_type, show = False):
if ev_type == "server":
prefix = "[server]"
elif ev_type == "local":
prefix = "[local]"
ts = time.time()
st = datetime.datetime.fromtimestamp(ts).strftime('%Y-%m-%d %H:%M:%S')
self.events.append("{:<10} - {:^8} - {:}".format(st, prefix, format_text(msg, 'bold')))
if show:
print format_text("\n{:^8} - {:}".format(prefix, format_text(msg, 'bold')))
def handle_async_event (self, type, data):
# DP stopped
show_event = False
# port started
if (type == 0):
port_id = int(data['port_id'])
ev = "Port {0} has started".format(port_id)
# port stopped
elif (type == 1):
port_id = int(data['port_id'])
ev = "Port {0} has stopped".format(port_id)
# call the handler
self.async_event_port_stopped(port_id)
# server stopped
elif (type == 2):
ev = "Server has stopped"
self.async_event_server_stopped()
show_event = True
# port finished traffic
elif (type == 3):
port_id = int(data['port_id'])
ev = "Port {0} job done".format(port_id)
# call the handler
self.async_event_port_stopped(port_id)
show_event = True
else:
# unknown event - ignore
return
self.add_event_log(ev, 'server', show_event)
def async_event_port_stopped (self, port_id):
self.ports[port_id].async_event_port_stopped()
def async_event_server_stopped (self):
self.connected = False
def get_events (self):
return self.events
def clear_events (self):
self.events = []
############# helper functions section ##############
# measure time for functions
def timing(f):
def wrap(*args):
time1 = time.time()
ret = f(*args)
# don't want to print on error
if ret.bad():
return ret
delta = time.time() - time1
for unit in ['sec','ms','usec']:
if delta > 1.0:
print '{:,.2f} [{:}]\n'.format(delta, unit)
break
delta *= 1000.0
return ret
return wrap
def validate_port_list(self, port_id_list):
if not isinstance(port_id_list, list):
print type(port_id_list)
return False
# check each item of the sequence
return all([ (port_id >= 0) and (port_id < self.get_port_count())
for port_id in port_id_list ])
# some preprocessing for port argument
def __ports (self, port_id_list):
# none means all
if port_id_list == None:
return range(0, self.get_port_count())
# always list
if isinstance(port_id_list, int):
port_id_list = [port_id_list]
if not isinstance(port_id_list, list):
raise ValueError("bad port id list: {0}".format(port_id_list))
for port_id in port_id_list:
if not isinstance(port_id, int) or (port_id < 0) or (port_id > self.get_port_count()):
raise ValueError("bad port id {0}".format(port_id))
return port_id_list
############ boot up section ################
# connection sequence
def connect(self):
# clear this flag
self.connected = False
# connect sync channel
rc, data = self.comm_link.connect()
if not rc:
return RC_ERR(data)
# connect async channel
rc, data = self.async_client.connect()
if not rc:
return RC_ERR(data)
# version
rc, data = self.transmit("get_version")
if not rc:
return RC_ERR(data)
self.server_version = data
# cache system info
rc, data = self.transmit("get_system_info")
if not rc:
return RC_ERR(data)
self.system_info = data
# cache supported commands
rc, data = self.transmit("get_supported_cmds")
if not rc:
return RC_ERR(data)
self.supported_cmds = data
# create ports
for port_id in xrange(self.get_port_count()):
speed = self.system_info['ports'][port_id]['speed']
driver = self.system_info['ports'][port_id]['driver']
self.ports.append(Port(port_id, speed, driver, self.user, self.comm_link))
# acquire all ports
rc = self.acquire()
if rc.bad():
return rc
rc = self.sync_with_server()
if rc.bad():
return rc
self.connected = True
return RC_OK()
def is_connected (self):
return self.connected and self.comm_link.is_connected
def disconnect(self):
self.comm_link.disconnect()
self.async_client.disconnect()
return RC_OK()
def on_async_dead (self):
if self.connected:
msg = 'lost connection to server'
self.add_event_log(msg, 'local', True)
self.connected = False
def on_async_alive (self):
pass
########### cached queries (no server traffic) ###########
def get_supported_cmds(self):
return self.supported_cmds
def get_version(self):
return self.server_version
def get_system_info(self):
return self.system_info
def get_port_count(self):
return self.system_info.get("port_count")
def get_port_ids(self, as_str=False):
port_ids = range(self.get_port_count())
if as_str:
return " ".join(str(p) for p in port_ids)
else:
return port_ids
def get_stats_async (self):
return self.async_client.get_stats()
def get_connection_port (self):
return self.comm_link.port
def get_connection_ip (self):
return self.comm_link.server
def get_acquired_ports(self):
return [port.port_id for port in self.ports if port.is_acquired()]
def get_active_ports(self):
return [port.port_id for port in self.ports if port.is_active()]
def set_verbose(self, mode):
self.comm_link.set_verbose(mode)
self.verbose = mode
############# server actions ################
# ping server
def ping(self):
rc, info = self.transmit("ping")
return RC(rc, info)
def sync_with_server(self, sync_streams=False):
rc, data = self.transmit("sync_user", {"user": self.user, "sync_streams": sync_streams})
if not rc:
return RC_ERR(data)
for port_info in data:
rc = self.ports[port_info['port_id']].sync(port_info)
if rc.bad():
return rc
return RC_OK()
########## port commands ##############
# acquire ports, if port_list is none - get all
def acquire (self, port_id_list = None, force = False):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].acquire(force))
return rc
# release ports
def release (self, port_id_list = None):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].release(force))
return rc
def add_stream(self, stream_id, stream_obj, port_id_list = None):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].add_stream(stream_id, stream_obj))
return rc
def add_stream_pack(self, stream_pack_list, port_id_list = None):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].add_streams(stream_pack_list))
return rc
def remove_stream(self, stream_id, port_id_list = None):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].remove_stream(stream_id))
return rc
def remove_all_streams(self, port_id_list = None):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].remove_all_streams())
return rc
def get_stream(self, stream_id, port_id, get_pkt = False):
return self.ports[port_id].get_stream(stream_id)
def get_all_streams(self, port_id, get_pkt = False):
return self.ports[port_id].get_all_streams()
def get_stream_id_list(self, port_id):
return self.ports[port_id].get_stream_id_list()
def start_traffic (self, multiplier, duration, port_id_list = None):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].start(multiplier, duration))
return rc
def resume_traffic (self, port_id_list = None, force = False):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].resume())
return rc
def pause_traffic (self, port_id_list = None, force = False):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].pause())
return rc
def stop_traffic (self, port_id_list = None, force = False):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].stop(force))
return rc
def update_traffic (self, mult, port_id_list = None, force = False):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].update(mult))
return rc
def validate (self, port_id_list = None):
port_id_list = self.__ports(port_id_list)
rc = RC()
for port_id in port_id_list:
rc.add(self.ports[port_id].validate())
return rc
def get_port_stats(self, port_id=None):
pass
def get_stream_stats(self, port_id=None):
pass
def transmit(self, method_name, params={}):
return self.comm_link.transmit(method_name, params)
def transmit_batch(self, batch_list):
return self.comm_link.transmit_batch(batch_list)
######################### Console (high level) API #########################
@timing
def cmd_ping(self):
rc = self.ping()
rc.annotate("Pinging the server on '{0}' port '{1}': ".format(self.get_connection_ip(), self.get_connection_port()))
return rc
def cmd_connect(self):
rc = self.connect()
rc.annotate()
return rc
def cmd_disconnect(self):
rc = self.disconnect()
rc.annotate()
return rc
# reset
def cmd_reset(self):
# sync with the server
rc = self.sync_with_server()
rc.annotate("Syncing with the server:")
if rc.bad():
return rc
rc = self.acquire(force = True)
rc.annotate("Force acquiring all ports:")
if rc.bad():
return rc
# force stop all ports
rc = self.stop_traffic(self.get_port_ids(), True)
rc.annotate("Stop traffic on all ports:")
if rc.bad():
return rc
# remove all streams
rc = self.remove_all_streams(self.get_port_ids())
rc.annotate("Removing all streams from all ports:")
if rc.bad():
return rc
# TODO: clear stats
return RC_OK()
# stop cmd
def cmd_stop (self, port_id_list):
# find the relveant ports
active_ports = list(set(self.get_active_ports()).intersection(port_id_list))
if not active_ports:
msg = "No active traffic on provided ports"
print format_text(msg, 'bold')
return RC_ERR(msg)
rc = self.stop_traffic(active_ports)
rc.annotate("Stopping traffic on port(s) {0}:".format(port_id_list))
if rc.bad():
return rc
return RC_OK()
# update cmd
def cmd_update (self, port_id_list, mult):
# find the relveant ports
active_ports = list(set(self.get_active_ports()).intersection(port_id_list))
if not active_ports:
msg = "No active traffic on porvided ports"
print format_text(msg, 'bold')
return RC_ERR(msg)
rc = self.update_traffic(mult, active_ports)
rc.annotate("Updating traffic on port(s) {0}:".format(port_id_list))
return rc
# pause cmd
def cmd_pause (self, port_id_list):
# find the relveant ports
active_ports = list(set(self.get_active_ports()).intersection(port_id_list))
if not active_ports:
msg = "No active traffic on porvided ports"
print format_text(msg, 'bold')
return RC_ERR(msg)
rc = self.pause_traffic(active_ports)
rc.annotate("Pausing traffic on port(s) {0}:".format(port_id_list))
return rc
# resume cmd
def cmd_resume (self, port_id_list):
# find the relveant ports
active_ports = list(set(self.get_active_ports()).intersection(port_id_list))
if not active_ports:
msg = "No active traffic on porvided ports"
print format_text(msg, 'bold')
return RC_ERR(msg)
rc = self.resume_traffic(active_ports)
rc.annotate("Resume traffic on port(s) {0}:".format(port_id_list))
return rc
# start cmd
def cmd_start (self, port_id_list, stream_list, mult, force, duration):
active_ports = list(set(self.get_active_ports()).intersection(port_id_list))
if active_ports:
if not force:
msg = "Port(s) {0} are active - please stop them or add '--force'".format(active_ports)
print format_text(msg, 'bold')
return RC_ERR(msg)
else:
rc = self.cmd_stop(active_ports)
if not rc:
return rc
rc = self.remove_all_streams(port_id_list)
rc.annotate("Removing all streams from port(s) {0}:".format(port_id_list))
if rc.bad():
return rc
rc = self.add_stream_pack(stream_list.compiled, port_id_list)
rc.annotate("Attaching {0} streams to port(s) {1}:".format(len(stream_list.compiled), port_id_list))
if rc.bad():
return rc
# finally, start the traffic
rc = self.start_traffic(mult, duration, port_id_list)
rc.annotate("Starting traffic on port(s) {0}:".format(port_id_list))
return rc
def cmd_validate (self, port_id_list):
rc = self.validate(port_id_list)
rc.annotate("Validating streams on port(s) {0}:".format(port_id_list))
return rc
############## High Level API With Parser ################
@timing
def cmd_start_line (self, line):
'''Start selected traffic in specified ports on TRex\n'''
# define a parser
parser = parsing_opts.gen_parser(self,
"start",
self.cmd_start_line.__doc__,
parsing_opts.PORT_LIST_WITH_ALL,
parsing_opts.TOTAL,
parsing_opts.FORCE,
parsing_opts.STREAM_FROM_PATH_OR_FILE,
parsing_opts.DURATION,
parsing_opts.MULTIPLIER_STRICT)
opts = parser.parse_args(line.split())
if opts is None:
return RC_ERR("bad command line paramters")
if opts.db:
stream_list = self.stream_db.get_stream_pack(opts.db)
rc = RC(stream_list != None)
rc.annotate("Load stream pack (from DB):")
if rc.bad():
return RC_ERR("Failed to load stream pack")
else:
# load streams from file
stream_list = self.streams_db.load_yaml_file(opts.file[0])
rc = RC(stream_list != None)
rc.annotate("Load stream pack (from file):")
if stream_list == None:
return RC_ERR("Failed to load stream pack")
# total has no meaning with percentage - its linear
if opts.total and (opts.mult['type'] != 'percentage'):
# if total was set - divide it between the ports
opts.mult['value'] = opts.mult['value'] / len(opts.ports)
return self.cmd_start(opts.ports, stream_list, opts.mult, opts.force, opts.duration)
@timing
def cmd_stop_line (self, line):
'''Stop active traffic in specified ports on TRex\n'''
parser = parsing_opts.gen_parser(self,
"stop",
self.cmd_stop_line.__doc__,
parsing_opts.PORT_LIST_WITH_ALL)
opts = parser.parse_args(line.split())
if opts is None:
return RC_ERR("bad command line paramters")
return self.cmd_stop(opts.ports)
@timing
def cmd_update_line (self, line):
'''Update port(s) speed currently active\n'''
parser = parsing_opts.gen_parser(self,
"update",
self.cmd_update_line.__doc__,
parsing_opts.PORT_LIST_WITH_ALL,
parsing_opts.MULTIPLIER,
parsing_opts.TOTAL)
opts = parser.parse_args(line.split())
if opts is None:
return RC_ERR("bad command line paramters")
# total has no meaning with percentage - its linear
if opts.total and (opts.mult['type'] != 'percentage'):
# if total was set - divide it between the ports
opts.mult['value'] = opts.mult['value'] / len(opts.ports)
return self.cmd_update(opts.ports, opts.mult)
@timing
def cmd_reset_line (self, line):
return self.cmd_reset()
@timing
def cmd_pause_line (self, line):
'''Pause active traffic in specified ports on TRex\n'''
parser = parsing_opts.gen_parser(self,
"pause",
self.cmd_stop_line.__doc__,
parsing_opts.PORT_LIST_WITH_ALL)
opts = parser.parse_args(line.split())
if opts is None:
return RC_ERR("bad command line paramters")
return self.cmd_pause(opts.ports)
@timing
def cmd_resume_line (self, line):
'''Resume active traffic in specified ports on TRex\n'''
parser = parsing_opts.gen_parser(self,
"resume",
self.cmd_stop_line.__doc__,
parsing_opts.PORT_LIST_WITH_ALL)
opts = parser.parse_args(line.split())
if opts is None:
return RC_ERR("bad command line paramters")
return self.cmd_resume(opts.ports)
@timing
def cmd_validate_line (self, line):
'''validates port(s) stream configuration\n'''
parser = parsing_opts.gen_parser(self,
"validate",
self.cmd_validate_line.__doc__,
parsing_opts.PORT_LIST_WITH_ALL)
opts = parser.parse_args(line.split())
if opts is None:
return RC_ERR("bad command line paramters")
rc = self.cmd_validate(opts.ports)
if rc.bad():
return rc
# for each port - print the profile
port_id_list = self.__ports(opts.ports)
for port_id in port_id_list:
port = self.ports[port_id]
rate = port.get_profile()['rate']
print format_text("Port {0}:\n".format(port_id), 'underline', 'bold')
print "Profile max BPS (m = 1): {:>15}".format(format_num(rate['max_bps'], suffix = "bps"))
print "Profile max PPS (m = 1): {:>15}".format(format_num(rate['max_pps'], suffix = "pps"))
print "Profile line util. (m = 1): {:>15}".format(format_percentage(rate['max_line_util'] * 100))
print "\n"
return rc
def cmd_exit_line (self, line):
print format_text("Exiting\n", 'bold')
# a way to exit
return RC_ERR("exit")
def cmd_wait_line (self, line):
'''wait for a period of time\n'''
parser = parsing_opts.gen_parser(self,
"wait",
self.cmd_wait_line.__doc__,
parsing_opts.DURATION)
opts = parser.parse_args(line.split())
if opts is None:
return RC_ERR("bad command line paramters")
delay_sec = opts.duration if (opts.duration > 0) else 1
print format_text("Waiting for {0} seconds...\n".format(delay_sec), 'bold')
time.sleep(delay_sec)
return RC_OK()
# run a script of commands
def run_script_file (self, filename):
print format_text("\nRunning script file '{0}'...".format(filename), 'bold')
rc = self.cmd_connect()
if rc.bad():
return
with open(filename) as f:
script_lines = f.readlines()
cmd_table = {}
# register all the commands
cmd_table['start'] = self.cmd_start_line
cmd_table['stop'] = self.cmd_stop_line
cmd_table['reset'] = self.cmd_reset_line
cmd_table['wait'] = self.cmd_wait_line
cmd_table['exit'] = self.cmd_exit_line
for index, line in enumerate(script_lines, start = 1):
line = line.strip()
if line == "":
continue
if line.startswith("#"):
continue
sp = line.split(' ', 1)
cmd = sp[0]
if len(sp) == 2:
args = sp[1]
else:
args = ""
print format_text("Executing line {0} : '{1}'\n".format(index, line))
if not cmd in cmd_table:
print "\n*** Error at line {0} : '{1}'\n".format(index, line)
print format_text("unknown command '{0}'\n".format(cmd), 'bold')
return False
rc = cmd_table[cmd](args)
if rc.bad():
return False
print format_text("\n[Done]", 'bold')
return True
#################################
# ------ private classes ------ #
class CCommLink(object):
"""describes the connectivity of the stateless client method"""
def __init__(self, server="localhost", port=5050, virtual=False):
super(CTRexStatelessClient.CCommLink, self).__init__()
self.virtual = virtual
self.server = server
self.port = port
self.verbose = False
self.rpc_link = JsonRpcClient(self.server, self.port)
@property
def is_connected(self):
if not self.virtual:
return self.rpc_link.connected
else:
return True
def set_verbose(self, mode):
self.verbose = mode
return self.rpc_link.set_verbose(mode)
def connect(self):
if not self.virtual:
return self.rpc_link.connect()
def disconnect(self):
if not self.virtual:
return self.rpc_link.disconnect()
def transmit(self, method_name, params={}):
if self.virtual:
self._prompt_virtual_tx_msg()
_, msg = self.rpc_link.create_jsonrpc_v2(method_name, params)
print msg
return
else:
return self.rpc_link.invoke_rpc_method(method_name, params)
def transmit_batch(self, batch_list):
if self.virtual:
self._prompt_virtual_tx_msg()
print [msg
for _, msg in [self.rpc_link.create_jsonrpc_v2(command.method, command.params)
for command in batch_list]]
else:
batch = self.rpc_link.create_batch()
for command in batch_list:
batch.add(command.method, command.params)
# invoke the batch
return batch.invoke()
def _prompt_virtual_tx_msg(self):
print "Transmitting virtually over tcp://{server}:{port}".format(server=self.server,
port=self.port)
if __name__ == "__main__":
pass
|