aboutsummaryrefslogtreecommitdiffstats
path: root/resources/libraries/python/QATUtil.py
blob: 34a8e3b8d966c46a5689c2159dc16b623d95569d (plain)
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
# Copyright (c) 2023 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.

"""QAT util library."""

from resources.libraries.python.DUTSetup import DUTSetup
from resources.libraries.python.topology import Topology
from resources.libraries.python.VPPUtil import VPPUtil


class QATUtil:
    """Contains methods for setting up QATs."""

    @staticmethod
    def crypto_device_verify(node, crypto_type, numvfs, force_init=True):
        """Verify if Crypto QAT device virtual functions are initialized on all
        DUTs. If parameter force initialization is set to True, then try to
        initialize or remove VFs on QAT.

        :param node: DUT node.
        :crypto_type: Crypto device type - HW_DH895xcc, HW_C3xxx, HW_C4xxx
                      or HW_4xxx.
        :param numvfs: Number of VFs to initialize, 0 - disable the VFs.
        :param force_init: If True then try to initialize to specific value.
        :type node: dict
        :type crypto_type: string
        :type numvfs: int
        :type force_init: bool
        :returns: nothing
        :raises RuntimeError: If QAT VFs are not created and force init is set
                              to False.
        """
        pci_addr = Topology.get_cryptodev(node)

        if force_init:
            # QAT is not initialized and we want to initialize with numvfs.
            QATUtil.crypto_device_init(node, crypto_type, numvfs)
        else:
            raise RuntimeError(
                f"QAT device failed to create VFs on {node[u'host']}"
            )

        # QAT VF devices must be re-bound to vfio-pci driver before use.
        pci_addr = Topology.get_cryptodev(node)
        for i in range(numvfs):
            DUTSetup.pci_vf_driver_unbind(node, pci_addr, i)
            DUTSetup.pci_vf_driver_bind(node, pci_addr, i, "vfio-pci")

    @staticmethod
    def crypto_device_init(node, crypto_type, numvfs):
        """Init Crypto QAT device virtual functions on DUT.

        :param node: DUT node.
        :crypto_type: Crypto device type - HW_DH895xcc, HW_C3xxx, HW_C4xxx
                      or HW_4xxx.
        :param numvfs: Number of VFs to initialize, 0 - disable the VFs.
        :type node: dict
        :type crypto_type: string
        :type numvfs: int
        :returns: nothing
        :raises RuntimeError: If failed to stop VPP or QAT failed to initialize.
        """
        if crypto_type == u"HW_DH895xcc":
            kernel_mod = u"qat_dh895xcc"
            kernel_drv = u"dh895xcc"
        elif crypto_type == u"HW_C3xxx":
            kernel_mod = u"qat_c3xxx"
            kernel_drv = u"c3xxx"
        elif crypto_type == u"HW_C4xxx":
            kernel_mod = u"qat_c4xxx"
            kernel_drv = u"c4xxx"
        elif crypto_type == u"HW_4xxx":
            kernel_mod = u"qat_4xxx"
            kernel_drv = u"4xxx"
        else:
            raise RuntimeError(
                f"Unsupported crypto device type on {node[u'host']}"
            )

        pci_addr = Topology.get_cryptodev(node)

        # QAT device must be re-bound to kernel driver before initialization.
        DUTSetup.verify_kernel_module(node, kernel_mod, force_load=True)

        # Stop VPP to prevent deadlock.
        VPPUtil.stop_vpp_service(node)

        current_driver = DUTSetup.get_pci_dev_driver(
            node, pci_addr.replace(u":", r"\:")
        )
        if current_driver is not None:
            DUTSetup.pci_driver_unbind(node, pci_addr)

        # Bind to kernel driver.
        DUTSetup.pci_driver_bind(node, pci_addr, kernel_drv)

        # Initialize QAT VFs.
        if numvfs > 0:
            DUTSetup.set_sriov_numvfs(node, pci_addr, numvfs)