Kernel/debug.c

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