[debug] Allow debug message colours to be customised via DBGCOL=...

When multiple iPXE binaries are running concurrently (e.g. in the case
of undionly.kpxe using an underlying iPXE driver via the UNDI
interface) it would be helpful to be able to visually distinguish
debug messages from each binary.

Allow the range of debug colours used to be customised via the
DBGCOL=...  build parameter.  For example:

  # Restrict to colours 31-33 (red, green, yellow)
  make DBGCOL=31-33

  # Restrict to colours 34-36 (blue, magenta, cyan)
  make DBGCOL=34-36

Signed-off-by: Michael Brown <mcb30@ipxe.org>

diff --git a/src/Makefile.housekeeping b/src/Makefile.housekeeping
index f7755369cee84ddfcf16173018908f907f3b47b6..e40e713225556efd0c6aa8a8360d223e21df224d 100644 (file)
--- a/src/Makefile.housekeeping
+++ b/src/Makefile.housekeeping
@@ -710,6 +710,31 @@ $(BIN)/version.o : ../.git/index
 endif
 endif
 
+# Debug message autocolourisation range
+#
+DBGCOL_LIST    := $(BIN)/.dbgcol.list
+ifeq ($(wildcard $(DBGCOL_LIST)),)
+DBGCOL_OLD := <invalid>
+else
+DBGCOL_OLD := $(shell cat $(DBGCOL_LIST))
+endif
+ifneq ($(DBGCOL_OLD),$(DBGCOL))
+$(shell $(ECHO) "$(DBGCOL)" > $(DBGCOL_LIST))
+endif
+
+$(DBGCOL_LIST) : $(MAKEDEPS)
+
+VERYCLEANUP += $(DBGCOL_LIST)
+
+DBGCOL_COLOURS := $(subst -, ,$(DBGCOL))
+DBGCOL_MIN := $(word 1,$(DBGCOL_COLOURS))
+DBGCOL_MAX := $(word 2,$(DBGCOL_COLOURS))
+
+debug_DEPS += $(DBGCOL_LIST)
+
+CFLAGS_debug += $(if $(DBGCOL_MIN),-DDBGCOL_MIN=$(DBGCOL_MIN))
+CFLAGS_debug += $(if $(DBGCOL_MAX),-DDBGCOL_MAX=$(DBGCOL_MAX))
+
 # We automatically generate rules for any file mentioned in AUTO_SRCS
 # using the following set of templates.  We use $(eval ...) if
 # available, otherwise we generate separate Makefile fragments and

diff --git a/src/core/debug.c b/src/core/debug.c
index 2161f9731dfe3c103ed5fac46c9249e2f7fb3353..7ded47089844d7ec84b2a0c31c4ed2ae967ee012 100644 (file)
--- a/src/core/debug.c
+++ b/src/core/debug.c
@@ -118,6 +118,15 @@ void dbg_hex_dump_da ( unsigned long dispaddr, const void *data,
        }
 }
 
+/**
+ * Base message stream colour
+ *
+ * We default to using 31 (red foreground) as the base colour.
+ */
+#ifndef DBGCOL_MIN
+#define DBGCOL_MIN 31
+#endif
+
 /**
  * Maximum number of separately coloured message streams
  *
@@ -125,7 +134,9 @@ void dbg_hex_dump_da ( unsigned long dispaddr, const void *data,
  * of which will be the terminal default and one of which will be
  * invisible on the terminal because it matches the background colour.
  */
-#define NUM_AUTO_COLOURS 6
+#ifndef DBGCOL_MAX
+#define DBGCOL_MAX ( DBGCOL_MIN + 6 - 1 )
+#endif
 
 /** A colour assigned to an autocolourised debug message stream */
 struct autocolour {
@@ -142,7 +153,7 @@ struct autocolour {
  * @ret colour         Colour ID
  */
 static int dbg_autocolour ( unsigned long stream ) {
-       static struct autocolour acs[NUM_AUTO_COLOURS];
+       static struct autocolour acs[ DBGCOL_MAX - DBGCOL_MIN + 1 ];
        static unsigned long use;
        unsigned int i;
        unsigned int oldest;
@@ -180,7 +191,7 @@ static int dbg_autocolour ( unsigned long stream ) {
  */
 void dbg_autocolourise ( unsigned long stream ) {
        dbg_printf ( "\033[%dm",
-                    ( stream ? ( 31 + dbg_autocolour ( stream ) ) : 0 ) );
+                    ( stream ? ( DBGCOL_MIN + dbg_autocolour ( stream ) ) :0));
 }
 
 /**