2 * AcessOS Microkernel Version
8 #define DEBUG_MAX_LINE_LEN 256
9 #define LOCK_DEBUG_OUTPUT 1 // Avoid interleaving of output lines?
10 #define TRACE_TO_KTERM 0 // Send ENTER/DEBUG/LEAVE to debug?
13 extern void Threads_Dump(void);
14 extern void Heap_Dump(void);
15 extern void KernelPanic_SetMode(void);
16 extern void KernelPanic_PutChar(char Ch);
17 extern void IPStack_SendDebugText(const char *Text);
20 static void Debug_Putchar(char ch);
21 static void Debug_Puts(int bUseKTerm, const char *Str);
22 void Debug_DbgOnlyFmt(const char *format, va_list args);
23 void Debug_FmtS(int bUseKTerm, const char *format, ...);
24 void Debug_Fmt(int bUseKTerm, const char *format, va_list args);
25 void Debug_SetKTerminal(const char *File);
29 int giDebug_KTerm = -1;
30 int gbDebug_IsKPanic = 0;
31 volatile int gbInPutChar = 0;
33 tShortSpinlock glDebug_Lock;
35 // - Disabled because it breaks shit
36 int gbSendNetworkDebug = 0;
39 static void Debug_Putchar(char ch)
41 Debug_PutCharDebug(ch);
43 if( gbDebug_IsKPanic )
44 KernelPanic_PutChar(ch);
46 if( gbDebug_IsKPanic < 2 )
48 if(gbInPutChar) return ;
50 if(giDebug_KTerm != -1)
51 VFS_Write(giDebug_KTerm, 1, &ch);
55 if( gbSendNetworkDebug )
57 char str[2] = {ch, 0};
58 IPStack_SendDebugText(str);
62 static void Debug_Puts(int UseKTerm, const char *Str)
66 Debug_PutStringDebug(Str);
68 if( gbDebug_IsKPanic )
70 for( len = 0; Str[len]; len ++ )
71 KernelPanic_PutChar( Str[len] );
74 for( len = 0; Str[len]; len ++ );
76 if( gbSendNetworkDebug )
77 IPStack_SendDebugText(Str);
79 // Output to the kernel terminal
80 if( UseKTerm && gbDebug_IsKPanic < 2 && giDebug_KTerm != -1)
82 if(gbInPutChar) return ;
84 VFS_Write(giDebug_KTerm, len, Str);
89 void Debug_DbgOnlyFmt(const char *format, va_list args)
91 Debug_Fmt(0, format, args);
94 void Debug_Fmt(int bUseKTerm, const char *format, va_list args)
96 char buf[DEBUG_MAX_LINE_LEN];
98 buf[DEBUG_MAX_LINE_LEN-1] = 0;
99 /*len = */vsnprintf(buf, DEBUG_MAX_LINE_LEN-1, format, args);
100 //if( len < DEBUG_MAX_LINE )
102 Debug_Puts(bUseKTerm, buf);
106 void Debug_FmtS(int bUseKTerm, const char *format, ...)
109 va_start(args, format);
110 Debug_Fmt(bUseKTerm, format, args);
114 void Debug_KernelPanic(void)
116 #if LOCK_DEBUG_OUTPUT
117 SHORTREL(&glDebug_Lock);
120 KernelPanic_SetMode();
124 * \fn void LogF(const char *Msg, ...)
125 * \brief Raw debug log (no new line, no prefix)
127 void LogF(const char *Fmt, ...)
131 #if LOCK_DEBUG_OUTPUT
132 SHORTLOCK(&glDebug_Lock);
137 Debug_Fmt(1, Fmt, args);
141 #if LOCK_DEBUG_OUTPUT
142 SHORTREL(&glDebug_Lock);
146 * \fn void Debug(const char *Msg, ...)
147 * \brief Print only to the debug channel (not KTerm)
149 void Debug(const char *Fmt, ...)
153 #if LOCK_DEBUG_OUTPUT
154 if(!CPU_HAS_LOCK(&glDebug_Lock)) SHORTLOCK(&glDebug_Lock);
157 Debug_Puts(0, "Debug: ");
159 Debug_DbgOnlyFmt(Fmt, args);
161 Debug_PutCharDebug('\r');
162 Debug_PutCharDebug('\n');
163 #if LOCK_DEBUG_OUTPUT
164 SHORTREL(&glDebug_Lock);
169 void LogFV(const char *Fmt, va_list args)
171 #if LOCK_DEBUG_OUTPUT
172 SHORTLOCK(&glDebug_Lock);
175 Debug_Fmt(1, Fmt, args);
177 #if LOCK_DEBUG_OUTPUT
178 SHORTREL(&glDebug_Lock);
182 void LogV(const char *Fmt, va_list args)
184 #if LOCK_DEBUG_OUTPUT
185 SHORTLOCK(&glDebug_Lock);
188 Debug_Puts(1, "Log: ");
189 Debug_Fmt(1, Fmt, args);
190 Debug_Puts(1, "\r\n");
192 #if LOCK_DEBUG_OUTPUT
193 SHORTREL(&glDebug_Lock);
198 * \fn void Log(const char *Msg, ...)
200 void Log(const char *Fmt, ...)
208 void Warning(const char *Fmt, ...)
212 #if LOCK_DEBUG_OUTPUT
213 SHORTLOCK(&glDebug_Lock);
216 Debug_Puts(1, "Warning: ");
218 Debug_Fmt(1, Fmt, args);
223 #if LOCK_DEBUG_OUTPUT
224 SHORTREL(&glDebug_Lock);
227 void Panic(const char *Fmt, ...)
231 #if LOCK_DEBUG_OUTPUT
232 if( !CPU_HAS_LOCK(&glDebug_Lock) )
233 SHORTLOCK(&glDebug_Lock);
235 // And never SHORTREL
239 Debug_Puts(1, "Panic: ");
241 Debug_Fmt(1, Fmt, args);
252 void Debug_SetKTerminal(const char *File)
255 if(giDebug_KTerm != -1) {
260 tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
261 // Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
263 // Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
266 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
271 tTID tid = Threads_GetTID();
273 #if LOCK_DEBUG_OUTPUT
274 SHORTLOCK(&glDebug_Lock);
279 va_start(args, ArgTypes);
281 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
282 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
284 Debug_Puts(TRACE_TO_KTERM, FuncName);
285 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
286 Debug_Puts(TRACE_TO_KTERM, ": (");
290 pos = strpos(ArgTypes, ' ');
291 if(pos == -1 || pos > 1) {
293 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
295 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
297 Debug_Puts(TRACE_TO_KTERM, "=");
301 case 'p': Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*)); break;
302 case 'P': Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
303 case 's': Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*)); break;
304 case 'i': Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int)); break;
305 case 'u': Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint)); break;
306 case 'x': Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
307 case 'b': Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
308 case 'X': Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64)); break; // Extended (64-Bit)
309 case 'B': Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64)); break; // Extended (64-Bit)
312 Debug_Puts(TRACE_TO_KTERM, ", ");
316 ArgTypes = &ArgTypes[pos+1];
320 Debug_Puts(TRACE_TO_KTERM, ")\r\n");
322 #if LOCK_DEBUG_OUTPUT
323 SHORTREL(&glDebug_Lock);
327 void Debug_Log(const char *FuncName, const char *Fmt, ...)
330 int i = gDebug_Level;
331 tTID tid = Threads_GetTID();
333 #if LOCK_DEBUG_OUTPUT
334 SHORTLOCK(&glDebug_Lock);
337 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
338 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
340 Debug_Puts(TRACE_TO_KTERM, FuncName);
341 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
342 Debug_Puts(TRACE_TO_KTERM, ": ");
345 Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
348 Debug_Puts(TRACE_TO_KTERM, "\r\n");
350 #if LOCK_DEBUG_OUTPUT
351 SHORTREL(&glDebug_Lock);
355 void Debug_Leave(const char *FuncName, char RetType, ...)
359 tTID tid = Threads_GetTID();
361 #if LOCK_DEBUG_OUTPUT
362 SHORTLOCK(&glDebug_Lock);
367 va_start(args, RetType);
373 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
375 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
377 Debug_Puts(TRACE_TO_KTERM, FuncName);
378 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
379 Debug_Puts(TRACE_TO_KTERM, ": RETURN");
383 Debug_Puts(TRACE_TO_KTERM, "\r\n");
384 #if LOCK_DEBUG_OUTPUT
385 SHORTREL(&glDebug_Lock);
392 case 'n': Debug_Puts(TRACE_TO_KTERM, " NULL"); break;
393 case 'p': Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
394 case 'P': Debug_Fmt(TRACE_TO_KTERM, " %P", args); break; // PAddr
395 case 's': Debug_Fmt(TRACE_TO_KTERM, " '%s'", args); break;
396 case 'i': Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
397 case 'u': Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
398 case 'x': Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args); break;
400 case 'X': Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args); break;
402 Debug_Puts(TRACE_TO_KTERM, "\r\n");
406 #if LOCK_DEBUG_OUTPUT
407 SHORTREL(&glDebug_Lock);
411 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
413 const Uint8 *cdat = Data;
415 LogF("%014lli ", now());
416 Debug_Puts(1, Header);
417 LogF(" (Hexdump of %p)\r\n", Data);
419 #define CH(n) ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
423 LogF("%014lli Log: %04x:"
424 " %02x %02x %02x %02x %02x %02x %02x %02x"
425 " %02x %02x %02x %02x %02x %02x %02x %02x"
426 " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
429 cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
430 cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
431 CH(0), CH(1), CH(2), CH(3), CH(4), CH(5), CH(6), CH(7),
432 CH(8), CH(9), CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
441 LogF("%014lli Log: %04x: ", now(), pos);
442 for(i = 0; i < Length; i ++)
444 LogF("%02x ", cdat[i]);
446 for( ; i < 16; i ++) LogF(" ");
448 for(i = 0; i < Length; i ++)
450 if( i == 8 ) LogF(" ");