1*9663SMark.Logan@Sun.COM /* 2*9663SMark.Logan@Sun.COM * logging.h - Centralised logging. Part of the Linux-NTFS project. 3*9663SMark.Logan@Sun.COM * 4*9663SMark.Logan@Sun.COM * Copyright (c) 2005 Richard Russon 5*9663SMark.Logan@Sun.COM * 6*9663SMark.Logan@Sun.COM * This program/include file is free software; you can redistribute it and/or 7*9663SMark.Logan@Sun.COM * modify it under the terms of the GNU General Public License as published 8*9663SMark.Logan@Sun.COM * by the Free Software Foundation; either version 2 of the License, or 9*9663SMark.Logan@Sun.COM * (at your option) any later version. 10*9663SMark.Logan@Sun.COM * 11*9663SMark.Logan@Sun.COM * This program/include file is distributed in the hope that it will be 12*9663SMark.Logan@Sun.COM * useful, but WITHOUT ANY WARRANTY; without even the implied warranty 13*9663SMark.Logan@Sun.COM * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14*9663SMark.Logan@Sun.COM * GNU General Public License for more details. 15*9663SMark.Logan@Sun.COM * 16*9663SMark.Logan@Sun.COM * You should have received a copy of the GNU General Public License 17*9663SMark.Logan@Sun.COM * along with this program (in the main directory of the Linux-NTFS 18*9663SMark.Logan@Sun.COM * distribution in the file COPYING); if not, write to the Free Software 19*9663SMark.Logan@Sun.COM * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 20*9663SMark.Logan@Sun.COM */ 21*9663SMark.Logan@Sun.COM 22*9663SMark.Logan@Sun.COM #ifndef _LOGGING_H_ 23*9663SMark.Logan@Sun.COM #define _LOGGING_H_ 24*9663SMark.Logan@Sun.COM 25*9663SMark.Logan@Sun.COM #ifdef HAVE_CONFIG_H 26*9663SMark.Logan@Sun.COM #include "config.h" 27*9663SMark.Logan@Sun.COM #endif 28*9663SMark.Logan@Sun.COM 29*9663SMark.Logan@Sun.COM #ifdef HAVE_STDARG_H 30*9663SMark.Logan@Sun.COM #include <stdarg.h> 31*9663SMark.Logan@Sun.COM #endif 32*9663SMark.Logan@Sun.COM 33*9663SMark.Logan@Sun.COM #include "types.h" 34*9663SMark.Logan@Sun.COM 35*9663SMark.Logan@Sun.COM /* Function prototype for the logging handlers */ 36*9663SMark.Logan@Sun.COM typedef int (ntfs_log_handler)(const char *function, const char *file, int line, 37*9663SMark.Logan@Sun.COM u32 level, void *data, const char *format, va_list args); 38*9663SMark.Logan@Sun.COM 39*9663SMark.Logan@Sun.COM /* Set the logging handler from one of the functions, below. */ 40*9663SMark.Logan@Sun.COM void ntfs_log_set_handler(ntfs_log_handler *handler); 41*9663SMark.Logan@Sun.COM 42*9663SMark.Logan@Sun.COM /* Logging handlers */ 43*9663SMark.Logan@Sun.COM ntfs_log_handler ntfs_log_handler_syslog __attribute__((format(printf, 6, 0))); 44*9663SMark.Logan@Sun.COM ntfs_log_handler ntfs_log_handler_fprintf __attribute__((format(printf, 6, 0))); 45*9663SMark.Logan@Sun.COM ntfs_log_handler ntfs_log_handler_null __attribute__((format(printf, 6, 0))); 46*9663SMark.Logan@Sun.COM ntfs_log_handler ntfs_log_handler_stdout __attribute__((format(printf, 6, 0))); 47*9663SMark.Logan@Sun.COM ntfs_log_handler ntfs_log_handler_outerr __attribute__((format(printf, 6, 0))); 48*9663SMark.Logan@Sun.COM ntfs_log_handler ntfs_log_handler_stderr __attribute__((format(printf, 6, 0))); 49*9663SMark.Logan@Sun.COM 50*9663SMark.Logan@Sun.COM /* Enable/disable certain log levels */ 51*9663SMark.Logan@Sun.COM u32 ntfs_log_set_levels(u32 levels); 52*9663SMark.Logan@Sun.COM u32 ntfs_log_clear_levels(u32 levels); 53*9663SMark.Logan@Sun.COM u32 ntfs_log_get_levels(void); 54*9663SMark.Logan@Sun.COM 55*9663SMark.Logan@Sun.COM /* Enable/disable certain log flags */ 56*9663SMark.Logan@Sun.COM u32 ntfs_log_set_flags(u32 flags); 57*9663SMark.Logan@Sun.COM u32 ntfs_log_clear_flags(u32 flags); 58*9663SMark.Logan@Sun.COM u32 ntfs_log_get_flags(void); 59*9663SMark.Logan@Sun.COM 60*9663SMark.Logan@Sun.COM /* Turn command-line options into logging flags */ 61*9663SMark.Logan@Sun.COM BOOL ntfs_log_parse_option(const char *option); 62*9663SMark.Logan@Sun.COM 63*9663SMark.Logan@Sun.COM int ntfs_log_redirect(const char *function, const char *file, int line, 64*9663SMark.Logan@Sun.COM u32 level, void *data, const char *format, ...) 65*9663SMark.Logan@Sun.COM __attribute__((format(printf, 6, 7))); 66*9663SMark.Logan@Sun.COM 67*9663SMark.Logan@Sun.COM /* Logging levels - Determine what gets logged */ 68*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_DEBUG ((u32)1 << 0) /* x = 42 */ 69*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_TRACE ((u32)1 << 1) /* Entering function x() */ 70*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_QUIET ((u32)1 << 2) /* Quietable output */ 71*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_INFO ((u32)1 << 3) /* Volume needs defragmenting */ 72*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_VERBOSE ((u32)1 << 4) /* Forced to continue */ 73*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_PROGRESS ((u32)1 << 5) /* 54% complete */ 74*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_WARNING ((u32)1 << 6) /* You should backup before starting */ 75*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_ERROR ((u32)1 << 7) /* Operation failed, no damage done */ 76*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_PERROR ((u32)1 << 8) /* Message : standard error description */ 77*9663SMark.Logan@Sun.COM #define NTFS_LOG_LEVEL_CRITICAL ((u32)1 << 9) /* Operation failed,damage may have occurred */ 78*9663SMark.Logan@Sun.COM 79*9663SMark.Logan@Sun.COM /* Logging style flags - Manage the style of the output */ 80*9663SMark.Logan@Sun.COM #define NTFS_LOG_FLAG_PREFIX ((u32)1 << 0) /* Prefix messages with "ERROR: ", etc */ 81*9663SMark.Logan@Sun.COM #define NTFS_LOG_FLAG_FILENAME ((u32)1 << 1) /* Show the file origin of the message */ 82*9663SMark.Logan@Sun.COM #define NTFS_LOG_FLAG_LINE ((u32)1 << 2) /* Show the line number of the message */ 83*9663SMark.Logan@Sun.COM #define NTFS_LOG_FLAG_FUNCTION ((u32)1 << 3) /* Show the function name containing the message */ 84*9663SMark.Logan@Sun.COM #define NTFS_LOG_FLAG_ONLYNAME ((u32)1 << 4) /* Only display the filename, not the pathname */ 85*9663SMark.Logan@Sun.COM #define NTFS_LOG_FLAG_COLOUR ((u32)1 << 5) /* Colour highlight some messages */ 86*9663SMark.Logan@Sun.COM 87*9663SMark.Logan@Sun.COM /* Macros to simplify logging. One for each level defined above. 88*9663SMark.Logan@Sun.COM * Note, if DEBUG is not defined, then ntfs_log_debug/trace have no effect. 89*9663SMark.Logan@Sun.COM */ 90*9663SMark.Logan@Sun.COM #if defined(__GNUC__) 91*9663SMark.Logan@Sun.COM 92*9663SMark.Logan@Sun.COM #define ntfs_log_critical(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_CRITICAL,NULL,FORMAT,##ARGS) 93*9663SMark.Logan@Sun.COM #define ntfs_log_error(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_ERROR,NULL,FORMAT,##ARGS) 94*9663SMark.Logan@Sun.COM #define ntfs_log_info(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_INFO,NULL,FORMAT,##ARGS) 95*9663SMark.Logan@Sun.COM #define ntfs_log_perror(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_PERROR,NULL,FORMAT,##ARGS) 96*9663SMark.Logan@Sun.COM #define ntfs_log_progress(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_PROGRESS,NULL,FORMAT,##ARGS) 97*9663SMark.Logan@Sun.COM #define ntfs_log_quiet(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_QUIET,NULL,FORMAT,##ARGS) 98*9663SMark.Logan@Sun.COM #define ntfs_log_verbose(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_VERBOSE,NULL,FORMAT,##ARGS) 99*9663SMark.Logan@Sun.COM #define ntfs_log_warning(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_WARNING,NULL,FORMAT,##ARGS) 100*9663SMark.Logan@Sun.COM 101*9663SMark.Logan@Sun.COM #else /* not __GNUC__ */ 102*9663SMark.Logan@Sun.COM 103*9663SMark.Logan@Sun.COM #define PRINT(...) printf(__VA_ARGS__) 104*9663SMark.Logan@Sun.COM 105*9663SMark.Logan@Sun.COM #define ntfs_log_critical(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_CRITICAL,NULL,__VA_ARGS__) 106*9663SMark.Logan@Sun.COM #define ntfs_log_error(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_ERROR,NULL,__VA_ARGS__) 107*9663SMark.Logan@Sun.COM #define ntfs_log_info(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_INFO,NULL,__VA_ARGS__) 108*9663SMark.Logan@Sun.COM #define ntfs_log_perror(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_PERROR,NULL,__VA_ARGS__) 109*9663SMark.Logan@Sun.COM #define ntfs_log_progress(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_PROGRESS,NULL,__VA_ARGS__) 110*9663SMark.Logan@Sun.COM #define ntfs_log_quiet(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_QUIET,NULL,__VA_ARGS__) 111*9663SMark.Logan@Sun.COM #define ntfs_log_verbose(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_VERBOSE,NULL,__VA_ARGS__) 112*9663SMark.Logan@Sun.COM #define ntfs_log_warning(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_WARNING,NULL,__VA_ARGS__) 113*9663SMark.Logan@Sun.COM 114*9663SMark.Logan@Sun.COM #endif /* __GNUC__ */ 115*9663SMark.Logan@Sun.COM 116*9663SMark.Logan@Sun.COM /* 117*9663SMark.Logan@Sun.COM * By default debug and trace messages are compiled into the program, 118*9663SMark.Logan@Sun.COM * but not displayed. 119*9663SMark.Logan@Sun.COM */ 120*9663SMark.Logan@Sun.COM #if defined(__GNUC__) 121*9663SMark.Logan@Sun.COM 122*9663SMark.Logan@Sun.COM #ifndef DEBUG 123*9663SMark.Logan@Sun.COM #define ntfs_log_debug(FORMAT, ARGS...)do {} while (0) 124*9663SMark.Logan@Sun.COM #define ntfs_log_trace(FORMAT, ARGS...)do {} while (0) 125*9663SMark.Logan@Sun.COM #else /* !DEBUG */ 126*9663SMark.Logan@Sun.COM #define ntfs_log_debug(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_DEBUG,NULL,FORMAT,##ARGS) 127*9663SMark.Logan@Sun.COM #define ntfs_log_trace(FORMAT, ARGS...) ntfs_log_redirect(__FUNCTION__,__FILE__,__LINE__,NTFS_LOG_LEVEL_TRACE,NULL,FORMAT,##ARGS) 128*9663SMark.Logan@Sun.COM #endif /* DEBUG */ 129*9663SMark.Logan@Sun.COM 130*9663SMark.Logan@Sun.COM #else /* not __GNUC__ */ 131*9663SMark.Logan@Sun.COM 132*9663SMark.Logan@Sun.COM #ifndef DEBUG 133*9663SMark.Logan@Sun.COM #define ntfs_log_debug(...) do {} while (0) 134*9663SMark.Logan@Sun.COM #define ntfs_log_trace(...) do {} while (0) 135*9663SMark.Logan@Sun.COM #else /* !DEBUG */ 136*9663SMark.Logan@Sun.COM #define ntfs_log_debug(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_DEBUG,NULL,__VA_ARGS__) 137*9663SMark.Logan@Sun.COM #define ntfs_log_trace(...) ntfs_log_redirect("unknown",__FILE__,__LINE__,NTFS_LOG_LEVEL_TRACE,NULL,__VA_ARGS__) 138*9663SMark.Logan@Sun.COM #endif /* DEBUG */ 139*9663SMark.Logan@Sun.COM 140*9663SMark.Logan@Sun.COM #endif /* __GNUC__ */ 141*9663SMark.Logan@Sun.COM 142*9663SMark.Logan@Sun.COM #endif /* _LOGGING_H_ */ 143*9663SMark.Logan@Sun.COM 144