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          1       // 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( !gbDebug_IsKPanic )
 117         {
 118                 #if LOCK_DEBUG_OUTPUT
 119                 SHORTREL(&glDebug_Lock);
 120                 #endif
 121                 VT_SetTerminal(7);
 122         }
 123         // 5 nested panics? Fuck it
 124         if( gbDebug_IsKPanic > 5 )
 125                 for(;;);
 126         gbDebug_IsKPanic ++;
 127         KernelPanic_SetMode();
 128 }
 129
 130 /**
 131  * \fn void LogF(const char *Msg, ...)
 132  * \brief Raw debug log (no new line, no prefix)
 133  */
 134 void LogF(const char *Fmt, ...)
 135 {
 136         va_list args;
 137
 138         #if LOCK_DEBUG_OUTPUT
 139         SHORTLOCK(&glDebug_Lock);
 140         #endif
 141
 142         va_start(args, Fmt);
 143
 144         Debug_Fmt(1, Fmt, args);
 145
 146         va_end(args);
 147
 148         #if LOCK_DEBUG_OUTPUT
 149         SHORTREL(&glDebug_Lock);
 150         #endif
 151 }
 152 /**
 153  * \fn void Debug(const char *Msg, ...)
 154  * \brief Print only to the debug channel (not KTerm)
 155  */
 156 void Debug(const char *Fmt, ...)
 157 {
 158         va_list args;
 159
 160         #if LOCK_DEBUG_OUTPUT
 161         if(!CPU_HAS_LOCK(&glDebug_Lock)) SHORTLOCK(&glDebug_Lock);
 162         #endif
 163
 164         Debug_Puts(0, "Debug: ");
 165         va_start(args, Fmt);
 166         Debug_DbgOnlyFmt(Fmt, args);
 167         va_end(args);
 168         Debug_PutCharDebug('\r');
 169         Debug_PutCharDebug('\n');
 170         #if LOCK_DEBUG_OUTPUT
 171         SHORTREL(&glDebug_Lock);
 172         #endif
 173 }
 174
 175
 176 void LogFV(const char *Fmt, va_list args)
 177 {
 178         #if LOCK_DEBUG_OUTPUT
 179         SHORTLOCK(&glDebug_Lock);
 180         #endif
 181
 182         Debug_Fmt(1, Fmt, args);
 183
 184         #if LOCK_DEBUG_OUTPUT
 185         SHORTREL(&glDebug_Lock);
 186         #endif
 187 }
 188
 189 void LogV(const char *Fmt, va_list args)
 190 {
 191         #if LOCK_DEBUG_OUTPUT
 192         SHORTLOCK(&glDebug_Lock);
 193         #endif
 194
 195         Debug_Puts(1, "Log: ");
 196         Debug_Fmt(1, Fmt, args);
 197         Debug_Puts(1, "\r\n");
 198
 199         #if LOCK_DEBUG_OUTPUT
 200         SHORTREL(&glDebug_Lock);
 201         #endif
 202 }
 203
 204 /**
 205  * \fn void Log(const char *Msg, ...)
 206  */
 207 void Log(const char *Fmt, ...)
 208 {
 209         va_list args;
 210         va_start(args, Fmt);
 211         LogV(Fmt, args);
 212         va_end(args);
 213 }
 214
 215 void Warning(const char *Fmt, ...)
 216 {
 217         va_list args;
 218
 219         #if LOCK_DEBUG_OUTPUT
 220         SHORTLOCK(&glDebug_Lock);
 221         #endif
 222
 223         Debug_Puts(1, "Warning: ");
 224         va_start(args, Fmt);
 225         Debug_Fmt(1, Fmt, args);
 226         va_end(args);
 227         Debug_Putchar('\r');
 228         Debug_Putchar('\n');
 229
 230         #if LOCK_DEBUG_OUTPUT
 231         SHORTREL(&glDebug_Lock);
 232         #endif
 233 }
 234 void Panic(const char *Fmt, ...)
 235 {
 236         va_list args;
 237
 238         #if LOCK_DEBUG_OUTPUT
 239         if( !CPU_HAS_LOCK(&glDebug_Lock) )
 240                 SHORTLOCK(&glDebug_Lock);
 241         #endif
 242         // And never SHORTREL
 243
 244         Debug_KernelPanic();
 245
 246         Debug_Puts(1, "Panic: ");
 247         va_start(args, Fmt);
 248         Debug_Fmt(1, Fmt, args);
 249         va_end(args);
 250         Debug_Putchar('\r');
 251         Debug_Putchar('\n');
 252
 253         //Threads_Dump();
 254         //Heap_Dump();
 255
 256         for(;;) ;
 257 }
 258
 259 void Debug_SetKTerminal(const char *File)
 260 {
 261          int    tmp;
 262         if(giDebug_KTerm != -1) {
 263                 tmp = giDebug_KTerm;
 264                 giDebug_KTerm = -1;
 265                 VFS_Close(tmp);
 266         }
 267         tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
 268 //      Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
 269         giDebug_KTerm = tmp;
 270 //      Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
 271 }
 272
 273 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
 274 {
 275         va_list args;
 276          int    i;
 277          int    pos;
 278         tTID    tid = Threads_GetTID();
 279
 280         #if LOCK_DEBUG_OUTPUT
 281         SHORTLOCK(&glDebug_Lock);
 282         #endif
 283
 284         i = gDebug_Level ++;
 285
 286         va_start(args, ArgTypes);
 287
 288         Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
 289         while(i--)      Debug_Puts(TRACE_TO_KTERM, " ");
 290
 291         Debug_Puts(TRACE_TO_KTERM, FuncName);
 292         Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
 293         Debug_Puts(TRACE_TO_KTERM, ": (");
 294
 295         while(*ArgTypes)
 296         {
 297                 pos = strpos(ArgTypes, ' ');
 298                 if(pos == -1 || pos > 1) {
 299                         if(pos == -1)
 300                                 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
 301                         else {
 302                                 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
 303                         }
 304                         Debug_Puts(TRACE_TO_KTERM, "=");
 305                 }
 306                 switch(*ArgTypes)
 307                 {
 308                 case 'p':       Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*));  break;
 309                 case 'P':       Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
 310                 case 's':       Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*));        break;
 311                 case 'i':       Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int));    break;
 312                 case 'u':       Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint));   break;
 313                 case 'x':       Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
 314                 case 'b':       Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
 315                 case 'X':       Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64));     break;  // Extended (64-Bit)
 316                 case 'B':       Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64));     break;  // Extended (64-Bit)
 317                 }
 318                 if(pos != -1) {
 319                         Debug_Puts(TRACE_TO_KTERM, ", ");
 320                 }
 321
 322                 if(pos == -1)   break;
 323                 ArgTypes = &ArgTypes[pos+1];
 324         }
 325
 326         va_end(args);
 327         Debug_Puts(TRACE_TO_KTERM, ")\r\n");
 328
 329         #if LOCK_DEBUG_OUTPUT
 330         SHORTREL(&glDebug_Lock);
 331         #endif
 332 }
 333
 334 void Debug_Log(const char *FuncName, const char *Fmt, ...)
 335 {
 336         va_list args;
 337          int    i = gDebug_Level;
 338         tTID    tid = Threads_GetTID();
 339
 340         #if LOCK_DEBUG_OUTPUT
 341         SHORTLOCK(&glDebug_Lock);
 342         #endif
 343
 344         Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
 345         while(i--)      Debug_Puts(TRACE_TO_KTERM, " ");
 346
 347         Debug_Puts(TRACE_TO_KTERM, FuncName);
 348         Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
 349         Debug_Puts(TRACE_TO_KTERM, ": ");
 350
 351         va_start(args, Fmt);
 352         Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
 353         va_end(args);
 354
 355         Debug_Puts(TRACE_TO_KTERM, "\r\n");
 356
 357         #if LOCK_DEBUG_OUTPUT
 358         SHORTREL(&glDebug_Lock);
 359         #endif
 360 }
 361
 362 void Debug_Leave(const char *FuncName, char RetType, ...)
 363 {
 364         va_list args;
 365          int    i;
 366         tTID    tid = Threads_GetTID();
 367
 368         #if LOCK_DEBUG_OUTPUT
 369         SHORTLOCK(&glDebug_Lock);
 370         #endif
 371
 372         i = --gDebug_Level;
 373
 374         va_start(args, RetType);
 375
 376         if( i == -1 ) {
 377                 gDebug_Level = 0;
 378                 i = 0;
 379         }
 380         Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
 381         // Indenting
 382         while(i--)      Debug_Puts(TRACE_TO_KTERM, " ");
 383
 384         Debug_Puts(TRACE_TO_KTERM, FuncName);
 385         Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
 386         Debug_Puts(TRACE_TO_KTERM, ": RETURN");
 387
 388         // No Return
 389         if(RetType == '-') {
 390                 Debug_Puts(TRACE_TO_KTERM, "\r\n");
 391                 #if LOCK_DEBUG_OUTPUT
 392                 SHORTREL(&glDebug_Lock);
 393                 #endif
 394                 return;
 395         }
 396
 397         switch(RetType)
 398         {
 399         case 'n':       Debug_Puts(TRACE_TO_KTERM, " NULL");    break;
 400         case 'p':       Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
 401         case 'P':       Debug_Fmt(TRACE_TO_KTERM, " %P", args); break;  // PAddr
 402         case 's':       Debug_Fmt(TRACE_TO_KTERM, " '%s'", args);       break;
 403         case 'i':       Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
 404         case 'u':       Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
 405         case 'x':       Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args);       break;
 406         // Extended (64-Bit)
 407         case 'X':       Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args);     break;
 408         }
 409         Debug_Puts(TRACE_TO_KTERM, "\r\n");
 410
 411         va_end(args);
 412
 413         #if LOCK_DEBUG_OUTPUT
 414         SHORTREL(&glDebug_Lock);
 415         #endif
 416 }
 417
 418 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
 419 {
 420         const Uint8     *cdat = Data;
 421         Uint    pos = 0;
 422         LogF("%014lli ", now());
 423         Debug_Puts(1, Header);
 424         LogF(" (Hexdump of %p)\r\n", Data);
 425
 426         #define CH(n)   ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
 427
 428         while(Length >= 16)
 429         {
 430                 LogF("%014lli Log: %04x:"
 431                         " %02x %02x %02x %02x %02x %02x %02x %02x"
 432                         " %02x %02x %02x %02x %02x %02x %02x %02x"
 433                         "  %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
 434                         now(),
 435                         pos,
 436                         cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
 437                         cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
 438                         CH(0),  CH(1),  CH(2),  CH(3),  CH(4),  CH(5),  CH(6),  CH(7),
 439                         CH(8),  CH(9),  CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
 440                         );
 441                 Length -= 16;
 442                 cdat += 16;
 443                 pos += 16;
 444         }
 445
 446         {
 447                  int    i ;
 448                 LogF("%014lli Log: %04x: ", now(), pos);
 449                 for(i = 0; i < Length; i ++)
 450                 {
 451                         LogF("%02x ", cdat[i]);
 452                 }
 453                 for( ; i < 16; i ++)    LogF("   ");
 454                 LogF(" ");
 455                 for(i = 0; i < Length; i ++)
 456                 {
 457                         if( i == 8 )    LogF(" ");
 458                         LogF("%c", CH(i));
 459                 }
 460
 461                 Debug_Putchar('\r');
 462                 Debug_Putchar('\n');
 463         }
 464 }
 465
 466 // --- EXPORTS ---
 467 EXPORT(Debug);
 468 EXPORT(Log);
 469 EXPORT(Warning);
 470 EXPORT(Debug_Enter);
 471 EXPORT(Debug_Log);
 472 EXPORT(Debug_Leave);