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
|
/*********************************************************************************************************
* Software License Agreement (BSD License) *
* Author: Sebastien Decugis <sdecugis@freediameter.net> *
* *
* Copyright (c) 2023, WIDE Project and NICT *
* All rights reserved. *
* *
* Redistribution and use of this software in source and binary forms, with or without modification, are *
* permitted provided that the following conditions are met: *
* *
* * Redistributions of source code must retain the above *
* copyright notice, this list of conditions and the *
* following disclaimer. *
* *
* * Redistributions in binary form must reproduce the above *
* copyright notice, this list of conditions and the *
* following disclaimer in the documentation and/or other *
* materials provided with the distribution. *
* *
* * Neither the name of the WIDE Project or NICT nor the *
* names of its contributors may be used to endorse or *
* promote products derived from this software without *
* specific prior written permission of WIDE Project and *
* NICT. *
* *
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED *
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR *
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT *
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS *
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR *
* TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF *
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
*********************************************************************************************************/
#include "fdproto-internal.h"
#include <stdarg.h>
pthread_mutex_t fd_log_lock = PTHREAD_MUTEX_INITIALIZER;
pthread_key_t fd_log_thname;
int fd_g_debug_lvl = FD_LOG_NOTICE;
static void fd_internal_logger( int, const char *, va_list );
static int use_colors = 0; /* 0: not init, 1: yes, 2: no */
/* These may be used to pass specific debug requests via the command-line parameters */
char * fd_debug_one_function = NULL;
char * fd_debug_one_file = NULL;
/* Useless function, only to ease setting up a breakpoint in gdb (break fd_breakhere) -- use TRACE_HERE */
int fd_breaks = 0;
int fd_breakhere(void) { return ++fd_breaks; }
/* Allow passing of the log and debug information from base stack to extensions */
void (*fd_logger)( int loglevel, const char * format, va_list args ) = fd_internal_logger;
/* Register an external call back for tracing and debug */
int fd_log_handler_register( void (*logger)(int loglevel, const char * format, va_list args) )
{
CHECK_PARAMS( logger );
if ( fd_logger != fd_internal_logger )
{
return EALREADY; /* only one registration allowed */
}
else
{
fd_logger = logger;
}
return 0;
}
/* Implement a simple reset function here */
int fd_log_handler_unregister ( void )
{
fd_logger = fd_internal_logger;
return 0; /* Successful in all cases. */
}
static void fd_cleanup_mutex_silent( void * mutex )
{
(void)pthread_mutex_unlock((pthread_mutex_t *)mutex);
}
static void fd_internal_logger( int printlevel, const char *format, va_list ap )
{
char buf[25];
/* Do we need to trace this ? */
if (printlevel < fd_g_debug_lvl)
return;
/* add timestamp */
printf("%s ", fd_log_time(NULL, buf, sizeof(buf),
#if (defined(DEBUG) && defined(DEBUG_WITH_META))
1, 1
#else /* (defined(DEBUG) && defined(DEBUG_WITH_META)) */
0, 0
#endif /* (defined(DEBUG) && defined(DEBUG_WITH_META)) */
));
/* Use colors on stdout ? */
if (!use_colors) {
if (isatty(STDOUT_FILENO))
use_colors = 1;
else
use_colors = 2;
}
switch(printlevel) {
case FD_LOG_ANNOYING: printf("%s A ", (use_colors == 1) ? "\e[0;37m" : ""); break;
case FD_LOG_DEBUG: printf("%s DBG ", (use_colors == 1) ? "\e[0;37m" : ""); break;
case FD_LOG_INFO: printf("%sINFO ", (use_colors == 1) ? "\e[1;37m" : ""); break;
case FD_LOG_NOTICE: printf("%sNOTI ", (use_colors == 1) ? "\e[1;37m" : ""); break;
case FD_LOG_ERROR: printf("%sERROR ", (use_colors == 1) ? "\e[0;31m" : ""); break;
case FD_LOG_FATAL: printf("%sFATAL! ", (use_colors == 1) ? "\e[0;31m" : ""); break;
default: printf("%s ??? ", (use_colors == 1) ? "\e[0;31m" : "");
}
vprintf(format, ap);
if (use_colors == 1)
printf("\e[00m");
printf("\n");
fflush(stdout);
}
/* Log a debug message */
void fd_log ( int loglevel, const char * format, ... )
{
va_list ap;
(void)pthread_mutex_lock(&fd_log_lock);
pthread_cleanup_push(fd_cleanup_mutex_silent, &fd_log_lock);
va_start(ap, format);
fd_logger(loglevel, format, ap);
va_end(ap);
pthread_cleanup_pop(0);
(void)pthread_mutex_unlock(&fd_log_lock);
}
/* Log a debug message */
void fd_log_va ( int loglevel, const char * format, va_list args )
{
(void)pthread_mutex_lock(&fd_log_lock);
pthread_cleanup_push(fd_cleanup_mutex_silent, &fd_log_lock);
fd_logger(loglevel, format, args);
pthread_cleanup_pop(0);
(void)pthread_mutex_unlock(&fd_log_lock);
}
/* Function to set the thread's friendly name */
void fd_log_threadname ( const char * name )
{
void * val = NULL;
TRACE_ENTRY("%p(%s)", name, name?:"/");
/* First, check if a value is already assigned to the current thread */
val = pthread_getspecific(fd_log_thname);
if (TRACE_BOOL(ANNOYING)) {
if (val) {
fd_log_debug("(Thread '%s' renamed to '%s')", (char *)val, name?:"(nil)");
} else {
fd_log_debug("(Thread %p named '%s')", (void *)pthread_self(), name?:"(nil)");
}
}
if (val != NULL) {
free(val);
}
/* Now create the new string */
if (name == NULL) {
CHECK_POSIX_DO( pthread_setspecific(fd_log_thname, NULL), /* continue */);
return;
}
CHECK_MALLOC_DO( val = strdup(name), return );
CHECK_POSIX_DO( pthread_setspecific(fd_log_thname, val), /* continue */);
return;
}
/* Write time into a buffer */
char * fd_log_time ( struct timespec * ts, char * buf, size_t len, int incl_date, int incl_ms )
{
int ret;
size_t offset = 0;
struct timespec tp;
struct tm tm;
/* Get current time */
if (!ts) {
ret = clock_gettime(CLOCK_REALTIME, &tp);
if (ret != 0) {
snprintf(buf, len, "%s", strerror(ret));
return buf;
}
ts = &tp;
}
offset += strftime(buf + offset, len - offset, incl_date?"%F %T":"%T", localtime_r( &ts->tv_sec , &tm ));
if (incl_ms)
offset += snprintf(buf + offset, len - offset, ".%6.6ld", ts->tv_nsec / 1000);
return buf;
}
static size_t sys_mempagesz = 0;
static size_t get_mempagesz(void) {
if (!sys_mempagesz) {
sys_mempagesz = sysconf(_SC_PAGESIZE); /* We alloc buffer by memory pages for efficiency. This can be readjusted if too memory consuming */
if (sys_mempagesz <= 0)
sys_mempagesz = 256; /* default size if above call failed */
}
return sys_mempagesz;
}
/* Helper function for fd_*_dump. Prints the format string from 'offset' into '*buf', extends if needed. The location of buf can be updated by this function. */
char * fd_dump_extend(char ** buf, size_t *len, size_t *offset, const char * format, ... )
{
va_list ap;
int to_write;
size_t o = 0;
size_t mempagesz = get_mempagesz();
/* we do not TRACE_ENTRY this one on purpose */
CHECK_PARAMS_DO(buf && len, return NULL);
if (*buf == NULL) {
CHECK_MALLOC_DO(*buf = malloc(mempagesz), return NULL);
*len = mempagesz;
}
if (offset)
o = *offset;
va_start(ap, format);
to_write = vsnprintf(*buf + o, *len - o, format, ap);
va_end(ap);
if (to_write + o >= *len) {
/* There was no room in the buffer, we extend and redo */
size_t new_len = (((to_write + o) / mempagesz) + 1) * mempagesz;
CHECK_MALLOC_DO(*buf = realloc(*buf, new_len), return NULL);
*len = new_len;
va_start(ap, format);
to_write = vsnprintf(*buf + o, *len - o, format, ap);
va_end(ap);
}
if (offset)
*offset += to_write;
return *buf;
}
char * fd_dump_extend_hexdump(char ** buf, size_t *len, size_t *offset, uint8_t *data, size_t datalen, size_t trunc, size_t wrap )
{
int truncated = 0;
size_t towrite = 0;
size_t o = 0;
int i;
char * p;
size_t mempagesz = get_mempagesz();
#define TRUNK_MARK "[...]"
CHECK_PARAMS_DO(buf && len && data, return NULL);
if (trunc && (datalen > trunc)) {
datalen = trunc;
truncated = 1;
}
towrite = datalen * 2;
if (wrap)
towrite += datalen / wrap; /* add 1 '\n' every wrap byte */
if (truncated)
towrite += CONSTSTRLEN(TRUNK_MARK);
if (offset)
o = *offset;
if (*buf == NULL) {
/* Directly allocate the size we need */
*len = (((towrite + o) / mempagesz) + 1 ) * mempagesz;
CHECK_MALLOC_DO(*buf = malloc(*len), return NULL);
} else if ((towrite + o) >= *len) {
/* There is no room in the buffer, we extend and redo */
size_t new_len = (((towrite + o) / mempagesz) + 1) * mempagesz;
CHECK_MALLOC_DO(*buf = realloc(*buf, new_len), return NULL);
*len = new_len;
}
p = *buf + o;
for (i = 0; i < datalen; i++) {
sprintf(p, "%02hhX", data[i]);
p+=2;
if ((wrap) && ((i+1) % wrap == 0)) {
*p++='\n'; *p ='\0'; /* we want to ensure the buffer is always 0-terminated */
}
}
if (truncated)
memcpy(p, TRUNK_MARK, CONSTSTRLEN(TRUNK_MARK));
if (offset)
*offset += towrite;
return *buf;
}
|