1 # Copyright (c) 2021 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """Defines nodes and topology structure."""
18 from collections import Counter
20 from yaml import safe_load
22 from robot.api import logger
23 from robot.libraries.BuiltIn import BuiltIn, RobotNotRunningError
25 from resources.libraries.python.Constants import Constants
28 u"DICT__nodes", u"Topology", u"NodeType", u"SocketType", u"NodeSubTypeTG"
32 def load_topo_from_yaml():
33 """Load topology from file defined in "${TOPOLOGY_PATH}" variable.
35 :returns: Nodes from loaded topology.
38 topo_path = BuiltIn().get_variable_value(u"${TOPOLOGY_PATH}")
39 except RobotNotRunningError:
42 with open(topo_path) as work_file:
43 return safe_load(work_file.read())[u"nodes"]
47 """Defines node types used in topology dictionaries."""
48 # Device Under Test (this node has VPP running on it)
50 # Traffic Generator (this node has traffic generator on it)
51 # pylint: disable=invalid-name
53 # Virtual Machine (this node running on DUT node)
54 # pylint: disable=invalid-name
59 """Defines node sub-type TG - traffic generator."""
60 # T-Rex traffic generator
69 """Defines socket types used in topology dictionaries."""
72 # VPP PAPI Stats (legacy option until stats are migrated to Socket PAPI)
76 DICT__nodes = load_topo_from_yaml()
80 """Topology data manipulation and extraction methods.
82 Defines methods used for manipulation and extraction of data from
85 "Active topology" contains initially data from the topology file and can be
86 extended with additional data from the DUTs like internal interface indexes
87 or names. Additional data which can be filled to the active topology are
89 - additional internal representation (index, name, ...)
90 - operational data (dynamic ports)
92 To access the port data it is recommended to use a port key because the key
93 does not rely on the data retrieved from nodes, this allows to call most of
94 the methods without having filled active topology with internal nodes data.
97 def add_node_item(node, value, path):
98 """Add item to topology node.
100 :param node: Topology node.
101 :param value: Value to insert.
102 :param path: Path where to insert item.
108 node[path[0]] = value
110 if path[0] not in node:
111 node[path[0]] = dict()
112 elif isinstance(node[path[0]], str):
113 node[path[0]] = dict() if node[path[0]] == u"" \
114 else {node[path[0]]: u""}
115 Topology.add_node_item(node[path[0]], value, path[1:])
118 def add_new_port(node, ptype):
119 """Add new port to the node to active topology.
121 :param node: Node to add new port on.
122 :param ptype: Port type, used as key prefix.
125 :returns: Port key or None
126 :rtype: string or None
130 for i in range(1, max_ports):
131 if node[u"interfaces"].get(str(ptype) + str(i)) is None:
132 iface = str(ptype) + str(i)
133 node[u"interfaces"][iface] = dict()
138 def remove_port(node, iface_key):
139 """Remove required port from active topology.
141 :param node: Node to remove port on.
142 :param: iface_key: Topology key of the interface.
148 node[u"interfaces"].pop(iface_key)
153 def remove_all_ports(node, ptype):
154 """Remove all ports with ptype as prefix.
156 :param node: Node to remove ports on.
157 :param: ptype: Port type, used as key prefix.
162 for if_key in list(node[u"interfaces"]):
163 if if_key.startswith(str(ptype)):
164 node[u"interfaces"].pop(if_key)
167 def remove_all_added_ports_on_all_duts_from_topology(nodes):
168 """Remove all added ports on all DUT nodes in the topology.
170 :param nodes: Nodes in the topology.
175 u"subinterface", u"vlan_subif", u"memif", u"tap", u"vhost",
176 u"loopback", u"gre_tunnel", u"vxlan_tunnel", u"eth_bond",
177 u"eth_avf", u"eth_rdma", u"geneve_tunnel", u"eth_af_xdp",
181 for node_data in nodes.values():
182 if node_data[u"type"] == NodeType.DUT:
183 for ptype in port_types:
184 Topology.remove_all_ports(node_data, ptype)
187 def remove_all_vif_ports(node):
188 """Remove all Virtual Interfaces on DUT node.
190 :param node: Node to remove VIF ports on.
194 reg_ex = re.compile(r"port\d+_vif\d+")
195 for if_key in list(node[u"interfaces"]):
196 if re.match(reg_ex, if_key):
197 node[u"interfaces"].pop(if_key)
200 def remove_all_added_vif_ports_on_all_duts_from_topology(nodes):
201 """Remove all added Virtual Interfaces on all DUT nodes in
204 :param nodes: Nodes in the topology.
208 for node_data in nodes.values():
209 if node_data[u"type"] == NodeType.DUT:
210 Topology.remove_all_vif_ports(node_data)
213 def update_interface_sw_if_index(node, iface_key, sw_if_index):
214 """Update sw_if_index on the interface from the node.
216 :param node: Node to update sw_if_index on.
217 :param iface_key: Topology key of the interface.
218 :param sw_if_index: Internal index to store.
221 :type sw_if_index: int
223 node[u"interfaces"][iface_key][u"vpp_sw_index"] = int(sw_if_index)
226 def update_interface_name(node, iface_key, name):
227 """Update name on the interface from the node.
229 :param node: Node to update name on.
230 :param iface_key: Topology key of the interface.
231 :param name: Interface name to store.
236 node[u"interfaces"][iface_key][u"name"] = str(name)
239 def update_interface_mac_address(node, iface_key, mac_address):
240 """Update mac_address on the interface from the node.
242 :param node: Node to update MAC on.
243 :param iface_key: Topology key of the interface.
244 :param mac_address: MAC address.
247 :type mac_address: str
249 node[u"interfaces"][iface_key][u"mac_address"] = str(mac_address)
252 def update_interface_pci_address(node, iface_key, pci_address):
253 """Update pci_address on the interface from the node.
255 :param node: Node to update PCI on.
256 :param iface_key: Topology key of the interface.
257 :param pci_address: PCI address.
260 :type pci_address: str
262 node[u"interfaces"][iface_key][u"pci_address"] = str(pci_address)
265 def update_interface_vlan(node, iface_key, vlan):
266 """Update VLAN on the interface from the node.
268 :param node: Node to update VLAN on.
269 :param iface_key: Topology key of the interface.
270 :param vlan: VLAN ID.
275 node[u"interfaces"][iface_key][u"vlan"] = int(vlan)
278 def update_interface_vhost_socket(node, iface_key, vhost_socket):
279 """Update vhost socket name on the interface from the node.
281 :param node: Node to update socket name on.
282 :param iface_key: Topology key of the interface.
283 :param vhost_socket: Path to named socket on node.
286 :type vhost_socket: str
288 node[u"interfaces"][iface_key][u"vhost_socket"] = str(vhost_socket)
291 def update_interface_memif_socket(node, iface_key, memif_socket):
292 """Update memif socket name on the interface from the node.
294 :param node: Node to update socket name on.
295 :param iface_key: Topology key of the interface.
296 :param memif_socket: Path to named socket on node.
299 :type memif_socket: str
301 node[u"interfaces"][iface_key][u"memif_socket"] = str(memif_socket)
304 def update_interface_memif_id(node, iface_key, memif_id):
305 """Update memif ID on the interface from the node.
307 :param node: Node to update memif ID on.
308 :param iface_key: Topology key of the interface.
309 :param memif_id: Memif interface ID.
314 node[u"interfaces"][iface_key][u"memif_id"] = str(memif_id)
317 def update_interface_memif_role(node, iface_key, memif_role):
318 """Update memif role on the interface from the node.
320 :param node: Node to update memif role on.
321 :param iface_key: Topology key of the interface.
322 :param memif_role: Memif role.
325 :type memif_role: str
327 node[u"interfaces"][iface_key][u"memif_role"] = str(memif_role)
330 def update_interface_tap_dev_name(node, iface_key, dev_name):
331 """Update device name on the tap interface from the node.
333 :param node: Node to update tap device name on.
334 :param iface_key: Topology key of the interface.
335 :param dev_name: Device name of the tap interface.
341 node[u"interfaces"][iface_key][u"dev_name"] = str(dev_name)
344 def get_node_by_hostname(nodes, hostname):
345 """Get node from nodes of the topology by hostname.
347 :param nodes: Nodes of the test topology.
348 :param hostname: Host name.
351 :returns: Node dictionary or None if not found.
353 for node in nodes.values():
354 if node[u"host"] == hostname:
360 def get_links(nodes):
361 """Get list of links(networks) in the topology.
363 :param nodes: Nodes of the test topology.
365 :returns: Links in the topology.
370 for node in nodes.values():
371 for interface in node[u"interfaces"].values():
372 link = interface.get(u"link")
374 if link not in links:
380 def _get_interface_by_key_value(node, key, value, subsequent=False):
381 """Return node interface key from topology file
382 according to key and value.
384 :param node: The node dictionary.
385 :param key: Key by which to select the interface.
386 :param value: Value that should be found using the key.
387 :param subsequent: Use second interface of the link. Useful for
388 back-to-back links. Default: False
392 :type subsequent: bool
393 :returns: Interface key from topology file
396 interfaces = node[u"interfaces"]
398 for if_key, if_val in interfaces.items():
399 k_val = if_val.get(key)
400 if k_val is not None:
410 def get_interface_by_name(node, iface_name):
411 """Return interface key based on name from DUT/TG.
413 This method returns interface key based on interface name
414 retrieved from the DUT, or TG.
416 :param node: The node topology dictionary.
417 :param iface_name: Interface name (string form).
419 :type iface_name: string
420 :returns: Interface key.
423 return Topology._get_interface_by_key_value(node, u"name", iface_name)
426 def get_interface_by_link_name(node, link_name, subsequent=False):
427 """Return interface key of link on node.
429 This method returns the interface name associated with a given link
432 :param node: The node topology dictionary.
433 :param link_name: Name of the link that a interface is connected to.
434 :param subsequent: Use second interface of the link. Useful for
435 back-to-back links. Default: False
437 :type link_name: string
438 :type subsequent: bool
439 :returns: Interface key of the interface connected to the given link.
442 return Topology._get_interface_by_key_value(
443 node, u"link", link_name, subsequent=subsequent
446 def get_interfaces_by_link_names(self, node, link_names):
447 """Return dictionary of dictionaries {"interfaceN", interface name}.
449 This method returns the interface names associated with given links
452 :param node: The node topology directory.
453 :param link_names: List of names of the link that a interface is
456 :type link_names: list
457 :returns: Dictionary of interface names that are connected to the given
463 for link_name in link_names:
464 interface = self.get_interface_by_link_name(node, link_name)
465 retval[f"interface{str(interface_number)}"] = \
466 self.get_interface_name(node, interface)
467 interface_number += 1
471 def get_interface_by_sw_index(node, sw_if_index):
472 """Return interface name of link on node.
474 This method returns the interface name associated with a software
475 interface index assigned to the interface by vpp for a given node.
477 :param node: The node topology dictionary.
478 :param sw_if_index: sw_if_index of the link that a interface is
481 :type sw_if_index: int
482 :returns: Interface name of the interface connected to the given link.
485 return Topology._get_interface_by_key_value(
486 node, u"vpp_sw_index", sw_if_index
490 def get_interface_sw_index(node, iface_key):
491 """Get VPP sw_if_index for the interface using interface key.
493 :param node: Node to get interface sw_if_index on.
494 :param iface_key: Interface key from topology file, or sw_if_index.
496 :type iface_key: str/int
497 :returns: Return sw_if_index or None if not found.
501 if isinstance(iface_key, str):
502 return node[u"interfaces"][iface_key].get(u"vpp_sw_index")
503 # TODO: use only iface_key, do not use integer
504 return int(iface_key)
505 except (KeyError, ValueError):
509 def get_interface_sw_index_by_name(node, iface_name):
510 """Get VPP sw_if_index for the interface using interface name.
512 :param node: Node to get interface sw_if_index on.
513 :param iface_name: Interface name.
515 :type iface_name: str
516 :returns: Return sw_if_index or None if not found.
517 :raises TypeError: If provided interface name is not a string.
520 if not isinstance(iface_name, str):
521 raise TypeError(u"Interface name must be a string.")
522 iface_key = Topology.get_interface_by_name(node, iface_name)
523 return node[u"interfaces"][iface_key].get(u"vpp_sw_index")
524 except (KeyError, ValueError):
528 def get_interface_mtu(node, iface_key):
529 """Get interface MTU.
531 Returns physical layer MTU (max. size of Ethernet frame).
532 :param node: Node to get interface MTU on.
533 :param iface_key: Interface key from topology file.
536 :returns: MTU or None if not found.
540 return node[u"interfaces"][iface_key].get(u"mtu")
545 def get_interface_name(node, iface_key):
546 """Get interface name (retrieved from DUT/TG).
548 Returns name in string format, retrieved from the node.
549 :param node: Node to get interface name on.
550 :param iface_key: Interface key from topology file.
553 :returns: Interface name or None if not found.
557 return node[u"interfaces"][iface_key].get(u"name")
562 def convert_interface_reference_to_key(node, interface):
563 """Takes interface reference in any format
564 (name, link name, interface key or sw_if_index)
565 and converts to interface key using Topology methods.
567 :param node: Node in topology.
568 :param interface: Name, sw_if_index, link name or key of an interface
571 :type interface: str or int
573 :returns: Interface key.
576 :raises TypeError: If provided with invalid interface argument.
577 :raises RuntimeError: If the interface does not exist in topology.
580 if isinstance(interface, int):
581 key = Topology.get_interface_by_sw_index(node, interface)
584 f"Interface with sw_if_index={interface} does not exist "
587 elif interface in Topology.get_node_interfaces(node):
589 elif interface in Topology.get_links({u"dut": node}):
590 key = Topology.get_interface_by_link_name(node, interface)
591 elif isinstance(interface, str):
592 key = Topology.get_interface_by_name(node, interface)
595 f"Interface with key, name or link name \"{interface}\" "
596 f"does not exist in topology."
600 u"Type of interface argument must be integer or string."
605 def convert_interface_reference(node, interface, wanted_format):
606 """Takes interface reference in any format
607 (name, link name, topology key or sw_if_index) and returns
608 its equivalent in the desired format.
610 :param node: Node in topology.
611 :param interface: Name, sw_if_index, link name or key of an interface
613 :param wanted_format: Format of return value wanted.
614 Valid options are: sw_if_index, key, name.
616 :type interface: str or int
617 :type wanted_format: str
618 :returns: Interface name, interface key or sw_if_index.
620 :raises TypeError, ValueError: If provided with invalid arguments.
621 :raises RuntimeError: If the interface does not exist in topology.
624 key = Topology.convert_interface_reference_to_key(node, interface)
627 u"key": lambda x, y: y,
628 u"name": Topology.get_interface_name,
629 u"sw_if_index": Topology.get_interface_sw_index
633 return conversions[wanted_format](node, key)
636 f"Unrecognized return value wanted: {wanted_format}."
637 f"Valid options are key, name, sw_if_index"
641 def get_interface_numa_node(node, iface_key):
642 """Get interface numa node.
644 Returns physical relation to numa node, numa_id.
646 :param node: Node to get numa id on.
647 :param iface_key: Interface key from topology file.
650 :returns: numa node id, None if not available.
654 return node[u"interfaces"][iface_key].get(u"numa_node")
659 def get_interfaces_numa_node(node, *iface_keys):
660 """Get numa node on which are located most of the interfaces.
662 Return numa node with highest count of interfaces provided as arguments.
663 Return 0 if the interface does not have numa_node information available.
664 If all interfaces have unknown location (-1), then return 0.
665 If most of interfaces have unknown location (-1), but there are
666 some interfaces with known location, then return the second most
667 location of the provided interfaces.
669 :param node: Node from DICT__nodes.
670 :param iface_keys: Interface keys for lookup.
672 :type iface_keys: strings
673 :returns: Numa node of most given interfaces or 0.
677 for if_key in iface_keys:
679 numa_list.append(node[u"interfaces"][if_key].get(u"numa_node"))
683 numa_cnt_mc = Counter(numa_list).most_common()
685 if numa_cnt_mc and numa_cnt_mc[0][0] != -1:
686 return numa_cnt_mc[0][0]
687 if len(numa_cnt_mc) > 1 and numa_cnt_mc[0][0] == -1:
688 return numa_cnt_mc[1][0]
692 def get_interface_mac(node, iface_key):
693 """Get MAC address for the interface.
695 :param node: Node to get interface mac on.
696 :param iface_key: Interface key from topology file.
699 :returns: Return MAC or None if not found.
702 return node[u"interfaces"][iface_key].get(u"mac_address")
707 def get_interface_ip4(node, iface_key):
708 """Get IP4 address for the interface.
710 :param node: Node to get interface mac on.
711 :param iface_key: Interface key from topology file.
714 :returns: Return IP4 or None if not found.
717 return node[u"interfaces"][iface_key].get(u"ip4_address")
722 def get_interface_ip4_prefix_length(node, iface_key):
723 """Get IP4 address prefix length for the interface.
725 :param node: Node to get prefix length on.
726 :param iface_key: Interface key from topology file.
729 :returns: Prefix length from topology file or the default
730 IP4 prefix length if not found.
732 :raises: KeyError if iface_key is not found.
734 return node[u"interfaces"][iface_key].get(u"ip4_prefix_length", \
735 Constants.DEFAULT_IP4_PREFIX_LENGTH)
738 def get_adjacent_node_and_interface(nodes_info, node, iface_key):
739 """Get node and interface adjacent to specified interface
742 :param nodes_info: Dictionary containing information on all nodes
744 :param node: Node that contains specified interface.
745 :param iface_key: Interface key from topology file.
746 :type nodes_info: dict
749 :returns: Return (node, interface_key) tuple or None if not found.
753 # get link name where the interface belongs to
754 for if_key, if_val in node[u"interfaces"].items():
755 if if_key == u"mgmt":
757 if if_key == iface_key:
758 link_name = if_val[u"link"]
761 if link_name is None:
765 for node_data in nodes_info.values():
767 if node_data[u"host"] == node[u"host"]:
770 in node_data[u"interfaces"].items():
771 if u"link" not in if_val:
773 if if_val[u"link"] == link_name:
774 return node_data, if_key
778 def get_interface_pci_addr(node, iface_key):
779 """Get interface PCI address.
781 :param node: Node to get interface PCI address on.
782 :param iface_key: Interface key from topology file.
785 :returns: Return PCI address or None if not found.
788 return node[u"interfaces"][iface_key].get(u"pci_address")
793 def get_interface_driver(node, iface_key):
794 """Get interface driver.
796 :param node: Node to get interface driver on.
797 :param iface_key: Interface key from topology file.
800 :returns: Return interface driver or None if not found.
803 return node[u"interfaces"][iface_key].get(u"driver")
808 def get_interface_vlan(node, iface_key):
809 """Get interface vlan.
811 :param node: Node to get interface driver on.
812 :param iface_key: Interface key from topology file.
815 :returns: Return interface vlan or None if not found.
818 return node[u"interfaces"][iface_key].get(u"vlan")
823 def get_node_interfaces(node):
824 """Get all node interfaces.
826 :param node: Node to get list of interfaces from.
828 :returns: Return list of keys of all interfaces.
831 return node[u"interfaces"].keys()
834 def get_node_link_mac(node, link_name):
835 """Return interface mac address by link name.
837 :param node: Node to get interface sw_if_index on.
838 :param link_name: Link name.
841 :returns: MAC address string.
844 for port in node[u"interfaces"].values():
845 if port.get(u"link") == link_name:
846 return port.get(u"mac_address")
850 def _get_node_active_link_names(node, filter_list=None, topo_has_dut=True):
851 """Return list of link names that are other than mgmt links.
853 :param node: Node topology dictionary.
854 :param filter_list: Link filter criteria.
855 :param topo_has_dut: Whether we require back-to-back links.
857 :type filter_list: list of strings
858 :type topo_has_dut: bool
859 :returns: List of link names occupied by the node.
860 :rtype: None or list of string
862 interfaces = node[u"interfaces"]
864 for interface in interfaces.values():
865 if u"link" in interface:
866 if (filter_list is not None) and (u"model" in interface):
867 for filt in filter_list:
868 if filt == interface[u"model"]:
869 link_names.append(interface[u"link"])
870 elif (filter_list is not None) and (u"model" not in interface):
872 f"Cannot apply filter on interface: {str(interface)}"
875 link_names.append(interface[u"link"])
879 new_link_names = list()
880 for link_name in link_names:
882 for interface in interfaces.values():
883 link = interface.get(u"link", None)
884 if link == link_name:
887 new_link_names.append(link_name)
888 link_names = new_link_names
891 def get_active_connecting_links(
892 self, node1, node2, filter_list_node1=None, filter_list_node2=None):
893 """Return list of link names that connect together node1 and node2.
895 :param node1: Node topology dictionary.
896 :param node2: Node topology dictionary.
897 :param filter_list_node1: Link filter criteria for node1.
898 :param filter_list_node2: Link filter criteria for node2.
901 :type filter_list_node1: list of strings
902 :type filter_list_node2: list of strings
903 :returns: List of strings that represent connecting link names.
908 node1_links = self._get_node_active_link_names(
909 node1, filter_list=filter_list_node1
911 node2_links = self._get_node_active_link_names(
912 node2, filter_list=filter_list_node2
915 # Looking for back-to-back links.
916 node1_links = self._get_node_active_link_names(
917 node1, filter_list=filter_list_node1, topo_has_dut=False
919 node2_links = node1_links
921 connecting_links = None
922 if node1_links is None:
923 logger.error(u"Unable to find active links for node1")
924 elif node2_links is None:
925 logger.error(u"Unable to find active links for node2")
927 # Not using set operations, as we need deterministic order.
929 link for link in node1_links if link in node2_links
932 return connecting_links
934 def get_first_active_connecting_link(self, node1, node2):
935 """Get first link connecting the two nodes together.
937 :param node1: Connected node.
938 :param node2: Connected node.
941 :returns: Name of a link connecting the two nodes together.
943 :raises RuntimeError: If no links are found.
945 connecting_links = self.get_active_connecting_links(node1, node2)
946 if not connecting_links:
947 raise RuntimeError(u"No links connecting the nodes were found")
948 return connecting_links[0]
950 def get_egress_interfaces_name_for_nodes(self, node1, node2):
951 """Get egress interfaces on node1 for link with node2.
953 :param node1: First node, node to get egress interface on.
954 :param node2: Second node.
957 :returns: Egress interfaces.
961 links = self.get_active_connecting_links(node1, node2)
963 raise RuntimeError(u"No link between nodes")
964 for interface in node1[u"interfaces"].values():
965 link = interface.get(u"link")
970 name = interface.get(u"name")
973 interfaces.append(name)
976 def get_first_egress_interface_for_nodes(self, node1, node2):
977 """Get first egress interface on node1 for link with node2.
979 :param node1: First node, node to get egress interface name on.
980 :param node2: Second node.
983 :returns: Egress interface name.
986 interfaces = self.get_egress_interfaces_name_for_nodes(node1, node2)
988 raise RuntimeError(u"No egress interface for nodes")
991 def get_links_dict_from_nodes(self, tgen, dut1, dut2):
992 """Return link combinations used in tests in circular topology.
994 For the time being it returns links from the Node path:
996 The naming convention until changed to something more general is
998 DUT1_DUT2_LINK: link name between DUT! and DUT2
999 DUT1_TG_LINK: link name between DUT1 and TG
1000 DUT2_TG_LINK: link name between DUT2 and TG
1001 TG_TRAFFIC_LINKS: list of link names that generated traffic is sent
1003 DUT1_BD_LINKS: list of link names that will be connected by the bridge
1005 DUT2_BD_LINKS: list of link names that will be connected by the bridge
1008 :param tgen: Traffic generator node data.
1009 :param dut1: DUT1 node data.
1010 :param dut2: DUT2 node data.
1014 :returns: Dictionary of possible link combinations.
1017 # TODO: replace with generic function.
1018 dut1_dut2_link = self.get_first_active_connecting_link(dut1, dut2)
1019 dut1_tg_link = self.get_first_active_connecting_link(dut1, tgen)
1020 dut2_tg_link = self.get_first_active_connecting_link(dut2, tgen)
1021 tg_traffic_links = [dut1_tg_link, dut2_tg_link]
1022 dut1_bd_links = [dut1_dut2_link, dut1_tg_link]
1023 dut2_bd_links = [dut1_dut2_link, dut2_tg_link]
1025 u"DUT1_DUT2_LINK": dut1_dut2_link,
1026 u"DUT1_TG_LINK": dut1_tg_link,
1027 u"DUT2_TG_LINK": dut2_tg_link,
1028 u"TG_TRAFFIC_LINKS": tg_traffic_links,
1029 u"DUT1_BD_LINKS": dut1_bd_links,
1030 u"DUT2_BD_LINKS": dut2_bd_links
1032 return topology_links
1035 def is_tg_node(node):
1036 """Find out whether the node is TG.
1038 :param node: Node to examine.
1040 :returns: True if node is type of TG, otherwise False.
1043 return node[u"type"] == NodeType.TG
1046 def get_node_hostname(node):
1047 """Return host (hostname/ip address) of the node.
1049 :param node: Node created from topology.
1051 :returns: Hostname or IP address.
1054 return node[u"host"]
1057 def get_node_arch(node):
1058 """Return arch of the node.
1059 Default to x86_64 if no arch present
1061 :param node: Node created from topology.
1063 :returns: Node architecture
1067 return node[u"arch"]
1069 node[u"arch"] = u"x86_64"
1073 def get_cryptodev(node):
1074 """Return Crytodev configuration of the node.
1076 :param node: Node created from topology.
1078 :returns: Cryptodev configuration string.
1082 return node[u"cryptodev"]
1087 def get_uio_driver(node):
1088 """Return uio-driver configuration of the node.
1090 :param node: Node created from topology.
1092 :returns: uio-driver configuration string.
1096 return node[u"uio_driver"]
1101 def set_interface_numa_node(node, iface_key, numa_node_id):
1102 """Set interface numa_node location.
1104 :param node: Node to set numa_node on.
1105 :param iface_key: Interface key from topology file.
1106 :param numa_node_id: Num_node ID.
1108 :type iface_key: str
1109 :type numa_node_id: int
1110 :returns: Return iface_key or None if not found.
1113 node[u"interfaces"][iface_key][u"numa_node"] = numa_node_id
1119 def add_new_socket(node, socket_type, socket_id, socket_path):
1120 """Add socket file of specific SocketType and ID to node.
1122 :param node: Node to add socket on.
1123 :param socket_type: Socket type.
1124 :param socket_id: Socket id, currently equals to unique node key.
1125 :param socket_path: Socket absolute path.
1127 :type socket_type: SocketType
1128 :type socket_id: str
1129 :type socket_path: str
1131 path = [u"sockets", socket_type, socket_id]
1132 Topology.add_node_item(node, socket_path, path)
1135 def del_node_socket_id(node, socket_type, socket_id):
1136 """Delete socket of specific SocketType and ID from node.
1138 :param node: Node to delete socket from.
1139 :param socket_type: Socket type.
1140 :param socket_id: Socket id, currently equals to unique node key.
1142 :type socket_type: SocketType
1143 :type socket_id: str
1145 node[u"sockets"][socket_type].pop(socket_id)
1148 def get_node_sockets(node, socket_type=None):
1149 """Get node socket files.
1151 :param node: Node to get sockets from.
1152 :param socket_type: Socket type or None for all sockets.
1154 :type socket_type: SocketType
1155 :returns: Node sockets or None if not found.
1160 return node[u"sockets"][socket_type]
1161 return node[u"sockets"]
1166 def clean_sockets_on_all_nodes(nodes):
1167 """Remove temporary socket files from topology file.
1169 :param nodes: SUT nodes.
1172 for node in nodes.values():
1173 if u"sockets" in list(node.keys()):
1174 # Containers are disconnected and destroyed already.
1175 node.pop(u"sockets")