1 /*	$NetBSD: logging.h,v 1.1.1.1 2009/04/12 15:33:34 christos Exp $	*/
2 
3 /*
4  * Copyright (c) 2004 by Internet Systems Consortium, Inc. ("ISC")
5  * Copyright (c) 1996-1999 by Internet Software Consortium.
6  *
7  * Permission to use, copy, modify, and distribute this software for any
8  * purpose with or without fee is hereby granted, provided that the above
9  * copyright notice and this permission notice appear in all copies.
10  *
11  * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13  * MERCHANTABILITY AND FITNESS.  IN NO EVENT SHALL ISC BE LIABLE FOR
14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
17  * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18  */
19 
20 #ifndef LOGGING_H
21 #define LOGGING_H
22 
23 #include <sys/types.h>
24 #include <stdio.h>
25 #include <stdarg.h>
26 #include <unistd.h>
27 
28 #define log_critical		(-5)
29 #define log_error   		(-4)
30 #define log_warning 		(-3)
31 #define log_notice  		(-2)
32 #define log_info  		(-1)
33 #define log_debug(level)	(level)
34 
35 typedef enum { log_syslog, log_file, log_null } log_channel_type;
36 
37 #define LOG_MAX_VERSIONS 99
38 
39 #define LOG_CLOSE_STREAM		0x0001
40 #define LOG_TIMESTAMP			0x0002
41 #define LOG_TRUNCATE			0x0004
42 #define LOG_USE_CONTEXT_LEVEL		0x0008
43 #define LOG_PRINT_LEVEL			0x0010
44 #define LOG_REQUIRE_DEBUG		0x0020
45 #define LOG_CHANNEL_BROKEN		0x0040
46 #define LOG_PRINT_CATEGORY		0x0080
47 #define LOG_CHANNEL_OFF			0x0100
48 
49 typedef struct log_context *log_context;
50 typedef struct log_channel *log_channel;
51 
52 #define LOG_OPTION_DEBUG		0x01
53 #define LOG_OPTION_LEVEL		0x02
54 
55 #define log_open_stream		__log_open_stream
56 #define log_close_stream	__log_close_stream
57 #define log_get_stream		__log_get_stream
58 #define log_get_filename	__log_get_filename
59 #define log_check_channel	__log_check_channel
60 #define log_check		__log_check
61 #define log_vwrite		__log_vwrite
62 #define log_write		__log_write
63 #define log_new_context		__log_new_context
64 #define log_free_context	__log_free_context
65 #define log_add_channel		__log_add_channel
66 #define log_remove_channel	__log_remove_channel
67 #define log_option		__log_option
68 #define log_category_is_active	__log_category_is_active
69 #define log_new_syslog_channel	__log_new_syslog_channel
70 #define log_new_file_channel	__log_new_file_channel
71 #define log_set_file_owner	__log_set_file_owner
72 #define log_new_null_channel	__log_new_null_channel
73 #define log_inc_references	__log_inc_references
74 #define log_dec_references	__log_dec_references
75 #define log_get_channel_type	__log_get_channel_type
76 #define log_free_channel	__log_free_channel
77 #define log_close_debug_channels	__log_close_debug_channels
78 
79 FILE *			log_open_stream(log_channel);
80 int			log_close_stream(log_channel);
81 FILE *			log_get_stream(log_channel);
82 char *			log_get_filename(log_channel);
83 int			log_check_channel(log_context, int, log_channel);
84 int			log_check(log_context, int, int);
85 #ifdef __GNUC__
86 void			log_vwrite(log_context, int, int, const char *,
87 				   va_list args)
88 				__attribute__((__format__(__printf__, 4, 0)));
89 void			log_write(log_context, int, int, const char *, ...)
90 				__attribute__((__format__(__printf__, 4, 5)));
91 #else
92 void			log_vwrite(log_context, int, int, const char *,
93 				   va_list args);
94 void			log_write(log_context, int, int, const char *, ...);
95 #endif
96 int			log_new_context(int, char **, log_context *);
97 void			log_free_context(log_context);
98 int			log_add_channel(log_context, int, log_channel);
99 int			log_remove_channel(log_context, int, log_channel);
100 int			log_option(log_context, int, int);
101 int			log_category_is_active(log_context, int);
102 log_channel		log_new_syslog_channel(unsigned int, int, int);
103 log_channel		log_new_file_channel(unsigned int, int, const char *,
104 					     FILE *, unsigned int,
105 					     unsigned long);
106 int			log_set_file_owner(log_channel, uid_t, gid_t);
107 log_channel		log_new_null_channel(void);
108 int			log_inc_references(log_channel);
109 int			log_dec_references(log_channel);
110 log_channel_type	log_get_channel_type(log_channel);
111 int			log_free_channel(log_channel);
112 void			log_close_debug_channels(log_context);
113 
114 #endif /* !LOGGING_H */
115 /*! \file */
116