]> git.sur5r.net Git - openldap/blob - include/ldap_log.h
Assist in cache debugging
[openldap] / include / ldap_log.h
1 /* $OpenLDAP$ */
2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
3  * 
4  * Copyright 1998-2004 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  * debug reporting levels.
36  *
37  * They start with the syslog levels, and
38  * go down in importance.  The normal
39  * debugging levels begin with LDAP_LEVEL_ENTRY
40  *
41  */
42 #define LDAP_LEVEL_EMERG       0
43 #define LDAP_LEVEL_ALERT       1
44 #define LDAP_LEVEL_CRIT        2
45 #define LDAP_LEVEL_ERR         3
46 #define LDAP_LEVEL_WARNING     4
47 #define LDAP_LEVEL_NOTICE      5
48 #define LDAP_LEVEL_INFO        6
49 #define LDAP_LEVEL_ENTRY       7  /* log function entry points */
50 #define LDAP_LEVEL_ARGS        8  /* log function call parameters */
51 #define LDAP_LEVEL_RESULTS     9  /* Log function results */
52 #define LDAP_LEVEL_DETAIL1    10  /* log level 1 function operational details */
53 #define LDAP_LEVEL_DETAIL2    11  /* Log level 2 function operational details */
54
55 #define LDAP_DEBUG_TRACE        0x0001
56 #define LDAP_DEBUG_PACKETS      0x0002
57 #define LDAP_DEBUG_ARGS         0x0004
58 #define LDAP_DEBUG_CONNS        0x0008
59 #define LDAP_DEBUG_BER          0x0010
60 #define LDAP_DEBUG_FILTER       0x0020
61 #define LDAP_DEBUG_CONFIG       0x0040
62 #define LDAP_DEBUG_ACL          0x0080
63 #define LDAP_DEBUG_STATS        0x0100
64 #define LDAP_DEBUG_STATS2       0x0200
65 #define LDAP_DEBUG_SHELL        0x0400
66 #define LDAP_DEBUG_PARSE        0x0800
67 #define LDAP_DEBUG_CACHE    0x1000
68 #define LDAP_DEBUG_INDEX    0x2000
69 #define LDAP_DEBUG_SYNC         0x4000
70
71 #define LDAP_DEBUG_NONE         0x8000
72 #define LDAP_DEBUG_ANY          -1
73
74 /* debugging stuff */
75 #ifdef LDAP_DEBUG
76     /*
77      * This is a bogus extern declaration for the compiler. No need to ensure
78      * a 'proper' dllimport.
79      */
80 #   ifndef ldap_debug
81      extern int ldap_debug;
82 #   endif /* !ldap_debug */
83
84 #   ifdef LDAP_SYSLOG
85     extern int  ldap_syslog;
86     extern int  ldap_syslog_level;
87
88 #       ifdef HAVE_EBCDIC
89 #       define syslog   eb_syslog
90         extern void eb_syslog(int pri, const char *fmt, ...);
91 #       endif
92
93 #   endif /* LDAP_SYSLOG */
94
95 /* this doesn't below as part of ldap.h */
96 #   ifdef LDAP_SYSLOG
97 #   define Debug( level, fmt, arg1, arg2, arg3 )        \
98         do { \
99                 if ( ldap_debug & (level) ) \
100                         lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3) ); \
101                 if ( ldap_syslog & (level) ) \
102                         syslog( ldap_syslog_level, (fmt), (arg1), (arg2), (arg3) ); \
103         } while ( 0 )
104
105 #   else
106 #       define Debug( level, fmt, arg1, arg2, arg3 ) \
107         do { \
108                 if ( ldap_debug & (level) ) \
109                         lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3) ); \
110         } while ( 0 )
111 #   endif
112
113 #else /* LDAP_DEBUG */
114 #   define Debug( level, fmt, arg1, arg2, arg3 )
115
116 #endif /* LDAP_DEBUG */
117
118 #ifndef LDAP_LOG
119 #define LDAP_LOG(a, b, fmt, arg1, arg2, arg3)
120 #define LDAP_LOGS_TEST(a, b) 0
121 #endif
122
123 LDAP_LUTIL_F(int) lutil_debug_file LDAP_P(( FILE *file ));
124
125 LDAP_LUTIL_F(void) lutil_debug LDAP_P((
126         int debug, int level,
127         const char* fmt, ... )) LDAP_GCCATTR((format(printf, 3, 4)));
128
129 LDAP_END_DECL
130
131 #endif /* _LDAP_LOG_H */