Add DEBUG_ERROR_LOCATIONS support

If DEBUG_ERROR_LOCATIONS is defined, replace uses of
krb5_set_error_message and krb5int_set_error with calls to the new
_fl variants of those functions, and include filename and line number
information in the calls.  Requires C99-style variadic macros if
defined.

ticket: 6479

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@22291 dc483132-0cff-0310-8789-dd5450dbe970

diff --git a/src/include/k5-err.h b/src/include/k5-err.h
index a6dedcc88aab438fec350db8eb4a2f33e8bed454..e5fc9bddf74b08d6399351a6427a935651c8a7e0 100644 (file)
--- a/src/include/k5-err.h
+++ b/src/include/k5-err.h
@@ -65,6 +65,22 @@ krb5int_vset_error (struct errinfo *ep, long code,
     __attribute__((__format__(__printf__, 3, 0)))
 #endif
     ;
+void
+krb5int_set_error_fl (struct errinfo *ep, long code,
+                     const char *file, int line,
+                     const char *fmt, ...)
+#if !defined(__cplusplus) && (__GNUC__ > 2)
+    __attribute__((__format__(__printf__, 5, 6)))
+#endif
+    ;
+void
+krb5int_vset_error_fl (struct errinfo *ep, long code,
+                      const char *file, int line,
+                      const char *fmt, va_list args)
+#if !defined(__cplusplus) && (__GNUC__ > 2)
+    __attribute__((__format__(__printf__, 5, 0)))
+#endif
+    ;
 const char *
 krb5int_get_error (struct errinfo *ep, long code);
 void
@@ -74,4 +90,9 @@ krb5int_clear_error (struct errinfo *ep);
 void
 krb5int_set_error_info_callout_fn (const char *(KRB5_CALLCONV *f)(long));
 
+#ifdef DEBUG_ERROR_LOCATIONS
+#define krb5int_set_error(ep, code, ...) \
+    krb5int_set_error_fl(ep, code, __FILE__, __LINE__, __VA_ARGS__)
+#endif
+
 #endif /* K5_ERR_H */

diff --git a/src/include/k5-int.h b/src/include/k5-int.h
index 5e159d9a4fb67503f43710b479a4f19692953485..de391a7d95cd7f27c535e18c4e5e071db55634fc 100644 (file)
--- a/src/include/k5-int.h
+++ b/src/include/k5-int.h
@@ -2797,4 +2797,9 @@ krb5int_pac_sign(krb5_context context,
                 const krb5_keyblock *privsvr_key,
                 krb5_data *data);
 
+#ifdef DEBUG_ERROR_LOCATIONS
+#define krb5_set_error_message(ctx, code, ...) \
+    krb5_set_error_message_fl(ctx, code, __FILE__, __LINE__, __VA_ARGS__)
+#endif
+
 #endif /* _KRB5_INT_H */

diff --git a/src/lib/krb5/krb/kerrs.c b/src/lib/krb5/krb/kerrs.c
index 647076485c393c34e4a7f0e0da262b963537fcff..b7e4fc1c72e32cbf42d77e6fb3d628b1d7df2c65 100644 (file)
--- a/src/lib/krb5/krb/kerrs.c
+++ b/src/lib/krb5/krb/kerrs.c
@@ -35,6 +35,7 @@ static int error_message_debug = 0;
 #endif
 #endif
 
+#undef krb5_set_error_message
 void KRB5_CALLCONV_C
 krb5_set_error_message (krb5_context ctx, krb5_error_code code,
                        const char *fmt, ...)
@@ -57,6 +58,28 @@ krb5_set_error_message (krb5_context ctx, krb5_error_code code,
     va_end (args);
 }
 
+void KRB5_CALLCONV_C
+krb5_set_error_message_fl (krb5_context ctx, krb5_error_code code,
+                          const char *file, int line, const char *fmt, ...)
+{
+    va_list args;
+    if (ctx == NULL)
+       return;
+    va_start (args, fmt);
+#ifdef DEBUG
+    if (ERROR_MESSAGE_DEBUG())
+       fprintf(stderr,
+               "krb5_set_error_message(ctx=%p/err=%p, code=%ld, ...)\n",
+               ctx, &ctx->err, (long) code);
+#endif
+    krb5int_vset_error_fl (&ctx->err, code, file, line, fmt, args);
+#ifdef DEBUG
+    if (ERROR_MESSAGE_DEBUG())
+       fprintf(stderr, "->%s\n", ctx->err.msg);
+#endif
+    va_end (args);
+}
+
 void KRB5_CALLCONV
 krb5_vset_error_message (krb5_context ctx, krb5_error_code code,
                         const char *fmt, va_list args)

diff --git a/src/lib/krb5/libkrb5.exports b/src/lib/krb5/libkrb5.exports
index f30b57114b9ff54766ca96a48c799d22d6fba7c6..45e5002f099c3c82f6ca512d23fe971b4d6b7c3f 100644 (file)
--- a/src/lib/krb5/libkrb5.exports
+++ b/src/lib/krb5/libkrb5.exports
@@ -487,6 +487,7 @@ krb5_set_default_realm
 krb5_set_default_tgs_enctypes
 krb5_set_default_tgs_ktypes
 krb5_set_error_message
+krb5_set_error_message_fl
 krb5_set_password
 krb5_set_password_using_ccache
 krb5_set_principal_realm

diff --git a/src/util/support/errors.c b/src/util/support/errors.c
index 4111ed478b9089e6894134c29cdea999437c8585..8d523b98b3e75af6c022f6d599b494bc358d0a80 100644 (file)
--- a/src/util/support/errors.c
+++ b/src/util/support/errors.c
@@ -34,21 +34,40 @@ krb5int_err_init (void)
 #define lock()         k5_mutex_lock(&krb5int_error_info_support_mutex)
 #define unlock()       k5_mutex_unlock(&krb5int_error_info_support_mutex)
 
+#undef krb5int_set_error
 void
 krb5int_set_error (struct errinfo *ep, long code, const char *fmt, ...)
 {
     va_list args;
     va_start (args, fmt);
-    krb5int_vset_error (ep, code, fmt, args);
+    krb5int_vset_error_fl (ep, code, NULL, 0, fmt, args);
+    va_end (args);
+}
+
+void
+krb5int_set_error_fl (struct errinfo *ep, long code,
+                     const char *file, int line, const char *fmt, ...)
+{
+    va_list args;
+    va_start (args, fmt);
+    krb5int_vset_error_fl (ep, code, file, line, fmt, args);
     va_end (args);
 }
 
 void
 krb5int_vset_error (struct errinfo *ep, long code,
                    const char *fmt, va_list args)
+{
+    krb5int_vset_error_fl(ep, code, NULL, 0, fmt, args);
+}
+
+void
+krb5int_vset_error_fl (struct errinfo *ep, long code,
+                      const char *file, int line,
+                      const char *fmt, va_list args)
 {
     va_list args2;
-    char *str = NULL;
+    char *str = NULL, *str2, *slash;
     const char *loc_fmt = NULL;
     
 #ifdef USE_KIM
@@ -66,6 +85,17 @@ krb5int_vset_error (struct errinfo *ep, long code,
        str = NULL;
     }
     va_end(args2);
+
+    if (str && line) {
+       /* Try to add file and line suffix. */
+       slash = strrchr(file, '/');
+       if (slash)
+           file = slash + 1;
+       if (asprintf(&str2, "%s (%s: %d)", str, file, line) > 0) {
+           free(str);
+           str = str2;
+       }
+    }
     
     /* If that failed, try using scratch_buf */
     if (str == NULL) {

diff --git a/src/util/support/libkrb5support-fixed.exports b/src/util/support/libkrb5support-fixed.exports
index 4638bb659703799978e791ccb39dce3a96c111fc..3560ce63a1ef6f7b58c0cd093ad740daea91eb25 100644 (file)
--- a/src/util/support/libkrb5support-fixed.exports
+++ b/src/util/support/libkrb5support-fixed.exports
@@ -24,6 +24,8 @@ krb5int_mutex_lock
 krb5int_mutex_unlock
 krb5int_set_error
 krb5int_vset_error
+krb5int_set_error_fl
+krb5int_vset_error_fl
 krb5int_get_error
 krb5int_free_error
 krb5int_clear_error