1999-08-31 09:17:01 +08:00
|
|
|
/* $OpenLDAP$ */
|
2003-11-26 15:16:36 +08:00
|
|
|
/* This work is part of OpenLDAP Software <http://www.openldap.org/>.
|
|
|
|
*
|
2008-01-08 08:19:56 +08:00
|
|
|
* Copyright 1998-2008 The OpenLDAP Foundation.
|
1998-12-29 03:51:35 +08:00
|
|
|
* All rights reserved.
|
|
|
|
*
|
2001-05-29 11:29:53 +08:00
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted only as authorized by the OpenLDAP
|
2003-11-26 15:16:36 +08:00
|
|
|
* Public License.
|
|
|
|
*
|
|
|
|
* A copy of this license is available in file LICENSE in the
|
|
|
|
* top-level directory of the distribution or, alternatively, at
|
|
|
|
* <http://www.OpenLDAP.org/license.html>.
|
1998-12-29 03:51:35 +08:00
|
|
|
*/
|
2003-11-26 15:16:36 +08:00
|
|
|
/* Portions Copyright (c) 1990 Regents of the University of Michigan.
|
1998-10-26 09:18:41 +08:00
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms are permitted
|
|
|
|
* provided that this notice is preserved and that due credit is given
|
|
|
|
* to the University of Michigan at Ann Arbor. The name of the University
|
|
|
|
* may not be used to endorse or promote products derived from this
|
|
|
|
* software without specific prior written permission. This software
|
|
|
|
* is provided ``as is'' without express or implied warranty.
|
|
|
|
*/
|
|
|
|
|
2005-12-28 00:29:37 +08:00
|
|
|
#ifndef LDAP_LOG_H
|
|
|
|
#define LDAP_LOG_H
|
1998-10-26 09:18:41 +08:00
|
|
|
|
2000-10-13 04:01:12 +08:00
|
|
|
#include <stdio.h>
|
1998-10-26 09:18:41 +08:00
|
|
|
#include <ldap_cdefs.h>
|
|
|
|
|
|
|
|
LDAP_BEGIN_DECL
|
|
|
|
|
2000-10-13 04:01:12 +08:00
|
|
|
/*
|
|
|
|
* debug reporting levels.
|
|
|
|
*
|
|
|
|
* They start with the syslog levels, and
|
|
|
|
* go down in importance. The normal
|
|
|
|
* debugging levels begin with LDAP_LEVEL_ENTRY
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2005-12-28 00:29:37 +08:00
|
|
|
/*
|
|
|
|
* The "OLD_DEBUG" means that all logging occurs at LOG_DEBUG
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifdef OLD_DEBUG
|
|
|
|
/* original behavior: all logging occurs at the same severity level */
|
|
|
|
#if defined(LDAP_DEBUG) && defined(LDAP_SYSLOG)
|
|
|
|
#define LDAP_LEVEL_EMERG ldap_syslog_level
|
|
|
|
#define LDAP_LEVEL_ALERT ldap_syslog_level
|
|
|
|
#define LDAP_LEVEL_CRIT ldap_syslog_level
|
|
|
|
#define LDAP_LEVEL_ERR ldap_syslog_level
|
|
|
|
#define LDAP_LEVEL_WARNING ldap_syslog_level
|
|
|
|
#define LDAP_LEVEL_NOTICE ldap_syslog_level
|
|
|
|
#define LDAP_LEVEL_INFO ldap_syslog_level
|
|
|
|
#define LDAP_LEVEL_DEBUG ldap_syslog_level
|
|
|
|
#else /* !LDAP_DEBUG || !LDAP_SYSLOG */
|
|
|
|
#define LDAP_LEVEL_EMERG (7)
|
|
|
|
#define LDAP_LEVEL_ALERT (7)
|
|
|
|
#define LDAP_LEVEL_CRIT (7)
|
|
|
|
#define LDAP_LEVEL_ERR (7)
|
|
|
|
#define LDAP_LEVEL_WARNING (7)
|
|
|
|
#define LDAP_LEVEL_NOTICE (7)
|
|
|
|
#define LDAP_LEVEL_INFO (7)
|
|
|
|
#define LDAP_LEVEL_DEBUG (7)
|
|
|
|
#endif /* !LDAP_DEBUG || !LDAP_SYSLOG */
|
|
|
|
|
|
|
|
#else /* ! OLD_DEBUG */
|
|
|
|
/* map syslog onto LDAP severity levels */
|
|
|
|
#ifdef LOG_DEBUG
|
|
|
|
#define LDAP_LEVEL_EMERG LOG_EMERG
|
|
|
|
#define LDAP_LEVEL_ALERT LOG_ALERT
|
|
|
|
#define LDAP_LEVEL_CRIT LOG_CRIT
|
|
|
|
#define LDAP_LEVEL_ERR LOG_ERR
|
|
|
|
#define LDAP_LEVEL_WARNING LOG_WARNING
|
|
|
|
#define LDAP_LEVEL_NOTICE LOG_NOTICE
|
|
|
|
#define LDAP_LEVEL_INFO LOG_INFO
|
|
|
|
#define LDAP_LEVEL_DEBUG LOG_DEBUG
|
|
|
|
#else /* ! LOG_DEBUG */
|
|
|
|
#define LDAP_LEVEL_EMERG (0)
|
|
|
|
#define LDAP_LEVEL_ALERT (1)
|
|
|
|
#define LDAP_LEVEL_CRIT (2)
|
|
|
|
#define LDAP_LEVEL_ERR (3)
|
|
|
|
#define LDAP_LEVEL_WARNING (4)
|
|
|
|
#define LDAP_LEVEL_NOTICE (5)
|
|
|
|
#define LDAP_LEVEL_INFO (6)
|
|
|
|
#define LDAP_LEVEL_DEBUG (7)
|
|
|
|
#endif /* ! LOG_DEBUG */
|
|
|
|
#endif /* ! OLD_DEBUG */
|
|
|
|
#if 0
|
|
|
|
/* in case we need to reuse the unused bits of severity */
|
|
|
|
#define LDAP_LEVEL_MASK(s) ((s) & 0x7)
|
|
|
|
#else
|
|
|
|
#define LDAP_LEVEL_MASK(s) (s)
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* (yet) unused */
|
|
|
|
#define LDAP_LEVEL_ENTRY (0x08) /* log function entry points */
|
|
|
|
#define LDAP_LEVEL_ARGS (0x10) /* log function call parameters */
|
|
|
|
#define LDAP_LEVEL_RESULTS (0x20) /* Log function results */
|
|
|
|
#define LDAP_LEVEL_DETAIL1 (0x40) /* log level 1 function operational details */
|
|
|
|
#define LDAP_LEVEL_DETAIL2 (0x80) /* Log level 2 function operational details */
|
|
|
|
/* end of (yet) unused */
|
|
|
|
|
|
|
|
/* original subsystem selection mechanism */
|
1998-12-22 09:34:01 +08:00
|
|
|
#define LDAP_DEBUG_TRACE 0x0001
|
|
|
|
#define LDAP_DEBUG_PACKETS 0x0002
|
|
|
|
#define LDAP_DEBUG_ARGS 0x0004
|
|
|
|
#define LDAP_DEBUG_CONNS 0x0008
|
|
|
|
#define LDAP_DEBUG_BER 0x0010
|
|
|
|
#define LDAP_DEBUG_FILTER 0x0020
|
|
|
|
#define LDAP_DEBUG_CONFIG 0x0040
|
|
|
|
#define LDAP_DEBUG_ACL 0x0080
|
|
|
|
#define LDAP_DEBUG_STATS 0x0100
|
|
|
|
#define LDAP_DEBUG_STATS2 0x0200
|
|
|
|
#define LDAP_DEBUG_SHELL 0x0400
|
|
|
|
#define LDAP_DEBUG_PARSE 0x0800
|
2005-12-23 06:33:32 +08:00
|
|
|
#if 0 /* no longer used (nor supported) */
|
|
|
|
#define LDAP_DEBUG_CACHE 0x1000
|
|
|
|
#define LDAP_DEBUG_INDEX 0x2000
|
|
|
|
#endif
|
2004-10-09 17:26:16 +08:00
|
|
|
#define LDAP_DEBUG_SYNC 0x4000
|
1998-12-22 09:34:01 +08:00
|
|
|
|
|
|
|
#define LDAP_DEBUG_NONE 0x8000
|
|
|
|
#define LDAP_DEBUG_ANY -1
|
1998-10-26 09:18:41 +08:00
|
|
|
|
1998-12-23 12:18:50 +08:00
|
|
|
/* debugging stuff */
|
|
|
|
#ifdef LDAP_DEBUG
|
2000-10-13 05:13:56 +08:00
|
|
|
/*
|
|
|
|
* This is a bogus extern declaration for the compiler. No need to ensure
|
|
|
|
* a 'proper' dllimport.
|
|
|
|
*/
|
2005-12-28 00:29:37 +08:00
|
|
|
#ifndef ldap_debug
|
|
|
|
extern int ldap_debug;
|
|
|
|
#endif /* !ldap_debug */
|
2000-10-13 05:13:56 +08:00
|
|
|
|
2005-12-28 00:29:37 +08:00
|
|
|
#ifdef LDAP_SYSLOG
|
|
|
|
extern int ldap_syslog;
|
|
|
|
extern int ldap_syslog_level;
|
2004-02-03 11:58:38 +08:00
|
|
|
|
2005-12-28 00:29:37 +08:00
|
|
|
#ifdef HAVE_EBCDIC
|
|
|
|
#define syslog eb_syslog
|
|
|
|
extern void eb_syslog(int pri, const char *fmt, ...);
|
|
|
|
#endif /* HAVE_EBCDIC */
|
2004-02-03 11:58:38 +08:00
|
|
|
|
2005-12-28 00:29:37 +08:00
|
|
|
#endif /* LDAP_SYSLOG */
|
1998-12-23 12:18:50 +08:00
|
|
|
|
1998-10-26 09:18:41 +08:00
|
|
|
/* this doesn't below as part of ldap.h */
|
2005-12-28 00:29:37 +08:00
|
|
|
#ifdef LDAP_SYSLOG
|
2005-12-28 09:22:56 +08:00
|
|
|
#define Log0( level, severity, fmt ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt) ); \
|
|
|
|
if ( ldap_syslog & (level) ) \
|
|
|
|
syslog( LDAP_LEVEL_MASK((severity)), (fmt) ); \
|
|
|
|
} while ( 0 )
|
2005-12-28 00:29:37 +08:00
|
|
|
#define Log1( level, severity, fmt, arg1 ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1) ); \
|
|
|
|
if ( ldap_syslog & (level) ) \
|
|
|
|
syslog( LDAP_LEVEL_MASK((severity)), (fmt), (arg1) ); \
|
|
|
|
} while ( 0 )
|
|
|
|
#define Log2( level, severity, fmt, arg1, arg2 ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2) ); \
|
|
|
|
if ( ldap_syslog & (level) ) \
|
|
|
|
syslog( LDAP_LEVEL_MASK((severity)), (fmt), (arg1), (arg2) ); \
|
|
|
|
} while ( 0 )
|
|
|
|
#define Log3( level, severity, fmt, arg1, arg2, arg3 ) \
|
1999-04-30 08:53:10 +08:00
|
|
|
do { \
|
2001-09-22 01:53:16 +08:00
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3) ); \
|
1999-03-14 15:15:58 +08:00
|
|
|
if ( ldap_syslog & (level) ) \
|
2005-12-28 00:29:37 +08:00
|
|
|
syslog( LDAP_LEVEL_MASK((severity)), (fmt), (arg1), (arg2), (arg3) ); \
|
|
|
|
} while ( 0 )
|
|
|
|
#define Log4( level, severity, fmt, arg1, arg2, arg3, arg4 ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3), (arg4) ); \
|
|
|
|
if ( ldap_syslog & (level) ) \
|
|
|
|
syslog( LDAP_LEVEL_MASK((severity)), (fmt), (arg1), (arg2), (arg3), (arg4) ); \
|
|
|
|
} while ( 0 )
|
|
|
|
#define Log5( level, severity, fmt, arg1, arg2, arg3, arg4, arg5 ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3), (arg4), (arg5) ); \
|
|
|
|
if ( ldap_syslog & (level) ) \
|
|
|
|
syslog( LDAP_LEVEL_MASK((severity)), (fmt), (arg1), (arg2), (arg3), (arg4), (arg5) ); \
|
1999-04-30 08:53:10 +08:00
|
|
|
} while ( 0 )
|
2005-12-28 00:29:37 +08:00
|
|
|
#define Debug( level, fmt, arg1, arg2, arg3 ) \
|
|
|
|
Log3( (level), ldap_syslog_level, (fmt), (arg1), (arg2), (arg3) )
|
|
|
|
#define LogTest(level) ( ( ldap_debug | ldap_syslog ) & (level) )
|
1999-06-22 06:33:35 +08:00
|
|
|
|
2005-12-28 00:29:37 +08:00
|
|
|
#else /* ! LDAP_SYSLOG */
|
2005-12-28 09:22:56 +08:00
|
|
|
#define Log0( level, severity, fmt ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt) ); \
|
|
|
|
} while ( 0 )
|
2005-12-28 00:29:37 +08:00
|
|
|
#define Log1( level, severity, fmt, arg1 ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1) ); \
|
|
|
|
} while ( 0 )
|
|
|
|
#define Log2( level, severity, fmt, arg1, arg2 ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2) ); \
|
|
|
|
} while ( 0 )
|
|
|
|
#define Log3( level, severity, fmt, arg1, arg2, arg3 ) \
|
2001-09-22 01:53:16 +08:00
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3) ); \
|
|
|
|
} while ( 0 )
|
2005-12-28 00:29:37 +08:00
|
|
|
#define Log4( level, severity, fmt, arg1, arg2, arg3, arg4 ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3), (arg4) ); \
|
|
|
|
} while ( 0 )
|
|
|
|
#define Log5( level, severity, fmt, arg1, arg2, arg3, arg4, arg5 ) \
|
|
|
|
do { \
|
|
|
|
if ( ldap_debug & (level) ) \
|
|
|
|
lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3), (arg4), (arg5) ); \
|
|
|
|
} while ( 0 )
|
|
|
|
#define Debug( level, fmt, arg1, arg2, arg3 ) \
|
2006-05-11 12:30:21 +08:00
|
|
|
Log3( (level), 0, (fmt), (arg1), (arg2), (arg3) )
|
2005-12-28 00:29:37 +08:00
|
|
|
#define LogTest(level) ( ldap_debug & (level) )
|
|
|
|
#endif /* ! LDAP_SYSLOG */
|
|
|
|
#else /* ! LDAP_DEBUG */
|
|
|
|
/* TODO: in case LDAP_DEBUG is undefined, make sure logs with appropriate
|
|
|
|
* severity gets thru anyway */
|
2006-04-17 00:03:49 +08:00
|
|
|
#define Log0( level, severity, fmt ) ((void)0)
|
|
|
|
#define Log1( level, severity, fmt, arg1 ) ((void)0)
|
|
|
|
#define Log2( level, severity, fmt, arg1, arg2 ) ((void)0)
|
|
|
|
#define Log3( level, severity, fmt, arg1, arg2, arg3 ) ((void)0)
|
|
|
|
#define Log4( level, severity, fmt, arg1, arg2, arg3, arg4 ) ((void)0)
|
|
|
|
#define Log5( level, severity, fmt, arg1, arg2, arg3, arg4, arg5 ) ((void)0)
|
|
|
|
#define Debug( level, fmt, arg1, arg2, arg3 ) ((void)0)
|
2005-12-28 00:29:37 +08:00
|
|
|
#define LogTest(level) ( 0 )
|
|
|
|
#endif /* ! LDAP_DEBUG */
|
2000-10-13 04:01:12 +08:00
|
|
|
|
|
|
|
LDAP_LUTIL_F(int) lutil_debug_file LDAP_P(( FILE *file ));
|
|
|
|
|
2000-06-19 03:48:07 +08:00
|
|
|
LDAP_LUTIL_F(void) lutil_debug LDAP_P((
|
1999-06-22 06:33:35 +08:00
|
|
|
int debug, int level,
|
1999-09-04 05:06:33 +08:00
|
|
|
const char* fmt, ... )) LDAP_GCCATTR((format(printf, 3, 4)));
|
1999-06-22 06:33:35 +08:00
|
|
|
|
1998-10-26 09:18:41 +08:00
|
|
|
LDAP_END_DECL
|
|
|
|
|
2005-12-28 00:29:37 +08:00
|
|
|
#endif /* LDAP_LOG_H */
|