Replace rand() implementation - fixes threading lockups
[tpg/acess2.git] / Kernel / debug.c
index ac9d617..ce87d9d 100644 (file)
@@ -1,6 +1,8 @@
 /*
  * AcessOS Microkernel Version
  * debug.c
+ * 
+ * TODO: Move the Debug_putchar methods out to the arch/ tree
  */
 #include <acess.h>
 #include <stdarg.h>
 #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
 
 // === IMPORTS ===
 extern void Threads_Dump(void);
 extern void    KernelPanic_SetMode(void);
 extern void    KernelPanic_PutChar(char Ch);
 
+// === PROTOTYPES ===
+ int   putDebugChar(char ch);
+ int   getDebugChar(void);
+static void    Debug_Putchar(char ch);
+static void    Debug_Puts(int DbgOnly, char *Str);
+void   Debug_Fmt(const char *format, va_list args);
+
 // === 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)
@@ -28,9 +44,9 @@ 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 + 0, 0x0C);    // Set divisor to 12 (lo byte) 9600 baud
+               outb(GDB_SERIAL_PORT + 1, 0x00);    //  (base is         (hi byte)
+               outb(GDB_SERIAL_PORT + 3, 0x03);    // 8 bits, no parity, one stop bit (8N1)
                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;
@@ -39,13 +55,13 @@ int putDebugChar(char ch)
        outb(GDB_SERIAL_PORT, ch);
        return 0;
 }
-int getDebugChar()
+int getDebugChar(void)
 {
        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 + 0, 0x0C);    // Set divisor to 12 (lo byte) 9600 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
@@ -55,9 +71,7 @@ int getDebugChar()
        return inb(GDB_SERIAL_PORT);
 }
 
-volatile int   gbInPutChar = 0;
-
-static void Debug_Putchar(char ch)
+static void Debug_PutCharDebug(char ch)
 {
        #if DEBUG_TO_E9
        __asm__ __volatile__ ( "outb %%al, $0xe9" :: "a"(((Uint8)ch)) );
@@ -67,8 +81,8 @@ static void Debug_Putchar(char ch)
        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 + 0, 0x0C);    // Set divisor to 12 (lo byte) 9600 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
@@ -77,7 +91,11 @@ static void Debug_Putchar(char ch)
        while( (inb(SERIAL_PORT + 5) & 0x20) == 0 );
        outb(SERIAL_PORT, ch);
        #endif
-       
+}
+
+static void Debug_Putchar(char ch)
+{      
+       Debug_PutCharDebug(ch);
        if( !gbDebug_IsKPanic )
        {
                if(gbInPutChar) return ;
@@ -90,146 +108,59 @@ static void Debug_Putchar(char ch)
                KernelPanic_PutChar(ch);
 }
 
-static void Debug_Puts(char *Str)
+static void Debug_Puts(int UseKTerm, char *Str)
 {
-       while(*Str)     Debug_Putchar(*Str++);
+        int    len = 0;
+       while( *Str )
+       {
+               Debug_PutCharDebug( *Str );
+               
+               if( gbDebug_IsKPanic )
+                       KernelPanic_PutChar(*Str);
+               len ++;
+               Str ++;
+       }
+       
+       Str -= len;
+       
+       if( UseKTerm && !gbDebug_IsKPanic && giDebug_KTerm != -1)
+       {
+               if(gbInPutChar) return ;
+               gbInPutChar = 1;
+               VFS_Write(giDebug_KTerm, len, Str);
+               gbInPutChar = 0;
+       }
 }
 
-void Debug_Fmt(const char *format, va_list *args)
+void Debug_DbgOnlyFmt(const char *format, va_list args)
 {
-       char    c, pad = ' ';
-        int    minSize = 0, len;
-       char    tmpBuf[34];     // For Integers
-       char    *p = NULL;
-        int    isLongLong = 0;
-       Uint64  arg;
-        int    bPadLeft = 0;
-
-       while((c = *format++) != 0)
-       {
-               // Non control character
-               if( c != '%' ) {
-                       Debug_Putchar(c);
-                       continue;
-               }
-
-               c = *format++;
-
-               // Literal %
-               if(c == '%') {
-                       Debug_Putchar('%');
-                       continue;
-               }
-
-               // Pointer
-               if(c == 'p') {
-                       Uint    ptr = va_arg(*args, Uint);
-                       Debug_Putchar('*');     Debug_Putchar('0');     Debug_Putchar('x');
-                       p = tmpBuf;
-                       itoa(p, ptr, 16, BITS/4, '0');
-                       goto printString;
-               }
-
-               // Get Argument
-               arg = va_arg(*args, Uint);
-
-               // - Padding Side Flag
-               if(c == '+') {
-                       bPadLeft = 1;
-                       c = *format++;
-               }
-
-               // 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++;
-                       }
-               }
+       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(0, buf);
+}
 
-               // 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;
-                       }
-               }
+void Debug_Fmt(const char *format, va_list args)
+{
+       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(1, buf);
+       return ;
+}
 
-               p = tmpBuf;
-               switch (c) {
-               case 'd':
-               case 'i':
-                       if( (isLongLong && arg >> 63) || (!isLongLong && arg >> 31) ) {
-                               Debug_Putchar('-');
-                               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;
-
-               printString:
-                       if(!p)          p = "(null)";
-                       while(*p)       Debug_Putchar(*p++);
-                       break;
-
-               case 'B':       //Boolean
-                       if(arg) Debug_Puts("True");
-                       else    Debug_Puts("False");
-                       break;
-
-               case 's':
-                       p = (char*)(Uint)arg;
-                       if(!p)          p = "(null)";
-                       len = strlen(p);
-                       if( !bPadLeft ) while(len++ < minSize)  Debug_Putchar(pad);
-                       while(*p)       Debug_Putchar(*p++);
-                       if( bPadLeft )  while(len++ < minSize)  Debug_Putchar(pad);
-                       break;
-
-               // Single Character / Array
-               case 'c':
-                       if(minSize == 1) {
-                               Debug_Putchar(arg);
-                               break;
-                       }
-                       p = (char*)(Uint)arg;
-                       if(!p)  goto printString;
-                       while(minSize--)        Debug_Putchar(*p++);
-                       break;
-
-               default:
-                       Debug_Putchar(arg);
-                       break;
-               }
-    }
+void Debug_FmtS(const char *format, ...)
+{
+       va_list args;   
+       va_start(args, format);
+       Debug_Fmt(format, args);
+       va_end(args);
 }
 
 void Debug_KernelPanic()
@@ -245,11 +176,41 @@ void LogF(char *Fmt, ...)
 {
        va_list args;
 
+       #if LOCK_DEBUG_OUTPUT
+       SHORTLOCK(&glDebug_Lock);
+       #endif
+       
        va_start(args, Fmt);
 
-       Debug_Fmt(Fmt, &args);
+       Debug_Fmt(Fmt, args);
 
        va_end(args);
+       
+       #if LOCK_DEBUG_OUTPUT
+       SHORTREL(&glDebug_Lock);
+       #endif
+}
+/**
+ * \fn void Debug(char *Msg, ...)
+ * \brief Print only to the debug channel
+ */
+void Debug(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, ...)
@@ -257,32 +218,57 @@ void LogF(char *Fmt, ...)
 void Log(char *Fmt, ...)
 {
        va_list args;
+       
+       #if LOCK_DEBUG_OUTPUT
+       SHORTLOCK(&glDebug_Lock);
+       #endif
 
-       Debug_Puts("Log: ");
+       Debug_Puts(1, "Log: ");
        va_start(args, Fmt);
-       Debug_Fmt(Fmt, &args);
+       Debug_Fmt(Fmt, args);
        va_end(args);
+       Debug_Putchar('\r');
        Debug_Putchar('\n');
+       
+       #if LOCK_DEBUG_OUTPUT
+       SHORTREL(&glDebug_Lock);
+       #endif
 }
 void Warning(char *Fmt, ...)
 {
        va_list args;
-       Debug_Puts("Warning: ");
+       
+       #if LOCK_DEBUG_OUTPUT
+       SHORTLOCK(&glDebug_Lock);
+       #endif
+       
+       Debug_Puts(1, "Warning: ");
        va_start(args, Fmt);
-       Debug_Fmt(Fmt, &args);
+       Debug_Fmt(Fmt, args);
        va_end(args);
+       Debug_Putchar('\r');
        Debug_Putchar('\n');
+       
+       #if LOCK_DEBUG_OUTPUT
+       SHORTREL(&glDebug_Lock);
+       #endif
 }
 void Panic(char *Fmt, ...)
 {
        va_list args;
        
+       #if LOCK_DEBUG_OUTPUT
+       SHORTLOCK(&glDebug_Lock);
+       #endif
+       // And never SHORTREL
+       
        Debug_KernelPanic();
        
-       Debug_Puts("Panic: ");
+       Debug_Puts(1, "Panic: ");
        va_start(args, Fmt);
-       Debug_Fmt(Fmt, &args);
+       Debug_Fmt(Fmt, args);
        va_end(args);
+       Debug_Putchar('\r');
        Debug_Putchar('\n');
 
        Threads_Dump();
@@ -309,35 +295,43 @@ void Debug_SetKTerminal(char *File)
 void Debug_Enter(char *FuncName, 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--)      Debug_Putchar(' ');
 
-       Debug_Puts(FuncName);   Debug_Puts(": (");
+       Debug_Puts(1, FuncName);
+       Debug_FmtS("[%i]", tid);
+       Debug_Puts(1, ": (");
 
        while(*ArgTypes)
        {
                pos = strpos(ArgTypes, ' ');
                if(pos != -1)   ArgTypes[pos] = '\0';
                if(pos == -1 || pos > 1) {
-                       Debug_Puts(ArgTypes+1);
+                       Debug_Puts(1, ArgTypes+1);
                        Debug_Putchar('=');
                }
                if(pos != -1)   ArgTypes[pos] = ' ';
                switch(*ArgTypes)
                {
-               case 'p':       Debug_Fmt("%p", &args); break;
-               case 's':       Debug_Fmt("'%s'", &args);       break;
-               case 'i':       Debug_Fmt("%i", &args); break;
-               case 'u':       Debug_Fmt("%u", &args); break;
-               case 'x':       Debug_Fmt("0x%x", &args);       break;
-               case 'b':       Debug_Fmt("0b%b", &args);       break;
-               // Extended (64-Bit)
-               case 'X':       Debug_Fmt("0x%llx", &args);     break;
-               case 'B':       Debug_Fmt("0b%llb", &args);     break;
+               case 'p':       LogF("%p", va_arg(args, void*));        break;
+               case 's':       LogF("'%s'", va_arg(args, char*));      break;
+               case 'i':       LogF("%i", va_arg(args, int));  break;
+               case 'u':       LogF("%u", va_arg(args, Uint)); break;
+               case 'x':       LogF("0x%x", va_arg(args, Uint));       break;
+               case 'b':       LogF("0b%b", va_arg(args, Uint));       break;
+               case 'X':       LogF("0x%llx", va_arg(args, Uint64));   break;  // Extended (64-Bit)
+               case 'B':       LogF("0b%llb", va_arg(args, Uint64));   break;  // Extended (64-Bit)
                }
                if(pos != -1) {
                        Debug_Putchar(',');     Debug_Putchar(' ');
@@ -348,29 +342,52 @@ void Debug_Enter(char *FuncName, char *ArgTypes, ...)
        }
 
        va_end(args);
-       Debug_Putchar(')');     Debug_Putchar('\n');
+       Debug_Putchar(')');     Debug_Putchar('\r');    Debug_Putchar('\n');
+       
+       #if LOCK_DEBUG_OUTPUT
+       SHORTREL(&glDebug_Lock);
+       #endif
 }
 
 void Debug_Log(char *FuncName, char *Fmt, ...)
 {
        va_list args;
         int    i = gDebug_Level;
+       tTID    tid = Threads_GetTID();
+
+       #if LOCK_DEBUG_OUTPUT
+       SHORTLOCK(&glDebug_Lock);
+       #endif
 
        va_start(args, Fmt);
 
        while(i--)      Debug_Putchar(' ');
 
-       Debug_Puts(FuncName);   Debug_Puts(": ");
-       Debug_Fmt(Fmt, &args);
+       Debug_Puts(1, FuncName);
+       Debug_FmtS("[%i]", tid);
+       Debug_Puts(1, ": ");
+       Debug_Fmt(Fmt, args);
 
        va_end(args);
+       Debug_Putchar('\r');
        Debug_Putchar('\n');
+       
+       #if LOCK_DEBUG_OUTPUT
+       SHORTREL(&glDebug_Lock);
+       #endif
 }
 
 void Debug_Leave(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);
 
@@ -381,41 +398,53 @@ void Debug_Leave(char *FuncName, char RetType, ...)
        // Indenting
        while(i--)      Debug_Putchar(' ');
 
-       Debug_Puts(FuncName);   Debug_Puts(": RETURN");
+       Debug_Puts(1, FuncName);
+       Debug_FmtS("(%i)", tid);
+       Debug_Puts(1, ": RETURN");
 
        // No Return
        if(RetType == '-') {
+               Debug_Putchar('\r');
                Debug_Putchar('\n');
+               #if LOCK_DEBUG_OUTPUT
+               SHORTREL(&glDebug_Lock);
+               #endif
                return;
        }
 
        Debug_Putchar(' ');
        switch(RetType)
        {
-       case 'n':       Debug_Puts("NULL");     break;
-       case 'p':       Debug_Fmt("%p", &args); break;
-       case 's':       Debug_Fmt("'%s'", &args);       break;
-       case 'i':       Debug_Fmt("%i", &args); break;
-       case 'u':       Debug_Fmt("%u", &args); break;
-       case 'x':       Debug_Fmt("0x%x", &args);       break;
+       case 'n':       Debug_Puts(1, "NULL");  break;
+       case 'p':       Debug_Fmt("%p", args);  break;
+       case 's':       Debug_Fmt("'%s'", args);        break;
+       case 'i':       Debug_Fmt("%i", args);  break;
+       case 'u':       Debug_Fmt("%u", args);  break;
+       case 'x':       Debug_Fmt("0x%x", args);        break;
        // Extended (64-Bit)
-       case 'X':       Debug_Fmt("0x%llx", &args);     break;
+       case 'X':       Debug_Fmt("0x%llx", args);      break;
        }
+       Debug_Putchar('\r');
        Debug_Putchar('\n');
 
        va_end(args);
+       
+       #if LOCK_DEBUG_OUTPUT
+       SHORTREL(&glDebug_Lock);
+       #endif
 }
 
 void Debug_HexDump(char *Header, void *Data, Uint Length)
 {
        Uint8   *cdat = Data;
        Uint    pos = 0;
-       Debug_Puts(Header);
-       LogF(" (Hexdump of %p)\n", Data);
+       Debug_Puts(1, Header);
+       LogF(" (Hexdump of %p)\r\n", Data);
+
+       #define CH(n)   ((' '<=cdat[(n)]&&cdat[(n)]<=0x7F) ? cdat[(n)] : '.')
 
        while(Length >= 16)
        {
-               #define CH(n)   ((' '<=cdat[(n)]&&cdat[(n)]<=0x7F) ? cdat[(n)] : '.')
                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",
@@ -430,18 +459,28 @@ void Debug_HexDump(char *Header, void *Data, Uint Length)
                pos += 16;
        }
 
-       LogF("Log: %04x: ", pos);
-       while(Length)
        {
-               Uint    byte = *cdat;
-               LogF("%02x ", byte);
-               Length--;
-               cdat ++;
+                int    i ;
+               LogF("Log: %04x: ", 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');
 }
 
 // --- EXPORTS ---
+EXPORT(Debug);
 EXPORT(Log);
 EXPORT(Warning);
 EXPORT(Debug_Enter);

UCC git Repository :: git.ucc.asn.au