lisa.wlgen.rta.WloadPropertyBase

class lisa.wlgen.rta.WloadPropertyBase

Bases: ConcretePropertyBase

Phase workload.

Workloads are a sequence of rt-app events such as run.

Classes

__class__ inherited

Metaclass for properties.

Attributes

JSON_KEY
KEY	Subclasses can override this attribute so that PropertyBase.from_key() knows that it can call their _from_key() method for that key.
OPTIMIZE_JSON_KEYS inherited	Configuration driving the JSON optimization, as a dict(str, set(str)).
REQUIRED_KCONFIG_KEYS inherited	List of KCONFIG keys that need to be =Y on the target kernel for this property to be usable.

Properties

val	Value “payload” of the property.
key inherited	Key of the instance.
logger inherited	Convenience short-hand for self.get_logger().

Methods

__add__()	Adding two workloads together concatenates them.
__await__()
__mul__()	Replicate the given workload n times.
__rmul__()
to_events()
HASH_COERCE() inherited	Used to coerce the values of self.__dict__ to hashable values.
__and__() inherited	Combine two instances of the same property together.
check_kconfig() inherited	Check whether plat_info contains the kernel KCONFIG keys contained in REQUIRED_KCONFIG_KEYS.
find_cls() inherited	Find which subclass can handle key.
from_key() inherited	Alternative constructor that is available with the same signature for all properties.
get_logger() inherited	Provides a logging.Logger named after cls.
log_locals() inherited	Debugging aid: log the local variables of the calling function.
to_default_json() inherited	Similar to to_json() but returns the default values for the keys set in to_json().
to_json() inherited	Snippet of JSON content for that property as Python objects.

Classes

WloadPropertyBase.__class__

alias of PropertyMeta

Attributes

WloadPropertyBase.JSON_KEY = 'events'

WloadPropertyBase.KEY = 'wload'

Subclasses can override this attribute so that PropertyBase.from_key() knows that it can call their _from_key() method for that key.

Note

This class attribute will not be inherited automatically so that each class can be uniquely identified by its key. Subclass that do not override the value explicitly will get None.

WloadPropertyBase.OPTIMIZE_JSON_KEYS = {}

Inherited attribute, see lisa.wlgen.rta.ConcretePropertyBase.OPTIMIZE_JSON_KEYS

Configuration driving the JSON optimization, as a dict(str, set(str)).

WloadPropertyBase.REQUIRED_KCONFIG_KEYS = []

Inherited attribute, see lisa.wlgen.rta.ConcretePropertyBase.REQUIRED_KCONFIG_KEYS

List of KCONFIG keys that need to be =Y on the target kernel for this property to be usable.

Properties

property WloadPropertyBase.val

Value “payload” of the property.

Ideally, it should be a valid value that can be given to from_key(), but it’s not mandatory. For complex properties that are not isomorphic to a Python basic type (int, tuple etc.), self should be returned.

property WloadPropertyBase.key

Inherited property, see lisa.wlgen.rta.PropertyBase.key

Key of the instance.

property WloadPropertyBase.logger

Inherited property, see lisa.utils.Loggable.logger

Convenience short-hand for self.get_logger().

Methods

WloadPropertyBase.__add__(other)

Adding two workloads together concatenates them.

Note

Any subclass implementation of __add__ must be associative, i.e. a+(b+c) == (a+b)+c. This property is relied on.

WloadPropertyBase.__await__()

WloadPropertyBase.__mul__(n)

Replicate the given workload n times.

WloadPropertyBase.__rmul__(n)

abstract WloadPropertyBase.to_events(**kwargs)

WloadPropertyBase.HASH_COERCE(x, coerce)

Inherited method, see lisa.utils.SimpleHash.HASH_COERCE()

Used to coerce the values of self.__dict__ to hashable values.

abstract WloadPropertyBase.__and__(other)

Inherited method, see lisa.wlgen.rta.PropertyBase.__and__()

Combine two instances of the same property together.

classmethod WloadPropertyBase.check_kconfig(plat_info, strict=True)

Inherited method, see lisa.wlgen.rta.ConcretePropertyBase.check_kconfig()

Check whether plat_info contains the kernel KCONFIG keys contained in REQUIRED_KCONFIG_KEYS.

classmethod WloadPropertyBase.find_cls(key)

Inherited method, see lisa.wlgen.rta.PropertyBase.find_cls()

Find which subclass can handle key.

classmethod WloadPropertyBase.from_key(key, val)

Inherited method, see lisa.wlgen.rta.PropertyBase.from_key()

Alternative constructor that is available with the same signature for all properties.

classmethod WloadPropertyBase.get_logger(suffix=None)

Inherited method, see lisa.utils.Loggable.get_logger()

Provides a logging.Logger named after cls.

classmethod WloadPropertyBase.log_locals(var_names=None, level='debug')

Inherited method, see lisa.utils.Loggable.log_locals()

Debugging aid: log the local variables of the calling function.

classmethod WloadPropertyBase.to_default_json(plat_info, properties)

Inherited method, see lisa.wlgen.rta.ConcretePropertyBase.to_default_json()

Similar to to_json() but returns the default values for the keys set in to_json().

WloadPropertyBase.to_json(plat_info, **kwargs)

Inherited method, see lisa.wlgen.rta.ConcretePropertyBase.to_json()

Snippet of JSON content for that property as Python objects.