Update copyright notices

[openldap] / include / ldap_log.h

diff --git a/include/ldap_log.h b/include/ldap_log.h
index d368b8f6a0c39add2b09ba00243af062e8f4fc29..30f57c418c268304ba8766136d0b3a6f73cdd4d6 100644 (file)
--- a/include/ldap_log.h
+++ b/include/ldap_log.h
@@ -1,4 +1,15 @@
+/* $OpenLDAP$ */
 /*
+ * Copyright 1998-2002 The OpenLDAP Foundation, Redwood City, California, USA
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted only as authorized by the OpenLDAP
+ * Public License.  A copy of this license is available at
+ * http://www.OpenLDAP.org/license.html or in file LICENSE in the
+ * top-level directory of the distribution.
+ */
+/* Portions
  * Copyright (c) 1990 Regents of the University of Michigan.
  * All rights reserved.
  *
@@ -13,21 +24,53 @@
 #ifndef _LDAP_LOG_H
 #define _LDAP_LOG_H
 
+#include <stdio.h>
 #include <ldap_cdefs.h>
 
 LDAP_BEGIN_DECL
 
-/* debugging stuff */
-#ifdef LDAP_DEBUG
+/*
+ * While it's not important that the subsystem number are
+ * contiguous, it is important that the LDAP_SUBSYS_NUM accurately
+ * reflect the number of subsystems and LDAP_SUBSYS_MAX reflect
+ * the largest subsystem number.
+ */
+#define LDAP_SUBSYS_NUM 12
+#define LDAP_SUBSYS_MAX 11
 
-#ifndef ldap_debug
-extern int     ldap_debug;
-#endif /* !ldap_debug */
+#define LDAP_SUBSYS_GLOBAL      0
+#define LDAP_SUBSYS_OPERATION   1
+#define LDAP_SUBSYS_TRANSPORT   2
+#define LDAP_SUBSYS_CONNECTION  3
+#define LDAP_SUBSYS_FILTER      4
+#define LDAP_SUBSYS_BACKEND     5
+#define LDAP_SUBSYS_BER         6
+#define LDAP_SUBSYS_CONFIG      7
+#define LDAP_SUBSYS_ACL         8
+#define LDAP_SUBSYS_CACHE       9
+#define LDAP_SUBSYS_INDEX      10
+#define LDAP_SUBSYS_LDIF       11
 
-#ifdef LDAP_SYSLOG
-extern int     ldap_syslog;
-extern int     ldap_syslog_level;
-#endif /* LDAP_SYSLOG */
+/*
+ * debug reporting levels.
+ *
+ * They start with the syslog levels, and
+ * go down in importance.  The normal
+ * debugging levels begin with LDAP_LEVEL_ENTRY
+ *
+ */
+#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_ENTRY       7  /* log function entry points */
+#define LDAP_LEVEL_ARGS        8  /* log function call parameters */
+#define LDAP_LEVEL_RESULTS     9  /* Log function results */
+#define LDAP_LEVEL_DETAIL1    10  /* log level 1 function operational details */
+#define LDAP_LEVEL_DETAIL2    11  /* Log level 2 function operational details */
 
 #define LDAP_DEBUG_TRACE       0x0001
 #define LDAP_DEBUG_PACKETS     0x0002
@@ -41,32 +84,76 @@ extern int  ldap_syslog_level;
 #define LDAP_DEBUG_STATS2      0x0200
 #define LDAP_DEBUG_SHELL       0x0400
 #define LDAP_DEBUG_PARSE       0x0800
+#define LDAP_DEBUG_CACHE    0x1000
+#define LDAP_DEBUG_INDEX    0x2000
 
+#define LDAP_DEBUG_DEPRECATED  0x1000
 #define LDAP_DEBUG_NONE                0x8000
 #define LDAP_DEBUG_ANY         -1
 
+/* debugging stuff */
+#ifdef LDAP_DEBUG
+
+    /*
+     * This is a bogus extern declaration for the compiler. No need to ensure
+     * a 'proper' dllimport.
+     */
+#   ifndef ldap_debug
+     extern int        ldap_debug;
+#   endif /* !ldap_debug */
+
+#   ifdef LDAP_SYSLOG
+    extern int ldap_syslog;
+    extern int ldap_syslog_level;
+#   endif /* LDAP_SYSLOG */
+
 /* this doesn't below as part of ldap.h */
-#ifdef LDAP_SYSLOG
-#define Debug( level, fmt, arg1, arg2, arg3 )  \
-       { \
+#   ifdef LDAP_SYSLOG
+#   define Debug( level, fmt, arg1, arg2, arg3 )       \
+       do { \
                if ( ldap_debug & (level) ) \
-                       fprintf( stderr, (fmt), (arg1), (arg2), (arg3) ); \
-               if ( ldap_syslog & level ) \
+                       lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3) ); \
+               if ( ldap_syslog & (level) ) \
                        syslog( ldap_syslog_level, (fmt), (arg1), (arg2), (arg3) ); \
-       }
-#else /* LDAP_SYSLOG */
-#ifndef WINSOCK
-#define Debug( level, fmt, arg1, arg2, arg3 ) \
+       } while ( 0 )
+
+#   else
+#       define Debug( level, fmt, arg1, arg2, arg3 ) \
+       do { \
                if ( ldap_debug & (level) ) \
-                       fprintf( stderr, (fmt), (arg1), (arg2), (arg3) );
-#else /* !WINSOCK */
-extern void Debug( int level, char* fmt, ... );
-#endif /* !WINSOCK */
-#endif /* LDAP_SYSLOG */
+                       lutil_debug( ldap_debug, (level), (fmt), (arg1), (arg2), (arg3) ); \
+       } while ( 0 )
+#   endif
+
+#ifndef LDAP_LOG
+#   define LDAP_LOG(a) lutil_log a
+#endif
+
 #else /* LDAP_DEBUG */
-#define Debug( level, fmt, arg1, arg2, arg3 )
+#   define Debug( level, fmt, arg1, arg2, arg3 )
+
+#ifndef LDAP_LOG
+#   define LDAP_LOG(a)
+#endif
+
 #endif /* LDAP_DEBUG */
 
+
+LDAP_LUTIL_F(int) lutil_mnem2level LDAP_P(( const char *level ));
+LDAP_LUTIL_F(void) lutil_log_initialize LDAP_P((
+       int argc, char **argv ));
+LDAP_LUTIL_F(void) lutil_set_debug_level LDAP_P((
+       const char *subsys, int level ));
+LDAP_LUTIL_F(void) lutil_log LDAP_P((
+       const char *subsys, int level, const char *fmt, ... ));
+
+LDAP_LUTIL_F(int) lutil_debug_file LDAP_P(( FILE *file ));
+
+
+LDAP_LUTIL_F(void) lutil_debug LDAP_P((
+       int debug, int level,
+       const char* fmt, ... )) LDAP_GCCATTR((format(printf, 3, 4)));
+
 LDAP_END_DECL
 
 #endif /* _LDAP_LOG_H */