mirror of
https://github.com/libvirt/libvirt.git
synced 2025-02-25 18:55:26 -06:00
b65f37a4a1
These VIR_XXXX0 APIs make us confused, use the non-0-suffix APIs instead.
How do these coversions works? The magic is using the gcc extension of ##.
When __VA_ARGS__ is empty, "##" will swallow the "," in "fmt," to
avoid compile error.
example: origin after CPP
high_level_api("%d", a_int) low_level_api("%d", a_int)
high_level_api("a string") low_level_api("a string")
About 400 conversions.
8 special conversions:
VIR_XXXX0("") -> VIR_XXXX("msg") (avoid empty format) 2 conversions
VIR_XXXX0(string_literal_with_%) -> VIR_XXXX(%->%%) 0 conversions
VIR_XXXX0(non_string_literal) -> VIR_XXXX("%s", non_string_literal)
(for security) 6 conversions
Signed-off-by: Lai Jiangshan <laijs@cn.fujitsu.com>
131 lines
4.8 KiB
C
131 lines
4.8 KiB
C
/*
|
|
* logging.h: internal logging and debugging
|
|
*
|
|
* Copyright (C) 2006-2008, 2011 Red Hat, Inc.
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library 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
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, write to the Free Software
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
*
|
|
*/
|
|
|
|
#ifndef __VIRTLOG_H_
|
|
# define __VIRTLOG_H_
|
|
|
|
# include "internal.h"
|
|
# include "buf.h"
|
|
|
|
/*
|
|
* If configured with --enable-debug=yes then library calls
|
|
* are printed to stderr for debugging or to an appropriate channel
|
|
* defined at runtime from the libvirt daemon configuration file
|
|
*/
|
|
# ifdef ENABLE_DEBUG
|
|
# define VIR_DEBUG_INT(category, f, l, fmt,...) \
|
|
virLogMessage(category, VIR_LOG_DEBUG, f, l, 0, fmt, ##__VA_ARGS__)
|
|
# else
|
|
# define VIR_DEBUG_INT(category, f, l, fmt,...) \
|
|
do { } while (0)
|
|
# endif /* !ENABLE_DEBUG */
|
|
|
|
# define VIR_INFO_INT(category, f, l, fmt,...) \
|
|
virLogMessage(category, VIR_LOG_INFO, f, l, 0, fmt, ##__VA_ARGS__)
|
|
# define VIR_WARN_INT(category, f, l, fmt,...) \
|
|
virLogMessage(category, VIR_LOG_WARN, f, l, 0, fmt, ##__VA_ARGS__)
|
|
# define VIR_ERROR_INT(category, f, l, fmt,...) \
|
|
virLogMessage(category, VIR_LOG_ERROR, f, l, 0, fmt, ##__VA_ARGS__)
|
|
|
|
# define VIR_DEBUG(fmt,...) \
|
|
VIR_DEBUG_INT("file." __FILE__, __func__, __LINE__, fmt, ##__VA_ARGS__)
|
|
# define VIR_INFO(fmt,...) \
|
|
VIR_INFO_INT("file." __FILE__, __func__, __LINE__, fmt, ##__VA_ARGS__)
|
|
# define VIR_WARN(fmt,...) \
|
|
VIR_WARN_INT("file." __FILE__, __func__, __LINE__, fmt, ##__VA_ARGS__)
|
|
# define VIR_ERROR(fmt,...) \
|
|
VIR_ERROR_INT("file." __FILE__, __func__, __LINE__, fmt, ##__VA_ARGS__)
|
|
|
|
/*
|
|
* To be made public
|
|
*/
|
|
typedef enum {
|
|
VIR_LOG_DEBUG = 1,
|
|
VIR_LOG_INFO,
|
|
VIR_LOG_WARN,
|
|
VIR_LOG_ERROR,
|
|
} virLogPriority;
|
|
|
|
# define VIR_LOG_DEFAULT VIR_LOG_WARN
|
|
|
|
typedef enum {
|
|
VIR_LOG_TO_STDERR = 1,
|
|
VIR_LOG_TO_SYSLOG,
|
|
VIR_LOG_TO_FILE,
|
|
} virLogDestination;
|
|
|
|
/**
|
|
* virLogOutputFunc:
|
|
* @category: the category for the message
|
|
* @priority: the priority for the message
|
|
* @funcname: the function emitting the message
|
|
* @linenr: line where the message was emitted
|
|
* @msg: the message to log, preformatted and zero terminated
|
|
* @len: the lenght of the message in bytes without the terminating zero
|
|
* @data: extra output logging data
|
|
*
|
|
* Callback function used to output messages
|
|
*
|
|
* Returns the number of bytes written or -1 in case of error
|
|
*/
|
|
typedef int (*virLogOutputFunc) (const char *category, int priority,
|
|
const char *funcname, long long lineno,
|
|
const char *str, int len, void *data);
|
|
|
|
/**
|
|
* virLogCloseFunc:
|
|
* @data: extra output logging data
|
|
*
|
|
* Callback function used to close a log output
|
|
*/
|
|
typedef void (*virLogCloseFunc) (void *data);
|
|
|
|
extern int virLogGetNbFilters(void);
|
|
extern int virLogGetNbOutputs(void);
|
|
extern char *virLogGetFilters(void);
|
|
extern char *virLogGetOutputs(void);
|
|
extern int virLogGetDefaultPriority(void);
|
|
extern int virLogSetDefaultPriority(int priority);
|
|
extern void virLogSetFromEnv(void);
|
|
extern int virLogDefineFilter(const char *match, int priority, int flags);
|
|
extern int virLogDefineOutput(virLogOutputFunc f, virLogCloseFunc c, void *data,
|
|
int priority, int dest, const char *name,
|
|
int flags);
|
|
|
|
/*
|
|
* Internal logging API
|
|
*/
|
|
|
|
extern void virLogLock(void);
|
|
extern void virLogUnlock(void);
|
|
extern int virLogStartup(void);
|
|
extern int virLogReset(void);
|
|
extern void virLogShutdown(void);
|
|
extern int virLogParseDefaultPriority(const char *priority);
|
|
extern int virLogParseFilters(const char *filters);
|
|
extern int virLogParseOutputs(const char *output);
|
|
extern void virLogMessage(const char *category, int priority,
|
|
const char *funcname, long long linenr, int flags,
|
|
const char *fmt, ...) ATTRIBUTE_FMT_PRINTF(6, 7);
|
|
extern int virLogSetBufferSize(int size);
|
|
extern void virLogEmergencyDumpAll(int signum);
|
|
#endif
|