Optional parameters that can be passed from the active part to the runtime to be considered when creating the executable (task, thread, ect.) for the specific runtime. More...

#include <Imt.Base.Dff.Runtime/inc/Imt.Base.Dff.Runtime/ExecutableConfiguration.h>

Classes
struct	CoreAffinity
	Data type to pass the core affinity. More...

struct	StackSize
	Size type to pass the stack size. More...

struct	TimeSlice
	Size type to pass the time slice. More...

Public Types
using	CoreId = uint32_t
	A CoreId is used to indicate in which core the executable should run.

Public Member Functions
	ExecutableConfiguration ()
	Default constructor.

	ExecutableConfiguration (char_t const *const pName)
	Custom constructor to set the executable name only.

	ExecutableConfiguration (StackSize const exeStackSize)
	Custom constructor to set the stack size only.

	ExecutableConfiguration (TimeSlice const exeTimeSlice)
	Custom constructor to set the time slice only.

	ExecutableConfiguration (CoreAffinity const exeCoreAffinity)
	Custom constructor to set the core affinity only.

	ExecutableConfiguration (char_t const *const pName, StackSize const exeStackSize, TimeSlice const exeTimeSlice)
	Custom constructor to set all configuration parameters.

	ExecutableConfiguration (char_t const *const pName, StackSize const exeStackSize, TimeSlice const exeTimeSlice, CoreAffinity const exeCoreAffinity)
	Custom constructor to set all configuration parameters.

char_t const *	getName () const
	Get the requested name for the executable.

size_t	getStackSize () const
	Get the requested stack size for the executable.

uint32_t	getTimeSlice () const
	Get the requested time slice for the executable.

CoreId	getCoreAffinity () const
	Get the requested core affinity for the executable.

bool	isNameDefined () const
	Returns wether a name is defined for the executable.

bool	isStackSizeDefined () const
	Returns wether a stack size is defined for the executable.

bool	isTimeSliceDefined () const
	Returns wether a time slice is defined for the executable.

bool	isCoreAffinityDefined () const
	Returns whether a core affinity is defined for the executable.

Detailed Description

Optional parameters that can be passed from the active part to the runtime to be considered when creating the executable (task, thread, ect.) for the specific runtime.

If the runtime does not support a parameter it is ignored.

At the moment the folowing parameters are supported:

a name string that is passed to the runtime so that the executable can be identified in the debugger
the stack size in the unit used by the specific runtime (e.g. words or bytes)
a time slice for round-robin scheduling in the unit used by the specific runtime (e.g. milliseconds)

Based on future runtime implementations this could be extened in future releases of the DFF framework.

Todo:: Nested types could be replaced by std::optional (back port to C++14), see https://dev.azure.com/imtag/DFS/_workitems/edit/4722/

Definition at line 60 of file ExecutableConfiguration.h.

Member Typedef Documentation

◆ CoreId

using imt::base::dff::runtime::ExecutableConfiguration::CoreId = uint32_t

A CoreId is used to indicate in which core the executable should run.

Possible values are 0..n + 1. The last value implies any core affinity.

Definition at line 68 of file ExecutableConfiguration.h.

Constructor & Destructor Documentation

◆ ExecutableConfiguration() [1/7]

imt::base::dff::runtime::ExecutableConfiguration::ExecutableConfiguration ( )

Default constructor.

No parameter is defined.

◆ ExecutableConfiguration() [2/7]

imt::base::dff::runtime::ExecutableConfiguration::ExecutableConfiguration ( char_t const *const pName )

explicit

Custom constructor to set the executable name only.

Parameters

pName The name of the executable passed to the runtime as null terminated string.

◆ ExecutableConfiguration() [3/7]

imt::base::dff::runtime::ExecutableConfiguration::ExecutableConfiguration ( StackSize const exeStackSize )

explicit

Custom constructor to set the stack size only.

Parameters

exeStackSize The size of the stack for the executable in the size unit used by the runtime.

◆ ExecutableConfiguration() [4/7]

imt::base::dff::runtime::ExecutableConfiguration::ExecutableConfiguration ( TimeSlice const exeTimeSlice )

explicit

Custom constructor to set the time slice only.

Parameters

exeTimeSlice The time slice for the executable for round-robin scheduling in the size unit used by the runtime.

◆ ExecutableConfiguration() [5/7]

imt::base::dff::runtime::ExecutableConfiguration::ExecutableConfiguration ( CoreAffinity const exeCoreAffinity )

explicit

Custom constructor to set the core affinity only.

Parameters

exeCoreAffinity The core in which the executable should run in.

◆ ExecutableConfiguration() [6/7]

imt::base::dff::runtime::ExecutableConfiguration::ExecutableConfiguration	(	char_t const *const	pName,
		StackSize const	exeStackSize,
		TimeSlice const	exeTimeSlice
	)

Custom constructor to set all configuration parameters.

Parameters

pName	The name of the executable passed to the runtime as null terminated string.
exeStackSize	The size of the stack for the executable in the size unit used by the runtime.
exeTimeSlice	The time slice for the executable for round-robin scheduling in the size unit used by the runtime.

◆ ExecutableConfiguration() [7/7]

imt::base::dff::runtime::ExecutableConfiguration::ExecutableConfiguration	(	char_t const *const	pName,
		StackSize const	exeStackSize,
		TimeSlice const	exeTimeSlice,
		CoreAffinity const	exeCoreAffinity
	)

explicit

Custom constructor to set all configuration parameters.

Parameters

pName	The name of the executable passed to the runtime as null terminated string.
exeStackSize	The size of the stack for the executable in the size unit used by the runtime.
exeTimeSlice	The time slice for the executable for round-robin scheduling in the size unit used by the runtime.
exeCoreAffinity	The core in which the executable should run in.

Member Function Documentation

◆ getCoreAffinity()

CoreId imt::base::dff::runtime::ExecutableConfiguration::getCoreAffinity ( ) const

Get the requested core affinity for the executable.

Returns: The core affinity of the executable

◆ getName()

char_t const * imt::base::dff::runtime::ExecutableConfiguration::getName ( ) const

Get the requested name for the executable.

Returns a nullptr pointer when there is no name defined.

Returns: A pointer to a null terminated string or a null pointer.

◆ getStackSize()

size_t imt::base::dff::runtime::ExecutableConfiguration::getStackSize ( ) const

Get the requested stack size for the executable.

Returns 0 when there is no stack size defined.

Returns: The stack size in the size unit used by the runtime.

◆ getTimeSlice()

uint32_t imt::base::dff::runtime::ExecutableConfiguration::getTimeSlice ( ) const

Get the requested time slice for the executable.

Returns 0 when there is no time slice defined.

Returns: The time slice in the size unit used by the runtime.

◆ isCoreAffinityDefined()

bool imt::base::dff::runtime::ExecutableConfiguration::isCoreAffinityDefined ( ) const

Returns whether a core affinity is defined for the executable.

Returns: True if a core affinity is defined, false otherwise.

◆ isNameDefined()

bool imt::base::dff::runtime::ExecutableConfiguration::isNameDefined ( ) const

Returns wether a name is defined for the executable.

Returns: True if a name is defined, false otherwise.

◆ isStackSizeDefined()

bool imt::base::dff::runtime::ExecutableConfiguration::isStackSizeDefined ( ) const

Returns wether a stack size is defined for the executable.

Returns: True if a stack size is defined, false otherwise.

◆ isTimeSliceDefined()

bool imt::base::dff::runtime::ExecutableConfiguration::isTimeSliceDefined ( ) const

Returns wether a time slice is defined for the executable.

Returns: True if a time slice is defined, false otherwise.

The documentation for this class was generated from the following file:

C:/src/imt/Imt.Base-cpp/Imt.Base/Imt.Base.Dff.Runtime/inc/Imt.Base.Dff.Runtime/ExecutableConfiguration.h

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ CoreId

Constructor & Destructor Documentation

◆ ExecutableConfiguration() [1/7]

◆ ExecutableConfiguration() [2/7]

◆ ExecutableConfiguration() [3/7]

◆ ExecutableConfiguration() [4/7]

◆ ExecutableConfiguration() [5/7]

◆ ExecutableConfiguration() [6/7]

◆ ExecutableConfiguration() [7/7]

Member Function Documentation

◆ getCoreAffinity()

◆ getName()

◆ getStackSize()

◆ getTimeSlice()

◆ isCoreAffinityDefined()

◆ isNameDefined()

◆ isStackSizeDefined()

◆ isTimeSliceDefined()