typo + state dumping

Signed-off-by: Mattias Andrée <maandree@kth.se>

9 files changed, 318 insertions, 15 deletions

diff --git a/README b/README
index 2e412ec..3954901 100644
--- a/README
+++ b/README
@@ -78,6 +78,10 @@ SIGNALS
 	SIGUSR1
 		Reexecute the process to an updated version.
 
+	SIGUSR2
+	SIGINFO if available
+		Dump the process state to standard error.
+
 	SIGRTMIN+0
 		Disconnect from the display server or
 		graphics card.
diff --git a/doc/coopgammad.1 b/doc/coopgammad.1
index 54ca6f6..71bf4da 100644
--- a/doc/coopgammad.1
+++ b/doc/coopgammad.1
@@ -93,6 +93,9 @@ for local display 0 when using
 .B SIGUSR1
 Reexecute the process to an updated version.
 .TP
+.BR SIGUSR2 ", " SIGINFO " if available"
+Dump the process state to standard error.
+.TP
 .B SIGRTMIN+0
 Disconnect from the display server or graphics
 card.
diff --git a/src/coopgammad.c b/src/coopgammad.c
index 6875849..e81840e 100644
--- a/src/coopgammad.c
+++ b/src/coopgammad.c
@@ -153,6 +153,26 @@ static void sig_connection(int signo)
 }
 
 
+/**
+ * Called when the process receives
+ * a signal telling it to dump its
+ * state to stderr
+ * 
+ * @param  signo  The received signal
+ */
+static void sig_info(int signo)
+{
+  int saved_errno = errno;
+  char* env;
+  signal(signo, sig_info);
+  env = getenv("COOPGAMMAD_PIDFILE_TOKEN");
+  fprintf(stderr, "PID file token: %s\n", env ? env : "(null)");
+  fprintf(stderr, "PID file: %s\n", pidpath ? pidpath : "(null)");
+  fprintf(stderr, "Socket path: %s\n", socketpath ? socketpath : "(null)");
+  state_dump();
+  errno = saved_errno;
+}
+
 
 /**
  * Parse adjustment method name (or stringised number)
@@ -196,6 +216,10 @@ static int get_method(const char* restrict arg)
 static int set_up_signals(void)
 {
   if ((signal(SIGUSR1,      sig_reexec)     == SIG_ERR) ||
+      (signal(SIGUSR2,      sig_info)       == SIG_ERR) ||
+#if defined(SIGINFO)
+      (signal(SIGINFO,      sig_info)       == SIG_ERR) ||
+#endif
       (signal(SIGTERM,      sig_terminate)  == SIG_ERR) ||
       (signal(SIGRTMIN + 0, sig_connection) == SIG_ERR) ||
       (signal(SIGRTMIN + 1, sig_connection) == SIG_ERR))
@@ -740,6 +764,8 @@ static void usage(void)
  * The process closes stdout when the socket has been created
  * 
  * @signal  SIGUSR1     Re-execute to updated process image
+ * @signal  SIGUSR2     Dump the state of the process to standard error
+ * @signal  SIGINFO     Ditto
  * @signal  SIGTERM     Terminate the process gracefully
  * @signal  SIGRTMIN+0  Disconnect from the site
  * @signal  SiGRTMIN+1  Reconnect to the site
diff --git a/src/servers/coopgamma.c b/src/servers/coopgamma.c
index 26b000d..4e126cf 100644
--- a/src/servers/coopgamma.c
+++ b/src/servers/coopgamma.c
@@ -188,6 +188,10 @@ static ssize_t add_filter(struct output* restrict out, struct filter* restrict f
   memmove(out->table_sums    + i + 1, out->table_sums    + i, (n - i) * sizeof(*(out->table_sums)));
   out->table_size++;
   
+  out->table_filters[i] = *filter;
+  filter->class = NULL;
+  filter->ramps = NULL;
+  
   COPY_RAMP_SIZES(&(out->table_sums[i].u8), out);
   switch (out->depth)
     {
@@ -203,10 +207,6 @@ static ssize_t add_filter(struct output* restrict out, struct filter* restrict f
   if (r < 0)
     return -1;
   
-  out->table_filters[i] = *filter;
-  filter->class = NULL;
-  filter->ramps = NULL;
-  
   return (ssize_t)i;
 }
 
diff --git a/src/servers/master.c b/src/servers/master.c
index acd0f6b..01b9bb5 100644
--- a/src/servers/master.c
+++ b/src/servers/master.c
@@ -128,7 +128,7 @@ static int dispatch_message(size_t conn, struct message* restrict msg)
  * 
  * @param   fds        Reference parameter for the array of file descriptors
  * @param   fdn        Output parameter for the number of file descriptors
- * @parma   fds_alloc  Reference parameter for the allocation size of `fds`, in elements
+ * @param   fds_alloc  Reference parameter for the allocation size of `fds`, in elements
  * @return             Zero on success, -1 on error
  */
 static int update_fdset(struct pollfd** restrict fds, nfds_t* restrict fdn, nfds_t* restrict fds_alloc)
diff --git a/src/state.c b/src/state.c
index a9b4b2e..ff4f0e9 100644
--- a/src/state.c
+++ b/src/state.c
@@ -18,6 +18,8 @@
 #include "state.h"
 #include "util.h"
 
+#include <inttypes.h>
+#include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
@@ -64,7 +66,7 @@ volatile sig_atomic_t terminate = 0; /* do not marshal */
 /**
  * Has the process receive a to
  * disconnect from or reconnect to
- * the site? 1 if disconnct, 2 if
+ * the site? 1 if disconnect, 2 if
  * reconnect, 0 otherwise.
  */
 volatile sig_atomic_t connection = 0;
@@ -142,6 +144,269 @@ int preserve = 0;
 
 
 /**
+ * As part of a state dump, dump one or two gamma ramp-trios
+ * 
+ * @param  left        The left ramps
+ * @param  right       The right ramps
+ * @param  depth       The gamma ramp type/depth
+ * @param  have_right  Print right ramps?
+ * @param  indent      Print indent
+ */
+static void ramps_dump(union gamma_ramps* left, union gamma_ramps* right,
+		       signed depth, int have_right, const char* indent)
+{
+#define STRINGISE(SIDE, CH, N, BUF)							\
+  do											\
+    if ((SIDE == NULL) || (SIDE->u8.CH == NULL))					\
+      strcpy(BUF, "null");								\
+    else if (i < N)									\
+      switch (depth)									\
+	{										\
+	case -2:  snprintf(BUF, sizeof(BUF), "%lf",        SIDE->d.CH[i]);    break;	\
+	case -1:  snprintf(BUF, sizeof(BUF), "%f", (double)(SIDE->f.CH[i]));  break;	\
+	case  8:  snprintf(BUF, sizeof(BUF), "%02" PRIx8,  SIDE->u8.CH[i]);   break;	\
+	case 16:  snprintf(BUF, sizeof(BUF), "%04" PRIx16, SIDE->u16.CH[i]);  break;	\
+	case 32:  snprintf(BUF, sizeof(BUF), "%08" PRIx32, SIDE->u32.CH[i]);  break;	\
+	case 64:  snprintf(BUF, sizeof(BUF), "%16" PRIx64, SIDE->u64.CH[i]);  break;	\
+	default:									\
+	  strcpy(BUF, "corrupt state");							\
+	  break;									\
+	}										\
+  while (0)
+  
+  char lr[100], lg[100], lb[100], rr[100], rg[100], rb[100];
+  size_t rn = left ? left->u8.red_size   : right ? right->u8.red_size   : 0;
+  size_t gn = left ? left->u8.green_size : right ? right->u8.green_size : 0;
+  size_t bn = left ? left->u8.blue_size  : right ? right->u8.blue_size  : 0;
+  size_t i, n = rn > gn ? rn : gn;
+  n = n > bn ? n : bn;
+  
+  for (i = 0; i < n; i++)
+    {
+      *lr = *lg = *lb = *rr = *rg = *rb = '\0';
+      
+      STRINGISE(left, red,   rn, lr);
+      STRINGISE(left, green, gn, lg);
+      STRINGISE(left, blue,  bn, lb);
+      
+      if (have_right)
+	{
+	  STRINGISE(right, red,   rn, rr);
+	  STRINGISE(right, green, gn, rg);
+	  STRINGISE(right, blue,  bn, rb);
+	}
+      
+      if (have_right)
+	fprintf(stderr, "%s%zu: %s, %s, %s :: %s, %s, %s\n", indent, i, lr, lg, lb, rr, rg, rb);
+      else
+	fprintf(stderr, "%s%zu: %s, %s, %s\n", indent, i, lr, lg, lb);
+    }
+}
+
+
+/**
+ * Dump the state to stderr
+ */
+void state_dump(void)
+{
+  size_t i, j;
+  fprintf(stderr, "argv0: %s\n", argv0 ? argv0 : "(null)");
+  fprintf(stderr, "Realpath of argv0: %s\n", argv0_real ? argv0_real : "(null)");
+  fprintf(stderr, "Calibrations preserved: %s\n", preserve ? "yes" : "no");
+  fprintf(stderr, "Connected: %s\n", connected ? "yes" : "no");
+  fprintf(stderr, "Socket FD: %i\n", socketfd);
+  fprintf(stderr, "Re-execution pending: %s\n", reexec ? "yes" : "no");
+  fprintf(stderr, "Termination pending: %s\n", terminate ? "yes" : "no");
+  if ((0 <= connection) && (connection <= 2))
+    fprintf(stderr, "Pending connection change: %s\n",
+	    connection == 0 ? "none" : connection == 1 ? "disconnect" : "reconnect");
+  else
+    fprintf(stderr, "Pending connection change: %i (CORRUPT STATE)\n", connection);
+  fprintf(stderr, "Adjustment method: %i\n", method);
+  fprintf(stderr, "Site name: %s\n", sitename ? sitename : "(automatic)");
+  fprintf(stderr, "Clients:\n");
+  fprintf(stderr, "  Next empty slot: %zu\n", connections_ptr);
+  fprintf(stderr, "  Initialised slots: %zu\n", connections_used);
+  fprintf(stderr, "  Allocated slots: %zu\n", connections_alloc);
+  if (connections == NULL)
+    fprintf(stderr, "  File descriptor array is null\n");
+  else
+    for (i = 0; i < connections_used; i++)
+      {
+	if (connections[i] < 0)
+	  {
+	    fprintf(stderr, "  Slot %zu: empty\n", i);
+	    continue;
+	  }
+	fprintf(stderr, "  Slot %zu:\n", i);
+	fprintf(stderr, "    File descriptor: %i\n", connections[i]);
+	if (inbound == NULL)
+	  fprintf(stderr, "    Inbound message array is null\n");
+	else
+	  {
+	    fprintf(stderr, "    Inbound message:\n");
+	    fprintf(stderr, "      Header array: %s\n", inbound[i].headers ? "non-null" : "null");
+	    fprintf(stderr, "      Headers: %zu\n", inbound[i].header_count);
+	    fprintf(stderr, "      Payload buffer: %s\n", inbound[i].payload ? "non-null" : "null");
+	    fprintf(stderr, "      Payload size: %zu\n", inbound[i].payload_size);
+	    fprintf(stderr, "      Payload write pointer: %zu\n", inbound[i].payload_ptr);
+	    fprintf(stderr, "      Message buffer: %s\n", inbound[i].buffer ? "non-null" : "null");
+	    fprintf(stderr, "      Message buffer size: %zu\n", inbound[i].buffer_size);
+	    fprintf(stderr, "      Message buffer write pointer: %zu\n", inbound[i].buffer_ptr);
+	    fprintf(stderr, "      Read stage: %i\n", inbound[i].stage);
+	  }
+	if (outbound == NULL)
+	  fprintf(stderr, "    Outbound message array is null\n");
+	else
+	  {
+	    fprintf(stderr, "      Ring buffer: %s\n", outbound[i].buffer ? "non-null" : "null");
+	    fprintf(stderr, "      Head: %zu\n", outbound[i].end);
+	    fprintf(stderr, "      Tail: %zu\n", outbound[i].start);
+	    fprintf(stderr, "      Size: %zu\n", outbound[i].size);
+	  }
+      }
+  fprintf(stderr, "Partition array: %s\n", partitions ? "non-null" : "null");
+  fprintf(stderr, "CRTC array: %s\n", crtcs ? "non-null" : "null");
+  fprintf(stderr, "Output:\n");
+  fprintf(stderr, "  Output count: %zu\n", outputs_n);
+  if (outputs == NULL)
+    fprintf(stderr, "  Output array is null\n");
+  else
+    for (i = 0; i < outputs_n; i++)
+      {
+	struct output* restrict out = outputs + i;
+	const char* str;
+	fprintf(stderr, "  Output %zu:\n", i);
+	fprintf(stderr, "    Depth: %i (%s)\n", out->depth,
+		out->depth == -1 ? "float" :
+		out->depth == -2 ? "double" :
+		out->depth ==  8 ? "uint8_t" :
+		out->depth == 16 ? "uint16_t" :
+		out->depth == 32 ? "uint32_t" :
+		out->depth == 64 ? "uint64_t" : "CORRUPT STATE");
+	fprintf(stderr, "    Gamma supported: %s (%i)\n",
+		out->supported == LIBGAMMA_YES ? "yes" :
+		out->supported == LIBGAMMA_NO ? "no" :
+		out->supported == LIBGAMMA_MAYBE ? "maybe" :
+		"CORRUPT STATE", out->supported);
+	fprintf(stderr, "    Name is EDID: %s\n", out->name_is_edid ? "yes" : "no");
+	switch (out->colourspace)
+	  {
+	  case COLOURSPACE_UNKNOWN:          str = "unknown";                                      break;
+	  case COLOURSPACE_SRGB:             str = "sRGB with explicit gamut";                     break;
+	  case COLOURSPACE_SRGB_SANS_GAMUT:  str = "sRGB with implicit gamut (actually illegal)";  break;
+	  case COLOURSPACE_RGB:              str = "RGB other than sRGB, with unknown gamut";      break;
+	  case COLOURSPACE_RGB_SANS_GAMUT:   str = "RGB other than sRGB, with listed gamut";       break;
+	  case COLOURSPACE_NON_RGB:          str = "Non-RGB multicolour";                          break;
+	  case COLOURSPACE_GREY:             str = "Monochrome or singlecolour scale";             break;
+	  default:                           str = "CORRUPT STATE";                                break;
+	  }
+	fprintf(stderr, "    Colourspace: %s (%i)\n", str, out->colourspace);
+	if ((out->colourspace == COLOURSPACE_SRGB) || (out->colourspace == COLOURSPACE_RGB))
+	  {
+	    fprintf(stderr, "      Red (x, y): (%u / 1024, %u / 1024)\n", out->red_x, out->red_y);
+	    fprintf(stderr, "      Green (x, y): (%u / 1024, %u / 1024)\n", out->green_x, out->green_y);
+	    fprintf(stderr, "      Blue (x, y): (%u / 1024, %u / 1024)\n", out->blue_x, out->blue_y);
+	    fprintf(stderr, "      White (x, y): (%u / 1024, %u / 1024)\n", out->white_x, out->white_y);
+	    if (out->colourspace == COLOURSPACE_SRGB)
+	      {
+		fprintf(stderr, "      Expected red (x, y): (655 / 1024, 338 / 1024)\n");
+		fprintf(stderr, "      Expected green (x, y): (307 / 1024, 614 / 1024)\n");
+		fprintf(stderr, "      Expected blue (x, y): (154 / 1024, 61 / 1024)\n");
+		fprintf(stderr, "      Expected white (x, y): (320 / 1024, 337 / 1024)\n");
+	      }
+	  }
+	if (out->supported)
+	  {
+	    fprintf(stderr, "    Gamma ramp size:\n");
+	    fprintf(stderr, "      Red: %zu stops\n", out->red_size);
+	    fprintf(stderr, "      Green: %zu stops\n", out->green_size);
+	    fprintf(stderr, "      Blue: %zu stops\n", out->blue_size);
+	    fprintf(stderr, "      Total: %zu bytes\n", out->ramps_size);
+	    fprintf(stderr, "    Name: %s\n", out->name ? out->name : "(null)");
+	    fprintf(stderr, "    CRTC state: %s\n", out->crtc ? "non-null" : "null");
+	    fprintf(stderr, "    Saved gamma ramps (stop: red, green, blue):\n");
+	    ramps_dump(&(out->saved_ramps), NULL, out->depth, 0, "      ");
+	    fprintf(stderr, "    Filter table:\n");
+	    fprintf(stderr, "      Filter count: %zu\n", out->table_size);
+	    fprintf(stderr, "      Slots allocated: %zu\n", out->table_alloc);
+	    if (out->table_size > 0)
+	      {
+		if (out->table_filters == NULL)
+		  fprintf(stderr, "      Filter table is null\n");
+		if (out->table_sums == NULL)
+		  fprintf(stderr, "      Result table is null\n");
+	      }
+	    for (j = 0; j < out->table_size; j++)
+	      {
+		struct filter* restrict filter = out->table_filters ? out->table_filters + j : NULL;
+		fprintf(stderr, "      Filter %zu:\n", j);
+		if (filter != NULL)
+		  {
+		    if (filter->lifespan == LIFESPAN_UNTIL_DEATH)
+		      fprintf(stderr, "        Client FD: %i\n", filter->client);
+		    switch (filter->lifespan)
+		      {
+		      case LIFESPAN_REMOVE:         str = "remove (ILLEGAL STATE)";  break;
+		      case LIFESPAN_UNTIL_REMOVAL:  str = "until-removal";           break;
+		      case LIFESPAN_UNTIL_DEATH:    str = "until-death";             break;
+		      default:                      str = "CORRUPT STATE";           break;
+		      }
+		    fprintf(stderr, "        Lifespan: %s (%i)\n", str, filter->lifespan);
+		    fprintf(stderr, "        Priority: %"PRIi64"\n", filter->priority);
+		    fprintf(stderr, "        Class: %s\n", filter->class ? filter->class : "(null)");
+		    str = "yes";
+		    if (filter->class == NULL)
+		      str = "no, is NULL";
+		    else if (strchr(filter->class, '\n'))
+		      str = "no, contains LF";
+		    else if (strstr(filter->class, "::") == NULL)
+		      str = "no, does not contain \"::\"";
+		    else if (strstr(strstr(filter->class, "::") + 2, "::") == NULL)
+		      str = "no, contains only one \"::\"";
+		    else if (verify_utf8(filter->class) < 0)
+		      str = "no, not UTF-8";
+		    fprintf(stderr, "        Class legal: %s\n", str);
+		    if ((filter->ramps == NULL) && (filter->lifespan != LIFESPAN_REMOVE))
+		      fprintf(stderr, "        Ramps are NULL\n");
+		  }
+		if (filter != NULL ? (filter->lifespan != LIFESPAN_REMOVE) : (out->table_sums != NULL))
+		  {
+		    union gamma_ramps left;
+		    size_t depth;
+		    switch (out->depth)
+		      {
+		      case -2:  depth = sizeof(double);  break;
+		      case -1:  depth = sizeof(float);   break;
+		      case 8: case 16: case 32: case 64:
+			depth = (size_t)(out->depth) / 8;
+			break;
+		      default:
+			goto corrupt_depth;
+		      }
+		    if (filter && filter->ramps)
+		      {
+			left.u8.red_size   = out->red_size;
+			left.u8.green_size = out->green_size;
+			left.u8.blue_size  = out->blue_size;
+			left.u8.red   = filter->ramps;
+			left.u8.green = left.u8.red + out->red_size * depth;
+			left.u8.blue  = left.u8.green + out->green_size * depth;
+		      }
+		    fprintf(stderr,"        Ramps (stop: filter red, green, blue :: "
+			    "composite red, geen, blue):\n");
+		    ramps_dump((filter && filter->ramps) ? &left : NULL,
+			       out->table_sums ? out->table_sums + j : NULL,
+			       out->depth, 1, "          ");
+		  corrupt_depth:;
+		  }
+	      }
+	  }
+      }
+}
+
+
+/**
  * Destroy the state
  */
 void state_destroy(void)
diff --git a/src/state.h b/src/state.h
index 32a6cb1..1cbe482 100644
--- a/src/state.h
+++ b/src/state.h
@@ -81,7 +81,7 @@ extern volatile sig_atomic_t terminate;
 /**
  * Has the process receive a to
  * disconnect from or reconnect to
- * the site? 1 if disconnct, 2 if
+ * the site? 1 if disconnect, 2 if
  * reconnect, 0 otherwise.
  */
 extern volatile sig_atomic_t connection;
@@ -159,6 +159,11 @@ extern int preserve;
 
 
 /**
+ * Dump the state to stderr
+ */
+void state_dump(void);
+
+/**
  * Destroy the state
  */
 void state_destroy(void);
diff --git a/src/types/filter.h b/src/types/filter.h
index c9e01bb..c91ccb2 100644
--- a/src/types/filter.h
+++ b/src/types/filter.h
@@ -40,21 +40,21 @@
 enum lifespan
 {
   /**
-   * The filter should be applied
-   * until it is explicitly removed
+   * The filter should be removed now
    */
-  LIFESPAN_UNTIL_REMOVAL,
+  LIFESPAN_REMOVE = 0,
   
   /**
    * The filter should be applied
-   * until the client exists
+   * until it is explicitly removed
    */
-  LIFESPAN_UNTIL_DEATH,
+  LIFESPAN_UNTIL_REMOVAL = 1,
   
   /**
-   * The filter should be removed now
+   * The filter should be applied
+   * until the client exists
    */
-  LIFESPAN_REMOVE
+  LIFESPAN_UNTIL_DEATH = 2
   
 };
 
diff --git a/src/types/message.h b/src/types/message.h
index 00a2a50..0f1ade2 100644
--- a/src/types/message.h
+++ b/src/types/message.h
@@ -88,7 +88,7 @@ struct message
    * 0 while reading headers, 1 while reading payload, and 2 when done (internal data)
    */
   int stage;
-
+  
 #if INT_MAX != LONG_MAX
   int padding__;
 #endif