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 1 // 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];
97 buf[DEBUG_MAX_LINE_LEN-1] = 0;
98 int len = vsnprintf(buf, DEBUG_MAX_LINE_LEN-1, format, args);
99 Debug_Puts(bUseKTerm, buf);
100 if( len > DEBUG_MAX_LINE_LEN-1 ) {
102 Debug_Puts(bUseKTerm, "[...]");
107 void Debug_FmtS(int bUseKTerm, const char *format, ...)
110 va_start(args, format);
111 Debug_Fmt(bUseKTerm, format, args);
115 void Debug_KernelPanic(void)
117 if( !gbDebug_IsKPanic )
119 #if LOCK_DEBUG_OUTPUT
120 SHORTREL(&glDebug_Lock);
124 // 5 nested panics? Fuck it
125 if( gbDebug_IsKPanic > 5 )
128 KernelPanic_SetMode();
132 * \fn void LogF(const char *Msg, ...)
133 * \brief Raw debug log (no new line, no prefix)
135 void LogF(const char *Fmt, ...)
139 #if LOCK_DEBUG_OUTPUT
140 SHORTLOCK(&glDebug_Lock);
145 Debug_Fmt(1, Fmt, args);
149 #if LOCK_DEBUG_OUTPUT
150 SHORTREL(&glDebug_Lock);
154 * \fn void Debug(const char *Msg, ...)
155 * \brief Print only to the debug channel (not KTerm)
157 void Debug(const char *Fmt, ...)
161 #if LOCK_DEBUG_OUTPUT
162 if(!CPU_HAS_LOCK(&glDebug_Lock)) SHORTLOCK(&glDebug_Lock);
165 Debug_Puts(0, "Debug: ");
167 Debug_DbgOnlyFmt(Fmt, args);
169 Debug_PutCharDebug('\r');
170 Debug_PutCharDebug('\n');
171 #if LOCK_DEBUG_OUTPUT
172 SHORTREL(&glDebug_Lock);
177 void LogFV(const char *Fmt, va_list args)
179 #if LOCK_DEBUG_OUTPUT
180 SHORTLOCK(&glDebug_Lock);
183 Debug_Fmt(1, Fmt, args);
185 #if LOCK_DEBUG_OUTPUT
186 SHORTREL(&glDebug_Lock);
190 void LogV(const char *Fmt, va_list args)
192 #if LOCK_DEBUG_OUTPUT
193 SHORTLOCK(&glDebug_Lock);
196 Debug_Puts(1, "Log: ");
197 Debug_Fmt(1, Fmt, args);
198 Debug_Puts(1, "\r\n");
200 #if LOCK_DEBUG_OUTPUT
201 SHORTREL(&glDebug_Lock);
206 * \fn void Log(const char *Msg, ...)
208 void Log(const char *Fmt, ...)
216 void Warning(const char *Fmt, ...)
220 #if LOCK_DEBUG_OUTPUT
221 SHORTLOCK(&glDebug_Lock);
224 Debug_Puts(1, "Warning: ");
226 Debug_Fmt(1, Fmt, args);
231 #if LOCK_DEBUG_OUTPUT
232 SHORTREL(&glDebug_Lock);
235 void Panic(const char *Fmt, ...)
239 #if LOCK_DEBUG_OUTPUT
240 if( !CPU_HAS_LOCK(&glDebug_Lock) )
241 SHORTLOCK(&glDebug_Lock);
243 // And never SHORTREL
247 Debug_Puts(1, "Panic: ");
249 Debug_Fmt(1, Fmt, args);
260 void Debug_SetKTerminal(const char *File)
263 if(giDebug_KTerm != -1) {
268 tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
269 // Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
271 // Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
274 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
279 tTID tid = Threads_GetTID();
281 #if LOCK_DEBUG_OUTPUT
282 SHORTLOCK(&glDebug_Lock);
287 va_start(args, ArgTypes);
289 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
290 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
292 Debug_Puts(TRACE_TO_KTERM, FuncName);
293 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
294 Debug_Puts(TRACE_TO_KTERM, ": (");
298 pos = strpos(ArgTypes, ' ');
299 if(pos == -1 || pos > 1) {
301 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
303 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
305 Debug_Puts(TRACE_TO_KTERM, "=");
309 case 'p': Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*)); break;
310 case 'P': Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
311 case 's': Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*)); break;
312 case 'i': Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int)); break;
313 case 'u': Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint)); break;
314 case 'x': Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
315 case 'b': Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
316 case 'X': Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64)); break; // Extended (64-Bit)
317 case 'B': Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64)); break; // Extended (64-Bit)
320 Debug_Puts(TRACE_TO_KTERM, ", ");
324 ArgTypes = &ArgTypes[pos+1];
328 Debug_Puts(TRACE_TO_KTERM, ")\r\n");
330 #if LOCK_DEBUG_OUTPUT
331 SHORTREL(&glDebug_Lock);
335 void Debug_Log(const char *FuncName, const char *Fmt, ...)
338 int i = gDebug_Level;
339 tTID tid = Threads_GetTID();
341 #if LOCK_DEBUG_OUTPUT
342 SHORTLOCK(&glDebug_Lock);
345 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
346 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
348 Debug_Puts(TRACE_TO_KTERM, FuncName);
349 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
350 Debug_Puts(TRACE_TO_KTERM, ": ");
353 Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
356 Debug_Puts(TRACE_TO_KTERM, "\r\n");
358 #if LOCK_DEBUG_OUTPUT
359 SHORTREL(&glDebug_Lock);
363 void Debug_Leave(const char *FuncName, char RetType, ...)
367 tTID tid = Threads_GetTID();
369 #if LOCK_DEBUG_OUTPUT
370 SHORTLOCK(&glDebug_Lock);
375 va_start(args, RetType);
381 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
383 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
385 Debug_Puts(TRACE_TO_KTERM, FuncName);
386 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
387 Debug_Puts(TRACE_TO_KTERM, ": RETURN");
391 Debug_Puts(TRACE_TO_KTERM, "\r\n");
392 #if LOCK_DEBUG_OUTPUT
393 SHORTREL(&glDebug_Lock);
400 case 'n': Debug_Puts(TRACE_TO_KTERM, " NULL"); break;
401 case 'p': Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
402 case 'P': Debug_Fmt(TRACE_TO_KTERM, " %P", args); break; // PAddr
403 case 's': Debug_Fmt(TRACE_TO_KTERM, " '%s'", args); break;
404 case 'i': Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
405 case 'u': Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
406 case 'x': Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args); break;
408 case 'X': Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args); break;
410 Debug_Puts(TRACE_TO_KTERM, "\r\n");
414 #if LOCK_DEBUG_OUTPUT
415 SHORTREL(&glDebug_Lock);
419 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
421 const Uint8 *cdat = Data;
423 LogF("%014lli ", now());
424 Debug_Puts(1, Header);
425 LogF(" (Hexdump of %p)\r\n", Data);
427 #define CH(n) ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
431 LogF("%014lli Log: %04x:"
432 " %02x %02x %02x %02x %02x %02x %02x %02x"
433 " %02x %02x %02x %02x %02x %02x %02x %02x"
434 " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
437 cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
438 cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
439 CH(0), CH(1), CH(2), CH(3), CH(4), CH(5), CH(6), CH(7),
440 CH(8), CH(9), CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
449 LogF("%014lli Log: %04x: ", now(), pos);
450 for(i = 0; i < Length; i ++)
452 LogF("%02x ", cdat[i]);
454 for( ; i < 16; i ++) LogF(" ");
456 for(i = 0; i < Length; i ++)
458 if( i == 8 ) LogF(" ");