QOF 0.7.5
Trace: Debugging support

Files

file  qoflog.h
 

QOF error logging and tracing facility.


Defines

#define QOF_MOD_ENGINE   "qof-engine"
#define LOG_LEVEL_LIST(_)
#define FUNK   qof_log_prettify(__FUNCTION__)
#define FATAL(format, args...)
#define PERR(format, args...)
#define PWARN(format, args...)
#define PINFO(format, args...)
#define DEBUG(format, args...)
#define ENTER(format, args...)
#define LEAVE(format, args...)
#define TRACE(format, args...)
#define DEBUGCMD(x)

Typedefs

typedef void(* QofLogCB )(QofLogModule log_module, QofLogLevel *log_level, gpointer user_data)

Enumerations

enum  QofLogLevel {
  QOF_LOG_FATAL = 0, QOF_LOG_ERROR = 1, QOF_LOG_WARNING = 2, QOF_LOG_INFO = 3,
  QOF_LOG_DEBUG = 4, QOF_LOG_DETAIL = 5, QOF_LOG_TRACE = 6
}

Functions

const gchar * QofLogLevelasString (QofLogLevel n)
QofLogLevel QofLogLevelfromString (const gchar *str)
void qof_log_add_indent (void)
gint qof_log_get_indent (void)
void qof_log_drop_indent (void)
void qof_log_init (void)
void qof_log_set_level (QofLogModule module, QofLogLevel level)
void qof_log_set_level_registered (QofLogLevel level)
void qof_log_set_file (FILE *outfile)
void qof_log_init_filename (const gchar *logfilename)
void qof_log_shutdown (void)
const gchar * qof_log_prettify (const gchar *name)
gboolean qof_log_check (QofLogModule log_module, QofLogLevel log_level)
void qof_log_set_default (QofLogLevel log_level)
void qof_log_module_foreach (QofLogCB cb, gpointer data)
gint qof_log_module_count (void)

Define Documentation

#define DEBUG (   format,
  args... 
)
Value:
do {                 \
  if (qof_log_check (log_module, QOF_LOG_DEBUG)) {  \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Debug: %s(): " format,                      \
      FUNK , ## args);                             \
  }                                                \
} while (0)

Print a debugging message

Definition at line 208 of file qoflog.h.

#define DEBUGCMD (   x)
Value:
do {                            \
  if (qof_log_check (log_module, QOF_LOG_DEBUG)) {  \
        (x);                                        \
    }                                               \
} while (0)

Definition at line 244 of file qoflog.h.

#define ENTER (   format,
  args... 
)
Value:
do {                 \
  if (qof_log_check (log_module, QOF_LOG_DEBUG)) {  \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Enter in %s: %s()" format, __FILE__,        \
      FUNK , ## args);                             \
    qof_log_add_indent();                           \
  }                                                \
} while (0)

Print a function entry debugging message

Definition at line 217 of file qoflog.h.

#define FATAL (   format,
  args... 
)
Value:
do {                  \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_ERROR,          \
      "Fatal Error: %s(): " format, FUNK , ## args); \
} while (0)

Log error/warning/info messages to stderr or to a file. This logging infrastructure is meant for validating the correctness of the execution of the code. 'Info' level messages help trace program flow. 'Error' messages are meant to indicate internal data inconsistencies.

Messages can be logged to stdout, stderr, or to any desired file. Log a fatal error

Definition at line 177 of file qoflog.h.

#define LEAVE (   format,
  args... 
)
Value:
do {                 \
  if (qof_log_check (log_module, QOF_LOG_DEBUG)) {  \
    qof_log_drop_indent();                          \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Leave: %s()" format,                        \
      FUNK , ## args);                             \
  }                                                \
} while (0)

Print a function exit debugging message

Definition at line 227 of file qoflog.h.

#define LOG_LEVEL_LIST (   _)
Value:
_(QOF_LOG_FATAL, = 0)   \
  _(QOF_LOG_ERROR, = 1)   \
  _(QOF_LOG_WARNING, = 2) \
  _(QOF_LOG_INFO, = 3)    \
  _(QOF_LOG_DEBUG, = 4)   \
  _(QOF_LOG_DETAIL, = 5)  \
  _(QOF_LOG_TRACE, = 6)

Definition at line 43 of file qoflog.h.

#define PERR (   format,
  args... 
)
Value:
do {                   \
  if (qof_log_check (log_module, QOF_LOG_ERROR)) {   \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_CRITICAL,     \
      "Error: %s(): " format, FUNK , ## args);     \
  }                                                \
} while (0)

Log a serious error

Definition at line 183 of file qoflog.h.

#define PINFO (   format,
  args... 
)
Value:
do {                 \
  if (qof_log_check (log_module, QOF_LOG_INFO)) {   \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_INFO,         \
      "Info: %s(): " format,                       \
      FUNK , ## args);                             \
  }                                                \
} while (0)

Print an informational note

Definition at line 199 of file qoflog.h.

#define PWARN (   format,
  args... 
)
Value:
do {                    \
  if (qof_log_check (log_module, QOF_LOG_WARNING)) {   \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_WARNING,      \
      "Warning: %s(): " format, FUNK , ## args);   \
  }                                                \
} while (0)

Log a warning

Definition at line 191 of file qoflog.h.

#define TRACE (   format,
  args... 
)
Value:
do {                 \
  if (qof_log_check (log_module, QOF_LOG_TRACE)) {  \
    g_log (G_LOG_DOMAIN, G_LOG_LEVEL_DEBUG,        \
      "Trace: %s(): " format, FUNK , ## args);     \
  }                                                \
} while (0)

Print a function trace debugging message

Definition at line 237 of file qoflog.h.


Enumeration Type Documentation

Convert QofLogLevel to a string.

The macro correlates the enum value and an exact copy as a string, removing the need to keep two separate lists in sync.

Definition at line 58 of file qoflog.h.

{                  \

Function Documentation

void qof_log_add_indent ( void  )

indents once for each ENTER macro

Definition at line 45 of file qoflog.c.

{
gboolean qof_log_check ( QofLogModule  log_module,
QofLogLevel  log_level 
)

Do not log log_modules that have not been enabled.

Definition at line 204 of file qoflog.c.

{
    gchar *log_string;
    /* Any positive log_level less than this will be logged. */
    QofLogLevel maximum; 

    log_string = NULL;
    if (log_level > QOF_LOG_TRACE)
        log_level = QOF_LOG_TRACE;
    if (!log_table || log_module == NULL)
    {
        return FALSE;
    }
    log_string = (gchar *) g_hash_table_lookup (log_table, log_module);
    /* if log_module not found, do not log. */
    if (!log_string)
    {
        return FALSE;
    }
    maximum = QofLogLevelfromString (log_string);
    if (log_level <= maximum)
    {
        return TRUE;
void qof_log_drop_indent ( void  )

drops back one indent for each LEAVE macro

indent is reset to zero if less than a single indent would exist.

Definition at line 57 of file qoflog.c.

{
gint qof_log_get_indent ( void  )

gets the running total of the indent

Definition at line 51 of file qoflog.c.

{
void qof_log_init ( void  )

Initialize the error logging subsystem

Deprecated:
Applications need to call qof_log_set_file to set the output, otherwise the default of /tmp/qof.trace will be used.

Instead, use qof_log_init_filename which sets the filename and initialises the logging subsystem in one operation.

Definition at line 74 of file qoflog.c.

{
    if (!fout)  /* allow qof_log_set_file */
    {
        fout = fopen ("/tmp/qof.trace", "w");
    }

    if (!fout && (filename = (gchar *) g_malloc (MAX_TRACE_FILENAME)))
    {
        snprintf (filename, MAX_TRACE_FILENAME - 1, "/tmp/qof.trace.%d",
            getpid ());
        fout = fopen (filename, "w");
        g_free (filename);
    }

    if (!fout)
        fout = stderr;
void qof_log_init_filename ( const gchar *  logfilename)

Specify a filename for log output.

Calls qof_log_init() for you.

Definition at line 144 of file qoflog.c.

{
    if (!logfilename)
    {
        fout = stderr;
    }
    else
    {
        filename = g_strdup (logfilename);
        fout = fopen (filename, "w");
gint qof_log_module_count ( void  )

Number of log_modules registered

Definition at line 287 of file qoflog.c.

{
    if (!log_table)
    {
        return 0;
void qof_log_module_foreach ( QofLogCB  cb,
gpointer  data 
)

Iterate over each known log_module

Only log_modules with log_levels set will be available.

Definition at line 273 of file qoflog.c.

{
    struct hash_s qiter;

    if (!cb)
    {
        return;
    }
    qiter.cb = cb;
const gchar* qof_log_prettify ( const gchar *  name)

qof_log_prettify() cleans up subroutine names. AIX/xlC has the habit of printing signatures not names; clean this up. On other operating systems, truncate name to QOF_LOG_MAX_CHARS chars.

Definition at line 177 of file qoflog.c.

{
    gchar *p, *buffer;
    gint length;

    if (!name)
    {
        return "";
    }
    buffer = g_strndup (name, QOF_LOG_MAX_CHARS - 1);
    length = strlen (buffer);
    p = g_strstr_len (buffer, length, "(");
    if (p)
    {
        *(p + 1) = ')';
        *(p + 2) = 0x0;
    }
    else
    {
        strcpy (&buffer[QOF_LOG_MAX_CHARS - 4], "...()");
    }
    function_buffer = g_strdup (buffer);
void qof_log_set_default ( QofLogLevel  log_level)

Set the default QOF log_modules to the log level.

Definition at line 232 of file qoflog.c.

{
    qof_log_set_level (QOF_MOD_BACKEND, log_level);
    qof_log_set_level (QOF_MOD_CLASS, log_level);
    qof_log_set_level (QOF_MOD_ENGINE, log_level);
    qof_log_set_level (QOF_MOD_OBJECT, log_level);
    qof_log_set_level (QOF_MOD_KVP, log_level);
    qof_log_set_level (QOF_MOD_MERGE, log_level);
    qof_log_set_level (QOF_MOD_QUERY, log_level);
    qof_log_set_level (QOF_MOD_SESSION, log_level);
    qof_log_set_level (QOF_MOD_CHOICE, log_level);
    qof_log_set_level (QOF_MOD_UTIL, log_level);
    qof_log_set_level (QOF_MOD_TIME, log_level);
    qof_log_set_level (QOF_MOD_DATE, log_level);
    qof_log_set_level (QOF_MOD_UNDO, log_level);
    qof_log_set_level (QOF_MOD_ERROR, log_level);
    qof_log_set_level (QOF_MOD_QSF, log_level);
void qof_log_set_file ( FILE *  outfile)

Specify an alternate log output, to pipe or file. By default, all logging goes to /tmp/qof.trace

Needs to be called before qof_log_init()

Deprecated:

Definition at line 133 of file qoflog.c.

{
    if (!outfile)
    {
        fout = stderr;
        return;
void qof_log_set_level ( QofLogModule  module,
QofLogLevel  level 
)

Set the logging level of the given log_module.

Registers the log_module with the qof_log hashtable and sets an initial value for the loglevel for that log_module.

Definition at line 96 of file qoflog.c.

{
    gchar *level_string;

    if (!log_module || level == 0)
    {
        return;
    }
    level_string = g_strdup (QofLogLevelasString (level));
    if (!log_table)
    {
        log_table = g_hash_table_new (g_str_hash, g_str_equal);
void qof_log_set_level_registered ( QofLogLevel  level)

Set the logging level for all registered log_modules.

Note:
Unless a log_module has been registered using qof_log_set_level, it will be unaffected by this change because there will be no entry in the hashtable.

"silent" log_modules are supported by the qof_log_set_level_registered function which only moderates log_levels for those modules actually registered. The advantage is that a developer can omit existing log_modules from the init code and cut down the amount of unwanted logging.

e.g. if you are working in one section of the code and do not want the extra log information created by allowing the default modules to log as well. This makes the log itself easier to use when working in a small area of the codebase. Silent log_modules can also be useful where no default currently exists - again to isolate certain sections of the default log output - and using qof_log_set_level_registered allows these silent log_modules to be retained in the code without being logged by other developers etc.

Definition at line 120 of file qoflog.c.

{
    gchar *level_string;

    if (!log_table || level == 0)
    {
        return;
    }
void qof_log_shutdown ( void  )

Be nice, close the logfile if possible.

Definition at line 159 of file qoflog.c.

{
    if (fout && fout != stderr)
    {
        fclose (fout);
    }
    if (filename)
    {
        g_free (filename);
    }
    if (function_buffer)
    {
        g_free (function_buffer);
const gchar* QofLogLevelasString ( QofLogLevel  n)

Convert a QofLogLevel to the log_string

Only for use as a partner to QofLogLevelfromString

Definition at line 45 of file qoflog.c.

{
QofLogLevel QofLogLevelfromString ( const gchar *  str)

Convert the log_string to a QofLogLevel

Only for use as a partner to QofLogLevelasString

Definition at line 45 of file qoflog.c.

{