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);
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);
124 KernelPanic_SetMode();
128 * \fn void LogF(const char *Msg, ...)
129 * \brief Raw debug log (no new line, no prefix)
131 void LogF(const char *Fmt, ...)
135 #if LOCK_DEBUG_OUTPUT
136 SHORTLOCK(&glDebug_Lock);
141 Debug_Fmt(1, Fmt, args);
145 #if LOCK_DEBUG_OUTPUT
146 SHORTREL(&glDebug_Lock);
150 * \fn void Debug(const char *Msg, ...)
151 * \brief Print only to the debug channel (not KTerm)
153 void Debug(const char *Fmt, ...)
157 #if LOCK_DEBUG_OUTPUT
158 if(!CPU_HAS_LOCK(&glDebug_Lock)) SHORTLOCK(&glDebug_Lock);
161 Debug_Puts(0, "Debug: ");
163 Debug_DbgOnlyFmt(Fmt, args);
165 Debug_PutCharDebug('\r');
166 Debug_PutCharDebug('\n');
167 #if LOCK_DEBUG_OUTPUT
168 SHORTREL(&glDebug_Lock);
173 void LogFV(const char *Fmt, va_list args)
175 #if LOCK_DEBUG_OUTPUT
176 SHORTLOCK(&glDebug_Lock);
179 Debug_Fmt(1, Fmt, args);
181 #if LOCK_DEBUG_OUTPUT
182 SHORTREL(&glDebug_Lock);
186 void LogV(const char *Fmt, va_list args)
188 #if LOCK_DEBUG_OUTPUT
189 SHORTLOCK(&glDebug_Lock);
192 Debug_Puts(1, "Log: ");
193 Debug_Fmt(1, Fmt, args);
194 Debug_Puts(1, "\r\n");
196 #if LOCK_DEBUG_OUTPUT
197 SHORTREL(&glDebug_Lock);
202 * \fn void Log(const char *Msg, ...)
204 void Log(const char *Fmt, ...)
212 void Warning(const char *Fmt, ...)
216 #if LOCK_DEBUG_OUTPUT
217 SHORTLOCK(&glDebug_Lock);
220 Debug_Puts(1, "Warning: ");
222 Debug_Fmt(1, Fmt, args);
227 #if LOCK_DEBUG_OUTPUT
228 SHORTREL(&glDebug_Lock);
231 void Panic(const char *Fmt, ...)
235 #if LOCK_DEBUG_OUTPUT
236 if( !CPU_HAS_LOCK(&glDebug_Lock) )
237 SHORTLOCK(&glDebug_Lock);
239 // And never SHORTREL
243 Debug_Puts(1, "Panic: ");
245 Debug_Fmt(1, Fmt, args);
256 void Debug_SetKTerminal(const char *File)
259 if(giDebug_KTerm != -1) {
264 tmp = VFS_Open(File, VFS_OPENFLAG_WRITE);
265 // Log_Log("Debug", "Opened '%s' as 0x%x", File, tmp);
267 // Log_Log("Debug", "Returning to %p", __builtin_return_address(0));
270 void Debug_Enter(const char *FuncName, const char *ArgTypes, ...)
275 tTID tid = Threads_GetTID();
277 #if LOCK_DEBUG_OUTPUT
278 SHORTLOCK(&glDebug_Lock);
283 va_start(args, ArgTypes);
285 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
286 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
288 Debug_Puts(TRACE_TO_KTERM, FuncName);
289 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
290 Debug_Puts(TRACE_TO_KTERM, ": (");
294 pos = strpos(ArgTypes, ' ');
295 if(pos == -1 || pos > 1) {
297 Debug_Puts(TRACE_TO_KTERM, ArgTypes+1);
299 Debug_FmtS(TRACE_TO_KTERM, "%.*s", pos-1, ArgTypes+1);
301 Debug_Puts(TRACE_TO_KTERM, "=");
305 case 'p': Debug_FmtS(TRACE_TO_KTERM, "%p", va_arg(args, void*)); break;
306 case 'P': Debug_FmtS(TRACE_TO_KTERM, "%P", va_arg(args, tPAddr)); break;
307 case 's': Debug_FmtS(TRACE_TO_KTERM, "'%s'", va_arg(args, char*)); break;
308 case 'i': Debug_FmtS(TRACE_TO_KTERM, "%i", va_arg(args, int)); break;
309 case 'u': Debug_FmtS(TRACE_TO_KTERM, "%u", va_arg(args, Uint)); break;
310 case 'x': Debug_FmtS(TRACE_TO_KTERM, "0x%x", va_arg(args, Uint)); break;
311 case 'b': Debug_FmtS(TRACE_TO_KTERM, "0b%b", va_arg(args, Uint)); break;
312 case 'X': Debug_FmtS(TRACE_TO_KTERM, "0x%llx", va_arg(args, Uint64)); break; // Extended (64-Bit)
313 case 'B': Debug_FmtS(TRACE_TO_KTERM, "0b%llb", va_arg(args, Uint64)); break; // Extended (64-Bit)
316 Debug_Puts(TRACE_TO_KTERM, ", ");
320 ArgTypes = &ArgTypes[pos+1];
324 Debug_Puts(TRACE_TO_KTERM, ")\r\n");
326 #if LOCK_DEBUG_OUTPUT
327 SHORTREL(&glDebug_Lock);
331 void Debug_Log(const char *FuncName, const char *Fmt, ...)
334 int i = gDebug_Level;
335 tTID tid = Threads_GetTID();
337 #if LOCK_DEBUG_OUTPUT
338 SHORTLOCK(&glDebug_Lock);
341 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
342 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
344 Debug_Puts(TRACE_TO_KTERM, FuncName);
345 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
346 Debug_Puts(TRACE_TO_KTERM, ": ");
349 Debug_Fmt(TRACE_TO_KTERM, Fmt, args);
352 Debug_Puts(TRACE_TO_KTERM, "\r\n");
354 #if LOCK_DEBUG_OUTPUT
355 SHORTREL(&glDebug_Lock);
359 void Debug_Leave(const char *FuncName, char RetType, ...)
363 tTID tid = Threads_GetTID();
365 #if LOCK_DEBUG_OUTPUT
366 SHORTLOCK(&glDebug_Lock);
371 va_start(args, RetType);
377 Debug_FmtS(TRACE_TO_KTERM, "%014lli ", now());
379 while(i--) Debug_Puts(TRACE_TO_KTERM, " ");
381 Debug_Puts(TRACE_TO_KTERM, FuncName);
382 Debug_FmtS(TRACE_TO_KTERM, "[%i]", tid);
383 Debug_Puts(TRACE_TO_KTERM, ": RETURN");
387 Debug_Puts(TRACE_TO_KTERM, "\r\n");
388 #if LOCK_DEBUG_OUTPUT
389 SHORTREL(&glDebug_Lock);
396 case 'n': Debug_Puts(TRACE_TO_KTERM, " NULL"); break;
397 case 'p': Debug_Fmt(TRACE_TO_KTERM, " %p", args); break;
398 case 'P': Debug_Fmt(TRACE_TO_KTERM, " %P", args); break; // PAddr
399 case 's': Debug_Fmt(TRACE_TO_KTERM, " '%s'", args); break;
400 case 'i': Debug_Fmt(TRACE_TO_KTERM, " %i", args); break;
401 case 'u': Debug_Fmt(TRACE_TO_KTERM, " %u", args); break;
402 case 'x': Debug_Fmt(TRACE_TO_KTERM, " 0x%x", args); break;
404 case 'X': Debug_Fmt(TRACE_TO_KTERM, " 0x%llx", args); break;
406 Debug_Puts(TRACE_TO_KTERM, "\r\n");
410 #if LOCK_DEBUG_OUTPUT
411 SHORTREL(&glDebug_Lock);
415 void Debug_HexDump(const char *Header, const void *Data, size_t Length)
417 const Uint8 *cdat = Data;
419 LogF("%014lli ", now());
420 Debug_Puts(1, Header);
421 LogF(" (Hexdump of %p)\r\n", Data);
423 #define CH(n) ((' '<=cdat[(n)]&&cdat[(n)]<0x7F) ? cdat[(n)] : '.')
427 LogF("%014lli Log: %04x:"
428 " %02x %02x %02x %02x %02x %02x %02x %02x"
429 " %02x %02x %02x %02x %02x %02x %02x %02x"
430 " %c%c%c%c%c%c%c%c %c%c%c%c%c%c%c%c\r\n",
433 cdat[ 0], cdat[ 1], cdat[ 2], cdat[ 3], cdat[ 4], cdat[ 5], cdat[ 6], cdat[ 7],
434 cdat[ 8], cdat[ 9], cdat[10], cdat[11], cdat[12], cdat[13], cdat[14], cdat[15],
435 CH(0), CH(1), CH(2), CH(3), CH(4), CH(5), CH(6), CH(7),
436 CH(8), CH(9), CH(10), CH(11), CH(12), CH(13), CH(14), CH(15)
445 LogF("%014lli Log: %04x: ", now(), pos);
446 for(i = 0; i < Length; i ++)
448 LogF("%02x ", cdat[i]);
450 for( ; i < 16; i ++) LogF(" ");
452 for(i = 0; i < Length; i ++)
454 if( i == 8 ) LogF(" ");