Typo
[freeradius.git] / src / lib / debug.c
index 185bbcf..1947325 100644 (file)
@@ -86,6 +86,9 @@ static int fr_debugger_present = -1;                  //!< Whether were attached to by a debugg
 static struct rlimit core_limits;
 #endif
 
+static TALLOC_CTX *talloc_null_ctx;
+static TALLOC_CTX *talloc_autofree_ctx;
+
 #define FR_FAULT_LOG(fmt, ...) fr_fault_log(fmt "\n", ## __VA_ARGS__)
 
 /** Stub callback to see if the SIGTRAP handler is overriden
@@ -117,28 +120,6 @@ void fr_debug_break(void)
 }
 
 #ifdef HAVE_EXECINFO
-/** Generate a backtrace for an object during destruction
- *
- * If this is the first entry being inserted
- */
-static int _fr_do_bt(fr_bt_marker_t *marker)
-{
-       fr_bt_info_t *bt;
-
-       if (!fr_assert(marker->obj) || !fr_assert(marker->cbuff)) {
-               return -1;
-       }
-
-       bt = talloc_zero(marker->cbuff, fr_bt_info_t);
-       if (!bt) {
-               return -1;
-       }
-       bt->count = backtrace(bt->frames, MAX_BT_FRAMES);
-       fr_cbuff_rp_insert(marker->cbuff, bt);
-
-       return 0;
-}
-
 /** Print backtrace entry for a given object
  *
  * @param cbuff to search in.
@@ -148,23 +129,13 @@ void backtrace_print(fr_cbuff_t *cbuff, void *obj)
 {
        fr_bt_info_t *p;
        bool found = false;
-       int i = 0;
-       char **frames;
 
        while ((p = fr_cbuff_rp_next(cbuff, NULL))) {
-               if ((p == obj) || !obj) {
+               if ((p->obj == obj) || !obj) {
                        found = true;
-                       frames = backtrace_symbols(p->frames, p->count);
 
-                       fprintf(stderr, "Stacktrace for: %p\n", p);
-                       for (i = 0; i < p->count; i++) {
-                               fprintf(stderr, "%s\n", frames[i]);
-                       }
-
-                       /* We were only asked to look for one */
-                       if (obj) {
-                               return;
-                       }
+                       fprintf(stderr, "Stacktrace for: %p\n", p->obj);
+                       backtrace_symbols_fd(p->frames, p->count, STDERR_FILENO);
                }
        };
 
@@ -173,6 +144,27 @@ void backtrace_print(fr_cbuff_t *cbuff, void *obj)
        }
 }
 
+/** Generate a backtrace for an object
+ *
+ * If this is the first entry being inserted
+ */
+int fr_backtrace_do(fr_bt_marker_t *marker)
+{
+       fr_bt_info_t *bt;
+
+       if (!fr_assert(marker->obj) || !fr_assert(marker->cbuff)) return -1;
+
+       bt = talloc_zero(NULL, fr_bt_info_t);
+       if (!bt) return -1;
+
+       bt->obj = marker->obj;
+       bt->count = backtrace(bt->frames, MAX_BT_FRAMES);
+
+       fr_cbuff_rp_insert(marker->cbuff, bt);
+
+       return 0;
+}
+
 /** Inserts a backtrace marker into the provided context
  *
  * Allows for maximum laziness and will initialise a circular buffer if one has not already been created.
@@ -180,7 +172,7 @@ void backtrace_print(fr_cbuff_t *cbuff, void *obj)
  * Code augmentation should look something like:
 @verbatim
        // Create a static cbuffer pointer, the first call to backtrace_attach will initialise it
-       static fr_cbuff *my_obj_bt;
+       static fr_cbuff_t *my_obj_bt;
 
        my_obj_t *alloc_my_obj(TALLOC_CTX *ctx) {
                my_obj_t *this;
@@ -212,12 +204,7 @@ fr_bt_marker_t *fr_backtrace_attach(fr_cbuff_t **cbuff, TALLOC_CTX *obj)
        if (*cbuff == NULL) {
                PTHREAD_MUTEX_LOCK(&fr_debug_init);
                /* Check again now we hold the mutex - eww*/
-               if (*cbuff == NULL) {
-                       TALLOC_CTX *ctx;
-
-                       ctx = fr_autofree_ctx();
-                       *cbuff = fr_cbuff_alloc(ctx, MAX_BT_CBUFF, true);
-               }
+               if (*cbuff == NULL) *cbuff = fr_cbuff_alloc(NULL, MAX_BT_CBUFF, true);
                PTHREAD_MUTEX_UNLOCK(&fr_debug_init);
        }
 
@@ -229,7 +216,12 @@ fr_bt_marker_t *fr_backtrace_attach(fr_cbuff_t **cbuff, TALLOC_CTX *obj)
        marker->obj = (void *) obj;
        marker->cbuff = *cbuff;
 
-       talloc_set_destructor(marker, _fr_do_bt);
+       fprintf(stderr, "Backtrace attached to %s %p\n", talloc_get_name(obj), obj);
+       /*
+        *      Generate the backtrace for memory allocation
+        */
+       fr_backtrace_do(marker);
+       talloc_set_destructor(marker, fr_backtrace_do);
 
        return marker;
 }
@@ -581,7 +573,6 @@ static void _fr_talloc_log(char const *msg)
 int fr_log_talloc_report(TALLOC_CTX *ctx)
 {
        FILE *log;
-       char const *null_ctx = NULL;
        int i = 0;
        int fd;
 
@@ -597,18 +588,22 @@ int fr_log_talloc_report(TALLOC_CTX *ctx)
                return -1;
        }
 
-       fprintf(log, "Current state of talloced memory:\n");
-       if (ctx) {
-               null_ctx = talloc_get_name(NULL);
-       }
-
        if (!ctx) {
-               talloc_report_full(NULL, log);
-       } else do {
-               fprintf(log, "Context level %i", i++);
-
-               talloc_report_full(ctx, log);
-       } while ((ctx = talloc_parent(ctx)) && (talloc_get_name(ctx) != null_ctx));  /* Stop before we hit NULL ctx */
+               fprintf(log, "Current state of talloced memory:\n");
+               talloc_report_full(talloc_null_ctx, log);
+       } else {
+               fprintf(log, "Talloc chunk lineage:\n");
+               fprintf(log, "%p (%s)", ctx, talloc_get_name(ctx));
+               while ((ctx = talloc_parent(ctx))) fprintf(log, " < %p (%s)", ctx, talloc_get_name(ctx));
+               fprintf(log, "\n");
+
+               do {
+                       fprintf(log, "Talloc context level %i:\n", i++);
+                       talloc_report_full(ctx, log);
+               } while ((ctx = talloc_parent(ctx)) &&
+                        (talloc_parent(ctx) != talloc_autofree_ctx) && /* Stop before we hit the autofree ctx */
+                        (talloc_parent(ctx) != talloc_null_ctx));      /* Stop before we hit NULL ctx */
+       }
 
        fclose(log);
 
@@ -711,27 +706,30 @@ int fr_fault_setup(char const *cmd, char const *program)
 
                /*
                 *  Needed for memory reports
-                *
-                *  Disable null tracking on exit, else valgrind complains
                 */
                {
-                       TALLOC_CTX *autofree;
+                       TALLOC_CTX *tmp;
                        bool *marker;
 
-                       talloc_enable_null_tracking();
+                       tmp = talloc(NULL, bool);
+                       talloc_null_ctx = talloc_parent(tmp);
+                       talloc_free(tmp);
 
-                       autofree = talloc_autofree_context();
-                       marker = talloc(autofree, bool);
+                       /*
+                        *  Disable null tracking on exit, else valgrind complains
+                        */
+                       talloc_autofree_ctx = talloc_autofree_context();
+                       marker = talloc(talloc_autofree_ctx, bool);
                        talloc_set_destructor(marker, _fr_disable_null_tracking);
                }
 
+#if defined(HAVE_MALLOPT) && !defined(NDEBUG)
                /*
                 *  If were using glibc malloc > 2.4 this scribbles over
                 *  uninitialised and freed memory, to make memory issues easier
                 *  to track down.
                 */
-#if defined(HAVE_MALLOPT) && !defined(NDEBUG)
-               mallopt(M_PERTURB, 0x42);
+               if (!getenv("TALLOC_FREE_FILL")) mallopt(M_PERTURB, 0x42);
                mallopt(M_CHECK_ACTION, 3);
 #endif
 
@@ -804,8 +802,14 @@ void fr_fault_set_log_fd(int fd)
 /*
  *     Verify a VALUE_PAIR
  */
-inline void fr_verify_vp(VALUE_PAIR const *vp)
+inline void fr_verify_vp(char const *file, int line, VALUE_PAIR const *vp)
 {
+       if (!vp) {
+               fprintf(stderr, "CONSISTENCY CHECK FAILED %s[%u]: VALUE_PAIR pointer was NULL", file, line);
+               fr_assert(0);
+               fr_exit_now(0);
+       }
+
        (void) talloc_get_type_abort(vp, VALUE_PAIR);
 
        if (vp->data.ptr) switch (vp->da->type) {
@@ -813,15 +817,28 @@ inline void fr_verify_vp(VALUE_PAIR const *vp)
        case PW_TYPE_TLV:
        {
                size_t len;
+               TALLOC_CTX *parent;
 
                if (!talloc_get_type(vp->data.ptr, uint8_t)) {
-                       fr_perror("Type check failed for attribute \"%s\"", vp->da->name);
+                       fprintf(stderr, "CONSISTENCY CHECK FAILED %s[%u]: VALUE_PAIR \"%s\" data buffer type should be "
+                               "uint8_t but is %s\n", file, line, vp->da->name, talloc_get_name(vp->data.ptr));
                        (void) talloc_get_type_abort(vp->data.ptr, uint8_t);
                }
 
                len = talloc_array_length(vp->vp_octets);
                if (vp->length > len) {
-                       fr_perror("VALUE_PAIR length %zu does not equal uint8_t buffer length %zu", vp->length, len);
+                       fprintf(stderr, "CONSISTENCY CHECK FAILED %s[%u]: VALUE_PAIR \"%s\" length %zu is greater than "
+                               "uint8_t data buffer length %zu\n", file, line, vp->da->name, vp->length, len);
+                       fr_assert(0);
+                       fr_exit_now(1);
+               }
+
+               parent = talloc_parent(vp->data.ptr);
+               if (parent != vp) {
+                       fprintf(stderr, "CONSISTENCY CHECK FAILED %s[%u]: VALUE_PAIR \"%s\" char buffer is not "
+                               "parented by VALUE_PAIR %p, instead parented by %p (%s)\n",
+                               file, line, vp->da->name,
+                               vp, parent, parent ? talloc_get_name(parent) : "NULL");
                        fr_assert(0);
                        fr_exit_now(1);
                }
@@ -831,21 +848,35 @@ inline void fr_verify_vp(VALUE_PAIR const *vp)
        case PW_TYPE_STRING:
        {
                size_t len;
+               TALLOC_CTX *parent;
 
                if (!talloc_get_type(vp->data.ptr, char)) {
-                       fr_perror("Type check failed for attribute \"%s\"", vp->da->name);
+                       fprintf(stderr, "CONSISTENCY CHECK FAILED %s[%u]: VALUE_PAIR \"%s\" data buffer type should be "
+                               "char but is %s\n", file, line, vp->da->name, talloc_get_name(vp->data.ptr));
                        (void) talloc_get_type_abort(vp->data.ptr, char);
                }
 
                len = (talloc_array_length(vp->vp_strvalue) - 1);
                if (vp->length > len) {
-                       fr_perror("VALUE_PAIR %s length %zu is too small for char buffer length %zu",
-                                 vp->da->name, vp->length, len);
+                       fprintf(stderr, "CONSISTENCY CHECK FAILED %s[%u]: VALUE_PAIR \"%s\" length %zu is greater than "
+                               "char buffer length %zu\n", file, line, vp->da->name, vp->length, len);
                        fr_assert(0);
                        fr_exit_now(1);
                }
+
                if (vp->vp_strvalue[vp->length] != '\0') {
-                       fr_perror("VALUE_PAIR %s buffer not \\0 terminated", vp->da->name);
+                       fprintf(stderr, "CONSISTENCY CHECK FAILED %s[%u]: VALUE_PAIR \"%s\" char buffer not \\0 "
+                               "terminated\n", file, line, vp->da->name);
+                       fr_assert(0);
+                       fr_exit_now(1);
+               }
+
+               parent = talloc_parent(vp->data.ptr);
+               if (parent != vp) {
+                       fprintf(stderr, "CONSISTENCY CHECK FAILED %s[%u]: VALUE_PAIR \"%s\" uint8_t buffer is not "
+                               "parented by VALUE_PAIR %p, instead parented by %p (%s)\n",
+                               file, line, vp->da->name,
+                               vp, parent, parent ? talloc_get_name(parent) : "NULL");
                        fr_assert(0);
                        fr_exit_now(1);
                }
@@ -860,7 +891,7 @@ inline void fr_verify_vp(VALUE_PAIR const *vp)
 /*
  *     Verify a pair list
  */
-void fr_verify_list(TALLOC_CTX *expected, VALUE_PAIR *vps)
+void fr_verify_list(char const *file, int line, TALLOC_CTX *expected, VALUE_PAIR *vps)
 {
        vp_cursor_t cursor;
        VALUE_PAIR *vp;
@@ -873,11 +904,11 @@ void fr_verify_list(TALLOC_CTX *expected, VALUE_PAIR *vps)
 
                parent = talloc_parent(vp);
                if (expected && (parent != expected)) {
-                       fr_perror("Expected VALUE_PAIR (%s) to be parented by %p (%s), "
-                                 "but parented by %p (%s)",
-                                 vp->da->name,
-                                 expected, talloc_get_name(expected),
-                                 parent, parent ? talloc_get_name(parent) : "NULL");
+                       fprintf(stderr, "CONSISTENCY CHECK FAILED %s[%u]: Expected VALUE_PAIR \"%s\" to be parented "
+                               "by %p (%s), instead parented by %p (%s)\n",
+                               file, line, vp->da->name,
+                               expected, talloc_get_name(expected),
+                               parent, parent ? talloc_get_name(parent) : "NULL");
 
                        fr_log_talloc_report(expected);
                        if (parent) fr_log_talloc_report(parent);