2 * AcessOS Microkernel Version
7 #include <debug_hooks.h>
9 #define DEBUG_MAX_LINE_LEN 256
10 #define LOCK_DEBUG_OUTPUT 1 // Avoid interleaving of output lines?
11 #define TRACE_TO_KTERM 0 // Send ENTER/DEBUG/LEAVE to debug?
14 extern void KernelPanic_SetMode(void);
15 extern void KernelPanic_PutChar(char Ch);
16 extern void IPStack_SendDebugText(const char *Text);
17 extern void VT_SetTerminal(int TerminalID);
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 // 5 nested panics? Fuck it
118 if( gbDebug_IsKPanic > 5 )
121 if( gbDebug_IsKPanic == 1 )
123 #if LOCK_DEBUG_OUTPUT
124 SHORTREL(&glDebug_Lock);
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 if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
141 SHORTLOCK(&glDebug_Lock);
146 Debug_Fmt(1, Fmt, args);
150 #if LOCK_DEBUG_OUTPUT
151 SHORTREL(&glDebug_Lock);
155 * \fn void Debug(const char *Msg, ...)
156 * \brief Print only to the debug channel (not KTerm)
158 void Debug(const char *Fmt, ...)
162 #if LOCK_DEBUG_OUTPUT
163 if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
164 SHORTLOCK(&glDebug_Lock);
167 Debug_Puts(0, "Debug: ");
169 Debug_DbgOnlyFmt(Fmt, args);
171 Debug_PutCharDebug('\r');
172 Debug_PutCharDebug('\n');
173 #if LOCK_DEBUG_OUTPUT
174 SHORTREL(&glDebug_Lock);
179 void LogFV(const char *Fmt, va_list args)
181 #if LOCK_DEBUG_OUTPUT
182 if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
183 SHORTLOCK(&glDebug_Lock);
186 Debug_Fmt(1, Fmt, args);
188 #if LOCK_DEBUG_OUTPUT
189 SHORTREL(&glDebug_Lock);
193 void LogV(const char *Fmt, va_list args)
195 #if LOCK_DEBUG_OUTPUT
196 if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
197 SHORTLOCK(&glDebug_Lock);
200 Debug_Puts(1, "Log: ");
201 Debug_Fmt(1, Fmt, args);
202 Debug_Puts(1, "\r\n");
204 #if LOCK_DEBUG_OUTPUT
205 SHORTREL(&glDebug_Lock);
210 * \fn void Log(const char *Msg, ...)
212 void Log(const char *Fmt, ...)
220 void Warning(const char *Fmt, ...)
224 #if LOCK_DEBUG_OUTPUT
225 if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
226 SHORTLOCK(&glDebug_Lock);
229 Debug_Puts(1, "Warning: ");
231 Debug_Fmt(1, Fmt, args);
236 #if LOCK_DEBUG_OUTPUT
237 SHORTREL(&glDebug_Lock);
240 void Panic(const char *Fmt, ...)
244 #if LOCK_DEBUG_OUTPUT
245 if( !CPU_HAS_LOCK(&glDebug_Lock) )
246 SHORTLOCK(&glDebug_Lock);
248 // And never SHORTREL
252 Debug_Puts(1, "Panic: ");
254 Debug_Fmt(1, Fmt, args);
259 Proc_PrintBacktrace();
266 void Debug_SetKTerminal(const char *File)
269 if(giDebug_KTerm != -1) {
274 tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
275 // Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
277 // Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
280 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
285 tTID tid = Threads_GetTID();
287 #if LOCK_DEBUG_OUTPUT
288 if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
289 SHORTLOCK(&glDebug_Lock);
294 va_start(args, ArgTypes);
296 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
297 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
299 Debug_Puts(TRACE_TO_KTERM, FuncName);
300 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
301 Debug_Puts(TRACE_TO_KTERM, ": (");
305 pos = strpos(ArgTypes, ' ');
306 if(pos == -1 || pos > 1) {
308 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
310 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
312 Debug_Puts(TRACE_TO_KTERM, "=");
316 case 'p': Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*)); break;
317 case 'P': Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
318 case 's': Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*)); break;
319 case 'i': Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int)); break;
320 case 'u': Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint)); break;
321 case 'x': Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
322 case 'b': Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
323 case 'X': Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64)); break; // Extended (64-Bit)
324 case 'B': Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64)); break; // Extended (64-Bit)
327 Debug_Puts(TRACE_TO_KTERM, ", ");
331 ArgTypes = &ArgTypes[pos+1];
335 Debug_Puts(TRACE_TO_KTERM, ")\r\n");
337 #if LOCK_DEBUG_OUTPUT
338 SHORTREL(&glDebug_Lock);
342 void Debug_Log(const char *FuncName, const char *Fmt, ...)
345 int i = gDebug_Level;
346 tTID tid = Threads_GetTID();
348 #if LOCK_DEBUG_OUTPUT
349 if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
350 SHORTLOCK(&glDebug_Lock);
353 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
354 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
356 Debug_Puts(TRACE_TO_KTERM, FuncName);
357 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
358 Debug_Puts(TRACE_TO_KTERM, ": ");
361 Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
364 Debug_Puts(TRACE_TO_KTERM, "\r\n");
366 #if LOCK_DEBUG_OUTPUT
367 SHORTREL(&glDebug_Lock);
371 void Debug_Leave(const char *FuncName, char RetType, ...)
375 tTID tid = Threads_GetTID();
377 #if LOCK_DEBUG_OUTPUT
378 if(CPU_HAS_LOCK(&glDebug_Lock)) return ;
379 SHORTLOCK(&glDebug_Lock);
384 va_start(args, RetType);
390 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
392 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
394 Debug_Puts(TRACE_TO_KTERM, FuncName);
395 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
396 Debug_Puts(TRACE_TO_KTERM, ": RETURN");
400 Debug_Puts(TRACE_TO_KTERM, "\r\n");
401 #if LOCK_DEBUG_OUTPUT
402 SHORTREL(&glDebug_Lock);
409 case 'n': Debug_Puts(TRACE_TO_KTERM, " NULL"); break;
410 case 'p': Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
411 case 'P': Debug_Fmt(TRACE_TO_KTERM, " %P", args); break; // PAddr
412 case 's': Debug_Fmt(TRACE_TO_KTERM, " '%s'", args); break;
413 case 'i': Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
414 case 'u': Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
415 case 'x': Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args); break;
417 case 'X': Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args); break;
419 Debug_Puts(TRACE_TO_KTERM, "\r\n");
423 #if LOCK_DEBUG_OUTPUT
424 SHORTREL(&glDebug_Lock);
428 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
430 const Uint8 *cdat = Data;
432 LogF("%014lli ", now());
433 Debug_Puts(1, Header);
434 LogF(" (Hexdump of %p)\r\n", Data);
436 #define CH(n) ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
440 LogF("%014lli Log: %04x:"
441 " %02x %02x %02x %02x %02x %02x %02x %02x"
442 " %02x %02x %02x %02x %02x %02x %02x %02x"
443 " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
446 cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
447 cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
448 CH(0), CH(1), CH(2), CH(3), CH(4), CH(5), CH(6), CH(7),
449 CH(8), CH(9), CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
458 LogF("%014lli Log: %04x: ", now(), pos);
459 for(i = 0; i < Length; i ++)
461 LogF("%02x ", cdat[i]);
463 for( ; i < 16; i ++) LogF(" ");
465 for(i = 0; i < Length; i ++)
467 if( i == 8 ) LogF(" ");