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