usage: allow pluggable die-recursion checks

When any git code calls die or die_errno, we use a counter
to detect recursion into the die functions from any of the
helper functions. However, such a simple counter is not good
enough for threaded programs, which may call die from a
sub-thread, killing only the sub-thread (but incrementing
the counter for everyone).

Rather than try to deal with threads ourselves here, let's
just allow callers to plug in their own recursion-detection
function. This is similar to how we handle the die routine
(the caller plugs in a die routine which may kill only the
sub-thread).

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/git-compat-util.h b/git-compat-util.h
index 9c01e9bc2eaaa9fe302228263bcc0e1e5e9196f8..6aee9df86893459999314554fd246c2f8f847128 100644 (file)
--- a/git-compat-util.h
+++ b/git-compat-util.h
@@ -301,6 +301,7 @@ extern void warning(const char *err, ...) __attribute__((format (printf, 1, 2)))
 
 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 extern void set_error_routine(void (*routine)(const char *err, va_list params));
 
 extern void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params));
 extern void set_error_routine(void (*routine)(const char *err, va_list params));

+extern void set_die_is_recursing_routine(int (*routine)(void));

 
 extern int prefixcmp(const char *str, const char *prefix);
 extern int suffixcmp(const char *str, const char *suffix);
 
 extern int prefixcmp(const char *str, const char *prefix);
 extern int suffixcmp(const char *str, const char *suffix);

diff --git a/usage.c b/usage.c
index 8eab28113a970a3f1bc7b9b430aa50341c2667e2..9d2961ec200fa235bf9a761a2ea0a948b3578334 100644 (file)
--- a/usage.c
+++ b/usage.c
@@ -6,8 +6,6 @@
 #include "git-compat-util.h"
 #include "cache.h"
 
 #include "git-compat-util.h"
 #include "cache.h"
 

-static int dying;
-

 void vreportf(const char *prefix, const char *err, va_list params)
 {
        char msg[4096];
 void vreportf(const char *prefix, const char *err, va_list params)
 {
        char msg[4096];


@@ -49,12 +47,19 @@ static void warn_builtin(const char *warn, va_list params)
        vreportf("warning: ", warn, params);
 }
 
        vreportf("warning: ", warn, params);
 }
 

+static int die_is_recursing_builtin(void)
+{
+       static int dying;
+       return dying++;
+}
+

 /* If we are in a dlopen()ed .so write to a global variable would segfault
  * (ugh), so keep things static. */
 static NORETURN_PTR void (*usage_routine)(const char *err, va_list params) = usage_builtin;
 static NORETURN_PTR void (*die_routine)(const char *err, va_list params) = die_builtin;
 static void (*error_routine)(const char *err, va_list params) = error_builtin;
 static void (*warn_routine)(const char *err, va_list params) = warn_builtin;
 /* If we are in a dlopen()ed .so write to a global variable would segfault
  * (ugh), so keep things static. */
 static NORETURN_PTR void (*usage_routine)(const char *err, va_list params) = usage_builtin;
 static NORETURN_PTR void (*die_routine)(const char *err, va_list params) = die_builtin;
 static void (*error_routine)(const char *err, va_list params) = error_builtin;
 static void (*warn_routine)(const char *err, va_list params) = warn_builtin;

+static int (*die_is_recursing)(void) = die_is_recursing_builtin;

 
 void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params))
 {
 
 void set_die_routine(NORETURN_PTR void (*routine)(const char *err, va_list params))
 {


@@ -66,6 +71,11 @@ void set_error_routine(void (*routine)(const char *err, va_list params))
        error_routine = routine;
 }
 
        error_routine = routine;
 }
 

+void set_die_is_recursing_routine(int (*routine)(void))
+{
+       die_is_recursing = routine;
+}
+

 void NORETURN usagef(const char *err, ...)
 {
        va_list params;
 void NORETURN usagef(const char *err, ...)
 {
        va_list params;


@@ -84,11 +94,10 @@ void NORETURN die(const char *err, ...)
 {
        va_list params;
 
 {
        va_list params;
 

-       if (dying) {
+       if (die_is_recursing()) {

                fputs("fatal: recursion detected in die handler\n", stderr);
                exit(128);
        }
                fputs("fatal: recursion detected in die handler\n", stderr);
                exit(128);
        }

-       dying = 1;

 
        va_start(params, err);
        die_routine(err, params);
 
        va_start(params, err);
        die_routine(err, params);


@@ -102,12 +111,11 @@ void NORETURN die_errno(const char *fmt, ...)
        char str_error[256], *err;
        int i, j;
 
        char str_error[256], *err;
        int i, j;
 

-       if (dying) {
+       if (die_is_recursing()) {

                fputs("fatal: recursion detected in die_errno handler\n",
                        stderr);
                exit(128);
        }
                fputs("fatal: recursion detected in die_errno handler\n",
                        stderr);
                exit(128);
        }

-       dying = 1;

 
        err = strerror(errno);
        for (i = j = 0; err[i] && j < sizeof(str_error) - 1; ) {
 
        err = strerror(errno);
        for (i = j = 0; err[i] && j < sizeof(str_error) - 1; ) {