def test_check_core_invalid(self, lib):
"Tests check_core() method when the given core is invalid."
def pqos_cpu_check_core_m(_p_cpu, core):
"Mock pqos_cpu_check_core()."
self.assertEqual(core, 99999)
return 1
lib.pqos_cap_get = MagicMock(return_value=0)
lib.pqos_cpu_check_core = MagicMock(side_effect=pqos_cpu_check_core_m)
cpu = PqosCpuInfo()
result = cpu.check_core(99999)
self.assertFalse(result)
lib.pqos_cpu_check_core.assert_called_once()
def test_check_core_invalid(self, lib):
"Tests check_core() method when the given core is invalid."
def pqos_cpu_check_core_m(_p_cpu, core):
"Mock pqos_cpu_check_core()."
self.assertEqual(core, 99999)
return 1
lib.pqos_cap_get = MagicMock(return_value=0)
lib.pqos_cpu_check_core = MagicMock(side_effect=pqos_cpu_check_core_m)
cpu = PqosCpuInfo()
result = cpu.check_core(99999)
self.assertFalse(result)
lib.pqos_cpu_check_core.assert_called_once()
class PqosApi:
"""
Wrapper for libpqos wrapper.
"""
def __init__(self):
self.pqos = Pqos()
self.cap = None
self.l3ca = None
self.mba = None
self.alloc = None
self.cpuinfo = None
def init(self):
"""
Initializes libpqos
Returns:
0 on success
-1 otherwise
"""
try:
self.pqos.init('MSR')
self.cap = PqosCap()
self.l3ca = PqosCatL3()
self.mba = PqosMba()
self.alloc = PqosAlloc()
self.cpuinfo = PqosCpuInfo()
except Exception as ex:
log.error(str(ex))
return -1
return 0
def fini(self):
"""
De-initializes libpqos
"""
self.pqos.fini()
return 0
def release(self, cores):
"""
Release cores, assigns cores to CoS#0
Parameters:
cores: list of cores to be released
Returns:
0 on success
-1 otherwise
"""
if cores is None:
return 0
try:
self.alloc.release(cores)
except Exception as ex:
log.error(str(ex))
return -1
return 0
def alloc_assoc_set(self, cores, cos):
"""
Assigns cores to CoS
Parameters:
cores: list of cores to be assigned to cos
cos: Class of Service
Returns:
0 on success
-1 otherwise
"""
if not cores:
return 0
try:
for core in cores:
self.alloc.assoc_set(core, cos)
except Exception as ex:
log.error(str(ex))
return -1
return 0
def l3ca_set(self, sockets, cos_id, ways_mask):
"""
Configures L3 CAT for CoS
Parameters:
sockets: sockets list on which to configure L3 CAT
cos_id: Class of Service
ways_mask: L3 CAT CBM to set
Returns:
0 on success
-1 otherwise
"""
try:
cos = self.l3ca.COS(cos_id, ways_mask)
for socket in sockets:
self.l3ca.set(socket, [cos])
except Exception as ex:
log.error(str(ex))
return -1
return 0
def mba_set(self, sockets, cos_id, mb_max):
"""
Configures MBA for CoS
Parameters:
sockets: sockets list on which to configure L3 CAT
cos_id: Class of Service
mb_max: MBA to set
Returns:
0 on success
-1 otherwise
"""
try:
cos = self.mba.COS(cos_id, mb_max)
for socket in sockets:
self.mba.set(socket, [cos])
except Exception as ex:
log.error(str(ex))
return -1
return 0
def is_mba_supported(self):
"""
Checks for MBA support
Returns:
1 if supported
0 otherwise
"""
try:
return self.get_mba_num_cos() != 0
except Exception as ex:
log.error(str(ex))
return 0
def is_l3_cat_supported(self):
"""
Checks for L3 CAT support
Returns:
1 if supported
0 otherwise
"""
try:
return self.get_l3ca_num_cos() != 0
except Exception as ex:
log.error(str(ex))
return 0
def is_multicore(self):
"""
Checks if system is multicore
Returns:
True if multicore
False otherwise
"""
return self.get_num_cores() > 1
def get_num_cores(self):
"""
Gets number of cores in system
Returns:
num of cores
0 otherwise
"""
try:
sockets = self.cpuinfo.get_sockets()
return sum([len(self.cpuinfo.get_cores(socket)) for socket in sockets])
except Exception as ex:
log.error(str(ex))
return None
def check_core(self, core):
"""
Verifies if a specified core is a valid logical core ID.
Parameters:
core: core ID
Returns:
True/False a given core number is valid/invalid
None otherwise
"""
try:
return self.cpuinfo.check_core(core)
except Exception as ex:
log.error(str(ex))
return None
def get_sockets(self):
"""
Gets list of sockets
Returns:
sockets list,
None otherwise
"""
try:
return self.cpuinfo.get_sockets()
except Exception as ex:
log.error(str(ex))
return None
def get_l3ca_num_cos(self):
"""
Gets number of COS for L3 CAT
Returns:
num of COS for L3 CAT
None otherwise
"""
try:
return self.cap.get_l3ca_cos_num()
except Exception as ex:
log.error(str(ex))
return None
def get_mba_num_cos(self):
"""
Gets number of COS for MBA
Returns:
num of COS for MBA
None otherwise
"""
try:
return self.cap.get_mba_cos_num()
except Exception as ex:
log.error(str(ex))
return None
def get_max_cos_id(self, alloc_type):
"""
Gets max COS# (id) that can be used to configure set of allocation technologies
Returns:
Available COS# to be used
None otherwise
"""
max_cos_num = None
max_cos_cat = self.get_l3ca_num_cos()
max_cos_mba = self.get_mba_num_cos()
if common.CAT_CAP not in alloc_type and common.MBA_CAP not in alloc_type:
return None
if common.CAT_CAP in alloc_type and not max_cos_cat:
return None
if common.MBA_CAP in alloc_type and not max_cos_mba:
return None
if common.CAT_CAP in alloc_type:
max_cos_num = max_cos_cat
if common.MBA_CAP in alloc_type:
if max_cos_num is not None:
max_cos_num = min(max_cos_mba, max_cos_num)
else:
max_cos_num = max_cos_mba
return max_cos_num - 1
def get_max_l3_cat_cbm(self):
"""
Gets Max L3 CAT CBM
Returns:
Max L3 CAT CBM
None otherwise
"""
if not self.is_l3_cat_supported():
return None
try:
l3ca_caps = self.cap.get_type("l3ca")
return 2**l3ca_caps.num_ways - 1
except Exception as ex:
log.error(str(ex))
return None
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
################################################################################
from pqos import Pqos
from pqos.cpuinfo import PqosCpuInfo
# Initialize PQoS library
pqos = Pqos()
pqos.init('MSR')
cpuinfo = PqosCpuInfo()
# Get number of sockets
sockets = cpuinfo.get_sockets()
print('Number of sockets: %d' % len(sockets))
# Get number of cores
num_cores = sum([len(cpuinfo.get_cores(socket)) for socket in sockets])
print('Number of cores: %d' % num_cores)
# Check if core 89 is a valid core
result = cpuinfo.check_core(89)
print('Is 89 a valid core? %s' % ('Yes' if result else 'No'))
# Finalize PQoS library
pqos.fini()
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
################################################################################
from pqos import Pqos
from pqos.cpuinfo import PqosCpuInfo
# Initialize PQoS library
pqos = Pqos()
pqos.init('MSR')
cpuinfo = PqosCpuInfo()
# Get number of sockets
sockets = cpuinfo.get_sockets()
print('Number of sockets: %d' % len(sockets))
# Get number of cores
num_cores = sum([len(cpuinfo.get_cores(socket)) for socket in sockets])
print('Number of cores: %d' % num_cores)
# Check if core 89 is a valid core
result = cpuinfo.check_core(89)
print('Is 89 a valid core? %s' % ('Yes' if result else 'No'))
# Finalize PQoS library
pqos.fini()
class PqosApi:
# pylint: disable=too-many-instance-attributes
"""
Wrapper for libpqos wrapper.
"""
def __init__(self):
self.pqos = Pqos()
self.cap = None
self.l3ca = None
self.mba = None
self.alloc = None
self.cpuinfo = None
self._supported_iface = []
# dict to share interface type and MBA BW status
# between REST API process and "backend"
self.shared_dict = common.MANAGER.dict()
self.shared_dict['current_iface'] = None
self.shared_dict['mba_bw_supported'] = None
self.shared_dict['mba_bw_enabled'] = None
def detect_supported_ifaces(self):
"""
Detects supported RDT interfaces
"""
for iface in ["msr", "os"]:
if not self.init(iface, True):
log.info("Interface %s, MBA BW: %ssupported."\
% (iface.upper(), "un" if not self.is_mba_bw_supported() else ""))
self.fini()
self._supported_iface.append(iface)
log.info("Supported RDT interfaces: " + str(self.supported_iface()))
def init(self, iface, force_iface=False):
"""
Initializes libpqos
Returns:
0 on success
-1 otherwise
"""
if not force_iface and not iface in self.supported_iface():
log.error("RDT does not support '%s' interface!" % (iface))
return -1
# deinitialize lib first
if self.shared_dict['current_iface']:
self.fini()
# umount restcrl to improve caps detection
if platform.system() == 'FreeBSD':
result = os.system(
"/sbin/umount -a -t resctrl") # nosec - string literal
else:
result = os.system(
"/bin/umount -a -t resctrl") # nosec - string literal
if result:
log.error("Failed to umount resctrl fs! status code: %d"\
% (os.WEXITSTATUS(result)))
return -1
# attempt to initialize libpqos
try:
self.pqos.init(iface.upper())
self.cap = PqosCap()
self.l3ca = PqosCatL3()
self.mba = PqosMba()
self.alloc = PqosAlloc()
self.cpuinfo = PqosCpuInfo()
except Exception as ex:
log.error(str(ex))
return -1
# save current interface type in shared dict
self.shared_dict['current_iface'] = iface
# Reread MBA BW status from libpqos
self.refresh_mba_bw_status()
return 0
def refresh_mba_bw_status(self):
"""
Reads MBA BW status from libpqos
and save results in shared dict
Returns:
0 on success
-1 otherwise
"""
try:
supported, enabled = self.cap.is_mba_ctrl_enabled()
# convert None to False
supported = bool(supported)
self.shared_dict['mba_bw_supported'] = supported
self.shared_dict['mba_bw_enabled'] = enabled
except Exception as ex:
log.error("libpqos is_mba_ctrl_enabled(..) call failed!")
log.error(str(ex))
return -1
return 0
def current_iface(self):
"""
Returns current RDT interface
Returns:
interface name on success
None when libpqos is not initialized
"""
return self.shared_dict['current_iface']
def supported_iface(self):
"""
Returns list of supported RDT interfaces
Returns:
list of supported interfaces
"""
# no need to keep it in shared dict as it does not changed
# during runtime.
return self._supported_iface
def is_mba_bw_supported(self):
"""
Returns MBA BW support status
Returns:
MBA BW support status
"""
return self.shared_dict['mba_bw_supported']
def is_mba_bw_enabled(self):
"""
Returns MBA BW enabled status
Returns:
MBA BW enabled status
"""
return self.shared_dict['mba_bw_enabled']
def enable_mba_bw(self, enable):
"""
Change MBA BW enabled status
Returns:
0 on success
-1 otherwise
"""
try:
# call libpqos alloc reset
self.alloc.reset("any", "any", "ctrl" if enable else "default")
except Exception as ex:
log.error("libpqos reset(..) call failed!")
log.error(str(ex))
return -1
# Reread MBA BW status from libpqos
self.refresh_mba_bw_status()
return 0
def fini(self):
"""
De-initializes libpqos
"""
self.pqos.fini()
self.shared_dict['current_iface'] = None
return 0
def release(self, cores):
"""
Release cores, assigns cores to CoS#0
Parameters:
cores: list of cores to be released
Returns:
0 on success
-1 otherwise
"""
if cores is None:
return 0
try:
self.alloc.release(cores)
except Exception as ex:
log.error(str(ex))
return -1
return 0
def alloc_assoc_set(self, cores, cos):
"""
Assigns cores to CoS
Parameters:
cores: list of cores to be assigned to cos
cos: Class of Service
Returns:
0 on success
-1 otherwise
"""
if not cores:
return 0
try:
for core in cores:
self.alloc.assoc_set(core, cos)
except Exception as ex:
log.error(str(ex))
return -1
return 0
def l3ca_set(self, sockets, cos_id, ways_mask):
"""
Configures L3 CAT for CoS
Parameters:
sockets: sockets list on which to configure L3 CAT
cos_id: Class of Service
ways_mask: L3 CAT CBM to set
Returns:
0 on success
-1 otherwise
"""
try:
cos = self.l3ca.COS(cos_id, ways_mask)
for socket in sockets:
self.l3ca.set(socket, [cos])
except Exception as ex:
log.error(str(ex))
return -1
return 0
def mba_set(self, sockets, cos_id, mb_max, ctrl=False):
"""
Configures MBA rate for CoS
Parameters:
sockets: sockets list on which to configure L3 CAT
cos_id: Class of Service
mb_max: MBA rate to set
Returns:
0 on success
-1 otherwise
"""
try:
cos = self.mba.COS(cos_id, mb_max, ctrl)
for socket in sockets:
self.mba.set(socket, [cos])
except Exception as ex:
log.error(str(ex))
return -1
return 0
def is_mba_supported(self):
"""
Checks for MBA support
Returns:
True if supported
False otherwise
"""
try:
return bool(self.get_mba_num_cos())
except Exception as ex:
log.error(str(ex))
return False
def is_l3_cat_supported(self):
"""
Checks for L3 CAT support
Returns:
True if supported
False otherwise
"""
try:
return bool(self.get_l3ca_num_cos())
except Exception as ex:
log.error(str(ex))
return False
def is_multicore(self):
"""
Checks if system is multicore
Returns:
True if multicore
False otherwise
"""
return self.get_num_cores() > 1
def get_num_cores(self):
"""
Gets number of cores in system
Returns:
num of cores
None otherwise
"""
try:
sockets = self.cpuinfo.get_sockets()
return sum(
[len(self.cpuinfo.get_cores(socket)) for socket in sockets])
except Exception as ex:
log.error(str(ex))
return None
def check_core(self, core):
"""
Verifies if a specified core is a valid logical core ID.
Parameters:
core: core ID
Returns:
True/False a given core number is valid/invalid
None otherwise
"""
try:
return self.cpuinfo.check_core(core)
except Exception as ex:
log.error(str(ex))
return None
def get_sockets(self):
"""
Gets list of sockets
Returns:
sockets list,
None otherwise
"""
try:
return self.cpuinfo.get_sockets()
except Exception as ex:
log.error(str(ex))
return None
def get_l3ca_num_cos(self):
"""
Gets number of COS for L3 CAT
Returns:
num of COS for L3 CAT
None otherwise
"""
try:
return self.cap.get_l3ca_cos_num()
except Exception as ex:
log.error(str(ex))
return None
def get_mba_num_cos(self):
"""
Gets number of COS for MBA
Returns:
num of COS for MBA
None otherwise
"""
try:
return self.cap.get_mba_cos_num()
except Exception as ex:
log.error(str(ex))
return None
def get_max_cos_id(self, alloc_type):
"""
Gets max COS# (id) that can be used to configure set of allocation technologies
Returns:
Available COS# to be used
None otherwise
"""
max_cos_num = None
max_cos_cat = self.get_l3ca_num_cos()
max_cos_mba = self.get_mba_num_cos()
if common.CAT_CAP not in alloc_type and common.MBA_CAP not in alloc_type:
return None
if common.CAT_CAP in alloc_type and not max_cos_cat:
return None
if common.MBA_CAP in alloc_type and not max_cos_mba:
return None
if common.CAT_CAP in alloc_type:
max_cos_num = max_cos_cat
if common.MBA_CAP in alloc_type:
if max_cos_num is not None:
max_cos_num = min(max_cos_mba, max_cos_num)
else:
max_cos_num = max_cos_mba
return max_cos_num - 1
def get_max_l3_cat_cbm(self):
"""
Gets Max L3 CAT CBM
Returns:
Max L3 CAT CBM
None otherwise
"""
if not self.is_l3_cat_supported():
return None
try:
l3ca_caps = self.cap.get_type("l3ca")
return 2**l3ca_caps.num_ways - 1
except Exception as ex:
log.error(str(ex))
return None