[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 GNU Zebra; see the file COPYING.  If not, write to the Free
 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.  
 */

#ifndef _ZEBRA_LOG_H
#define _ZEBRA_LOG_H

#include <syslog.h>

/* 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.
 */

typedef enum 
{
  ZLOG_NONE,
  ZLOG_DEFAULT,
  ZLOG_ZEBRA,
  ZLOG_RIP,
  ZLOG_BGP,
  ZLOG_OSPF,
  ZLOG_RIPNG,  
  ZLOG_OSPF6,
  ZLOG_ISIS,
  ZLOG_MASC
} zlog_proto_t;

/* 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)

struct zlog 
{
  const char *ident;	/* daemon name (first arg to openlog) */
  zlog_proto_t protocol;
  int maxlvl[ZLOG_NUM_DESTS];	/* maximum priority to send to associated
  				   logging destination */
  int default_lvl;	/* maxlvl to use if none is specified */
  FILE *fp;
  char *filename;
  int facility;		/* as per syslog facility */
  int record_priority;	/* should messages logged through stdio include the
  			   priority of the message? */
  int syslog_options;	/* 2nd arg to openlog */
  int timestamp_precision;	/* # of digits of subsecond precision */
};

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

/* Default logging strucutre. */
extern struct zlog *zlog_default;

/* Open zlog function */
extern struct zlog *openzlog (const char *progname, zlog_proto_t protocol,
		              int syslog_options, int syslog_facility);

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

/* 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__ */

/* Generic function for zlog. */
extern void zlog (struct zlog *zl, int priority, const char *format, ...)
  PRINTF_ATTRIBUTE(3, 4);

/* 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);

/* For bgpd's peer oriented log. */
extern void plog_err (struct zlog *, const char *format, ...)
  PRINTF_ATTRIBUTE(2, 3);
extern void plog_warn (struct zlog *, const char *format, ...)
  PRINTF_ATTRIBUTE(2, 3);
extern void plog_info (struct zlog *, const char *format, ...)
  PRINTF_ATTRIBUTE(2, 3);
extern void plog_notice (struct zlog *, const char *format, ...)
  PRINTF_ATTRIBUTE(2, 3);
extern void plog_debug (struct zlog *, const char *format, ...)
  PRINTF_ATTRIBUTE(2, 3);

/* 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 (struct zlog *zl, zlog_dest_t, int log_level);

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

/* Rotate log. */
extern int zlog_rotate (struct zlog *);

/* For hackey massage lookup and check */
#define LOOKUP(x, y) mes_lookup(x, x ## _max, y, "(no item found)")

extern const char *lookup (const struct message *, int);
extern const char *mes_lookup (const struct message *meslist, 
                               int max, int index,
                               const char *no_item);

extern const char *zlog_priority[];
extern const char *zlog_proto_names[];

/* 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
#ifdef SA_SIGINFO
			, siginfo_t *siginfo, void *program_counter
#endif
		       );

/* 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. */
extern size_t quagga_timestamp(int timestamp_precision /* # subsecond digits */,
			       char *buf, size_t buflen);

/* 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[40];	/* will contain the rendered timestamp */
};

/* Defines for use in command construction: */

#define LOG_LEVELS "(emergencies|alerts|critical|errors|warnings|notifications|informational|debugging)"

#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_FACILITIES "(kern|user|mail|daemon|auth|syslog|lpr|news|uucp|cron|local0|local1|local2|local3|local4|local5|local6|local7)"

#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"

#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	*
	17	* You should have received a copy of the GNU General Public License
	18	* along with GNU Zebra; see the file COPYING. If not, write to the Free
	19	* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
	20	* 02111-1307, USA.
	21	*/
	22
	23	#ifndef _ZEBRA_LOG_H
	24	#define _ZEBRA_LOG_H
	25
	26	#include <syslog.h>
	27
5e764774	28	/* Here is some guidance on logging levels to use:
	29	*
	30	* LOG_DEBUG - For all messages that are enabled by optional debugging
	31	* features, typically preceded by "if (IS...DEBUG...)"
	32	* LOG_INFO - Information that may be of interest, but everything seems
	33	* to be working properly.
	34	* LOG_NOTICE - Only for message pertaining to daemon startup or shutdown.
	35	* LOG_WARNING - Warning conditions: unexpected events, but the daemon believes
	36	* it can continue to operate correctly.
	37	* LOG_ERR - Error situations indicating malfunctions. Probably require
	38	* attention.
	39	*
	40	* Note: LOG_CRIT, LOG_ALERT, and LOG_EMERG are currently not used anywhere,
	41	* please use LOG_ERR instead.
	42	*/
	43
718e3744	44	typedef enum
	45	{
	46	ZLOG_NONE,
	47	ZLOG_DEFAULT,
	48	ZLOG_ZEBRA,
	49	ZLOG_RIP,
	50	ZLOG_BGP,
	51	ZLOG_OSPF,
	52	ZLOG_RIPNG,
	53	ZLOG_OSPF6,
9e867fe6	54	ZLOG_ISIS,
718e3744	55	ZLOG_MASC
	56	} zlog_proto_t;
	57
274a4a44	58	/* If maxlvl is set to ZLOG_DISABLED, then no messages will be sent
	59	to that logging destination. */
	60	#define ZLOG_DISABLED (LOG_EMERG-1)
	61
	62	typedef enum
	63	{
	64	ZLOG_DEST_SYSLOG = 0,
	65	ZLOG_DEST_STDOUT,
	66	ZLOG_DEST_MONITOR,
	67	ZLOG_DEST_FILE
	68	} zlog_dest_t;
	69	#define ZLOG_NUM_DESTS (ZLOG_DEST_FILE+1)
	70
718e3744	71	struct zlog
718e3744	72	{
7d149b8e	73	const char ident; / daemon name (first arg to openlog) */
718e3744	74	zlog_proto_t protocol;
274a4a44	75	int maxlvl[ZLOG_NUM_DESTS]; /* maximum priority to send to associated
	76	logging destination */
	77	int default_lvl; /* maxlvl to use if none is specified */
718e3744	78	FILE *fp;
718e3744	79	char *filename;
718e3744	80	int facility; /* as per syslog facility */
7d149b8e	81	int record_priority; /* should messages logged through stdio include the
	82	priority of the message? */
	83	int syslog_options; /* 2nd arg to openlog */
1ed72e0b	84	int timestamp_precision; /* # of digits of subsecond precision */
718e3744	85	};
	86
	87	/* Message structure. */
	88	struct message
	89	{
	90	int key;
b04c699e	91	const char *str;
718e3744	92	};
	93
	94	/* Default logging strucutre. */
	95	extern struct zlog *zlog_default;
	96
	97	/* Open zlog function */
8cc4198f	98	extern struct zlog openzlog (const char progname, zlog_proto_t protocol,
8cc4198f	99	int syslog_options, int syslog_facility);
718e3744	100
718e3744	101	/* Close zlog function. */
8cc4198f	102	extern void closezlog (struct zlog *zl);
718e3744	103
	104	/* GCC have printf type attribute check. */
	105	#ifdef __GNUC__
	106	#define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
	107	#else
	108	#define PRINTF_ATTRIBUTE(a,b)
	109	#endif /* __GNUC__ */
	110
	111	/* Generic function for zlog. */
80c375e7 SH	112	extern void zlog (struct zlog zl, int priority, const char format, ...)
80c375e7 SH	113	PRINTF_ATTRIBUTE(3, 4);
718e3744	114
718e3744	115	/* Handy zlog functions. */
8cc4198f	116	extern void zlog_err (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
	117	extern void zlog_warn (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
	118	extern void zlog_info (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
	119	extern void zlog_notice (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
	120	extern void zlog_debug (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
718e3744	121
718e3744	122	/* For bgpd's peer oriented log. */
80c375e7 SH	123	extern void plog_err (struct zlog , const char format, ...)
	124	PRINTF_ATTRIBUTE(2, 3);
	125	extern void plog_warn (struct zlog , const char format, ...)
	126	PRINTF_ATTRIBUTE(2, 3);
	127	extern void plog_info (struct zlog , const char format, ...)
	128	PRINTF_ATTRIBUTE(2, 3);
	129	extern void plog_notice (struct zlog , const char format, ...)
	130	PRINTF_ATTRIBUTE(2, 3);
	131	extern void plog_debug (struct zlog , const char format, ...)
	132	PRINTF_ATTRIBUTE(2, 3);
718e3744	133
274a4a44	134	/* Set logging level for the given destination. If the log_level
	135	argument is ZLOG_DISABLED, then the destination is disabled.
	136	This function should not be used for file logging (use zlog_set_file
	137	or zlog_reset_file instead). */
8cc4198f	138	extern void zlog_set_level (struct zlog *zl, zlog_dest_t, int log_level);
718e3744	139
274a4a44	140	/* Set logging to the given filename at the specified level. */
8cc4198f	141	extern int zlog_set_file (struct zlog zl, const char filename, int log_level);
274a4a44	142	/* Disable file logging. */
8cc4198f	143	extern int zlog_reset_file (struct zlog *zl);
718e3744	144
718e3744	145	/* Rotate log. */
8cc4198f	146	extern int zlog_rotate (struct zlog *);
718e3744	147
718e3744	148	/* For hackey massage lookup and check */
11486b52	149	#define LOOKUP(x, y) mes_lookup(x, x ## _max, y, "(no item found)")
718e3744	150
1423c809	151	extern const char lookup (const struct message , int);
8e4c0930	152	extern const char mes_lookup (const struct message meslist,
11486b52 PJ	153	int max, int index,
11486b52 PJ	154	const char *no_item);
718e3744	155
718e3744	156	extern const char *zlog_priority[];
274a4a44	157	extern const char *zlog_proto_names[];
718e3744	158
ca359769	159	/* Safe version of strerror -- never returns NULL. */
	160	extern const char *safe_strerror(int errnum);
	161
59a06a91	162	/* To be called when a fatal signal is caught. */
31364274	163	extern void zlog_signal(int signo, const char *action
	164	#ifdef SA_SIGINFO
	165	, siginfo_t siginfo, void program_counter
	166	#endif
	167	);
59a06a91	168
063ee52a	169	/* Log a backtrace. */
	170	extern void zlog_backtrace(int priority);
	171
	172	/* Log a backtrace, but in an async-signal-safe way. Should not be
	173	called unless the program is about to exit or abort, since it messes
239c26fd	174	up the state of zlog file pointers. If program_counter is non-NULL,
	175	that is logged in addition to the current backtrace. */
	176	extern void zlog_backtrace_sigsafe(int priority, void *program_counter);
063ee52a	177
1ed72e0b AS	178	/* Puts a current timestamp in buf and returns the number of characters
	179	written (not including the terminating NUL). The purpose of
	180	this function is to avoid calls to localtime appearing all over the code.
	181	It caches the most recent localtime result and can therefore
	182	avoid multiple calls within the same second. If buflen is too small,
	183	buf will be set to '\0', and 0 will be returned. /
	184	extern size_t quagga_timestamp(int timestamp_precision /* # subsecond digits */,
	185	char *buf, size_t buflen);
	186
	187	/* structure useful for avoiding repeated rendering of the same timestamp */
	188	struct timestamp_control {
	189	size_t len; /* length of rendered timestamp */
	190	int precision; /* configuration parameter */
	191	int already_rendered; /* should be initialized to 0 */
	192	char buf[40]; /* will contain the rendered timestamp */
	193	};
	194
274a4a44	195	/* Defines for use in command construction: */
	196
	197	#define LOG_LEVELS "(emergencies\|alerts\|critical\|errors\|warnings\|notifications\|informational\|debugging)"
	198
	199	#define LOG_LEVEL_DESC \
	200	"System is unusable\n" \
	201	"Immediate action needed\n" \
	202	"Critical conditions\n" \
	203	"Error conditions\n" \
	204	"Warning conditions\n" \
	205	"Normal but significant conditions\n" \
	206	"Informational messages\n" \
	207	"Debugging messages\n"
	208
	209	#define LOG_FACILITIES "(kern\|user\|mail\|daemon\|auth\|syslog\|lpr\|news\|uucp\|cron\|local0\|local1\|local2\|local3\|local4\|local5\|local6\|local7)"
	210
	211	#define LOG_FACILITY_DESC \
	212	"Kernel\n" \
	213	"User process\n" \
	214	"Mail system\n" \
	215	"System daemons\n" \
	216	"Authorization system\n" \
	217	"Syslog itself\n" \
	218	"Line printer system\n" \
	219	"USENET news\n" \
	220	"Unix-to-Unix copy system\n" \
	221	"Cron/at facility\n" \
	222	"Local use\n" \
	223	"Local use\n" \
	224	"Local use\n" \
	225	"Local use\n" \
	226	"Local use\n" \
	227	"Local use\n" \
	228	"Local use\n" \
	229	"Local use\n"
	230
718e3744	231	#endif /* _ZEBRA_LOG_H */