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 Heap_Dump(void)
16 extern void KernelPanic_SetMode(void);
17 extern void KernelPanic_PutChar(char Ch);
18 extern void IPStack_SendDebugText(const char *Text);
21 static void Debug_Putchar(char ch);
22 static void Debug_Puts(int bUseKTerm, const char *Str);
23 void Debug_DbgOnlyFmt(const char *format, va_list args);
24 void Debug_FmtS(int bUseKTerm, const char *format, ...);
25 void Debug_Fmt(int bUseKTerm, const char *format, va_list args);
26 void Debug_SetKTerminal(const char *File);
27 void LogFV(const char *Fmt, va_list args);
31 int giDebug_KTerm = -1;
32 int gbDebug_IsKPanic = 0;
33 volatile int gbInPutChar = 0;
35 tShortSpinlock glDebug_Lock;
37 // - Disabled because it breaks shit
38 int gbSendNetworkDebug = 0;
41 static void Debug_Putchar(char ch)
43 Debug_PutCharDebug(ch);
45 if( !gbDebug_IsKPanic )
47 if(gbInPutChar) return ;
49 if(giDebug_KTerm != -1)
50 VFS_Write(giDebug_KTerm, 1, &ch);
54 KernelPanic_PutChar(ch);
56 if( gbSendNetworkDebug )
58 char str[2] = {ch, 0};
59 IPStack_SendDebugText(str);
63 static void Debug_Puts(int UseKTerm, const char *Str)
67 Debug_PutStringDebug(Str);
69 if( gbDebug_IsKPanic )
71 for( len = 0; Str[len]; len ++ )
72 KernelPanic_PutChar( Str[len] );
75 for( len = 0; Str[len]; len ++ );
77 if( gbSendNetworkDebug )
78 IPStack_SendDebugText(Str);
80 // Output to the kernel terminal
81 if( UseKTerm && !gbDebug_IsKPanic && giDebug_KTerm != -1)
83 if(gbInPutChar) return ;
85 VFS_Write(giDebug_KTerm, len, Str);
90 void Debug_DbgOnlyFmt(const char *format, va_list args)
92 Debug_Fmt(0, format, args);
95 void Debug_Fmt(int bUseKTerm, const char *format, va_list args)
97 char buf[DEBUG_MAX_LINE_LEN];
99 buf[DEBUG_MAX_LINE_LEN-1] = 0;
100 /*len = */vsnprintf(buf, DEBUG_MAX_LINE_LEN-1, format, args);
101 //if( len < DEBUG_MAX_LINE )
103 Debug_Puts(bUseKTerm, buf);
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 LOCK_DEBUG_OUTPUT
118 SHORTREL(&glDebug_Lock);
120 gbDebug_IsKPanic = 1;
121 KernelPanic_SetMode();
125 * \fn void LogF(const char *Msg, ...)
126 * \brief Raw debug log (no new line, no prefix)
128 void LogF(const char *Fmt, ...)
132 #if LOCK_DEBUG_OUTPUT
133 SHORTLOCK(&glDebug_Lock);
138 Debug_Fmt(1, Fmt, args);
142 #if LOCK_DEBUG_OUTPUT
143 SHORTREL(&glDebug_Lock);
147 * \fn void Debug(const char *Msg, ...)
148 * \brief Print only to the debug channel (not KTerm)
150 void Debug(const char *Fmt, ...)
154 #if LOCK_DEBUG_OUTPUT
155 if(!CPU_HAS_LOCK(&glDebug_Lock)) SHORTLOCK(&glDebug_Lock);
158 Debug_Puts(0, "Debug: ");
160 Debug_DbgOnlyFmt(Fmt, args);
162 Debug_PutCharDebug('\r');
163 Debug_PutCharDebug('\n');
164 #if LOCK_DEBUG_OUTPUT
165 SHORTREL(&glDebug_Lock);
170 void LogFV(const char *Fmt, va_list args)
172 #if LOCK_DEBUG_OUTPUT
173 SHORTLOCK(&glDebug_Lock);
176 Debug_Fmt(1, Fmt, args);
178 #if LOCK_DEBUG_OUTPUT
179 SHORTREL(&glDebug_Lock);
183 void LogV(const char *Fmt, va_list args)
185 #if LOCK_DEBUG_OUTPUT
186 SHORTLOCK(&glDebug_Lock);
189 Debug_Puts(1, "Log: ");
190 Debug_Fmt(1, Fmt, args);
191 Debug_Puts(1, "\r\n");
193 #if LOCK_DEBUG_OUTPUT
194 SHORTREL(&glDebug_Lock);
199 * \fn void Log(const char *Msg, ...)
201 void Log(const char *Fmt, ...)
209 void Warning(const char *Fmt, ...)
213 #if LOCK_DEBUG_OUTPUT
214 SHORTLOCK(&glDebug_Lock);
217 Debug_Puts(1, "Warning: ");
219 Debug_Fmt(1, Fmt, args);
224 #if LOCK_DEBUG_OUTPUT
225 SHORTREL(&glDebug_Lock);
228 void Panic(const char *Fmt, ...)
232 #if LOCK_DEBUG_OUTPUT
233 if( !CPU_HAS_LOCK(&glDebug_Lock) )
234 SHORTLOCK(&glDebug_Lock);
236 // And never SHORTREL
240 Debug_Puts(1, "Panic: ");
242 Debug_Fmt(1, Fmt, args);
253 void Debug_SetKTerminal(const char *File)
256 if(giDebug_KTerm != -1) {
261 tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
262 // Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
264 // Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
267 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
272 tTID tid = Threads_GetTID();
274 #if LOCK_DEBUG_OUTPUT
275 SHORTLOCK(&glDebug_Lock);
280 va_start(args, ArgTypes);
282 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
283 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
285 Debug_Puts(TRACE_TO_KTERM, FuncName);
286 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
287 Debug_Puts(TRACE_TO_KTERM, ": (");
291 pos = strpos(ArgTypes, ' ');
292 if(pos == -1 || pos > 1) {
294 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
296 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
298 Debug_Puts(TRACE_TO_KTERM, "=");
302 case 'p': Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*)); break;
303 case 'P': Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
304 case 's': Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*)); break;
305 case 'i': Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int)); break;
306 case 'u': Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint)); break;
307 case 'x': Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
308 case 'b': Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
309 case 'X': Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64)); break; // Extended (64-Bit)
310 case 'B': Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64)); break; // Extended (64-Bit)
313 Debug_Puts(TRACE_TO_KTERM, ", ");
317 ArgTypes = &ArgTypes[pos+1];
321 Debug_Puts(TRACE_TO_KTERM, ")\r\n");
323 #if LOCK_DEBUG_OUTPUT
324 SHORTREL(&glDebug_Lock);
328 void Debug_Log(const char *FuncName, const char *Fmt, ...)
331 int i = gDebug_Level;
332 tTID tid = Threads_GetTID();
334 #if LOCK_DEBUG_OUTPUT
335 SHORTLOCK(&glDebug_Lock);
338 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
339 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
341 Debug_Puts(TRACE_TO_KTERM, FuncName);
342 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
343 Debug_Puts(TRACE_TO_KTERM, ": ");
346 Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
349 Debug_Puts(TRACE_TO_KTERM, "\r\n");
351 #if LOCK_DEBUG_OUTPUT
352 SHORTREL(&glDebug_Lock);
356 void Debug_Leave(const char *FuncName, char RetType, ...)
360 tTID tid = Threads_GetTID();
362 #if LOCK_DEBUG_OUTPUT
363 SHORTLOCK(&glDebug_Lock);
368 va_start(args, RetType);
374 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
376 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
378 Debug_Puts(TRACE_TO_KTERM, FuncName);
379 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
380 Debug_Puts(TRACE_TO_KTERM, ": RETURN");
384 Debug_Puts(TRACE_TO_KTERM, "\r\n");
385 #if LOCK_DEBUG_OUTPUT
386 SHORTREL(&glDebug_Lock);
393 case 'n': Debug_Puts(TRACE_TO_KTERM, " NULL"); break;
394 case 'p': Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
395 case 'P': Debug_Fmt(TRACE_TO_KTERM, " %P", args); break; // PAddr
396 case 's': Debug_Fmt(TRACE_TO_KTERM, " '%s'", args); break;
397 case 'i': Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
398 case 'u': Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
399 case 'x': Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args); break;
401 case 'X': Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args); break;
403 Debug_Puts(TRACE_TO_KTERM, "\r\n");
407 #if LOCK_DEBUG_OUTPUT
408 SHORTREL(&glDebug_Lock);
412 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
414 const Uint8 *cdat = Data;
416 LogF("%014lli ", now());
417 Debug_Puts(1, Header);
418 LogF(" (Hexdump of %p)\r\n", Data);
420 #define CH(n) ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
424 LogF("%014lli Log: %04x:"
425 " %02x %02x %02x %02x %02x %02x %02x %02x"
426 " %02x %02x %02x %02x %02x %02x %02x %02x"
427 " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
430 cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
431 cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
432 CH(0), CH(1), CH(2), CH(3), CH(4), CH(5), CH(6), CH(7),
433 CH(8), CH(9), CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
442 LogF("%014lli Log: %04x: ", now(), pos);
443 for(i = 0; i < Length; i ++)
445 LogF("%02x ", cdat[i]);
447 for( ; i < 16; i ++) LogF(" ");
449 for(i = 0; i < Length; i ++)
451 if( i == 8 ) LogF(" ");