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