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: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
|
|
|
|
|
|
|
|
#endif /* TRACE_H */
|