SAI Metadata
Loading...
Searching...
No Matches
SAI - Metadata Logger Definitions

Macros

#define SAI_META_LOG(loglevel, format, ...)
 Helper log macro definition.
 
#define SAI_META_LOG_ENTER()   SAI_META_LOG(SAI_LOG_LEVEL_DEBUG, ":> enter");
 
#define SAI_META_LOG_DEBUG(format, ...)   SAI_META_LOG(SAI_LOG_LEVEL_DEBUG, ":- " format, ##__VA_ARGS__)
 
#define SAI_META_LOG_INFO(format, ...)   SAI_META_LOG(SAI_LOG_LEVEL_INFO, ":- " format, ##__VA_ARGS__)
 
#define SAI_META_LOG_NOTICE(format, ...)   SAI_META_LOG(SAI_LOG_LEVEL_NOTICE, ":- " format, ##__VA_ARGS__)
 
#define SAI_META_LOG_WARN(format, ...)   SAI_META_LOG(SAI_LOG_LEVEL_WARN, ":- " format, ##__VA_ARGS__)
 
#define SAI_META_LOG_ERROR(format, ...)   SAI_META_LOG(SAI_LOG_LEVEL_ERROR, ":- " format, ##__VA_ARGS__)
 
#define SAI_META_LOG_CRITICAL(format, ...)   SAI_META_LOG(SAI_LOG_LEVEL_CRITICAL, ":- " format, ##__VA_ARGS__)
 
#define SAI_META_LOG_EXIT()   SAI_META_LOG(SAI_LOG_LEVEL_DEBUG, ":< exit");
 

Typedefs

typedef void(* sai_metadata_log_fn) (_In_ sai_log_level_t log_level, _In_ const char *file, _In_ int line, _In_ const char *function, _In_ const char *format, _In_ ...)
 Log level function definition.
 

Variables

volatile sai_metadata_log_fn sai_metadata_log
 User specified log function.
 
volatile sai_log_level_t sai_metadata_log_level
 Log level for SAI metadata macros.
 

Detailed Description

Macro Definition Documentation

◆ SAI_META_LOG

#define SAI_META_LOG (   loglevel,
  format,
  ... 
)
Value:
if (loglevel >= sai_metadata_log_level) \
{ \
if (sai_metadata_log == NULL) /* or syslog? */ \
fprintf(stderr, "%s:%d %s: " format "\n", __FILE__, __LINE__, __func__, ##__VA_ARGS__); \
else \
sai_metadata_log(loglevel, __FILE__, __LINE__, __func__, format, ##__VA_ARGS__); \
}
volatile sai_metadata_log_fn sai_metadata_log
User specified log function.
volatile sai_log_level_t sai_metadata_log_level
Log level for SAI metadata macros.

Helper log macro definition.

If logger function is NULL, stderr is used to print messages. Also, fprintf function will validate parameters at compilation time.

Definition at line 77 of file saimetadatalogger.h.

◆ SAI_META_LOG_CRITICAL

#define SAI_META_LOG_CRITICAL (   format,
  ... 
)    SAI_META_LOG(SAI_LOG_LEVEL_CRITICAL, ":- " format, ##__VA_ARGS__)

Definition at line 96 of file saimetadatalogger.h.

◆ SAI_META_LOG_DEBUG

#define SAI_META_LOG_DEBUG (   format,
  ... 
)    SAI_META_LOG(SAI_LOG_LEVEL_DEBUG, ":- " format, ##__VA_ARGS__)

Definition at line 91 of file saimetadatalogger.h.

◆ SAI_META_LOG_ENTER

#define SAI_META_LOG_ENTER ( )    SAI_META_LOG(SAI_LOG_LEVEL_DEBUG, ":> enter");

Definition at line 90 of file saimetadatalogger.h.

◆ SAI_META_LOG_ERROR

#define SAI_META_LOG_ERROR (   format,
  ... 
)    SAI_META_LOG(SAI_LOG_LEVEL_ERROR, ":- " format, ##__VA_ARGS__)

Definition at line 95 of file saimetadatalogger.h.

◆ SAI_META_LOG_EXIT

#define SAI_META_LOG_EXIT ( )    SAI_META_LOG(SAI_LOG_LEVEL_DEBUG, ":< exit");

Definition at line 97 of file saimetadatalogger.h.

◆ SAI_META_LOG_INFO

#define SAI_META_LOG_INFO (   format,
  ... 
)    SAI_META_LOG(SAI_LOG_LEVEL_INFO, ":- " format, ##__VA_ARGS__)

Definition at line 92 of file saimetadatalogger.h.

◆ SAI_META_LOG_NOTICE

#define SAI_META_LOG_NOTICE (   format,
  ... 
)    SAI_META_LOG(SAI_LOG_LEVEL_NOTICE, ":- " format, ##__VA_ARGS__)

Definition at line 93 of file saimetadatalogger.h.

◆ SAI_META_LOG_WARN

#define SAI_META_LOG_WARN (   format,
  ... 
)    SAI_META_LOG(SAI_LOG_LEVEL_WARN, ":- " format, ##__VA_ARGS__)

Definition at line 94 of file saimetadatalogger.h.

Typedef Documentation

◆ sai_metadata_log_fn

typedef void(* sai_metadata_log_fn) (_In_ sai_log_level_t log_level, _In_ const char *file, _In_ int line, _In_ const char *function, _In_ const char *format, _In_ ...)

Log level function definition.

User can specify his own function that will be called when message log level will be greater or equal to sai_metadata_log_level.

Parameters
[in]log_levelLog level
[in]fileSource file
[in]lineLine number in file
[in]functionFunction name
[in]formatFormat of logging
[in]...Variable parameters

Definition at line 47 of file saimetadatalogger.h.

Variable Documentation

◆ sai_metadata_log

volatile sai_metadata_log_fn sai_metadata_log
extern

User specified log function.

TODO: add a set function to update this?

◆ sai_metadata_log_level

volatile sai_log_level_t sai_metadata_log_level
extern

Log level for SAI metadata macros.

Log level can be changed by user at any time.

TODO: add a set function to update this?