1/* SPDX-License-Identifier: BSD-2-Clause */
2/*
3 * logerr: errx with logging
4 * Copyright (c) 2006-2023 Roy Marples <roy@marples.name>
5 * All rights reserved
6
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef LOGERR_H
30#define LOGERR_H
31
32#include <sys/param.h>
33
34#ifndef __printflike
35#if __GNUC__ > 2 || defined(__INTEL_COMPILER)
36#define	__printflike(a, b) __attribute__((format(printf, a, b)))
37#else
38#define	__printflike(a, b)
39#endif
40#endif /* !__printflike */
41
42/* Please do not call log_* functions directly, use macros below */
43__printflike(1, 2) void log_debug(const char *, ...);
44__printflike(1, 2) void log_debugx(const char *, ...);
45__printflike(1, 2) void log_info(const char *, ...);
46__printflike(1, 2) void log_infox(const char *, ...);
47__printflike(1, 2) void log_warn(const char *, ...);
48__printflike(1, 2) void log_warnx(const char *, ...);
49__printflike(1, 2) void log_err(const char *, ...);
50__printflike(1, 2) void log_errx(const char *, ...);
51#define	LOGERROR	logerr("%s: %d", __FILE__, __LINE__)
52
53__printflike(2, 3) void logmessage(int pri, const char *fmt, ...);
54__printflike(2, 3) void logerrmessage(int pri, const char *fmt, ...);
55
56/*
57 * These are macros to prevent taking address of them so
58 * __FILE__, __LINE__, etc can easily be added.
59 *
60 * We should be using
61 * #define loginfox(fmt, __VA_OPT__(,) __VA_ARGS__)
62 * but that requires gcc-8 or clang-6 and we still have a need to support
63 * old OS's without modern compilers.
64 *
65 * Likewise, ##__VA_ARGS__ can't be used as that's a gcc only extension.
66 *
67 * The solution is to put fmt into __VA_ARGS__.
68 * It's not pretty but it's 100% portable.
69 */
70#define logdebug(...)	log_debug(__VA_ARGS__)
71#define logdebugx(...)	log_debugx(__VA_ARGS__)
72#define loginfo(...)	log_info(__VA_ARGS__)
73#define loginfox(...)	log_infox(__VA_ARGS__)
74#define logwarn(...)	log_warn(__VA_ARGS__)
75#define logwarnx(...)	log_warnx(__VA_ARGS__)
76#define logerr(...)	log_err(__VA_ARGS__)
77#define logerrx(...)	log_errx(__VA_ARGS__)
78
79/* For logging in a chroot */
80int loggetfd(void);
81void logsetfd(int);
82int logreadfd(int);
83
84unsigned int loggetopts(void);
85void logsetopts(unsigned int);
86#define	LOGERR_DEBUG	(1U << 6)
87#define	LOGERR_QUIET	(1U << 7)
88#define	LOGERR_LOG	(1U << 11)
89#define	LOGERR_LOG_DATE	(1U << 12)
90#define	LOGERR_LOG_HOST	(1U << 13)
91#define	LOGERR_LOG_TAG	(1U << 14)
92#define	LOGERR_LOG_PID	(1U << 15)
93#define	LOGERR_ERR	(1U << 21)
94#define	LOGERR_ERR_DATE	(1U << 22)
95#define	LOGERR_ERR_HOST	(1U << 23)
96#define	LOGERR_ERR_TAG	(1U << 24)
97#define	LOGERR_ERR_PID	(1U << 25)
98
99/* To build tag support or not. */
100//#define	LOGERR_TAG
101#if defined(LOGERR_TAG)
102void logsettag(const char *);
103#endif
104
105/* Can be called more than once. */
106int logopen(const char *);
107
108/* Should only be called at program exit. */
109void logclose(void);
110
111#endif
112