2008-11-06 16:36:07 +00:00
|
|
|
/*
|
2012-12-12 17:59:27 +00:00
|
|
|
* virlog.h: internal logging and debugging
|
2008-11-06 16:36:07 +00:00
|
|
|
*
|
2012-07-13 07:50:04 +00:00
|
|
|
* Copyright (C) 2006-2008, 2011-2012 Red Hat, Inc.
|
2008-11-06 16:36:07 +00:00
|
|
|
*
|
|
|
|
* 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
|
2012-09-20 22:30:55 +00:00
|
|
|
* License along with this library. If not, see
|
2012-07-21 10:06:23 +00:00
|
|
|
* <http://www.gnu.org/licenses/>.
|
2008-11-06 16:36:07 +00:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __VIRTLOG_H_
|
2010-03-09 18:22:22 +00:00
|
|
|
# define __VIRTLOG_H_
|
2008-11-06 16:36:07 +00:00
|
|
|
|
2010-03-09 18:22:22 +00:00
|
|
|
# include "internal.h"
|
2012-12-04 12:04:07 +00:00
|
|
|
# include "virbuffer.h"
|
2008-11-06 16:36:07 +00:00
|
|
|
|
2012-10-15 07:14:26 +00:00
|
|
|
/*
|
|
|
|
* 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,
|
|
|
|
VIR_LOG_TO_JOURNALD,
|
|
|
|
} virLogDestination;
|
|
|
|
|
2014-02-27 17:44:53 +00:00
|
|
|
typedef struct _virLogSource virLogSource;
|
|
|
|
typedef virLogSource *virLogSourcePtr;
|
|
|
|
|
|
|
|
struct _virLogSource {
|
|
|
|
const char *name;
|
|
|
|
};
|
2012-10-15 07:14:26 +00:00
|
|
|
|
2014-02-27 17:44:53 +00:00
|
|
|
extern virLogSource virLogSelf;
|
2012-10-15 07:14:26 +00:00
|
|
|
|
2008-11-06 16:36:07 +00:00
|
|
|
/*
|
|
|
|
* If configured with --enable-debug=yes then library calls
|
|
|
|
* are printed to stderr for debugging or to an appropriate channel
|
2011-02-16 23:37:57 +00:00
|
|
|
* defined at runtime from the libvirt daemon configuration file
|
2008-11-06 16:36:07 +00:00
|
|
|
*/
|
2010-03-09 18:22:22 +00:00
|
|
|
# ifdef ENABLE_DEBUG
|
2012-09-27 13:44:22 +00:00
|
|
|
# define VIR_DEBUG_INT(src, filename, linenr, funcname, ...) \
|
Add a metadata parameter to virLog{, V}Message
... and update all users. No change in functionality, the parameter
will be used later.
The metadata representation is as minimal as possible, but requires
the caller to allocate an array on stack explicitly.
The alternative of using varargs in the virLogMessage() callers:
* Would not allow the caller to optionally omit some metadata elements,
except by having two calls to virLogMessage.
* Would not be as type-safe (e.g. using int vs. size_t), and the compiler
wouldn't be able to do type checking
* Depending on parameter order:
a) virLogMessage(..., message format, message params...,
metadata..., NULL)
can not be portably implemented (parse_printf_format() is a glibc
function)
b) virLogMessage(..., metadata..., NULL,
message format, message params...)
would prevent usage of ATTRIBUTE_FMT_PRINTF and the associated
compiler checking.
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2012-10-17 18:17:14 +00:00
|
|
|
virLogMessage(src, VIR_LOG_DEBUG, filename, linenr, funcname, NULL, __VA_ARGS__)
|
2010-03-09 18:22:22 +00:00
|
|
|
# else
|
2012-07-13 07:50:04 +00:00
|
|
|
/**
|
|
|
|
* virLogEatParams:
|
|
|
|
*
|
|
|
|
* Do nothing but eat parameters.
|
|
|
|
*/
|
2014-02-27 17:44:53 +00:00
|
|
|
static inline void virLogEatParams(virLogSourcePtr unused, ...)
|
2012-07-13 07:50:04 +00:00
|
|
|
{
|
|
|
|
/* Silence gcc */
|
|
|
|
unused = unused;
|
|
|
|
}
|
2012-09-27 13:44:22 +00:00
|
|
|
# define VIR_DEBUG_INT(src, filename, linenr, funcname, ...) \
|
|
|
|
virLogEatParams(src, filename, linenr, funcname, __VA_ARGS__)
|
2010-03-09 18:22:22 +00:00
|
|
|
# endif /* !ENABLE_DEBUG */
|
2009-06-26 15:08:04 +00:00
|
|
|
|
2012-09-27 13:44:22 +00:00
|
|
|
# define VIR_INFO_INT(src, filename, linenr, funcname, ...) \
|
Add a metadata parameter to virLog{, V}Message
... and update all users. No change in functionality, the parameter
will be used later.
The metadata representation is as minimal as possible, but requires
the caller to allocate an array on stack explicitly.
The alternative of using varargs in the virLogMessage() callers:
* Would not allow the caller to optionally omit some metadata elements,
except by having two calls to virLogMessage.
* Would not be as type-safe (e.g. using int vs. size_t), and the compiler
wouldn't be able to do type checking
* Depending on parameter order:
a) virLogMessage(..., message format, message params...,
metadata..., NULL)
can not be portably implemented (parse_printf_format() is a glibc
function)
b) virLogMessage(..., metadata..., NULL,
message format, message params...)
would prevent usage of ATTRIBUTE_FMT_PRINTF and the associated
compiler checking.
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2012-10-17 18:17:14 +00:00
|
|
|
virLogMessage(src, VIR_LOG_INFO, filename, linenr, funcname, NULL, __VA_ARGS__)
|
2012-09-27 13:44:22 +00:00
|
|
|
# define VIR_WARN_INT(src, filename, linenr, funcname, ...) \
|
Add a metadata parameter to virLog{, V}Message
... and update all users. No change in functionality, the parameter
will be used later.
The metadata representation is as minimal as possible, but requires
the caller to allocate an array on stack explicitly.
The alternative of using varargs in the virLogMessage() callers:
* Would not allow the caller to optionally omit some metadata elements,
except by having two calls to virLogMessage.
* Would not be as type-safe (e.g. using int vs. size_t), and the compiler
wouldn't be able to do type checking
* Depending on parameter order:
a) virLogMessage(..., message format, message params...,
metadata..., NULL)
can not be portably implemented (parse_printf_format() is a glibc
function)
b) virLogMessage(..., metadata..., NULL,
message format, message params...)
would prevent usage of ATTRIBUTE_FMT_PRINTF and the associated
compiler checking.
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2012-10-17 18:17:14 +00:00
|
|
|
virLogMessage(src, VIR_LOG_WARN, filename, linenr, funcname, NULL, __VA_ARGS__)
|
2012-09-27 13:44:22 +00:00
|
|
|
# define VIR_ERROR_INT(src, filename, linenr, funcname, ...) \
|
Add a metadata parameter to virLog{, V}Message
... and update all users. No change in functionality, the parameter
will be used later.
The metadata representation is as minimal as possible, but requires
the caller to allocate an array on stack explicitly.
The alternative of using varargs in the virLogMessage() callers:
* Would not allow the caller to optionally omit some metadata elements,
except by having two calls to virLogMessage.
* Would not be as type-safe (e.g. using int vs. size_t), and the compiler
wouldn't be able to do type checking
* Depending on parameter order:
a) virLogMessage(..., message format, message params...,
metadata..., NULL)
can not be portably implemented (parse_printf_format() is a glibc
function)
b) virLogMessage(..., metadata..., NULL,
message format, message params...)
would prevent usage of ATTRIBUTE_FMT_PRINTF and the associated
compiler checking.
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2012-10-17 18:17:14 +00:00
|
|
|
virLogMessage(src, VIR_LOG_ERROR, filename, linenr, funcname, NULL, __VA_ARGS__)
|
2008-11-06 16:36:07 +00:00
|
|
|
|
2011-05-11 19:24:50 +00:00
|
|
|
# define VIR_DEBUG(...) \
|
2014-02-27 17:44:53 +00:00
|
|
|
VIR_DEBUG_INT(&virLogSelf, __FILE__, __LINE__, __func__, __VA_ARGS__)
|
2011-05-11 19:24:50 +00:00
|
|
|
# define VIR_INFO(...) \
|
2014-02-27 17:44:53 +00:00
|
|
|
VIR_INFO_INT(&virLogSelf, __FILE__, __LINE__, __func__, __VA_ARGS__)
|
2011-05-11 19:24:50 +00:00
|
|
|
# define VIR_WARN(...) \
|
2014-02-27 17:44:53 +00:00
|
|
|
VIR_WARN_INT(&virLogSelf, __FILE__, __LINE__, __func__, __VA_ARGS__)
|
2011-05-11 19:24:50 +00:00
|
|
|
# define VIR_ERROR(...) \
|
2014-02-27 17:44:53 +00:00
|
|
|
VIR_ERROR_INT(&virLogSelf, __FILE__, __LINE__, __func__, __VA_ARGS__)
|
2009-01-06 18:32:03 +00:00
|
|
|
|
Add a metadata parameter to virLog{, V}Message
... and update all users. No change in functionality, the parameter
will be used later.
The metadata representation is as minimal as possible, but requires
the caller to allocate an array on stack explicitly.
The alternative of using varargs in the virLogMessage() callers:
* Would not allow the caller to optionally omit some metadata elements,
except by having two calls to virLogMessage.
* Would not be as type-safe (e.g. using int vs. size_t), and the compiler
wouldn't be able to do type checking
* Depending on parameter order:
a) virLogMessage(..., message format, message params...,
metadata..., NULL)
can not be portably implemented (parse_printf_format() is a glibc
function)
b) virLogMessage(..., metadata..., NULL,
message format, message params...)
would prevent usage of ATTRIBUTE_FMT_PRINTF and the associated
compiler checking.
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2012-10-17 18:17:14 +00:00
|
|
|
|
|
|
|
struct _virLogMetadata {
|
|
|
|
const char *key;
|
|
|
|
const char *s; /* String value, or NULL to use "i" */
|
Convert 'int i' to 'size_t i' in src/util/ files
Convert the type of loop iterators named 'i', 'j', k',
'ii', 'jj', 'kk', to be 'size_t' instead of 'int' or
'unsigned int', also santizing 'ii', 'jj', 'kk' to use
the normal 'i', 'j', 'k' naming
Signed-off-by: Daniel P. Berrange <berrange@redhat.com>
2013-07-08 14:09:33 +00:00
|
|
|
int iv;
|
Add a metadata parameter to virLog{, V}Message
... and update all users. No change in functionality, the parameter
will be used later.
The metadata representation is as minimal as possible, but requires
the caller to allocate an array on stack explicitly.
The alternative of using varargs in the virLogMessage() callers:
* Would not allow the caller to optionally omit some metadata elements,
except by having two calls to virLogMessage.
* Would not be as type-safe (e.g. using int vs. size_t), and the compiler
wouldn't be able to do type checking
* Depending on parameter order:
a) virLogMessage(..., message format, message params...,
metadata..., NULL)
can not be portably implemented (parse_printf_format() is a glibc
function)
b) virLogMessage(..., metadata..., NULL,
message format, message params...)
would prevent usage of ATTRIBUTE_FMT_PRINTF and the associated
compiler checking.
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2012-10-17 18:17:14 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
typedef struct _virLogMetadata virLogMetadata;
|
|
|
|
typedef struct _virLogMetadata *virLogMetadataPtr;
|
|
|
|
|
2008-12-22 10:36:54 +00:00
|
|
|
/**
|
|
|
|
* virLogOutputFunc:
|
2014-02-27 17:44:53 +00:00
|
|
|
* @src: the source of the log message
|
2008-12-22 10:36:54 +00:00
|
|
|
* @priority: the priority for the message
|
2012-09-27 13:44:22 +00:00
|
|
|
* @filename: file where the message was emitted
|
2008-12-22 10:44:10 +00:00
|
|
|
* @linenr: line where the message was emitted
|
2012-09-27 13:44:22 +00:00
|
|
|
* @funcname: the function emitting the message
|
2011-09-28 13:20:07 +00:00
|
|
|
* @timestamp: zero terminated string with timestamp of the message
|
2012-10-17 18:17:15 +00:00
|
|
|
* @metadata: NULL or metadata array, terminated by an item with NULL key
|
2012-05-09 14:18:56 +00:00
|
|
|
* @flags: flags associated with the message
|
2012-09-27 11:45:33 +00:00
|
|
|
* @rawstr: the unformatted message to log, zero terminated
|
2011-09-28 13:20:07 +00:00
|
|
|
* @str: the message to log, preformatted and zero terminated
|
2008-12-22 10:44:10 +00:00
|
|
|
* @data: extra output logging data
|
2008-12-22 10:36:54 +00:00
|
|
|
*
|
|
|
|
* Callback function used to output messages
|
|
|
|
*/
|
2014-02-27 17:44:53 +00:00
|
|
|
typedef void (*virLogOutputFunc) (virLogSourcePtr src,
|
2012-09-27 13:14:01 +00:00
|
|
|
virLogPriority priority,
|
2012-09-27 13:28:44 +00:00
|
|
|
const char *filename,
|
2012-09-27 13:14:01 +00:00
|
|
|
int linenr,
|
2012-09-27 13:28:44 +00:00
|
|
|
const char *funcname,
|
2012-09-20 18:24:00 +00:00
|
|
|
const char *timestamp,
|
2012-10-17 18:17:15 +00:00
|
|
|
virLogMetadataPtr metadata,
|
2012-09-20 18:24:00 +00:00
|
|
|
unsigned int flags,
|
2012-09-27 13:14:01 +00:00
|
|
|
const char *rawstr,
|
|
|
|
const char *str,
|
2012-09-20 18:24:00 +00:00
|
|
|
void *data);
|
2008-12-22 10:36:54 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* virLogCloseFunc:
|
|
|
|
* @data: extra output logging data
|
|
|
|
*
|
|
|
|
* Callback function used to close a log output
|
|
|
|
*/
|
|
|
|
typedef void (*virLogCloseFunc) (void *data);
|
|
|
|
|
2012-05-09 14:18:56 +00:00
|
|
|
typedef enum {
|
|
|
|
VIR_LOG_STACK_TRACE = (1 << 0),
|
|
|
|
} virLogFlags;
|
|
|
|
|
2009-08-06 13:45:50 +00:00
|
|
|
extern int virLogGetNbFilters(void);
|
|
|
|
extern int virLogGetNbOutputs(void);
|
2009-10-08 15:05:01 +00:00
|
|
|
extern char *virLogGetFilters(void);
|
|
|
|
extern char *virLogGetOutputs(void);
|
2012-09-27 12:58:58 +00:00
|
|
|
extern virLogPriority virLogGetDefaultPriority(void);
|
|
|
|
extern int virLogSetDefaultPriority(virLogPriority priority);
|
2009-08-06 13:55:07 +00:00
|
|
|
extern void virLogSetFromEnv(void);
|
2012-09-27 13:14:01 +00:00
|
|
|
extern int virLogDefineFilter(const char *match,
|
|
|
|
virLogPriority priority,
|
2011-07-06 22:29:02 +00:00
|
|
|
unsigned int flags);
|
2012-09-27 13:14:01 +00:00
|
|
|
extern int virLogDefineOutput(virLogOutputFunc f,
|
|
|
|
virLogCloseFunc c,
|
|
|
|
void *data,
|
|
|
|
virLogPriority priority,
|
|
|
|
virLogDestination dest,
|
|
|
|
const char *name,
|
2011-07-06 22:29:02 +00:00
|
|
|
unsigned int flags);
|
2008-12-22 10:36:54 +00:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Internal logging API
|
|
|
|
*/
|
2008-11-06 16:36:07 +00:00
|
|
|
|
2010-02-03 16:12:57 +00:00
|
|
|
extern void virLogLock(void);
|
|
|
|
extern void virLogUnlock(void);
|
2008-12-22 10:36:54 +00:00
|
|
|
extern int virLogReset(void);
|
2009-08-06 13:55:07 +00:00
|
|
|
extern int virLogParseDefaultPriority(const char *priority);
|
2008-12-22 10:36:54 +00:00
|
|
|
extern int virLogParseFilters(const char *filters);
|
|
|
|
extern int virLogParseOutputs(const char *output);
|
2013-06-07 09:55:27 +00:00
|
|
|
extern int virLogPriorityFromSyslog(int priority);
|
2014-02-27 17:44:53 +00:00
|
|
|
extern void virLogMessage(virLogSourcePtr source,
|
2012-09-27 13:14:01 +00:00
|
|
|
virLogPriority priority,
|
2012-09-27 13:28:44 +00:00
|
|
|
const char *filename,
|
2012-09-27 13:14:01 +00:00
|
|
|
int linenr,
|
2012-09-27 13:28:44 +00:00
|
|
|
const char *funcname,
|
Add a metadata parameter to virLog{, V}Message
... and update all users. No change in functionality, the parameter
will be used later.
The metadata representation is as minimal as possible, but requires
the caller to allocate an array on stack explicitly.
The alternative of using varargs in the virLogMessage() callers:
* Would not allow the caller to optionally omit some metadata elements,
except by having two calls to virLogMessage.
* Would not be as type-safe (e.g. using int vs. size_t), and the compiler
wouldn't be able to do type checking
* Depending on parameter order:
a) virLogMessage(..., message format, message params...,
metadata..., NULL)
can not be portably implemented (parse_printf_format() is a glibc
function)
b) virLogMessage(..., metadata..., NULL,
message format, message params...)
would prevent usage of ATTRIBUTE_FMT_PRINTF and the associated
compiler checking.
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2012-10-17 18:17:14 +00:00
|
|
|
virLogMetadataPtr metadata,
|
|
|
|
const char *fmt, ...) ATTRIBUTE_FMT_PRINTF(7, 8);
|
2014-02-27 17:44:53 +00:00
|
|
|
extern void virLogVMessage(virLogSourcePtr source,
|
2012-09-27 13:14:01 +00:00
|
|
|
virLogPriority priority,
|
2012-09-27 13:28:44 +00:00
|
|
|
const char *filename,
|
2012-09-27 13:14:01 +00:00
|
|
|
int linenr,
|
2012-09-27 13:28:44 +00:00
|
|
|
const char *funcname,
|
Add a metadata parameter to virLog{, V}Message
... and update all users. No change in functionality, the parameter
will be used later.
The metadata representation is as minimal as possible, but requires
the caller to allocate an array on stack explicitly.
The alternative of using varargs in the virLogMessage() callers:
* Would not allow the caller to optionally omit some metadata elements,
except by having two calls to virLogMessage.
* Would not be as type-safe (e.g. using int vs. size_t), and the compiler
wouldn't be able to do type checking
* Depending on parameter order:
a) virLogMessage(..., message format, message params...,
metadata..., NULL)
can not be portably implemented (parse_printf_format() is a glibc
function)
b) virLogMessage(..., metadata..., NULL,
message format, message params...)
would prevent usage of ATTRIBUTE_FMT_PRINTF and the associated
compiler checking.
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2012-10-17 18:17:14 +00:00
|
|
|
virLogMetadataPtr metadata,
|
2012-01-23 14:57:16 +00:00
|
|
|
const char *fmt,
|
Add a metadata parameter to virLog{, V}Message
... and update all users. No change in functionality, the parameter
will be used later.
The metadata representation is as minimal as possible, but requires
the caller to allocate an array on stack explicitly.
The alternative of using varargs in the virLogMessage() callers:
* Would not allow the caller to optionally omit some metadata elements,
except by having two calls to virLogMessage.
* Would not be as type-safe (e.g. using int vs. size_t), and the compiler
wouldn't be able to do type checking
* Depending on parameter order:
a) virLogMessage(..., message format, message params...,
metadata..., NULL)
can not be portably implemented (parse_printf_format() is a glibc
function)
b) virLogMessage(..., metadata..., NULL,
message format, message params...)
would prevent usage of ATTRIBUTE_FMT_PRINTF and the associated
compiler checking.
Signed-off-by: Miloslav Trmač <mitr@redhat.com>
2012-10-17 18:17:14 +00:00
|
|
|
va_list vargs) ATTRIBUTE_FMT_PRINTF(7, 0);
|
2011-03-08 10:31:20 +00:00
|
|
|
extern int virLogSetBufferSize(int size);
|
2011-03-03 08:32:18 +00:00
|
|
|
extern void virLogEmergencyDumpAll(int signum);
|
2013-03-04 20:46:32 +00:00
|
|
|
|
|
|
|
bool virLogProbablyLogMessage(const char *str);
|
|
|
|
|
2008-11-06 16:36:07 +00:00
|
|
|
#endif
|