# # Copyright(c) 2019 Intel Corporation # SPDX-License-Identifier: BSD-3-Clause-Clear # from .cli import * from .casctl import stop as casctl_stop from core.test_run import TestRun from .casadm_params import * from api.cas.cache_config import CacheLineSize, CacheMode, SeqCutOffPolicy, CleaningPolicy from test_utils.size import Size, Unit from typing import List from storage_devices.device import Device from api.cas.core import Core from api.cas.cache import Cache def help(shortcut: bool = False): return TestRun.executor.run(help_cmd(shortcut)) def start_cache(cache_dev: Device, cache_mode: CacheMode = None, cache_line_size: CacheLineSize = None, cache_id: int = None, force: bool = False, load: bool = False, shortcut: bool = False): _cache_line_size = None if cache_line_size is None else str( CacheLineSize.get_value(Unit.KibiByte)) _cache_id = None if cache_id is None else str(cache_id) _cache_mode = None if cache_mode is None else cache_mode.name.lower() output = TestRun.executor.run(start_cmd( cache_dev=cache_dev.system_path, cache_mode=_cache_mode, cache_line_size=_cache_line_size, cache_id=_cache_id, force=force, load=load, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Failed to start cache. stdout: {output.stdout} \n stderr :{output.stderr}") return Cache(cache_dev.system_path) def stop_cache(cache_id: int, no_data_flush: bool = False, shortcut: bool = False): output = TestRun.executor.run( stop_cmd(cache_id=str(cache_id), no_data_flush=no_data_flush, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Failed to stop cache. stdout: {output.stdout} \n stderr :{output.stderr}") return output def add_core(cache: Cache, core_dev: Device, core_id: int = None, shortcut: bool = False): _core_id = None if core_id is None else str(id) output = TestRun.executor.run( add_core_cmd(cache_id=str(cache.cache_id), core_dev=core_dev.system_path, core_id=_core_id, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Failed to add core. stdout: {output.stdout} \n stderr :{output.stderr}") return Core(core_dev.system_path, cache.cache_id) def remove_core(cache_id: int, core_id: int, force: bool = False, shortcut: bool = False): output = TestRun.executor.run( remove_core_cmd(cache_id=str(cache_id), core_id=str(core_id), force=force, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Failed to remove core. stdout: {output.stdout} \n stderr :{output.stderr}") def remove_detached(core_device: Device, shortcut: bool = False): output = TestRun.executor.run( remove_detached_cmd(core_device=core_device.system_path, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Failed to remove detached core. stdout: {output.stdout} \n stderr :{output.stderr}") return output def reset_counters(cache_id: int, core_id: int = None, shortcut: bool = False): _core_id = None if core_id is None else str(core_id) output = TestRun.executor.run( reset_counters_cmd(cache_id=str(cache_id), core_id=_core_id, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Failed to reset counters. stdout: {output.stdout} \n stderr :{output.stderr}") return output def flush(cache_id: int, core_id: int = None, shortcut: bool = False): if core_id is None: command = flush_cache_cmd(cache_id=str(cache_id), shortcut=shortcut) else: command = flush_core_cmd(cache_id=str(cache_id), core_id=str(core_id), shortcut=shortcut) output = TestRun.executor.run(command) if output.exit_code != 0: raise Exception( f"Flushing failed. stdout: {output.stdout} \n stderr :{output.stderr}") return output def load_cache(device: Device, shortcut: bool = False): output = TestRun.executor.run( load_cmd(cache_dev=device.system_path, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Failed to load cache. stdout: {output.stdout} \n stderr :{output.stderr}") return Cache(device.system_path) def list_caches(output_format: OutputFormat = None, shortcut: bool = False): _output_format = None if output_format is None else output_format.name output = TestRun.executor.run( list_cmd(output_format=_output_format, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Failed to list caches. stdout: {output.stdout} \n stderr :{output.stderr}") return output def print_version(output_format: OutputFormat = None, shortcut: bool = False): _output_format = None if output_format is None else output_format.name output = TestRun.executor.run( version_cmd(output_format=_output_format, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Failed to print version. stdout: {output.stdout} \n stderr :{output.stderr}") return output def format_nvme(cache_dev: Device, force: bool = False, shortcut: bool = False): output = TestRun.executor.run( format_cmd(cache_dev=cache_dev.system_path, force=force, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Format command failed. stdout: {output.stdout} \n stderr :{output.stderr}") return output def stop_all_caches(): if "No caches running" in list_caches().stdout: return TestRun.LOGGER.info("Stop all caches") casctl_stop() output = list_caches() if "No caches running" not in output.stdout: raise Exception( f"Error while stopping caches. stdout: {output.stdout} \n stderr :{output.stderr}") def print_statistics(cache_id: int, core_id: int = None, per_io_class: bool = False, io_class_id: int = None, filter: List[StatsFilter] = None, output_format: OutputFormat = None, shortcut: bool = False): _output_format = None if output_format is None else output_format.name _core_id = None if core_id is None else str(core_id) _io_class_id = None if io_class_id is None else str(io_class_id) if filter is None: _filter = filter else: names = (x.name for x in filter) _filter = ",".join(names) output = TestRun.executor.run( print_statistics_cmd( cache_id=str(cache_id), core_id=_core_id, per_io_class=per_io_class, io_class_id=_io_class_id, filter=_filter, output_format=_output_format, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Printing statistics failed. stdout: {output.stdout} \n stderr :{output.stderr}") return output def set_cache_mode(cache_mode: CacheMode, cache_id: int, flush: bool = True, shortcut: bool = False): flush_cache = None if cache_mode in [CacheMode.WB, CacheMode.WO]: flush_cache = "yes" if flush else "no" output = TestRun.executor.run( set_cache_mode_cmd(cache_mode=cache_mode.name.lower(), cache_id=str(cache_id), flush_cache=flush_cache, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Set cache mode command failed. stdout: {output.stdout} \n stderr :{output.stderr}") return output def load_io_classes(cache_id: int, file: str, shortcut: bool = False): output = TestRun.executor.run( load_io_classes_cmd(cache_id=str(cache_id), file=file, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Load IO class command failed. stdout: {output.stdout} \n stderr :{output.stderr}") return output def list_io_classes(cache_id: int, output_format: OutputFormat, shortcut: bool = False): _output_format = None if output_format is None else output_format.name output = TestRun.executor.run( list_io_classes_cmd(cache_id=str(cache_id), output_format=_output_format, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"List IO class command failed. stdout: {output.stdout} \n stderr :{output.stderr}") return output def get_param_cutoff(cache_id: int, core_id: int, output_format: OutputFormat = None, shortcut: bool = False): _output_format = None if output_format is None else output_format.name output = TestRun.executor.run( get_param_cutoff_cmd(cache_id=str(cache_id), core_id=str(core_id), output_format=_output_format, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Getting sequential cutoff params failed." f" stdout: {output.stdout} \n stderr :{output.stderr}") return output def get_param_cleaning(cache_id: int, output_format: OutputFormat = None, shortcut: bool = False): _output_format = None if output_format is None else output_format.name output = TestRun.executor.run( get_param_cleaning_cmd(cache_id=str(cache_id), output_format=_output_format, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Getting cleaning policy params failed." f" stdout: {output.stdout} \n stderr :{output.stderr}") return output def get_param_cleaning_alru(cache_id: int, output_format: OutputFormat = None, shortcut: bool = False): _output_format = None if output_format is None else output_format.name output = TestRun.executor.run( get_param_cleaning_alru_cmd(cache_id=str(cache_id), output_format=_output_format, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Getting alru cleaning policy params failed." f" stdout: {output.stdout} \n stderr :{output.stderr}") return output def get_param_cleaning_acp(cache_id: int, output_format: OutputFormat = None, shortcut: bool = False): _output_format = None if output_format is None else output_format.name output = TestRun.executor.run( get_param_cleaning_acp_cmd(cache_id=str(cache_id), output_format=_output_format, shortcut=shortcut)) if output.exit_code != 0: raise Exception( f"Getting acp cleaning policy params failed." f" stdout: {output.stdout} \n stderr :{output.stderr}") return output def set_param_cutoff(cache_id: int, core_id: int = None, threshold: Size = None, policy: SeqCutOffPolicy = None): _threshold = None if threshold is None else threshold.get_value(Unit.KibiByte) if core_id is None: command = set_param_cutoff_cmd( cache_id=str(cache_id), threshold=_threshold, policy=policy.name) else: command = set_param_cutoff_cmd( cache_id=str(cache_id), core_id=str(core_id), threshold=_threshold, policy=policy.name) output = TestRun.executor.run(command) if output.exit_code != 0: raise Exception( f"Error while setting sequential cut-off params." f" stdout: {output.stdout} \n stderr :{output.stderr}") return output def set_param_cleaning(cache_id: int, policy: CleaningPolicy): output = TestRun.executor.run( set_param_cleaning_cmd(cache_id=str(cache_id), policy=policy.name)) if output.exit_code != 0: raise Exception( f"Error while setting cleaning policy." f" stdout: {output.stdout} \n stderr :{output.stderr}") return output def set_param_cleaning_alru(cache_id: int, wake_up: int = None, staleness_time: int = None, flush_max_buffers: int = None, activity_threshold: int = None): output = TestRun.executor.run( set_param_cleaning_alru_cmd( cache_id=str(cache_id), wake_up=str(wake_up), staleness_time=str(staleness_time), flush_max_buffers=str(flush_max_buffers), activity_threshold=str(activity_threshold))) if output.exit_code != 0: raise Exception( f"Error while setting alru cleaning policy parameters." f" stdout: {output.stdout} \n stderr :{output.stderr}") return output def set_param_cleaning_acp(cache_id: int, wake_up: int = None, flush_max_buffers: int = None): output = TestRun.executor.run( set_param_cleaning_acp_cmd(cache_id=str(cache_id), wake_up=str(wake_up), flush_max_buffers=str(flush_max_buffers))) if output.exit_code != 0: raise Exception( f"Error while setting acp cleaning policy parameters." f" stdout: {output.stdout} \n stderr :{output.stderr}") return output