KernelLand/Kernel/debug.c

   1 /*
   2  * AcessOS Microkernel Version
   3  * debug.c
   4  */
   5 #include <acess.h>
   6 #include <stdarg.h>
   7 #include <debug_hooks.h>
   8
   9 #define DEBUG_MAX_LINE_LEN      256
  10 #define LOCK_DEBUG_OUTPUT       0       // Avoid interleaving of output lines?
  11 #define TRACE_TO_KTERM          0       // Send ENTER/DEBUG/LEAVE/Debug to the VTerm
  12
  13 // === IMPORTS ===
  14 extern void     KernelPanic_SetMode(void);
  15 extern void     KernelPanic_PutChar(char Ch);
  16 extern void     IPStack_SendDebugText(const char *Text);
  17 extern void     VT_SetTerminal(int TerminalID);
  18
  19 // === PROTOTYPES ===
  20 static void     Debug_Putchar(char ch);
  21 static void     Debug_Puts(int bUseKTerm, const char *Str);
  22 void    Debug_FmtS(int bUseKTerm, const char *format, ...);
  23 bool    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 && gbInPutChar == 0)
  80         {
  81                 gbInPutChar = 1;
  82                 VFS_Write(giDebug_KTerm, len, Str);
  83                 gbInPutChar = 0;
  84         }
  85 }
  86
  87 bool Debug_Fmt(int bUseKTerm, const char *format, va_list args)
  88 {
  89         char    buf[DEBUG_MAX_LINE_LEN];
  90         buf[DEBUG_MAX_LINE_LEN-1] = 0;
  91         size_t len = vsnprintf(buf, DEBUG_MAX_LINE_LEN-1, format, args);
  92         Debug_Puts(bUseKTerm, buf);
  93         if( len > DEBUG_MAX_LINE_LEN-1 ) {
  94                 // do something
  95                 Debug_Puts(bUseKTerm, "[...]");
  96                 return false;
  97         }
  98         return true;
  99 }
 100
 101 void Debug_FmtS(int bUseKTerm, const char *format, ...)
 102 {
 103         va_list args;
 104         va_start(args, format);
 105         Debug_Fmt(bUseKTerm, format, args);
 106         va_end(args);
 107 }
 108
 109 void Debug_KernelPanic(void)
 110 {
 111         // 5 nested panics? Fuck it
 112         if( gbDebug_IsKPanic > 5 )
 113                 HALT_CPU();
 114         gbDebug_IsKPanic ++;
 115         if( gbDebug_IsKPanic == 1 )
 116         {
 117                 #if LOCK_DEBUG_OUTPUT
 118                 SHORTREL(&glDebug_Lock);
 119                 #endif
 120                 VT_SetTerminal(7);
 121         }
 122         KernelPanic_SetMode();
 123 }
 124
 125 /**
 126  * \fn void LogF(const char *Msg, ...)
 127  * \brief Raw debug log (no new line, no prefix)
 128  * \return True if all of the provided text was printed
 129  */
 130 bool LogF(const char *Fmt, ...)
 131 {
 132         #if LOCK_DEBUG_OUTPUT
 133         if(CPU_HAS_LOCK(&glDebug_Lock)) {
 134                 Debug_Puts("[#]");
 135                 return true;
 136         }
 137         SHORTLOCK(&glDebug_Lock);
 138         #endif
 139
 140         va_list args;
 141         va_start(args, Fmt);
 142         bool rv = Debug_Fmt(1, Fmt, args);
 143         va_end(args);
 144
 145         #if LOCK_DEBUG_OUTPUT
 146         SHORTREL(&glDebug_Lock);
 147         #endif
 148         return rv;
 149 }
 150 /**
 151  * \fn void Debug(const char *Msg, ...)
 152  * \brief Print only to the debug channel (not KTerm)
 153  */
 154 void Debug(const char *Fmt, ...)
 155 {
 156         va_list args;
 157
 158         #if LOCK_DEBUG_OUTPUT
 159         if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
 160         SHORTLOCK(&glDebug_Lock);
 161         #endif
 162
 163         Debug_Puts(TRACE_TO_KTERM, "Debug: ");
 164         va_start(args, Fmt);
 165         Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
 166         va_end(args);
 167         Debug_Puts(TRACE_TO_KTERM, "\r\n");
 168         #if LOCK_DEBUG_OUTPUT
 169         SHORTREL(&glDebug_Lock);
 170         #endif
 171 }
 172
 173
 174 void LogFV(const char *Fmt, va_list args)
 175 {
 176         #if LOCK_DEBUG_OUTPUT
 177         if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
 178         SHORTLOCK(&glDebug_Lock);
 179         #endif
 180
 181         Debug_Fmt(1, Fmt, args);
 182
 183         #if LOCK_DEBUG_OUTPUT
 184         SHORTREL(&glDebug_Lock);
 185         #endif
 186 }
 187
 188 void LogV(const char *Fmt, va_list args)
 189 {
 190         #if LOCK_DEBUG_OUTPUT
 191         if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
 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         if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
 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, "\x1b[31m");
 248         Debug_Puts(1, "Panic: ");
 249         va_start(args, Fmt);
 250         Debug_Fmt(1, Fmt, args);
 251         va_end(args);
 252         Debug_Puts(1, "\x1b[0m\r\n");
 253
 254         Proc_PrintBacktrace();
 255         //Threads_Dump();
 256         //Heap_Dump();
 257
 258         HALT_CPU();
 259 }
 260
 261 void Debug_SetKTerminal(const char *File)
 262 {
 263         if(giDebug_KTerm != -1) {
 264                 // Clear FD to -1 before closing (prevents writes to closed FD)
 265                 int oldfd = giDebug_KTerm;
 266                 giDebug_KTerm = -1;
 267                 VFS_Close(oldfd);
 268         }
 269         giDebug_KTerm = VFS_Open(File, VFS_OPENFLAG_WRITE);
 270 }
 271
 272 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
 273 {
 274         va_list args;
 275          int    i;
 276          int    pos;
 277         tTID    tid = Threads_GetTID();
 278
 279         #if LOCK_DEBUG_OUTPUT
 280         if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
 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         if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
 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         if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
 371         SHORTLOCK(&glDebug_Lock);
 372         #endif
 373
 374         i = --gDebug_Level;
 375
 376         va_start(args, RetType);
 377
 378         if( i == -1 ) {
 379                 gDebug_Level = 0;
 380                 i = 0;
 381         }
 382         Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
 383         // Indenting
 384         while(i--)      Debug_Puts(TRACE_TO_KTERM, " ");
 385
 386         Debug_Puts(TRACE_TO_KTERM, FuncName);
 387         Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
 388         Debug_Puts(TRACE_TO_KTERM, ": RETURN");
 389
 390         // No Return
 391         if(RetType == '-') {
 392                 Debug_Puts(TRACE_TO_KTERM, "\r\n");
 393                 #if LOCK_DEBUG_OUTPUT
 394                 SHORTREL(&glDebug_Lock);
 395                 #endif
 396                 return;
 397         }
 398
 399         switch(RetType)
 400         {
 401         case 'n':       Debug_Puts(TRACE_TO_KTERM, " NULL");    break;
 402         case 'p':       Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
 403         case 'P':       Debug_Fmt(TRACE_TO_KTERM, " %P", args); break;  // PAddr
 404         case 's':       Debug_Fmt(TRACE_TO_KTERM, " '%s'", args);       break;
 405         case 'i':       Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
 406         case 'u':       Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
 407         case 'x':       Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args);       break;
 408         // Extended (64-Bit)
 409         case 'X':       Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args);     break;
 410         }
 411         Debug_Puts(TRACE_TO_KTERM, "\r\n");
 412
 413         va_end(args);
 414
 415         #if LOCK_DEBUG_OUTPUT
 416         SHORTREL(&glDebug_Lock);
 417         #endif
 418 }
 419
 420 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
 421 {
 422         const Uint8     *cdat = Data;
 423         Uint    pos = 0;
 424         LogF("%014lli ", now());
 425         Debug_Puts(1, Header);
 426         LogF(" (Hexdump of %p+%i)\r\n", Data, Length);
 427
 428         #define CH(n)   ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
 429
 430         while(Length >= 16)
 431         {
 432                 LogF("%014lli Log: %04x:"
 433                         " %02x %02x %02x %02x %02x %02x %02x %02x "
 434                         " %02x %02x %02x %02x %02x %02x %02x %02x "
 435                         " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
 436                         now(),
 437                         pos,
 438                         cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
 439                         cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
 440                         CH(0),  CH(1),  CH(2),  CH(3),  CH(4),  CH(5),  CH(6),  CH(7),
 441                         CH(8),  CH(9),  CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
 442                         );
 443                 Length -= 16;
 444                 cdat += 16;
 445                 pos += 16;
 446         }
 447
 448         {
 449                  int    i ;
 450                 LogF("%014lli Log: %04x: ", now(), pos);
 451                 for(i = 0; i < Length; i ++)
 452                 {
 453                         LogF("%02x ", cdat[i]);
 454                 }
 455                 for( ; i < 16; i ++)    LogF("   ");
 456                 LogF(" ");
 457                 for(i = 0; i < Length; i ++)
 458                 {
 459                         if( i == 8 )    LogF(" ");
 460                         LogF("%c", CH(i));
 461                 }
 462
 463                 Debug_Putchar('\r');
 464                 Debug_Putchar('\n');
 465         }
 466 }
 467
 468 // --- EXPORTS ---
 469 EXPORT(Debug);
 470 EXPORT(Log);
 471 EXPORT(Warning);
 472 EXPORT(Debug_Enter);
 473 EXPORT(Debug_Log);
 474 EXPORT(Debug_Leave);