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