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