libqb  0.16.0
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
qblog.h File Reference

The logging API provides four main parts (basics, filtering, threading & blackbox). More...

#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <errno.h>
#include <syslog.h>
#include <string.h>
#include <qb/qbutil.h>
#include <qb/qbconfig.h>
Include dependency graph for qblog.h:

Data Structures

struct  qb_log_callsite
 An instance of this structure is created in a special ELF section at every dynamic debug callsite. More...
 

Macros

#define LOG_TRACE   (LOG_DEBUG + 1)
 
#define QB_LOG_MAX_LEN   512
 
#define QB_LOG_STRERROR_MAX_LEN   128
 
#define QB_LOG_INIT_DATA(name)
 
#define QB_LOG_TAG_LIBQB_MSG_BIT   31
 
#define QB_LOG_TAG_LIBQB_MSG   (1 << QB_LOG_TAG_LIBQB_MSG_BIT)
 
#define qb_logt(priority, tags, fmt, args...)
 This is the function to generate a log message if you want to manually add tags.
 
#define qb_log(priority, fmt, args...)   qb_logt(priority, 0, fmt, ##args)
 This is the main function to generate a log message.
 
#define qb_perror(priority, fmt, args...)
 This is similar to perror except it goes into the logging system.
 
#define qb_enter()   qb_log(LOG_TRACE, "ENTERING %s()", __func__)
 
#define qb_leave()   qb_log(LOG_TRACE, "LEAVING %s()", __func__)
 
#define QB_LOG_SYSLOG   0
 
#define QB_LOG_STDERR   1
 
#define QB_LOG_BLACKBOX   2
 
#define QB_LOG_STDOUT   3
 
#define QB_LOG_TARGET_MAX   32
 

Typedefs

typedef const char *(* qb_log_tags_stringify_fn )(uint32_t tags)
 
typedef void(* qb_log_filter_fn )(struct qb_log_callsite *cs)
 
typedef void(* qb_log_logger_fn )(int32_t t, struct qb_log_callsite *cs, time_t timestamp, const char *msg)
 
typedef void(* qb_log_vlogger_fn )(int32_t t, struct qb_log_callsite *cs, time_t timestamp, va_list ap)
 
typedef void(* qb_log_close_fn )(int32_t t)
 
typedef void(* qb_log_reload_fn )(int32_t t)
 

Enumerations

enum  qb_log_target_state { QB_LOG_STATE_UNUSED = 1, QB_LOG_STATE_DISABLED = 2, QB_LOG_STATE_ENABLED = 3 }
 
enum  qb_log_conf {
  QB_LOG_CONF_ENABLED, QB_LOG_CONF_FACILITY, QB_LOG_CONF_DEBUG, QB_LOG_CONF_SIZE,
  QB_LOG_CONF_THREADED, QB_LOG_CONF_PRIORITY_BUMP, QB_LOG_CONF_STATE_GET, QB_LOG_CONF_FILE_SYNC
}
 
enum  qb_log_filter_type { QB_LOG_FILTER_FILE, QB_LOG_FILTER_FUNCTION, QB_LOG_FILTER_FORMAT }
 
enum  qb_log_filter_conf {
  QB_LOG_FILTER_ADD, QB_LOG_FILTER_REMOVE, QB_LOG_FILTER_CLEAR_ALL, QB_LOG_TAG_SET,
  QB_LOG_TAG_CLEAR, QB_LOG_TAG_CLEAR_ALL
}
 

Functions

struct qb_log_callsite __attribute__ ((aligned(8)))
 
void qb_log_real_ (struct qb_log_callsite *cs,...)
 Internal function: use qb_log() or qb_logt()
 
void qb_log_real_va_ (struct qb_log_callsite *cs, va_list ap)
 
void qb_log_from_external_source (const char *function, const char *filename, const char *format, uint8_t priority, uint32_t lineno, uint32_t tags,...)
 This function is to import logs from other code (like libraries) that provide a callback with their logs.
 
struct qb_log_callsiteqb_log_callsite_get (const char *function, const char *filename, const char *format, uint8_t priority, uint32_t lineno, uint32_t tags)
 Get or create a callsite at the give position.
 
void qb_log_from_external_source_va (const char *function, const char *filename, const char *format, uint8_t priority, uint32_t lineno, uint32_t tags, va_list ap)
 
void qb_log_init (const char *name, int32_t facility, uint8_t priority)
 Init the logging system.
 
void qb_log_fini (void)
 Logging system finalization function.
 
int32_t qb_log_callsites_register (struct qb_log_callsite *_start, struct qb_log_callsite *_stop)
 If you are using dynamically loadable modules via dlopen() and you load them after qb_log_init() then after you load the module you will need to do the following to get the filters to work in that module.
 
void qb_log_callsites_dump (void)
 Dump the callsite info to stdout.
 
int32_t qb_log_ctl (int32_t target, enum qb_log_conf conf_type, int32_t arg)
 Main logging control function.
 
int32_t qb_log_filter_ctl (int32_t value, enum qb_log_filter_conf c, enum qb_log_filter_type type, const char *text, uint8_t low_priority)
 This allows you modify the 'tags' and 'targets' callsite fields at runtime.
 
int32_t qb_log_filter_ctl2 (int32_t value, enum qb_log_filter_conf c, enum qb_log_filter_type type, const char *text, uint8_t high_priority, uint8_t low_priority)
 This extends qb_log_filter_ctl() by been able to provide a high_priority.
 
int32_t qb_log_filter_fn_set (qb_log_filter_fn fn)
 Instead of using the qb_log_filter_ctl() functions you can apply the filters manually by defining a callback and setting the targets field using qb_bit_set() and qb_bit_clear() like the following below.
 
void qb_log_tags_stringify_fn_set (qb_log_tags_stringify_fn fn)
 Set the callback to map the 'tags' bit map to a string.
 
void qb_log_format_set (int32_t t, const char *format)
 Set the format specifiers.
 
int32_t qb_log_file_open (const char *filename)
 Open a log file.
 
void qb_log_file_close (int32_t t)
 Close a log file and release is resources.
 
int32_t qb_log_thread_priority_set (int32_t policy, int32_t priority)
 When using threaded logging set the pthread policy and priority.
 
int32_t qb_log_thread_start (void)
 Start the logging pthread.
 
ssize_t qb_log_blackbox_write_to_file (const char *filename)
 Write the blackbox to file.
 
void qb_log_blackbox_print_from_file (const char *filename)
 Read the blackbox for file and print it out.
 
int32_t qb_log_custom_open (qb_log_logger_fn log_fn, qb_log_close_fn close_fn, qb_log_reload_fn reload_fn, void *user_data)
 Open a custom log target.
 
void qb_log_custom_close (int32_t t)
 Close a custom log target and release is resources.
 
void * qb_log_target_user_data_get (int32_t t)
 Retrieve the user data set by either qb_log_custom_open or qb_log_target_user_data_set.
 
int32_t qb_log_target_user_data_set (int32_t t, void *user_data)
 Associate user data with this log target.
 
void qb_log_target_format (int32_t target, struct qb_log_callsite *cs, time_t timestamp, const char *formatted_message, char *output_buffer)
 format the callsite and timestamp info according to the format set using qb_log_format_set() It is intended to be used from your custom logger function.
 
int32_t qb_log_facility2int (const char *fname)
 Convert string "auth" to equivalent number "LOG_AUTH" etc.
 
const char * qb_log_facility2str (int32_t fnum)
 Convert number "LOG_AUTH" to equivalent string "auth" etc.
 

Variables

const char * function
 
const char * filename
 
const char * format
 
uint8_t priority
 
uint32_t lineno
 
uint32_t targets
 
uint32_t tags
 
struct qb_log_callsite __start___verbose []
 
struct qb_log_callsite __stop___verbose []
 
enum qb_log_target_state __attribute__
 

Detailed Description

The logging API provides four main parts (basics, filtering, threading & blackbox).

The idea behind this logging system is not to be prescriptive but to provide a set of tools to help the developer achieve what they want quickly and easily.

Basic logging API.
Call qb_log() to generate a log message. Then to write the message somewhere meaningful call qb_log_ctl() to configure the targets.

Simplist possible use:

main() {
qb_log_init("simple-log", LOG_DAEMON, LOG_INFO);
// ...
qb_log(LOG_WARNING, "watch out");
// ...
}
Configuring log targets.
A log target can by syslog, stderr, the blackbox or a text file. By default only syslog is enabled.

To enable a target do the following

syslog, stderr and the blackbox are static (they don't need to be created, just enabled or disabled. However you can open multiple logfiles (32 - QB_LOG_BLACKBOX). To do this use the following code.

mytarget = qb_log_file_open("/var/log/mylogfile");

Once your targets are enabled/opened you can configure them as follows: Configure the size of blackbox

Make logging to file threaded:

To workaround your syslog daemon filtering all messages > LOG_INFO

To ensure all logs to file targets are fsync'ed (default QB_FALSE)

Filtering messages.
To have more power over what log messages go to which target you can apply filters to the targets. What happens is the desired callsites have the correct bit set. Then when the log message is generated it gets sent to the targets based on which bit is set in the callsite's "target" bitmap. Messages can be filtered based on the:
  1. filename + priority
  2. function name + priority
  3. format string + priority

So to make all logs from evil_fnunction() go to stderr do the following:

So to make all logs from totem* (with a priority <= LOG_INFO) go to stderr do the following:

So to make all logs with the substring "ringbuffer" go to stderr do the following:

Threaded logging.
To achieve non-blocking logging you can use threaded logging. So any calls to write() or syslog() will not hold up your program.

Threaded logging use:

main() {
qb_log_init("simple-log", LOG_DAEMON, LOG_INFO);
// ...
daemonize();
// call this after you fork()
// ...
qb_log(LOG_WARNING, "watch out");
// ...
}
A blackbox for in-field diagnosis.
This stores log messages in a ringbuffer so they can be written to file if the program crashes (you will need to catch SIGSEGV). These can then be easily printed out later.
Note
the blackbox is not enabled by default.

Blackbox usage:

static void sigsegv_handler(int sig)
{
(void)signal (SIGSEGV, SIG_DFL);
qb_log_blackbox_write_to_file("simple-log.fdata");
raise(SIGSEGV);
}
main() {
signal(SIGSEGV, sigsegv_handler);
qb_log_init("simple-log", LOG_DAEMON, LOG_INFO);
QB_LOG_FILTER_FILE, "*", LOG_DEBUG);
// ...
qb_log(LOG_WARNING, "watch out");
// ...
}
Tagging messages.
You can tag messages using the second argument to qb_logt() or by using qb_log_filter_ctl(). This can be used to add feature or sub-system information to the logs.
const char* my_tags_stringify(uint32_t tags) {
return "libqb";
} else if (tags == 3) {
return "three";
} else {
return "MAIN";
}
}
main() {
// ...
qb_log_tags_stringify_fn_set(my_tags_stringify);
// ...
qb_logt(LOG_INFO, 3, "hello");
qb_logt(LOG_INFO, 0, "hello");
}

The code above will produce:

[libqb] some message
[three] info hello
[MAIN ] info hello

Macro Definition Documentation

#define LOG_TRACE   (LOG_DEBUG + 1)
#define qb_enter ( )    qb_log(LOG_TRACE, "ENTERING %s()", __func__)
Examples:
simplelog.c.
#define qb_leave ( )    qb_log(LOG_TRACE, "LEAVING %s()", __func__)
Examples:
simplelog.c.
#define qb_log (   priority,
  fmt,
  args... 
)    qb_logt(priority, 0, fmt, ##args)

This is the main function to generate a log message.

Parameters
prioritythis takes syslog priorities.
fmtusual printf style format specifiers
argsusual printf style args
Examples:
ipcserver.c, and simplelog.c.
#define QB_LOG_BLACKBOX   2
Examples:
simplelog.c.
#define QB_LOG_INIT_DATA (   name)
Value:
void name(void); \
void name(void) { if (__start___verbose != __stop___verbose) {assert(1);} } \
void __attribute__ ((constructor)) name(void);
#define QB_LOG_MAX_LEN   512
Examples:
simplelog.c.
#define QB_LOG_STDERR   1
#define QB_LOG_STDOUT   3
Examples:
simplelog.c.
#define QB_LOG_STRERROR_MAX_LEN   128
#define QB_LOG_SYSLOG   0
Examples:
ipcclient.c, and simplelog.c.
#define QB_LOG_TAG_LIBQB_MSG   (1 << QB_LOG_TAG_LIBQB_MSG_BIT)
#define QB_LOG_TAG_LIBQB_MSG_BIT   31
Examples:
simplelog.c.
#define QB_LOG_TARGET_MAX   32
#define qb_logt (   priority,
  tags,
  fmt,
  args... 
)
Value:
do { \
static struct qb_log_callsite descriptor \
__attribute__((section("__verbose"), aligned(8))) = \
{ __func__, __FILE__, fmt, priority, __LINE__, 0, tags }; \
qb_log_real_(&descriptor, ##args); \
} while(0)

This is the function to generate a log message if you want to manually add tags.

Parameters
prioritythis takes syslog priorities.
tagsthis is a uint32_t that you can use with qb_log_tags_stringify_fn_set() to "tag" a log message with a feature or sub-system then you can use "%g" in the format specifer to print it out.
fmtusual printf style format specifiers
argsusual printf style args
Examples:
simplelog.c.
#define qb_perror (   priority,
  fmt,
  args... 
)
Value:
do { \
char _perr_buf_[QB_LOG_STRERROR_MAX_LEN]; \
const char *_perr_str_ = qb_strerror_r(errno, _perr_buf_, sizeof(_perr_buf_)); \
qb_logt(priority, 0, fmt ": %s (%d)", ##args, _perr_str_, errno); \
} while(0)

This is similar to perror except it goes into the logging system.

Parameters
prioritythis takes syslog priorities.
fmtusual printf style format specifiers
argsusual printf style args
Examples:
ipcserver.c, and simplelog.c.

Typedef Documentation

typedef void(* qb_log_close_fn)(int32_t t)
typedef void(* qb_log_filter_fn)(struct qb_log_callsite *cs)
typedef void(* qb_log_logger_fn)(int32_t t, struct qb_log_callsite *cs, time_t timestamp, const char *msg)
typedef void(* qb_log_reload_fn)(int32_t t)
typedef const char*(* qb_log_tags_stringify_fn)(uint32_t tags)
typedef void(* qb_log_vlogger_fn)(int32_t t, struct qb_log_callsite *cs, time_t timestamp, va_list ap)

Enumeration Type Documentation

Enumerator
QB_LOG_CONF_ENABLED 
QB_LOG_CONF_FACILITY 
QB_LOG_CONF_DEBUG 
QB_LOG_CONF_SIZE 
QB_LOG_CONF_THREADED 
QB_LOG_CONF_PRIORITY_BUMP 
QB_LOG_CONF_STATE_GET 
QB_LOG_CONF_FILE_SYNC 
Enumerator
QB_LOG_FILTER_ADD 
QB_LOG_FILTER_REMOVE 
QB_LOG_FILTER_CLEAR_ALL 
QB_LOG_TAG_SET 
QB_LOG_TAG_CLEAR 
QB_LOG_TAG_CLEAR_ALL 
Enumerator
QB_LOG_FILTER_FILE 
QB_LOG_FILTER_FUNCTION 
QB_LOG_FILTER_FORMAT 
Enumerator
QB_LOG_STATE_UNUSED 
QB_LOG_STATE_DISABLED 
QB_LOG_STATE_ENABLED 

Function Documentation

struct qb_log_callsite __attribute__ ( (aligned(8))  )
void qb_log_blackbox_print_from_file ( const char *  filename)

Read the blackbox for file and print it out.

Examples:
simplelog.c.
ssize_t qb_log_blackbox_write_to_file ( const char *  filename)

Write the blackbox to file.

Examples:
simplelog.c.
struct qb_log_callsite* qb_log_callsite_get ( const char *  function,
const char *  filename,
const char *  format,
uint8_t  priority,
uint32_t  lineno,
uint32_t  tags 
)
read

Get or create a callsite at the give position.

The result can then be passed into qb_log_real_()

Parameters
functionoriginating function name
filenameoriginating filename
formatformat string
prioritythis takes syslog priorities.
linenofile line number
tagsthe tag
void qb_log_callsites_dump ( void  )

Dump the callsite info to stdout.

int32_t qb_log_callsites_register ( struct qb_log_callsite _start,
struct qb_log_callsite _stop 
)

If you are using dynamically loadable modules via dlopen() and you load them after qb_log_init() then after you load the module you will need to do the following to get the filters to work in that module.

_start = dlsym (dl_handle, "__start___verbose");
_stop = dlsym (dl_handle, "__stop___verbose");
int32_t qb_log_ctl ( int32_t  target,
enum qb_log_conf  conf_type,
int32_t  arg 
)

Main logging control function.

Parameters
targetQB_LOG_SYSLOG, QB_LOG_STDERR or result from qb_log_file_open()
conf_typewhat to configure
argthe new value
See Also
qb_log_conf
Return values
-errnoon error
0on success
qb_log_target_statefor QB_LOG_CONF_STATE_GET
Examples:
ipcclient.c, ipcserver.c, and simplelog.c.
void qb_log_custom_close ( int32_t  t)

Close a custom log target and release is resources.

int32_t qb_log_custom_open ( qb_log_logger_fn  log_fn,
qb_log_close_fn  close_fn,
qb_log_reload_fn  reload_fn,
void *  user_data 
)

Open a custom log target.

Return values
-errnoon error
3to 31 (to be passed into other qb_log_* functions)
Examples:
simplelog.c.
int32_t qb_log_facility2int ( const char *  fname)

Convert string "auth" to equivalent number "LOG_AUTH" etc.

const char* qb_log_facility2str ( int32_t  fnum)

Convert number "LOG_AUTH" to equivalent string "auth" etc.

void qb_log_file_close ( int32_t  t)

Close a log file and release is resources.

int32_t qb_log_file_open ( const char *  filename)

Open a log file.

Return values
-errnoon error
3to 31 (to be passed into other qb_log_* functions)
Examples:
simplelog.c.
int32_t qb_log_filter_ctl ( int32_t  value,
enum qb_log_filter_conf  c,
enum qb_log_filter_type  type,
const char *  text,
uint8_t  low_priority 
)

This allows you modify the 'tags' and 'targets' callsite fields at runtime.

Examples:
ipcclient.c, ipcserver.c, and simplelog.c.
int32_t qb_log_filter_ctl2 ( int32_t  value,
enum qb_log_filter_conf  c,
enum qb_log_filter_type  type,
const char *  text,
uint8_t  high_priority,
uint8_t  low_priority 
)

This extends qb_log_filter_ctl() by been able to provide a high_priority.

Examples:
simplelog.c.
int32_t qb_log_filter_fn_set ( qb_log_filter_fn  fn)

Instead of using the qb_log_filter_ctl() functions you can apply the filters manually by defining a callback and setting the targets field using qb_bit_set() and qb_bit_clear() like the following below.

static void
m_filter(struct qb_log_callsite *cs)
{
if ((cs->priority >= LOG_ALERT &&
cs->priority <= LOG_DEBUG) &&
strcmp(cs->filename, "my_c_file.c") == 0) {
} else {
}
}
Examples:
simplelog.c.
void qb_log_fini ( void  )

Logging system finalization function.

It releases any shared memory. Stops the logging thread if running. Flushes the last message to their destinations.

Examples:
simplelog.c.
void qb_log_format_set ( int32_t  t,
const char *  format 
)

Set the format specifiers.

n FUNCTION NAME f FILENAME l FILELINE p PRIORITY t TIMESTAMP b BUFFER g TAGS N name (passed into qb_log_init) P PID H hostname

any number between % and character specify field length to pad or chop

Examples:
ipcclient.c, ipcserver.c, and simplelog.c.
void qb_log_from_external_source ( const char *  function,
const char *  filename,
const char *  format,
uint8_t  priority,
uint32_t  lineno,
uint32_t  tags,
  ... 
)

This function is to import logs from other code (like libraries) that provide a callback with their logs.

Note
the performance of this will not impress you, as the filtering is done on each log message, not before hand. So try doing basic pre-filtering.
Parameters
functionoriginating function name
filenameoriginating filename
formatformat string
prioritythis takes syslog priorities.
linenofile line number
tagsthis is a uint32_t that you can use with qb_log_tags_stringify_fn_set() to "tag" a log message with a feature or sub-system then you can use "%g" in the format specifer to print it out.
void qb_log_from_external_source_va ( const char *  function,
const char *  filename,
const char *  format,
uint8_t  priority,
uint32_t  lineno,
uint32_t  tags,
va_list  ap 
)
void qb_log_init ( const char *  name,
int32_t  facility,
uint8_t  priority 
)

Init the logging system.

Parameters
namewill be passed into openlog()
facilitydefault for all new targets.
prioritya basic filter with this priority will be added.
Examples:
ipcclient.c, ipcserver.c, and simplelog.c.
void qb_log_real_ ( struct qb_log_callsite cs,
  ... 
)

Internal function: use qb_log() or qb_logt()

void qb_log_real_va_ ( struct qb_log_callsite cs,
va_list  ap 
)
void qb_log_tags_stringify_fn_set ( qb_log_tags_stringify_fn  fn)

Set the callback to map the 'tags' bit map to a string.

Examples:
simplelog.c.
void qb_log_target_format ( int32_t  target,
struct qb_log_callsite cs,
time_t  timestamp,
const char *  formatted_message,
char *  output_buffer 
)

format the callsite and timestamp info according to the format set using qb_log_format_set() It is intended to be used from your custom logger function.

Examples:
simplelog.c.
void* qb_log_target_user_data_get ( int32_t  t)

Retrieve the user data set by either qb_log_custom_open or qb_log_target_user_data_set.

int32_t qb_log_target_user_data_set ( int32_t  t,
void *  user_data 
)

Associate user data with this log target.

Note
only use this with custom targets
int32_t qb_log_thread_priority_set ( int32_t  policy,
int32_t  priority 
)

When using threaded logging set the pthread policy and priority.

Return values
-errnoon error
0success
int32_t qb_log_thread_start ( void  )

Start the logging pthread.

Examples:
simplelog.c.

Variable Documentation

enum qb_log_target_state __attribute__
struct qb_log_callsite __start___verbose[]
struct qb_log_callsite __stop___verbose[]
const char* filename
const char* format
const char* function
uint32_t lineno
uint8_t priority
uint32_t tags
Examples:
simplelog.c.
uint32_t targets