KernelLand/Kernel/debug.c

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