git.sur5r.net Git - openldap/blob - include/ldap_log.h

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1998-2005 The OpenLDAP Foundation.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted only as authorized by the OpenLDAP
   9  * Public License.
  10  *
  11  * A copy of this license is available in file LICENSE in the
  12  * top-level directory of the distribution or, alternatively, at
  13  * <http://www.OpenLDAP.org/license.html>.
  14  */
  15 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
  16  * All rights reserved.
  17  *
  18  * Redistribution and use in source and binary forms are permitted
  19  * provided that this notice is preserved and that due credit is given
  20  * to the University of Michigan at Ann Arbor. The name of the University
  21  * may not be used to endorse or promote products derived from this
  22  * software without specific prior written permission. This software
  23  * is provided ``as is'' without express or implied warranty.
  24  */
  25
  26 #ifndef _LDAP_LOG_H
  27 #define _LDAP_LOG_H
  28
  29 #include <stdio.h>
  30 #include <ldap_cdefs.h>
  31
  32 LDAP_BEGIN_DECL
  33
  34 /*
  35  * While it's not important that the subsystem number are
  36  * contiguous, it is important that the LDAP_SUBSYS_NUM accurately
  37  * reflect the number of subsystems and LDAP_SUBSYS_MAX reflect
  38  * the largest subsystem number.
  39  */
  40 #define LDAP_SUBSYS_NUM 20
  41 #define LDAP_SUBSYS_MAX 19
  42
  43 #define LDAP_SUBSYS_GLOBAL      0
  44 #define LDAP_SUBSYS_OPERATION   1
  45 #define LDAP_SUBSYS_TRANSPORT   2
  46 #define LDAP_SUBSYS_CONNECTION  3
  47 #define LDAP_SUBSYS_FILTER      4
  48 #define LDAP_SUBSYS_BER         5
  49 #define LDAP_SUBSYS_CONFIG      6
  50 #define LDAP_SUBSYS_ACL         7
  51 #define LDAP_SUBSYS_CACHE       8
  52 #define LDAP_SUBSYS_INDEX       9
  53 #define LDAP_SUBSYS_LDIF        10
  54 #define LDAP_SUBSYS_TOOLS       11
  55 #define LDAP_SUBSYS_SLAPD       12
  56 #define LDAP_SUBSYS_SLURPD      13
  57 #define LDAP_SUBSYS_BACKEND     14
  58 #define LDAP_SUBSYS_BACK_BDB    15
  59 #define LDAP_SUBSYS_BACK_LDBM   16
  60 #define LDAP_SUBSYS_BACK_LDAP   17
  61 #define LDAP_SUBSYS_BACK_META   18
  62 #define LDAP_SUBSYS_BACK_MON    19
  63
  64 /*
  65  * debug reporting levels.
  66  *
  67  * They start with the syslog levels, and
  68  * go down in importance.  The normal
  69  * debugging levels begin with LDAP_LEVEL_ENTRY
  70  *
  71  */
  72 #define LDAP_LEVEL_EMERG       0
  73 #define LDAP_LEVEL_ALERT       1
  74 #define LDAP_LEVEL_CRIT        2
  75 #define LDAP_LEVEL_ERR         3
  76 #define LDAP_LEVEL_WARNING     4
  77 #define LDAP_LEVEL_NOTICE      5
  78 #define LDAP_LEVEL_INFO        6
  79 #define LDAP_LEVEL_ENTRY       7  /* log function entry points */
  80 #define LDAP_LEVEL_ARGS        8  /* log function call parameters */
  81 #define LDAP_LEVEL_RESULTS     9  /* Log function results */
  82 #define LDAP_LEVEL_DETAIL1    10  /* log level 1 function operational details */
  83 #define LDAP_LEVEL_DETAIL2    11  /* Log level 2 function operational details */
  84
  85 #define LDAP_DEBUG_TRACE        0x0001
  86 #define LDAP_DEBUG_PACKETS      0x0002
  87 #define LDAP_DEBUG_ARGS         0x0004
  88 #define LDAP_DEBUG_CONNS        0x0008
  89 #define LDAP_DEBUG_BER          0x0010
  90 #define LDAP_DEBUG_FILTER       0x0020
  91 #define LDAP_DEBUG_CONFIG       0x0040
  92 #define LDAP_DEBUG_ACL          0x0080
  93 #define LDAP_DEBUG_STATS        0x0100
  94 #define LDAP_DEBUG_STATS2       0x0200
  95 #define LDAP_DEBUG_SHELL        0x0400
  96 #define LDAP_DEBUG_PARSE        0x0800
  97 #define LDAP_DEBUG_CACHE    0x1000
  98 #define LDAP_DEBUG_INDEX    0x2000
  99
 100 #define LDAP_DEBUG_NONE         0x8000
 101 #define LDAP_DEBUG_ANY          -1
 102
 103 /* debugging stuff */
 104 #ifdef LDAP_DEBUG
 105
 106     /*
 107      * This is a bogus extern declaration for the compiler. No need to ensure
 108      * a 'proper' dllimport.
 109      */
 110 #   ifndef ldap_debug
 111      extern int ldap_debug;
 112 #   endif /* !ldap_debug */
 113
 114 #   ifdef LDAP_SYSLOG
 115     extern int  ldap_syslog;
 116     extern int  ldap_syslog_level;
 117
 118 #       ifdef HAVE_EBCDIC
 119 #       define syslog   eb_syslog
 120         extern void eb_syslog(int pri, const char *fmt, ...);
 121 #       endif
 122
 123 #   endif /* LDAP_SYSLOG */
 124
 125 /* this doesn't below as part of ldap.h */
 126 #   ifdef LDAP_SYSLOG
 127 #   define Debug( level, fmt, arg1, arg2, arg3 )        \
 128         do { \
 129                 if ( ldap_debug & (level) ) \
 130                         lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3) ); \
 131                 if ( ldap_syslog & (level) ) \
 132                         syslog( ldap_syslog_level, (fmt), (arg1), (arg2), (arg3) ); \
 133         } while ( 0 )
 134
 135 #   else
 136 #       define Debug( level, fmt, arg1, arg2, arg3 ) \
 137         do { \
 138                 if ( ldap_debug & (level) ) \
 139                         lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3) ); \
 140         } while ( 0 )
 141 #   endif
 142
 143 #else /* LDAP_DEBUG */
 144 #   define Debug( level, fmt, arg1, arg2, arg3 )
 145
 146 #endif /* LDAP_DEBUG */
 147
 148 #ifdef NEW_LOGGING
 149 extern int ldap_loglevels[LDAP_SUBSYS_NUM];
 150
 151 #ifdef LDAP_DEBUG
 152
 153 #define LDAP_LOG(a, b, fmt, arg1, arg2, arg3) do {\
 154         if (ldap_loglevels[LDAP_SUBSYS_##a] >= LDAP_LEVEL_##b || \
 155                 ldap_loglevels[LDAP_SUBSYS_GLOBAL] >= LDAP_LEVEL_##b)\
 156                    lutil_log (LDAP_SUBSYS_##a, LDAP_LEVEL_##b, fmt, arg1, arg2, arg3); \
 157         } while (0)
 158
 159
 160 #define LDAP_LOGS_TEST(a, b) \
 161         (ldap_loglevels[LDAP_SUBSYS_##a] >= LDAP_LEVEL_##b || \
 162          ldap_loglevels[LDAP_SUBSYS_GLOBAL] >= LDAP_LEVEL_##b)
 163
 164 #endif /* LDAP_DEBUG */
 165
 166 #endif /* NEW_LOGGING */
 167
 168 #ifndef LDAP_LOG
 169 #define LDAP_LOG(a, b, fmt, arg1, arg2, arg3)
 170 #define LDAP_LOGS_TEST(a, b) 0
 171 #endif
 172
 173 LDAP_LUTIL_F(int) lutil_mnem2level LDAP_P(( const char *level ));
 174 LDAP_LUTIL_F(void) lutil_log_initialize LDAP_P((
 175         int argc, char **argv ));
 176 LDAP_LUTIL_F(int) lutil_set_debug_level LDAP_P((
 177         const char *subsys, int level ));
 178 LDAP_LUTIL_F(void) lutil_log LDAP_P((
 179         const int subsys, int level, const char *fmt, ... ));
 180
 181 LDAP_LUTIL_F(int) lutil_debug_file LDAP_P(( FILE *file ));
 182
 183
 184 LDAP_LUTIL_F(void) lutil_debug LDAP_P((
 185         int debug, int level,
 186         const char* fmt, ... )) LDAP_GCCATTR((format(printf, 3, 4)));
 187
 188 LDAP_END_DECL
 189
 190 #endif /* _LDAP_LOG_H */