lisa.wlgen.rta.TaskGroupProperty

class lisa.wlgen.rta.TaskGroupProperty(path)

Bases: SimpleConcreteProperty

Task group property.

Parameters:

path (str) – Path of the taskgroup.

Only supported by rt-app for SCHED_OTHER and SCHED_IDLE for now.

Classes

__class__ inherited

Metaclass for properties.

Attributes

JSON_KEY	Name of the JSON key the property will set.
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	Configuration driving the JSON optimization, as a dict(str, set(str)).
REQUIRED_KCONFIG_KEYS	List of KCONFIG keys that need to be =Y on the target kernel for this property to be usable.
DEFAULT_JSON inherited	JSON value to use as a default.
FILTER_NONE inherited	If True, no JSON content will be generated when the property value is None.

Properties

json_key inherited	Name of the JSON key that will be set.
key inherited	Key of the instance.
logger inherited	Convenience short-hand for self.get_logger().
val inherited	Value “payload” of the property.

Methods

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

TaskGroupProperty.__class__

alias of PropertyMeta

Attributes

TaskGroupProperty.JSON_KEY = 'taskgroup'

Name of the JSON key the property will set.

Note

If it needs to be dynamically chose, see json_key.

TaskGroupProperty.KEY = 'taskgroup'

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.

TaskGroupProperty.OPTIMIZE_JSON_KEYS = {'taskgroup': {'policy'}}

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

This is a dictionary mapping JSON key names to set of “barrier” JSON keys. When successive phases of a given task share the same value for the keys of that dictionary, they will be removed in the later phases since rt-app settings are persistent across phases. When any of the barrier key listed in the set has a change in its value, it will be considered as an optimization barrier and the value will be set again, even if it means repeating the same value as earlier.

TaskGroupProperty.REQUIRED_KCONFIG_KEYS = ['CONFIG_CGROUP_SCHED']

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

TaskGroupProperty.DEFAULT_JSON = None

Inherited attribute, see lisa.wlgen.rta.SimpleConcreteProperty.DEFAULT_JSON

JSON value to use as a default.

TaskGroupProperty.FILTER_NONE = True

Inherited attribute, see lisa.wlgen.rta.SimpleConcreteProperty.FILTER_NONE

If True, no JSON content will be generated when the property value is None.

Properties

property TaskGroupProperty.json_key

Inherited property, see lisa.wlgen.rta.SimpleConcreteProperty.json_key

Name of the JSON key that will be set.

property TaskGroupProperty.key

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

Key of the instance.

property TaskGroupProperty.logger

Inherited property, see lisa.utils.Loggable.logger

Convenience short-hand for self.get_logger().

property TaskGroupProperty.val

Inherited property, see lisa.wlgen.rta.SimpleProperty.val

Value “payload” of the property.

Methods

TaskGroupProperty.HASH_COERCE(x, coerce)

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

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

TaskGroupProperty.__and__(other)

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

Combine two instances of the same property together.

classmethod TaskGroupProperty.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 TaskGroupProperty.find_cls(key)

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

Find which subclass can handle key.

classmethod TaskGroupProperty.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 TaskGroupProperty.get_logger(suffix=None)

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

Provides a logging.Logger named after cls.

classmethod TaskGroupProperty.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 TaskGroupProperty.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().

TaskGroupProperty.to_json(plat_info, **kwargs)

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

Snippet of JSON content for that property as Python objects.