alf_init

NAME

alf_init - Initializes the ALF runtime.

SYNOPSIS

int alf_init(void* p_sys_config_info, alf_handle_t* p_alf_handle);

Parameters  
p_sys_config_info [IN] A platform-dependent configuration information placeholder so that the ALF runtime can get the necessary data for system configuration information.
This parameter should point to sys_config_info_CBEA_t data structure. This data structure is defined as follows:
typedef struct {
	  	char* library_path;
	} alf_sys_config_t_CBEA_t;
p_alf_handle [OUT] A pointer to a handle for a data structure that represents the ALF runtime. This buffer is initialized with proper data if the call is successful. Otherwise, the content is not modified.

DESCRIPTION

This function initializes the ALF runtime. It allocates the necessary resources and global data for ALF as well as sets up any platform specific configurations.

RETURN VALUE

>= 0 Successful, the result of the query
less than 0 Errors:
  • ALF_ERR_INVAL: Invalid input parameter
  • ALF_ERR_NODATA: Some system configuration data is not available
  • ALF_ERR_NOMEM: Out of memory or some system resources have been used up
  • ALF_ERR_GENERIC: Generic internal errors

OPTIONS

Field value  
library_path The path to all of the application's computational kernel shared object files. If the pointer is NULL, the ALF_LIBRARY_PATH environment variable is checked and if it is defined then it is used. If neither is set, the default "." (the current directory) is used.
Related reference
alf_handle_t
alf_query_system_info
alf_num_instances_set
alf_exit
alf_error_handler_register
ALF_ERR_POLICY_T