2014-06-11 15:56:49 +08:00
|
|
|
#ifndef TRACE_H
|
|
|
|
#define TRACE_H
|
|
|
|
|
|
|
|
#include "git-compat-util.h"
|
|
|
|
#include "strbuf.h"
|
|
|
|
|
2014-07-12 08:00:06 +08:00
|
|
|
struct trace_key {
|
|
|
|
const char * const key;
|
|
|
|
int fd;
|
|
|
|
unsigned int initialized : 1;
|
|
|
|
unsigned int need_close : 1;
|
|
|
|
};
|
|
|
|
|
|
|
|
#define TRACE_KEY_INIT(name) { "GIT_TRACE_" #name, 0, 0, 0 }
|
|
|
|
|
2014-06-11 15:56:49 +08:00
|
|
|
extern void trace_repo_setup(const char *prefix);
|
2014-07-12 08:00:06 +08:00
|
|
|
extern int trace_want(struct trace_key *key);
|
|
|
|
extern void trace_disable(struct trace_key *key);
|
2014-07-12 08:05:42 +08:00
|
|
|
extern uint64_t getnanotime(void);
|
2014-07-12 08:04:29 +08:00
|
|
|
|
2014-07-12 08:05:03 +08:00
|
|
|
#ifndef HAVE_VARIADIC_MACROS
|
|
|
|
|
2014-07-12 08:04:29 +08:00
|
|
|
__attribute__((format (printf, 1, 2)))
|
|
|
|
extern void trace_printf(const char *format, ...);
|
|
|
|
|
2014-06-11 15:56:49 +08:00
|
|
|
__attribute__((format (printf, 2, 3)))
|
2014-07-12 08:00:06 +08:00
|
|
|
extern void trace_printf_key(struct trace_key *key, const char *format, ...);
|
2014-07-12 08:04:29 +08:00
|
|
|
|
|
|
|
__attribute__((format (printf, 2, 3)))
|
|
|
|
extern void trace_argv_printf(const char **argv, const char *format, ...);
|
|
|
|
|
trace: add infrastructure to augment trace output with additional info
To be able to add a common prefix or suffix to all trace output (e.g.
a timestamp or file:line of the caller), factor out common setup and
cleanup tasks of the trace* functions.
When adding a common prefix, it makes sense that the output of each trace
call starts on a new line. Add '\n' in case the caller forgot.
Note that this explicitly limits trace output to line-by-line, it is no
longer possible to trace-print just part of a line. Until now, this was
just an implicit assumption (trace-printing part of a line worked, but
messed up the trace file if multiple threads or processes were involved).
Thread-safety / inter-process-safety is also the reason why we need to do
the prefixing and suffixing in memory rather than issuing multiple write()
calls. Write_or_whine_pipe() / xwrite() is atomic unless the size exceeds
MAX_IO_SIZE (8MB, see wrapper.c). In case of trace_strbuf, this costs an
additional string copy (which should be irrelevant for performance in light
of actual file IO).
While we're at it, rename trace_strbuf's 'buf' argument, which suggests
that the function is modifying the buffer. Trace_strbuf() currently is the
only trace API that can print arbitrary binary data (without barfing on
'%' or stopping at '\0'), so 'data' seems more appropriate.
Signed-off-by: Karsten Blees <blees@dcon.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-07-12 08:02:18 +08:00
|
|
|
extern void trace_strbuf(struct trace_key *key, const struct strbuf *data);
|
2014-06-11 15:56:49 +08:00
|
|
|
|
2014-07-12 08:05:03 +08:00
|
|
|
#else
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Macros to add file:line - see above for C-style declarations of how these
|
|
|
|
* should be used.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* TRACE_CONTEXT may be set to __FUNCTION__ if the compiler supports it. The
|
|
|
|
* default is __FILE__, as it is consistent with assert(), and static function
|
|
|
|
* names are not necessarily unique.
|
|
|
|
*
|
|
|
|
* __FILE__ ":" __FUNCTION__ doesn't work with GNUC, as __FILE__ is supplied
|
|
|
|
* by the preprocessor as a string literal, and __FUNCTION__ is filled in by
|
|
|
|
* the compiler as a string constant.
|
|
|
|
*/
|
|
|
|
#ifndef TRACE_CONTEXT
|
|
|
|
# define TRACE_CONTEXT __FILE__
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Note: with C99 variadic macros, __VA_ARGS__ must include the last fixed
|
|
|
|
* parameter ('format' in this case). Otherwise, a call without variable
|
|
|
|
* arguments will have a surplus ','. E.g.:
|
|
|
|
*
|
|
|
|
* #define foo(format, ...) bar(format, __VA_ARGS__)
|
|
|
|
* foo("test");
|
|
|
|
*
|
|
|
|
* will expand to
|
|
|
|
*
|
|
|
|
* bar("test",);
|
|
|
|
*
|
|
|
|
* which is invalid (note the ',)'). With GNUC, '##__VA_ARGS__' drops the
|
|
|
|
* comma, but this is non-standard.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define trace_printf(...) \
|
|
|
|
trace_printf_key_fl(TRACE_CONTEXT, __LINE__, NULL, __VA_ARGS__)
|
|
|
|
|
|
|
|
#define trace_printf_key(key, ...) \
|
|
|
|
trace_printf_key_fl(TRACE_CONTEXT, __LINE__, key, __VA_ARGS__)
|
|
|
|
|
|
|
|
#define trace_argv_printf(argv, ...) \
|
|
|
|
trace_argv_printf_fl(TRACE_CONTEXT, __LINE__, argv, __VA_ARGS__)
|
|
|
|
|
|
|
|
#define trace_strbuf(key, data) \
|
|
|
|
trace_strbuf_fl(TRACE_CONTEXT, __LINE__, key, data)
|
|
|
|
|
|
|
|
/* backend functions, use non-*fl macros instead */
|
|
|
|
__attribute__((format (printf, 4, 5)))
|
|
|
|
extern void trace_printf_key_fl(const char *file, int line, struct trace_key *key,
|
|
|
|
const char *format, ...);
|
|
|
|
__attribute__((format (printf, 4, 5)))
|
|
|
|
extern void trace_argv_printf_fl(const char *file, int line, const char **argv,
|
|
|
|
const char *format, ...);
|
|
|
|
extern void trace_strbuf_fl(const char *file, int line, struct trace_key *key,
|
|
|
|
const struct strbuf *data);
|
|
|
|
|
|
|
|
#endif /* HAVE_VARIADIC_MACROS */
|
|
|
|
|
2014-06-11 15:56:49 +08:00
|
|
|
#endif /* TRACE_H */
|