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