xref: /netbsd-src/crypto/external/bsd/openssh/dist/log.h (revision 8ecbf5f02b752fcb7debe1a8fab1dc82602bc760)
1 /*	$NetBSD: log.h,v 1.15 2019/10/12 18:32:22 christos Exp $	*/
2 /* $OpenBSD: log.h,v 1.24 2019/09/06 04:53:27 djm Exp $ */
3 
4 /*
5  * Author: Tatu Ylonen <ylo@cs.hut.fi>
6  * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7  *                    All rights reserved
8  *
9  * As far as I am concerned, the code I have written for this software
10  * can be used freely for any purpose.  Any derived versions of this
11  * software must be clearly marked as such, and if the derived work is
12  * incompatible with the protocol description in the RFC file, it must be
13  * called by a name other than "ssh" or "Secure Shell".
14  */
15 
16 #ifndef SSH_LOG_H
17 #define SSH_LOG_H
18 
19 #include <stdarg.h> /* va_list */
20 
21 /* Supported syslog facilities and levels. */
22 typedef enum {
23 	SYSLOG_FACILITY_DAEMON,
24 	SYSLOG_FACILITY_USER,
25 	SYSLOG_FACILITY_AUTH,
26 	SYSLOG_FACILITY_LOCAL0,
27 	SYSLOG_FACILITY_LOCAL1,
28 	SYSLOG_FACILITY_LOCAL2,
29 	SYSLOG_FACILITY_LOCAL3,
30 	SYSLOG_FACILITY_LOCAL4,
31 	SYSLOG_FACILITY_LOCAL5,
32 	SYSLOG_FACILITY_LOCAL6,
33 	SYSLOG_FACILITY_LOCAL7,
34 	SYSLOG_FACILITY_NOT_SET = -1
35 }       SyslogFacility;
36 
37 typedef enum {
38 	SYSLOG_LEVEL_QUIET,
39 	SYSLOG_LEVEL_FATAL,
40 	SYSLOG_LEVEL_ERROR,
41 	SYSLOG_LEVEL_INFO,
42 	SYSLOG_LEVEL_VERBOSE,
43 	SYSLOG_LEVEL_DEBUG1,
44 	SYSLOG_LEVEL_DEBUG2,
45 	SYSLOG_LEVEL_DEBUG3,
46 	SYSLOG_LEVEL_NOT_SET = -1
47 }       LogLevel;
48 
49 typedef void (log_handler_fn)(LogLevel, const char *, void *);
50 
51 void     log_init(const char *, LogLevel, SyslogFacility, int);
52 LogLevel log_level_get(void);
53 int      log_change_level(LogLevel);
54 int      log_is_on_stderr(void);
55 void     log_redirect_stderr_to(const char *);
56 
57 SyslogFacility	log_facility_number(char *);
58 const char * 	log_facility_name(SyslogFacility);
59 LogLevel	log_level_number(char *);
60 const char *	log_level_name(LogLevel);
61 
62 void     fatal(const char *, ...) __attribute__((noreturn))
63     __attribute__((format(printf, 1, 2)));
64 void     error(const char *, ...) __attribute__((format(printf, 1, 2)));
65 void     sigdie(const char *, ...)  __attribute__((noreturn))
66     __attribute__((format(printf, 1, 2)));
67 void     logdie(const char *, ...) __attribute__((noreturn))
68     __attribute__((format(printf, 1, 2)));
69 void     logit(const char *, ...) __attribute__((format(printf, 1, 2)));
70 void     verbose(const char *, ...) __attribute__((format(printf, 1, 2)));
71 void     debug(const char *, ...) __attribute__((format(printf, 1, 2)));
72 void     debug2(const char *, ...) __attribute__((format(printf, 1, 2)));
73 void     debug3(const char *, ...) __attribute__((format(printf, 1, 2)));
74 
75 
76 void	 set_log_handler(log_handler_fn *, void *);
77 void	 do_log2(LogLevel, const char *, ...)
78     __attribute__((format(printf, 2, 3)));
79 void	 do_log(LogLevel, const char *, va_list)
80     __attribute__((format(printf, 2, 0)));
81 void	 cleanup_exit(int) __attribute__((noreturn));
82 #endif
83