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