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 KernelPanic_SetMode(void);
15 extern void KernelPanic_PutChar(char Ch);
16 extern void IPStack_SendDebugText(const char *Text);
19 static void Debug_Putchar(char ch);
20 static void Debug_Puts(int bUseKTerm, const char *Str);
21 void Debug_DbgOnlyFmt(const char *format, va_list args);
22 void Debug_FmtS(int bUseKTerm, const char *format, ...);
23 void Debug_Fmt(int bUseKTerm, const char *format, va_list args);
24 void Debug_SetKTerminal(const char *File);
28 int giDebug_KTerm = -1;
29 int gbDebug_IsKPanic = 0;
30 volatile int gbInPutChar = 0;
32 tShortSpinlock glDebug_Lock;
34 // - Disabled because it breaks shit
35 int gbSendNetworkDebug = 0;
38 static void Debug_Putchar(char ch)
40 Debug_PutCharDebug(ch);
42 if( gbDebug_IsKPanic )
43 KernelPanic_PutChar(ch);
45 if( gbDebug_IsKPanic < 2 )
47 if(gbInPutChar) return ;
49 if(giDebug_KTerm != -1)
50 VFS_Write(giDebug_KTerm, 1, &ch);
54 if( gbSendNetworkDebug )
56 char str[2] = {ch, 0};
57 IPStack_SendDebugText(str);
61 static void Debug_Puts(int UseKTerm, const char *Str)
65 Debug_PutStringDebug(Str);
67 if( gbDebug_IsKPanic )
69 for( len = 0; Str[len]; len ++ )
70 KernelPanic_PutChar( Str[len] );
73 for( len = 0; Str[len]; len ++ );
75 if( gbSendNetworkDebug )
76 IPStack_SendDebugText(Str);
78 // Output to the kernel terminal
79 if( UseKTerm && gbDebug_IsKPanic < 2 && giDebug_KTerm != -1)
81 if(gbInPutChar) return ;
83 VFS_Write(giDebug_KTerm, len, Str);
88 void Debug_DbgOnlyFmt(const char *format, va_list args)
90 Debug_Fmt(0, format, args);
93 void Debug_Fmt(int bUseKTerm, const char *format, va_list args)
95 char buf[DEBUG_MAX_LINE_LEN];
97 buf[DEBUG_MAX_LINE_LEN-1] = 0;
98 /*len = */vsnprintf(buf, DEBUG_MAX_LINE_LEN-1, format, args);
99 //if( len < DEBUG_MAX_LINE )
101 Debug_Puts(bUseKTerm, buf);
105 void Debug_FmtS(int bUseKTerm, const char *format, ...)
108 va_start(args, format);
109 Debug_Fmt(bUseKTerm, format, args);
113 void Debug_KernelPanic(void)
115 #if LOCK_DEBUG_OUTPUT
116 SHORTREL(&glDebug_Lock);
119 KernelPanic_SetMode();
123 * \fn void LogF(const char *Msg, ...)
124 * \brief Raw debug log (no new line, no prefix)
126 void LogF(const char *Fmt, ...)
130 #if LOCK_DEBUG_OUTPUT
131 SHORTLOCK(&glDebug_Lock);
136 Debug_Fmt(1, Fmt, args);
140 #if LOCK_DEBUG_OUTPUT
141 SHORTREL(&glDebug_Lock);
145 * \fn void Debug(const char *Msg, ...)
146 * \brief Print only to the debug channel (not KTerm)
148 void Debug(const char *Fmt, ...)
152 #if LOCK_DEBUG_OUTPUT
153 if(!CPU_HAS_LOCK(&glDebug_Lock)) SHORTLOCK(&glDebug_Lock);
156 Debug_Puts(0, "Debug: ");
158 Debug_DbgOnlyFmt(Fmt, args);
160 Debug_PutCharDebug('\r');
161 Debug_PutCharDebug('\n');
162 #if LOCK_DEBUG_OUTPUT
163 SHORTREL(&glDebug_Lock);
168 void LogFV(const char *Fmt, va_list args)
170 #if LOCK_DEBUG_OUTPUT
171 SHORTLOCK(&glDebug_Lock);
174 Debug_Fmt(1, Fmt, args);
176 #if LOCK_DEBUG_OUTPUT
177 SHORTREL(&glDebug_Lock);
181 void LogV(const char *Fmt, va_list args)
183 #if LOCK_DEBUG_OUTPUT
184 SHORTLOCK(&glDebug_Lock);
187 Debug_Puts(1, "Log: ");
188 Debug_Fmt(1, Fmt, args);
189 Debug_Puts(1, "\r\n");
191 #if LOCK_DEBUG_OUTPUT
192 SHORTREL(&glDebug_Lock);
197 * \fn void Log(const char *Msg, ...)
199 void Log(const char *Fmt, ...)
207 void Warning(const char *Fmt, ...)
211 #if LOCK_DEBUG_OUTPUT
212 SHORTLOCK(&glDebug_Lock);
215 Debug_Puts(1, "Warning: ");
217 Debug_Fmt(1, Fmt, args);
222 #if LOCK_DEBUG_OUTPUT
223 SHORTREL(&glDebug_Lock);
226 void Panic(const char *Fmt, ...)
230 #if LOCK_DEBUG_OUTPUT
231 if( !CPU_HAS_LOCK(&glDebug_Lock) )
232 SHORTLOCK(&glDebug_Lock);
234 // And never SHORTREL
238 Debug_Puts(1, "Panic: ");
240 Debug_Fmt(1, Fmt, args);
251 void Debug_SetKTerminal(const char *File)
254 if(giDebug_KTerm != -1) {
259 tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
260 // Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
262 // Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
265 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
270 tTID tid = Threads_GetTID();
272 #if LOCK_DEBUG_OUTPUT
273 SHORTLOCK(&glDebug_Lock);
278 va_start(args, ArgTypes);
280 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
281 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
283 Debug_Puts(TRACE_TO_KTERM, FuncName);
284 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
285 Debug_Puts(TRACE_TO_KTERM, ": (");
289 pos = strpos(ArgTypes, ' ');
290 if(pos == -1 || pos > 1) {
292 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
294 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
296 Debug_Puts(TRACE_TO_KTERM, "=");
300 case 'p': Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*)); break;
301 case 'P': Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
302 case 's': Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*)); break;
303 case 'i': Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int)); break;
304 case 'u': Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint)); break;
305 case 'x': Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
306 case 'b': Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
307 case 'X': Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64)); break; // Extended (64-Bit)
308 case 'B': Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64)); break; // Extended (64-Bit)
311 Debug_Puts(TRACE_TO_KTERM, ", ");
315 ArgTypes = &ArgTypes[pos+1];
319 Debug_Puts(TRACE_TO_KTERM, ")\r\n");
321 #if LOCK_DEBUG_OUTPUT
322 SHORTREL(&glDebug_Lock);
326 void Debug_Log(const char *FuncName, const char *Fmt, ...)
329 int i = gDebug_Level;
330 tTID tid = Threads_GetTID();
332 #if LOCK_DEBUG_OUTPUT
333 SHORTLOCK(&glDebug_Lock);
336 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
337 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
339 Debug_Puts(TRACE_TO_KTERM, FuncName);
340 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
341 Debug_Puts(TRACE_TO_KTERM, ": ");
344 Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
347 Debug_Puts(TRACE_TO_KTERM, "\r\n");
349 #if LOCK_DEBUG_OUTPUT
350 SHORTREL(&glDebug_Lock);
354 void Debug_Leave(const char *FuncName, char RetType, ...)
358 tTID tid = Threads_GetTID();
360 #if LOCK_DEBUG_OUTPUT
361 SHORTLOCK(&glDebug_Lock);
366 va_start(args, RetType);
372 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
374 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
376 Debug_Puts(TRACE_TO_KTERM, FuncName);
377 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
378 Debug_Puts(TRACE_TO_KTERM, ": RETURN");
382 Debug_Puts(TRACE_TO_KTERM, "\r\n");
383 #if LOCK_DEBUG_OUTPUT
384 SHORTREL(&glDebug_Lock);
391 case 'n': Debug_Puts(TRACE_TO_KTERM, " NULL"); break;
392 case 'p': Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
393 case 'P': Debug_Fmt(TRACE_TO_KTERM, " %P", args); break; // PAddr
394 case 's': Debug_Fmt(TRACE_TO_KTERM, " '%s'", args); break;
395 case 'i': Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
396 case 'u': Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
397 case 'x': Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args); break;
399 case 'X': Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args); break;
401 Debug_Puts(TRACE_TO_KTERM, "\r\n");
405 #if LOCK_DEBUG_OUTPUT
406 SHORTREL(&glDebug_Lock);
410 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
412 const Uint8 *cdat = Data;
414 LogF("%014lli ", now());
415 Debug_Puts(1, Header);
416 LogF(" (Hexdump of %p)\r\n", Data);
418 #define CH(n) ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
422 LogF("%014lli Log: %04x:"
423 " %02x %02x %02x %02x %02x %02x %02x %02x"
424 " %02x %02x %02x %02x %02x %02x %02x %02x"
425 " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
428 cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
429 cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
430 CH(0), CH(1), CH(2), CH(3), CH(4), CH(5), CH(6), CH(7),
431 CH(8), CH(9), CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
440 LogF("%014lli Log: %04x: ", now(), pos);
441 for(i = 0; i < Length; i ++)
443 LogF("%02x ", cdat[i]);
445 for( ; i < 16; i ++) LogF(" ");
447 for(i = 0; i < Length; i ++)
449 if( i == 8 ) LogF(" ");