log.h revision 323129 
1/* $OpenBSD: log.h,v 1.21 2016/07/15 05:01:58 dtucker 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/* Supported syslog facilities and levels. */
19typedef enum {
20	SYSLOG_FACILITY_DAEMON,
21	SYSLOG_FACILITY_USER,
22	SYSLOG_FACILITY_AUTH,
23#ifdef LOG_AUTHPRIV
24	SYSLOG_FACILITY_AUTHPRIV,
25#endif
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
37typedef 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
49typedef void (log_handler_fn)(LogLevel, const char *, void *);
50
51void     log_init(char *, LogLevel, SyslogFacility, int);
52void     log_change_level(LogLevel);
53int      log_is_on_stderr(void);
54void     log_redirect_stderr_to(const char *);
55
56SyslogFacility	log_facility_number(char *);
57const char * 	log_facility_name(SyslogFacility);
58LogLevel	log_level_number(char *);
59const char *	log_level_name(LogLevel);
60
61void     fatal(const char *, ...) __attribute__((noreturn))
62    __attribute__((format(printf, 1, 2)));
63void     error(const char *, ...) __attribute__((format(printf, 1, 2)));
64void     sigdie(const char *, ...)  __attribute__((noreturn))
65    __attribute__((format(printf, 1, 2)));
66void     logdie(const char *, ...) __attribute__((noreturn))
67    __attribute__((format(printf, 1, 2)));
68void     logit(const char *, ...) __attribute__((format(printf, 1, 2)));
69void     verbose(const char *, ...) __attribute__((format(printf, 1, 2)));
70void     debug(const char *, ...) __attribute__((format(printf, 1, 2)));
71void     debug2(const char *, ...) __attribute__((format(printf, 1, 2)));
72void     debug3(const char *, ...) __attribute__((format(printf, 1, 2)));
73
74
75void	 set_log_handler(log_handler_fn *, void *);
76void	 do_log2(LogLevel, const char *, ...)
77    __attribute__((format(printf, 2, 3)));
78void	 do_log(LogLevel, const char *, va_list);
79void	 cleanup_exit(int) __attribute__((noreturn));
80#endif
81