[tor-commits] [tor/maint-0.3.2] sched: Implement SCHED_BUG()

[nickm at torproject.org]

commit 2e8de0de3b5ae10277cd0fd72e782d2f6aa30c81
Author: David Goulet <dgoulet at torproject.org>
Date:   Tue Oct 3 13:58:22 2017 -0400

    sched: Implement SCHED_BUG()
    
    Signed-off-by: David Goulet <dgoulet at torproject.org>
---
 src/or/scheduler.c | 29 +++++++++++++++++++++++++++++
 src/or/scheduler.h |  8 ++++++++
 2 files changed, 37 insertions(+)

diff --git a/src/or/scheduler.c b/src/or/scheduler.c
index 22a9b574a..c656c80e9 100644
--- a/src/or/scheduler.c
+++ b/src/or/scheduler.c
@@ -9,6 +9,9 @@
 #define SCHEDULER_KIST_PRIVATE
 #include "scheduler.h"
 #include "main.h"
+#include "buffers.h"
+#define TOR_CHANNEL_INTERNAL_
+#include "channeltls.h"
 
 #include <event2/event.h>
 
@@ -667,6 +670,32 @@ scheduler_channel_wants_writes(channel_t *chan)
   }
 }
 
+/* Log warn the given channel and extra scheduler context as well. This is
+ * used by SCHED_BUG() in order to be able to extract as much information as
+ * we can when we hit a bug. Channel chan can be NULL. */
+void
+scheduler_bug_occurred(const channel_t *chan)
+{
+  char buf[128];
+
+  if (chan != NULL) {
+    const size_t outbuf_len =
+      buf_datalen(TO_CONN(BASE_CHAN_TO_TLS((channel_t *) chan)->conn)->outbuf);
+    tor_snprintf(buf, sizeof(buf),
+                 "Channel %" PRIu64 " in state %s and scheduler state %d."
+                 " Num cells on cmux: %d. Connection outbuf len: %lu.",
+                 chan->global_identifier,
+                 channel_state_to_string(chan->state),
+                 chan->scheduler_state, circuitmux_num_cells(chan->cmux),
+                 outbuf_len);
+  }
+
+  log_warn(LD_BUG, "%s Num pending channels: %d. Channel in pending list: %s",
+           (chan != NULL) ? buf : "No channel in bug context.",
+           smartlist_len(channels_pending),
+           (smartlist_pos(channels_pending, chan) == -1) ? "no" : "yes");
+}
+
 #ifdef TOR_UNIT_TESTS
 
 /*
diff --git a/src/or/scheduler.h b/src/or/scheduler.h
index 0ec24db93..47c98f096 100644
--- a/src/or/scheduler.h
+++ b/src/or/scheduler.h
@@ -143,6 +143,14 @@ MOCK_DECL(void, scheduler_channel_has_waiting_cells, (channel_t *chan));
 /*********************************
  * Defined in scheduler.c
  *********************************/
+
+/* Triggers a BUG() and extra information with chan if available. */
+#define SCHED_BUG(cond, chan) \
+  (PREDICT_UNLIKELY(cond) ? \
+   ((BUG(cond)) ? (scheduler_bug_occurred(chan), 1) : 0) : 0)
+
+void scheduler_bug_occurred(const channel_t *chan);
+
 smartlist_t *get_channels_pending(void);
 MOCK_DECL(int, scheduler_compare_channels,
           (const void *c1_v, const void *c2_v));