src/logging.c

Sat, 28 Oct 2017 11:25:27 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 28 Oct 2017 11:25:27 +0200
changeset 258
d9f4285c795c
parent 251
fae240d633fc
child 259
2f5dea574a75
permissions
-rw-r--r--

removes "integration" from documentation

103
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
1 /*
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
3 *
250
b7d1317b138e updates license
Mike Becker <universe@uap-core.de>
parents: 225
diff changeset
4 * Copyright 2017 Olaf Wintermann. All rights reserved.
103
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
5 *
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
6 * Redistribution and use in source and binary forms, with or without
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
7 * modification, are permitted provided that the following conditions are met:
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
8 *
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
9 * 1. Redistributions of source code must retain the above copyright
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
10 * notice, this list of conditions and the following disclaimer.
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
11 *
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
12 * 2. Redistributions in binary form must reproduce the above copyright
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
13 * notice, this list of conditions and the following disclaimer in the
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
14 * documentation and/or other materials provided with the distribution.
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
15 *
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
26 * POSSIBILITY OF SUCH DAMAGE.
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
27 */
08018864fb91 added license and copyright notice to all files
Mike Becker <universe@uap-core.de>
parents: 95
diff changeset
28
251
fae240d633fc changes source directory structure in preperation for autotools rollout
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
29 #include "ucx/logging.h"
fae240d633fc changes source directory structure in preperation for autotools rollout
Mike Becker <universe@uap-core.de>
parents: 250
diff changeset
30
57
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
31 #include <stdlib.h>
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
32 #include <string.h>
81
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
33 #include <stdarg.h>
82
6068d965328b logger can now log timestamps
Mike Becker <universe@uap-core.de>
parents: 81
diff changeset
34 #include <time.h>
57
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
35
83
3b552d7a9610 modified code to compile with -pedantic
Mike Becker <universe@uap-core.de>
parents: 82
diff changeset
36 UcxLogger *ucx_logger_new(void *stream, unsigned int level, unsigned int mask) {
57
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
37 UcxLogger *logger = (UcxLogger*) malloc(sizeof(UcxLogger));
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
38 if (logger != NULL) {
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
39 logger->stream = stream;
82
6068d965328b logger can now log timestamps
Mike Becker <universe@uap-core.de>
parents: 81
diff changeset
40 logger->writer = (write_func)fwrite;
95
ecfdc1c4a552 added gnu++11 support
Mike Becker <universe@uap-core.de>
parents: 83
diff changeset
41 logger->dateformat = (char*) "%F %T %z ";
57
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
42 logger->level = level;
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
43 logger->mask = mask;
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
44 logger->levels = ucx_map_new(8);
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
45
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
46 unsigned int l;
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
47 l = UCX_LOGGER_ERROR;
95
ecfdc1c4a552 added gnu++11 support
Mike Becker <universe@uap-core.de>
parents: 83
diff changeset
48 ucx_map_int_put(logger->levels, l, (void*) "[ERROR]");
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
49 l = UCX_LOGGER_WARN;
95
ecfdc1c4a552 added gnu++11 support
Mike Becker <universe@uap-core.de>
parents: 83
diff changeset
50 ucx_map_int_put(logger->levels, l, (void*) "[WARNING]");
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
51 l = UCX_LOGGER_INFO;
95
ecfdc1c4a552 added gnu++11 support
Mike Becker <universe@uap-core.de>
parents: 83
diff changeset
52 ucx_map_int_put(logger->levels, l, (void*) "[INFO]");
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
53 l = UCX_LOGGER_TRACE;
95
ecfdc1c4a552 added gnu++11 support
Mike Becker <universe@uap-core.de>
parents: 83
diff changeset
54 ucx_map_int_put(logger->levels, l, (void*) "[TRACE]");
57
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
55 }
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
56
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
57 return logger;
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
58 }
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
59
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
60 void ucx_logger_free(UcxLogger *logger) {
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
61 ucx_map_free(logger->levels);
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
62 free(logger);
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
63 }
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
64
152
3238f65db163 minor code fixes + added clang support + improved build system
Mike Becker <universe@uap-core.de>
parents: 138
diff changeset
65 // estimated max. message length (documented)
3238f65db163 minor code fixes + added clang support + improved build system
Mike Becker <universe@uap-core.de>
parents: 138
diff changeset
66 #define UCX_LOGGER_MSGMAX 4096
3238f65db163 minor code fixes + added clang support + improved build system
Mike Becker <universe@uap-core.de>
parents: 138
diff changeset
67
81
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
68 void ucx_logger_logf(UcxLogger *logger, unsigned int level, const char* file,
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
69 const unsigned int line, const char *format, ...) {
57
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
70 if (level <= logger->level) {
152
3238f65db163 minor code fixes + added clang support + improved build system
Mike Becker <universe@uap-core.de>
parents: 138
diff changeset
71 char msg[UCX_LOGGER_MSGMAX];
81
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
72 char *text;
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
73 size_t k = 0;
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
74 size_t n;
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
75
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
76 if ((logger->mask & UCX_LOGGER_LEVEL) > 0) {
81
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
77 text = (char*) ucx_map_int_get(logger->levels, level);
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
78 n = strlen(text);
171
49cebb8eceff logger: removed unnecessary boundary checks and limited string parts so they always respect buffer lengths
Mike Becker <universe@uap-core.de>
parents: 153
diff changeset
79 n = n > 256 ? 256 : n;
81
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
80 memcpy(msg+k, text, n);
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
81 k += n;
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
82 msg[k++] = ' ';
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
83 }
82
6068d965328b logger can now log timestamps
Mike Becker <universe@uap-core.de>
parents: 81
diff changeset
84 if ((logger->mask & UCX_LOGGER_TIMESTAMP) > 0) {
6068d965328b logger can now log timestamps
Mike Becker <universe@uap-core.de>
parents: 81
diff changeset
85 time_t now = time(NULL);
6068d965328b logger can now log timestamps
Mike Becker <universe@uap-core.de>
parents: 81
diff changeset
86 k += strftime(msg+k, 128, logger->dateformat, localtime(&now));
6068d965328b logger can now log timestamps
Mike Becker <universe@uap-core.de>
parents: 81
diff changeset
87 }
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
88 if ((logger->mask & UCX_LOGGER_SOURCE) > 0) {
81
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
89 n = strlen(file);
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
90 memcpy(msg+k, file, n);
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
91 k += n;
171
49cebb8eceff logger: removed unnecessary boundary checks and limited string parts so they always respect buffer lengths
Mike Becker <universe@uap-core.de>
parents: 153
diff changeset
92 k += sprintf(msg+k, ":%u ", line);
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
93 }
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
94
81
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
95 msg[k++] = '-'; msg[k++] = ' ';
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
96
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
97 va_list args;
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
98 va_start (args, format);
152
3238f65db163 minor code fixes + added clang support + improved build system
Mike Becker <universe@uap-core.de>
parents: 138
diff changeset
99 k += vsnprintf(msg+k, UCX_LOGGER_MSGMAX-k-1, format, args);
81
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
100 va_end (args);
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
101
80
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
102 msg[k++] = '\n';
0125e4089f88 Fixed map tests + added some formatting options to logger
Mike Becker <universe@uap-core.de>
parents: 67
diff changeset
103
81
86a23238d8a1 changed logger to behave more like printf + added possibility to specify write function
Mike Becker <universe@uap-core.de>
parents: 80
diff changeset
104 logger->writer(msg, 1, k, logger->stream);
57
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
105 }
e18157c52985 some fixes
Olaf Wintermann <olaf.wintermann@gmail.com>
parents: 54
diff changeset
106 }

mercurial