CONTRIB: initiate a debugging suite to make debugging easier
The goal is to have a collection of quick-n-dirty utilities that make
debugging easier and that can easily be modified when needed. The first
utility in this series is called "flags". For a given numeric argument,
it reports the various known combinations of flags for channels, streams
and so on. This way it's easy to copy-paste values from the CLI or from
gdb and immediately know what state a stream-interface or connection is
in.
diff --git a/contrib/debug/Makefile b/contrib/debug/Makefile
new file mode 100644
index 0000000..74e7547
--- /dev/null
+++ b/contrib/debug/Makefile
@@ -0,0 +1,12 @@
+INCLUDE = -I../../include -I../../ebtree
+
+CC = gcc
+OPTIMIZE = -O2
+DEFINE =
+OBJS = flags
+
+flags: flags.c
+ $(CC) $(OPTIMIZE) $(DEFINE) $(INCLUDE) -o $@ $^
+
+clean:
+ rm -f $(OBJS) *.[oas] *~
diff --git a/contrib/debug/flags.c b/contrib/debug/flags.c
new file mode 100644
index 0000000..3ad462f
--- /dev/null
+++ b/contrib/debug/flags.c
@@ -0,0 +1,366 @@
+#include <stdio.h>
+#include <stdlib.h>
+
+#include <types/channel.h>
+#include <types/connection.h>
+#include <types/proto_http.h>
+#include <types/stream.h>
+#include <types/stream_interface.h>
+#include <types/task.h>
+
+#define SHOW_FLAG(f,n) \
+ do { \
+ if (!((f) & (n))) break; \
+ (f) &= ~(n); \
+ printf(#n"%s", (f) ? " | " : ""); \
+ } while (0)
+
+void show_chn_ana(unsigned int f)
+{
+ printf("chn->ana = ");
+
+ if (!f) {
+ printf("0\n");
+ return;
+ }
+
+ SHOW_FLAG(f, AN_REQ_INSPECT_FE);
+ SHOW_FLAG(f, AN_REQ_WAIT_HTTP);
+ SHOW_FLAG(f, AN_REQ_HTTP_BODY);
+ SHOW_FLAG(f, AN_REQ_HTTP_PROCESS_FE);
+ SHOW_FLAG(f, AN_REQ_SWITCHING_RULES);
+ SHOW_FLAG(f, AN_REQ_INSPECT_BE);
+ SHOW_FLAG(f, AN_REQ_HTTP_PROCESS_BE);
+ SHOW_FLAG(f, AN_REQ_SRV_RULES);
+ SHOW_FLAG(f, AN_REQ_HTTP_INNER);
+ SHOW_FLAG(f, AN_REQ_HTTP_TARPIT);
+ SHOW_FLAG(f, AN_REQ_STICKING_RULES);
+ SHOW_FLAG(f, AN_REQ_PRST_RDP_COOKIE);
+ SHOW_FLAG(f, AN_REQ_HTTP_XFER_BODY);
+ SHOW_FLAG(f, AN_REQ_ALL);
+ SHOW_FLAG(f, AN_RES_INSPECT);
+ SHOW_FLAG(f, AN_RES_WAIT_HTTP);
+ SHOW_FLAG(f, AN_RES_HTTP_PROCESS_BE);
+ SHOW_FLAG(f, AN_RES_HTTP_PROCESS_FE);
+ SHOW_FLAG(f, AN_RES_STORE_RULES);
+ SHOW_FLAG(f, AN_RES_HTTP_XFER_BODY);
+
+ if (f) {
+ printf("EXTRA(0x%08x)", f);
+ }
+ putchar('\n');
+}
+
+void show_chn_flags(unsigned int f)
+{
+ printf("chn->flags = ");
+
+ if (!f) {
+ printf("0\n");
+ return;
+ }
+
+ SHOW_FLAG(f, CF_ISRESP);
+ SHOW_FLAG(f, CF_WAKE_ONCE);
+ SHOW_FLAG(f, CF_NEVER_WAIT);
+ SHOW_FLAG(f, CF_SEND_DONTWAIT);
+ SHOW_FLAG(f, CF_EXPECT_MORE);
+ SHOW_FLAG(f, CF_DONT_READ);
+ SHOW_FLAG(f, CF_AUTO_CONNECT);
+ SHOW_FLAG(f, CF_READ_DONTWAIT);
+ SHOW_FLAG(f, CF_KERN_SPLICING);
+ SHOW_FLAG(f, CF_READ_ATTACHED);
+ SHOW_FLAG(f, CF_ANA_TIMEOUT);
+ SHOW_FLAG(f, CF_WROTE_DATA);
+ SHOW_FLAG(f, CF_STREAMER_FAST);
+ SHOW_FLAG(f, CF_STREAMER);
+ SHOW_FLAG(f, CF_AUTO_CLOSE);
+ SHOW_FLAG(f, CF_SHUTW_NOW);
+ SHOW_FLAG(f, CF_SHUTW);
+ SHOW_FLAG(f, CF_WAKE_WRITE);
+ SHOW_FLAG(f, CF_WRITE_ERROR);
+ SHOW_FLAG(f, CF_WRITE_TIMEOUT);
+ SHOW_FLAG(f, CF_WRITE_PARTIAL);
+ SHOW_FLAG(f, CF_WRITE_NULL);
+ SHOW_FLAG(f, CF_READ_NOEXP);
+ SHOW_FLAG(f, CF_SHUTR_NOW);
+ SHOW_FLAG(f, CF_SHUTR);
+ SHOW_FLAG(f, CF_WAKE_CONNECT);
+ SHOW_FLAG(f, CF_READ_ERROR);
+ SHOW_FLAG(f, CF_READ_TIMEOUT);
+ SHOW_FLAG(f, CF_READ_PARTIAL);
+ SHOW_FLAG(f, CF_READ_NULL);
+
+ if (f) {
+ printf("EXTRA(0x%08x)", f);
+ }
+ putchar('\n');
+}
+
+void show_conn_flags(unsigned int f)
+{
+ printf("conn->flags = ");
+ if (!f) {
+ printf("0\n");
+ return;
+ }
+
+ SHOW_FLAG(f, CO_FL_XPRT_TRACKED);
+ SHOW_FLAG(f, CO_FL_PRIVATE);
+ SHOW_FLAG(f, CO_FL_ACCEPT_PROXY);
+ SHOW_FLAG(f, CO_FL_SSL_WAIT_HS);
+ SHOW_FLAG(f, CO_FL_SEND_PROXY);
+ SHOW_FLAG(f, CO_FL_WAIT_L6_CONN);
+ SHOW_FLAG(f, CO_FL_WAIT_L4_CONN);
+ SHOW_FLAG(f, CO_FL_CONNECTED);
+ SHOW_FLAG(f, CO_FL_ERROR);
+ SHOW_FLAG(f, CO_FL_SOCK_WR_SH);
+ SHOW_FLAG(f, CO_FL_SOCK_RD_SH);
+ SHOW_FLAG(f, CO_FL_DATA_WR_SH);
+ SHOW_FLAG(f, CO_FL_DATA_RD_SH);
+ SHOW_FLAG(f, CO_FL_WAKE_DATA);
+ SHOW_FLAG(f, CO_FL_INIT_DATA);
+ SHOW_FLAG(f, CO_FL_ADDR_TO_SET);
+ SHOW_FLAG(f, CO_FL_ADDR_FROM_SET);
+ SHOW_FLAG(f, CO_FL_WAIT_ROOM);
+ SHOW_FLAG(f, CO_FL_WAIT_DATA);
+ SHOW_FLAG(f, CO_FL_XPRT_READY);
+ SHOW_FLAG(f, CO_FL_CTRL_READY);
+ SHOW_FLAG(f, CO_FL_CURR_WR_ENA);
+ SHOW_FLAG(f, CO_FL_DATA_WR_ENA);
+ SHOW_FLAG(f, CO_FL_SOCK_WR_ENA);
+ SHOW_FLAG(f, CO_FL_CURR_RD_ENA);
+ SHOW_FLAG(f, CO_FL_DATA_RD_ENA);
+ SHOW_FLAG(f, CO_FL_SOCK_RD_ENA);
+
+ if (f) {
+ printf("EXTRA(0x%08x)", f);
+ }
+ putchar('\n');
+}
+
+void show_si_et(unsigned int f)
+{
+ printf("si->et = ");
+ if (!f) {
+ printf("SI_ET_NONE\n");
+ return;
+ }
+
+ SHOW_FLAG(f, SI_ET_QUEUE_TO);
+ SHOW_FLAG(f, SI_ET_QUEUE_ERR);
+ SHOW_FLAG(f, SI_ET_QUEUE_ABRT);
+ SHOW_FLAG(f, SI_ET_CONN_TO);
+ SHOW_FLAG(f, SI_ET_CONN_ERR);
+ SHOW_FLAG(f, SI_ET_CONN_ABRT);
+ SHOW_FLAG(f, SI_ET_CONN_RES);
+ SHOW_FLAG(f, SI_ET_CONN_OTHER);
+ SHOW_FLAG(f, SI_ET_DATA_TO);
+ SHOW_FLAG(f, SI_ET_DATA_ERR);
+ SHOW_FLAG(f, SI_ET_DATA_ABRT);
+
+ if (f) {
+ printf("EXTRA(0x%08x)", f);
+ }
+ putchar('\n');
+}
+
+void show_si_flags(unsigned int f)
+{
+ f &= 0xFFFF;
+
+ printf("si->flags = ");
+ if (!f) {
+ printf("SI_FL_NONE\n");
+ return;
+ }
+
+ SHOW_FLAG(f, SI_FL_EXP);
+ SHOW_FLAG(f, SI_FL_ERR);
+ SHOW_FLAG(f, SI_FL_WAIT_ROOM);
+ SHOW_FLAG(f, SI_FL_WAIT_DATA);
+ SHOW_FLAG(f, SI_FL_ISBACK);
+ SHOW_FLAG(f, SI_FL_DONT_WAKE);
+ SHOW_FLAG(f, SI_FL_INDEP_STR);
+ SHOW_FLAG(f, SI_FL_NOLINGER);
+ SHOW_FLAG(f, SI_FL_NOHALF);
+ SHOW_FLAG(f, SI_FL_SRC_ADDR);
+ SHOW_FLAG(f, SI_FL_WANT_PUT);
+ SHOW_FLAG(f, SI_FL_WANT_GET);
+
+ if (f) {
+ printf("EXTRA(0x%04x)", f);
+ }
+ putchar('\n');
+}
+
+void show_task_state(unsigned int f)
+{
+ printf("task->state = ");
+
+ if (!f) {
+ printf("TASK_SLEEPING\n");
+ return;
+ }
+
+ SHOW_FLAG(f, TASK_WOKEN_OTHER);
+ SHOW_FLAG(f, TASK_WOKEN_RES);
+ SHOW_FLAG(f, TASK_WOKEN_MSG);
+ SHOW_FLAG(f, TASK_WOKEN_SIGNAL);
+ SHOW_FLAG(f, TASK_WOKEN_IO);
+ SHOW_FLAG(f, TASK_WOKEN_TIMER);
+ SHOW_FLAG(f, TASK_WOKEN_INIT);
+ SHOW_FLAG(f, TASK_RUNNING);
+
+ if (f) {
+ printf("EXTRA(0x%08x)", f);
+ }
+ putchar('\n');
+}
+
+void show_txn_flags(unsigned int f)
+{
+ printf("txn->flags = ");
+
+ if (!f) {
+ printf("0\n");
+ return;
+ }
+
+ SHOW_FLAG(f, TX_NOT_FIRST);
+ SHOW_FLAG(f, TX_USE_PX_CONN);
+ SHOW_FLAG(f, TX_HDR_CONN_KAL);
+ SHOW_FLAG(f, TX_HDR_CONN_CLO);
+ SHOW_FLAG(f, TX_HDR_CONN_PRS);
+ SHOW_FLAG(f, TX_WAIT_NEXT_RQ);
+ SHOW_FLAG(f, TX_HDR_CONN_UPG);
+ SHOW_FLAG(f, TX_PREFER_LAST);
+ SHOW_FLAG(f, TX_CON_KAL_SET);
+ SHOW_FLAG(f, TX_CON_CLO_SET);
+
+ //printf("%s", f ? "" : " | ");
+ switch (f & TX_CON_WANT_MSK) {
+ case TX_CON_WANT_KAL: /*f &= ~TX_CON_WANT_MSK ; printf("TX_CON_WANT_KAL%s", f ? " | " : "");*/ break;
+ case TX_CON_WANT_TUN: f &= ~TX_CON_WANT_MSK ; printf("TX_CON_WANT_TUN%s", f ? " | " : ""); break;
+ case TX_CON_WANT_SCL: f &= ~TX_CON_WANT_MSK ; printf("TX_CON_WANT_SCL%s", f ? " | " : ""); break;
+ case TX_CON_WANT_CLO: f &= ~TX_CON_WANT_MSK ; printf("TX_CON_WANT_CLO%s", f ? " | " : ""); break;
+ }
+
+ SHOW_FLAG(f, TX_CACHE_COOK);
+ SHOW_FLAG(f, TX_CACHEABLE);
+ SHOW_FLAG(f, TX_SCK_PRESENT);
+
+ //printf("%s", f ? "" : " | ");
+ switch (f & TX_SCK_MASK) {
+ case TX_SCK_NONE: f &= ~TX_SCK_MASK ; /*printf("TX_SCK_NONE%s", f ? " | " : "");*/ break;
+ case TX_SCK_FOUND: f &= ~TX_SCK_MASK ; printf("TX_SCK_FOUND%s", f ? " | " : ""); break;
+ case TX_SCK_DELETED: f &= ~TX_SCK_MASK ; printf("TX_SCK_DELETED%s", f ? " | " : ""); break;
+ case TX_SCK_INSERTED: f &= ~TX_SCK_MASK ; printf("TX_SCK_INSERTED%s", f ? " | " : ""); break;
+ case TX_SCK_REPLACED: f &= ~TX_SCK_MASK ; printf("TX_SCK_REPLACED%s", f ? " | " : ""); break;
+ case TX_SCK_UPDATED: f &= ~TX_SCK_MASK ; printf("TX_SCK_UPDATED%s", f ? " | " : ""); break;
+ default: printf("TX_SCK_MASK(%02x)", f); f &= ~TX_SCK_MASK ; printf("%s", f ? " | " : ""); break;
+ }
+
+ //printf("%s", f ? "" : " | ");
+ switch (f & TX_CK_MASK) {
+ case TX_CK_NONE: f &= ~TX_CK_MASK ; /*printf("TX_CK_NONE%s", f ? " | " : "");*/ break;
+ case TX_CK_INVALID: f &= ~TX_CK_MASK ; printf("TX_CK_INVALID%s", f ? " | " : ""); break;
+ case TX_CK_DOWN: f &= ~TX_CK_MASK ; printf("TX_CK_DOWN%s", f ? " | " : ""); break;
+ case TX_CK_VALID: f &= ~TX_CK_MASK ; printf("TX_CK_VALID%s", f ? " | " : ""); break;
+ case TX_CK_EXPIRED: f &= ~TX_CK_MASK ; printf("TX_CK_EXPIRED%s", f ? " | " : ""); break;
+ case TX_CK_OLD: f &= ~TX_CK_MASK ; printf("TX_CK_OLD%s", f ? " | " : ""); break;
+ case TX_CK_UNUSED: f &= ~TX_CK_MASK ; printf("TX_CK_UNUSED%s", f ? " | " : ""); break;
+ default: printf("TX_CK_MASK(%02x)", f); f &= ~TX_CK_MASK ; printf("%s", f ? " | " : ""); break;
+ }
+
+ SHOW_FLAG(f, TX_CLTARPIT);
+ SHOW_FLAG(f, TX_SVALLOW);
+ SHOW_FLAG(f, TX_SVDENY);
+ SHOW_FLAG(f, TX_CLALLOW);
+ SHOW_FLAG(f, TX_CLDENY);
+
+ if (f) {
+ printf("EXTRA(0x%08x)", f);
+ }
+ putchar('\n');
+}
+
+void show_strm_flags(unsigned int f)
+{
+ printf("strm->flags = ");
+
+ if (!f) {
+ printf("0\n");
+ return;
+ }
+
+ SHOW_FLAG(f, SF_SRV_REUSED);
+ SHOW_FLAG(f, SF_COMP_READY);
+ SHOW_FLAG(f, SF_IGNORE_PRST);
+
+ //printf("%s", f ? "" : " | ");
+ switch (f & SF_FINST_MASK) {
+ case SF_FINST_R: f &= ~SF_FINST_MASK ; printf("SF_FINST_R%s", f ? " | " : ""); break;
+ case SF_FINST_C: f &= ~SF_FINST_MASK ; printf("SF_FINST_C%s", f ? " | " : ""); break;
+ case SF_FINST_H: f &= ~SF_FINST_MASK ; printf("SF_FINST_H%s", f ? " | " : ""); break;
+ case SF_FINST_D: f &= ~SF_FINST_MASK ; printf("SF_FINST_D%s", f ? " | " : ""); break;
+ case SF_FINST_L: f &= ~SF_FINST_MASK ; printf("SF_FINST_L%s", f ? " | " : ""); break;
+ case SF_FINST_Q: f &= ~SF_FINST_MASK ; printf("SF_FINST_Q%s", f ? " | " : ""); break;
+ case SF_FINST_T: f &= ~SF_FINST_MASK ; printf("SF_FINST_T%s", f ? " | " : ""); break;
+ }
+
+ switch (f & SF_ERR_MASK) {
+ case SF_ERR_LOCAL: f &= ~SF_ERR_MASK ; printf("SF_ERR_LOCAL%s", f ? " | " : ""); break;
+ case SF_ERR_CLITO: f &= ~SF_ERR_MASK ; printf("SF_ERR_CLITO%s", f ? " | " : ""); break;
+ case SF_ERR_CLICL: f &= ~SF_ERR_MASK ; printf("SF_ERR_CLICL%s", f ? " | " : ""); break;
+ case SF_ERR_SRVTO: f &= ~SF_ERR_MASK ; printf("SF_ERR_SRVTO%s", f ? " | " : ""); break;
+ case SF_ERR_SRVCL: f &= ~SF_ERR_MASK ; printf("SF_ERR_SRVCL%s", f ? " | " : ""); break;
+ case SF_ERR_PRXCOND: f &= ~SF_ERR_MASK ; printf("SF_ERR_PRXCOND%s", f ? " | " : ""); break;
+ case SF_ERR_RESOURCE: f &= ~SF_ERR_MASK ; printf("SF_ERR_RESOURCE%s", f ? " | " : ""); break;
+ case SF_ERR_INTERNAL: f &= ~SF_ERR_MASK ; printf("SF_ERR_INTERNAL%s", f ? " | " : ""); break;
+ case SF_ERR_DOWN: f &= ~SF_ERR_MASK ; printf("SF_ERR_DOWN%s", f ? " | " : ""); break;
+ case SF_ERR_KILLED: f &= ~SF_ERR_MASK ; printf("SF_ERR_KILLED%s", f ? " | " : ""); break;
+ case SF_ERR_UP: f &= ~SF_ERR_MASK ; printf("SF_ERR_UP%s", f ? " | " : ""); break;
+ }
+
+ SHOW_FLAG(f, SF_TUNNEL);
+ SHOW_FLAG(f, SF_REDIRECTABLE);
+ SHOW_FLAG(f, SF_CONN_TAR);
+ SHOW_FLAG(f, SF_REDISP);
+ SHOW_FLAG(f, SF_INITIALIZED);
+ SHOW_FLAG(f, SF_CURR_SESS);
+ SHOW_FLAG(f, SF_MONITOR);
+ SHOW_FLAG(f, SF_FORCE_PRST);
+ SHOW_FLAG(f, SF_BE_ASSIGNED);
+ SHOW_FLAG(f, SF_ADDR_SET);
+ SHOW_FLAG(f, SF_ASSIGNED);
+ SHOW_FLAG(f, SF_DIRECT);
+
+ if (f) {
+ printf("EXTRA(0x%08x)", f);
+ }
+ putchar('\n');
+}
+
+int main(int argc, char **argv)
+{
+ unsigned int flags;
+
+ if (argc < 2) {
+ fprintf(stderr, "Usage: %s 0x<flags|state>\n", argv[0]);
+ exit(1);
+ }
+
+ flags = strtoul(argv[1], NULL, 0);
+
+ show_task_state(flags);
+ show_txn_flags(flags);
+ show_strm_flags(flags);
+ show_si_et(flags);
+ show_si_flags(flags);
+ show_conn_flags(flags);
+ show_chn_flags(flags);
+ show_chn_ana(flags);
+
+ return 0;
+}