Coverage Report

Created: 2023-09-25 07:12

/src/open5gs/lib/core/ogs-log.c
Line
Count
Source (jump to first uncovered line)
1
/*
2
 * Copyright (C) 2019 by Sukchan Lee <acetcom@gmail.com>
3
 *
4
 * This file is part of Open5GS.
5
 *
6
 * This program is free software: you can redistribute it and/or modify
7
 * it under the terms of the GNU Affero General Public License as published by
8
 * the Free Software Foundation, either version 3 of the License, or
9
 * (at your option) any later version.
10
 *
11
 * This program is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14
 * GNU General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU General Public License
17
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
18
 */
19
20
#include "core-config-private.h"
21
22
#if HAVE_CTYPE_H
23
#include <ctype.h>
24
#endif
25
26
#if HAVE_STDARG_H
27
#include <stdarg.h>
28
#endif
29
30
#include "ogs-core.h"
31
32
24.2k
#define TA_NOR              "\033[0m"       /* all off */
33
34
#define TA_FGC_BLACK        "\033[30m"      /* Black */
35
#define TA_FGC_RED          "\033[31m"      /* Red */
36
6.07k
#define TA_FGC_BOLD_RED     "\033[1;31m"    /* Bold Red */
37
6.07k
#define TA_FGC_GREEN        "\033[32m"      /* Green */
38
6.07k
#define TA_FGC_BOLD_GREEN   "\033[1;32m"    /* Bold Green */
39
6.07k
#define TA_FGC_YELLOW       "\033[33m"      /* Yellow */
40
6.07k
#define TA_FGC_BOLD_YELLOW  "\033[1;33m"    /* Bold Yellow */
41
#define TA_FGC_BOLD_BLUE    "\033[1;34m"    /* Bold Blue */
42
#define TA_FGC_BOLD_MAGENTA "\033[1;35m"    /* Bold Magenta */
43
6.07k
#define TA_FGC_BOLD_CYAN    "\033[1;36m"    /* Bold Cyan */
44
6.07k
#define TA_FGC_WHITE        "\033[37m"      /* White  */
45
6.07k
#define TA_FGC_BOLD_WHITE   "\033[1;37m"    /* Bold White  */
46
#define TA_FGC_DEFAULT      "\033[39m"      /* default */
47
48
typedef enum {
49
    OGS_LOG_STDERR_TYPE,
50
    OGS_LOG_FILE_TYPE,
51
} ogs_log_type_e;
52
53
typedef struct ogs_log_s {
54
    ogs_lnode_t node;
55
56
    ogs_log_type_e type;
57
58
    union {
59
        struct {
60
            FILE *out;
61
            const char *name;
62
        } file;
63
    };
64
65
    struct {
66
    ED7(uint8_t color:1;,
67
        uint8_t timestamp:1;,
68
        uint8_t domain:1;,
69
        uint8_t level:1;,
70
        uint8_t fileline:1;,
71
        uint8_t function:1;,
72
        uint8_t linefeed:1;)
73
    } print;
74
75
    void (*writer)(ogs_log_t *log, ogs_log_level_e level, const char *string);
76
77
} ogs_log_t;
78
79
typedef struct ogs_log_domain_s {
80
    ogs_lnode_t node;
81
82
    int id;
83
    ogs_log_level_e level;
84
    const char *name;
85
} ogs_log_domain_t;
86
87
const char *level_strings[] = {
88
    NULL,
89
    "FATAL", "ERROR", "WARNING", "INFO", "DEBUG", "TRACE",
90
};
91
92
static OGS_POOL(log_pool, ogs_log_t);
93
static OGS_LIST(log_list);
94
95
static OGS_POOL(domain_pool, ogs_log_domain_t);
96
static OGS_LIST(domain_list);
97
98
static ogs_log_t *add_log(ogs_log_type_e type);
99
static int file_cycle(ogs_log_t *log);
100
101
static char *log_timestamp(char *buf, char *last,
102
        int use_color);
103
static char *log_domain(char *buf, char *last,
104
        const char *name, int use_color);
105
static char *log_content(char *buf, char *last,
106
        const char *format, va_list ap);
107
static char *log_level(char *buf, char *last,
108
        ogs_log_level_e level, int use_color);
109
static char *log_linefeed(char *buf, char *last);
110
111
static void file_writer(
112
        ogs_log_t *log, ogs_log_level_e level, const char *string);
113
114
void ogs_log_init(void)
115
1
{
116
1
    ogs_pool_init(&log_pool, ogs_core()->log.pool);
117
1
    ogs_pool_init(&domain_pool, ogs_core()->log.domain_pool);
118
119
1
    ogs_log_add_domain("core", ogs_core()->log.level);
120
1
    ogs_log_add_stderr();
121
1
}
122
123
void ogs_log_final(void)
124
0
{
125
0
    ogs_log_t *log, *saved_log;
126
0
    ogs_log_domain_t *domain, *saved_domain;
127
128
0
    ogs_list_for_each_safe(&log_list, saved_log, log)
129
0
        ogs_log_remove(log);
130
0
    ogs_pool_final(&log_pool);
131
132
0
    ogs_list_for_each_safe(&domain_list, saved_domain, domain)
133
0
        ogs_log_remove_domain(domain);
134
0
    ogs_pool_final(&domain_pool);
135
0
}
136
137
void ogs_log_cycle(void)
138
0
{
139
0
    ogs_log_t *log = NULL;
140
141
0
    ogs_list_for_each(&log_list, log) {
142
0
        switch(log->type) {
143
0
        case OGS_LOG_FILE_TYPE:
144
0
            file_cycle(log);
145
0
        default:
146
0
            break;
147
0
        }
148
0
    }
149
0
}
150
151
ogs_log_t *ogs_log_add_stderr(void)
152
1
{
153
1
    ogs_log_t *log = NULL;
154
    
155
1
    log = add_log(OGS_LOG_STDERR_TYPE);
156
1
    ogs_assert(log);
157
158
1
    log->file.out = stderr;
159
1
    log->writer = file_writer;
160
161
1
#if !defined(_WIN32)
162
1
    log->print.color = 1;
163
1
#endif
164
165
1
    return log;
166
1
}
167
168
ogs_log_t *ogs_log_add_file(const char *name)
169
0
{
170
0
    FILE *out = NULL;
171
0
    ogs_log_t *log = NULL;
172
173
0
    out = fopen(name, "a");
174
0
    if (!out) 
175
0
        return NULL;
176
    
177
0
    log = add_log(OGS_LOG_FILE_TYPE);
178
0
    ogs_assert(log);
179
180
0
    log->file.name = name;
181
0
    log->file.out = out;
182
183
0
    log->writer = file_writer;
184
185
0
    return log;
186
0
}
187
188
void ogs_log_remove(ogs_log_t *log)
189
0
{
190
0
    ogs_assert(log);
191
192
0
    ogs_list_remove(&log_list, log);
193
194
0
    if (log->type == OGS_LOG_FILE_TYPE) {
195
0
        ogs_assert(log->file.out);
196
0
        fclose(log->file.out);
197
0
        log->file.out = NULL;
198
0
    }
199
200
0
    ogs_pool_free(&log_pool, log);
201
0
}
202
203
ogs_log_domain_t *ogs_log_add_domain(const char *name, ogs_log_level_e level)
204
7
{
205
7
    ogs_log_domain_t *domain = NULL;
206
207
7
    ogs_assert(name);
208
209
7
    ogs_pool_alloc(&domain_pool, &domain);
210
7
    ogs_assert(domain);
211
212
7
    domain->name = name;
213
7
    domain->id = ogs_pool_index(&domain_pool, domain);
214
7
    domain->level = level;
215
216
7
    ogs_list_add(&domain_list, domain);
217
218
7
    return domain;
219
7
}
220
221
ogs_log_domain_t *ogs_log_find_domain(const char *name)
222
7
{
223
7
    ogs_log_domain_t *domain = NULL;
224
225
7
    ogs_assert(name);
226
227
7
    ogs_list_for_each(&domain_list, domain)
228
27
        if (!ogs_strcasecmp(domain->name, name))
229
1
            return domain;
230
231
6
    return NULL;
232
7
}
233
234
void ogs_log_remove_domain(ogs_log_domain_t *domain)
235
0
{
236
0
    ogs_assert(domain);
237
238
0
    ogs_list_remove(&domain_list, domain);
239
0
    ogs_pool_free(&domain_pool, domain);
240
0
}
241
242
void ogs_log_set_domain_level(int id, ogs_log_level_e level)
243
1
{
244
1
    ogs_log_domain_t *domain = NULL;
245
246
1
    ogs_assert(id > 0 && id <= ogs_core()->log.domain_pool);
247
248
1
    domain = ogs_pool_find(&domain_pool, id);
249
1
    ogs_assert(domain);
250
251
1
    domain->level = level;
252
1
}
253
254
ogs_log_level_e ogs_log_get_domain_level(int id)
255
0
{
256
0
    ogs_log_domain_t *domain = NULL;
257
258
0
    ogs_assert(id > 0 && id <= ogs_core()->log.domain_pool);
259
260
0
    domain = ogs_pool_find(&domain_pool, id);
261
0
    ogs_assert(domain);
262
263
0
    return domain->level;
264
0
}
265
266
const char *ogs_log_get_domain_name(int id)
267
0
{
268
0
    ogs_log_domain_t *domain = NULL;
269
270
0
    ogs_assert(id > 0 && id <= ogs_core()->log.domain_pool);
271
272
0
    domain = ogs_pool_find(&domain_pool, id);
273
0
    ogs_assert(domain);
274
275
0
    return domain->name;
276
0
}
277
278
int ogs_log_get_domain_id(const char *name)
279
0
{
280
0
    ogs_log_domain_t *domain = NULL;
281
282
0
    ogs_assert(name);
283
    
284
0
    domain = ogs_log_find_domain(name);
285
0
    ogs_assert(domain);
286
287
0
    return domain->id;
288
0
}
289
290
void ogs_log_install_domain(int *domain_id,
291
        const char *name, ogs_log_level_e level)
292
7
{
293
7
    ogs_log_domain_t *domain = NULL;
294
295
7
    ogs_assert(domain_id);
296
7
    ogs_assert(name);
297
298
7
    domain = ogs_log_find_domain(name);
299
7
    if (domain) {
300
1
        ogs_warn("`%s` log-domain duplicated", name);
301
1
        if (level != domain->level) {
302
1
            ogs_warn("[%s]->[%s] log-level changed",
303
1
                    level_strings[domain->level], level_strings[level]);
304
1
            ogs_log_set_domain_level(domain->id, level);
305
1
        }
306
6
    } else {
307
6
        domain = ogs_log_add_domain(name, level);
308
6
        ogs_assert(domain);
309
6
    }
310
311
7
    *domain_id = domain->id;
312
7
}
313
314
void ogs_log_set_mask_level(const char *_mask, ogs_log_level_e level)
315
0
{
316
0
    ogs_log_domain_t *domain = NULL;
317
318
0
    if (_mask) {
319
0
        const char *delim = " \t\n,:";
320
0
        char *mask = NULL;
321
0
        char *saveptr;
322
0
        char *name;
323
324
0
        mask = ogs_strdup(_mask);
325
0
        ogs_assert(mask);
326
327
0
        for (name = ogs_strtok_r(mask, delim, &saveptr);
328
0
            name != NULL;
329
0
            name = ogs_strtok_r(NULL, delim, &saveptr)) {
330
331
0
            domain = ogs_log_find_domain(name);
332
0
            if (domain)
333
0
                domain->level = level;
334
0
        }
335
336
0
        ogs_free(mask);
337
0
    } else {
338
0
        ogs_list_for_each(&domain_list, domain)
339
0
            domain->level = level;
340
0
    }
341
0
}
342
343
static ogs_log_level_e ogs_log_level_from_string(const char *string)
344
0
{
345
0
    ogs_log_level_e level = OGS_ERROR;
346
347
0
    if (!strcasecmp(string, "none")) level = OGS_LOG_NONE;
348
0
    else if (!strcasecmp(string, "fatal")) level = OGS_LOG_FATAL;
349
0
    else if (!strcasecmp(string, "error")) level = OGS_LOG_ERROR;
350
0
    else if (!strcasecmp(string, "warn")) level = OGS_LOG_WARN;
351
0
    else if (!strcasecmp(string, "info")) level = OGS_LOG_INFO;
352
0
    else if (!strcasecmp(string, "debug")) level = OGS_LOG_DEBUG;
353
0
    else if (!strcasecmp(string, "trace")) level = OGS_LOG_TRACE;
354
355
0
    return level;
356
0
}
357
358
int ogs_log_config_domain(const char *domain, const char *level)
359
0
{
360
0
    if (domain || level) {
361
0
        int l = ogs_core()->log.level;
362
363
0
        if (level) {
364
0
            l = ogs_log_level_from_string(level);
365
0
            if (l == OGS_ERROR) {
366
0
                ogs_error("Invalid LOG-LEVEL "
367
0
                        "[none:fatal|error|warn|info|debug|trace]: %s\n",
368
0
                        level);
369
0
                return OGS_ERROR;
370
0
            }
371
0
        }
372
373
0
        ogs_log_set_mask_level(domain, l);
374
0
    }
375
376
0
    return OGS_OK;
377
0
}
378
379
void ogs_log_vprintf(ogs_log_level_e level, int id,
380
    ogs_err_t err, const char *file, int line, const char *func,
381
    int content_only, const char *format, va_list ap)
382
7.46k
{
383
7.46k
    ogs_log_t *log = NULL;
384
7.46k
    ogs_log_domain_t *domain = NULL;
385
386
7.46k
    char logstr[OGS_HUGE_LEN];
387
7.46k
    char *p, *last;
388
389
7.46k
    int wrote_stderr = 0;
390
391
7.46k
    ogs_list_for_each(&log_list, log) {
392
7.46k
        domain = ogs_pool_find(&domain_pool, id);
393
7.46k
        if (!domain) {
394
0
            fprintf(stderr, "No LogDomain[id:%d] in %s:%d", id, file, line);
395
0
            ogs_assert_if_reached();
396
0
        }
397
7.46k
        if (domain->level < level)
398
1.23k
            return;
399
400
6.23k
        p = logstr;
401
6.23k
        last = logstr + OGS_HUGE_LEN;
402
403
6.23k
        if (!content_only) {
404
6.07k
            if (log->print.timestamp)
405
6.07k
                p = log_timestamp(p, last, log->print.color);
406
6.07k
            if (log->print.domain)
407
6.07k
                p = log_domain(p, last, domain->name, log->print.color);
408
6.07k
            if (log->print.level)
409
6.07k
                p = log_level(p, last, level, log->print.color);
410
6.07k
        }
411
412
6.23k
        p = log_content(p, last, format, ap);
413
414
6.23k
        if (err) {
415
0
            char errbuf[OGS_HUGE_LEN];
416
0
            p = ogs_slprintf(p, last, " (%d:%s)",
417
0
                    (int)err, ogs_strerror(err, errbuf, OGS_HUGE_LEN));
418
0
        }
419
420
6.23k
        if (!content_only) {
421
6.07k
            if (log->print.fileline)
422
6.07k
                p = ogs_slprintf(p, last, " (%s:%d)", file, line);
423
6.07k
            if (log->print.function)
424
0
                p = ogs_slprintf(p, last, " %s()", func);
425
6.07k
            if (log->print.linefeed) 
426
6.07k
                p = log_linefeed(p, last);
427
6.07k
        }
428
429
6.23k
        log->writer(log, level, logstr);
430
        
431
6.23k
        if (log->type == OGS_LOG_STDERR_TYPE)
432
6.23k
            wrote_stderr = 1;
433
6.23k
    }
434
435
6.23k
    if (!wrote_stderr)
436
0
    {
437
0
        int use_color = 0;
438
0
#if !defined(_WIN32)
439
0
        use_color = 1;
440
0
#endif
441
442
0
        p = logstr;
443
0
        last = logstr + OGS_HUGE_LEN;
444
445
0
        if (!content_only) {
446
0
            p = log_timestamp(p, last, use_color);
447
0
            p = log_level(p, last, level, use_color);
448
0
        }
449
0
        p = log_content(p, last, format, ap);
450
0
        if (!content_only) {
451
0
            p = ogs_slprintf(p, last, " (%s:%d)", file, line);
452
0
            p = ogs_slprintf(p, last, " %s()", func);
453
0
            p = log_linefeed(p, last);
454
0
        }
455
456
0
        fprintf(stderr, "%s", logstr);
457
0
        fflush(stderr);
458
0
    }
459
6.23k
}
460
461
void ogs_log_printf(ogs_log_level_e level, int id,
462
    ogs_err_t err, const char *file, int line, const char *func,
463
    int content_only, const char *format, ...)
464
7.46k
{
465
7.46k
    va_list args;
466
467
7.46k
    va_start(args, format);
468
7.46k
    ogs_log_vprintf(level, id,
469
7.46k
            err, file, line, func, content_only, format, args);
470
7.46k
    va_end(args);
471
7.46k
}
472
473
void ogs_log_hexdump_func(ogs_log_level_e level, int id,
474
        const unsigned char *data, size_t len)
475
162
{
476
162
    size_t n, m;
477
162
    char dumpstr[OGS_HUGE_LEN];
478
162
    char *p, *last;
479
480
162
    last = dumpstr + OGS_HUGE_LEN;
481
162
    p = dumpstr;
482
483
1.36k
    for (n = 0; n < len; n += 16) {
484
1.20k
        p = ogs_slprintf(p, last, "%04x: ", (int)n);
485
        
486
20.4k
        for (m = n; m < n + 16; m++) {
487
19.2k
            if (m > n && (m % 4) == 0)
488
3.60k
                p = ogs_slprintf(p, last, " ");
489
19.2k
            if (m < len)
490
17.7k
                p = ogs_slprintf(p, last, "%02x", data[m]);
491
1.47k
            else
492
1.47k
                p = ogs_slprintf(p, last, "  ");
493
19.2k
        }
494
495
1.20k
        p = ogs_slprintf(p, last, "   ");
496
497
18.9k
        for (m = n; m < len && m < n + 16; m++)
498
17.7k
            p = ogs_slprintf(p, last, "%c", isprint(data[m]) ? data[m] : '.');
499
500
1.20k
        p = ogs_slprintf(p, last, "\n");
501
1.20k
    }
502
503
162
    ogs_log_print(level, "%s", dumpstr);
504
162
}
505
506
static ogs_log_t *add_log(ogs_log_type_e type)
507
1
{
508
1
    ogs_log_t *log = NULL;
509
510
1
    ogs_pool_alloc(&log_pool, &log);
511
1
    ogs_assert(log);
512
1
    memset(log, 0, sizeof *log);
513
514
1
    log->type = type;
515
516
1
    log->print.timestamp = 1;
517
1
    log->print.domain = 1;
518
1
    log->print.level = 1;
519
1
    log->print.fileline = 1;
520
1
    log->print.linefeed = 1;
521
522
1
    ogs_list_add(&log_list, log);
523
524
1
    return log;
525
1
}
526
527
static int file_cycle(ogs_log_t *log)
528
0
{
529
0
    ogs_assert(log);
530
0
    ogs_assert(log->file.out);
531
0
    ogs_assert(log->file.name);
532
533
0
    fclose(log->file.out);
534
0
    log->file.out = fopen(log->file.name, "a");
535
0
    ogs_assert(log->file.out);
536
537
0
    return 0;
538
0
}
539
540
static char *log_timestamp(char *buf, char *last,
541
        int use_color)
542
6.07k
{
543
6.07k
    struct timeval tv;
544
6.07k
    struct tm tm;
545
6.07k
    char nowstr[32];
546
547
6.07k
    ogs_gettimeofday(&tv);
548
6.07k
    ogs_localtime(tv.tv_sec, &tm);
549
6.07k
    strftime(nowstr, sizeof nowstr, "%m/%d %H:%M:%S", &tm);
550
551
6.07k
    buf = ogs_slprintf(buf, last, "%s%s.%03d%s: ",
552
6.07k
            use_color ? TA_FGC_GREEN : "",
553
6.07k
            nowstr, (int)(tv.tv_usec/1000),
554
6.07k
            use_color ? TA_NOR : "");
555
556
6.07k
    return buf;
557
6.07k
}
558
559
static char *log_domain(char *buf, char *last,
560
        const char *name, int use_color)
561
6.07k
{
562
6.07k
    buf = ogs_slprintf(buf, last, "[%s%s%s] ",
563
6.07k
            use_color ? TA_FGC_YELLOW : "",
564
6.07k
            name,
565
6.07k
            use_color ? TA_NOR : "");
566
567
6.07k
    return buf;
568
6.07k
}
569
570
static char *log_level(char *buf, char *last,
571
        ogs_log_level_e level, int use_color)
572
6.07k
{
573
6.07k
    const char *colors[] = {
574
6.07k
        TA_NOR,
575
6.07k
        TA_FGC_BOLD_RED, TA_FGC_BOLD_YELLOW, TA_FGC_BOLD_CYAN,
576
6.07k
        TA_FGC_BOLD_GREEN, TA_FGC_BOLD_WHITE, TA_FGC_WHITE,
577
6.07k
    };
578
579
6.07k
    buf = ogs_slprintf(buf, last, "%s%s%s: ",
580
6.07k
            use_color ? colors[level] : "",
581
6.07k
            level_strings[level],
582
6.07k
            use_color ? TA_NOR : "");
583
584
6.07k
    return buf;
585
6.07k
}
586
587
static char *log_content(char *buf, char *last,
588
        const char *format, va_list ap)
589
6.23k
{
590
6.23k
    va_list bp;
591
592
6.23k
    va_copy(bp, ap);
593
6.23k
#pragma GCC diagnostic push
594
6.23k
#pragma GCC diagnostic ignored "-Wformat-nonliteral"
595
6.23k
    buf = ogs_vslprintf(buf, last, format, bp);
596
6.23k
#pragma GCC diagnostic pop
597
6.23k
    va_end(bp);
598
599
6.23k
    return buf;
600
6.23k
}
601
602
static char *log_linefeed(char *buf, char *last)
603
6.07k
{
604
#if defined(_WIN32)
605
    if (buf > last - 3)
606
        buf = last - 3;
607
608
    buf = ogs_slprintf(buf, last, "\r\n");
609
#else
610
6.07k
    if (buf > last - 2)
611
0
        buf = last - 2;
612
613
6.07k
    buf = ogs_slprintf(buf, last, "\n");
614
6.07k
#endif
615
616
6.07k
    return buf;
617
6.07k
}
618
619
static void file_writer(
620
        ogs_log_t *log, ogs_log_level_e level, const char *string)
621
6.23k
{
622
6.23k
    fprintf(log->file.out, "%s", string);
623
6.23k
    fflush(log->file.out);
624
6.23k
}
625