[thirdparty/git.git] / trace.h

#ifndef TRACE_H
#define TRACE_H

#include "git-compat-util.h"
#include "strbuf.h"

struct trace_key {
	const char * const key;
	int fd;
	unsigned int initialized : 1;
	unsigned int  need_close : 1;
};

extern struct trace_key trace_default_key;

#define TRACE_KEY_INIT(name) { "GIT_TRACE_" #name, 0, 0, 0 }
extern struct trace_key trace_perf_key;
extern struct trace_key trace_setup_key;

extern void trace_repo_setup(const char *prefix);
extern int trace_want(struct trace_key *key);
extern void trace_disable(struct trace_key *key);
extern uint64_t getnanotime(void);
extern void trace_command_performance(const char **argv);
extern void trace_verbatim(struct trace_key *key, const void *buf, unsigned len);

#ifndef HAVE_VARIADIC_MACROS

__attribute__((format (printf, 1, 2)))
extern void trace_printf(const char *format, ...);

__attribute__((format (printf, 2, 3)))
extern void trace_printf_key(struct trace_key *key, const char *format, ...);

__attribute__((format (printf, 2, 3)))
extern void trace_argv_printf(const char **argv, const char *format, ...);

extern void trace_strbuf(struct trace_key *key, const struct strbuf *data);

/* Prints elapsed time (in nanoseconds) if GIT_TRACE_PERFORMANCE is enabled. */
__attribute__((format (printf, 2, 3)))
extern void trace_performance(uint64_t nanos, const char *format, ...);

/* Prints elapsed time since 'start' if GIT_TRACE_PERFORMANCE is enabled. */
__attribute__((format (printf, 2, 3)))
extern void trace_performance_since(uint64_t start, const char *format, ...);

#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_key(key, ...)					    \
	do {								    \
		if (trace_pass_fl(key))					    \
			trace_printf_key_fl(TRACE_CONTEXT, __LINE__, key,   \
					    __VA_ARGS__);		    \
	} while (0)

#define trace_printf(...) trace_printf_key(&trace_default_key, __VA_ARGS__)

#define trace_argv_printf(argv, ...)					    \
	do {								    \
		if (trace_pass_fl(&trace_default_key))			    \
			trace_argv_printf_fl(TRACE_CONTEXT, __LINE__,	    \
					    argv, __VA_ARGS__);		    \
	} while (0)

#define trace_strbuf(key, data)						    \
	do {								    \
		if (trace_pass_fl(key))					    \
			trace_strbuf_fl(TRACE_CONTEXT, __LINE__, key, data);\
	} while (0)

#define trace_performance(nanos, ...)					    \
	do {								    \
		if (trace_pass_fl(&trace_perf_key))			    \
			trace_performance_fl(TRACE_CONTEXT, __LINE__, nanos,\
					     __VA_ARGS__);		    \
	} while (0)

#define trace_performance_since(start, ...)				    \
	do {								    \
		if (trace_pass_fl(&trace_perf_key))			    \
			trace_performance_fl(TRACE_CONTEXT, __LINE__,       \
					     getnanotime() - (start),	    \
					     __VA_ARGS__);		    \
	} while (0)

/* 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);
__attribute__((format (printf, 4, 5)))
extern void trace_performance_fl(const char *file, int line,
				 uint64_t nanos, const char *fmt, ...);
static inline int trace_pass_fl(struct trace_key *key)
{
	return key->fd || !key->initialized;
}

#endif /* HAVE_VARIADIC_MACROS */

#endif /* TRACE_H */
Commit	Line	Data
5991a55c KB	1	#ifndef TRACE_H
	2	#define TRACE_H
	3
	4	#include "git-compat-util.h"
	5	#include "strbuf.h"
	6
6aa30857 KB	7	struct trace_key {
	8	const char * const key;
	9	int fd;
	10	unsigned int initialized : 1;
	11	unsigned int need_close : 1;
	12	};
	13
406102a7 GK	14	extern struct trace_key trace_default_key;
406102a7 GK	15
6aa30857	16	#define TRACE_KEY_INIT(name) { "GIT_TRACE_" #name, 0, 0, 0 }
8eeb25c6	17	extern struct trace_key trace_perf_key;
cb507619	18	extern struct trace_key trace_setup_key;
6aa30857	19
5991a55c	20	extern void trace_repo_setup(const char *prefix);
6aa30857 KB	21	extern int trace_want(struct trace_key *key);
6aa30857 KB	22	extern void trace_disable(struct trace_key *key);
148d6771	23	extern uint64_t getnanotime(void);
578da039	24	extern void trace_command_performance(const char **argv);
32359838	25	extern void trace_verbatim(struct trace_key key, const void buf, unsigned len);
66f66c59	26
e05bed96 KB	27	#ifndef HAVE_VARIADIC_MACROS
e05bed96 KB	28
66f66c59 KB	29	__attribute__((format (printf, 1, 2)))
	30	extern void trace_printf(const char *format, ...);
	31
5991a55c	32	__attribute__((format (printf, 2, 3)))
6aa30857	33	extern void trace_printf_key(struct trace_key key, const char format, ...);
66f66c59 KB	34
	35	__attribute__((format (printf, 2, 3)))
	36	extern void trace_argv_printf(const char *argv, const char format, ...);
	37
c69dfd24	38	extern void trace_strbuf(struct trace_key key, const struct strbuf data);
5991a55c	39
09b2c1c7 KB	40	/* Prints elapsed time (in nanoseconds) if GIT_TRACE_PERFORMANCE is enabled. */
	41	__attribute__((format (printf, 2, 3)))
	42	extern void trace_performance(uint64_t nanos, const char *format, ...);
	43
	44	/* Prints elapsed time since 'start' if GIT_TRACE_PERFORMANCE is enabled. */
	45	__attribute__((format (printf, 2, 3)))
	46	extern void trace_performance_since(uint64_t start, const char *format, ...);
	47
e05bed96 KB	48	#else
	49
	50	/*
	51	* Macros to add file:line - see above for C-style declarations of how these
	52	* should be used.
	53	*/
	54
	55	/*
	56	* TRACE_CONTEXT may be set to __FUNCTION__ if the compiler supports it. The
	57	* default is __FILE__, as it is consistent with assert(), and static function
	58	* names are not necessarily unique.
	59	*
	60	* __FILE__ ":" __FUNCTION__ doesn't work with GNUC, as __FILE__ is supplied
	61	* by the preprocessor as a string literal, and __FUNCTION__ is filled in by
	62	* the compiler as a string constant.
	63	*/
	64	#ifndef TRACE_CONTEXT
	65	# define TRACE_CONTEXT __FILE__
	66	#endif
	67
	68	/*
	69	* Note: with C99 variadic macros, __VA_ARGS__ must include the last fixed
	70	* parameter ('format' in this case). Otherwise, a call without variable
	71	* arguments will have a surplus ','. E.g.:
	72	*
	73	* #define foo(format, ...) bar(format, __VA_ARGS__)
	74	* foo("test");
	75	*
	76	* will expand to
	77	*
	78	* bar("test",);
	79	*
	80	* which is invalid (note the ',)'). With GNUC, '##__VA_ARGS__' drops the
	81	* comma, but this is non-standard.
	82	*/
	83
8eeb25c6 GK	84	#define trace_printf_key(key, ...) \
	85	do { \
	86	if (trace_pass_fl(key)) \
	87	trace_printf_key_fl(TRACE_CONTEXT, __LINE__, key, \
	88	__VA_ARGS__); \
	89	} while (0)
	90
	91	#define trace_printf(...) trace_printf_key(&trace_default_key, __VA_ARGS__)
	92
	93	#define trace_argv_printf(argv, ...) \
	94	do { \
	95	if (trace_pass_fl(&trace_default_key)) \
	96	trace_argv_printf_fl(TRACE_CONTEXT, __LINE__, \
	97	argv, __VA_ARGS__); \
	98	} while (0)
	99
	100	#define trace_strbuf(key, data) \
	101	do { \
	102	if (trace_pass_fl(key)) \
	103	trace_strbuf_fl(TRACE_CONTEXT, __LINE__, key, data);\
	104	} while (0)
	105
	106	#define trace_performance(nanos, ...) \
	107	do { \
	108	if (trace_pass_fl(&trace_perf_key)) \
	109	trace_performance_fl(TRACE_CONTEXT, __LINE__, nanos,\
	110	__VA_ARGS__); \
	111	} while (0)
	112
	113	#define trace_performance_since(start, ...) \
	114	do { \
	115	if (trace_pass_fl(&trace_perf_key)) \
	116	trace_performance_fl(TRACE_CONTEXT, __LINE__, \
	117	getnanotime() - (start), \
	118	__VA_ARGS__); \
	119	} while (0)
09b2c1c7	120
e05bed96 KB	121	/* backend functions, use non-fl macros instead /
	122	__attribute__((format (printf, 4, 5)))
	123	extern void trace_printf_key_fl(const char file, int line, struct trace_key key,
	124	const char *format, ...);
	125	__attribute__((format (printf, 4, 5)))
	126	extern void trace_argv_printf_fl(const char file, int line, const char *argv,
	127	const char *format, ...);
	128	extern void trace_strbuf_fl(const char file, int line, struct trace_key key,
	129	const struct strbuf *data);
09b2c1c7 KB	130	__attribute__((format (printf, 4, 5)))
	131	extern void trace_performance_fl(const char *file, int line,
	132	uint64_t nanos, const char *fmt, ...);
8eeb25c6 GK	133	static inline int trace_pass_fl(struct trace_key *key)
	134	{
	135	return key->fd \|\| !key->initialized;
	136	}
e05bed96 KB	137
	138	#endif /* HAVE_VARIADIC_MACROS */
	139
5991a55c	140	#endif /* TRACE_H */