Kernel/debug.c

   1 /*
   2  * AcessOS Microkernel Version
   3  * debug.c
   4  *
   5  * TODO: Move the Debug_putchar methods out to the arch/ tree
   6  */
   7 #include <acess.h>
   8 #include <stdarg.h>
   9
  10 #define DEBUG_MAX_LINE_LEN      256
  11
  12 #define LOCK_DEBUG_OUTPUT       1
  13
  14 #define TRACE_TO_KTERM  0
  15
  16 // === IMPORTS ===
  17 extern void     Threads_Dump(void);
  18 extern void     KernelPanic_SetMode(void);
  19 extern void     KernelPanic_PutChar(char Ch);
  20
  21 // === PROTOTYPES ===
  22 static void     Debug_Putchar(char ch);
  23 static void     Debug_Puts(int bUseKTerm, const char *Str);
  24 void    Debug_DbgOnlyFmt(const char *format, va_list args);
  25 void    Debug_FmtS(int bUseKTerm, const char *format, ...);
  26 void    Debug_Fmt(int bUseKTerm, const char *format, va_list args);
  27 void    Debug_SetKTerminal(const char *File);
  28
  29 // === GLOBALS ===
  30  int    gDebug_Level = 0;
  31  int    giDebug_KTerm = -1;
  32  int    gbDebug_IsKPanic = 0;
  33 volatile int    gbInPutChar = 0;
  34 #if LOCK_DEBUG_OUTPUT
  35 tShortSpinlock  glDebug_Lock;
  36 #endif
  37
  38 // === CODE ===
  39 static void Debug_Putchar(char ch)
  40 {
  41         Debug_PutCharDebug(ch);
  42         if( !gbDebug_IsKPanic )
  43         {
  44                 if(gbInPutChar) return ;
  45                 gbInPutChar = 1;
  46                 if(giDebug_KTerm != -1)
  47                         VFS_Write(giDebug_KTerm, 1, &ch);
  48                 gbInPutChar = 0;
  49         }
  50         else
  51                 KernelPanic_PutChar(ch);
  52 }
  53
  54 static void Debug_Puts(int UseKTerm, const char *Str)
  55 {
  56          int    len = 0;
  57
  58         Debug_PutStringDebug(Str);
  59
  60         if( gbDebug_IsKPanic )
  61         {
  62                 for( len = 0; Str[len]; len ++ )
  63                         KernelPanic_PutChar( Str[len] );
  64         }
  65         else
  66                 for( len = 0; Str[len]; len ++ );
  67
  68         // Output to the kernel terminal
  69         if( UseKTerm && !gbDebug_IsKPanic && giDebug_KTerm != -1)
  70         {
  71                 if(gbInPutChar) return ;
  72                 gbInPutChar = 1;
  73                 VFS_Write(giDebug_KTerm, len, Str);
  74                 gbInPutChar = 0;
  75         }
  76 }
  77
  78 void Debug_DbgOnlyFmt(const char *format, va_list args)
  79 {
  80         Debug_Fmt(0, format, args);
  81 }
  82
  83 void Debug_Fmt(int bUseKTerm, const char *format, va_list args)
  84 {
  85         char    buf[DEBUG_MAX_LINE_LEN];
  86          int    len;
  87         buf[DEBUG_MAX_LINE_LEN-1] = 0;
  88         len = vsnprintf(buf, DEBUG_MAX_LINE_LEN-1, format, args);
  89         //if( len < DEBUG_MAX_LINE )
  90                 // do something
  91         Debug_Puts(bUseKTerm, buf);
  92         return ;
  93 }
  94
  95 void Debug_FmtS(int bUseKTerm, const char *format, ...)
  96 {
  97         va_list args;
  98         va_start(args, format);
  99         Debug_Fmt(bUseKTerm, format, args);
 100         va_end(args);
 101 }
 102
 103 void Debug_KernelPanic(void)
 104 {
 105         #if LOCK_DEBUG_OUTPUT
 106         SHORTREL(&glDebug_Lock);
 107         #endif
 108         gbDebug_IsKPanic = 1;
 109         KernelPanic_SetMode();
 110 }
 111
 112 /**
 113  * \fn void LogF(const char *Msg, ...)
 114  * \brief Raw debug log (no new line, no prefix)
 115  */
 116 void LogF(const char *Fmt, ...)
 117 {
 118         va_list args;
 119
 120         #if LOCK_DEBUG_OUTPUT
 121         SHORTLOCK(&glDebug_Lock);
 122         #endif
 123
 124         va_start(args, Fmt);
 125
 126         Debug_Fmt(1, Fmt, args);
 127
 128         va_end(args);
 129
 130         #if LOCK_DEBUG_OUTPUT
 131         SHORTREL(&glDebug_Lock);
 132         #endif
 133 }
 134 /**
 135  * \fn void Debug(const char *Msg, ...)
 136  * \brief Print only to the debug channel (not KTerm)
 137  */
 138 void Debug(const char *Fmt, ...)
 139 {
 140         va_list args;
 141
 142         #if LOCK_DEBUG_OUTPUT
 143         SHORTLOCK(&glDebug_Lock);
 144         #endif
 145
 146         Debug_Puts(0, "Debug: ");
 147         va_start(args, Fmt);
 148         Debug_DbgOnlyFmt(Fmt, args);
 149         va_end(args);
 150         Debug_PutCharDebug('\r');
 151         Debug_PutCharDebug('\n');
 152         #if LOCK_DEBUG_OUTPUT
 153         SHORTREL(&glDebug_Lock);
 154         #endif
 155 }
 156 /**
 157  * \fn void Log(const char *Msg, ...)
 158  */
 159 void Log(const char *Fmt, ...)
 160 {
 161         va_list args;
 162
 163         #if LOCK_DEBUG_OUTPUT
 164         SHORTLOCK(&glDebug_Lock);
 165         #endif
 166
 167         Debug_Puts(1, "Log: ");
 168         va_start(args, Fmt);
 169         Debug_Fmt(1, Fmt, args);
 170         va_end(args);
 171         Debug_Puts(1, "\r\n");
 172
 173         #if LOCK_DEBUG_OUTPUT
 174         SHORTREL(&glDebug_Lock);
 175         #endif
 176 }
 177 void Warning(const char *Fmt, ...)
 178 {
 179         va_list args;
 180
 181         #if LOCK_DEBUG_OUTPUT
 182         SHORTLOCK(&glDebug_Lock);
 183         #endif
 184
 185         Debug_Puts(1, "Warning: ");
 186         va_start(args, Fmt);
 187         Debug_Fmt(1, Fmt, args);
 188         va_end(args);
 189         Debug_Putchar('\r');
 190         Debug_Putchar('\n');
 191
 192         #if LOCK_DEBUG_OUTPUT
 193         SHORTREL(&glDebug_Lock);
 194         #endif
 195 }
 196 void Panic(const char *Fmt, ...)
 197 {
 198         va_list args;
 199
 200         #if LOCK_DEBUG_OUTPUT
 201         SHORTLOCK(&glDebug_Lock);
 202         #endif
 203         // And never SHORTREL
 204
 205         Debug_KernelPanic();
 206
 207         Debug_Puts(1, "Panic: ");
 208         va_start(args, Fmt);
 209         Debug_Fmt(1, Fmt, args);
 210         va_end(args);
 211         Debug_Putchar('\r');
 212         Debug_Putchar('\n');
 213
 214         Threads_Dump();
 215
 216         for(;;) ;
 217 }
 218
 219 void Debug_SetKTerminal(const char *File)
 220 {
 221          int    tmp;
 222         if(giDebug_KTerm != -1) {
 223                 tmp = giDebug_KTerm;
 224                 giDebug_KTerm = -1;
 225                 VFS_Close(tmp);
 226         }
 227         tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
 228 //      Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
 229         giDebug_KTerm = tmp;
 230 //      Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
 231 }
 232
 233 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
 234 {
 235         va_list args;
 236          int    i;
 237          int    pos;
 238         tTID    tid = Threads_GetTID();
 239
 240         #if LOCK_DEBUG_OUTPUT
 241         SHORTLOCK(&glDebug_Lock);
 242         #endif
 243
 244         i = gDebug_Level ++;
 245
 246         va_start(args, ArgTypes);
 247
 248         Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
 249         while(i--)      Debug_Puts(TRACE_TO_KTERM, " ");
 250
 251         Debug_Puts(TRACE_TO_KTERM, FuncName);
 252         Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
 253         Debug_Puts(TRACE_TO_KTERM, ": (");
 254
 255         while(*ArgTypes)
 256         {
 257                 pos = strpos(ArgTypes, ' ');
 258                 if(pos == -1 || pos > 1) {
 259                         if(pos == -1)
 260                                 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
 261                         else {
 262                                 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
 263                         }
 264                         Debug_Puts(TRACE_TO_KTERM, "=");
 265                 }
 266                 switch(*ArgTypes)
 267                 {
 268                 case 'p':       Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*));  break;
 269                 case 'P':       Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
 270                 case 's':       Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*));        break;
 271                 case 'i':       Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int));    break;
 272                 case 'u':       Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint));   break;
 273                 case 'x':       Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
 274                 case 'b':       Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
 275                 case 'X':       Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64));     break;  // Extended (64-Bit)
 276                 case 'B':       Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64));     break;  // Extended (64-Bit)
 277                 }
 278                 if(pos != -1) {
 279                         Debug_Puts(TRACE_TO_KTERM, ", ");
 280                 }
 281
 282                 if(pos == -1)   break;
 283                 ArgTypes = &ArgTypes[pos+1];
 284         }
 285
 286         va_end(args);
 287         Debug_Puts(TRACE_TO_KTERM, ")\r\n");
 288
 289         #if LOCK_DEBUG_OUTPUT
 290         SHORTREL(&glDebug_Lock);
 291         #endif
 292 }
 293
 294 void Debug_Log(const char *FuncName, const char *Fmt, ...)
 295 {
 296         va_list args;
 297          int    i = gDebug_Level;
 298         tTID    tid = Threads_GetTID();
 299
 300         #if LOCK_DEBUG_OUTPUT
 301         SHORTLOCK(&glDebug_Lock);
 302         #endif
 303
 304         Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
 305         while(i--)      Debug_Puts(TRACE_TO_KTERM, " ");
 306
 307         Debug_Puts(TRACE_TO_KTERM, FuncName);
 308         Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
 309         Debug_Puts(TRACE_TO_KTERM, ": ");
 310
 311         va_start(args, Fmt);
 312         Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
 313         va_end(args);
 314
 315         Debug_Puts(TRACE_TO_KTERM, "\r\n");
 316
 317         #if LOCK_DEBUG_OUTPUT
 318         SHORTREL(&glDebug_Lock);
 319         #endif
 320 }
 321
 322 void Debug_Leave(const char *FuncName, char RetType, ...)
 323 {
 324         va_list args;
 325          int    i;
 326         tTID    tid = Threads_GetTID();
 327
 328         #if LOCK_DEBUG_OUTPUT
 329         SHORTLOCK(&glDebug_Lock);
 330         #endif
 331
 332         i = --gDebug_Level;
 333
 334         va_start(args, RetType);
 335
 336         if( i == -1 ) {
 337                 gDebug_Level = 0;
 338                 i = 0;
 339         }
 340         Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
 341         // Indenting
 342         while(i--)      Debug_Puts(TRACE_TO_KTERM, " ");
 343
 344         Debug_Puts(TRACE_TO_KTERM, FuncName);
 345         Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
 346         Debug_Puts(TRACE_TO_KTERM, ": RETURN");
 347
 348         // No Return
 349         if(RetType == '-') {
 350                 Debug_Puts(TRACE_TO_KTERM, "\r\n");
 351                 #if LOCK_DEBUG_OUTPUT
 352                 SHORTREL(&glDebug_Lock);
 353                 #endif
 354                 return;
 355         }
 356
 357         switch(RetType)
 358         {
 359         case 'n':       Debug_Puts(TRACE_TO_KTERM, " NULL");    break;
 360         case 'p':       Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
 361         case 'P':       Debug_Fmt(TRACE_TO_KTERM, " %P", args); break;  // PAddr
 362         case 's':       Debug_Fmt(TRACE_TO_KTERM, " '%s'", args);       break;
 363         case 'i':       Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
 364         case 'u':       Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
 365         case 'x':       Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args);       break;
 366         // Extended (64-Bit)
 367         case 'X':       Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args);     break;
 368         }
 369         Debug_Puts(TRACE_TO_KTERM, "\r\n");
 370
 371         va_end(args);
 372
 373         #if LOCK_DEBUG_OUTPUT
 374         SHORTREL(&glDebug_Lock);
 375         #endif
 376 }
 377
 378 void Debug_HexDump(const char *Header, const void *Data, Uint Length)
 379 {
 380         const Uint8     *cdat = Data;
 381         Uint    pos = 0;
 382         LogF("%014lli ", now());
 383         Debug_Puts(1, Header);
 384         LogF(" (Hexdump of %p)\r\n", Data);
 385
 386         #define CH(n)   ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
 387
 388         while(Length >= 16)
 389         {
 390                 LogF("%014lli Log: %04x:"
 391                         " %02x %02x %02x %02x %02x %02x %02x %02x"
 392                         " %02x %02x %02x %02x %02x %02x %02x %02x"
 393                         "  %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
 394                         now(),
 395                         pos,
 396                         cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
 397                         cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
 398                         CH(0),  CH(1),  CH(2),  CH(3),  CH(4),  CH(5),  CH(6),  CH(7),
 399                         CH(8),  CH(9),  CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
 400                         );
 401                 Length -= 16;
 402                 cdat += 16;
 403                 pos += 16;
 404         }
 405
 406         {
 407                  int    i ;
 408                 LogF("%014lli Log: %04x: ", now(), pos);
 409                 for(i = 0; i < Length; i ++)
 410                 {
 411                         LogF("%02x ", cdat[i]);
 412                 }
 413                 for( ; i < 16; i ++)    LogF("   ");
 414                 LogF(" ");
 415                 for(i = 0; i < Length; i ++)
 416                 {
 417                         if( i == 8 )    LogF(" ");
 418                         LogF("%c", CH(i));
 419                 }
 420
 421                 Debug_Putchar('\r');
 422                 Debug_Putchar('\n');
 423         }
 424 }
 425
 426 // --- EXPORTS ---
 427 EXPORT(Debug);
 428 EXPORT(Log);
 429 EXPORT(Warning);
 430 EXPORT(Debug_Enter);
 431 EXPORT(Debug_Log);
 432 EXPORT(Debug_Leave);