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