Index

lognestmonster / 930a09b

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?
13719 Nov 2019 22:12930a09bLinux timestamps; more detail debug parsingJosh Stockin1538N

Blob @ lognestmonster / src / c / lognestmonster.h

text/plain6211 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;
42
43
44// Pushable structure
45
46typedef struct {
47 uint16_t length;
48 lnmItem * pushed;
49} lnm_pushable;
50
51lnm_pushable * lnm_new_pushable() {
52 lnm_pushable * new_pushable = malloc(sizeof(lnm_pushable));
53 new_pushable->length = 0;
54 new_pushable->pushed = malloc(0);
55 return new_pushable;
56}
57void lnm_pushable_push(lnm_pushable * pushable, lnmItem item) {
58 pushable->pushed = realloc(pushable->pushed, sizeof(lnmItem)*(pushable->length+1)); // reallocate with size: length+1
59 pushable->pushed[pushable->length] = item;
60 pushable->length += 1;
61}
62
63
64// Statement and event structure definitions
65
66typedef struct {
67 uint8_t type; // Used internally; 0 = statement, 1 = event
68 lnm_pushable * pushed; // array of memory locations for lnm_event and lnm_log_statement structs
69} lnm_log_event;
70
71typedef struct {
72 // word 1, 4 bytes data 4 bytes padding
73 uint8_t type:1; // Used internally; 0 = statement, 1 = event
74 uint8_t verbosity:3; // lnmVerbosityLevel, 0-5
75 uint8_t tag_size; // character length of the tag
76 uint16_t message_size; // character length of the message
77
78 // word 2, 8 bytes data
79 uint64_t timestamp; // 64-bit millisecond timestamp
80
81 // word 3, 8 bytes data
82 char * log; // tag string + message string
83} lnm_log_statement;
84
85
86// Core library
87
88unsigned long lnm_getus(void) {
89 struct timeval current_time;
90 gettimeofday(&current_time, NULL);
91 unsigned long ms = (current_time.tv_sec*1000000+current_time.tv_usec);
92 return ms;
93}
94
95unsigned long lnm_getms(void) {
96 return lnm_getus()/1000;
97}
98
99lnmItem lnmStatement(uint8_t verbosity, char * tag, char * message) {
100 lnm_log_statement * new_statement = malloc(sizeof(lnm_log_statement));
101 new_statement->type = 0;
102 new_statement->verbosity = verbosity;
103 new_statement->timestamp = lnm_getms();
104 int tlen = strlen(tag);
105 if (tlen > 255 || tlen < 0) {
106 printf("lognestmonster: tag length %i is longer than the cap 255 characters. exiting...\n", tlen);
107 exit(1);
108 }
109 int mlen = strlen(message);
110 if (mlen > 65535 || mlen < 0) {
111 printf("lognestmonster: message length %i is longer than the cap 65535 characters. exiting...\n", mlen);
112 exit(1);
113 }
114 new_statement->tag_size = tlen;
115 new_statement->message_size = mlen;
116 new_statement->log = malloc(tlen+mlen+1);
117 strcpy(new_statement->log, tag);
118 strcat(new_statement->log, message);
119 return (lnmItem)new_statement;
120}
121
122lnmItem lnmEvent(void) {
123 lnm_log_event * new_event = malloc(sizeof(lnm_log_event));
124 new_event->type = 1;
125 new_event->pushed = lnm_new_pushable();
126 return (lnmItem)new_event;
127}
128
129void lnmEventPush(lnmItem event, lnmItem item) {
130 if (event == item) {
131 printf("lognestmonster: attempt to push event to self. exiting...\n");
132 exit(1);
133 }
134 lnm_pushable_push(((lnm_log_event*)event)->pushed, item);
135}
136
137void lnmEventPushS(lnmItem event, uint8_t verbosity, char * tag, char * message) {
138 lnmItem statement = lnmStatement(verbosity, tag, message);
139 lnmEventPush(event, statement);
140}
141
142lnmItem lnmEventI(lnmItem item) {
143 lnmItem event = lnmEvent();
144 lnmEventPush(event, item);
145 return event;
146}
147
148lnmItem lnmEventS(uint8_t verbosity, char * tag, char * message) {
149 lnmItem statement = lnmStatement(verbosity, tag, message);
150 return lnmEventI(statement);
151}
152
153void lnm_debug_tabs(int count) {
154 for (int i = 0; i < count; i++) {
155 printf(" ");
156 }
157}
158
159void lnm_debug_parse(lnmItem item, int tabcount) {
160 lnm_log_statement * statement = (lnm_log_statement *) item;
161 if (statement->type == 0) {
162 lnm_debug_tabs(tabcount);
163 printf("Statement {\n");
164
165 lnm_debug_tabs(tabcount+1);
166 char * verbosity;
167 switch (statement->verbosity) {
168 case 0:
169 verbosity = "INFO";
170 break;
171 case 1:
172 verbosity = "DEBUG";
173 break;
174 case 2:
175 verbosity = "VERBOSE";
176 break;
177 case 3:
178 verbosity = "VERYVERBOSE";
179 break;
180 case 4:
181 verbosity = "WARNING";
182 break;
183 case 5:
184 verbosity = "ERROR";
185 break;
186 }
187 printf("Verbosity %s\n", verbosity);
188
189 lnm_debug_tabs(tabcount+1);
190 printf("Timestamp %ld\n", statement->timestamp);
191
192 lnm_debug_tabs(tabcount+1);
193 char tag[statement->tag_size+1];
194 strncpy(tag, statement->log, statement->tag_size);
195 tag[statement->tag_size] = '\0';
196 printf("Tag (%i) %s\n", statement->tag_size, tag);
197
198 lnm_debug_tabs(tabcount+1);
199 char message[statement->message_size+1];
200 strncpy(message, statement->log+statement->tag_size, statement->message_size);
201 message[statement->message_size] = '\0';
202 printf("Message (%i) %s\n", statement->message_size, message);
203
204 lnm_debug_tabs(tabcount);
205 printf("}\n");
206 } else if (statement->type == 1) {
207 lnm_debug_tabs(tabcount);
208 lnm_log_event * event = (lnm_log_event *) item;
209 printf("Event (%i) [\n", event->pushed->length);
210 for (int i = 0; i < event->pushed->length; i++) {
211 lnmItem item = event->pushed->pushed[i];
212 lnm_debug_parse(item, tabcount + 1);
213 }
214 lnm_debug_tabs(tabcount);
215 printf("]\n");
216 } else {
217 printf("Bad item type\n");
218 exit(1);
219 }
220}
221
222#endif
223