trace: add high resolution timer function to debug performance issues
[git/git.git] / trace.h
CommitLineData
5991a55c
KB
1#ifndef TRACE_H
2#define TRACE_H
3
4#include "git-compat-util.h"
5#include "strbuf.h"
6
6aa30857
KB
7struct trace_key {
8 const char * const key;
9 int fd;
10 unsigned int initialized : 1;
11 unsigned int need_close : 1;
12};
13
14#define TRACE_KEY_INIT(name) { "GIT_TRACE_" #name, 0, 0, 0 }
15
5991a55c 16extern void trace_repo_setup(const char *prefix);
6aa30857
KB
17extern int trace_want(struct trace_key *key);
18extern void trace_disable(struct trace_key *key);
148d6771 19extern uint64_t getnanotime(void);
66f66c59 20
e05bed96
KB
21#ifndef HAVE_VARIADIC_MACROS
22
66f66c59
KB
23__attribute__((format (printf, 1, 2)))
24extern void trace_printf(const char *format, ...);
25
5991a55c 26__attribute__((format (printf, 2, 3)))
6aa30857 27extern void trace_printf_key(struct trace_key *key, const char *format, ...);
66f66c59
KB
28
29__attribute__((format (printf, 2, 3)))
30extern void trace_argv_printf(const char **argv, const char *format, ...);
31
c69dfd24 32extern void trace_strbuf(struct trace_key *key, const struct strbuf *data);
5991a55c 33
e05bed96
KB
34#else
35
36/*
37 * Macros to add file:line - see above for C-style declarations of how these
38 * should be used.
39 */
40
41/*
42 * TRACE_CONTEXT may be set to __FUNCTION__ if the compiler supports it. The
43 * default is __FILE__, as it is consistent with assert(), and static function
44 * names are not necessarily unique.
45 *
46 * __FILE__ ":" __FUNCTION__ doesn't work with GNUC, as __FILE__ is supplied
47 * by the preprocessor as a string literal, and __FUNCTION__ is filled in by
48 * the compiler as a string constant.
49 */
50#ifndef TRACE_CONTEXT
51# define TRACE_CONTEXT __FILE__
52#endif
53
54/*
55 * Note: with C99 variadic macros, __VA_ARGS__ must include the last fixed
56 * parameter ('format' in this case). Otherwise, a call without variable
57 * arguments will have a surplus ','. E.g.:
58 *
59 * #define foo(format, ...) bar(format, __VA_ARGS__)
60 * foo("test");
61 *
62 * will expand to
63 *
64 * bar("test",);
65 *
66 * which is invalid (note the ',)'). With GNUC, '##__VA_ARGS__' drops the
67 * comma, but this is non-standard.
68 */
69
70#define trace_printf(...) \
71 trace_printf_key_fl(TRACE_CONTEXT, __LINE__, NULL, __VA_ARGS__)
72
73#define trace_printf_key(key, ...) \
74 trace_printf_key_fl(TRACE_CONTEXT, __LINE__, key, __VA_ARGS__)
75
76#define trace_argv_printf(argv, ...) \
77 trace_argv_printf_fl(TRACE_CONTEXT, __LINE__, argv, __VA_ARGS__)
78
79#define trace_strbuf(key, data) \
80 trace_strbuf_fl(TRACE_CONTEXT, __LINE__, key, data)
81
82/* backend functions, use non-*fl macros instead */
83__attribute__((format (printf, 4, 5)))
84extern void trace_printf_key_fl(const char *file, int line, struct trace_key *key,
85 const char *format, ...);
86__attribute__((format (printf, 4, 5)))
87extern void trace_argv_printf_fl(const char *file, int line, const char **argv,
88 const char *format, ...);
89extern void trace_strbuf_fl(const char *file, int line, struct trace_key *key,
90 const struct strbuf *data);
91
92#endif /* HAVE_VARIADIC_MACROS */
93
5991a55c 94#endif /* TRACE_H */