include/yaz/log.h

   1 /*
   2  * Copyright (c) 1995-2004, Index Data.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and
   5  * its documentation, in whole or in part, for any purpose, is hereby granted,
   6  * provided that:
   7  *
   8  * 1. This copyright and permission notice appear in all copies of the
   9  * software and its documentation. Notices of copyright or attribution
  10  * which appear at the beginning of any file must remain unchanged.
  11  *
  12  * 2. The name of Index Data or the individual authors may not be used to
  13  * endorse or promote products derived from this software without specific
  14  * prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
  18  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  19  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
  20  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
  21  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
  22  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
  23  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  24  * OF THIS SOFTWARE.
  25  *
  26  * $Id: log.h,v 1.18 2004-11-04 14:19:58 heikki Exp $
  27  */
  28
  29 /**
  30  * \file log.h
  31  * \brief Header for logging utility
  32  */
  33
  34 #ifndef LOG_H
  35 #define LOG_H
  36
  37 #include <stdio.h>
  38 #include <yaz/yconfig.h>
  39 #include <yaz/xmalloc.h>
  40
  41 YAZ_BEGIN_CDECL
  42
  43 #define LOG_FATAL  0x00000001
  44 #define LOG_DEBUG  0x00000002
  45 #define LOG_WARN   0x00000004
  46 #define LOG_LOG    0x00000008
  47 #define LOG_ERRNO  0x00000010 /* append strerror to message */
  48 #define LOG_FILE   0x00000020
  49 #define LOG_APP    0x00000040 /* Application level events (new-connection) */
  50 #define LOG_MALLOC 0x00000080 /* debugging mallocs */
  51 #define LOG_NOTIME 0x00000100 /* do not output date and time */
  52 #define LOG_APP2   0x00000200 /* Application-level events, such as api calls */
  53 #define LOG_APP3   0x00000400 /* For more application-level events */
  54 #define LOG_FLUSH  0x00000800 /* Flush log after every write (DEBUG does too) */
  55
  56 #define LOG_ALL   (0xffff&~LOG_MALLOC&~LOG_NOTIME)
  57
  58 #define LOG_DEFAULT_LEVEL (LOG_FATAL | LOG_ERRNO | LOG_LOG | LOG_WARN)
  59
  60 #define LOG_LAST_BIT LOG_FLUSH  /* the last bit used for regular log bits */
  61                                 /* the rest are for dynamic modules */
  62
  63 #define logf yaz_log
  64
  65 /**
  66  * yaz_log_init is a shorthand for initializing the log level and prefixes */
  67 YAZ_EXPORT void yaz_log_init(int level, const char *prefix, const char *name);
  68
  69 /** yaz_log_init_file sets the file name used for yaz_log */
  70 YAZ_EXPORT void yaz_log_init_file(const char *fname);
  71
  72 /** yaz_log_init_level sets the logging level. Use an OR of the bits above */
  73 YAZ_EXPORT void yaz_log_init_level(int level);
  74
  75 /** yaz_log_init_prefix sets the log prefix */
  76 YAZ_EXPORT void yaz_log_init_prefix(const char *prefix);
  77
  78 /** yaz_log_init_prefix2 sets an optional second prefix */
  79 YAZ_EXPORT void yaz_log_init_prefix2(const char *prefix);
  80
  81 /**
  82  * yaz_log_time_format sets the format of the timestamp. See man 3 strftime
  83  * Calling with "old" sets to the old format "11:55:06-02/11"
  84  * Calling with NULL or "" sets to the new format "20041102-115719"
  85  * If not called at all, the old format is used, for backward compatibility
  86  */
  87 YAZ_EXPORT void yaz_log_time_format(const char *fmt);
  88
  89 /**
  90  * yaz_log_init_max_size sets the max size for a log file.
  91  * zero means no limit. Negative means built-in limit (1GB)
  92  */
  93 YAZ_EXPORT void yaz_log_init_max_size(int mx);
  94
  95 /**
  96  * yaz_log writes an entry in the log. Defaults to stderr if not initialized
  97  * to a file with yaz_log_init_file. The level must match the level set via
  98  * yaz_log_init_level, optionally defined via yaz_log_mask_str. */
  99 YAZ_EXPORT void yaz_log(int level, const char *fmt, ...)
 100 #ifdef __GNUC__
 101         __attribute__ ((format (printf, 2, 3)))
 102 #endif
 103         ;
 104
 105 /**
 106  * yaz_log_mask_str converts a comma-separated list of log levels to a bit
 107  * mask. Starts from default level, and adds bits as specified, unless 'none'
 108  * is specified, which clears the list. If a name matches the name of a
 109  * LOG_BIT above, that one is set. Otherwise a new value is picked, and given
 110  * to that name, to be found with yaz_log_module_level */
 111 YAZ_EXPORT int yaz_log_mask_str(const char *str);
 112
 113 /** yaz_log_mask_str_x is like yaz_log_mask_str, but with a given start value*/
 114 YAZ_EXPORT int yaz_log_mask_str_x(const char *str, int level);
 115
 116
 117 /**
 118  * yaz_log_module_level returns a log level mask corresponding to the module
 119  * name. If that had been specified on the -v arguments (that is, passed to
 120  * yaz_log_mask_str), then a non-zero mask is returned. If not, we get a
 121  * zero. This can later be used in yaz_log for the level argument
 122  */
 123 YAZ_EXPORT int yaz_log_module_level(const char *name);
 124
 125 /** yaz_log_file returns the file handle for yaz_log. */
 126 YAZ_EXPORT FILE *yaz_log_file(void);
 127
 128 YAZ_EXPORT void log_event_start(void (*func)(int level, const char *msg, void *info),
 129         void *info);
 130 YAZ_EXPORT void log_event_end(void (*func)(int level, const char *msg, void *info),
 131         void *info);
 132
 133 YAZ_EXPORT void yaz_log_reopen(void);
 134 YAZ_END_CDECL
 135
 136 #endif