xref: /illumos-gate/usr/src/cmd/hal/hald/logger.h (revision 18c2aff7)
1*18c2aff7Sartem /***************************************************************************
2*18c2aff7Sartem  * CVSID: $Id$
3*18c2aff7Sartem  *
4*18c2aff7Sartem  * logger.h : Logging facility
5*18c2aff7Sartem  *
6*18c2aff7Sartem  * Copyright (C) 2003 David Zeuthen, <david@fubar.dk>
7*18c2aff7Sartem  *
8*18c2aff7Sartem  * Licensed under the Academic Free License version 2.1
9*18c2aff7Sartem  *
10*18c2aff7Sartem  * This program is free software; you can redistribute it and/or modify
11*18c2aff7Sartem  * it under the terms of the GNU General Public License as published by
12*18c2aff7Sartem  * the Free Software Foundation; either version 2 of the License, or
13*18c2aff7Sartem  * (at your option) any later version.
14*18c2aff7Sartem  *
15*18c2aff7Sartem  * This program is distributed in the hope that it will be useful,
16*18c2aff7Sartem  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*18c2aff7Sartem  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*18c2aff7Sartem  * GNU General Public License for more details.
19*18c2aff7Sartem  *
20*18c2aff7Sartem  * You should have received a copy of the GNU General Public License
21*18c2aff7Sartem  * along with this program; if not, write to the Free Software
22*18c2aff7Sartem  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
23*18c2aff7Sartem  *
24*18c2aff7Sartem  **************************************************************************/
25*18c2aff7Sartem 
26*18c2aff7Sartem #ifndef LOGGER_H
27*18c2aff7Sartem #define LOGGER_H
28*18c2aff7Sartem 
29*18c2aff7Sartem #include <stdio.h>
30*18c2aff7Sartem #include <stdlib.h>
31*18c2aff7Sartem 
32*18c2aff7Sartem /**
33*18c2aff7Sartem  * @addtogroup HalDaemonLogging
34*18c2aff7Sartem  *
35*18c2aff7Sartem  * @{
36*18c2aff7Sartem  */
37*18c2aff7Sartem 
38*18c2aff7Sartem 
39*18c2aff7Sartem /** Logging levels for HAL daemon
40*18c2aff7Sartem  */
41*18c2aff7Sartem enum {
42*18c2aff7Sartem 	HAL_LOGPRI_TRACE = (1 << 0),   /**< function call sequences */
43*18c2aff7Sartem 	HAL_LOGPRI_DEBUG = (1 << 1),   /**< debug statements in code */
44*18c2aff7Sartem 	HAL_LOGPRI_INFO = (1 << 2),    /**< informational level */
45*18c2aff7Sartem 	HAL_LOGPRI_WARNING = (1 << 3), /**< warnings */
46*18c2aff7Sartem 	HAL_LOGPRI_ERROR = (1 << 4)    /**< error */
47*18c2aff7Sartem };
48*18c2aff7Sartem 
49*18c2aff7Sartem void logger_setup (int priority, const char *file, int line, const char *function);
50*18c2aff7Sartem 
51*18c2aff7Sartem void logger_emit (const char *format, ...);
52*18c2aff7Sartem void logger_forward_debug (const char *format, ...);
53*18c2aff7Sartem 
54*18c2aff7Sartem void logger_enable (void);
55*18c2aff7Sartem void logger_disable (void);
56*18c2aff7Sartem 
57*18c2aff7Sartem void logger_enable_syslog (void);
58*18c2aff7Sartem void logger_disable_syslog (void);
59*18c2aff7Sartem 
60*18c2aff7Sartem void setup_logger (void);
61*18c2aff7Sartem 
62*18c2aff7Sartem #ifdef __SUNPRO_C
63*18c2aff7Sartem #define __FUNCTION__ __func__
64*18c2aff7Sartem #endif
65*18c2aff7Sartem 
66*18c2aff7Sartem /** Trace logging macro */
67*18c2aff7Sartem #define HAL_TRACE(expr)   do {logger_setup(HAL_LOGPRI_TRACE,   __FILE__, __LINE__, __FUNCTION__); logger_emit expr; } while(0)
68*18c2aff7Sartem 
69*18c2aff7Sartem /** Debug information logging macro */
70*18c2aff7Sartem #define HAL_DEBUG(expr)   do {logger_setup(HAL_LOGPRI_DEBUG,   __FILE__, __LINE__, __FUNCTION__); logger_emit expr; } while(0)
71*18c2aff7Sartem 
72*18c2aff7Sartem /** Information level logging macro */
73*18c2aff7Sartem #define HAL_INFO(expr)    do {logger_setup(HAL_LOGPRI_INFO,    __FILE__, __LINE__, __FUNCTION__); logger_emit expr; } while(0)
74*18c2aff7Sartem 
75*18c2aff7Sartem /** Warning level logging macro */
76*18c2aff7Sartem #define HAL_WARNING(expr) do {logger_setup(HAL_LOGPRI_WARNING, __FILE__, __LINE__, __FUNCTION__); logger_emit expr; } while(0)
77*18c2aff7Sartem 
78*18c2aff7Sartem /** Error leve logging macro */
79*18c2aff7Sartem #define HAL_ERROR(expr)   do {logger_setup(HAL_LOGPRI_ERROR,   __FILE__, __LINE__, __FUNCTION__); logger_emit expr; } while(0)
80*18c2aff7Sartem 
81*18c2aff7Sartem /** Macro for terminating the program on an unrecoverable error */
82*18c2aff7Sartem #define DIE(expr) do {printf("*** [DIE] %s:%s():%d : ", __FILE__, __FUNCTION__, __LINE__); printf expr; printf("\n"); exit(1); } while(0)
83*18c2aff7Sartem 
84*18c2aff7Sartem /** @} */
85*18c2aff7Sartem 
86*18c2aff7Sartem #endif				/* LOGGER_H */
87