OS API. ModuleID = 0. More...

Macros
#define	OSAPI_LOG_GET_NEXT_OBJECT_ID (1)
	Retrieving the next error code failed.
#define	OSAPI_LOG_SYSTEM_SET_PROPERTY (2)
	An error occured while setting the system properties.
#define	OSAPI_LOG_SYSTEM_TIMER_START (4)
	An error occured when starting the system timer.
#define	OSAPI_LOG_SYSTEM_TIMER_STOP (5)
	An error occured when stopping the system timer.
#define	OSAPI_LOG_THREAD_NEW (6)
	An error when allocating the a thread object.
#define	OSAPI_LOG_THREAD_CREATE (7)
	An error when creating the a thread object.
#define	OSAPI_LOG_THREAD_SEM (8)
	An error when creating thread sync semaphore.
#define	OSAPI_LOG_THREAD_EXEC_CREATE (9)
	Failed to signal that a thread has been created.
#define	OSAPI_LOG_THREAD_EXEC_START (10)
	Failed to signal the start a created thread.
#define	OSAPI_LOG_THREAD_START (11)
	Failed to start a thread.
#define	OSAPI_LOG_THREAD_DESTROY (12)
	Failed to destroy a thread.
#define	OSAPI_LOG_THREAD_DESTROY_NO_START (13)
	Failed to start an unstarted thread being destroyed.
#define	OSAPI_LOG_THREAD_DESTROY_NO_WAKEUP (14)
	Failed wakeup of a thread being destroyed.
#define	OSAPI_LOG_THREAD_INIT (15)
	Failed initializing a thread.
#define	OSAPI_LOG_THREAD_SCHEDPARAM (16)
	Failed to set scheduling policy of a thread.
#define	OSAPI_LOG_THREAD_GET_POLICY (17)
	Failed to get the scheduling policy of a thread.
#define	OSAPI_LOG_THREAD_POLICY_DIFFER (18)
	Mismatch of scheduling policy of a created thread and the application thread.
#define	OSAPI_LOG_THREAD_PRIORITY_MAP (19)
	Failed to map to native thread priority values.
#define	OSAPI_LOG_TIMER_DELETE (20)
	Failed to delete the Timer object.
#define	OSAPI_LOG_TIMER_TICK_MUTEX (22)
	Failed taking or giving the Timer mutex.
#define	OSAPI_LOG_TIMER_GET_USER_DATA_EPOCH (27)
	Failed to return user data for a timeout due to mismatched epochs.
#define	OSAPI_LOG_TIMER_NEW (28)
	Failed to allocate memory for a new Timer.
#define	OSAPI_LOG_TIMER_NEW_ENTRY (29)
	Failed to allocate memory for a new Timer entry.
#define	OSAPI_LOG_TIMER_NEW_WHEEL (30)
	Failed to allocate memory for a new Timer wheel.
#define	OSAPI_LOG_TIMER_NEW_MUTEX (31)
	Failed to create a new Timer mutex.
#define	OSAPI_LOG_TIMER_NEW_START_TIMER (32)
	Failed to start a new Timer being created.
#define	OSAPI_LOG_TIMER_DELETE_STOP_TIMER (33)
	Failed to stop a Timer being deleted.
#define	OSAPI_LOG_TIMER_DELETE_MUTEX (34)
	Failed to delete the Timer mutex.
#define	OSAPI_LOG_TIMER_MUTEX (35)
	Failed to take or give a Timer mutex.
#define	OSAPI_LOG_SEMAPHORE_DELETE (36)
	Failed to delete a semaphore.
#define	OSAPI_LOG_SEMAPHORE_NEW (37)
	Failed to create a semaphore.
#define	OSAPI_LOG_SEMAPHORE_NEW_INIT (38)
	Failed to initialize a new semaphore.
#define	OSAPI_LOG_SEMAPHORE_GIVE (39)
	Failed to give a semaphore.
#define	OSAPI_LOG_SEMAPHORE_TAKE (40)
	Failed to take a semaphore.
#define	OSAPI_LOG_MUTEX_DELETE (41)
	Failed to delete a mutex.
#define	OSAPI_LOG_MUTEX_NEW (42)
	Failed to create a mutex.
#define	OSAPI_LOG_MUTEX_TAKE (43)
	Failed to take a mutex.
#define	OSAPI_LOG_MUTEX_GIVE (44)
	Failed to give a mutex.
#define	OSAPI_LOG_MUTEX_INIT (45)
	Failed to initialize a mutex.
#define	OSAPI_LOG_HEAP_INTERNAL_ALLOCATE (46)
	Failed to allocate a buffer from the heap.
#define	OSAPI_LOG_SYSTEM_GET_TIME (48)
	Failed to get current system time.
#define	OSAPI_LOG_LAST_RECORDED_ERROR (49)
	Return the last recorded error-code for the calling thread.

Detailed Description

OS API. ModuleID = 0.

The logging API provides a number of functions for logging different types of events. There are 3 types of events:

info - This type is for informational purposes

warning - This type does not necessarily cause any functional behavior, but could indicate an unexpected situation has been handled or performance could be affected.

error - This indicated an error condition that has functional impact and could not be dealt with.

Each log message has a header using the following format:

 *   1   2       13            16
 * %+--------------------------------+
 * %|x| type | module   | error_code |
 * %|--------------------------------+
 * %|MN|FN|LN|F|  resvd  |  length   |
 * %|--------------------------------+
 * %|  line number (LN=1)            |
 * %|--------------------------------+
 * %|  module name (MN=1)            |
 * %|--------------------------------+
 * %|  function name (FN=1)          |
 * %|--------------------------------+
 * %|  format (F=1)                  |
 * %|--------------------------------+
 * %|  payload (F=1)                 |
 * %|--------------------------------+
 *

4 bits for length of payload, in 32-bit ints
4 bits for message type (error, warning, etc)
8 bits for module
1 bit for extended format (not in use)
15 bits for error code

Example Log Header: 0x1203005d

length: 0x1 one parameter
type: 0x2 RTI Error
module: 0x03 DDS_C module
X=0: Not extended format
error code: 0x005d LOG_FAIL_CREATE_PUBLISHER_TABLE

Macro Definition Documentation

#define OSAPI_LOG_GET_NEXT_OBJECT_ID (1)

Retrieving the next error code failed.

#define OSAPI_LOG_SYSTEM_SET_PROPERTY (2)

An error occured while setting the system properties.

#define OSAPI_LOG_SYSTEM_TIMER_START (4)

An error occured when starting the system timer.

#define OSAPI_LOG_SYSTEM_TIMER_STOP (5)

An error occured when stopping the system timer.

#define OSAPI_LOG_THREAD_NEW (6)

An error when allocating the a thread object.

#define OSAPI_LOG_THREAD_CREATE (7)

An error when creating the a thread object.

#define OSAPI_LOG_THREAD_SEM (8)

An error when creating thread sync semaphore.

#define OSAPI_LOG_THREAD_EXEC_CREATE (9)

Failed to signal that a thread has been created.

#define OSAPI_LOG_THREAD_EXEC_START (10)

Failed to signal the start a created thread.

#define OSAPI_LOG_THREAD_START (11)

Failed to start a thread.

#define OSAPI_LOG_THREAD_DESTROY (12)

Failed to destroy a thread.

#define OSAPI_LOG_THREAD_DESTROY_NO_START (13)

Failed to start an unstarted thread being destroyed.

#define OSAPI_LOG_THREAD_DESTROY_NO_WAKEUP (14)

Failed wakeup of a thread being destroyed.

#define OSAPI_LOG_THREAD_INIT (15)

Failed initializing a thread.

#define OSAPI_LOG_THREAD_SCHEDPARAM (16)

Failed to set scheduling policy of a thread.

#define OSAPI_LOG_THREAD_GET_POLICY (17)

Failed to get the scheduling policy of a thread.

#define OSAPI_LOG_THREAD_POLICY_DIFFER (18)

Mismatch of scheduling policy of a created thread and the application thread.

#define OSAPI_LOG_THREAD_PRIORITY_MAP (19)

Failed to map to native thread priority values.

#define OSAPI_LOG_TIMER_DELETE (20)

Failed to delete the Timer object.

#define OSAPI_LOG_TIMER_TICK_MUTEX (22)

Failed taking or giving the Timer mutex.

#define OSAPI_LOG_TIMER_GET_USER_DATA_EPOCH (27)

Failed to return user data for a timeout due to mismatched epochs.

#define OSAPI_LOG_TIMER_NEW (28)

Failed to allocate memory for a new Timer.

#define OSAPI_LOG_TIMER_NEW_ENTRY (29)

Failed to allocate memory for a new Timer entry.

#define OSAPI_LOG_TIMER_NEW_WHEEL (30)

Failed to allocate memory for a new Timer wheel.

#define OSAPI_LOG_TIMER_NEW_MUTEX (31)

Failed to create a new Timer mutex.

#define OSAPI_LOG_TIMER_NEW_START_TIMER (32)

Failed to start a new Timer being created.

#define OSAPI_LOG_TIMER_DELETE_STOP_TIMER (33)

Failed to stop a Timer being deleted.

#define OSAPI_LOG_TIMER_DELETE_MUTEX (34)

Failed to delete the Timer mutex.

#define OSAPI_LOG_TIMER_MUTEX (35)

Failed to take or give a Timer mutex.

#define OSAPI_LOG_SEMAPHORE_DELETE (36)

Failed to delete a semaphore.

#define OSAPI_LOG_SEMAPHORE_NEW (37)

Failed to create a semaphore.

#define OSAPI_LOG_SEMAPHORE_NEW_INIT (38)

Failed to initialize a new semaphore.

#define OSAPI_LOG_SEMAPHORE_GIVE (39)

Failed to give a semaphore.

#define OSAPI_LOG_SEMAPHORE_TAKE (40)

Failed to take a semaphore.

#define OSAPI_LOG_MUTEX_DELETE (41)

Failed to delete a mutex.

#define OSAPI_LOG_MUTEX_NEW (42)

Failed to create a mutex.

#define OSAPI_LOG_MUTEX_TAKE (43)

Failed to take a mutex.

#define OSAPI_LOG_MUTEX_GIVE (44)

Failed to give a mutex.

#define OSAPI_LOG_MUTEX_INIT (45)

Failed to initialize a mutex.

#define OSAPI_LOG_HEAP_INTERNAL_ALLOCATE (46)

Failed to allocate a buffer from the heap.

#define OSAPI_LOG_SYSTEM_GET_TIME (48)

Failed to get current system time.

#define OSAPI_LOG_LAST_RECORDED_ERROR (49)

Return the last recorded error-code for the calling thread.

This log-messages retrieves the last recorded error-code for the calling thread. It is used a function calls another function that fails.

Macros

Detailed Description

Macro Definition Documentation