git: treat "git -C '<path>'" as a no-op when <path> is empty
[git.git] / trace.h
blobae6a3329470cae428bb0864e51b14ea42078b182
1 #ifndef TRACE_H
2 #define TRACE_H
4 #include "git-compat-util.h"
5 #include "strbuf.h"
7 struct trace_key {
8 const char * const key;
9 int fd;
10 unsigned int initialized : 1;
11 unsigned int need_close : 1;
14 #define TRACE_KEY_INIT(name) { "GIT_TRACE_" #name, 0, 0, 0 }
16 extern void trace_repo_setup(const char *prefix);
17 extern int trace_want(struct trace_key *key);
18 extern void trace_disable(struct trace_key *key);
19 extern uint64_t getnanotime(void);
20 extern void trace_command_performance(const char **argv);
22 #ifndef HAVE_VARIADIC_MACROS
24 __attribute__((format (printf, 1, 2)))
25 extern void trace_printf(const char *format, ...);
27 __attribute__((format (printf, 2, 3)))
28 extern void trace_printf_key(struct trace_key *key, const char *format, ...);
30 __attribute__((format (printf, 2, 3)))
31 extern void trace_argv_printf(const char **argv, const char *format, ...);
33 extern void trace_strbuf(struct trace_key *key, const struct strbuf *data);
35 /* Prints elapsed time (in nanoseconds) if GIT_TRACE_PERFORMANCE is enabled. */
36 __attribute__((format (printf, 2, 3)))
37 extern void trace_performance(uint64_t nanos, const char *format, ...);
39 /* Prints elapsed time since 'start' if GIT_TRACE_PERFORMANCE is enabled. */
40 __attribute__((format (printf, 2, 3)))
41 extern void trace_performance_since(uint64_t start, const char *format, ...);
43 #else
46 * Macros to add file:line - see above for C-style declarations of how these
47 * should be used.
51 * TRACE_CONTEXT may be set to __FUNCTION__ if the compiler supports it. The
52 * default is __FILE__, as it is consistent with assert(), and static function
53 * names are not necessarily unique.
55 * __FILE__ ":" __FUNCTION__ doesn't work with GNUC, as __FILE__ is supplied
56 * by the preprocessor as a string literal, and __FUNCTION__ is filled in by
57 * the compiler as a string constant.
59 #ifndef TRACE_CONTEXT
60 # define TRACE_CONTEXT __FILE__
61 #endif
64 * Note: with C99 variadic macros, __VA_ARGS__ must include the last fixed
65 * parameter ('format' in this case). Otherwise, a call without variable
66 * arguments will have a surplus ','. E.g.:
68 * #define foo(format, ...) bar(format, __VA_ARGS__)
69 * foo("test");
71 * will expand to
73 * bar("test",);
75 * which is invalid (note the ',)'). With GNUC, '##__VA_ARGS__' drops the
76 * comma, but this is non-standard.
79 #define trace_printf(...) \
80 trace_printf_key_fl(TRACE_CONTEXT, __LINE__, NULL, __VA_ARGS__)
82 #define trace_printf_key(key, ...) \
83 trace_printf_key_fl(TRACE_CONTEXT, __LINE__, key, __VA_ARGS__)
85 #define trace_argv_printf(argv, ...) \
86 trace_argv_printf_fl(TRACE_CONTEXT, __LINE__, argv, __VA_ARGS__)
88 #define trace_strbuf(key, data) \
89 trace_strbuf_fl(TRACE_CONTEXT, __LINE__, key, data)
91 #define trace_performance(nanos, ...) \
92 trace_performance_fl(TRACE_CONTEXT, __LINE__, nanos, __VA_ARGS__)
94 #define trace_performance_since(start, ...) \
95 trace_performance_fl(TRACE_CONTEXT, __LINE__, getnanotime() - (start), \
96 __VA_ARGS__)
98 /* backend functions, use non-*fl macros instead */
99 __attribute__((format (printf, 4, 5)))
100 extern void trace_printf_key_fl(const char *file, int line, struct trace_key *key,
101 const char *format, ...);
102 __attribute__((format (printf, 4, 5)))
103 extern void trace_argv_printf_fl(const char *file, int line, const char **argv,
104 const char *format, ...);
105 extern void trace_strbuf_fl(const char *file, int line, struct trace_key *key,
106 const struct strbuf *data);
107 __attribute__((format (printf, 4, 5)))
108 extern void trace_performance_fl(const char *file, int line,
109 uint64_t nanos, const char *fmt, ...);
111 #endif /* HAVE_VARIADIC_MACROS */
113 #endif /* TRACE_H */