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