Kernel/debug.c

   1 /*
   2  * AcessOS Microkernel Version
   3  * debug.c
   4  */
   5 #include <acess.h>
   6 #include <stdarg.h>
   7
   8 #define DEBUG_TO_E9     1
   9 #define DEBUG_TO_SERIAL 1
  10 #define SERIAL_PORT     0x3F8
  11 #define GDB_SERIAL_PORT 0x2F8
  12
  13 // === IMPORTS ===
  14 extern void Threads_Dump();
  15
  16 // === GLOBALS ===
  17  int    gDebug_Level = 0;
  18  int    giDebug_KTerm = -1;
  19  int    gbDebug_SerialSetup = 0;
  20  int    gbGDB_SerialSetup = 0;
  21
  22 // === CODE ===
  23 int putDebugChar(char ch)
  24 {
  25         if(!gbGDB_SerialSetup) {
  26                 outb(GDB_SERIAL_PORT + 1, 0x00);    // Disable all interrupts
  27                 outb(GDB_SERIAL_PORT + 3, 0x80);    // Enable DLAB (set baud rate divisor)
  28                 outb(GDB_SERIAL_PORT + 0, 0x03);    // Set divisor to 3 (lo byte) 38400 baud
  29                 outb(GDB_SERIAL_PORT + 1, 0x00);    //                  (hi byte)
  30                 outb(GDB_SERIAL_PORT + 3, 0x03);    // 8 bits, no parity, one stop bit
  31                 outb(GDB_SERIAL_PORT + 2, 0xC7);    // Enable FIFO with 14-byte threshold and clear it
  32                 outb(GDB_SERIAL_PORT + 4, 0x0B);    // IRQs enabled, RTS/DSR set
  33                 gbDebug_SerialSetup = 1;
  34         }
  35         while( (inb(GDB_SERIAL_PORT + 5) & 0x20) == 0 );
  36         outb(GDB_SERIAL_PORT, ch);
  37         return 0;
  38 }
  39 int getDebugChar()
  40 {
  41         if(!gbGDB_SerialSetup) {
  42                 outb(GDB_SERIAL_PORT + 1, 0x00);    // Disable all interrupts
  43                 outb(GDB_SERIAL_PORT + 3, 0x80);    // Enable DLAB (set baud rate divisor)
  44                 outb(GDB_SERIAL_PORT + 0, 0x03);    // Set divisor to 3 (lo byte) 38400 baud
  45                 outb(GDB_SERIAL_PORT + 1, 0x00);    //                  (hi byte)
  46                 outb(GDB_SERIAL_PORT + 3, 0x03);    // 8 bits, no parity, one stop bit
  47                 outb(GDB_SERIAL_PORT + 2, 0xC7);    // Enable FIFO with 14-byte threshold and clear it
  48                 outb(GDB_SERIAL_PORT + 4, 0x0B);    // IRQs enabled, RTS/DSR set
  49                 gbDebug_SerialSetup = 1;
  50         }
  51         while( (inb(GDB_SERIAL_PORT + 5) & 1) == 0)     ;
  52         return inb(GDB_SERIAL_PORT);
  53 }
  54
  55 static void E9(char ch)
  56 {
  57         if(giDebug_KTerm != -1)
  58                 VFS_Write(giDebug_KTerm, 1, &ch);
  59
  60         #if DEBUG_TO_SERIAL
  61         if(!gbDebug_SerialSetup) {
  62                 outb(SERIAL_PORT + 1, 0x00);    // Disable all interrupts
  63                 outb(SERIAL_PORT + 3, 0x80);    // Enable DLAB (set baud rate divisor)
  64                 outb(SERIAL_PORT + 0, 0x03);    // Set divisor to 3 (lo byte) 38400 baud
  65                 outb(SERIAL_PORT + 1, 0x00);    //                  (hi byte)
  66                 outb(SERIAL_PORT + 3, 0x03);    // 8 bits, no parity, one stop bit
  67                 outb(SERIAL_PORT + 2, 0xC7);    // Enable FIFO with 14-byte threshold and clear it
  68                 outb(SERIAL_PORT + 4, 0x0B);    // IRQs enabled, RTS/DSR set
  69                 gbDebug_SerialSetup = 1;
  70         }
  71         while( (inb(SERIAL_PORT + 5) & 0x20) == 0 );
  72         outb(SERIAL_PORT, ch);
  73         #endif
  74
  75         #if DEBUG_TO_E9
  76         __asm__ __volatile__ ( "outb %%al, $0xe9" :: "a"(((Uint8)ch)) );
  77         #endif
  78 }
  79
  80 static void E9_Str(char *Str)
  81 {
  82         while(*Str)     E9(*Str++);
  83 }
  84
  85 void E9_Fmt(const char *format, va_list *args)
  86 {
  87         char    c, pad = ' ';
  88          int    minSize = 0;
  89         char    tmpBuf[34];     // For Integers
  90         char    *p = NULL;
  91          int    isLongLong = 0;
  92         Uint64  arg;
  93
  94         while((c = *format++) != 0)
  95         {
  96                 // Non control character
  97                 if( c != '%' ) {
  98                         E9(c);
  99                         continue;
 100                 }
 101
 102                 c = *format++;
 103
 104                 // Literal %
 105                 if(c == '%') {
 106                         E9('%');
 107                         continue;
 108                 }
 109
 110                 // Pointer
 111                 if(c == 'p') {
 112                         Uint    ptr = va_arg(*args, Uint);
 113                         E9('*');        E9('0');        E9('x');
 114                         p = tmpBuf;
 115                         itoa(p, ptr, 16, BITS/4, '0');
 116                         goto printString;
 117                 }
 118
 119                 // Get Argument
 120                 arg = va_arg(*args, Uint);
 121
 122                 // Padding
 123                 if(c == '0') {
 124                         pad = '0';
 125                         c = *format++;
 126                 } else
 127                         pad = ' ';
 128
 129                 // Minimum length
 130                 minSize = 1;
 131                 if('1' <= c && c <= '9')
 132                 {
 133                         minSize = 0;
 134                         while('0' <= c && c <= '9')
 135                         {
 136                                 minSize *= 10;
 137                                 minSize += c - '0';
 138                                 c = *format++;
 139                         }
 140                 }
 141
 142                 // Long (default)
 143                 isLongLong = 0;
 144                 if(c == 'l') {
 145                         c = *format++;
 146                         if(c == 'l') {
 147                                 #if BITS == 32
 148                                 arg |= va_arg(*args, Uint);
 149                                 #endif
 150                                 c = *format++;
 151                                 isLongLong = 1;
 152                         }
 153                 }
 154
 155                 p = tmpBuf;
 156                 switch (c) {
 157                 case 'd':
 158                 case 'i':
 159                         if( (isLongLong && arg >> 63) || (!isLongLong && arg >> 31) ) {
 160                                 E9('-');
 161                                 arg = -arg;
 162                         }
 163                         itoa(p, arg, 10, minSize, pad);
 164                         goto printString;
 165                 case 'u':
 166                         itoa(p, arg, 10, minSize, pad);
 167                         goto printString;
 168                 case 'x':
 169                         itoa(p, arg, 16, minSize, pad);
 170                         goto printString;
 171                 case 'o':
 172                         itoa(p, arg, 8, minSize, pad);
 173                         goto printString;
 174                 case 'b':
 175                         itoa(p, arg, 2, minSize, pad);
 176                         goto printString;
 177
 178                 case 'B':       //Boolean
 179                         if(arg) E9_Str("True");
 180                         else    E9_Str("False");
 181                         break;
 182
 183                 case 's':
 184                         p = (char*)(Uint)arg;
 185                 printString:
 186                         if(!p)          p = "(null)";
 187                         while(*p)       E9(*p++);
 188                         break;
 189
 190                 // Single Character / Array
 191                 case 'c':
 192                         if(minSize == 1) {
 193                                 E9(arg);
 194                                 break;
 195                         }
 196                         p = (char*)(Uint)arg;
 197                         if(!p)  goto printString;
 198                         while(minSize--)        E9(*p++);
 199                         break;
 200
 201                 default:        E9(arg);        break;
 202                 }
 203     }
 204 }
 205
 206 /**
 207  * \fn void LogV(char *Fmt, va_list Args)
 208  */
 209 void LogV(char *Fmt, va_list Args)
 210 {
 211         E9_Str("Log: ");
 212         E9_Fmt(Fmt, &Args);
 213         E9('\n');
 214 }
 215 /**
 216  * \fn void LogF(char *Msg, ...)
 217  */
 218 void LogF(char *Fmt, ...)
 219 {
 220         va_list args;
 221
 222         va_start(args, Fmt);
 223
 224         E9_Fmt(Fmt, &args);
 225
 226         va_end(args);
 227 }
 228 /**
 229  * \fn void Log(char *Msg, ...)
 230  */
 231 void Log(char *Fmt, ...)
 232 {
 233         va_list args;
 234
 235         E9_Str("Log: ");
 236         va_start(args, Fmt);
 237         E9_Fmt(Fmt, &args);
 238         va_end(args);
 239         E9('\n');
 240 }
 241 void Warning(char *Fmt, ...)
 242 {
 243         va_list args;
 244         E9_Str("Warning: ");
 245         va_start(args, Fmt);
 246         E9_Fmt(Fmt, &args);
 247         va_end(args);
 248         E9('\n');
 249 }
 250 void Panic(char *Fmt, ...)
 251 {
 252         va_list args;
 253         E9_Str("Panic: ");
 254         va_start(args, Fmt);
 255         E9_Fmt(Fmt, &args);
 256         va_end(args);
 257         E9('\n');
 258
 259         Threads_Dump();
 260
 261         __asm__ __volatile__ ("xchg %bx, %bx");
 262         __asm__ __volatile__ ("cli;\n\thlt");
 263         for(;;) __asm__ __volatile__ ("hlt");
 264 }
 265
 266 void Debug_SetKTerminal(char *File)
 267 {
 268         if(giDebug_KTerm != -1)
 269                 VFS_Close(giDebug_KTerm);
 270         giDebug_KTerm = VFS_Open(File, VFS_OPENFLAG_WRITE);
 271         Log("Opened '%s' as 0x%x", File, giDebug_KTerm);
 272 }
 273
 274 void Debug_Enter(char *FuncName, char *ArgTypes, ...)
 275 {
 276         va_list args;
 277          int    i = gDebug_Level ++;
 278          int    pos;
 279
 280         va_start(args, ArgTypes);
 281
 282         while(i--)      E9(' ');
 283
 284         E9_Str(FuncName);       E9_Str(": (");
 285
 286         while(*ArgTypes)
 287         {
 288                 pos = strpos(ArgTypes, ' ');
 289                 if(pos != -1)   ArgTypes[pos] = '\0';
 290                 if(pos == -1 || pos > 1) {
 291                         E9_Str(ArgTypes+1);
 292                         E9('=');
 293                 }
 294                 if(pos != -1)   ArgTypes[pos] = ' ';
 295                 switch(*ArgTypes)
 296                 {
 297                 case 'p':       E9_Fmt("%p", &args);    break;
 298                 case 's':       E9_Fmt("'%s'", &args);  break;
 299                 case 'i':       E9_Fmt("%i", &args);    break;
 300                 case 'u':       E9_Fmt("%u", &args);    break;
 301                 case 'x':       E9_Fmt("0x%x", &args);  break;
 302                 case 'b':       E9_Fmt("0b%b", &args);  break;
 303                 // Extended (64-Bit)
 304                 case 'X':       E9_Fmt("0x%llx", &args);        break;
 305                 case 'B':       E9_Fmt("0b%llb", &args);        break;
 306                 }
 307                 if(pos != -1) {
 308                         E9(',');        E9(' ');
 309                 }
 310
 311                 if(pos == -1)   break;
 312                 ArgTypes = &ArgTypes[pos+1];
 313         }
 314
 315         va_end(args);
 316         E9(')');        E9('\n');
 317 }
 318
 319 void Debug_Log(char *FuncName, char *Fmt, ...)
 320 {
 321         va_list args;
 322          int    i = gDebug_Level;
 323
 324         va_start(args, Fmt);
 325
 326         while(i--)      E9(' ');
 327
 328         E9_Str(FuncName);       E9_Str(": ");
 329         E9_Fmt(Fmt, &args);
 330
 331         va_end(args);
 332         E9('\n');
 333 }
 334
 335 void Debug_Leave(char *FuncName, char RetType, ...)
 336 {
 337         va_list args;
 338          int    i = --gDebug_Level;
 339
 340         va_start(args, RetType);
 341
 342         if( i == -1 ) {
 343                 gDebug_Level = 0;
 344                 i = 0;
 345         }
 346         // Indenting
 347         while(i--)      E9(' ');
 348
 349         E9_Str(FuncName);       E9_Str(": RETURN");
 350
 351         // No Return
 352         if(RetType == '-') {
 353                 E9('\n');
 354                 return;
 355         }
 356
 357         E9(' ');
 358         switch(RetType)
 359         {
 360         case 'n':       E9_Str("NULL"); break;
 361         case 'p':       E9_Fmt("%p", &args);    break;
 362         case 's':       E9_Fmt("'%s'", &args);  break;
 363         case 'i':       E9_Fmt("%i", &args);    break;
 364         case 'u':       E9_Fmt("%u", &args);    break;
 365         case 'x':       E9_Fmt("0x%x", &args);  break;
 366         // Extended (64-Bit)
 367         case 'X':       E9_Fmt("0x%llx", &args);        break;
 368         }
 369         E9('\n');
 370
 371         va_end(args);
 372 }
 373
 374 void Debug_HexDump(char *Header, void *Data, Uint Length)
 375 {
 376         Uint8   *cdat = Data;
 377         Uint    pos = 0;
 378         E9_Str(Header);
 379         LogF(" (Hexdump of %p)\n", Data);
 380
 381         while(Length >= 16)
 382         {
 383                 #define CH(n)   ((' '<=cdat[(n)]&&cdat[(n)]<=0x7F) ? cdat[(n)] : '.')
 384                 Log("%04x: %02x %02x %02x %02x %02x %02x %02x %02x"
 385                         " %02x %02x %02x %02x %02x %02x %02x %02x"
 386                         "  %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c",
 387                         pos,
 388                         cdat[0], cdat[1], cdat[2], cdat[3], cdat[4], cdat[5], cdat[6], cdat[7],
 389                         cdat[8], cdat[9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
 390                         CH(0),  CH(1),  CH(2),  CH(3),  CH(4),  CH(5),  CH(6),  CH(7),
 391                         CH(8),  CH(9),  CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
 392                         );
 393                 Length -= 16;
 394                 cdat += 16;
 395                 pos += 16;
 396         }
 397
 398         LogF("Log: %04x: ", pos);
 399         while(Length)
 400         {
 401                 Uint    byte = *cdat;
 402                 LogF("%02x ", byte);
 403                 Length--;
 404                 cdat ++;
 405         }
 406         E9('\n');
 407 }
 408
 409 // --- EXPORTS ---
 410 EXPORT(Log);
 411 EXPORT(Warning);
 412 EXPORT(Debug_Enter);
 413 EXPORT(Debug_Log);
 414 EXPORT(Debug_Leave);