-
Notifications
You must be signed in to change notification settings - Fork 0
/
noaaportLog.c
520 lines (444 loc) · 13.1 KB
/
noaaportLog.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
/*
* Copyright © 2011, University Corporation for Atmospheric Research.
*
* See file COPYRIGHT for copying and redistribution conditions.
*/
#define _XOPEN_SOURCE 500
#include <errno.h>
#include <pthread.h>
#include <stdarg.h>
#include <stddef.h> /* NULL */
#include <stdio.h> /* vsnprintf(), snprintf() */
#include <stdlib.h> /* malloc(), free() */
#include <string.h> /* strerrno() */
#include <ulog.h> /* LDM logging module */
#include "config.h"
#include "noaaportLog.h" /* Eat own dog food */
/**
* A log-message. Such structures accumulate.
*/
typedef struct message {
char* string; /**< message buffer */
struct message* next; /**< pointer to next message */
size_t size; /**< size of message buffer */
} Message;
#define DEFAULT_STRING_SIZE 256
/**
* A list of log messages.
*/
typedef struct list {
Message* first;
Message* last;
} List;
/**
* Key for the thread-specific list of log messages.
*/
static pthread_key_t listKey;
/**
* Whether or not the key has been created.
*/
static int keyCreated = 0;
/**
* The mutex that makes this module thread-safe.
*/
static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
/**
* Locks this module's lock.
*
* This function is thread-safe. On entry, this module's lock shall be
* unlocked.
*/
static void lock(void)
{
if (pthread_mutex_lock(&mutex) != 0)
serror("Couldn't lock logging mutex");
}
/**
* Unlocks this module's lock.
*
* This function is thread-safe. On entry, this module's lock shall be locked
* by the current thread.
*/
static void unlock(void)
{
if (pthread_mutex_unlock(&mutex) != 0)
serror("Couldn't unlock logging mutex");
}
/**
* Returns the current thread's message-list.
*
* This function is thread-safe. On entry, this module's lock shall be
* unlocked.
*
* @return The message-list of the current thread or NULL if the message-list
* doesn't exist and couldn't be created.
*/
static List* getList(void)
{
List* list;
int status;
lock();
if (!keyCreated) {
status = pthread_key_create(&listKey, NULL);
if (status != 0) {
serror("getList(): pthread_key_create() failure: %s",
strerror(status));
}
else {
keyCreated = 1;
}
}
unlock();
if (!keyCreated) {
list = NULL;
}
else {
list = pthread_getspecific(listKey);
if (NULL == list) {
list = (List*)malloc(sizeof(List));
if (NULL == list) {
lock();
serror("getList(): malloc() failure");
unlock();
}
else {
if ((status = pthread_setspecific(listKey, list)) != 0) {
lock();
serror("getList(): pthread_setspecific() failure: %s",
strerror(status));
unlock();
free(list);
list = NULL;
}
else {
list->first = NULL;
list->last = NULL;
}
}
}
}
return list;
}
/******************************************************************************
* Public API:
******************************************************************************/
/**
* Logs a system error.
*
* This function is thread-safe.
*/
void nplSerror(
const char* fmt, /**< The message format */
...) /**< Arguments referenced by the format */
{
va_list args;
va_start(args, fmt);
lock();
ulog(LOG_ERR, "%s", strerror(errno));
vulog(LOG_ERR, fmt, args);
unlock();
va_end(args);
}
/*
* Logs a program error.
*
* This function is thread-safe.
*/
void nplError(
const char* const fmt, /**< The message format */
...) /**< Arguments referenced by the format */
{
va_list args;
va_start(args ,fmt);
lock();
(void)vulog(LOG_ERR, fmt, args);
unlock();
va_end(args);
}
/*
* Logs a warning.
*
* This function is thread-safe.
*/
void nplWarn(
const char* const fmt, /**< The message format */
...) /**< Arguments referenced by the format */
{
va_list args;
va_start(args ,fmt);
lock();
(void)vulog(LOG_WARNING, fmt, args);
unlock();
va_end(args);
}
/*
* Logs a notice.
*
* This function is thread-safe.
*/
void nplNotice(
const char* const fmt, /**< The message format */
...) /**< Arguments referenced by the format */
{
va_list args;
va_start(args ,fmt);
lock();
(void)vulog(LOG_NOTICE, fmt, args);
unlock();
va_end(args);
}
/*
* Logs an informational message.
*
* This function is thread-safe.
*/
void nplInfo(
const char* const fmt, /**< The message format */
...) /**< Arguments referenced by the format */
{
va_list args;
va_start(args ,fmt);
lock();
(void)vulog(LOG_INFO, fmt, args);
unlock();
va_end(args);
}
/*
* Logs a debuging message.
*
* This function is thread-safe.
*/
void nplDebug(
const char* const fmt, /**< The message format */
...) /**< Arguments referenced by the format */
{
va_list args;
va_start(args ,fmt);
lock();
(void)vulog(LOG_DEBUG, fmt, args);
unlock();
va_end(args);
}
/**
* Clears the accumulated log-messages.
*
* This function is thread-safe.
*/
static void nplClear()
{
List* list = getList();
if (NULL != list)
list->last = NULL;
}
/**
* Adds a variadic log-message to the message-list for the current thread.
*
* This function is thread-safe.
*
* @retval 0 Success
* @retval EAGAIN Failure due to the buffer being too small for the
* message. The buffer has been expanded and the client
* should call this function again.
* @retval EINVAL There are insufficient arguments. Error message logged.
* @retval EILSEQ A wide-character code that doesn't correspond to a
* valid character has been detected. Error message logged.
* @retval ENOMEM Out-of-memory. Error message logged.
* @retval EOVERFLOW The length of the message is greater than {INT_MAX}.
* Error message logged.
*/
int nplVadd(
const char* const fmt, /**< The message format or NULL for no message */
va_list args) /**< The arguments referenced by the format. */
{
int status = 0; /* default success */
if (NULL != fmt) {
List* list = getList();
if (NULL != list) {
Message* msg = (NULL == list->last) ? list->first :
list->last->next;
status = 0;
if (msg == NULL) {
msg = (Message*)malloc(sizeof(Message));
if (msg == NULL) {
status = errno;
lock();
serror("nplVadd(): malloc(%lu) failure",
(unsigned long)sizeof(Message));
unlock();
}
else {
char* string = (char*)malloc(DEFAULT_STRING_SIZE);
if (NULL == string) {
status = errno;
lock();
serror("nplVadd(): malloc(%lu) failure",
(unsigned long)DEFAULT_STRING_SIZE);
unlock();
}
else {
msg->string = string;
msg->size = DEFAULT_STRING_SIZE;
msg->next = NULL;
if (NULL == list->first)
list->first = msg; /* very first message */
}
}
}
if (0 == status) {
int nbytes = vsnprintf(msg->string, msg->size, fmt, args);
if (0 > nbytes) {
status = errno;
lock();
serror("nplVadd(): vsnprintf() failure");
unlock();
}
else if (msg->size <= nbytes) {
/* The buffer is too small for the message */
size_t size = nbytes + 1;
char* string = (char*)malloc(size);
if (NULL == string) {
status = errno;
lock();
serror("nplVadd(): malloc(%lu) failure",
(unsigned long)size);
unlock();
}
else {
free(msg->string);
msg->string = string;
msg->size = size;
status = EAGAIN;
}
}
else {
if (NULL != list->last)
list->last->next = msg;
list->last = msg;
}
} /* have a message structure */
} /* message-list isn't NULL */
} /* arguments aren't NULL */
return status;
}
/*
* Sets the first log-message.
*
* This function is thread-safe.
*/
void nplStart(
const char* const fmt, /**< The message format */
...) /**< Arguments referenced by the format */
{
va_list args;
nplClear();
va_start(args, fmt);
if (EAGAIN == nplVadd(fmt, args)) {
va_end(args);
va_start(args, fmt);
(void)nplVadd(fmt, args);
}
va_end(args);
}
/*
* Adds a log-message.
*
* This function is thread-safe.
*/
void nplAdd(
const char* const fmt, /**< The message format */
...) /**< Arguments referenced by the format */
{
va_list args;
va_start(args, fmt);
if (EAGAIN == nplVadd(fmt, args)) {
va_end(args);
va_start(args, fmt);
(void)nplVadd(fmt, args);
}
va_end(args);
}
/*
* Adds a system error-message based on the value of "errno" and a higher-level
* error-message.
*
* This function is thread-safe.
*/
void nplErrno(
const char* const fmt, /**< [in] The higher-level message format or NULL
* for no higher-level message */
...) /**< [in] Arguments referenced by the format */
{
va_list args;
nplStart("%s", strerror(errno));
va_start(args, fmt);
if (EAGAIN == nplVadd(fmt, args)) {
va_end(args);
va_start(args, fmt);
(void)nplVadd(fmt, args);
}
va_end(args);
}
/*
* Adds a system error-message based on a given "errno" value and a
* higher-level error-message.
*
* This function is thread-safe.
*/
void nplErrnum(
const int errnum, /**< [in] The "errno" value */
const char* const fmt, /**< The higher-level message format or NULL
* for no higher-level message */
...) /**< Arguments referenced by the format */
{
va_list args;
nplStart("%s", strerror(errnum));
va_start(args, fmt);
if (EAGAIN == nplVadd(fmt, args)) {
va_end(args);
va_start(args, fmt);
(void)nplVadd(fmt, args);
}
va_end(args);
}
/*
* Logs the currently-accumulated log-messages and resets the message-list for
* the current thread.
*
* This function is thread-safe.
*/
void nplLog(
const int level) /**< The level at which to log the messages. One of
* LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, or
* LOG_DEBUG; otherwise, the behavior is undefined. */
{
List* list = getList();
if (NULL != list && NULL != list->last) {
static const unsigned allPrioritiesMask =
LOG_MASK(LOG_ERR) |
LOG_MASK(LOG_WARNING) |
LOG_MASK(LOG_NOTICE) |
LOG_MASK(LOG_INFO) |
LOG_MASK(LOG_DEBUG);
const int priorityMask = LOG_MASK(level);
lock();
if ((priorityMask & allPrioritiesMask) == 0) {
nplError("nplLog(): Invalid logging-level (%d)", level);
}
else if (getulogmask() & priorityMask) {
const Message* msg;
for (msg = list->first; NULL != msg; msg = msg->next) {
/*
* NB: The message is not printed using "ulog(level,
* msg->string)" because "msg->string" might have formatting
* characters in it (e.g., "%") from, for example, a call to
* "s_prod_info()" with a dangerous product-identifier.
*/
ulog(level, "%s", msg->string);
if (msg == list->last)
break;
} /* message loop */
} /* messages should be printed */
unlock();
nplClear();
} /* have messages */
}