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