rom/exec/exec_debug.c

   1 /*
   2     Copyright © 1995-2012, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Runtime debugging support
   6     Lang: english
   7 */
   8
   9 /*
  10  * You can #define this in order to omit the whole code. Perhaps ROM-based systems
  11  * will want to do this.
  12  * However it's not advised to do so because this is a great aid in debugging
  13  * on user's side.
  14  */
  15 #ifndef NO_RUNTIME_DEBUG
  16
  17 #include <exec/execbase.h>
  18 #include <exec/rawfmt.h>
  19 #include <proto/exec.h>
  20
  21 #include <ctype.h>
  22 #include <string.h>
  23
  24 #include "exec_debug.h"
  25
  26 const char * const ExecFlagNames[] =
  27 {
  28     "InitResident",
  29     "InitCode",
  30     "FindResident",
  31     (char *)-1,         /* Reserved bit         */
  32     "CreateLibrary",
  33     "SetFunction",
  34     "NewSetFunction",
  35     "ChipRam",
  36     "AddTask",
  37     "RemTask",
  38     "GetTaskAttr",
  39     "SetTaskAttr",
  40     "ExceptHandler",
  41     "AddDosNode",
  42     "PCI",
  43     "RamLib",
  44     (char *)-1,         /* NoLogServer          */
  45     (char *)-1,         /* NoLogWindow          */
  46     (char *)-1,         /* LogFile              */
  47     (char *)-1,         /* LogKPrintF           */
  48     (char *)-1,         /* PermMemTrack         */
  49     "MemTrack",
  50     (char *)-1,         /* CyberGuardDelay      */
  51     "LogExtended",
  52     "LoadSeg",
  53     "UnloadSeg",
  54     (char *)-1,         /* PPCStart             */
  55     "CGXDebug",
  56     "InvZeroPage",
  57     (char *)-1,         /* Reserved bit         */
  58     "Init",
  59     NULL
  60 };
  61
  62 void ExecLog(struct ExecBase *SysBase, ULONG flags, const char *format, ...)
  63 {
  64     va_list ap;
  65
  66     flags &= SysBase->ex_DebugFlags;
  67     if (!flags)
  68         return;
  69
  70     va_start(ap, format);
  71     VLog(SysBase, flags, ExecFlagNames, format, ap);
  72     va_end(ap);
  73 }
  74
  75 /*
  76  * The following stuff is a candidate to become a public API.
  77  * Currently i have no idea into what component to put it, so for now
  78  * it's exec.library's private property.
  79  * The main problem is that we need it very early, before debug.library
  80  * and whatever else wakes up.
  81  */
  82
  83 /*
  84  * Return a set of flags specified on the command line.
  85  * Option format: <flag1>,<flags>,...,<flagN>
  86  * Or:            "<flag1> <flag2> ... <flagN>"
  87  */
  88 ULONG ParseFlags(char *opts, const char * const *FlagNames)
  89 {
  90     ULONG ret = 0;
  91     char quoted = 0;
  92
  93     if (*opts == '"')
  94     {
  95         quoted = 1;
  96         opts++;
  97     }
  98
  99     while (isalpha(*opts))
 100     {
 101         char *p = opts + 1;
 102         unsigned int i;
 103
 104         /* Find the end of the word */
 105         while (isalpha(*p))
 106             p++;
 107
 108         /* "ALL" means all flags */
 109         if (!strnicmp(opts, "all", 3))
 110             return -1;
 111
 112         /* Decode flag name */
 113         for (i = 0; FlagNames[i]; i++)
 114         {
 115             const char *flagName = FlagNames[i];
 116
 117             if (flagName == (char *)-1)
 118                 continue;
 119
 120             if (!strnicmp(opts, flagName, strlen(flagName)))
 121             {
 122                 ret |= (1UL << i);
 123                 break;
 124             }
 125         }
 126
 127         if (quoted)
 128         {
 129             /* Skip separator characters */
 130             while (!isalpha(*p))
 131             {
 132                 /* If we hit closing quotes or end of line, this is the end */
 133                 if (*p == '"')
 134                     return ret;
 135
 136                 if (*p == 0)
 137                     return ret;
 138             }
 139
 140             /* Next word is found */
 141             opts = p;
 142         }
 143         else
 144         {
 145             /* If the string is not quoted, only single comma is allowed as a separator */
 146             if (*p != ',')
 147                 break;
 148
 149             opts = p + 1;
 150         }
 151     }
 152
 153     return ret;
 154 }
 155
 156 void VLog(struct ExecBase *SysBase, ULONG flags, const char * const *FlagNames, const char *format, va_list args)
 157 {
 158     unsigned int i;
 159
 160     /* Prepend tag (if known) */
 161     for (i = 0; FlagNames[i]; i++)
 162     {
 163         if (FlagNames[i] == (char *)-1)
 164             continue;
 165
 166         if (flags & (1UL << i))
 167         {
 168             RawDoFmt("[%s] ", (APTR)&FlagNames[i], (VOID_FUNC)RAWFMTFUNC_SERIAL, NULL);
 169             break;
 170         }
 171     }
 172
 173     /* Output the message and append a newline (in order not to bother about it every time) */
 174     VNewRawDoFmt(format, (VOID_FUNC)RAWFMTFUNC_SERIAL, NULL, args);
 175     RawPutChar('\n');
 176 }
 177
 178 #endif