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
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
|
# Copyright (c) 2020 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Interface util library."""
from time import sleep
from enum import IntEnum
from ipaddress import ip_address
from robot.api import logger
from resources.libraries.python.Constants import Constants
from resources.libraries.python.CpuUtils import CpuUtils
from resources.libraries.python.DUTSetup import DUTSetup
from resources.libraries.python.L2Util import L2Util
from resources.libraries.python.PapiExecutor import PapiSocketExecutor
from resources.libraries.python.parsers.JsonParser import JsonParser
from resources.libraries.python.ssh import SSH, exec_cmd_no_error
from resources.libraries.python.topology import NodeType, Topology
from resources.libraries.python.VPPUtil import VPPUtil
class InterfaceStatusFlags(IntEnum):
"""Interface status flags."""
IF_STATUS_API_FLAG_ADMIN_UP = 1
IF_STATUS_API_FLAG_LINK_UP = 2
class MtuProto(IntEnum):
"""MTU protocol."""
MTU_PROTO_API_L3 = 0
MTU_PROTO_API_IP4 = 1
MTU_PROTO_API_IP6 = 2
MTU_PROTO_API_MPLS = 3
MTU_PROTO_API_N = 4
class LinkDuplex(IntEnum):
"""Link duplex"""
LINK_DUPLEX_API_UNKNOWN = 0
LINK_DUPLEX_API_HALF = 1
LINK_DUPLEX_API_FULL = 2
class SubInterfaceFlags(IntEnum):
"""Sub-interface flags."""
SUB_IF_API_FLAG_NO_TAGS = 1
SUB_IF_API_FLAG_ONE_TAG = 2
SUB_IF_API_FLAG_TWO_TAGS = 4
SUB_IF_API_FLAG_DOT1AD = 8
SUB_IF_API_FLAG_EXACT_MATCH = 16
SUB_IF_API_FLAG_DEFAULT = 32
SUB_IF_API_FLAG_OUTER_VLAN_ID_ANY = 64
SUB_IF_API_FLAG_INNER_VLAN_ID_ANY = 128
SUB_IF_API_FLAG_DOT1AH = 256
class RxMode(IntEnum):
"""RX mode"""
RX_MODE_API_UNKNOWN = 0
RX_MODE_API_POLLING = 1
RX_MODE_API_INTERRUPT = 2
RX_MODE_API_ADAPTIVE = 3
RX_MODE_API_DEFAULT = 4
class IfType(IntEnum):
"""Interface type"""
# A hw interface
IF_API_TYPE_HARDWARE = 0
# A sub-interface
IF_API_TYPE_SUB = 1
IF_API_TYPE_P2P = 2
IF_API_TYPE_PIPE = 3
class LinkBondLoadBalanceAlgo(IntEnum):
"""Link bonding load balance algorithm."""
BOND_API_LB_ALGO_L2 = 0
BOND_API_LB_ALGO_L34 = 1
BOND_API_LB_ALGO_L23 = 2
BOND_API_LB_ALGO_RR = 3
BOND_API_LB_ALGO_BC = 4
BOND_API_LB_ALGO_AB = 5
class LinkBondMode(IntEnum):
"""Link bonding mode."""
BOND_API_MODE_ROUND_ROBIN = 1
BOND_API_MODE_ACTIVE_BACKUP = 2
BOND_API_MODE_XOR = 3
BOND_API_MODE_BROADCAST = 4
BOND_API_MODE_LACP = 5
class RdmaMode(IntEnum):
"""RDMA interface mode."""
RDMA_API_MODE_AUTO = 0
RDMA_API_MODE_IBV = 1
RDMA_API_MODE_DV = 2
class InterfaceUtil:
"""General utilities for managing interfaces"""
@staticmethod
def pci_to_int(pci_str):
"""Convert PCI address from string format (0000:18:0a.0) to
integer representation (169345024).
:param pci_str: PCI address in string representation.
:type pci_str: str
:returns: Integer representation of PCI address.
:rtype: int
"""
pci = list(pci_str.split(u":")[0:2])
pci.extend(pci_str.split(u":")[2].split(u"."))
return (int(pci[0], 16) | int(pci[1], 16) << 16 |
int(pci[2], 16) << 24 | int(pci[3], 16) << 29)
@staticmethod
def pci_to_eth(node, pci_str):
"""Convert PCI address on DUT to Linux ethernet name.
:param node: DUT node
:param pci_str: PCI address.
:type node: dict
:type pci_str: str
:returns: Ethernet name.
:rtype: str
"""
cmd = f"basename /sys/bus/pci/devices/{pci_str}/net/*"
try:
stdout, _ = exec_cmd_no_error(node, cmd)
except RuntimeError:
raise RuntimeError(f"Cannot convert {pci_str} to ethernet name!")
return stdout.strip()
@staticmethod
def get_interface_index(node, interface):
"""Get interface sw_if_index from topology file.
:param node: Node where the interface is.
:param interface: Numeric index or name string of a specific interface.
:type node: dict
:type interface: str or int
:returns: SW interface index.
:rtype: int
"""
try:
sw_if_index = int(interface)
except ValueError:
sw_if_index = Topology.get_interface_sw_index(node, interface)
if sw_if_index is None:
sw_if_index = \
Topology.get_interface_sw_index_by_name(node, interface)
except TypeError as err:
raise TypeError(f"Wrong interface format {interface}") from err
return sw_if_index
@staticmethod
def set_interface_state(node, interface, state, if_type=u"key"):
"""Set interface state on a node.
Function can be used for DUTs as well as for TGs.
:param node: Node where the interface is.
:param interface: Interface key or sw_if_index or name.
:param state: One of 'up' or 'down'.
:param if_type: Interface type
:type node: dict
:type interface: str or int
:type state: str
:type if_type: str
:returns: Nothing.
:raises ValueError: If the interface type is unknown.
:raises ValueError: If the state of interface is unexpected.
:raises ValueError: If the node has an unknown node type.
"""
if if_type == u"key":
if isinstance(interface, str):
sw_if_index = Topology.get_interface_sw_index(node, interface)
iface_name = Topology.get_interface_name(node, interface)
else:
sw_if_index = interface
elif if_type == u"name":
iface_key = Topology.get_interface_by_name(node, interface)
if iface_key is not None:
sw_if_index = Topology.get_interface_sw_index(node, iface_key)
iface_name = interface
else:
raise ValueError(f"Unknown if_type: {if_type}")
if node[u"type"] == NodeType.DUT:
if state == u"up":
flags = InterfaceStatusFlags.IF_STATUS_API_FLAG_ADMIN_UP.value
elif state == u"down":
flags = 0
else:
raise ValueError(f"Unexpected interface state: {state}")
cmd = u"sw_interface_set_flags"
err_msg = f"Failed to set interface state on host {node[u'host']}"
args = dict(
sw_if_index=int(sw_if_index),
flags=flags
)
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_reply(err_msg)
elif node[u"type"] == NodeType.TG or node[u"type"] == NodeType.VM:
cmd = f"ip link set {iface_name} {state}"
exec_cmd_no_error(node, cmd, sudo=True)
else:
raise ValueError(
f"Node {node[u'host']} has unknown NodeType: {node[u'type']}"
)
@staticmethod
def set_interface_ethernet_mtu(node, iface_key, mtu):
"""Set Ethernet MTU for specified interface.
Function can be used only for TGs.
:param node: Node where the interface is.
:param iface_key: Interface key from topology file.
:param mtu: MTU to set.
:type node: dict
:type iface_key: str
:type mtu: int
:returns: Nothing.
:raises ValueError: If the node type is "DUT".
:raises ValueError: If the node has an unknown node type.
"""
if node[u"type"] == NodeType.DUT:
msg = f"Node {node[u'host']}: Setting Ethernet MTU for interface " \
f"on DUT nodes not supported"
elif node[u"type"] != NodeType.TG:
msg = f"Node {node[u'host']} has unknown NodeType: {node[u'type']}"
else:
iface_name = Topology.get_interface_name(node, iface_key)
cmd = f"ip link set {iface_name} mtu {mtu}"
exec_cmd_no_error(node, cmd, sudo=True)
return
raise ValueError(msg)
@staticmethod
def set_default_ethernet_mtu_on_all_interfaces_on_node(node):
"""Set default Ethernet MTU on all interfaces on node.
Function can be used only for TGs.
:param node: Node where to set default MTU.
:type node: dict
:returns: Nothing.
"""
for ifc in node[u"interfaces"]:
InterfaceUtil.set_interface_ethernet_mtu(node, ifc, 1500)
@staticmethod
def vpp_set_interface_mtu(node, interface, mtu=9200):
"""Set Ethernet MTU on interface.
:param node: VPP node.
:param interface: Interface to setup MTU. Default: 9200.
:param mtu: Ethernet MTU size in Bytes.
:type node: dict
:type interface: str or int
:type mtu: int
"""
if isinstance(interface, str):
sw_if_index = Topology.get_interface_sw_index(node, interface)
else:
sw_if_index = interface
cmd = u"hw_interface_set_mtu"
err_msg = f"Failed to set interface MTU on host {node[u'host']}"
args = dict(
sw_if_index=sw_if_index,
mtu=int(mtu)
)
try:
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_reply(err_msg)
except AssertionError as err:
# TODO: Make failure tolerance optional.
logger.debug(f"Setting MTU failed. Expected?\n{err}")
@staticmethod
def vpp_set_interfaces_mtu_on_node(node, mtu=9200):
"""Set Ethernet MTU on all interfaces.
:param node: VPP node.
:param mtu: Ethernet MTU size in Bytes. Default: 9200.
:type node: dict
:type mtu: int
"""
for interface in node[u"interfaces"]:
InterfaceUtil.vpp_set_interface_mtu(node, interface, mtu)
@staticmethod
def vpp_set_interfaces_mtu_on_all_duts(nodes, mtu=9200):
"""Set Ethernet MTU on all interfaces on all DUTs.
:param nodes: VPP nodes.
:param mtu: Ethernet MTU size in Bytes. Default: 9200.
:type nodes: dict
:type mtu: int
"""
for node in nodes.values():
if node[u"type"] == NodeType.DUT:
InterfaceUtil.vpp_set_interfaces_mtu_on_node(node, mtu)
@staticmethod
def vpp_node_interfaces_ready_wait(node, retries=15):
"""Wait until all interfaces with admin-up are in link-up state.
:param node: Node to wait on.
:param retries: Number of retries to check interface status (optional,
default 15).
:type node: dict
:type retries: int
:returns: Nothing.
:raises RuntimeError: If any interface is not in link-up state after
defined number of retries.
"""
for _ in range(0, retries):
not_ready = list()
out = InterfaceUtil.vpp_get_interface_data(node)
for interface in out:
if interface.get(u"flags") == 1:
not_ready.append(interface.get(u"interface_name"))
if not_ready:
logger.debug(
f"Interfaces still not in link-up state:\n{not_ready}"
)
sleep(1)
else:
break
else:
err = f"Timeout, interfaces not up:\n{not_ready}" \
if u"not_ready" in locals() else u"No check executed!"
raise RuntimeError(err)
@staticmethod
def all_vpp_interfaces_ready_wait(nodes, retries=15):
"""Wait until all interfaces with admin-up are in link-up state for all
nodes in the topology.
:param nodes: Nodes in the topology.
:param retries: Number of retries to check interface status (optional,
default 15).
:type nodes: dict
:type retries: int
:returns: Nothing.
"""
for node in nodes.values():
if node[u"type"] == NodeType.DUT:
InterfaceUtil.vpp_node_interfaces_ready_wait(node, retries)
@staticmethod
def vpp_get_interface_data(node, interface=None):
"""Get all interface data from a VPP node. If a name or
sw_interface_index is provided, return only data for the matching
interface(s).
:param node: VPP node to get interface data from.
:param interface: Numeric index or name string of a specific interface.
:type node: dict
:type interface: int or str
:returns: List of dictionaries containing data for each interface, or a
single dictionary for the specified interface.
:rtype: list or dict
:raises TypeError: if the data type of interface is neither basestring
nor int.
"""
def process_if_dump(if_dump):
"""Process interface dump.
:param if_dump: Interface dump.
:type if_dump: dict
:returns: Processed interface dump.
:rtype: dict
"""
if_dump[u"l2_address"] = str(if_dump[u"l2_address"])
if_dump[u"b_dmac"] = str(if_dump[u"b_dmac"])
if_dump[u"b_smac"] = str(if_dump[u"b_smac"])
if_dump[u"flags"] = if_dump[u"flags"].value
if_dump[u"type"] = if_dump[u"type"].value
if_dump[u"link_duplex"] = if_dump[u"link_duplex"].value
if_dump[u"sub_if_flags"] = if_dump[u"sub_if_flags"].value \
if hasattr(if_dump[u"sub_if_flags"], u"value") \
else int(if_dump[u"sub_if_flags"])
return if_dump
if interface is not None:
if isinstance(interface, str):
param = u"interface_name"
elif isinstance(interface, int):
param = u"sw_if_index"
else:
raise TypeError(f"Wrong interface format {interface}")
else:
param = u""
cmd = u"sw_interface_dump"
args = dict(
name_filter_valid=False,
name_filter=u""
)
err_msg = f"Failed to get interface dump on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
details = papi_exec.add(cmd, **args).get_details(err_msg)
logger.debug(f"Received data:\n{details!r}")
data = list() if interface is None else dict()
for dump in details:
if interface is None:
data.append(process_if_dump(dump))
elif str(dump.get(param)).rstrip(u"\x00") == str(interface):
data = process_if_dump(dump)
break
logger.debug(f"Interface data:\n{data}")
return data
@staticmethod
def vpp_get_interface_name(node, sw_if_index):
"""Get interface name for the given SW interface index from actual
interface dump.
:param node: VPP node to get interface data from.
:param sw_if_index: SW interface index of the specific interface.
:type node: dict
:type sw_if_index: int
:returns: Name of the given interface.
:rtype: str
"""
if_data = InterfaceUtil.vpp_get_interface_data(node, sw_if_index)
if if_data[u"sup_sw_if_index"] != if_data[u"sw_if_index"]:
if_data = InterfaceUtil.vpp_get_interface_data(
node, if_data[u"sup_sw_if_index"]
)
return if_data.get(u"interface_name")
@staticmethod
def vpp_get_interface_sw_index(node, interface_name):
"""Get interface name for the given SW interface index from actual
interface dump.
:param node: VPP node to get interface data from.
:param interface_name: Interface name.
:type node: dict
:type interface_name: str
:returns: Name of the given interface.
:rtype: str
"""
if_data = InterfaceUtil.vpp_get_interface_data(node, interface_name)
return if_data.get(u"sw_if_index")
@staticmethod
def vpp_get_interface_mac(node, interface):
"""Get MAC address for the given interface from actual interface dump.
:param node: VPP node to get interface data from.
:param interface: Numeric index or name string of a specific interface.
:type node: dict
:type interface: int or str
:returns: MAC address.
:rtype: str
"""
if_data = InterfaceUtil.vpp_get_interface_data(node, interface)
if if_data[u"sup_sw_if_index"] != if_data[u"sw_if_index"]:
if_data = InterfaceUtil.vpp_get_interface_data(
node, if_data[u"sup_sw_if_index"])
return if_data.get(u"l2_address")
@staticmethod
def tg_set_interface_driver(node, pci_addr, driver):
"""Set interface driver on the TG node.
:param node: Node to set interface driver on (must be TG node).
:param pci_addr: PCI address of the interface.
:param driver: Driver name.
:type node: dict
:type pci_addr: str
:type driver: str
:raises RuntimeError: If unbinding from the current driver fails.
:raises RuntimeError: If binding to the new driver fails.
"""
old_driver = InterfaceUtil.tg_get_interface_driver(node, pci_addr)
if old_driver == driver:
return
ssh = SSH()
ssh.connect(node)
# Unbind from current driver
if old_driver is not None:
cmd = f"sh -c \"echo {pci_addr} > " \
f"/sys/bus/pci/drivers/{old_driver}/unbind\""
ret_code, _, _ = ssh.exec_command_sudo(cmd)
if int(ret_code) != 0:
raise RuntimeError(f"'{cmd}' failed on '{node[u'host']}'")
# Bind to the new driver
cmd = f"sh -c \"echo {pci_addr} > /sys/bus/pci/drivers/{driver}/bind\""
ret_code, _, _ = ssh.exec_command_sudo(cmd)
if int(ret_code) != 0:
raise RuntimeError(f"'{cmd}' failed on '{node[u'host']}'")
@staticmethod
def tg_get_interface_driver(node, pci_addr):
"""Get interface driver from the TG node.
:param node: Node to get interface driver on (must be TG node).
:param pci_addr: PCI address of the interface.
:type node: dict
:type pci_addr: str
:returns: Interface driver or None if not found.
:rtype: str
:raises RuntimeError: If PCI rescan or lspci command execution failed.
"""
return DUTSetup.get_pci_dev_driver(node, pci_addr)
@staticmethod
def tg_set_interfaces_default_driver(node):
"""Set interfaces default driver specified in topology yaml file.
:param node: Node to setup interfaces driver on (must be TG node).
:type node: dict
"""
for interface in node[u"interfaces"].values():
InterfaceUtil.tg_set_interface_driver(
node, interface[u"pci_address"], interface[u"driver"]
)
@staticmethod
def update_vpp_interface_data_on_node(node):
"""Update vpp generated interface data for a given node in DICT__nodes.
Updates interface names, software if index numbers and any other details
generated specifically by vpp that are unknown before testcase run.
It does this by dumping interface list from all devices using python
api, and pairing known information from topology (mac address) to state
from VPP.
:param node: Node selected from DICT__nodes.
:type node: dict
"""
interface_list = InterfaceUtil.vpp_get_interface_data(node)
interface_dict = dict()
for ifc in interface_list:
interface_dict[ifc[u"l2_address"]] = ifc
for if_name, if_data in node[u"interfaces"].items():
ifc_dict = interface_dict.get(if_data[u"mac_address"])
if ifc_dict is not None:
if_data[u"name"] = ifc_dict[u"interface_name"]
if_data[u"vpp_sw_index"] = ifc_dict[u"sw_if_index"]
if_data[u"mtu"] = ifc_dict[u"mtu"][0]
logger.trace(
f"Interface {if_name} found by MAC "
f"{if_data[u'mac_address']}"
)
else:
logger.trace(
f"Interface {if_name} not found by MAC "
f"{if_data[u'mac_address']}"
)
if_data[u"vpp_sw_index"] = None
@staticmethod
def update_nic_interface_names(node):
"""Update interface names based on nic type and PCI address.
This method updates interface names in the same format as VPP does.
:param node: Node dictionary.
:type node: dict
"""
for ifc in node[u"interfaces"].values():
if_pci = ifc[u"pci_address"].replace(u".", u":").split(u":")
loc = f"{int(if_pci[1], 16):x}/{int(if_pci[2], 16):x}/" \
f"{int(if_pci[3], 16):x}"
if ifc[u"model"] == u"Intel-XL710":
ifc[u"name"] = f"FortyGigabitEthernet{loc}"
elif ifc[u"model"] == u"Intel-X710":
ifc[u"name"] = f"TenGigabitEthernet{loc}"
elif ifc[u"model"] == u"Intel-X520-DA2":
ifc[u"name"] = f"TenGigabitEthernet{loc}"
elif ifc[u"model"] == u"Cisco-VIC-1385":
ifc[u"name"] = f"FortyGigabitEthernet{loc}"
elif ifc[u"model"] == u"Cisco-VIC-1227":
ifc[u"name"] = f"TenGigabitEthernet{loc}"
else:
ifc[u"name"] = f"UnknownEthernet{loc}"
@staticmethod
def update_nic_interface_names_on_all_duts(nodes):
"""Update interface names based on nic type and PCI address on all DUTs.
This method updates interface names in the same format as VPP does.
:param nodes: Topology nodes.
:type nodes: dict
"""
for node in nodes.values():
if node[u"type"] == NodeType.DUT:
InterfaceUtil.update_nic_interface_names(node)
@staticmethod
def update_tg_interface_data_on_node(node):
"""Update interface name for TG/linux node in DICT__nodes.
.. note::
# for dev in `ls /sys/class/net/`;
> do echo "\"`cat /sys/class/net/$dev/address`\": \"$dev\""; done
"52:54:00:9f:82:63": "eth0"
"52:54:00:77:ae:a9": "eth1"
"52:54:00:e1:8a:0f": "eth2"
"00:00:00:00:00:00": "lo"
:param node: Node selected from DICT__nodes.
:type node: dict
:raises RuntimeError: If getting of interface name and MAC fails.
"""
# First setup interface driver specified in yaml file
InterfaceUtil.tg_set_interfaces_default_driver(node)
# Get interface names
ssh = SSH()
ssh.connect(node)
cmd = u'for dev in `ls /sys/class/net/`; do echo "\\"`cat ' \
u'/sys/class/net/$dev/address`\\": \\"$dev\\""; done;'
ret_code, stdout, _ = ssh.exec_command(cmd)
if int(ret_code) != 0:
raise RuntimeError(u"Get interface name and MAC failed")
tmp = u"{" + stdout.rstrip().replace(u"\n", u",") + u"}"
interfaces = JsonParser().parse_data(tmp)
for interface in node[u"interfaces"].values():
name = interfaces.get(interface[u"mac_address"])
if name is None:
continue
interface[u"name"] = name
@staticmethod
def iface_update_numa_node(node):
"""For all interfaces from topology file update numa node based on
information from the node.
:param node: Node from topology.
:type node: dict
:returns: Nothing.
:raises ValueError: If numa node ia less than 0.
:raises RuntimeError: If update of numa node failed.
"""
def check_cpu_node_count(node_n, val):
val = int(val)
if val < 0:
if CpuUtils.cpu_node_count(node_n) == 1:
val = 0
else:
raise ValueError
return val
ssh = SSH()
for if_key in Topology.get_node_interfaces(node):
if_pci = Topology.get_interface_pci_addr(node, if_key)
ssh.connect(node)
cmd = f"cat /sys/bus/pci/devices/{if_pci}/numa_node"
for _ in range(3):
ret, out, _ = ssh.exec_command(cmd)
if ret == 0:
try:
numa_node = check_cpu_node_count(node, out)
except ValueError:
logger.trace(
f"Reading numa location failed for: {if_pci}"
)
else:
Topology.set_interface_numa_node(
node, if_key, numa_node
)
break
else:
raise RuntimeError(f"Update numa node failed for: {if_pci}")
@staticmethod
def update_all_interface_data_on_all_nodes(
nodes, skip_tg=False, skip_vpp=False):
"""Update interface names on all nodes in DICT__nodes.
This method updates the topology dictionary by querying interface lists
of all nodes mentioned in the topology dictionary.
:param nodes: Nodes in the topology.
:param skip_tg: Skip TG node.
:param skip_vpp: Skip VPP node.
:type nodes: dict
:type skip_tg: bool
:type skip_vpp: bool
"""
for node in nodes.values():
if node[u"type"] == NodeType.DUT and not skip_vpp:
InterfaceUtil.update_vpp_interface_data_on_node(node)
elif node[u"type"] == NodeType.TG and not skip_tg:
InterfaceUtil.update_tg_interface_data_on_node(node)
InterfaceUtil.iface_update_numa_node(node)
@staticmethod
def create_vlan_subinterface(node, interface, vlan):
"""Create VLAN sub-interface on node.
:param node: Node to add VLAN subinterface on.
:param interface: Interface name or index on which create VLAN
subinterface.
:param vlan: VLAN ID of the subinterface to be created.
:type node: dict
:type interface: str on int
:type vlan: int
:returns: Name and index of created subinterface.
:rtype: tuple
:raises RuntimeError: if it is unable to create VLAN subinterface on the
node or interface cannot be converted.
"""
sw_if_index = InterfaceUtil.get_interface_index(node, interface)
cmd = u"create_vlan_subif"
args = dict(
sw_if_index=sw_if_index,
vlan_id=int(vlan)
)
err_msg = f"Failed to create VLAN sub-interface on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
if_key = Topology.add_new_port(node, u"vlan_subif")
Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_index)
Topology.update_interface_name(node, if_key, ifc_name)
return f"{interface}.{vlan}", sw_if_index
@staticmethod
def create_vxlan_interface(node, vni, source_ip, destination_ip):
"""Create VXLAN interface and return sw if index of created interface.
:param node: Node where to create VXLAN interface.
:param vni: VXLAN Network Identifier.
:param source_ip: Source IP of a VXLAN Tunnel End Point.
:param destination_ip: Destination IP of a VXLAN Tunnel End Point.
:type node: dict
:type vni: int
:type source_ip: str
:type destination_ip: str
:returns: SW IF INDEX of created interface.
:rtype: int
:raises RuntimeError: if it is unable to create VxLAN interface on the
node.
"""
src_address = ip_address(source_ip)
dst_address = ip_address(destination_ip)
cmd = u"vxlan_add_del_tunnel"
args = dict(
is_add=1,
is_ipv6=1 if src_address.version == 6 else 0,
instance=Constants.BITWISE_NON_ZERO,
src_address=src_address.packed,
dst_address=dst_address.packed,
mcast_sw_if_index=Constants.BITWISE_NON_ZERO,
encap_vrf_id=0,
decap_next_index=Constants.BITWISE_NON_ZERO,
vni=int(vni)
)
err_msg = f"Failed to create VXLAN tunnel interface " \
f"on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
if_key = Topology.add_new_port(node, u"vxlan_tunnel")
Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_index)
Topology.update_interface_name(node, if_key, ifc_name)
return sw_if_index
@staticmethod
def set_vxlan_bypass(node, interface=None):
"""Add the 'ip4-vxlan-bypass' graph node for a given interface.
By adding the IPv4 vxlan-bypass graph node to an interface, the node
checks for and validate input vxlan packet and bypass ip4-lookup,
ip4-local, ip4-udp-lookup nodes to speedup vxlan packet forwarding.
This node will cause extra overhead to for non-vxlan packets which is
kept at a minimum.
:param node: Node where to set VXLAN bypass.
:param interface: Numeric index or name string of a specific interface.
:type node: dict
:type interface: int or str
:raises RuntimeError: if it failed to set VXLAN bypass on interface.
"""
sw_if_index = InterfaceUtil.get_interface_index(node, interface)
cmd = u"sw_interface_set_vxlan_bypass"
args = dict(
is_ipv6=0,
sw_if_index=sw_if_index,
enable=1
)
err_msg = f"Failed to set VXLAN bypass on interface " \
f"on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_replies(err_msg)
@staticmethod
def vxlan_dump(node, interface=None):
"""Get VxLAN data for the given interface.
:param node: VPP node to get interface data from.
:param interface: Numeric index or name string of a specific interface.
If None, information about all VxLAN interfaces is returned.
:type node: dict
:type interface: int or str
:returns: Dictionary containing data for the given VxLAN interface or if
interface=None, the list of dictionaries with all VxLAN interfaces.
:rtype: dict or list
:raises TypeError: if the data type of interface is neither basestring
nor int.
"""
def process_vxlan_dump(vxlan_dump):
"""Process vxlan dump.
:param vxlan_dump: Vxlan interface dump.
:type vxlan_dump: dict
:returns: Processed vxlan interface dump.
:rtype: dict
"""
if vxlan_dump[u"is_ipv6"]:
vxlan_dump[u"src_address"] = \
ip_address(vxlan_dump[u"src_address"])
vxlan_dump[u"dst_address"] = \
ip_address(vxlan_dump[u"dst_address"])
else:
vxlan_dump[u"src_address"] = \
ip_address(vxlan_dump[u"src_address"][0:4])
vxlan_dump[u"dst_address"] = \
ip_address(vxlan_dump[u"dst_address"][0:4])
return vxlan_dump
if interface is not None:
sw_if_index = InterfaceUtil.get_interface_index(node, interface)
else:
sw_if_index = int(Constants.BITWISE_NON_ZERO)
cmd = u"vxlan_tunnel_dump"
args = dict(
sw_if_index=sw_if_index
)
err_msg = f"Failed to get VXLAN dump on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
details = papi_exec.add(cmd, **args).get_details(err_msg)
data = list() if interface is None else dict()
for dump in details:
if interface is None:
data.append(process_vxlan_dump(dump))
elif dump[u"sw_if_index"] == sw_if_index:
data = process_vxlan_dump(dump)
break
logger.debug(f"VXLAN data:\n{data}")
return data
@staticmethod
def create_subinterface(
node, interface, sub_id, outer_vlan_id=None, inner_vlan_id=None,
type_subif=None):
"""Create sub-interface on node. It is possible to set required
sub-interface type and VLAN tag(s).
:param node: Node to add sub-interface.
:param interface: Interface name on which create sub-interface.
:param sub_id: ID of the sub-interface to be created.
:param outer_vlan_id: Optional outer VLAN ID.
:param inner_vlan_id: Optional inner VLAN ID.
:param type_subif: Optional type of sub-interface. Values supported by
VPP: [no_tags] [one_tag] [two_tags] [dot1ad] [exact_match]
[default_sub]
:type node: dict
:type interface: str or int
:type sub_id: int
:type outer_vlan_id: int
:type inner_vlan_id: int
:type type_subif: str
:returns: Name and index of created sub-interface.
:rtype: tuple
:raises RuntimeError: If it is not possible to create sub-interface.
"""
subif_types = type_subif.split()
flags = 0
if u"no_tags" in subif_types:
flags = flags | SubInterfaceFlags.SUB_IF_API_FLAG_NO_TAGS
if u"one_tag" in subif_types:
flags = flags | SubInterfaceFlags.SUB_IF_API_FLAG_ONE_TAG
if u"two_tags" in subif_types:
flags = flags | SubInterfaceFlags.SUB_IF_API_FLAG_TWO_TAGS
if u"dot1ad" in subif_types:
flags = flags | SubInterfaceFlags.SUB_IF_API_FLAG_DOT1AD
if u"exact_match" in subif_types:
flags = flags | SubInterfaceFlags.SUB_IF_API_FLAG_EXACT_MATCH
if u"default_sub" in subif_types:
flags = flags | SubInterfaceFlags.SUB_IF_API_FLAG_DEFAULT
if type_subif == u"default_sub":
flags = flags | SubInterfaceFlags.SUB_IF_API_FLAG_INNER_VLAN_ID_ANY\
| SubInterfaceFlags.SUB_IF_API_FLAG_OUTER_VLAN_ID_ANY
cmd = u"create_subif"
args = dict(
sw_if_index=InterfaceUtil.get_interface_index(node, interface),
sub_id=int(sub_id),
sub_if_flags=flags.value if hasattr(flags, u"value")
else int(flags),
outer_vlan_id=int(outer_vlan_id) if outer_vlan_id else 0,
inner_vlan_id=int(inner_vlan_id) if inner_vlan_id else 0
)
err_msg = f"Failed to create sub-interface on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
if_key = Topology.add_new_port(node, u"subinterface")
Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_index)
Topology.update_interface_name(node, if_key, ifc_name)
return f"{interface}.{sub_id}", sw_if_index
@staticmethod
def create_gre_tunnel_interface(node, source_ip, destination_ip):
"""Create GRE tunnel interface on node.
:param node: VPP node to add tunnel interface.
:param source_ip: Source of the GRE tunnel.
:param destination_ip: Destination of the GRE tunnel.
:type node: dict
:type source_ip: str
:type destination_ip: str
:returns: Name and index of created GRE tunnel interface.
:rtype: tuple
:raises RuntimeError: If unable to create GRE tunnel interface.
"""
cmd = u"gre_tunnel_add_del"
tunnel = dict(
type=0,
instance=Constants.BITWISE_NON_ZERO,
src=str(source_ip),
dst=str(destination_ip),
outer_fib_id=0,
session_id=0
)
args = dict(
is_add=1,
tunnel=tunnel
)
err_msg = f"Failed to create GRE tunnel interface " \
f"on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
if_key = Topology.add_new_port(node, u"gre_tunnel")
Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_index)
Topology.update_interface_name(node, if_key, ifc_name)
return ifc_name, sw_if_index
@staticmethod
def vpp_create_loopback(node, mac=None):
"""Create loopback interface on VPP node.
:param node: Node to create loopback interface on.
:param mac: Optional MAC address for loopback interface.
:type node: dict
:type mac: str
:returns: SW interface index.
:rtype: int
:raises RuntimeError: If it is not possible to create loopback on the
node.
"""
cmd = u"create_loopback"
args = dict(
mac_address=L2Util.mac_to_bin(mac) if mac else 0
)
err_msg = f"Failed to create loopback interface on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
if_key = Topology.add_new_port(node, u"loopback")
Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_index)
Topology.update_interface_name(node, if_key, ifc_name)
if mac:
mac = InterfaceUtil.vpp_get_interface_mac(node, ifc_name)
Topology.update_interface_mac_address(node, if_key, mac)
return sw_if_index
@staticmethod
def vpp_create_bond_interface(node, mode, load_balance=None, mac=None):
"""Create bond interface on VPP node.
:param node: DUT node from topology.
:param mode: Link bonding mode.
:param load_balance: Load balance (optional, valid for xor and lacp
modes, otherwise ignored).
:param mac: MAC address to assign to the bond interface (optional).
:type node: dict
:type mode: str
:type load_balance: str
:type mac: str
:returns: Interface key (name) in topology.
:rtype: str
:raises RuntimeError: If it is not possible to create bond interface on
the node.
"""
cmd = u"bond_create"
args = dict(
id=int(Constants.BITWISE_NON_ZERO),
use_custom_mac=bool(mac is not None),
mac_address=L2Util.mac_to_bin(mac) if mac else None,
mode=getattr(
LinkBondMode,
f"BOND_API_MODE_{mode.replace(u'-', u'_').upper()}"
).value,
lb=0 if load_balance is None else getattr(
LinkBondLoadBalanceAlgo,
f"BOND_API_LB_ALGO_{load_balance.upper()}"
).value,
numa_only=False
)
err_msg = f"Failed to create bond interface on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
InterfaceUtil.add_eth_interface(
node, sw_if_index=sw_if_index, ifc_pfx=u"eth_bond"
)
if_key = Topology.get_interface_by_sw_index(node, sw_if_index)
return if_key
@staticmethod
def add_eth_interface(
node, ifc_name=None, sw_if_index=None, ifc_pfx=None,
host_if_key=None):
"""Add ethernet interface to current topology.
:param node: DUT node from topology.
:param ifc_name: Name of the interface.
:param sw_if_index: SW interface index.
:param ifc_pfx: Interface key prefix.
:param host_if_key: Host interface key from topology file.
:type node: dict
:type ifc_name: str
:type sw_if_index: int
:type ifc_pfx: str
:type host_if_key: str
"""
if_key = Topology.add_new_port(node, ifc_pfx)
if ifc_name and sw_if_index is None:
sw_if_index = InterfaceUtil.vpp_get_interface_sw_index(
node, ifc_name)
Topology.update_interface_sw_if_index(node, if_key, sw_if_index)
if sw_if_index and ifc_name is None:
ifc_name = InterfaceUtil.vpp_get_interface_name(node, sw_if_index)
Topology.update_interface_name(node, if_key, ifc_name)
ifc_mac = InterfaceUtil.vpp_get_interface_mac(node, sw_if_index)
Topology.update_interface_mac_address(node, if_key, ifc_mac)
if host_if_key is not None:
Topology.set_interface_numa_node(
node, if_key, Topology.get_interface_numa_node(
node, host_if_key
)
)
Topology.update_interface_pci_address(
node, if_key, Topology.get_interface_pci_addr(node, host_if_key)
)
@staticmethod
def vpp_create_avf_interface(node, if_key, num_rx_queues=None):
"""Create AVF interface on VPP node.
:param node: DUT node from topology.
:param if_key: Interface key from topology file of interface
to be bound to i40evf driver.
:param num_rx_queues: Number of RX queues.
:type node: dict
:type if_key: str
:type num_rx_queues: int
:returns: AVF interface key (name) in topology.
:rtype: str
:raises RuntimeError: If it is not possible to create AVF interface on
the node.
"""
PapiSocketExecutor.run_cli_cmd(
node, u"set logging class avf level debug"
)
cmd = u"avf_create"
vf_pci_addr = Topology.get_interface_pci_addr(node, if_key)
args = dict(
pci_addr=InterfaceUtil.pci_to_int(vf_pci_addr),
enable_elog=0,
rxq_num=int(num_rx_queues) if num_rx_queues else 0,
rxq_size=0,
txq_size=0
)
err_msg = f"Failed to create AVF interface on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
InterfaceUtil.add_eth_interface(
node, sw_if_index=sw_if_index, ifc_pfx=u"eth_avf",
host_if_key=if_key
)
return Topology.get_interface_by_sw_index(node, sw_if_index)
@staticmethod
def vpp_create_rdma_interface(
node, if_key, num_rx_queues=None, mode=u"auto"):
"""Create RDMA interface on VPP node.
:param node: DUT node from topology.
:param if_key: Physical interface key from topology file of interface
to be bound to rdma-core driver.
:param num_rx_queues: Number of RX queues.
:param mode: RDMA interface mode - auto/ibv/dv.
:type node: dict
:type if_key: str
:type num_rx_queues: int
:type mode: str
:returns: Interface key (name) in topology file.
:rtype: str
:raises RuntimeError: If it is not possible to create RDMA interface on
the node.
"""
cmd = u"rdma_create"
pci_addr = Topology.get_interface_pci_addr(node, if_key)
args = dict(
name=InterfaceUtil.pci_to_eth(node, pci_addr),
host_if=InterfaceUtil.pci_to_eth(node, pci_addr),
rxq_num=int(num_rx_queues) if num_rx_queues else 0,
rxq_size=1024,
txq_size=1024,
mode=getattr(RdmaMode,f"RDMA_API_MODE_{mode.upper()}").value,
)
err_msg = f"Failed to create RDMA interface on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
sw_if_index = papi_exec.add(cmd, **args).get_sw_if_index(err_msg)
InterfaceUtil.add_eth_interface(
node, sw_if_index=sw_if_index, ifc_pfx=u"eth_rdma",
host_if_key=if_key
)
return Topology.get_interface_by_sw_index(node, sw_if_index)
@staticmethod
def vpp_enslave_physical_interface(node, interface, bond_if):
"""Enslave physical interface to bond interface on VPP node.
:param node: DUT node from topology.
:param interface: Physical interface key from topology file.
:param bond_if: Load balance
:type node: dict
:type interface: str
:type bond_if: str
:raises RuntimeError: If it is not possible to enslave physical
interface to bond interface on the node.
"""
cmd = u"bond_enslave"
args = dict(
sw_if_index=Topology.get_interface_sw_index(node, interface),
bond_sw_if_index=Topology.get_interface_sw_index(node, bond_if),
is_passive=False,
is_long_timeout=False
)
err_msg = f"Failed to enslave physical interface {interface} to bond " \
f"interface {bond_if} on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def vpp_show_bond_data_on_node(node, verbose=False):
"""Show (detailed) bond information on VPP node.
:param node: DUT node from topology.
:param verbose: If detailed information is required or not.
:type node: dict
:type verbose: bool
"""
cmd = u"sw_interface_bond_dump"
err_msg = f"Failed to get bond interface dump on host {node[u'host']}"
data = f"Bond data on node {node[u'host']}:\n"
with PapiSocketExecutor(node) as papi_exec:
details = papi_exec.add(cmd).get_details(err_msg)
for bond in details:
data += f"{bond[u'interface_name']}\n"
data += u" mode: {m}\n".format(
m=bond[u"mode"].name.replace(u"BOND_API_MODE_", u"").lower()
)
data += u" load balance: {lb}\n".format(
lb=bond[u"lb"].name.replace(u"BOND_API_LB_ALGO_", u"").lower()
)
data += f" number of active slaves: {bond[u'active_slaves']}\n"
if verbose:
slave_data = InterfaceUtil.vpp_bond_slave_dump(
node, Topology.get_interface_by_sw_index(
node, bond[u"sw_if_index"]
)
)
for slave in slave_data:
if not slave[u"is_passive"]:
data += f" {slave[u'interface_name']}\n"
data += f" number of slaves: {bond[u'slaves']}\n"
if verbose:
for slave in slave_data:
data += f" {slave[u'interface_name']}\n"
data += f" interface id: {bond[u'id']}\n"
data += f" sw_if_index: {bond[u'sw_if_index']}\n"
logger.info(data)
@staticmethod
def vpp_bond_slave_dump(node, interface):
"""Get bond interface slave(s) data on VPP node.
:param node: DUT node from topology.
:param interface: Physical interface key from topology file.
:type node: dict
:type interface: str
:returns: Bond slave interface data.
:rtype: dict
"""
cmd = u"sw_interface_slave_dump"
args = dict(
sw_if_index=Topology.get_interface_sw_index(node, interface)
)
err_msg = f"Failed to get slave dump on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
details = papi_exec.add(cmd, **args).get_details(err_msg)
logger.debug(f"Slave data:\n{details}")
return details
@staticmethod
def vpp_show_bond_data_on_all_nodes(nodes, verbose=False):
"""Show (detailed) bond information on all VPP nodes in DICT__nodes.
:param nodes: Nodes in the topology.
:param verbose: If detailed information is required or not.
:type nodes: dict
:type verbose: bool
"""
for node_data in nodes.values():
if node_data[u"type"] == NodeType.DUT:
InterfaceUtil.vpp_show_bond_data_on_node(node_data, verbose)
@staticmethod
def vpp_enable_input_acl_interface(
node, interface, ip_version, table_index):
"""Enable input acl on interface.
:param node: VPP node to setup interface for input acl.
:param interface: Interface to setup input acl.
:param ip_version: Version of IP protocol.
:param table_index: Classify table index.
:type node: dict
:type interface: str or int
:type ip_version: str
:type table_index: int
"""
cmd = u"input_acl_set_interface"
args = dict(
sw_if_index=InterfaceUtil.get_interface_index(node, interface),
ip4_table_index=table_index if ip_version == u"ip4"
else Constants.BITWISE_NON_ZERO,
ip6_table_index=table_index if ip_version == u"ip6"
else Constants.BITWISE_NON_ZERO,
l2_table_index=table_index if ip_version == u"l2"
else Constants.BITWISE_NON_ZERO,
is_add=1)
err_msg = f"Failed to enable input acl on interface {interface}"
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def get_interface_classify_table(node, interface):
"""Get name of classify table for the given interface.
TODO: Move to Classify.py.
:param node: VPP node to get data from.
:param interface: Name or sw_if_index of a specific interface.
:type node: dict
:type interface: str or int
:returns: Classify table name.
:rtype: str
"""
if isinstance(interface, str):
sw_if_index = InterfaceUtil.get_sw_if_index(node, interface)
else:
sw_if_index = interface
cmd = u"classify_table_by_interface"
args = dict(
sw_if_index=sw_if_index
)
err_msg = f"Failed to get classify table name by interface {interface}"
with PapiSocketExecutor(node) as papi_exec:
reply = papi_exec.add(cmd, **args).get_reply(err_msg)
return reply
@staticmethod
def get_sw_if_index(node, interface_name):
"""Get sw_if_index for the given interface from actual interface dump.
:param node: VPP node to get interface data from.
:param interface_name: Name of the specific interface.
:type node: dict
:type interface_name: str
:returns: sw_if_index of the given interface.
:rtype: str
"""
interface_data = InterfaceUtil.vpp_get_interface_data(
node, interface=interface_name
)
return interface_data.get(u"sw_if_index")
@staticmethod
def vxlan_gpe_dump(node, interface_name=None):
"""Get VxLAN GPE data for the given interface.
:param node: VPP node to get interface data from.
:param interface_name: Name of the specific interface. If None,
information about all VxLAN GPE interfaces is returned.
:type node: dict
:type interface_name: str
:returns: Dictionary containing data for the given VxLAN GPE interface
or if interface=None, the list of dictionaries with all VxLAN GPE
interfaces.
:rtype: dict or list
"""
def process_vxlan_gpe_dump(vxlan_dump):
"""Process vxlan_gpe dump.
:param vxlan_dump: Vxlan_gpe nterface dump.
:type vxlan_dump: dict
:returns: Processed vxlan_gpe interface dump.
:rtype: dict
"""
if vxlan_dump[u"is_ipv6"]:
vxlan_dump[u"local"] = ip_address(vxlan_dump[u"local"])
vxlan_dump[u"remote"] = ip_address(vxlan_dump[u"remote"])
else:
vxlan_dump[u"local"] = ip_address(vxlan_dump[u"local"][0:4])
vxlan_dump[u"remote"] = ip_address(vxlan_dump[u"remote"][0:4])
return vxlan_dump
if interface_name is not None:
sw_if_index = InterfaceUtil.get_interface_index(
node, interface_name
)
else:
sw_if_index = int(Constants.BITWISE_NON_ZERO)
cmd = u"vxlan_gpe_tunnel_dump"
args = dict(
sw_if_index=sw_if_index
)
err_msg = f"Failed to get VXLAN-GPE dump on host {node[u'host']}"
with PapiSocketExecutor(node) as papi_exec:
details = papi_exec.add(cmd, **args).get_details(err_msg)
data = list() if interface_name is None else dict()
for dump in details:
if interface_name is None:
data.append(process_vxlan_gpe_dump(dump))
elif dump[u"sw_if_index"] == sw_if_index:
data = process_vxlan_gpe_dump(dump)
break
logger.debug(f"VXLAN-GPE data:\n{data}")
return data
@staticmethod
def assign_interface_to_fib_table(node, interface, table_id, ipv6=False):
"""Assign VPP interface to specific VRF/FIB table.
:param node: VPP node where the FIB and interface are located.
:param interface: Interface to be assigned to FIB.
:param table_id: VRF table ID.
:param ipv6: Assign to IPv6 table. Default False.
:type node: dict
:type interface: str or int
:type table_id: int
:type ipv6: bool
"""
cmd = u"sw_interface_set_table"
args = dict(
sw_if_index=InterfaceUtil.get_interface_index(node, interface),
is_ipv6=ipv6,
vrf_id=int(table_id)
)
err_msg = f"Failed to assign interface {interface} to FIB table"
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def set_linux_interface_mac(
node, interface, mac, namespace=None, vf_id=None):
"""Set MAC address for interface in linux.
:param node: Node where to execute command.
:param interface: Interface in namespace.
:param mac: MAC to be assigned to interface.
:param namespace: Execute command in namespace. Optional
:param vf_id: Virtual Function id. Optional
:type node: dict
:type interface: str
:type mac: str
:type namespace: str
:type vf_id: int
"""
mac_str = f"vf {vf_id} mac {mac}" if vf_id is not None \
else f"address {mac}"
ns_str = f"ip netns exec {namespace}" if namespace else u""
cmd = f"{ns_str} ip link set {interface} {mac_str}"
exec_cmd_no_error(node, cmd, sudo=True)
@staticmethod
def set_linux_interface_trust_on(
node, interface, namespace=None, vf_id=None):
"""Set trust on (promisc) for interface in linux.
:param node: Node where to execute command.
:param interface: Interface in namespace.
:param namespace: Execute command in namespace. Optional
:param vf_id: Virtual Function id. Optional
:type node: dict
:type interface: str
:type namespace: str
:type vf_id: int
"""
trust_str = f"vf {vf_id} trust on" if vf_id is not None else u"trust on"
ns_str = f"ip netns exec {namespace}" if namespace else u""
cmd = f"{ns_str} ip link set dev {interface} {trust_str}"
exec_cmd_no_error(node, cmd, sudo=True)
@staticmethod
def set_linux_interface_spoof_off(
node, interface, namespace=None, vf_id=None):
"""Set spoof off for interface in linux.
:param node: Node where to execute command.
:param interface: Interface in namespace.
:param namespace: Execute command in namespace. Optional
:param vf_id: Virtual Function id. Optional
:type node: dict
:type interface: str
:type namespace: str
:type vf_id: int
"""
spoof_str = f"vf {vf_id} spoof off" if vf_id is not None \
else u"spoof off"
ns_str = f"ip netns exec {namespace}" if namespace else u""
cmd = f"{ns_str} ip link set dev {interface} {spoof_str}"
exec_cmd_no_error(node, cmd, sudo=True)
@staticmethod
def init_avf_interface(node, ifc_key, numvfs=1, osi_layer=u"L2"):
"""Init PCI device by creating VIFs and bind them to vfio-pci for AVF
driver testing on DUT.
:param node: DUT node.
:param ifc_key: Interface key from topology file.
:param numvfs: Number of VIFs to initialize, 0 - disable the VIFs.
:param osi_layer: OSI Layer type to initialize TG with.
Default value "L2" sets linux interface spoof off.
:type node: dict
:type ifc_key: str
:type numvfs: int
:type osi_layer: str
:returns: Virtual Function topology interface keys.
:rtype: list
:raises RuntimeError: If a reason preventing initialization is found.
"""
# Read PCI address and driver.
pf_pci_addr = Topology.get_interface_pci_addr(node, ifc_key)
pf_mac_addr = Topology.get_interface_mac(node, ifc_key).split(":")
uio_driver = Topology.get_uio_driver(node)
kernel_driver = Topology.get_interface_driver(node, ifc_key)
if kernel_driver not in (u"i40e", u"i40evf"):
raise RuntimeError(
f"AVF needs i40e-compatible driver, not {kernel_driver} "
f"at node {node[u'host']} ifc {ifc_key}"
)
current_driver = DUTSetup.get_pci_dev_driver(
node, pf_pci_addr.replace(u":", r"\:"))
VPPUtil.stop_vpp_service(node)
if current_driver != kernel_driver:
# PCI device must be re-bound to kernel driver before creating VFs.
DUTSetup.verify_kernel_module(node, kernel_driver, force_load=True)
# Stop VPP to prevent deadlock.
# Unbind from current driver.
DUTSetup.pci_driver_unbind(node, pf_pci_addr)
# Bind to kernel driver.
DUTSetup.pci_driver_bind(node, pf_pci_addr, kernel_driver)
# Initialize PCI VFs.
DUTSetup.set_sriov_numvfs(node, pf_pci_addr, numvfs)
vf_ifc_keys = []
# Set MAC address and bind each virtual function to uio driver.
for vf_id in range(numvfs):
vf_mac_addr = u":".join(
[pf_mac_addr[0], pf_mac_addr[2], pf_mac_addr[3], pf_mac_addr[4],
pf_mac_addr[5], f"{vf_id:02x}"
]
)
pf_dev = f"`basename /sys/bus/pci/devices/{pf_pci_addr}/net/*`"
InterfaceUtil.set_linux_interface_trust_on(
node, pf_dev, vf_id=vf_id
)
if osi_layer == u"L2":
InterfaceUtil.set_linux_interface_spoof_off(
node, pf_dev, vf_id=vf_id
)
InterfaceUtil.set_linux_interface_mac(
node, pf_dev, vf_mac_addr, vf_id=vf_id
)
DUTSetup.pci_vf_driver_unbind(node, pf_pci_addr, vf_id)
DUTSetup.pci_vf_driver_bind(node, pf_pci_addr, vf_id, uio_driver)
# Add newly created ports into topology file
vf_ifc_name = f"{ifc_key}_vif"
vf_pci_addr = DUTSetup.get_virtfn_pci_addr(node, pf_pci_addr, vf_id)
vf_ifc_key = Topology.add_new_port(node, vf_ifc_name)
Topology.update_interface_name(
node, vf_ifc_key, vf_ifc_name+str(vf_id+1)
)
Topology.update_interface_mac_address(node, vf_ifc_key, vf_mac_addr)
Topology.update_interface_pci_address(node, vf_ifc_key, vf_pci_addr)
Topology.set_interface_numa_node(
node, vf_ifc_key, Topology.get_interface_numa_node(
node, ifc_key
)
)
vf_ifc_keys.append(vf_ifc_key)
return vf_ifc_keys
@staticmethod
def vpp_sw_interface_rx_placement_dump(node):
"""Dump VPP interface RX placement on node.
:param node: Node to run command on.
:type node: dict
:returns: Thread mapping information as a list of dictionaries.
:rtype: list
"""
cmd = u"sw_interface_rx_placement_dump"
err_msg = f"Failed to run '{cmd}' PAPI command on host {node[u'host']}!"
with PapiSocketExecutor(node) as papi_exec:
for ifc in node[u"interfaces"].values():
if ifc[u"vpp_sw_index"] is not None:
papi_exec.add(cmd, sw_if_index=ifc[u"vpp_sw_index"])
details = papi_exec.get_details(err_msg)
return sorted(details, key=lambda k: k[u"sw_if_index"])
@staticmethod
def vpp_sw_interface_set_rx_placement(
node, sw_if_index, queue_id, worker_id):
"""Set interface RX placement to worker on node.
:param node: Node to run command on.
:param sw_if_index: VPP SW interface index.
:param queue_id: VPP interface queue ID.
:param worker_id: VPP worker ID (indexing from 0).
:type node: dict
:type sw_if_index: int
:type queue_id: int
:type worker_id: int
:raises RuntimeError: If failed to run command on host or if no API
reply received.
"""
cmd = u"sw_interface_set_rx_placement"
err_msg = f"Failed to set interface RX placement to worker " \
f"on host {node[u'host']}!"
args = dict(
sw_if_index=sw_if_index,
queue_id=queue_id,
worker_id=worker_id,
is_main=False
)
with PapiSocketExecutor(node) as papi_exec:
papi_exec.add(cmd, **args).get_reply(err_msg)
@staticmethod
def vpp_round_robin_rx_placement(node, prefix):
"""Set Round Robin interface RX placement on all worker threads
on node.
:param node: Topology nodes.
:param prefix: Interface name prefix.
:type node: dict
:type prefix: str
"""
worker_id = 0
worker_cnt = len(VPPUtil.vpp_show_threads(node)) - 1
if not worker_cnt:
return
for placement in InterfaceUtil.vpp_sw_interface_rx_placement_dump(node):
for interface in node[u"interfaces"].values():
if placement[u"sw_if_index"] == interface[u"vpp_sw_index"] \
and prefix in interface[u"name"]:
InterfaceUtil.vpp_sw_interface_set_rx_placement(
node, placement[u"sw_if_index"], placement[u"queue_id"],
worker_id % worker_cnt
)
worker_id += 1
@staticmethod
def vpp_round_robin_rx_placement_on_all_duts(nodes, prefix):
"""Set Round Robin interface RX placement on all worker threads
on all DUTs.
:param nodes: Topology nodes.
:param prefix: Interface name prefix.
:type nodes: dict
:type prefix: str
"""
for node in nodes.values():
if node[u"type"] == NodeType.DUT:
InterfaceUtil.vpp_round_robin_rx_placement(node, prefix)
|