]>
git.proxmox.com Git - mirror_frr.git/blob - lib/log.h
2 * Zebra logging funcions.
3 * Copyright (C) 1997, 1998, 1999 Kunihiro Ishiguro
5 * This file is part of GNU Zebra.
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
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.
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
28 /* Here is some guidance on logging levels to use:
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
40 * Note: LOG_CRIT, LOG_ALERT, and LOG_EMERG are currently not used anywhere,
41 * please use LOG_ERR instead.
59 /* If maxlvl is set to ZLOG_DISABLED, then no messages will be sent
60 to that logging destination. */
61 #define ZLOG_DISABLED (LOG_EMERG-1)
70 #define ZLOG_NUM_DESTS (ZLOG_DEST_FILE+1)
74 const char *ident
; /* daemon name (first arg to openlog) */
75 zlog_proto_t protocol
;
77 int maxlvl
[ZLOG_NUM_DESTS
]; /* maximum priority to send to associated
78 logging destination */
79 int default_lvl
; /* maxlvl to use if none is specified */
82 int facility
; /* as per syslog facility */
83 int record_priority
; /* should messages logged through stdio include the
84 priority of the message? */
85 int syslog_options
; /* 2nd arg to openlog */
86 int timestamp_precision
; /* # of digits of subsecond precision */
89 /* Message structure. */
96 /* Default logging strucutre. */
97 extern struct zlog
*zlog_default
;
99 /* Open zlog function */
100 extern struct zlog
*openzlog (const char *progname
, zlog_proto_t protocol
,
101 u_short instance
, int syslog_options
, int syslog_facility
);
103 /* Close zlog function. */
104 extern void closezlog (struct zlog
*zl
);
106 /* GCC have printf type attribute check. */
108 #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
110 #define PRINTF_ATTRIBUTE(a,b)
111 #endif /* __GNUC__ */
113 /* Generic function for zlog. */
114 extern void zlog (struct zlog
*zl
, int priority
, const char *format
, ...)
115 PRINTF_ATTRIBUTE(3, 4);
117 /* Handy zlog functions. */
118 extern void zlog_err (const char *format
, ...) PRINTF_ATTRIBUTE(1, 2);
119 extern void zlog_warn (const char *format
, ...) PRINTF_ATTRIBUTE(1, 2);
120 extern void zlog_info (const char *format
, ...) PRINTF_ATTRIBUTE(1, 2);
121 extern void zlog_notice (const char *format
, ...) PRINTF_ATTRIBUTE(1, 2);
122 extern void zlog_debug (const char *format
, ...) PRINTF_ATTRIBUTE(1, 2);
124 extern void zlog_thread_info (int log_level
);
126 /* Set logging level for the given destination. If the log_level
127 argument is ZLOG_DISABLED, then the destination is disabled.
128 This function should not be used for file logging (use zlog_set_file
129 or zlog_reset_file instead). */
130 extern void zlog_set_level (struct zlog
*zl
, zlog_dest_t
, int log_level
);
132 /* Set logging to the given filename at the specified level. */
133 extern int zlog_set_file (struct zlog
*zl
, const char *filename
, int log_level
);
134 /* Disable file logging. */
135 extern int zlog_reset_file (struct zlog
*zl
);
138 extern int zlog_rotate (struct zlog
*);
140 /* For hackey message lookup and check */
141 #define LOOKUP_DEF(x, y, def) mes_lookup(x, x ## _max, y, def, #x)
142 #define LOOKUP(x, y) LOOKUP_DEF(x, y, "(no item found)")
144 extern const char *lookup (const struct message
*, int);
145 extern const char *mes_lookup (const struct message
*meslist
,
147 const char *no_item
, const char *mesname
);
149 extern const char *zlog_priority
[];
150 extern const char *zlog_proto_names
[];
152 /* Safe version of strerror -- never returns NULL. */
153 extern const char *safe_strerror(int errnum
);
155 /* To be called when a fatal signal is caught. */
156 extern void zlog_signal(int signo
, const char *action
158 , siginfo_t
*siginfo
, void *program_counter
162 /* Log a backtrace. */
163 extern void zlog_backtrace(int priority
);
165 /* Log a backtrace, but in an async-signal-safe way. Should not be
166 called unless the program is about to exit or abort, since it messes
167 up the state of zlog file pointers. If program_counter is non-NULL,
168 that is logged in addition to the current backtrace. */
169 extern void zlog_backtrace_sigsafe(int priority
, void *program_counter
);
171 /* Puts a current timestamp in buf and returns the number of characters
172 written (not including the terminating NUL). The purpose of
173 this function is to avoid calls to localtime appearing all over the code.
174 It caches the most recent localtime result and can therefore
175 avoid multiple calls within the same second. If buflen is too small,
176 *buf will be set to '\0', and 0 will be returned. */
177 #define QUAGGA_TIMESTAMP_LEN 40
178 extern size_t quagga_timestamp(int timestamp_precision
/* # subsecond digits */,
179 char *buf
, size_t buflen
);
181 extern void zlog_hexdump(const void *mem
, unsigned int len
);
183 /* structure useful for avoiding repeated rendering of the same timestamp */
184 struct timestamp_control
{
185 size_t len
; /* length of rendered timestamp */
186 int precision
; /* configuration parameter */
187 int already_rendered
; /* should be initialized to 0 */
188 char buf
[QUAGGA_TIMESTAMP_LEN
]; /* will contain the rendered timestamp */
191 /* Defines for use in command construction: */
193 #define LOG_LEVELS "(emergencies|alerts|critical|errors|warnings|notifications|informational|debugging)"
195 #define LOG_LEVEL_DESC \
196 "System is unusable\n" \
197 "Immediate action needed\n" \
198 "Critical conditions\n" \
199 "Error conditions\n" \
200 "Warning conditions\n" \
201 "Normal but significant conditions\n" \
202 "Informational messages\n" \
203 "Debugging messages\n"
205 #define LOG_FACILITIES "(kern|user|mail|daemon|auth|syslog|lpr|news|uucp|cron|local0|local1|local2|local3|local4|local5|local6|local7)"
207 #define LOG_FACILITY_DESC \
212 "Authorization system\n" \
214 "Line printer system\n" \
216 "Unix-to-Unix copy system\n" \
217 "Cron/at facility\n" \
227 #endif /* _ZEBRA_LOG_H */