ONLP
Open Network Linux Platform APIs
Data Structures | Macros | Typedefs | Functions | Variables
Compile Time Configuration

Data Structures

struct  onlp_config_settings_s
 

Macros

#define ONLP_CONFIG_INCLUDE_LOGGING   1
 
#define ONLP_CONFIG_LOG_OPTIONS_DEFAULT   AIM_LOG_OPTIONS_DEFAULT
 
#define ONLP_CONFIG_LOG_BITS_DEFAULT   AIM_LOG_BITS_DEFAULT
 
#define ONLP_CONFIG_LOG_CUSTOM_BITS_DEFAULT   0
 
#define ONLP_CONFIG_PORTING_STDLIB   1
 
#define ONLP_CONFIG_PORTING_INCLUDE_STDLIB_HEADERS   ONLP_CONFIG_PORTING_STDLIB
 
#define ONLP_CONFIG_INCLUDE_UCLI   0
 
#define ONLP_CONFIG_INCLUDE_PLATFORM_ERROR_CHECK   1
 
#define ONLP_CONFIG_INCLUDE_SHLOCK_GLOBAL_INIT   0
 
#define ONLP_CONFIG_PLATFORM_NAME   NULL
 
#define ONLP_CONFIG_PLATFORM_FILENAME   "/etc/onl/platform"
 
#define ONLP_CONFIG_INCLUDE_PLATFORM_OVERRIDES   1
 
#define ONLP_CONFIG_CONFIGURATION_FILENAME   "/etc/onlp.conf"
 
#define ONLP_CONFIG_CONFIGURATION_ENV   "ONLP_CONF"
 
#define ONLP_CONFIG_INCLUDE_API_LOCK   1
 
#define ONLP_CONFIG_API_LOCK_GLOBAL_SHARED   1
 
#define ONLP_CONFIG_API_LOCK_TIMEOUT   60000000
 
#define ONLP_CONFIG_INFO_STR_MAX   64
 
#define ONLP_CONFIG_INCLUDE_THERMAL_THRESHOLDS   0
 
#define ONLP_CONFIG_INCLUDE_API_PROFILING   0
 

Typedefs

typedef struct onlp_config_settings_s onlp_config_settings_t
 

Functions

const char * onlp_config_lookup (const char *setting)
 Lookup a configuration setting. More...
 
int onlp_config_show (struct aim_pvs_s *pvs)
 Show the compile-time configuration. More...
 

Variables

onlp_config_settings_t onlp_config_settings []
 

Detailed Description

Macro Definition Documentation

◆ ONLP_CONFIG_API_LOCK_GLOBAL_SHARED

#define ONLP_CONFIG_API_LOCK_GLOBAL_SHARED   1

ONLP_CONFIG_API_LOCK_GLOBAL_SHARED

If 0, the API lock is a simple semaphore. If 1, the API lock is a global shared mutex.

◆ ONLP_CONFIG_API_LOCK_TIMEOUT

#define ONLP_CONFIG_API_LOCK_TIMEOUT   60000000

ONLP_CONFIG_API_LOCK_TIMEOUT

The maximum amount of time (in usecs) to wait while attempting to acquire the API lock. Failure to acquire is fatal. A value of zero disables this feature.

◆ ONLP_CONFIG_CONFIGURATION_ENV

#define ONLP_CONFIG_CONFIGURATION_ENV   "ONLP_CONF"

ONLP_CONFIG_CONFIGURATION_ENV

Environment variable to check for configuration filenames. Overrides default.

◆ ONLP_CONFIG_CONFIGURATION_FILENAME

#define ONLP_CONFIG_CONFIGURATION_FILENAME   "/etc/onlp.conf"

ONLP_CONFIG_CONFIGURATION_FILENAME

The filename for the (optional) ONLP JSON configuration file.

◆ ONLP_CONFIG_INCLUDE_API_LOCK

#define ONLP_CONFIG_INCLUDE_API_LOCK   1

ONLP_CONFIG_INCLUDE_API_LOCK

Include exclusive locking for all API calls.

◆ ONLP_CONFIG_INCLUDE_API_PROFILING

#define ONLP_CONFIG_INCLUDE_API_PROFILING   0

ONLP_CONFIG_INCLUDE_API_PROFILING

Include API timing profiles.

◆ ONLP_CONFIG_INCLUDE_LOGGING

#define ONLP_CONFIG_INCLUDE_LOGGING   1

ONLP_CONFIG_INCLUDE_LOGGING

Include or exclude logging.

◆ ONLP_CONFIG_INCLUDE_PLATFORM_ERROR_CHECK

#define ONLP_CONFIG_INCLUDE_PLATFORM_ERROR_CHECK   1

ONLP_CONFIG_INCLUDE_PLATFORM_ERROR_CHECK

Include platform error checking at initialization.

◆ ONLP_CONFIG_INCLUDE_PLATFORM_OVERRIDES

#define ONLP_CONFIG_INCLUDE_PLATFORM_OVERRIDES   1

ONLP_CONFIG_INCLUDE_PLATFORM_OVERRIDES

Allow support for local overrides of all platform OID values (testing).

◆ ONLP_CONFIG_INCLUDE_SHLOCK_GLOBAL_INIT

#define ONLP_CONFIG_INCLUDE_SHLOCK_GLOBAL_INIT   0

ONLP_CONFIG_INCLUDE_SHLOCK_GLOBAL_INIT

Include global shlock initialization at module init time.

◆ ONLP_CONFIG_INCLUDE_THERMAL_THRESHOLDS

#define ONLP_CONFIG_INCLUDE_THERMAL_THRESHOLDS   0

ONLP_CONFIG_INCLUDE_THERMAL_THRESHOLDS

Include thermal threshold reporting.

◆ ONLP_CONFIG_INCLUDE_UCLI

#define ONLP_CONFIG_INCLUDE_UCLI   0

ONLP_CONFIG_INCLUDE_UCLI

Include generic uCli support.

◆ ONLP_CONFIG_INFO_STR_MAX

#define ONLP_CONFIG_INFO_STR_MAX   64

ONLP_CONFIG_INFO_STR_MAX

The maximum size of static information string buffers.

◆ ONLP_CONFIG_LOG_BITS_DEFAULT

#define ONLP_CONFIG_LOG_BITS_DEFAULT   AIM_LOG_BITS_DEFAULT

ONLP_CONFIG_LOG_BITS_DEFAULT

Default enabled log bits.

◆ ONLP_CONFIG_LOG_CUSTOM_BITS_DEFAULT

#define ONLP_CONFIG_LOG_CUSTOM_BITS_DEFAULT   0

ONLP_CONFIG_LOG_CUSTOM_BITS_DEFAULT

Default enabled custom log bits.

◆ ONLP_CONFIG_LOG_OPTIONS_DEFAULT

#define ONLP_CONFIG_LOG_OPTIONS_DEFAULT   AIM_LOG_OPTIONS_DEFAULT

ONLP_CONFIG_LOG_OPTIONS_DEFAULT

Default enabled log options.

◆ ONLP_CONFIG_PLATFORM_FILENAME

#define ONLP_CONFIG_PLATFORM_FILENAME   "/etc/onl/platform"

ONLP_CONFIG_PLATFORM_FILENAME

The local filename containing the current platform identifier.

◆ ONLP_CONFIG_PLATFORM_NAME

#define ONLP_CONFIG_PLATFORM_NAME   NULL

ONLP_CONFIG_PLATFORM_NAME

Static platform configuration.

◆ ONLP_CONFIG_PORTING_INCLUDE_STDLIB_HEADERS

#define ONLP_CONFIG_PORTING_INCLUDE_STDLIB_HEADERS   ONLP_CONFIG_PORTING_STDLIB

ONLP_CONFIG_PORTING_INCLUDE_STDLIB_HEADERS

Include standard library headers for stdlib porting macros.

◆ ONLP_CONFIG_PORTING_STDLIB

#define ONLP_CONFIG_PORTING_STDLIB   1

ONLP_CONFIG_PORTING_STDLIB

Default all porting macros to use the C standard libraries.

Typedef Documentation

◆ onlp_config_settings_t

All compile time options can be queried or displayedConfiguration settings structure.

Function Documentation

◆ onlp_config_lookup()

const char* onlp_config_lookup ( const char *  setting)

Lookup a configuration setting.

Parameters
settingThe name of the configuration option to lookup.

◆ onlp_config_show()

int onlp_config_show ( struct aim_pvs_s *  pvs)

Show the compile-time configuration.

Parameters
pvsThe output stream.

Variable Documentation

◆ onlp_config_settings

onlp_config_settings_t onlp_config_settings[]

Configuration settings table. onlp_config_settings table.