mirror of
https://github.com/git/git.git
synced 2024-10-29 21:37:53 +01:00
578da0391a
Use trace_performance to measure and print execution time and command line arguments of the entire main() function. In constrast to the shell's 'time' utility, which measures total time of the parent process, this logs all involved git commands recursively. This is particularly useful to debug performance issues of scripted commands (i.e. which git commands were called with which parameters, and how long did they execute). Due to git's deliberate use of exit(), the implementation uses an atexit routine rather than just adding trace_performance_since() at the end of main(). Usage example: > GIT_TRACE_PERFORMANCE=~/git-trace.log git stash list Creates a log file like this: 23:57:38.638765 trace.c:405 performance: 0.000310107 s: git command: 'git' 'rev-parse' '--git-dir' 23:57:38.644387 trace.c:405 performance: 0.000261759 s: git command: 'git' 'rev-parse' '--show-toplevel' 23:57:38.646207 trace.c:405 performance: 0.000304468 s: git command: 'git' 'config' '--get-colorbool' 'color.interactive' 23:57:38.648491 trace.c:405 performance: 0.000241667 s: git command: 'git' 'config' '--get-color' 'color.interactive.help' 'red bold' 23:57:38.650465 trace.c:405 performance: 0.000243063 s: git command: 'git' 'config' '--get-color' '' 'reset' 23:57:38.654850 trace.c:405 performance: 0.025126313 s: git command: 'git' 'stash' 'list' Signed-off-by: Karsten Blees <blees@dcon.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
113 lines
3.5 KiB
C
113 lines
3.5 KiB
C
#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;
|
|
};
|
|
|
|
#define TRACE_KEY_INIT(name) { "GIT_TRACE_" #name, 0, 0, 0 }
|
|
|
|
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);
|
|
|
|
#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(...) \
|
|
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)
|
|
|
|
#define trace_performance(nanos, ...) \
|
|
trace_performance_fl(TRACE_CONTEXT, __LINE__, nanos, __VA_ARGS__)
|
|
|
|
#define trace_performance_since(start, ...) \
|
|
trace_performance_fl(TRACE_CONTEXT, __LINE__, getnanotime() - (start), \
|
|
__VA_ARGS__)
|
|
|
|
/* 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, ...);
|
|
|
|
#endif /* HAVE_VARIADIC_MACROS */
|
|
|
|
#endif /* TRACE_H */
|