[mirror_frr.git] / lib / log.h

/*
 * Zebra logging funcions.
 * Copyright (C) 1997, 1998, 1999 Kunihiro Ishiguro
 *
 * This file is part of GNU Zebra.
 *
 * GNU Zebra is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2, or (at your option) any
 * later version.
 *
 * GNU Zebra is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; see the file COPYING; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 */

#ifndef _ZEBRA_LOG_H
#define _ZEBRA_LOG_H

#include <syslog.h>
#include <stdint.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdarg.h>
#include "lib/hook.h"

#ifdef __cplusplus
extern "C" {
#endif

/* Hook for external logging function */
DECLARE_HOOK(zebra_ext_log, (int priority, const char *format, va_list args),
	     (priority, format, args));

/* Here is some guidance on logging levels to use:
 *
 * LOG_DEBUG	- For all messages that are enabled by optional debugging
 *		  features, typically preceded by "if (IS...DEBUG...)"
 * LOG_INFO	- Information that may be of interest, but everything seems
 *		  to be working properly.
 * LOG_NOTICE	- Only for message pertaining to daemon startup or shutdown.
 * LOG_WARNING	- Warning conditions: unexpected events, but the daemon believes
 *		  it can continue to operate correctly.
 * LOG_ERR	- Error situations indicating malfunctions.  Probably require
 *		  attention.
 *
 * Note: LOG_CRIT, LOG_ALERT, and LOG_EMERG are currently not used anywhere,
 * please use LOG_ERR instead.
 */

/* If maxlvl is set to ZLOG_DISABLED, then no messages will be sent
   to that logging destination. */
#define ZLOG_DISABLED	(LOG_EMERG-1)

typedef enum {
	ZLOG_DEST_SYSLOG = 0,
	ZLOG_DEST_STDOUT,
	ZLOG_DEST_MONITOR,
	ZLOG_DEST_FILE
} zlog_dest_t;
#define ZLOG_NUM_DESTS		(ZLOG_DEST_FILE+1)

extern bool zlog_startup_stderr;

/* Message structure. */
struct message {
	int key;
	const char *str;
};

/* Open zlog function */
extern void openzlog(const char *progname, const char *protoname,
		     uint16_t instance, int syslog_options,
		     int syslog_facility);

/* Close zlog function. */
extern void closezlog(void);

/* GCC have printf type attribute check.  */
#ifdef __GNUC__
#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
#else
#define PRINTF_ATTRIBUTE(a,b)
#endif /* __GNUC__ */

/* Handy zlog functions. */
extern void zlog_err(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
extern void zlog_warn(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
extern void zlog_info(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
extern void zlog_notice(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
extern void zlog_debug(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
extern void zlog(int priority, const char *format, ...) PRINTF_ATTRIBUTE(2, 3);

/* For logs which have error codes associated with them */
#define flog_err(ferr_id, format, ...)                                        \
	zlog_err("[EC %" PRIu32 "] " format, ferr_id, ##__VA_ARGS__)
#define flog_err_sys(ferr_id, format, ...)                                     \
	flog_err(ferr_id, format, ##__VA_ARGS__)
#define flog_warn(ferr_id, format, ...)                                        \
	zlog_warn("[EC %" PRIu32 "] " format, ferr_id, ##__VA_ARGS__)
#define flog(priority, ferr_id, format, ...)                                   \
	zlog(priority, "[EC %" PRIu32 "] " format, ferr_id, ##__VA_ARGS__)

extern void zlog_thread_info(int log_level);

/* Set logging level for the given destination.  If the log_level
   argument is ZLOG_DISABLED, then the destination is disabled.
   This function should not be used for file logging (use zlog_set_file
   or zlog_reset_file instead). */
extern void zlog_set_level(zlog_dest_t, int log_level);

/* Set logging to the given filename at the specified level. */
extern int zlog_set_file(const char *filename, int log_level);
/* Disable file logging. */
extern int zlog_reset_file(void);

/* Rotate log. */
extern int zlog_rotate(void);

const char *lookup_msg(const struct message *mz, int kz, const char *nf);

/* Safe version of strerror -- never returns NULL. */
extern const char *safe_strerror(int errnum);

/* To be called when a fatal signal is caught. */
extern void zlog_signal(int signo, const char *action, void *siginfo,
			void *program_counter);

/* Log a backtrace. */
extern void zlog_backtrace(int priority);

/* Log a backtrace, but in an async-signal-safe way.  Should not be
   called unless the program is about to exit or abort, since it messes
   up the state of zlog file pointers.  If program_counter is non-NULL,
   that is logged in addition to the current backtrace. */
extern void zlog_backtrace_sigsafe(int priority, void *program_counter);

/* Puts a current timestamp in buf and returns the number of characters
   written (not including the terminating NUL).  The purpose of
   this function is to avoid calls to localtime appearing all over the code.
   It caches the most recent localtime result and can therefore
   avoid multiple calls within the same second.  If buflen is too small,
   *buf will be set to '\0', and 0 will be returned. */
#define QUAGGA_TIMESTAMP_LEN 40
extern size_t quagga_timestamp(int timestamp_precision /* # subsecond digits */,
			       char *buf, size_t buflen);

extern void zlog_hexdump(const void *mem, unsigned int len);
extern const char *zlog_sanitize(char *buf, size_t bufsz, const void *in,
				 size_t inlen);

/* Note: whenever a new route-type or zserv-command is added the
 * corresponding {command,route}_types[] table in lib/log.c MUST be
 * updated! */

/* Map a route type to a string.  For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
extern const char *zebra_route_string(unsigned int route_type);
/* Map a route type to a char.  For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
extern char zebra_route_char(unsigned int route_type);
/* Map a zserv command type to the same string,
 * e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
/* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
extern int proto_name2num(const char *s);
/* Map redistribute X argument to protocol number.
 * unlike proto_name2num, this accepts shorthands and takes
 * an AFI value to restrict input */
extern int proto_redistnum(int afi, const char *s);

extern const char *zserv_command_string(unsigned int command);


extern int vzlog_test(int priority);

/* structure useful for avoiding repeated rendering of the same timestamp */
struct timestamp_control {
	size_t len;			/* length of rendered timestamp */
	int precision;			/* configuration parameter */
	int already_rendered;		/* should be initialized to 0 */
	char buf[QUAGGA_TIMESTAMP_LEN]; /* will contain the rendered timestamp
					   */
};

/* Defines for use in command construction: */

#define LOG_LEVEL_DESC                                                         \
	"System is unusable\n"                                                 \
	"Immediate action needed\n"                                            \
	"Critical conditions\n"                                                \
	"Error conditions\n"                                                   \
	"Warning conditions\n"                                                 \
	"Normal but significant conditions\n"                                  \
	"Informational messages\n"                                             \
	"Debugging messages\n"

#define LOG_FACILITY_DESC                                                      \
	"Kernel\n"                                                             \
	"User process\n"                                                       \
	"Mail system\n"                                                        \
	"System daemons\n"                                                     \
	"Authorization system\n"                                               \
	"Syslog itself\n"                                                      \
	"Line printer system\n"                                                \
	"USENET news\n"                                                        \
	"Unix-to-Unix copy system\n"                                           \
	"Cron/at facility\n"                                                   \
	"Local use\n"                                                          \
	"Local use\n"                                                          \
	"Local use\n"                                                          \
	"Local use\n"                                                          \
	"Local use\n"                                                          \
	"Local use\n"                                                          \
	"Local use\n"                                                          \
	"Local use\n"

#ifdef __cplusplus
}
#endif

#endif /* _ZEBRA_LOG_H */
Commit	Line	Data
274a4a44	1	/*
274a4a44	2	* Zebra logging funcions.
718e3744	3	* Copyright (C) 1997, 1998, 1999 Kunihiro Ishiguro
	4	*
	5	* This file is part of GNU Zebra.
	6	*
	7	* GNU Zebra is free software; you can redistribute it and/or modify it
	8	* under the terms of the GNU General Public License as published by the
	9	* Free Software Foundation; either version 2, or (at your option) any
	10	* later version.
	11	*
	12	* GNU Zebra is distributed in the hope that it will be useful, but
	13	* WITHOUT ANY WARRANTY; without even the implied warranty of
	14	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	15	* General Public License for more details.
	16	*
896014f4 DL	17	* You should have received a copy of the GNU General Public License along
	18	* with this program; see the file COPYING; if not, write to the Free Software
	19	* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
718e3744	20	*/
	21
	22	#ifndef _ZEBRA_LOG_H
	23	#define _ZEBRA_LOG_H
	24
	25	#include <syslog.h>
5894e76d	26	#include <stdint.h>
d34cb7f0	27	#include <stdbool.h>
2fb975da	28	#include <stdio.h>
77d9c926 EDP	29	#include <stdarg.h>
	30	#include "lib/hook.h"
	31
5e244469 RW	32	#ifdef __cplusplus
	33	extern "C" {
	34	#endif
	35
77d9c926 EDP	36	/* Hook for external logging function */
	37	DECLARE_HOOK(zebra_ext_log, (int priority, const char *format, va_list args),
	38	(priority, format, args));
718e3744	39
5e764774	40	/* Here is some guidance on logging levels to use:
	41	*
	42	* LOG_DEBUG - For all messages that are enabled by optional debugging
	43	* features, typically preceded by "if (IS...DEBUG...)"
	44	* LOG_INFO - Information that may be of interest, but everything seems
	45	* to be working properly.
	46	* LOG_NOTICE - Only for message pertaining to daemon startup or shutdown.
	47	* LOG_WARNING - Warning conditions: unexpected events, but the daemon believes
	48	* it can continue to operate correctly.
	49	* LOG_ERR - Error situations indicating malfunctions. Probably require
	50	* attention.
	51	*
	52	* Note: LOG_CRIT, LOG_ALERT, and LOG_EMERG are currently not used anywhere,
	53	* please use LOG_ERR instead.
	54	*/
	55
274a4a44	56	/* If maxlvl is set to ZLOG_DISABLED, then no messages will be sent
	57	to that logging destination. */
	58	#define ZLOG_DISABLED (LOG_EMERG-1)
	59
d62a17ae	60	typedef enum {
	61	ZLOG_DEST_SYSLOG = 0,
	62	ZLOG_DEST_STDOUT,
	63	ZLOG_DEST_MONITOR,
	64	ZLOG_DEST_FILE
274a4a44	65	} zlog_dest_t;
	66	#define ZLOG_NUM_DESTS (ZLOG_DEST_FILE+1)
	67
d34cb7f0 DL	68	extern bool zlog_startup_stderr;
d34cb7f0 DL	69
718e3744	70	/* Message structure. */
d62a17ae	71	struct message {
	72	int key;
	73	const char *str;
718e3744	74	};
718e3744	75
718e3744	76	/* Open zlog function */
d62a17ae	77	extern void openzlog(const char progname, const char protoname,
	78	uint16_t instance, int syslog_options,
	79	int syslog_facility);
718e3744	80
718e3744	81	/* Close zlog function. */
d62a17ae	82	extern void closezlog(void);
718e3744	83
	84	/* GCC have printf type attribute check. */
	85	#ifdef __GNUC__
	86	#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
	87	#else
	88	#define PRINTF_ATTRIBUTE(a,b)
	89	#endif /* __GNUC__ */
	90
718e3744	91	/* Handy zlog functions. */
d62a17ae	92	extern void zlog_err(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
	93	extern void zlog_warn(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
	94	extern void zlog_info(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
	95	extern void zlog_notice(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
	96	extern void zlog_debug(const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
e412d3b8	97	extern void zlog(int priority, const char *format, ...) PRINTF_ATTRIBUTE(2, 3);
718e3744	98
7b526b61	99	/* For logs which have error codes associated with them */
af4c2728	100	#define flog_err(ferr_id, format, ...) \
d01b92fd	101	zlog_err("[EC %" PRIu32 "] " format, ferr_id, ##__VA_ARGS__)
09c866e3 QY	102	#define flog_err_sys(ferr_id, format, ...) \
09c866e3 QY	103	flog_err(ferr_id, format, ##__VA_ARGS__)
2311712a	104	#define flog_warn(ferr_id, format, ...) \
d01b92fd	105	zlog_warn("[EC %" PRIu32 "] " format, ferr_id, ##__VA_ARGS__)
c650e48c RW	106	#define flog(priority, ferr_id, format, ...) \
c650e48c RW	107	zlog(priority, "[EC %" PRIu32 "] " format, ferr_id, ##__VA_ARGS__)
7b526b61	108
d62a17ae	109	extern void zlog_thread_info(int log_level);
d1265948	110
274a4a44	111	/* Set logging level for the given destination. If the log_level
	112	argument is ZLOG_DISABLED, then the destination is disabled.
	113	This function should not be used for file logging (use zlog_set_file
	114	or zlog_reset_file instead). */
d62a17ae	115	extern void zlog_set_level(zlog_dest_t, int log_level);
718e3744	116
274a4a44	117	/* Set logging to the given filename at the specified level. */
d62a17ae	118	extern int zlog_set_file(const char *filename, int log_level);
274a4a44	119	/* Disable file logging. */
d62a17ae	120	extern int zlog_reset_file(void);
718e3744	121
718e3744	122	/* Rotate log. */
d62a17ae	123	extern int zlog_rotate(void);
718e3744	124
d62a17ae	125	const char lookup_msg(const struct message mz, int kz, const char *nf);
718e3744	126
ca359769	127	/* Safe version of strerror -- never returns NULL. */
	128	extern const char *safe_strerror(int errnum);
	129
59a06a91	130	/* To be called when a fatal signal is caught. */
c22f6d8c DL	131	extern void zlog_signal(int signo, const char action, void siginfo,
c22f6d8c DL	132	void *program_counter);
59a06a91	133
063ee52a	134	/* Log a backtrace. */
	135	extern void zlog_backtrace(int priority);
	136
	137	/* Log a backtrace, but in an async-signal-safe way. Should not be
	138	called unless the program is about to exit or abort, since it messes
239c26fd	139	up the state of zlog file pointers. If program_counter is non-NULL,
	140	that is logged in addition to the current backtrace. */
	141	extern void zlog_backtrace_sigsafe(int priority, void *program_counter);
063ee52a	142
1ed72e0b AS	143	/* Puts a current timestamp in buf and returns the number of characters
	144	written (not including the terminating NUL). The purpose of
	145	this function is to avoid calls to localtime appearing all over the code.
	146	It caches the most recent localtime result and can therefore
	147	avoid multiple calls within the same second. If buflen is too small,
	148	buf will be set to '\0', and 0 will be returned. /
ae616d60	149	#define QUAGGA_TIMESTAMP_LEN 40
1ed72e0b AS	150	extern size_t quagga_timestamp(int timestamp_precision /* # subsecond digits */,
	151	char *buf, size_t buflen);
	152
a9b5cbe5	153	extern void zlog_hexdump(const void *mem, unsigned int len);
d62a17ae	154	extern const char zlog_sanitize(char buf, size_t bufsz, const void *in,
d62a17ae	155	size_t inlen);
99a6c6cd	156
77083571 DS	157	/* Note: whenever a new route-type or zserv-command is added the
	158	* corresponding {command,route}_types[] table in lib/log.c MUST be
	159	* updated! */
	160
	161	/* Map a route type to a string. For example, ZEBRA_ROUTE_RIPNG -> "ripng". */
	162	extern const char *zebra_route_string(unsigned int route_type);
	163	/* Map a route type to a char. For example, ZEBRA_ROUTE_RIPNG -> 'R'. */
	164	extern char zebra_route_char(unsigned int route_type);
	165	/* Map a zserv command type to the same string,
	166	* e.g. ZEBRA_INTERFACE_ADD -> "ZEBRA_INTERFACE_ADD" */
	167	/* Map a protocol name to its number. e.g. ZEBRA_ROUTE_BGP->9*/
	168	extern int proto_name2num(const char *s);
	169	/* Map redistribute X argument to protocol number.
	170	* unlike proto_name2num, this accepts shorthands and takes
	171	* an AFI value to restrict input */
	172	extern int proto_redistnum(int afi, const char *s);
	173
	174	extern const char *zserv_command_string(unsigned int command);
	175
65efcfce	176
d62a17ae	177	extern int vzlog_test(int priority);
65efcfce	178
1ed72e0b AS	179	/* structure useful for avoiding repeated rendering of the same timestamp */
1ed72e0b AS	180	struct timestamp_control {
d62a17ae	181	size_t len; /* length of rendered timestamp */
	182	int precision; /* configuration parameter */
	183	int already_rendered; /* should be initialized to 0 */
	184	char buf[QUAGGA_TIMESTAMP_LEN]; /* will contain the rendered timestamp
9d303b37	185	*/
1ed72e0b AS	186	};
1ed72e0b AS	187
274a4a44	188	/* Defines for use in command construction: */
274a4a44	189
d62a17ae	190	#define LOG_LEVEL_DESC \
	191	"System is unusable\n" \
	192	"Immediate action needed\n" \
	193	"Critical conditions\n" \
	194	"Error conditions\n" \
	195	"Warning conditions\n" \
	196	"Normal but significant conditions\n" \
	197	"Informational messages\n" \
	198	"Debugging messages\n"
	199
	200	#define LOG_FACILITY_DESC \
	201	"Kernel\n" \
	202	"User process\n" \
	203	"Mail system\n" \
	204	"System daemons\n" \
	205	"Authorization system\n" \
	206	"Syslog itself\n" \
	207	"Line printer system\n" \
	208	"USENET news\n" \
	209	"Unix-to-Unix copy system\n" \
	210	"Cron/at facility\n" \
	211	"Local use\n" \
	212	"Local use\n" \
	213	"Local use\n" \
	214	"Local use\n" \
	215	"Local use\n" \
	216	"Local use\n" \
	217	"Local use\n" \
	218	"Local use\n"
274a4a44	219
5e244469 RW	220	#ifdef __cplusplus
	221	}
	222	#endif
	223
718e3744	224	#endif /* _ZEBRA_LOG_H */