blob: ef7bea7e1aa23ac5d720ae5fdb3a9a585687d1d8 [file] [log] [blame]
markus@openbsd.org5d140192018-07-27 12:03:17 +00001/* $OpenBSD: log.h,v 1.23 2018/07/27 12:03:17 markus Exp $ */
Ben Lindstrom36579d32001-01-29 07:39:26 +00002
Ben Lindstrom226cfa02001-01-22 05:34:40 +00003/*
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
Kevin Stevesef4eea92001-02-05 12:42:17 +000024 SYSLOG_FACILITY_AUTHPRIV,
Ben Lindstrom226cfa02001-01-22 05:34:40 +000025#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,
Damien Millerfcd93202002-02-05 12:26:34 +110033 SYSLOG_FACILITY_LOCAL7,
Ben Lindstrom38ed63d2002-06-06 19:51:06 +000034 SYSLOG_FACILITY_NOT_SET = -1
Ben Lindstrom226cfa02001-01-22 05:34:40 +000035} 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,
Damien Millerfcd93202002-02-05 12:26:34 +110045 SYSLOG_LEVEL_DEBUG3,
Ben Lindstrom38ed63d2002-06-06 19:51:06 +000046 SYSLOG_LEVEL_NOT_SET = -1
Ben Lindstrom226cfa02001-01-22 05:34:40 +000047} LogLevel;
Ben Lindstrom226cfa02001-01-22 05:34:40 +000048
Damien Miller8f0bf232011-06-20 14:42:23 +100049typedef void (log_handler_fn)(LogLevel, const char *, void *);
50
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000051void log_init(char *, LogLevel, SyslogFacility, int);
markus@openbsd.org5d140192018-07-27 12:03:17 +000052LogLevel log_level_get(void);
djm@openbsd.org54cd41a2017-05-17 01:24:17 +000053int log_change_level(LogLevel);
Darren Tucker50a48d02012-09-06 21:25:37 +100054int log_is_on_stderr(void);
Damien Miller03d4d7e2013-04-23 15:21:06 +100055void log_redirect_stderr_to(const char *);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000056
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000057SyslogFacility log_facility_number(char *);
Darren Tuckere7140f22008-06-10 23:01:51 +100058const char * log_facility_name(SyslogFacility);
59LogLevel log_level_number(char *);
60const char * log_level_name(LogLevel);
Ben Lindstrom226cfa02001-01-22 05:34:40 +000061
Darren Tuckerf8b7eb72008-06-13 10:22:54 +100062void fatal(const char *, ...) __attribute__((noreturn))
63 __attribute__((format(printf, 1, 2)));
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000064void error(const char *, ...) __attribute__((format(printf, 1, 2)));
Darren Tuckerf8b7eb72008-06-13 10:22:54 +100065void sigdie(const char *, ...) __attribute__((noreturn))
66 __attribute__((format(printf, 1, 2)));
dtucker@openbsd.orgaf1f0842016-07-15 05:01:58 +000067void logdie(const char *, ...) __attribute__((noreturn))
68 __attribute__((format(printf, 1, 2)));
Damien Miller996acd22003-04-09 20:59:48 +100069void logit(const char *, ...) __attribute__((format(printf, 1, 2)));
Ben Lindstrom4cc240d2001-07-04 04:46:56 +000070void verbose(const char *, ...) __attribute__((format(printf, 1, 2)));
71void debug(const char *, ...) __attribute__((format(printf, 1, 2)));
72void debug2(const char *, ...) __attribute__((format(printf, 1, 2)));
73void debug3(const char *, ...) __attribute__((format(printf, 1, 2)));
Ben Lindstrom226cfa02001-01-22 05:34:40 +000074
Damien Miller8f0bf232011-06-20 14:42:23 +100075
76void set_log_handler(log_handler_fn *, void *);
77void do_log2(LogLevel, const char *, ...)
78 __attribute__((format(printf, 2, 3)));
Ben Lindstrom9c8edc92002-02-26 17:52:14 +000079void do_log(LogLevel, const char *, va_list);
Darren Tuckerf8b7eb72008-06-13 10:22:54 +100080void cleanup_exit(int) __attribute__((noreturn));
Ben Lindstrom226cfa02001-01-22 05:34:40 +000081#endif