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