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