#include <stdbool.h>

Classes
struct	option

struct	profile_info

Macros
#define	ADAPTYST_OK 0

#define	ADAPTYST_ERR_MODULE_NOT_FOUND 1

#define	ADAPTYST_ERR_OUT_OF_MEMORY 2

#define	ADAPTYST_ERR_EXCEPTION 3

#define	ADAPTYST_ERR_TERMINAL_NOT_INITIALISED 4

#define	ADAPTYST_ERR_LOG_DIR_CREATE 5

#define	ADAPTYST_ERR_INIT_ONLY 6

Typedefs
typedef unsigned int	amod_t

Enumerations
enum	option_type { INT = 1 , STRING = 2 , UNSIGNED_INT = 3 , BOOL = 4 , NONE = 0 }

enum	profile_type { LINUX_PROCESS = 0 }

Functions
option *	adaptyst_get_option (amod_t id, const char *key)

bool	adaptyst_set_error (amod_t id, const char *msg)

const char *	adaptyst_get_log_dir (amod_t id)

const char *	adaptyst_get_node_name (amod_t id)

bool	adaptyst_log (amod_t id, const char msg, const char type)

bool	adaptyst_print (amod_t id, const char msg, bool sub, bool error, const char type)

const char *	adaptyst_get_module_dir (amod_t id)

profile_info *	adaptyst_get_profile_info (amod_t id)

bool	adaptyst_set_profile_info (amod_t id, profile_info *info)

bool	adaptyst_is_directing_node (amod_t id)

bool	adaptyst_profile_notify (amod_t id)

int	adaptyst_profile_wait (amod_t id)

bool	adaptyst_process_src_paths (amod_t id, const char **paths, int n)

const char *	adaptyst_get_cpu_mask (amod_t id)

const char *	adaptyst_get_tmp_dir (amod_t id)

const char *	adaptyst_get_local_config_dir (amod_t id)

bool	adaptyst_set_will_profile (amod_t id, bool will_profile)

bool	adaptyst_has_in_tag (amod_t id, const char *tag)

bool	adaptyst_has_out_tag (amod_t id, const char *tag)

int	adaptyst_get_internal_error_code (amod_t id)

const char *	adaptyst_get_internal_error_msg (amod_t id)

Variables
amod_t	module_id

Macro Definition Documentation

◆ ADAPTYST_ERR_EXCEPTION

#define ADAPTYST_ERR_EXCEPTION 3

Error indicating that a C++ exception occurred on the Adaptyst side. Numerical value: 3

◆ ADAPTYST_ERR_INIT_ONLY

#define ADAPTYST_ERR_INIT_ONLY 6

Error indicating that an API method meant to be called inside adaptyst_module_init() only has been attempted to be called outside of adaptyst_module_init(). Numerical value: 6

◆ ADAPTYST_ERR_LOG_DIR_CREATE

#define ADAPTYST_ERR_LOG_DIR_CREATE 5

Error indicating that Adaptyst couldn't create log directories for the current performance analysis session. Numerical value: 5

◆ ADAPTYST_ERR_MODULE_NOT_FOUND

#define ADAPTYST_ERR_MODULE_NOT_FOUND 1

Error indicating that a module with the specified ID hasn't been found. Numerical value: 1

◆ ADAPTYST_ERR_OUT_OF_MEMORY

#define ADAPTYST_ERR_OUT_OF_MEMORY 2

Error indicating that there is no memory left. Numerical value: 2

◆ ADAPTYST_ERR_TERMINAL_NOT_INITIALISED

#define ADAPTYST_ERR_TERMINAL_NOT_INITIALISED 4

Error indicating that the terimnal-related resources in Adaptyst haven't been initialised yet. Numerical value: 4

◆ ADAPTYST_OK

#define ADAPTYST_OK 0

No error has occurred. Numerical value: 0

Typedef Documentation

◆ amod_t

typedef unsigned int amod_t

Enumeration Type Documentation

◆ option_type

enum option_type

Enum describing a value type of a module option.

Enumerator
INT	C: int
STRING	C: const char *
UNSIGNED_INT	C: unsigned int
BOOL	C: bool
NONE	No type.

◆ profile_type

enum profile_type

Enum describing workflow execution types.

Enumerator
LINUX_PROCESS	Workflow is executed as a Linux process.

Function Documentation

◆ adaptyst_get_cpu_mask()

const char * adaptyst_get_cpu_mask ( amod_t id )

Gets the CPU mask, which length is equal to the number of CPU cores and where the i-th char (indexing and core numbering from 1) can be either: 'b': the i-th core is for both workflow execution and performance analysis 'p': the i-th core is for performance analysis only 'c': the i-th core is for workflow execution only ' ': the i-th core is not used

This method can be called inside adaptyst_module_init() ONLY. Otherwise, an error will be thrown.

Parameters

id	The module ID (use module_id).

Returns: The CPU mask or a null pointer if the operation hasn't been successful.

◆ adaptyst_get_internal_error_code()

int adaptyst_get_internal_error_code ( amod_t id )

Gets the error code set by any of the Adaptyst API calls.

Parameters

id	The module ID (use module_id).

Returns: Error code or 0 if no error has occurred. See the ADAPTYST_OK and ADAPTYST_ERR_* definitions for possible error codes.

◆ adaptyst_get_internal_error_msg()

const char * adaptyst_get_internal_error_msg ( amod_t id )

Gets the error message set by any of the Adaptyst API calls.

Parameters

id	The module ID (use module_id).

Returns: Error message or a null pointer if no error has occurred.

◆ adaptyst_get_local_config_dir()

const char * adaptyst_get_local_config_dir ( amod_t id )

Gets the path to a directory where Adaptyst local configuration files are stored.

Parameters

id	The module ID (use module_id).

Returns: The path to the local config directory or a null pointer if the operation hasn't been successful.

◆ adaptyst_get_log_dir()

const char * adaptyst_get_log_dir ( amod_t id )

Gets the path to a directory where Adaptyst logs are stored.

Parameters

id	The module ID (use module_id).

Returns: The path to the Adaptyst log directory or a null pointer if the operation hasn't been successful.

◆ adaptyst_get_module_dir()

const char * adaptyst_get_module_dir ( amod_t id )

Gets the path to a directory where all module output files should be stored.

Parameters

id	The module ID (use module_id).

Returns: The path to the module output directory or a null pointer if the operation hasn't been successful.

◆ adaptyst_get_node_name()

const char * adaptyst_get_node_name ( amod_t id )

Gets the name of a node a module is attached to.

Parameters

id	The module ID (use module_id).

Returns: The name of the node or a null pointer if the operation hasn't been successful.

◆ adaptyst_get_option()

option * adaptyst_get_option	(	amod_t	id,
		const char *	key )

Gets a module option set by a user.

Parameters

id	The module ID (use module_id).
key	The name of an option to obtain.

Returns: Pointer to the option struct corresponding to an option with the given name or a null pointer if the option couldn't be found.

◆ adaptyst_get_profile_info()

profile_info * adaptyst_get_profile_info ( amod_t id )

Gets information necessary for profiling a workflow in form of a profile_info struct.

Parameters

id	The module ID (use module_id).

Returns: Pointer to the profile_info struct with profiling information or a null pointer if the operation hasn't been successful.

◆ adaptyst_get_tmp_dir()

const char * adaptyst_get_tmp_dir ( amod_t id )

Gets the path to a temporary directory.

Parameters

id	The module ID (use module_id).

Returns: The path to a temporary directory or a null pointer if the operation hasn't been successful.

◆ adaptyst_has_in_tag()

bool adaptyst_has_in_tag	(	amod_t	id,
		const char *	tag )

Checks whether any nodes connected to a node a module is attached to (i.e. any nodes with an edge to the module node) has a specific tag.

Parameters

id	The module ID (use module_id).
tag	Tag to check.

Returns: Whether any nodes connected to the node has the tag. If the operation hasn't been successful, false is returned.

◆ adaptyst_has_out_tag()

bool adaptyst_has_out_tag	(	amod_t	id,
		const char *	tag )

Checks whether any nodes a module node is connected to (i.e. any nodes with an edge from the module node) has a specific tag.

Parameters

id	The module ID (use module_id).
tag	Tag to check.

Returns: Whether any nodes the node is connected to has the tag. If the operation hasn't been successful, false is returned.

◆ adaptyst_is_directing_node()

bool adaptyst_is_directing_node ( amod_t id )

Returns whether a node a module is attached to is a directing node.

Returns: Whether the node is a directing node. If the operation hasn't been successful, false is returned.

◆ adaptyst_log()

bool adaptyst_log	(	amod_t	id,
		const char *	msg,
		const char *	type )

Prints an unformatted message of a given type to Adaptyst logs.

Parameters

id	The module ID (use module_id).
msg	Message to log.
type	Log type (use one of the types declared in log_types).

Returns: Whether the operation has been successful.

◆ adaptyst_print()

bool adaptyst_print	(	amod_t	id,
		const char *	msg,
		bool	sub,
		bool	error,
		const char *	type )

Prints a formatted message of a given type to Adaptyst logs, i.e. with a specific prefix indicating whether a message is a main one or a secondary one and whether a message is an error.

Parameters

id	The module ID (use module_id).
msg	Message to print.
sub	Whether a message is a secondary one (if true, "->" is printed before the message, otherwise "==>" is printed).
error	Whether a message is an error message.
type	Log type (use one of the types declared in log_types).

Returns: Whether the operation has been successful.

◆ adaptyst_process_src_paths()

bool adaptyst_process_src_paths	(	amod_t	id,
		const char **	paths,
		int	n )

Sends source code paths to Adaptyst for further processing (source code packing etc. is handled by Adaptyst, not modules).

Parameters

id	The module ID (use module_id).
paths	Array of source code paths.
n	Number of source code paths.

Returns: Whether the operation has been successful.

◆ adaptyst_profile_notify()

bool adaptyst_profile_notify ( amod_t id )

Sends a notification to Adaptyst that a module is ready to profile.

Parameters

id	The module ID (use module_id).

Returns: Whether the operation has been successful.

◆ adaptyst_profile_wait()

int adaptyst_profile_wait ( amod_t id )

Waits for a workflow executed by Adaptyst to finish running.

Parameters

id	The module ID (use module_id).

Returns: Exit code of the workflow or -1 if the operation hasn't been successful.

◆ adaptyst_set_error()

bool adaptyst_set_error	(	amod_t	id,
		const char *	msg )

Indicates to Adaptyst that a module error has occurred.

Parameters

id	The module ID (use module_id).
msg	Error message.

Returns: Whether the operation has been successful.

◆ adaptyst_set_profile_info()

bool adaptyst_set_profile_info	(	amod_t	id,
		profile_info *	info )

Sets information necessary for profiling a workflow in form of a profile_info struct. This function propagates information to all modules within an entity and is useful in case a module is in a directing node.

This method can be called inside adaptyst_module_init() ONLY. Otherwise, an error will be thrown.

Parameters

id	The module ID (use module_id).
info	Pointer to a profile_info struct with profiling information to be set.

Returns: Whether the operation has been successful.

◆ adaptyst_set_will_profile()

bool adaptyst_set_will_profile	(	amod_t	id,
		bool	will_profile )

Indicates to Adaptyst whether a module will profile a workflow. By default, Adaptyst assumes that modules do not profile.

This method can be called inside adaptyst_module_init() ONLY. Otherwise, an error will be thrown.

Parameters

id	The module ID (use module_id).
will_profile	Whether a module will profile a workflow.

Returns: Whether the operation has been successful.

Variable Documentation

◆ module_id

amod_t module_id

extern

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ ADAPTYST_ERR_EXCEPTION

◆ ADAPTYST_ERR_INIT_ONLY

◆ ADAPTYST_ERR_LOG_DIR_CREATE

◆ ADAPTYST_ERR_MODULE_NOT_FOUND

◆ ADAPTYST_ERR_OUT_OF_MEMORY

◆ ADAPTYST_ERR_TERMINAL_NOT_INITIALISED

◆ ADAPTYST_OK

Typedef Documentation

◆ amod_t

Enumeration Type Documentation

◆ option_type

◆ profile_type

Function Documentation

◆ adaptyst_get_cpu_mask()

◆ adaptyst_get_internal_error_code()

◆ adaptyst_get_internal_error_msg()

◆ adaptyst_get_local_config_dir()

◆ adaptyst_get_log_dir()

◆ adaptyst_get_module_dir()

◆ adaptyst_get_node_name()

◆ adaptyst_get_option()

◆ adaptyst_get_profile_info()

◆ adaptyst_get_tmp_dir()

◆ adaptyst_has_in_tag()

◆ adaptyst_has_out_tag()

◆ adaptyst_is_directing_node()

◆ adaptyst_log()

◆ adaptyst_print()

◆ adaptyst_process_src_paths()

◆ adaptyst_profile_notify()

◆ adaptyst_profile_wait()

◆ adaptyst_set_error()

◆ adaptyst_set_profile_info()

◆ adaptyst_set_will_profile()

Variable Documentation

◆ module_id