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];
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( !gbDebug_IsKPanic )
118 #if LOCK_DEBUG_OUTPUT
119 SHORTREL(&glDebug_Lock);
123 // 5 nested panics? Fuck it
124 if( gbDebug_IsKPanic > 5 )
127 KernelPanic_SetMode();
131 * \fn void LogF(const char *Msg, ...)
132 * \brief Raw debug log (no new line, no prefix)
134 void LogF(const char *Fmt, ...)
138 #if LOCK_DEBUG_OUTPUT
139 SHORTLOCK(&glDebug_Lock);
144 Debug_Fmt(1, Fmt, args);
148 #if LOCK_DEBUG_OUTPUT
149 SHORTREL(&glDebug_Lock);
153 * \fn void Debug(const char *Msg, ...)
154 * \brief Print only to the debug channel (not KTerm)
156 void Debug(const char *Fmt, ...)
160 #if LOCK_DEBUG_OUTPUT
161 if(!CPU_HAS_LOCK(&glDebug_Lock)) SHORTLOCK(&glDebug_Lock);
164 Debug_Puts(0, "Debug: ");
166 Debug_DbgOnlyFmt(Fmt, args);
168 Debug_PutCharDebug('\r');
169 Debug_PutCharDebug('\n');
170 #if LOCK_DEBUG_OUTPUT
171 SHORTREL(&glDebug_Lock);
176 void LogFV(const char *Fmt, va_list args)
178 #if LOCK_DEBUG_OUTPUT
179 SHORTLOCK(&glDebug_Lock);
182 Debug_Fmt(1, Fmt, args);
184 #if LOCK_DEBUG_OUTPUT
185 SHORTREL(&glDebug_Lock);
189 void LogV(const char *Fmt, va_list args)
191 #if LOCK_DEBUG_OUTPUT
192 SHORTLOCK(&glDebug_Lock);
195 Debug_Puts(1, "Log: ");
196 Debug_Fmt(1, Fmt, args);
197 Debug_Puts(1, "\r\n");
199 #if LOCK_DEBUG_OUTPUT
200 SHORTREL(&glDebug_Lock);
205 * \fn void Log(const char *Msg, ...)
207 void Log(const char *Fmt, ...)
215 void Warning(const char *Fmt, ...)
219 #if LOCK_DEBUG_OUTPUT
220 SHORTLOCK(&glDebug_Lock);
223 Debug_Puts(1, "Warning: ");
225 Debug_Fmt(1, Fmt, args);
230 #if LOCK_DEBUG_OUTPUT
231 SHORTREL(&glDebug_Lock);
234 void Panic(const char *Fmt, ...)
238 #if LOCK_DEBUG_OUTPUT
239 if( !CPU_HAS_LOCK(&glDebug_Lock) )
240 SHORTLOCK(&glDebug_Lock);
242 // And never SHORTREL
246 Debug_Puts(1, "Panic: ");
248 Debug_Fmt(1, Fmt, args);
259 void Debug_SetKTerminal(const char *File)
262 if(giDebug_KTerm != -1) {
267 tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
268 // Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
270 // Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
273 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
278 tTID tid = Threads_GetTID();
280 #if LOCK_DEBUG_OUTPUT
281 SHORTLOCK(&glDebug_Lock);
286 va_start(args, ArgTypes);
288 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
289 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
291 Debug_Puts(TRACE_TO_KTERM, FuncName);
292 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
293 Debug_Puts(TRACE_TO_KTERM, ": (");
297 pos = strpos(ArgTypes, ' ');
298 if(pos == -1 || pos > 1) {
300 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
302 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
304 Debug_Puts(TRACE_TO_KTERM, "=");
308 case 'p': Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*)); break;
309 case 'P': Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
310 case 's': Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*)); break;
311 case 'i': Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int)); break;
312 case 'u': Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint)); break;
313 case 'x': Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
314 case 'b': Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
315 case 'X': Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64)); break; // Extended (64-Bit)
316 case 'B': Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64)); break; // Extended (64-Bit)
319 Debug_Puts(TRACE_TO_KTERM, ", ");
323 ArgTypes = &ArgTypes[pos+1];
327 Debug_Puts(TRACE_TO_KTERM, ")\r\n");
329 #if LOCK_DEBUG_OUTPUT
330 SHORTREL(&glDebug_Lock);
334 void Debug_Log(const char *FuncName, const char *Fmt, ...)
337 int i = gDebug_Level;
338 tTID tid = Threads_GetTID();
340 #if LOCK_DEBUG_OUTPUT
341 SHORTLOCK(&glDebug_Lock);
344 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
345 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
347 Debug_Puts(TRACE_TO_KTERM, FuncName);
348 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
349 Debug_Puts(TRACE_TO_KTERM, ": ");
352 Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
355 Debug_Puts(TRACE_TO_KTERM, "\r\n");
357 #if LOCK_DEBUG_OUTPUT
358 SHORTREL(&glDebug_Lock);
362 void Debug_Leave(const char *FuncName, char RetType, ...)
366 tTID tid = Threads_GetTID();
368 #if LOCK_DEBUG_OUTPUT
369 SHORTLOCK(&glDebug_Lock);
374 va_start(args, RetType);
380 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
382 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
384 Debug_Puts(TRACE_TO_KTERM, FuncName);
385 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
386 Debug_Puts(TRACE_TO_KTERM, ": RETURN");
390 Debug_Puts(TRACE_TO_KTERM, "\r\n");
391 #if LOCK_DEBUG_OUTPUT
392 SHORTREL(&glDebug_Lock);
399 case 'n': Debug_Puts(TRACE_TO_KTERM, " NULL"); break;
400 case 'p': Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
401 case 'P': Debug_Fmt(TRACE_TO_KTERM, " %P", args); break; // PAddr
402 case 's': Debug_Fmt(TRACE_TO_KTERM, " '%s'", args); break;
403 case 'i': Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
404 case 'u': Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
405 case 'x': Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args); break;
407 case 'X': Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args); break;
409 Debug_Puts(TRACE_TO_KTERM, "\r\n");
413 #if LOCK_DEBUG_OUTPUT
414 SHORTREL(&glDebug_Lock);
418 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
420 const Uint8 *cdat = Data;
422 LogF("%014lli ", now());
423 Debug_Puts(1, Header);
424 LogF(" (Hexdump of %p)\r\n", Data);
426 #define CH(n) ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
430 LogF("%014lli Log: %04x:"
431 " %02x %02x %02x %02x %02x %02x %02x %02x"
432 " %02x %02x %02x %02x %02x %02x %02x %02x"
433 " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
436 cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
437 cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
438 CH(0), CH(1), CH(2), CH(3), CH(4), CH(5), CH(6), CH(7),
439 CH(8), CH(9), CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
448 LogF("%014lli Log: %04x: ", now(), pos);
449 for(i = 0; i < Length; i ++)
451 LogF("%02x ", cdat[i]);
453 for( ; i < 16; i ++) LogF(" ");
455 for(i = 0; i < Length; i ++)
457 if( i == 8 ) LogF(" ");