X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Kernel%2Fdebug.c;h=355624d5c483769fafc237442a7ad64aaff4767f;hb=a2495c6ea4f4cab16b5d339ae511428e92e89e73;hp=8404fc1d21a848a3cd2cd7bdde467805da57dd78;hpb=246ff98ae5b16ef0e19fe082a9c900e9169a1f7b;p=tpg%2Facess2.git diff --git a/Kernel/debug.c b/Kernel/debug.c index 8404fc1d..355624d5 100644 --- a/Kernel/debug.c +++ b/Kernel/debug.c @@ -1,407 +1,430 @@ /* * AcessOS Microkernel Version * debug.c + * + * TODO: Move the Debug_putchar methods out to the arch/ tree */ #include #include -#define DEBUG_TO_E9 1 -#define DEBUG_TO_SERIAL 1 -#define SERIAL_PORT 0x3F8 -#define GDB_SERIAL_PORT 0x2F8 +#define DEBUG_MAX_LINE_LEN 256 + +#define LOCK_DEBUG_OUTPUT 1 + +#define TRACE_TO_KTERM 0 // === IMPORTS === -extern void Threads_Dump(); +extern void Threads_Dump(void); +extern void KernelPanic_SetMode(void); +extern void KernelPanic_PutChar(char Ch); + +// === PROTOTYPES === +static void Debug_Putchar(char ch); +static void Debug_Puts(int bUseKTerm, const char *Str); +void Debug_DbgOnlyFmt(const char *format, va_list args); +void Debug_FmtS(int bUseKTerm, const char *format, ...); +void Debug_Fmt(int bUseKTerm, const char *format, va_list args); +void Debug_SetKTerminal(const char *File); // === GLOBALS === int gDebug_Level = 0; int giDebug_KTerm = -1; - int gbDebug_SerialSetup = 0; - int gbGDB_SerialSetup = 0; + int gbDebug_IsKPanic = 0; +volatile int gbInPutChar = 0; +#if LOCK_DEBUG_OUTPUT +tShortSpinlock glDebug_Lock; +#endif // === CODE === -int putDebugChar(char ch) -{ - if(!gbGDB_SerialSetup) { - outb(GDB_SERIAL_PORT + 1, 0x00); // Disable all interrupts - outb(GDB_SERIAL_PORT + 3, 0x80); // Enable DLAB (set baud rate divisor) - outb(GDB_SERIAL_PORT + 0, 0x03); // Set divisor to 3 (lo byte) 38400 baud - outb(GDB_SERIAL_PORT + 1, 0x00); // (hi byte) - outb(GDB_SERIAL_PORT + 3, 0x03); // 8 bits, no parity, one stop bit - outb(GDB_SERIAL_PORT + 2, 0xC7); // Enable FIFO with 14-byte threshold and clear it - outb(GDB_SERIAL_PORT + 4, 0x0B); // IRQs enabled, RTS/DSR set - gbDebug_SerialSetup = 1; - } - while( (inb(GDB_SERIAL_PORT + 5) & 0x20) == 0 ); - outb(GDB_SERIAL_PORT, ch); - return 0; -} -int getDebugChar() +static void Debug_Putchar(char ch) { - if(!gbGDB_SerialSetup) { - outb(GDB_SERIAL_PORT + 1, 0x00); // Disable all interrupts - outb(GDB_SERIAL_PORT + 3, 0x80); // Enable DLAB (set baud rate divisor) - outb(GDB_SERIAL_PORT + 0, 0x03); // Set divisor to 3 (lo byte) 38400 baud - outb(GDB_SERIAL_PORT + 1, 0x00); // (hi byte) - outb(GDB_SERIAL_PORT + 3, 0x03); // 8 bits, no parity, one stop bit - outb(GDB_SERIAL_PORT + 2, 0xC7); // Enable FIFO with 14-byte threshold and clear it - outb(GDB_SERIAL_PORT + 4, 0x0B); // IRQs enabled, RTS/DSR set - gbDebug_SerialSetup = 1; + Debug_PutCharDebug(ch); + if( !gbDebug_IsKPanic ) + { + if(gbInPutChar) return ; + gbInPutChar = 1; + if(giDebug_KTerm != -1) + VFS_Write(giDebug_KTerm, 1, &ch); + gbInPutChar = 0; } - while( (inb(GDB_SERIAL_PORT + 5) & 1) == 0) ; - return inb(GDB_SERIAL_PORT); + else + KernelPanic_PutChar(ch); } -static void E9(char ch) +static void Debug_Puts(int UseKTerm, const char *Str) { - if(giDebug_KTerm != -1) - VFS_Write(giDebug_KTerm, 1, &ch); + int len = 0; + + Debug_PutStringDebug(Str); - #if DEBUG_TO_SERIAL - if(!gbDebug_SerialSetup) { - outb(SERIAL_PORT + 1, 0x00); // Disable all interrupts - outb(SERIAL_PORT + 3, 0x80); // Enable DLAB (set baud rate divisor) - outb(SERIAL_PORT + 0, 0x03); // Set divisor to 3 (lo byte) 38400 baud - outb(SERIAL_PORT + 1, 0x00); // (hi byte) - outb(SERIAL_PORT + 3, 0x03); // 8 bits, no parity, one stop bit - outb(SERIAL_PORT + 2, 0xC7); // Enable FIFO with 14-byte threshold and clear it - outb(SERIAL_PORT + 4, 0x0B); // IRQs enabled, RTS/DSR set - gbDebug_SerialSetup = 1; + if( gbDebug_IsKPanic ) + { + for( len = 0; Str[len]; len ++ ) + KernelPanic_PutChar( Str[len] ); } - while( (inb(SERIAL_PORT + 5) & 0x20) == 0 ); - outb(SERIAL_PORT, ch); - #endif + else + for( len = 0; Str[len]; len ++ ); - #if DEBUG_TO_E9 - __asm__ __volatile__ ( "outb %%al, $0xe9" :: "a"(((Uint8)ch)) ); - #endif + // Output to the kernel terminal + if( UseKTerm && !gbDebug_IsKPanic && giDebug_KTerm != -1) + { + if(gbInPutChar) return ; + gbInPutChar = 1; + VFS_Write(giDebug_KTerm, len, Str); + gbInPutChar = 0; + } } -static void E9_Str(char *Str) +void Debug_DbgOnlyFmt(const char *format, va_list args) { - while(*Str) E9(*Str++); + Debug_Fmt(0, format, args); } -void E9_Fmt(const char *format, va_list *args) +void Debug_Fmt(int bUseKTerm, const char *format, va_list args) { - char c, pad = ' '; - int minSize = 0; - char tmpBuf[34]; // For Integers - char *p = NULL; - int isLongLong = 0; - Uint64 arg; - - while((c = *format++) != 0) - { - // Non control character - if( c != '%' ) { - E9(c); - continue; - } - - c = *format++; - - // Literal % - if(c == '%') { - E9('%'); - continue; - } - - // Pointer - if(c == 'p') { - Uint ptr = va_arg(*args, Uint); - E9('*'); E9('0'); E9('x'); - p = tmpBuf; - itoa(p, ptr, 16, BITS/4, '0'); - goto printString; - } - - // Get Argument - arg = va_arg(*args, Uint); - - // Padding - if(c == '0') { - pad = '0'; - c = *format++; - } else - pad = ' '; - - // Minimum length - minSize = 1; - if('1' <= c && c <= '9') - { - minSize = 0; - while('0' <= c && c <= '9') - { - minSize *= 10; - minSize += c - '0'; - c = *format++; - } - } - - // Long (default) - isLongLong = 0; - if(c == 'l') { - c = *format++; - if(c == 'l') { - #if BITS == 32 - arg |= va_arg(*args, Uint); - #endif - c = *format++; - isLongLong = 1; - } - } - - p = tmpBuf; - switch (c) { - case 'd': - case 'i': - if( (isLongLong && arg >> 63) || (!isLongLong && arg >> 31) ) { - E9('-'); - arg = -arg; - } - itoa(p, arg, 10, minSize, pad); - goto printString; - case 'u': - itoa(p, arg, 10, minSize, pad); - goto printString; - case 'x': - itoa(p, arg, 16, minSize, pad); - goto printString; - case 'o': - itoa(p, arg, 8, minSize, pad); - goto printString; - case 'b': - itoa(p, arg, 2, minSize, pad); - goto printString; - - case 'B': //Boolean - if(arg) E9_Str("True"); - else E9_Str("False"); - break; - - case 's': - p = (char*)(Uint)arg; - printString: - if(!p) p = "(null)"; - while(*p) E9(*p++); - break; - - // Single Character / Array - case 'c': - if(minSize == 1) { - E9(arg); - break; - } - p = (char*)(Uint)arg; - if(!p) goto printString; - while(minSize--) E9(*p++); - break; - - default: E9(arg); break; - } - } + char buf[DEBUG_MAX_LINE_LEN]; + int len; + buf[DEBUG_MAX_LINE_LEN-1] = 0; + len = vsnprintf(buf, DEBUG_MAX_LINE_LEN-1, format, args); + //if( len < DEBUG_MAX_LINE ) + // do something + Debug_Puts(bUseKTerm, buf); + return ; } -/** - * \fn void LogV(char *Fmt, va_list Args) - */ -void LogV(char *Fmt, va_list Args) +void Debug_FmtS(int bUseKTerm, const char *format, ...) +{ + va_list args; + va_start(args, format); + Debug_Fmt(bUseKTerm, format, args); + va_end(args); +} + +void Debug_KernelPanic(void) { - E9_Str("Log: "); - E9_Fmt(Fmt, &Args); - E9('\n'); + #if LOCK_DEBUG_OUTPUT + SHORTREL(&glDebug_Lock); + #endif + gbDebug_IsKPanic = 1; + KernelPanic_SetMode(); } + /** - * \fn void LogF(char *Msg, ...) + * \fn void LogF(const char *Msg, ...) + * \brief Raw debug log (no new line, no prefix) */ -void LogF(char *Fmt, ...) +void LogF(const char *Fmt, ...) { va_list args; + + #if LOCK_DEBUG_OUTPUT + SHORTLOCK(&glDebug_Lock); + #endif va_start(args, Fmt); + + Debug_Fmt(1, Fmt, args); + + va_end(args); - E9_Fmt(Fmt, &args); + #if LOCK_DEBUG_OUTPUT + SHORTREL(&glDebug_Lock); + #endif +} +/** + * \fn void Debug(const char *Msg, ...) + * \brief Print only to the debug channel (not KTerm) + */ +void Debug(const char *Fmt, ...) +{ + va_list args; + #if LOCK_DEBUG_OUTPUT + SHORTLOCK(&glDebug_Lock); + #endif + + Debug_Puts(0, "Debug: "); + va_start(args, Fmt); + Debug_DbgOnlyFmt(Fmt, args); va_end(args); + Debug_PutCharDebug('\r'); + Debug_PutCharDebug('\n'); + #if LOCK_DEBUG_OUTPUT + SHORTREL(&glDebug_Lock); + #endif } /** - * \fn void Log(char *Msg, ...) + * \fn void Log(const char *Msg, ...) */ -void Log(char *Fmt, ...) +void Log(const char *Fmt, ...) { va_list args; - E9_Str("Log: "); + #if LOCK_DEBUG_OUTPUT + SHORTLOCK(&glDebug_Lock); + #endif + + Debug_Puts(1, "Log: "); va_start(args, Fmt); - E9_Fmt(Fmt, &args); + Debug_Fmt(1, Fmt, args); va_end(args); - E9('\n'); + Debug_Puts(1, "\r\n"); + + #if LOCK_DEBUG_OUTPUT + SHORTREL(&glDebug_Lock); + #endif } -void Warning(char *Fmt, ...) +void Warning(const char *Fmt, ...) { va_list args; - E9_Str("Warning: "); + + #if LOCK_DEBUG_OUTPUT + SHORTLOCK(&glDebug_Lock); + #endif + + Debug_Puts(1, "Warning: "); va_start(args, Fmt); - E9_Fmt(Fmt, &args); + Debug_Fmt(1, Fmt, args); va_end(args); - E9('\n'); + Debug_Putchar('\r'); + Debug_Putchar('\n'); + + #if LOCK_DEBUG_OUTPUT + SHORTREL(&glDebug_Lock); + #endif } -void Panic(char *Fmt, ...) +void Panic(const char *Fmt, ...) { va_list args; - E9_Str("Panic: "); + + #if LOCK_DEBUG_OUTPUT + SHORTLOCK(&glDebug_Lock); + #endif + // And never SHORTREL + + Debug_KernelPanic(); + + Debug_Puts(1, "Panic: "); va_start(args, Fmt); - E9_Fmt(Fmt, &args); + Debug_Fmt(1, Fmt, args); va_end(args); - E9('\n'); - + Debug_Putchar('\r'); + Debug_Putchar('\n'); + Threads_Dump(); - - __asm__ __volatile__ ("xchg %bx, %bx"); - __asm__ __volatile__ ("cli;\n\thlt"); - for(;;) __asm__ __volatile__ ("hlt"); + + for(;;) ; } -void Debug_SetKTerminal(char *File) +void Debug_SetKTerminal(const char *File) { - if(giDebug_KTerm != -1) - VFS_Close(giDebug_KTerm); - giDebug_KTerm = VFS_Open(File, VFS_OPENFLAG_WRITE); - Log("Opened '%s' as 0x%x", File, giDebug_KTerm); + int tmp; + if(giDebug_KTerm != -1) { + tmp = giDebug_KTerm; + giDebug_KTerm = -1; + VFS_Close(tmp); + } + tmp = VFS_Open(File, VFS_OPENFLAG_WRITE); +// Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp); + giDebug_KTerm = tmp; +// Log_Log("Debug", "Returning to %p", __builtin_return_address(0)); } -void Debug_Enter(char *FuncName, char *ArgTypes, ...) +void Debug_Enter(const char *FuncName, const char *ArgTypes, ...) { va_list args; - int i = gDebug_Level ++; + int i; int pos; - + tTID tid = Threads_GetTID(); + + #if LOCK_DEBUG_OUTPUT + SHORTLOCK(&glDebug_Lock); + #endif + + i = gDebug_Level ++; + va_start(args, ArgTypes); - - while(i--) E9(' '); - - E9_Str(FuncName); E9_Str(": ("); - + + Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now()); + while(i--) Debug_Puts(TRACE_TO_KTERM, " "); + + Debug_Puts(TRACE_TO_KTERM, FuncName); + Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid); + Debug_Puts(TRACE_TO_KTERM, ": ("); + while(*ArgTypes) { pos = strpos(ArgTypes, ' '); - if(pos != -1) ArgTypes[pos] = '\0'; if(pos == -1 || pos > 1) { - E9_Str(ArgTypes+1); - E9('='); + if(pos == -1) + Debug_Puts(TRACE_TO_KTERM, ArgTypes+1); + else { + Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1); + } + Debug_Puts(TRACE_TO_KTERM, "="); } - if(pos != -1) ArgTypes[pos] = ' '; switch(*ArgTypes) { - case 'p': E9_Fmt("%p", &args); break; - case 's': E9_Fmt("'%s'", &args); break; - case 'i': E9_Fmt("%i", &args); break; - case 'u': E9_Fmt("%u", &args); break; - case 'x': E9_Fmt("0x%x", &args); break; - case 'b': E9_Fmt("0b%b", &args); break; - // Extended (64-Bit) - case 'X': E9_Fmt("0x%llx", &args); break; - case 'B': E9_Fmt("0b%llb", &args); break; + case 'p': Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*)); break; + case 'P': Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break; + case 's': Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*)); break; + case 'i': Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int)); break; + case 'u': Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint)); break; + case 'x': Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break; + case 'b': Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break; + case 'X': Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64)); break; // Extended (64-Bit) + case 'B': Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64)); break; // Extended (64-Bit) } if(pos != -1) { - E9(','); E9(' '); + Debug_Puts(TRACE_TO_KTERM, ", "); } - + if(pos == -1) break; ArgTypes = &ArgTypes[pos+1]; } - + va_end(args); - E9(')'); E9('\n'); + Debug_Puts(TRACE_TO_KTERM, ")\r\n"); + + #if LOCK_DEBUG_OUTPUT + SHORTREL(&glDebug_Lock); + #endif } -void Debug_Log(char *FuncName, char *Fmt, ...) +void Debug_Log(const char *FuncName, const char *Fmt, ...) { va_list args; int i = gDebug_Level; - + tTID tid = Threads_GetTID(); + + #if LOCK_DEBUG_OUTPUT + SHORTLOCK(&glDebug_Lock); + #endif + + Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now()); + while(i--) Debug_Puts(TRACE_TO_KTERM, " "); + + Debug_Puts(TRACE_TO_KTERM, FuncName); + Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid); + Debug_Puts(TRACE_TO_KTERM, ": "); + va_start(args, Fmt); - - while(i--) E9(' '); - - E9_Str(FuncName); E9_Str(": "); - E9_Fmt(Fmt, &args); - + Debug_Fmt(TRACE_TO_KTERM, Fmt, args); va_end(args); - E9('\n'); + + Debug_Puts(TRACE_TO_KTERM, "\r\n"); + + #if LOCK_DEBUG_OUTPUT + SHORTREL(&glDebug_Lock); + #endif } -void Debug_Leave(char *FuncName, char RetType, ...) +void Debug_Leave(const char *FuncName, char RetType, ...) { va_list args; - int i = --gDebug_Level; + int i; + tTID tid = Threads_GetTID(); + + #if LOCK_DEBUG_OUTPUT + SHORTLOCK(&glDebug_Lock); + #endif + i = --gDebug_Level; + va_start(args, RetType); - + if( i == -1 ) { gDebug_Level = 0; i = 0; } + Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now()); // Indenting - while(i--) E9(' '); - - E9_Str(FuncName); E9_Str(": RETURN"); - + while(i--) Debug_Puts(TRACE_TO_KTERM, " "); + + Debug_Puts(TRACE_TO_KTERM, FuncName); + Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid); + Debug_Puts(TRACE_TO_KTERM, ": RETURN"); + // No Return if(RetType == '-') { - E9('\n'); + Debug_Puts(TRACE_TO_KTERM, "\r\n"); + #if LOCK_DEBUG_OUTPUT + SHORTREL(&glDebug_Lock); + #endif return; } - - E9(' '); + switch(RetType) { - case 'n': E9_Str("NULL"); break; - case 'p': E9_Fmt("%p", &args); break; - case 's': E9_Fmt("'%s'", &args); break; - case 'i': E9_Fmt("%i", &args); break; - case 'u': E9_Fmt("%u", &args); break; - case 'x': E9_Fmt("0x%x", &args); break; + case 'n': Debug_Puts(TRACE_TO_KTERM, " NULL"); break; + case 'p': Debug_Fmt(TRACE_TO_KTERM, " %p", args); break; + case 'P': Debug_Fmt(TRACE_TO_KTERM, " %P", args); break; // PAddr + case 's': Debug_Fmt(TRACE_TO_KTERM, " '%s'", args); break; + case 'i': Debug_Fmt(TRACE_TO_KTERM, " %i", args); break; + case 'u': Debug_Fmt(TRACE_TO_KTERM, " %u", args); break; + case 'x': Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args); break; // Extended (64-Bit) - case 'X': E9_Fmt("0x%llx", &args); break; + case 'X': Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args); break; } - E9('\n'); - + Debug_Puts(TRACE_TO_KTERM, "\r\n"); + va_end(args); + + #if LOCK_DEBUG_OUTPUT + SHORTREL(&glDebug_Lock); + #endif } -void Debug_HexDump(char *Header, void *Data, Uint Length) +void Debug_HexDump(const char *Header, const void *Data, Uint Length) { - Uint8 *cdat = Data; + const Uint8 *cdat = Data; Uint pos = 0; - E9_Str(Header); - LogF(" (Hexdump of %p)\n", Data); - + LogF("%014lli ", now()); + Debug_Puts(1, Header); + LogF(" (Hexdump of %p)\r\n", Data); + + #define CH(n) ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.') + while(Length >= 16) { - Log("%04x: %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x", + LogF("%014lli Log: %04x:" + " %02x %02x %02x %02x %02x %02x %02x %02x" + " %02x %02x %02x %02x %02x %02x %02x %02x" + " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n", + now(), pos, - cdat[0], cdat[1], cdat[2], cdat[3], cdat[4], cdat[5], cdat[6], cdat[7], - cdat[8], cdat[9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15] + cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7], + cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15], + CH(0), CH(1), CH(2), CH(3), CH(4), CH(5), CH(6), CH(7), + CH(8), CH(9), CH(10), CH(11), CH(12), CH(13), CH(14), CH(15) ); Length -= 16; cdat += 16; pos += 16; } - - LogF("Log: %04x: ", pos); - while(Length) + { - Uint byte = *cdat; - LogF("%02x ", byte); - Length--; - cdat ++; + int i ; + LogF("%014lli Log: %04x: ", now(), pos); + for(i = 0; i < Length; i ++) + { + LogF("%02x ", cdat[i]); + } + for( ; i < 16; i ++) LogF(" "); + LogF(" "); + for(i = 0; i < Length; i ++) + { + if( i == 8 ) LogF(" "); + LogF("%c", CH(i)); + } + + Debug_Putchar('\r'); + Debug_Putchar('\n'); } - E9('\n'); } // --- EXPORTS --- +EXPORT(Debug); EXPORT(Log); EXPORT(Warning); EXPORT(Debug_Enter);