Kernel/x86 - Disabled task tracing
[tpg/acess2.git] / Kernel / logging.c
1 /*
2  * Acess 2 Kernel
3  * - By John Hodge (thePowersGang)
4  *
5  * logging.c - Kernel Logging Service
6  */
7 #include <acess.h>
8 #include <adt.h>
9
10 #define CACHE_MESSAGES  0
11 #define PRINT_ON_APPEND 1
12 #define USE_RING_BUFFER 1
13 #define RING_BUFFER_SIZE        4096
14
15 // === CONSTANTS ===
16 enum eLogLevels
17 {
18         LOG_LEVEL_KPANIC,
19         LOG_LEVEL_PANIC,
20         LOG_LEVEL_FATAL,
21         LOG_LEVEL_ERROR,
22         LOG_LEVEL_WARNING,
23         LOG_LEVEL_NOTICE,
24         LOG_LEVEL_LOG,
25         LOG_LEVEL_DEBUG,
26         NUM_LOG_LEVELS
27 };
28 const char      *csaLevelColours[] = {
29                 "\x1B[35m", "\x1B[34m", "\x1B[36m", "\x1B[31m",
30                 "\x1B[33m", "\x1B[32m", "\x1B[0m", "\x1B[0m"
31                 };
32 const char      *csaLevelCodes[] =  {"k","p","f","e","w","n","l","d"};
33
34 // === TYPES ===
35 typedef struct sLogEntry
36 {
37         struct sLogEntry        *Next;
38         struct sLogEntry        *LevelNext;
39         Sint64  Time;
40          int    Level;
41          int    Length;
42         char    Ident[9];
43         char    Data[];
44 }       tLogEntry;
45 typedef struct sLogList
46 {
47         tLogEntry       *Head;
48         tLogEntry       *Tail;
49 }       tLogList;
50
51 // === PROTOTYPES ===
52 void    Log_AddEvent(const char *Ident, int Level, const char *Format, va_list Args);
53 static void     Log_Int_PrintMessage(tLogEntry *Entry);
54 //void  Log_KernelPanic(const char *Ident, const char *Message, ...);
55 //void  Log_Panic(const char *Ident, const char *Message, ...);
56 //void  Log_Error(const char *Ident, const char *Message, ...);
57 //void  Log_Warning(const char *Ident, const char *Message, ...);
58 //void  Log_Notice(const char *Ident, const char *Message, ...);
59 //void  Log_Log(const char *Ident, const char *Message, ...);
60 //void  Log_Debug(const char *Ident, const char *Message, ...);
61
62 // === EXPORTS ===
63 EXPORT(Log_Panic);
64 EXPORT(Log_Error);
65 EXPORT(Log_Warning);
66 EXPORT(Log_Notice);
67 EXPORT(Log_Log);
68 EXPORT(Log_Debug);
69
70 // === GLOBALS ===
71 tShortSpinlock  glLogOutput;
72 #if USE_RING_BUFFER
73 Uint8   gaLog_RingBufferData[sizeof(tRingBuffer)+RING_BUFFER_SIZE];
74 tRingBuffer     *gpLog_RingBuffer = (void*)gaLog_RingBufferData;
75 #else
76 tMutex  glLog;
77 tLogList        gLog;
78 tLogList        gLog_Levels[NUM_LOG_LEVELS];
79 #endif
80
81 // === CODE ===
82 /**
83  * \brief Adds an event to the log
84  */
85 void Log_AddEvent(const char *Ident, int Level, const char *Format, va_list Args)
86 {
87          int    len;
88         tLogEntry       *ent;
89         va_list args_tmp;
90         
91         if( Level >= NUM_LOG_LEVELS )   return;
92         
93         va_copy(args_tmp, Args);
94         len = vsnprintf(NULL, 256, Format, args_tmp);
95         
96         //Log("len = %i", len);
97         
98         #if USE_RING_BUFFER || !CACHE_MESSAGES
99         {
100         char    buf[sizeof(tLogEntry)+len+1];
101         ent = (void*)buf;
102         #else
103         ent = malloc(sizeof(tLogEntry)+len+1);
104         #endif
105         ent->Time = now();
106         strncpy(ent->Ident, Ident, 8);
107         ent->Ident[8] = '\0';
108         ent->Level = Level;
109         ent->Length = len;
110         vsnprintf( ent->Data, len+1, Format, Args );
111
112         #if CACHE_MESSAGES
113         # if USE_RING_BUFFER
114         {
115                 #define LOG_HDR_LEN     (14+1+2+8+2)
116                 char    newData[ LOG_HDR_LEN + len + 2 + 1 ];
117                 char    _ident[9];
118                 strncpy(_ident, Ident, 9);
119                 sprintf( newData, "%014lli%s [%-8s] ",
120                         ent->Time, csaLevelCodes[Level], Ident);
121                 strcpy( newData + LOG_HDR_LEN, ent->Data );
122                 strcpy( newData + LOG_HDR_LEN + len, "\r\n" );
123                 gpLog_RingBuffer->Space = RING_BUFFER_SIZE;     // Needed to init the buffer
124                 RingBuffer_Write( gpLog_RingBuffer, newData, LOG_HDR_LEN + len + 2 );
125         }
126         # else
127         Mutex_Acquire( &glLog );
128         
129         ent->Next = gLog.Tail;
130         if(gLog.Head)
131                 gLog.Tail = ent;
132         else
133                 gLog.Tail = gLog.Head = ent;
134         
135         ent->LevelNext = gLog_Levels[Level].Tail;
136         if(gLog_Levels[Level].Head)
137                 gLog_Levels[Level].Tail = ent;
138         else
139                 gLog_Levels[Level].Tail = gLog_Levels[Level].Head = ent;
140         
141         Mutex_Release( &glLog );
142         # endif
143         #endif
144         
145         #if PRINT_ON_APPEND || !CACHE_MESSAGES
146         Log_Int_PrintMessage( ent );
147         #endif
148         
149         #if USE_RING_BUFFER || !CACHE_MESSAGES
150         }
151         #endif
152 }
153
154 /**
155  * \brief Prints a log message to the debug console
156  */
157 void Log_Int_PrintMessage(tLogEntry *Entry)
158 {
159         SHORTLOCK( &glLogOutput );
160         LogF("%s%014lli%s [%-8s] %i - %s",
161                 csaLevelColours[Entry->Level],
162                 Entry->Time,
163                 csaLevelCodes[Entry->Level],
164                 Entry->Ident,
165                 Threads_GetTID(),
166                 Entry->Data
167                 );
168         LogF("\x1B[0m\r\n");    // Separate in case Entry->Data is too long
169         SHORTREL( &glLogOutput );
170 }
171
172 /**
173  * \brief KERNEL PANIC!!!!
174  */
175 void Log_KernelPanic(const char *Ident, const char *Message, ...)
176 {
177         va_list args;   
178         va_start(args, Message);
179         Log_AddEvent(Ident, LOG_LEVEL_KPANIC, Message, args);
180         va_end(args);
181         Panic("Log_KernelPanic - %s", Ident);
182 }
183
184 /**
185  * \brief Panic Message - Driver Unrecoverable error
186  */
187 void Log_Panic(const char *Ident, const char *Message, ...)
188 {
189         va_list args;   
190         va_start(args, Message);
191         Log_AddEvent(Ident, LOG_LEVEL_PANIC, Message, args);
192         va_end(args);
193 }
194
195 /**
196  * \brief Error Message - Recoverable Error
197  */
198 void Log_Error(const char *Ident, const char *Message, ...)
199 {
200         va_list args;   
201         va_start(args, Message);
202         Log_AddEvent(Ident, LOG_LEVEL_ERROR, Message, args);
203         va_end(args);
204 }
205
206 /**
207  * \brief Warning Message - Something the user should know
208  */
209 void Log_Warning(const char *Ident, const char *Message, ...)
210 {
211         va_list args;
212         
213         va_start(args, Message);
214         Log_AddEvent(Ident, LOG_LEVEL_WARNING, Message, args);
215         va_end(args);
216 }
217
218 /**
219  * \brief Notice Message - Something the user might like to know
220  */
221 void Log_Notice(const char *Ident, const char *Message, ...)
222 {
223         va_list args;   
224         va_start(args, Message);
225         Log_AddEvent(Ident, LOG_LEVEL_NOTICE, Message, args);
226         va_end(args);
227 }
228
229 /**
230  * \brief Log Message - Possibly useful information
231  */
232 void Log_Log(const char *Ident, const char *Message, ...)
233 {
234         va_list args;   
235         va_start(args, Message);
236         Log_AddEvent(Ident, LOG_LEVEL_LOG, Message, args);
237         va_end(args);
238 }
239
240 /**
241  * \brief Debug Message - Only a developer would want this info
242  */
243 void Log_Debug(const char *Ident, const char *Message, ...)
244 {
245         va_list args;   
246         va_start(args, Message);
247         Log_AddEvent(Ident, LOG_LEVEL_DEBUG, Message, args);
248         va_end(args);
249 }

UCC git Repository :: git.ucc.asn.au