1 # Copyright (c) 2020 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.
16 # This library defines functions used by multiple entry scripts.
17 # Deliberately not depending on common.sh to allow standalone usage.
18 # Keep functions ordered alphabetically, please.
20 function activate_wrapper () {
22 # Acts as wrapper for activate docker topology.
25 # - ${1} - Node multiplicity of desired testbed.
26 # - ${2} - Node flavor string, usually describing the processor.
27 # - ${3} - CSIT-SUT-DCR image name and version.
32 get_available_interfaces "${1}" "${2}" || die
33 start_topology_containers "${3}" || die
34 bind_interfaces_to_containers || die
35 set_env_variables || die
36 print_env_variables || die
41 function bind_interfaces_to_containers () {
43 # Bind linux network interface to container and create symlink for PCI
44 # address in container.
47 # - DCR_UUIDS - Docker Container UUIDs.
48 # - DCR_CPIDS - Docker Container PIDs (namespaces).
49 # - DUT1_NETDEVS - List of network devices allocated to DUT1 container.
50 # - PCI_ADDR - PCI address of network device.
51 # - TG_NETDEVS - List of network devices allocated to TG container.
53 # - NETDEV - Linux network interface.
57 for NETDEV in "${TG_NETDEVS[@]}"; do
59 link_target=$(readlink -f /sys/bus/pci/devices/"${PCI_ADDR}") || {
60 die "Reading symlink for PCI address failed!"
62 cmd="ln -s ${link_target} /sys/bus/pci/devices/${PCI_ADDR}"
64 sudo ip link set ${NETDEV} netns ${DCR_CPIDS[tg]} || {
65 die "Moving interface to ${DCR_CPIDS[tg]} namespace failed!"
67 docker exec "${DCR_UUIDS[tg]}" ${cmd} || {
68 die "Linking PCI address in container failed!"
71 for NETDEV in "${DUT1_NETDEVS[@]}"; do
73 link_target=$(readlink -f /sys/bus/pci/devices/"${PCI_ADDR}") || {
74 die "Reading symlink for PCI address failed!"
76 cmd="ln -s ${link_target} /sys/bus/pci/devices/${PCI_ADDR}"
78 sudo ip link set ${NETDEV} netns ${DCR_CPIDS[dut1]} || {
79 die "Moving interface to ${DCR_CPIDS[dut1]} namespace failed!"
81 docker exec "${DCR_UUIDS[dut1]}" ${cmd} || {
82 die "Linking PCI address in container failed!"
88 function bind_interfaces_to_driver () {
90 # Bind network interface specified by parameter to driver specified by
94 # - ADDR - PCI address of network interface.
95 # - DRIVER - Kernel driver.
99 pci_path="/sys/bus/pci/devices/${ADDR}"
100 drv_path="/sys/bus/pci/drivers/${DRIVER}"
101 vd=$(cat ${pci_path}/vendor ${pci_path}/device) || {
102 die "Failed to retrieve interface details!"
105 echo ${vd} | sudo tee ${drv_path}/new_id
107 echo ${ADDR} | sudo tee ${pci_path}/driver/unbind || {
108 die "Failed to unbind interface ${ADDR}!"
110 echo ${ADDR} | sudo tee ${drv_path}/bind || {
111 die "Failed to bind interface ${ADDR}!"
116 function clean_environment () {
118 # Cleanup environment by removing topology containers and shared volumes
119 # and binding interfaces back to original driver.
122 # - DCR_UUIDS - Docker Container UUIDs.
123 # - DUT1_PCIDEVS - List of PCI addresses of devices of DUT1 container.
124 # - TG_PCIDEVS - List of PCI addresses of devices of TG container.
126 # - ADDR - PCI address of network interface.
127 # - DRIVER - Kernel driver.
131 # Kill docker containers.
132 docker rm --force "${DCR_UUIDS[@]}" || die "Cleanup containers failed!"
134 # Check if there are some leftover containers and remove all. Command will
135 # not fail in case there are no containers to remove.
136 docker rm --force $(docker ps -q --filter name=${DCR_UUIDS[dut1]}) || {
137 warn "Failed to remove hanged containers or nothing to remove!"
140 # Rebind interfaces back to kernel drivers.
141 for ADDR in ${TG_PCIDEVS[@]}; do
142 DRIVER="${TG_DRIVERS[0]}"
143 bind_interfaces_to_driver || die
145 for ADDR in ${DUT1_PCIDEVS[@]}; do
146 DRIVER="${DUT1_DRIVERS[0]}"
147 bind_interfaces_to_driver || die
152 function clean_environment_on_exit () {
154 # Cleanup environment by removing topology containers and binding
155 # interfaces back to original driver only if exit code is not 0.
156 # This function acts as workaround as 'set -eu' does not trigger ERR trap.
160 if [ $? -ne 0 ]; then
161 clean_environment || die
166 function deactivate_wrapper () {
168 # Acts as wrapper for deactivate docker topology.
171 # - ${@} - CSIT environment variables.
176 read_env_variables "${@}" || die
177 clean_environment || die
184 # Print the message to standard error end exit with error code specified
185 # by the second argument.
187 # Duplicate of common.sh function, as this file is also used standalone.
190 # - The default error message.
192 # - ${1} - The whole error message, be sure to quote. Optional
193 # - ${2} - the code to exit with, default: 1.
197 warn "${1:-Unspecified run-time error occurred!}"
202 function enter_mutex () {
204 # Enter mutual exclusion for protecting execution from starvation and
210 mutex_file="/tmp/mutex_file"
213 exec {lock_fd}>${mutex_file} || {
214 die "Mutex enter failed!"
216 flock --timeout "${mutex_timeout}" "${lock_fd}" || {
217 die "Calling flock() failed!"
219 # ----------------------
220 # Enter mutex succeeded.
221 warn "Mutex enter succeeded for PID $$."
225 function exit_mutex () {
227 # Exit mutual exclusion.
231 # ---------------------
232 # Remove mutex so we are not blocking others anymore.
233 flock -u "${lock_fd}" || {
234 die "Mutex destroy failed!"
236 warn "Mutex leave succeeded for PID $$."
240 function get_available_interfaces () {
242 # Find and get available Virtual functions.
245 # - ${1} - Nodeness, as set by common.sh get_test_code.
246 # - ${2} - Flavor, as set by common.sh get_test_code.
248 # - DUT1_NETDEVS - List of network devices allocated to DUT1 container.
249 # - DUT1_PCIDEVS - List of PCI addresses allocated to DUT1 container.
250 # - DUT1_NETMACS - List of MAC addresses allocated to DUT1 container.
251 # - DUT1_DRIVERS - List of interface drivers to DUT1 container.
252 # - TG_NETDEVS - List of network devices allocated to TG container.
253 # - TG_PCIDEVS - List of PCI addresses allocated to TG container.
254 # - TG_NETMACS - List of MAC addresses allocated to TG container.
255 # - TG_DRIVERS - List of interface drivers to TG container.
259 # Following code is specifing VFs ID based on nodeness and flavor.
260 # As there is great variability in hardware configuration outside LF,
261 # from bootstrap architecure point of view these are considered as flavors.
262 # Anyone can override flavor for its own machine and add condition here.
263 # See http://pci-ids.ucw.cz/v2.2/pci.ids for more info.
264 case_text="${1}_${2}"
265 case "${case_text}" in
267 # Add Intel Corporation XL710/X710 Virtual Function to the
274 # Add Intel Corporation XL710/X710 Virtual Function to the
277 tg_netdev=(enp5s2 enp5s3 enp5s4 enp5s5
278 enp5s6 enp5s7 enp5s8 enp5s9)
279 tg_netdev+=(enp5s10 enp5s11 enp5s12 enp5s13
280 enp5s14 enp5s15 enp5s16 enp5s17)
281 dut1_netdev=(enp145s2 enp145s3 enp145s4 enp145s5
282 enp145s6 enp145s7 enp145s8 enp145s9)
283 dut1_netdev+=(enp145s10 enp145s11 enp145s12 enp145s13
284 enp145s14 enp145s15 enp145s16 enp145s17)
287 # Add Intel Corporation 82545EM Gigabit Ethernet Controller to the
290 tg_netdev=(enp0s8 enp0s9)
291 dut1_netdev=(enp0s16 enp0s17)
294 die "Unknown specification: ${case_text}!"
299 # TG side of connections.
305 # DUT1 side of connections.
312 # Find the first ${device_count} number of available TG Linux network
313 # VF device names. Only allowed VF PCI IDs are filtered.
314 for netdev in ${tg_netdev[@]}
316 for netdev_path in $(grep -l "${pci_id}" \
317 /sys/class/net/${netdev}*/device/device \
320 if [[ ${#TG_NETDEVS[@]} -lt ${device_count} ]]; then
321 tg_netdev_name=$(dirname ${netdev_path})
322 tg_netdev_name=$(dirname ${tg_netdev_name})
323 TG_NETDEVS+=($(basename ${tg_netdev_name}))
328 if [[ ${#TG_NETDEVS[@]} -eq ${device_count} ]]; then
334 for netdev in "${TG_NETDEVS[@]}"; do
335 # Find the index of selected tg netdev among tg_netdevs
336 # e.g. enp8s5f7 is a vf of netdev enp8s5 with index 11
337 # and the corresponding dut1 netdev is enp133s13.
338 while [[ "${netdev}" != "${tg_netdev[$i]}"* ]]; do
341 # Rename tg netdev to dut1 netdev
342 # e.g. enp8s5f7 -> enp133s13f7
343 DUT1_NETDEVS+=(${netdev/${tg_netdev[$i]}/${dut1_netdev[$i]}})
344 # Don't need to reset i, all netdevs are sorted.
347 for NETDEV in "${TG_NETDEVS[@]}"; do
352 TG_PCIDEVS+=(${PCI_ADDR})
353 TG_NETMACS+=(${MAC_ADDR})
354 TG_DRIVERS+=(${KRN_DRIVER})
355 TG_VLANS+=(${VLAN_ID})
357 for NETDEV in "${DUT1_NETDEVS[@]}"; do
362 DUT1_PCIDEVS+=(${PCI_ADDR})
363 DUT1_NETMACS+=(${MAC_ADDR})
364 DUT1_DRIVERS+=(${KRN_DRIVER})
365 DUT1_VLANS+=(${VLAN_ID})
368 # We need at least two interfaces for TG/DUT1 for building topology.
369 if [ "${#TG_NETDEVS[@]}" -ne 2 ] || [ "${#DUT1_NETDEVS[@]}" -ne 2 ]; then
370 die "Not enough linux network interfaces found!"
372 if [ "${#TG_PCIDEVS[@]}" -ne 2 ] || [ "${#DUT1_PCIDEVS[@]}" -ne 2 ]; then
373 die "Not enough pci interfaces found!"
378 function get_krn_driver () {
380 # Get kernel driver from linux network device name.
383 # - PCI_ADDR - PCI address of network device.
385 # - KRN_DRIVER - Kernel driver of network device.
389 pci_path="/sys/bus/pci/devices/${PCI_ADDR}"
390 KRN_DRIVER="$(basename $(readlink -f ${pci_path}/driver))" || {
391 die "Failed to get kernel driver of PCI interface!"
396 function get_mac_addr () {
398 # Get MAC address from linux network device name.
401 # - NETDEV - Linux network device name.
403 # - MAC_ADDR - MAC address of network device.
407 if [ -d /sys/class/net/${NETDEV}/device ]; then
408 MAC_ADDR="$(</sys/class/net/${NETDEV}/address)" || {
409 die "Failed to get MAC address of linux network interface!"
415 function get_pci_addr () {
417 # Get PCI address in <domain>:<bus:<device>.<func> format from linux network
421 # - NETDEV - Linux network device name.
423 # - PCI_ADDR - PCI address of network device.
427 if [ -d /sys/class/net/${NETDEV}/device ]; then
428 PCI_ADDR=$(basename $(readlink /sys/class/net/${NETDEV}/device)) || {
429 die "Failed to get PCI address of linux network interface!"
432 if [ ! -d /sys/bus/pci/devices/${PCI_ADDR} ]; then
433 die "PCI device ${NETDEV} doesn't exist!"
438 function get_vlan_filter () {
440 # Get VLAN stripping filter from PF searched by mac adress.
443 # - MAC_ADDR - MAC address of VF.
445 # - VLAN_ID - VLAN ids.
449 # Sed regular expression pattern.
450 exp="s/^.*vlan ([[:digit:]]+).*$/\1/"
451 VLAN_ID=$(ip link | grep vlan | grep ${MAC_ADDR} | sed -re "${exp}") || true
452 VLAN_ID="${VLAN_ID:-0}"
456 function installed () {
458 # Check if the given utility is installed. Fail if not installed.
460 # Duplicate of common.sh function, as this file is also used standalone.
463 # - ${1} - Utility to check.
465 # - 0 - If command is installed.
466 # - 1 - If command is not installed.
474 function print_env_variables () {
476 # Get environment variables prefixed by CSIT_.
480 env | grep CSIT_ || true
484 function read_env_variables () {
486 # Read environment variables from parameters.
489 # - ${@} - Variables passed as an argument.
490 # Variables read, set or exported: Multiple,
491 # see the code for the current list.
492 # TODO: Do we need to list them and their meanings?
496 for param in "$@"; do
499 declare -gA DCR_UUIDS
500 DCR_UUIDS+=([tg]="${CSIT_TG_UUID}")
501 DCR_UUIDS+=([dut1]="${CSIT_DUT1_UUID}")
502 TG_PCIDEVS=("${CSIT_TG_INTERFACES_PORT1_PCI}")
503 TG_DRIVERS=("${CSIT_TG_INTERFACES_PORT1_DRV}")
504 TG_VLANS+=("${CSIT_TG_INTERFACES_PORT1_VLAN}")
505 TG_PCIDEVS+=("${CSIT_TG_INTERFACES_PORT2_PCI}")
506 TG_DRIVERS+=("${CSIT_TG_INTERFACES_PORT2_DRV}")
507 TG_VLANS+=("${CSIT_TG_INTERFACES_PORT2_VLAN}")
508 DUT1_PCIDEVS=("${CSIT_DUT1_INTERFACES_PORT1_PCI}")
509 DUT1_DRIVERS=("${CSIT_DUT1_INTERFACES_PORT1_DRV}")
510 DUT1_VLANS+=("${CSIT_DUT1_INTERFACES_PORT1_VLAN}")
511 DUT1_PCIDEVS+=("${CSIT_DUT1_INTERFACES_PORT2_PCI}")
512 DUT1_DRIVERS+=("${CSIT_DUT1_INTERFACES_PORT2_DRV}")
513 DUT1_VLANS+=("${CSIT_DUT1_INTERFACES_PORT2_VLAN}")
517 function set_env_variables () {
519 # Set environment variables.
522 # - DCR_UUIDS - Docker Container UUIDs.
523 # - DCR_PORTS - Docker Container's SSH ports.
524 # - DUT1_NETMACS - List of network devices MAC addresses of DUT1 container.
525 # - DUT1_PCIDEVS - List of PCI addresses of devices of DUT1 container.
526 # - DUT1_DRIVERS - List of interface drivers to DUT1 container.
527 # - TG_NETMACS - List of network devices MAC addresses of TG container.
528 # - TG_PCIDEVS - List of PCI addresses of devices of TG container.
529 # - TG_DRIVERS - List of interface drivers to TG container.
530 # Variables set: TODO.
535 CSIT_TG_HOST="$(hostname --all-ip-addresses | awk '{print $1}')" || {
536 die "Reading hostname IP address failed!"
538 CSIT_TG_PORT="${DCR_PORTS[tg]#*:}"
539 CSIT_TG_UUID="${DCR_UUIDS[tg]}"
540 CSIT_TG_ARCH="$(uname -i)" || {
541 die "Reading machine architecture failed!"
543 CSIT_DUT1_HOST="$(hostname --all-ip-addresses | awk '{print $1}')" || {
544 die "Reading hostname IP address failed!"
546 CSIT_DUT1_PORT="${DCR_PORTS[dut1]#*:}"
547 CSIT_DUT1_UUID="${DCR_UUIDS[dut1]}"
548 CSIT_DUT1_ARCH="$(uname -i)" || {
549 die "Reading machine architecture failed!"
551 CSIT_TG_INTERFACES_PORT1_MAC="${TG_NETMACS[0]}"
552 CSIT_TG_INTERFACES_PORT1_PCI="${TG_PCIDEVS[0]}"
553 CSIT_TG_INTERFACES_PORT1_DRV="${TG_DRIVERS[0]}"
554 CSIT_TG_INTERFACES_PORT1_VLAN="${TG_VLANS[0]}"
555 CSIT_TG_INTERFACES_PORT2_MAC="${TG_NETMACS[1]}"
556 CSIT_TG_INTERFACES_PORT2_PCI="${TG_PCIDEVS[1]}"
557 CSIT_TG_INTERFACES_PORT2_DRV="${TG_DRIVERS[1]}"
558 CSIT_TG_INTERFACES_PORT2_VLAN="${TG_VLANS[1]}"
559 CSIT_DUT1_INTERFACES_PORT1_MAC="${DUT1_NETMACS[0]}"
560 CSIT_DUT1_INTERFACES_PORT1_PCI="${DUT1_PCIDEVS[0]}"
561 CSIT_DUT1_INTERFACES_PORT1_DRV="${DUT1_DRIVERS[0]}"
562 CSIT_DUT1_INTERFACES_PORT1_VLAN="${DUT1_VLANS[0]}"
563 CSIT_DUT1_INTERFACES_PORT2_MAC="${DUT1_NETMACS[1]}"
564 CSIT_DUT1_INTERFACES_PORT2_PCI="${DUT1_PCIDEVS[1]}"
565 CSIT_DUT1_INTERFACES_PORT2_DRV="${DUT1_DRIVERS[1]}"
566 CSIT_DUT1_INTERFACES_PORT2_VLAN="${DUT1_VLANS[1]}"
571 function start_topology_containers () {
573 # Starts csit-sut-dcr docker containers for TG/DUT1.
576 # - CSIT_DIR - Path to existing root of local CSIT git repository.
578 # - DCR_UUIDS - Docker Container UUIDs.
579 # - DCR_PORTS - Docker Container SSH TCP ports.
580 # - DCR_CPIDS - Docker Container PIDs (namespaces).
584 if ! installed docker; then
585 die "Docker not present. Please install before continue!"
588 # If the IMAGE is not already loaded then docker run will pull the IMAGE,
589 # and all image dependencies, before it starts the container.
591 # Run the container in the background and print the new container ID.
592 dcr_stc_params="--detach=true "
593 # Give extended privileges to this container. A "privileged" container is
594 # given access to all devices and able to run nested containers.
595 dcr_stc_params+="--privileged "
596 # Publish all exposed ports to random ports on the host interfaces.
597 dcr_stc_params+="--publish-all "
598 # Automatically remove the container when it exits.
599 dcr_stc_params+="--rm "
601 dcr_stc_params+="--shm-size 512M "
602 # Override access to PCI bus by attaching a filesystem mount to the
604 dcr_stc_params+="--mount type=tmpfs,destination=/sys/bus/pci/devices "
605 # Mount vfio to be able to bind to see bound interfaces. We cannot use
606 # --device=/dev/vfio as this does not see newly bound interfaces.
607 dcr_stc_params+="--volume /dev/vfio:/dev/vfio "
608 # Mount docker.sock to be able to use docker deamon of the host.
609 dcr_stc_params+="--volume /var/run/docker.sock:/var/run/docker.sock "
610 # Mount /opt/boot/ where VM kernel and initrd are located.
611 dcr_stc_params+="--volume /opt/boot/:/opt/boot/ "
612 # Mount host hugepages for VMs.
613 dcr_stc_params+="--volume /dev/hugepages/:/dev/hugepages/ "
615 # Docker Container UUIDs.
616 declare -gA DCR_UUIDS
617 # Docker Container SSH TCP ports.
618 declare -gA DCR_PORTS
619 # Docker Container PIDs (namespaces).
620 declare -gA DCR_CPIDS
622 # Run TG and DUT1. As initial version we do support only 2-node.
623 params=(${dcr_stc_params} --name csit-tg-$(uuidgen) ${dcr_image})
624 DCR_UUIDS+=([tg]=$(docker run "${params[@]}")) || {
625 die "Failed to start TG docker container!"
627 params=(${dcr_stc_params} --name csit-dut1-$(uuidgen) ${dcr_image})
628 DCR_UUIDS+=([dut1]=$(docker run "${params[@]}")) || {
629 die "Failed to start DUT1 docker container!"
632 trap 'clean_environment_on_exit' EXIT || {
633 die "Trap attempt failed, please cleanup manually. Aborting!"
636 # Get Containers TCP ports.
637 params=(${DCR_UUIDS[tg]})
638 DCR_PORTS+=([tg]=$(docker port "${params[@]}")) || {
639 die "Failed to get port of TG docker container!"
641 params=(${DCR_UUIDS[dut1]})
642 DCR_PORTS+=([dut1]=$(docker port "${params[@]}")) || {
643 die "Failed to get port of DUT1 docker container!"
646 # Get Containers PIDs.
647 params=(--format="{{ .State.Pid }}" ${DCR_UUIDS[tg]})
648 DCR_CPIDS+=([tg]=$(docker inspect "${params[@]}")) || {
649 die "Failed to get PID of TG docker container!"
651 params=(--format="{{ .State.Pid }}" ${DCR_UUIDS[dut1]})
652 DCR_CPIDS+=([dut1]=$(docker inspect "${params[@]}")) || {
653 die "Failed to get PID of DUT1 docker container!"
658 # Print the message to standard error.
660 # Duplicate of common.sh function, as this file is also used standalone.
663 # - ${@} - The text of the message.