Index

lognestmonster / 6de05cb

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?
14825 Nov 2019 20:076de05cbUpdate behavior of lnm_pushable_indexofJosh Stockin121N

Blob @ lognestmonster / src / c / lognestmonster.h

text/plain11568 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#ifndef __LOGNESTMONSTER__
24#define __LOGNESTMONSTER__ 1
25
26// SEMANTICS
27// internal definitions: lnm_lower_camel_case
28// public definitions: lnmUpperCamelCase
29
30// stdc inclusions
31
32#include <stdint.h>
33#include <stdlib.h>
34#include <string.h>
35#include <sys/time.h>
36
37
38// Base definitions
39
40enum lnmVerbosityLevel {lnmInfo, lnmDebug, lnmVerbose, lnmVeryVerbose, lnmWarning, lnmError};
41typedef uint8_t * lnmItem;
42typedef uint8_t * lnmQueue;
43
44
45// Pushable structure
46
47typedef struct {
48 uint16_t length;
49 lnmItem * pushed;
50} lnm_pushable;
51
52lnm_pushable * lnm_new_pushable() {
53 lnm_pushable * new_pushable = malloc(sizeof(lnm_pushable));
54 new_pushable->length = 0;
55 new_pushable->pushed = malloc(0);
56 return new_pushable;
57}
58
59void lnm_pushable_push(lnm_pushable * pushable, lnmItem item) {
60 if (pushable->length+1 >= 65535) {
61 printf("lognestmonster (lnm_pushable_push): pushable reached cap length 65535. exiting...\n");
62 exit(1);
63 }
64 pushable->pushed = realloc(pushable->pushed, sizeof(lnmItem)*(pushable->length+1)); // reallocate with size: length+1
65 pushable->pushed[pushable->length] = item;
66 pushable->length += 1;
67}
68
69int lnm_pushable_indexof(lnm_pushable * pushable, lnmItem item) {
70 int len = pushable->length;
71 for (int iter = 0; iter<len; iter++) {
72 if (item == pushable->pushed[iter]) return iter;
73 }
74 printf("lognestmonster (lnm_pushable_indexof): cannot find item in pushable. exiting...\n");
75 exit(1);
76}
77
78void lnm_pushable_remove(lnm_pushable * pushable, int index) {
79 if (index>=pushable->length || index < 0) {
80 printf("lognestmonster (lnm_pushable_remove): attempt to remove index out of pushable bounds. exiting...\n");
81 exit(1);
82 }
83 lnmItem * new_pushed = malloc(sizeof(lnmItem)*(pushable->length-1)); // map array excluding index
84 for (int iter = 0; iter<index; iter++) {
85 new_pushed[iter] = pushable->pushed[iter];
86 }
87 for (int iter = index+1; iter<pushable->length; iter++) {
88 new_pushed[iter-1] = pushable->pushed[iter];
89 }
90 free(pushable->pushed);
91 pushable->length--;
92 pushable->pushed = new_pushed;
93}
94
95void lnm_pushable_free(lnm_pushable * pushable) {
96 free(pushable->pushed);
97 free(pushable);
98}
99
100
101// Statement and event structure definitions
102
103typedef struct {
104 uint8_t type:1; // Used internally; 0 = statement, 1 = event
105 uint8_t boolpushed:1; // whether or not this log item has been pushed
106 lnm_pushable * pushed; // array of memory locations for lnm_log_event and lnm_log_statement structs
107} lnm_log_event;
108
109typedef struct {
110 // word 1, 4 bytes data 4 bytes padding
111 uint8_t type:1; // Used internally; 0 = statement, 1 = event
112 uint8_t boolpushed:1; // whether or not this log item has been pushed
113 uint8_t verbosity:3; // lnmVerbosityLevel, 0-5
114 uint8_t tag_size; // character length of the tag
115 uint16_t message_size; // character length of the message
116
117 // word 2, 8 bytes data
118 uint64_t timestamp; // 64-bit millisecond timestamp
119
120 // word 3, 8 bytes data
121 char * log; // tag string + message string
122} lnm_log_statement;
123
124
125// Queue structure definition
126
127typedef struct {
128 char * name;
129 char * out_path;
130 uint64_t timestamp;
131 lnm_pushable * pushed;
132} lnm_queue;
133
134
135// Library utilities
136
137unsigned long lnm_getus(void) {
138 struct timeval current_time;
139 gettimeofday(&current_time, NULL);
140 unsigned long ms = (current_time.tv_sec*1000000+current_time.tv_usec);
141 return ms;
142}
143
144unsigned long lnm_getms(void) {
145 return lnm_getus()/1000;
146}
147
148
149int lnm_isstatement(lnmItem item) {
150 lnm_log_statement * s = (lnm_log_statement *)item;
151 return !s->type;
152}
153
154
155// Item registry utils
156
157lnm_pushable * lnm_registered_queues;
158lnm_pushable * lnm_registered_items;
159static int lnm_registry_update_count;
160
161void lnm_registry_update(void) { // scan each registered item
162 for (int iter = 0; iter < lnm_registered_items->length; iter++) {
163 lnm_log_statement * s = (lnm_log_statement *)lnm_registered_items->pushed[iter];
164 if (s->boolpushed == 1) { // if the registered item has been pushed elsewhere, remove it from the top level of the registry
165 lnm_registry_update_count++;
166 lnm_pushable_remove(lnm_registered_items, iter);
167 iter--;
168 }
169 }
170}
171
172
173// Core library
174
175void lnm_free_item(lnmItem item) {
176 lnm_log_statement * item_cast = (lnm_log_statement *)item;
177 if (item_cast->type == 0) {
178 item_cast->boolpushed = 1; // flush item out of the registry
179 lnm_registry_update();
180
181 free(item_cast->log);
182 free(item_cast);
183 } else if (item_cast->type == 1) {
184 lnm_log_event * event_cast = (lnm_log_event *)item_cast;
185 event_cast->boolpushed = 1; // flush item out of the registry
186 lnm_registry_update();
187
188 for (int iter = 0; iter < event_cast->pushed->length; iter++) { // free logtree children
189 lnmItem newitem = event_cast->pushed->pushed[iter];
190 lnm_free_item(newitem);
191 }
192 lnm_pushable_free(event_cast->pushed);
193 free(event_cast);
194 } else {
195 printf("lognestmonster (lnm_free_item): non-log item passed to function. exiting...\n");
196 }
197}
198
199void lnm_free_registry() {
200 for (int iter = 0; iter < lnm_registered_items->length; iter++) {
201 lnm_free_item(lnm_registered_items->pushed[iter]);
202 }
203}
204
205
206lnmQueue lnmQueueInit(char * name, char * out_path) {
207 if (lnm_registered_queues == NULL) {
208 lnm_registered_queues = lnm_new_pushable();
209 }
210 if (lnm_registered_items == NULL) {
211 lnm_registered_items = lnm_new_pushable();
212 }
213
214 lnm_queue * new_queue = malloc(sizeof(lnm_queue));
215 new_queue->name = malloc(strlen(name)+1);
216 new_queue->out_path = malloc(strlen(out_path)+1);
217 strcpy(new_queue->name, name);
218 strcpy(new_queue->out_path, out_path);
219 new_queue->pushed = lnm_new_pushable();
220
221 lnm_pushable_push(lnm_registered_queues, (lnmQueue)new_queue);
222 return (lnmQueue)new_queue;
223}
224
225lnmQueue lnmQueueByName(char * name) {
226 if (lnm_registered_queues == NULL) {
227 printf("lognestmonster (lnmQueueByName): queue registry is nonexistant. exiting...\n");
228 exit(1);
229 }
230 if (lnm_registered_queues->length == 0) {
231 printf("lognestmonster (lnmQueueByName): queue registry is empty. exiting...\n");
232 exit(1);
233 }
234 for (int iter = 0; iter<lnm_registered_queues->length; iter++) {
235 lnm_queue * iterqueue = (lnm_queue *)lnm_registered_queues->pushed[iter];
236 if (strcmp(iterqueue->name, name)==0) {
237 return (lnmQueue)iterqueue;
238 }
239 }
240 printf("lognestmonster (lnmQueueByName): queue not found in registry. exiting...\n");
241 exit(1);
242}
243
244
245lnmItem lnmStatement(uint8_t verbosity, char * tag, char * message) {
246 lnm_log_statement * new_statement = malloc(sizeof(lnm_log_statement));
247 new_statement->type = 0;
248 new_statement->verbosity = verbosity;
249 new_statement->timestamp = lnm_getus();
250 int tlen = strlen(tag);
251 if (tlen > 255 || tlen < 0) {
252 printf("lognestmonster (lnmStatement): tag length %i is longer than the cap 255 characters. exiting...\n", tlen);
253 exit(1);
254 }
255 int mlen = strlen(message);
256 if (mlen > 65535 || mlen < 0) {
257 printf("lognestmonster (lnmStatement): message length %i is longer than the cap 65535 characters. exiting...\n", mlen);
258 exit(1);
259 }
260 new_statement->tag_size = tlen;
261 new_statement->message_size = mlen;
262 new_statement->log = malloc(tlen+mlen+1);
263 strcpy(new_statement->log, tag);
264 strcat(new_statement->log, message);
265 lnm_registry_update();
266 lnm_pushable_push(lnm_registered_items, (lnmItem)new_statement);
267 return (lnmItem)new_statement;
268}
269
270
271lnmItem lnmEvent(void) {
272 lnm_log_event * new_event = malloc(sizeof(lnm_log_event));
273 new_event->type = 1;
274 new_event->pushed = lnm_new_pushable();
275 lnm_registry_update();
276 lnm_pushable_push(lnm_registered_items, (lnmItem)new_event);
277 return (lnmItem)new_event;
278}
279
280void lnmEventPush(lnmItem event, lnmItem item) {
281 if (event == item) {
282 printf("lognestmonster (lnmEventPush): attempt to push event to self. exiting...\n");
283 exit(1);
284 }
285 lnm_log_statement * item_cast = (lnm_log_statement *)item;
286 if (item_cast->boolpushed == 1) {
287 printf("lognestmonster (lnmEventPush): attempt to push an already-pushed log item. exiting...\n");
288 exit(1);
289 }
290 lnm_log_event * event_t = (lnm_log_event *)event;
291 if (event_t->type != 1) {
292 printf("lognestmonster (lnmEventPush): cannot cast non-event to event type. exiting...\n");
293 exit(1);
294 }
295 lnm_pushable_push(event_t->pushed, item);
296 item_cast->boolpushed = 1;
297 lnm_registry_update();
298}
299
300void lnmEventPushS(lnmItem event, uint8_t verbosity, char * tag, char * message) {
301 lnmItem statement = lnmStatement(verbosity, tag, message);
302 lnmEventPush(event, statement);
303}
304
305lnmItem lnmEventI(lnmItem item) {
306 lnmItem event = lnmEvent();
307 lnmEventPush(event, item);
308 return event;
309}
310
311lnmItem lnmEventS(uint8_t verbosity, char * tag, char * message) {
312 lnmItem statement = lnmStatement(verbosity, tag, message);
313 return lnmEventI(statement);
314}
315
316
317void lnm_debug_tabs(int count) {
318 for (int i = 0; i < count; i++) {
319 printf(" ");
320 }
321}
322
323void lnm_debug_parse_item(lnmItem item, int tabcount) {
324 if (lnm_isstatement(item)) {
325 lnm_log_statement * statement = (lnm_log_statement *) item;
326 lnm_debug_tabs(tabcount);
327 printf("Statement {\n");
328
329 lnm_debug_tabs(tabcount+1);
330 char * verbosity;
331 switch (statement->verbosity) {
332 case 0:
333 verbosity = "INFO";
334 break;
335 case 1:
336 verbosity = "DEBUG";
337 break;
338 case 2:
339 verbosity = "VERBOSE";
340 break;
341 case 3:
342 verbosity = "VERYVERBOSE";
343 break;
344 case 4:
345 verbosity = "WARNING";
346 break;
347 case 5:
348 verbosity = "ERROR";
349 break;
350 }
351 printf("Verbosity %s\n", verbosity);
352
353 lnm_debug_tabs(tabcount+1);
354 printf("Timestamp %ld\n", statement->timestamp);
355
356 lnm_debug_tabs(tabcount+1);
357 char tag[statement->tag_size+1];
358 strncpy(tag, statement->log, statement->tag_size);
359 tag[statement->tag_size] = '\0';
360 printf("Tag (%i) \"%s\"\n", statement->tag_size, tag);
361
362 lnm_debug_tabs(tabcount+1);
363 char message[statement->message_size+1];
364 strncpy(message, statement->log+statement->tag_size, statement->message_size);
365 message[statement->message_size] = '\0';
366 printf("Message (%i) \"%s\"\n", statement->message_size, message);
367
368 lnm_debug_tabs(tabcount);
369 printf("}\n");
370 } else if (!lnm_isstatement(item)) {
371 lnm_log_event * event = (lnm_log_event *) item;
372 lnm_debug_tabs(tabcount);
373 printf("Event (%i) [\n", event->pushed->length);
374 for (int i = 0; i < event->pushed->length; i++) {
375 lnmItem item = event->pushed->pushed[i];
376 lnm_debug_parse_item(item, tabcount + 1);
377 }
378 lnm_debug_tabs(tabcount);
379 printf("]\n");
380 } else {
381 printf("lognestmonster (lnm_debug_parse_item): unknown item type. exiting...\n");
382 exit(1);
383 }
384}
385
386void lnm_debug_parse_registry() {
387 printf("Top level registry (%i) {\n", lnm_registered_items->length);
388 for (int iter = 0; iter < lnm_registered_items->length; iter++) {
389 lnm_debug_parse_item(lnm_registered_items->pushed[iter], 1);
390 }
391 printf("}\n");
392}
393
394#endif
395