Index

lognestmonster / b6b260e

A general-purpose single-header C logging library and parser for event-based logs. (Incomplete)

Download | Refs | Commit Log | Files | README | LICENSE

Latest Commit

{#}TimeHashSubjectAuthor#(+)(-)GPG?
15329 Nov 2019 19:38b6b260eAdd header protection for one-time definitionsJosh Stockin1298N

Blob @ lognestmonster / src / c / lognestmonster.h

text/plain13578 bytesdownload raw
1// lognestmonster Copyright (c) 2019 Joshua 'joshuas3' Stockin
2// lognestmonster.h
3// C header file for implementation of the lognestmonster logging library
4
5// <https://github.com/JoshuaS3/lognestmonster/>.
6
7
8// This file is part of lognestmonster.
9
10// lognestmonster is free software: you can redistribute it and/or modify
11// it under the terms of the GNU General Public License as published by
12// the Free Software Foundation, either version 3 of the License, or
13// (at your option) any later version.
14
15// lognestmonster is distributed in the hope that it will be useful,
16// but WITHOUT ANY WARRANTY; without even the implied warranty of
17// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18// GNU General Public License for more details.
19
20// You should have received a copy of the GNU General Public License
21// along with lognestmonster. If not, see <https://www.gnu.org/licenses/>.
22
23
24// SEMANTICS
25// internal definitions: lnm_lower_camel_case
26// public definitions: lnmUpperCamelCase
27
28
29// Declarations
30#ifndef __LOGNESTMONSTER__
31#define __LOGNESTMONSTER__ 1
32
33// stdc inclusions
34
35#include <stdint.h>
36#include <inttypes.h>
37#include <stdio.h>
38#include <stdlib.h>
39#include <string.h>
40
41// non-universal inclusions
42
43#include <sys/time.h>
44
45
46enum lnmVerbosityLevel {lnmInfo, lnmDebug, lnmVerbose, lnmVeryVerbose, lnmWarning, lnmError};
47typedef uint8_t * lnmItem;
48typedef uint8_t * lnmQueue;
49
50lnmQueue lnmQueueInit(char * name, char * out_path);
51lnmQueue lnmQueueByName(char * name);
52lnmItem lnmStatement(uint8_t verbosity, char * tag, char * message);
53lnmItem lnmEvent(void);
54void lnmEventPush(lnmItem event, lnmItem item);
55void lnmEventPushS(lnmItem event, uint8_t verbosity, char * tag, char * message);
56lnmItem lnmEventI(lnmItem item);
57lnmItem lnmEventS(uint8_t verbosity, char * tag, char * message);
58
59void lnm_debug_parse_item();
60void lnm_debug_parse_registry();
61
62#endif
63
64
65#ifdef DEFINE_LOGNESTMONSTER // one-time definitions
66
67
68// Pushable structure
69
70typedef struct {
71 uint16_t length;
72 lnmItem * pushed;
73} lnm_pushable;
74
75lnm_pushable * lnm_new_pushable() {
76 lnm_pushable * new_pushable = malloc(sizeof(lnm_pushable));
77 new_pushable->length = 0;
78 new_pushable->pushed = malloc(0);
79 return new_pushable;
80}
81
82void lnm_pushable_push(lnm_pushable * pushable, lnmItem item) {
83 if (pushable->length+1 >= 65535) {
84 printf("lognestmonster (lnm_pushable_push): pushable reached cap length 65535. exiting...\n");
85 exit(1);
86 }
87 pushable->pushed = realloc(pushable->pushed, sizeof(lnmItem)*(pushable->length+1)); // reallocate with size: length+1
88 pushable->pushed[pushable->length] = item;
89 pushable->length += 1;
90}
91
92int lnm_pushable_indexof(lnm_pushable * pushable, lnmItem item) {
93 int len = pushable->length;
94 for (int iter = 0; iter<len; iter++) {
95 if (item == pushable->pushed[iter]) return iter;
96 }
97 printf("lognestmonster (lnm_pushable_indexof): cannot find item in pushable. exiting...\n");
98 exit(1);
99}
100
101void lnm_pushable_remove(lnm_pushable * pushable, int index) {
102 if (index>=pushable->length || index < 0) {
103 printf("lognestmonster (lnm_pushable_remove): attempt to remove index out of pushable bounds. exiting...\n");
104 exit(1);
105 }
106 lnmItem * new_pushed = malloc(sizeof(lnmItem)*(pushable->length-1)); // map array excluding index
107 for (int iter = 0; iter<index; iter++) {
108 new_pushed[iter] = pushable->pushed[iter];
109 }
110 for (int iter = index+1; iter<pushable->length; iter++) {
111 new_pushed[iter-1] = pushable->pushed[iter];
112 }
113 free(pushable->pushed);
114 pushable->length--;
115 pushable->pushed = new_pushed;
116}
117
118void lnm_pushable_free(lnm_pushable * pushable) {
119 free(pushable->pushed);
120 free(pushable);
121}
122
123
124// Statement and event structure definitions
125
126typedef struct {
127 uint8_t type:1; // Used internally; 0 = statement, 1 = event
128 uint8_t boolpushed:1; // whether or not this log item has been pushed
129 lnm_pushable * pushed; // array of memory locations for lnm_log_event and lnm_log_statement structs
130} lnm_log_event;
131
132typedef struct {
133 // word 1, 4 bytes data 4 bytes padding
134 uint8_t type:1; // Used internally; 0 = statement, 1 = event
135 uint8_t boolpushed:1; // whether or not this log item has been pushed
136 uint8_t verbosity:3; // lnmVerbosityLevel, 0-5
137 uint8_t tag_size; // character length of the tag
138 uint16_t message_size; // character length of the message
139
140 // word 2, 8 bytes data
141 uint64_t timestamp; // 64-bit millisecond timestamp
142
143 // word 3, 8 bytes data
144 char * log; // tag string + message string
145} lnm_log_statement;
146
147
148// Queue structure definition
149
150typedef struct {
151 char * name;
152 char * out_path;
153 uint64_t timestamp;
154 lnm_pushable * pushed;
155} lnm_queue;
156
157
158// Library utilities
159
160unsigned long lnm_getus(void) {
161 struct timeval current_time;
162 gettimeofday(&current_time, NULL);
163 unsigned long ms = (current_time.tv_sec*1000000+current_time.tv_usec);
164 return ms;
165}
166
167unsigned long lnm_getms(void) {
168 return lnm_getus()/1000;
169}
170
171
172int lnm_isstatement(lnmItem item) {
173 lnm_log_statement * s = (lnm_log_statement *)item;
174 return !s->type;
175}
176
177
178// Item registry utils
179
180static lnm_pushable * lnm_registered_queues;
181static lnm_pushable * lnm_registered_items;
182static int lnm_registry_update_count;
183
184void lnm_registry_update(void) { // scan each registered item
185 for (int iter = 0; iter < lnm_registered_items->length; iter++) {
186 lnm_log_statement * s = (lnm_log_statement *)lnm_registered_items->pushed[iter];
187 if (s->boolpushed == 1) { // if the registered item has been pushed elsewhere, remove it from the top level of the registry
188 lnm_registry_update_count++;
189 lnm_pushable_remove(lnm_registered_items, iter);
190 iter--;
191 }
192 }
193}
194
195
196// Core library
197
198void lnm_free_item(lnmItem item) { // i'm so sorry
199 lnm_log_statement * item_cast = (lnm_log_statement *)item;
200 if (item_cast->boolpushed == 0) { // flush item out of registry
201 item_cast->boolpushed = 1;
202 lnm_registry_update();
203 }
204 if (item_cast->type == 0) {
205 free(item_cast->log);
206 free(item_cast);
207 } else if (item_cast->type == 1) {
208 lnm_log_event * event_cast = (lnm_log_event *)item_cast;
209
210 lnm_pushable * breadcrumb = lnm_new_pushable();
211 lnm_pushable_push(breadcrumb, (lnmItem)event_cast); // add event_cast as the first step down the breadcrumb
212 while (breadcrumb->length > 0) { // while there are items still in the breadcrumb
213 lnm_log_statement * breadcrumb_item = (lnm_log_statement *)breadcrumb->pushed[breadcrumb->length-1]; // fetch the last (deepest) item
214 if (breadcrumb_item->type == 0) { // the item is a statement
215 lnm_pushable_remove(breadcrumb, breadcrumb->length-1); // remove it from the breadcrumb
216 free(breadcrumb_item->log); // and free it
217 free(breadcrumb_item);
218 } else if (breadcrumb_item->type == 1) {
219 lnm_log_event * breadcrumb_item_cast = (lnm_log_event *)breadcrumb_item; // item is an event, cast pointer
220 if (breadcrumb_item_cast->pushed->length > 0) { // if the event is not empty
221 lnm_pushable_push(breadcrumb, breadcrumb_item_cast->pushed->pushed[breadcrumb_item_cast->pushed->length-1]); // push the last item of event into the breadcrumb
222 lnm_pushable_remove(breadcrumb_item_cast->pushed, breadcrumb_item_cast->pushed->length-1); // and remove it from this event's index
223 // there is now a new breadcrumb navigation layer. loop back to check the new item...
224 } else {
225 lnm_pushable_remove(breadcrumb, breadcrumb->length-1); // event is finally empty, remove it from the breadcrumb and free it
226 lnm_pushable_free(breadcrumb_item_cast->pushed);
227 free(breadcrumb_item_cast);
228 }
229 }
230 }
231 } else {
232 printf("lognestmonster (lnm_free_item): non-log item passed to function. exiting...\n");
233 }
234}
235
236void lnm_free_registry() {
237 for (int iter = 0; iter < lnm_registered_items->length; iter++) {
238 lnm_free_item(lnm_registered_items->pushed[iter]);
239 }
240}
241
242
243lnmQueue lnmQueueInit(char * name, char * out_path) {
244 if (lnm_registered_queues == NULL) {
245 lnm_registered_queues = lnm_new_pushable();
246 }
247 if (lnm_registered_items == NULL) {
248 lnm_registered_items = lnm_new_pushable();
249 }
250
251 lnm_queue * new_queue = malloc(sizeof(lnm_queue));
252 new_queue->name = malloc(strlen(name)+1);
253 new_queue->out_path = malloc(strlen(out_path)+1);
254 strcpy(new_queue->name, name);
255 strcpy(new_queue->out_path, out_path);
256 new_queue->pushed = lnm_new_pushable();
257
258 lnm_pushable_push(lnm_registered_queues, (lnmQueue)new_queue);
259 return (lnmQueue)new_queue;
260}
261
262lnmQueue lnmQueueByName(char * name) {
263 if (lnm_registered_queues == NULL) {
264 printf("lognestmonster (lnmQueueByName): queue registry is nonexistant. exiting...\n");
265 exit(1);
266 }
267 if (lnm_registered_queues->length == 0) {
268 printf("lognestmonster (lnmQueueByName): queue registry is empty. exiting...\n");
269 exit(1);
270 }
271 for (int iter = 0; iter<lnm_registered_queues->length; iter++) {
272 lnm_queue * iterqueue = (lnm_queue *)lnm_registered_queues->pushed[iter];
273 if (strcmp(iterqueue->name, name)==0) {
274 return (lnmQueue)iterqueue;
275 }
276 }
277 printf("lognestmonster (lnmQueueByName): queue not found in registry. exiting...\n");
278 exit(1);
279}
280
281
282lnmItem lnmStatement(uint8_t verbosity, char * tag, char * message) {
283 lnm_log_statement * new_statement = malloc(sizeof(lnm_log_statement));
284 new_statement->type = 0;
285 new_statement->verbosity = verbosity;
286 new_statement->timestamp = lnm_getus();
287 int tlen = strlen(tag);
288 if (tlen > 255 || tlen < 0) {
289 printf("lognestmonster (lnmStatement): tag length %i is longer than the cap 255 characters. exiting...\n", tlen);
290 exit(1);
291 }
292 int mlen = strlen(message);
293 if (mlen > 65535 || mlen < 0) {
294 printf("lognestmonster (lnmStatement): message length %i is longer than the cap 65535 characters. exiting...\n", mlen);
295 exit(1);
296 }
297 new_statement->tag_size = tlen;
298 new_statement->message_size = mlen;
299 new_statement->log = malloc(tlen+mlen+1);
300 strcpy(new_statement->log, tag);
301 strcat(new_statement->log, message);
302 lnm_registry_update();
303 lnm_pushable_push(lnm_registered_items, (lnmItem)new_statement);
304 return (lnmItem)new_statement;
305}
306
307
308lnmItem lnmEvent(void) {
309 lnm_log_event * new_event = malloc(sizeof(lnm_log_event));
310 new_event->type = 1;
311 new_event->pushed = lnm_new_pushable();
312 lnm_registry_update();
313 lnm_pushable_push(lnm_registered_items, (lnmItem)new_event);
314 return (lnmItem)new_event;
315}
316
317void lnmEventPush(lnmItem event, lnmItem item) {
318 if (event == item) {
319 printf("lognestmonster (lnmEventPush): attempt to push event to self. exiting...\n");
320 exit(1);
321 }
322 lnm_log_statement * item_cast = (lnm_log_statement *)item;
323 if (item_cast->boolpushed == 1) {
324 printf("lognestmonster (lnmEventPush): attempt to push an already-pushed log item. exiting...\n");
325 exit(1);
326 }
327 lnm_log_event * event_t = (lnm_log_event *)event;
328 if (event_t->type != 1) {
329 printf("lognestmonster (lnmEventPush): cannot cast non-event to event type. exiting...\n");
330 exit(1);
331 }
332 lnm_pushable_push(event_t->pushed, item);
333 item_cast->boolpushed = 1;
334 lnm_registry_update();
335}
336
337void lnmEventPushS(lnmItem event, uint8_t verbosity, char * tag, char * message) {
338 lnmItem statement = lnmStatement(verbosity, tag, message);
339 lnmEventPush(event, statement);
340}
341
342lnmItem lnmEventI(lnmItem item) {
343 lnmItem event = lnmEvent();
344 lnmEventPush(event, item);
345 return event;
346}
347
348lnmItem lnmEventS(uint8_t verbosity, char * tag, char * message) {
349 lnmItem statement = lnmStatement(verbosity, tag, message);
350 return lnmEventI(statement);
351}
352
353
354void lnm_debug_tabs(int count) {
355 for (int i = 0; i < count; i++) {
356 printf(" ");
357 }
358}
359
360void lnm_debug_parse_item(lnmItem item, int tabcount) {
361 if (lnm_isstatement(item)) {
362 lnm_log_statement * statement = (lnm_log_statement *) item;
363 lnm_debug_tabs(tabcount);
364 printf("Statement {\n");
365
366 lnm_debug_tabs(tabcount+1);
367 char * verbosity;
368 switch (statement->verbosity) {
369 case 0:
370 verbosity = "INFO";
371 break;
372 case 1:
373 verbosity = "DEBUG";
374 break;
375 case 2:
376 verbosity = "VERBOSE";
377 break;
378 case 3:
379 verbosity = "VERYVERBOSE";
380 break;
381 case 4:
382 verbosity = "WARNING";
383 break;
384 case 5:
385 verbosity = "ERROR";
386 break;
387 }
388 printf("Verbosity %s\n", verbosity);
389
390 lnm_debug_tabs(tabcount+1);
391 printf("Timestamp %" PRIu64 "\n", statement->timestamp);
392
393 lnm_debug_tabs(tabcount+1);
394 char tag[statement->tag_size+1];
395 strncpy(tag, statement->log, statement->tag_size);
396 tag[statement->tag_size] = '\0';
397 printf("Tag (%" PRIu8 ") \"%s\"\n", statement->tag_size, tag);
398
399 lnm_debug_tabs(tabcount+1);
400 char message[statement->message_size+1];
401 strncpy(message, statement->log+statement->tag_size, statement->message_size);
402 message[statement->message_size] = '\0';
403 printf("Message (%" PRIu16 ") \"%s\"\n", statement->message_size, message);
404
405 lnm_debug_tabs(tabcount);
406 printf("}\n");
407 } else if (!lnm_isstatement(item)) {
408 lnm_log_event * event = (lnm_log_event *) item;
409 lnm_debug_tabs(tabcount);
410 printf("Event (%" PRIu16 ") [\n", event->pushed->length);
411 for (int i = 0; i < event->pushed->length; i++) {
412 lnmItem item = event->pushed->pushed[i];
413 lnm_debug_parse_item(item, tabcount + 1);
414 }
415 lnm_debug_tabs(tabcount);
416 printf("]\n");
417 } else {
418 printf("lognestmonster (lnm_debug_parse_item): unknown item type. exiting...\n");
419 exit(1);
420 }
421}
422
423void lnm_debug_parse_registry() {
424 printf("Top level registry (%" PRIu16 ") {\n", lnm_registered_items->length);
425 for (int iter = 0; iter < lnm_registered_items->length; iter++) {
426 lnm_debug_parse_item(lnm_registered_items->pushed[iter], 1);
427 }
428 printf("}\n");
429}
430
431#endif // DEFINE_LOGNESTMONSTER
432