trace.h

   1 #ifndef TRACE_H
   2 #define TRACE_H
   3
   4 #include "git-compat-util.h"
   5 #include "strbuf.h"
   6
   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
  14 #define TRACE_KEY_INIT(name) { "GIT_TRACE_" #name, 0, 0, 0 }
  15
  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);
  21
  22 #ifndef HAVE_VARIADIC_MACROS
  23
  24 __attribute__((format (printf, 1, 2)))
  25 extern void trace_printf(const char *format, ...);
  26
  27 __attribute__((format (printf, 2, 3)))
  28 extern void trace_printf_key(struct trace_key *key, const char *format, ...);
  29
  30 __attribute__((format (printf, 2, 3)))
  31 extern void trace_argv_printf(const char **argv, const char *format, ...);
  32
  33 extern void trace_strbuf(struct trace_key *key, const struct strbuf *data);
  34
  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, ...);
  38
  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, ...);
  42
  43 #else
  44
  45 /*
  46  * Macros to add file:line - see above for C-style declarations of how these
  47  * should be used.
  48  */
  49
  50 /*
  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.
  54  *
  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.
  58  */
  59 #ifndef TRACE_CONTEXT
  60 # define TRACE_CONTEXT __FILE__
  61 #endif
  62
  63 /*
  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.:
  67  *
  68  *  #define foo(format, ...) bar(format, __VA_ARGS__)
  69  *  foo("test");
  70  *
  71  * will expand to
  72  *
  73  *  bar("test",);
  74  *
  75  * which is invalid (note the ',)'). With GNUC, '##__VA_ARGS__' drops the
  76  * comma, but this is non-standard.
  77  */
  78
  79 #define trace_printf(...) \
  80         trace_printf_key_fl(TRACE_CONTEXT, __LINE__, NULL, __VA_ARGS__)
  81
  82 #define trace_printf_key(key, ...) \
  83         trace_printf_key_fl(TRACE_CONTEXT, __LINE__, key, __VA_ARGS__)
  84
  85 #define trace_argv_printf(argv, ...) \
  86         trace_argv_printf_fl(TRACE_CONTEXT, __LINE__, argv, __VA_ARGS__)
  87
  88 #define trace_strbuf(key, data) \
  89         trace_strbuf_fl(TRACE_CONTEXT, __LINE__, key, data)
  90
  91 #define trace_performance(nanos, ...) \
  92         trace_performance_fl(TRACE_CONTEXT, __LINE__, nanos, __VA_ARGS__)
  93
  94 #define trace_performance_since(start, ...) \
  95         trace_performance_fl(TRACE_CONTEXT, __LINE__, getnanotime() - (start), \
  96                              __VA_ARGS__)
  97
  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, ...);
 110
 111 #endif /* HAVE_VARIADIC_MACROS */
 112
 113 #endif /* TRACE_H */