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 )
44 if(gbInPutChar) return ;
46 if(giDebug_KTerm != -1)
47 VFS_Write(giDebug_KTerm, 1, &ch);
51 KernelPanic_PutChar(ch);
53 if( gbSendNetworkDebug )
55 char str[2] = {ch, 0};
56 IPStack_SendDebugText(str);
60 static void Debug_Puts(int UseKTerm, const char *Str)
64 Debug_PutStringDebug(Str);
66 if( gbDebug_IsKPanic )
68 for( len = 0; Str[len]; len ++ )
69 KernelPanic_PutChar( Str[len] );
72 for( len = 0; Str[len]; len ++ );
74 if( gbSendNetworkDebug )
75 IPStack_SendDebugText(Str);
77 // Output to the kernel terminal
78 if( UseKTerm && !gbDebug_IsKPanic && giDebug_KTerm != -1)
80 if(gbInPutChar) return ;
82 VFS_Write(giDebug_KTerm, len, Str);
87 void Debug_DbgOnlyFmt(const char *format, va_list args)
89 Debug_Fmt(0, format, args);
92 void Debug_Fmt(int bUseKTerm, const char *format, va_list args)
94 char buf[DEBUG_MAX_LINE_LEN];
96 buf[DEBUG_MAX_LINE_LEN-1] = 0;
97 /*len = */vsnprintf(buf, DEBUG_MAX_LINE_LEN-1, format, args);
98 //if( len < DEBUG_MAX_LINE )
100 Debug_Puts(bUseKTerm, buf);
104 void Debug_FmtS(int bUseKTerm, const char *format, ...)
107 va_start(args, format);
108 Debug_Fmt(bUseKTerm, format, args);
112 void Debug_KernelPanic(void)
114 #if LOCK_DEBUG_OUTPUT
115 SHORTREL(&glDebug_Lock);
117 gbDebug_IsKPanic = 1;
118 KernelPanic_SetMode();
122 * \fn void LogF(const char *Msg, ...)
123 * \brief Raw debug log (no new line, no prefix)
125 void LogF(const char *Fmt, ...)
129 #if LOCK_DEBUG_OUTPUT
130 SHORTLOCK(&glDebug_Lock);
135 Debug_Fmt(1, Fmt, args);
139 #if LOCK_DEBUG_OUTPUT
140 SHORTREL(&glDebug_Lock);
144 * \fn void Debug(const char *Msg, ...)
145 * \brief Print only to the debug channel (not KTerm)
147 void Debug(const char *Fmt, ...)
151 #if LOCK_DEBUG_OUTPUT
152 if(!CPU_HAS_LOCK(&glDebug_Lock)) SHORTLOCK(&glDebug_Lock);
155 Debug_Puts(0, "Debug: ");
157 Debug_DbgOnlyFmt(Fmt, args);
159 Debug_PutCharDebug('\r');
160 Debug_PutCharDebug('\n');
161 #if LOCK_DEBUG_OUTPUT
162 SHORTREL(&glDebug_Lock);
167 void LogFV(const char *Fmt, va_list args)
169 #if LOCK_DEBUG_OUTPUT
170 SHORTLOCK(&glDebug_Lock);
173 Debug_Fmt(1, Fmt, args);
175 #if LOCK_DEBUG_OUTPUT
176 SHORTREL(&glDebug_Lock);
180 void LogV(const char *Fmt, va_list args)
182 #if LOCK_DEBUG_OUTPUT
183 SHORTLOCK(&glDebug_Lock);
186 Debug_Puts(1, "Log: ");
187 Debug_Fmt(1, Fmt, args);
188 Debug_Puts(1, "\r\n");
190 #if LOCK_DEBUG_OUTPUT
191 SHORTREL(&glDebug_Lock);
196 * \fn void Log(const char *Msg, ...)
198 void Log(const char *Fmt, ...)
206 void Warning(const char *Fmt, ...)
210 #if LOCK_DEBUG_OUTPUT
211 SHORTLOCK(&glDebug_Lock);
214 Debug_Puts(1, "Warning: ");
216 Debug_Fmt(1, Fmt, args);
221 #if LOCK_DEBUG_OUTPUT
222 SHORTREL(&glDebug_Lock);
225 void Panic(const char *Fmt, ...)
229 #if LOCK_DEBUG_OUTPUT
230 if( !CPU_HAS_LOCK(&glDebug_Lock) )
231 SHORTLOCK(&glDebug_Lock);
233 // And never SHORTREL
237 Debug_Puts(1, "Panic: ");
239 Debug_Fmt(1, Fmt, args);
250 void Debug_SetKTerminal(const char *File)
253 if(giDebug_KTerm != -1) {
258 tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
259 // Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
261 // Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
264 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
269 tTID tid = Threads_GetTID();
271 #if LOCK_DEBUG_OUTPUT
272 SHORTLOCK(&glDebug_Lock);
277 va_start(args, ArgTypes);
279 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
280 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
282 Debug_Puts(TRACE_TO_KTERM, FuncName);
283 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
284 Debug_Puts(TRACE_TO_KTERM, ": (");
288 pos = strpos(ArgTypes, ' ');
289 if(pos == -1 || pos > 1) {
291 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
293 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
295 Debug_Puts(TRACE_TO_KTERM, "=");
299 case 'p': Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*)); break;
300 case 'P': Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
301 case 's': Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*)); break;
302 case 'i': Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int)); break;
303 case 'u': Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint)); break;
304 case 'x': Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
305 case 'b': Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
306 case 'X': Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64)); break; // Extended (64-Bit)
307 case 'B': Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64)); break; // Extended (64-Bit)
310 Debug_Puts(TRACE_TO_KTERM, ", ");
314 ArgTypes = &ArgTypes[pos+1];
318 Debug_Puts(TRACE_TO_KTERM, ")\r\n");
320 #if LOCK_DEBUG_OUTPUT
321 SHORTREL(&glDebug_Lock);
325 void Debug_Log(const char *FuncName, const char *Fmt, ...)
328 int i = gDebug_Level;
329 tTID tid = Threads_GetTID();
331 #if LOCK_DEBUG_OUTPUT
332 SHORTLOCK(&glDebug_Lock);
335 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
336 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
338 Debug_Puts(TRACE_TO_KTERM, FuncName);
339 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
340 Debug_Puts(TRACE_TO_KTERM, ": ");
343 Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
346 Debug_Puts(TRACE_TO_KTERM, "\r\n");
348 #if LOCK_DEBUG_OUTPUT
349 SHORTREL(&glDebug_Lock);
353 void Debug_Leave(const char *FuncName, char RetType, ...)
357 tTID tid = Threads_GetTID();
359 #if LOCK_DEBUG_OUTPUT
360 SHORTLOCK(&glDebug_Lock);
365 va_start(args, RetType);
371 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
373 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
375 Debug_Puts(TRACE_TO_KTERM, FuncName);
376 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
377 Debug_Puts(TRACE_TO_KTERM, ": RETURN");
381 Debug_Puts(TRACE_TO_KTERM, "\r\n");
382 #if LOCK_DEBUG_OUTPUT
383 SHORTREL(&glDebug_Lock);
390 case 'n': Debug_Puts(TRACE_TO_KTERM, " NULL"); break;
391 case 'p': Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
392 case 'P': Debug_Fmt(TRACE_TO_KTERM, " %P", args); break; // PAddr
393 case 's': Debug_Fmt(TRACE_TO_KTERM, " '%s'", args); break;
394 case 'i': Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
395 case 'u': Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
396 case 'x': Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args); break;
398 case 'X': Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args); break;
400 Debug_Puts(TRACE_TO_KTERM, "\r\n");
404 #if LOCK_DEBUG_OUTPUT
405 SHORTREL(&glDebug_Lock);
409 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
411 const Uint8 *cdat = Data;
413 LogF("%014lli ", now());
414 Debug_Puts(1, Header);
415 LogF(" (Hexdump of %p)\r\n", Data);
417 #define CH(n) ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
421 LogF("%014lli Log: %04x:"
422 " %02x %02x %02x %02x %02x %02x %02x %02x"
423 " %02x %02x %02x %02x %02x %02x %02x %02x"
424 " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
427 cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
428 cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
429 CH(0), CH(1), CH(2), CH(3), CH(4), CH(5), CH(6), CH(7),
430 CH(8), CH(9), CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
439 LogF("%014lli Log: %04x: ", now(), pos);
440 for(i = 0; i < Length; i ++)
442 LogF("%02x ", cdat[i]);
444 for( ; i < 16; i ++) LogF(" ");
446 for(i = 0; i < Length; i ++)
448 if( i == 8 ) LogF(" ");