def test_set(self, lib):
"Tests set() method."
def pqos_mba_set_mock(socket, num_cos, cos_arr, actual_arr):
"Mock pqos_mba_set()."
self.assertEqual(socket, 0)
self.assertEqual(num_cos, 1)
self.assertEqual(len(cos_arr), num_cos)
self.assertEqual(len(actual_arr), num_cos)
self.assertEqual(cos_arr[0].class_id, 1)
self.assertEqual(cos_arr[0].mb_max, 40)
self.assertEqual(cos_arr[0].ctrl, 0)
actual_arr[0].class_id = cos_arr[0].class_id
actual_arr[0].mb_max = 50
actual_arr[0].ctrl = cos_arr[0].ctrl
return 0
lib.pqos_mba_set = MagicMock(side_effect=pqos_mba_set_mock)
mba = PqosMba()
cos = mba.COS(1, 40)
actual = mba.set(0, [cos])
self.assertEqual(len(actual), 1)
self.assertEqual(actual[0].class_id, 1)
self.assertEqual(actual[0].mb_max, 50)
self.assertEqual(actual[0].ctrl, 0)
lib.pqos_mba_set.assert_called_once()
def test_set(self, lib):
"Tests set() method."
def pqos_mba_set_mock(socket, num_cos, cos_arr, actual_arr):
"Mock pqos_mba_set()."
self.assertEqual(socket, 0)
self.assertEqual(num_cos, 1)
self.assertEqual(len(cos_arr), num_cos)
self.assertEqual(len(actual_arr), num_cos)
self.assertEqual(cos_arr[0].class_id, 1)
self.assertEqual(cos_arr[0].mb_max, 40)
self.assertEqual(cos_arr[0].ctrl, 0)
actual_arr[0].class_id = cos_arr[0].class_id
actual_arr[0].mb_max = 50
actual_arr[0].ctrl = cos_arr[0].ctrl
return 0
lib.pqos_mba_set = MagicMock(side_effect=pqos_mba_set_mock)
mba = PqosMba()
cos = mba.COS(1, 40)
actual = mba.set(0, [cos])
self.assertEqual(len(actual), 1)
self.assertEqual(actual[0].class_id, 1)
self.assertEqual(actual[0].mb_max, 50)
self.assertEqual(actual[0].ctrl, 0)
lib.pqos_mba_set.assert_called_once()
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 test_get(self, lib):
"Tests get() method."
def pqos_mba_cos_num_mock(_p_cap, num_cos_ref):
"Mock pqos_mba_get_cos_num()."
ctypes_ref_set_int(num_cos_ref, 2)
return 0
def pqos_mba_get_mock(socket, max_num_cos, num_cos_ref, cos_arr):
"Mock pqos_mba_get()."
self.assertEqual(socket, 1)
self.assertEqual(max_num_cos, 2)
self.assertEqual(len(cos_arr), max_num_cos)
ctypes_ref_set_int(num_cos_ref, 2)
cos_arr[0].class_id = 0
cos_arr[0].mb_max = 4000
cos_arr[0].ctrl = 1
cos_arr[1].class_id = 1
cos_arr[1].mb_max = 8000
cos_arr[1].ctrl = 1
return 0
lib.pqos_cap_get = MagicMock(return_value=0)
lib.pqos_mba_get_cos_num = MagicMock(side_effect=pqos_mba_cos_num_mock)
lib.pqos_mba_get = MagicMock(side_effect=pqos_mba_get_mock)
mba = PqosMba()
coses = mba.get(1)
self.assertEqual(len(coses), 2)
self.assertEqual(coses[0].class_id, 0)
self.assertEqual(coses[0].mb_max, 4000)
self.assertTrue(coses[0].ctrl)
self.assertEqual(coses[1].class_id, 1)
self.assertEqual(coses[1].mb_max, 8000)
self.assertTrue(coses[1].ctrl)
lib.pqos_mba_get.assert_called_once()
lib.pqos_mba_get_cos_num.assert_called_once()
def test_get(self, lib):
"Tests get() method."
def pqos_mba_cos_num_mock(_p_cap, num_cos_ref):
"Mock pqos_mba_get_cos_num()."
ctypes_ref_set_int(num_cos_ref, 2)
return 0
def pqos_mba_get_mock(socket, max_num_cos, num_cos_ref, cos_arr):
"Mock pqos_mba_get()."
self.assertEqual(socket, 1)
self.assertEqual(max_num_cos, 2)
self.assertEqual(len(cos_arr), max_num_cos)
ctypes_ref_set_int(num_cos_ref, 2)
cos_arr[0].class_id = 0
cos_arr[0].mb_max = 4000
cos_arr[0].ctrl = 1
cos_arr[1].class_id = 1
cos_arr[1].mb_max = 8000
cos_arr[1].ctrl = 1
return 0
lib.pqos_cap_get = MagicMock(return_value=0)
lib.pqos_mba_get_cos_num = MagicMock(side_effect=pqos_mba_cos_num_mock)
lib.pqos_mba_get = MagicMock(side_effect=pqos_mba_get_mock)
mba = PqosMba()
coses = mba.get(1)
self.assertEqual(len(coses), 2)
self.assertEqual(coses[0].class_id, 0)
self.assertEqual(coses[0].mb_max, 4000)
self.assertTrue(coses[0].ctrl)
self.assertEqual(coses[1].class_id, 1)
self.assertEqual(coses[1].mb_max, 8000)
self.assertTrue(coses[1].ctrl)
lib.pqos_mba_get.assert_called_once()
lib.pqos_mba_get_cos_num.assert_called_once()
def set_allocation_class(sockets, class_id, mb_max):
"""
Sets up allocation classes of service on selected CPU sockets
Parameters:
sockets: array with socket IDs
class_id: class of service ID
mb_max: COS rate in percent
"""
mba = PqosMba()
cos = mba.COS(class_id, mb_max)
for socket in sockets:
try:
actual = mba.set(socket, [cos])
params = (socket, class_id, mb_max, actual[0].mb_max)
print("SKT%u: MBA COS%u => %u%% requested, %u%% applied" % params)
except:
print("Setting up cache allocation class of service failed!")
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 print_allocation_config(sockets):
"""
Prints allocation configuration.
Parameters:
sockets: array with socket IDs
"""
mba = PqosMba()
for socket in sockets:
try:
coses = mba.get(socket)
print("MBA COS definitions for Socket %u:" % socket)
for cos in coses:
cos_params = (cos.class_id, cos.mb_max)
print(" MBA COS%u => %u%% available" % cos_params)
except:
print("Error")
raise
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
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
pqos = Pqos()
pqos.init('OS')
# Check if MBA is supported
cap = PqosCap()
mba_supported = False
try:
cap.get_type('mba')
mba_supported = True
except:
pass
print('Is MBA supported? %s' % ('Yes' if mba_supported else 'No'))
if mba_supported:
mba = PqosMba()
# Get MBA configuration for socket 0
coses = mba.get(0)
print('MBA configuration for socket 0:')
for cos in coses:
print('COS: %d' % cos.class_id)
print('MB max: %d' % cos.mb_max)
print('CTRL: %s' % cos.ctrl)
print('')
# Configure MBA, 50% of available bandwidth for COS 0
cos = mba.COS(0, 50)
# Apply for socket 0
actual = mba.set(0, [cos])
pqos = Pqos()
pqos.init('OS')
# Check if MBA is supported
cap = PqosCap()
mba_supported = False
try:
cap.get_type('mba')
mba_supported = True
except:
pass
print('Is MBA supported? %s' % ('Yes' if mba_supported else 'No'))
if mba_supported:
mba = PqosMba()
# Get MBA configuration for socket 0
coses = mba.get(0)
print('MBA configuration for socket 0:')
for cos in coses:
print('COS: %d' % cos.class_id)
print('MB max: %d' % cos.mb_max)
print('CTRL: %s' % cos.ctrl)
print('')
# Configure MBA, 50% of available bandwidth for COS 0
cos = mba.COS(0, 50)
# Apply for socket 0
actual = mba.set(0, [cos])