1 /* 2 * util/log.c - implementation of the log code 3 * 4 * Copyright (c) 2007, NLnet Labs. All rights reserved. 5 * 6 * This software is open source. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 12 * Redistributions of source code must retain the above copyright notice, 13 * this list of conditions and the following disclaimer. 14 * 15 * Redistributions in binary form must reproduce the above copyright notice, 16 * this list of conditions and the following disclaimer in the documentation 17 * and/or other materials provided with the distribution. 18 * 19 * Neither the name of the NLNET LABS nor the names of its contributors may 20 * be used to endorse or promote products derived from this software without 21 * specific prior written permission. 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 29 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 30 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 31 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 33 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 34 */ 35 /** 36 * \file 37 * Implementation of log.h. 38 */ 39 40 #include "config.h" 41 #include "util/log.h" 42 #include "util/locks.h" 43 #include "sldns/sbuffer.h" 44 #include <stdarg.h> 45 #ifdef HAVE_TIME_H 46 #include <time.h> 47 #endif 48 #ifdef HAVE_SYSLOG_H 49 # include <syslog.h> 50 #else 51 /**define LOG_ constants */ 52 # define LOG_CRIT 2 53 # define LOG_ERR 3 54 # define LOG_WARNING 4 55 # define LOG_NOTICE 5 56 # define LOG_INFO 6 57 # define LOG_DEBUG 7 58 #endif 59 #ifdef UB_ON_WINDOWS 60 # include "winrc/win_svc.h" 61 #endif 62 63 /* default verbosity */ 64 enum verbosity_value verbosity = 0; 65 /** the file logged to. */ 66 static FILE* logfile = 0; 67 /** if key has been created */ 68 static int key_created = 0; 69 /** pthread key for thread ids in logfile */ 70 static ub_thread_key_type logkey; 71 #ifndef THREADS_DISABLED 72 /** pthread mutex to protect FILE* */ 73 static lock_quick_type log_lock; 74 #endif 75 /** the identity of this executable/process */ 76 static const char* ident="unbound"; 77 #if defined(HAVE_SYSLOG_H) || defined(UB_ON_WINDOWS) 78 /** are we using syslog(3) to log to */ 79 static int logging_to_syslog = 0; 80 #endif /* HAVE_SYSLOG_H */ 81 /** time to print in log, if NULL, use time(2) */ 82 static time_t* log_now = NULL; 83 /** print time in UTC or in secondsfrom1970 */ 84 static int log_time_asc = 0; 85 86 void 87 log_init(const char* filename, int use_syslog, const char* chrootdir) 88 { 89 FILE *f; 90 if(!key_created) { 91 key_created = 1; 92 ub_thread_key_create(&logkey, NULL); 93 lock_quick_init(&log_lock); 94 } 95 lock_quick_lock(&log_lock); 96 if(logfile 97 #if defined(HAVE_SYSLOG_H) || defined(UB_ON_WINDOWS) 98 || logging_to_syslog 99 #endif 100 ) { 101 lock_quick_unlock(&log_lock); /* verbose() needs the lock */ 102 verbose(VERB_QUERY, "switching log to %s", 103 use_syslog?"syslog":(filename&&filename[0]?filename:"stderr")); 104 lock_quick_lock(&log_lock); 105 } 106 if(logfile && logfile != stderr) { 107 FILE* cl = logfile; 108 logfile = NULL; /* set to NULL before it is closed, so that 109 other threads have a valid logfile or NULL */ 110 fclose(cl); 111 } 112 #ifdef HAVE_SYSLOG_H 113 if(logging_to_syslog) { 114 closelog(); 115 logging_to_syslog = 0; 116 } 117 if(use_syslog) { 118 /* do not delay opening until first write, because we may 119 * chroot and no longer be able to access dev/log and so on */ 120 openlog(ident, LOG_NDELAY, LOG_DAEMON); 121 logging_to_syslog = 1; 122 lock_quick_unlock(&log_lock); 123 return; 124 } 125 #elif defined(UB_ON_WINDOWS) 126 if(logging_to_syslog) { 127 logging_to_syslog = 0; 128 } 129 if(use_syslog) { 130 logging_to_syslog = 1; 131 lock_quick_unlock(&log_lock); 132 return; 133 } 134 #endif /* HAVE_SYSLOG_H */ 135 if(!filename || !filename[0]) { 136 logfile = stderr; 137 lock_quick_unlock(&log_lock); 138 return; 139 } 140 /* open the file for logging */ 141 if(chrootdir && chrootdir[0] && strncmp(filename, chrootdir, 142 strlen(chrootdir)) == 0) 143 filename += strlen(chrootdir); 144 f = fopen(filename, "a"); 145 if(!f) { 146 lock_quick_unlock(&log_lock); 147 log_err("Could not open logfile %s: %s", filename, 148 strerror(errno)); 149 return; 150 } 151 #ifndef UB_ON_WINDOWS 152 /* line buffering does not work on windows */ 153 setvbuf(f, NULL, (int)_IOLBF, 0); 154 #endif 155 logfile = f; 156 lock_quick_unlock(&log_lock); 157 } 158 159 void log_file(FILE *f) 160 { 161 lock_quick_lock(&log_lock); 162 logfile = f; 163 lock_quick_unlock(&log_lock); 164 } 165 166 void log_thread_set(int* num) 167 { 168 ub_thread_key_set(logkey, num); 169 } 170 171 int log_thread_get(void) 172 { 173 unsigned int* tid; 174 if(!key_created) return 0; 175 tid = (unsigned int*)ub_thread_key_get(logkey); 176 return (int)(tid?*tid:0); 177 } 178 179 void log_ident_set(const char* id) 180 { 181 ident = id; 182 } 183 184 void log_set_time(time_t* t) 185 { 186 log_now = t; 187 } 188 189 void log_set_time_asc(int use_asc) 190 { 191 log_time_asc = use_asc; 192 } 193 194 void 195 log_vmsg(int pri, const char* type, 196 const char *format, va_list args) 197 { 198 char message[MAXSYSLOGMSGLEN]; 199 unsigned int* tid = (unsigned int*)ub_thread_key_get(logkey); 200 time_t now; 201 #if defined(HAVE_STRFTIME) && defined(HAVE_LOCALTIME_R) 202 char tmbuf[32]; 203 struct tm tm; 204 #elif defined(UB_ON_WINDOWS) 205 char tmbuf[128], dtbuf[128]; 206 #endif 207 (void)pri; 208 vsnprintf(message, sizeof(message), format, args); 209 #ifdef HAVE_SYSLOG_H 210 if(logging_to_syslog) { 211 syslog(pri, "[%d:%x] %s: %s", 212 (int)getpid(), tid?*tid:0, type, message); 213 return; 214 } 215 #elif defined(UB_ON_WINDOWS) 216 if(logging_to_syslog) { 217 char m[32768]; 218 HANDLE* s; 219 LPCTSTR str = m; 220 DWORD tp = MSG_GENERIC_ERR; 221 WORD wt = EVENTLOG_ERROR_TYPE; 222 if(strcmp(type, "info") == 0) { 223 tp=MSG_GENERIC_INFO; 224 wt=EVENTLOG_INFORMATION_TYPE; 225 } else if(strcmp(type, "warning") == 0) { 226 tp=MSG_GENERIC_WARN; 227 wt=EVENTLOG_WARNING_TYPE; 228 } else if(strcmp(type, "notice") == 0 229 || strcmp(type, "debug") == 0) { 230 tp=MSG_GENERIC_SUCCESS; 231 wt=EVENTLOG_SUCCESS; 232 } 233 snprintf(m, sizeof(m), "[%s:%x] %s: %s", 234 ident, tid?*tid:0, type, message); 235 s = RegisterEventSource(NULL, SERVICE_NAME); 236 if(!s) return; 237 ReportEvent(s, wt, 0, tp, NULL, 1, 0, &str, NULL); 238 DeregisterEventSource(s); 239 return; 240 } 241 #endif /* HAVE_SYSLOG_H */ 242 lock_quick_lock(&log_lock); 243 if(!logfile) { 244 lock_quick_unlock(&log_lock); 245 return; 246 } 247 if(log_now) 248 now = (time_t)*log_now; 249 else now = (time_t)time(NULL); 250 #if defined(HAVE_STRFTIME) && defined(HAVE_LOCALTIME_R) 251 if(log_time_asc && strftime(tmbuf, sizeof(tmbuf), "%b %d %H:%M:%S", 252 localtime_r(&now, &tm))%(sizeof(tmbuf)) != 0) { 253 /* %sizeof buf!=0 because old strftime returned max on error */ 254 fprintf(logfile, "%s %s[%d:%x] %s: %s\n", tmbuf, 255 ident, (int)getpid(), tid?*tid:0, type, message); 256 } else 257 #elif defined(UB_ON_WINDOWS) 258 if(log_time_asc && GetTimeFormat(LOCALE_USER_DEFAULT, 0, NULL, NULL, 259 tmbuf, sizeof(tmbuf)) && GetDateFormat(LOCALE_USER_DEFAULT, 0, 260 NULL, NULL, dtbuf, sizeof(dtbuf))) { 261 fprintf(logfile, "%s %s %s[%d:%x] %s: %s\n", dtbuf, tmbuf, 262 ident, (int)getpid(), tid?*tid:0, type, message); 263 } else 264 #endif 265 fprintf(logfile, "[" ARG_LL "d] %s[%d:%x] %s: %s\n", (long long)now, 266 ident, (int)getpid(), tid?*tid:0, type, message); 267 #ifdef UB_ON_WINDOWS 268 /* line buffering does not work on windows */ 269 fflush(logfile); 270 #endif 271 lock_quick_unlock(&log_lock); 272 } 273 274 /** 275 * implementation of log_info 276 * @param format: format string printf-style. 277 */ 278 void 279 log_info(const char *format, ...) 280 { 281 va_list args; 282 va_start(args, format); 283 log_vmsg(LOG_INFO, "info", format, args); 284 va_end(args); 285 } 286 287 /** 288 * implementation of log_err 289 * @param format: format string printf-style. 290 */ 291 void 292 log_err(const char *format, ...) 293 { 294 va_list args; 295 va_start(args, format); 296 log_vmsg(LOG_ERR, "error", format, args); 297 va_end(args); 298 } 299 300 /** 301 * implementation of log_warn 302 * @param format: format string printf-style. 303 */ 304 void 305 log_warn(const char *format, ...) 306 { 307 va_list args; 308 va_start(args, format); 309 log_vmsg(LOG_WARNING, "warning", format, args); 310 va_end(args); 311 } 312 313 /** 314 * implementation of fatal_exit 315 * @param format: format string printf-style. 316 */ 317 void 318 fatal_exit(const char *format, ...) 319 { 320 va_list args; 321 va_start(args, format); 322 log_vmsg(LOG_CRIT, "fatal error", format, args); 323 va_end(args); 324 exit(1); 325 } 326 327 /** 328 * implementation of verbose 329 * @param level: verbose level for the message. 330 * @param format: format string printf-style. 331 */ 332 void 333 verbose(enum verbosity_value level, const char* format, ...) 334 { 335 va_list args; 336 va_start(args, format); 337 if(verbosity >= level) { 338 if(level == VERB_OPS) 339 log_vmsg(LOG_NOTICE, "notice", format, args); 340 else if(level == VERB_DETAIL) 341 log_vmsg(LOG_INFO, "info", format, args); 342 else log_vmsg(LOG_DEBUG, "debug", format, args); 343 } 344 va_end(args); 345 } 346 347 /** log hex data */ 348 static void 349 log_hex_f(enum verbosity_value v, const char* msg, void* data, size_t length) 350 { 351 size_t i, j; 352 uint8_t* data8 = (uint8_t*)data; 353 const char* hexchar = "0123456789ABCDEF"; 354 char buf[1024+1]; /* alloc blocksize hex chars + \0 */ 355 const size_t blocksize = 512; 356 size_t len; 357 358 if(length == 0) { 359 verbose(v, "%s[%u]", msg, (unsigned)length); 360 return; 361 } 362 363 for(i=0; i<length; i+=blocksize/2) { 364 len = blocksize/2; 365 if(length - i < blocksize/2) 366 len = length - i; 367 for(j=0; j<len; j++) { 368 buf[j*2] = hexchar[ data8[i+j] >> 4 ]; 369 buf[j*2 + 1] = hexchar[ data8[i+j] & 0xF ]; 370 } 371 buf[len*2] = 0; 372 verbose(v, "%s[%u:%u] %.*s", msg, (unsigned)length, 373 (unsigned)i, (int)len*2, buf); 374 } 375 } 376 377 void 378 log_hex(const char* msg, void* data, size_t length) 379 { 380 log_hex_f(verbosity, msg, data, length); 381 } 382 383 void log_buf(enum verbosity_value level, const char* msg, sldns_buffer* buf) 384 { 385 if(verbosity < level) 386 return; 387 log_hex_f(level, msg, sldns_buffer_begin(buf), sldns_buffer_limit(buf)); 388 } 389 390 #ifdef USE_WINSOCK 391 char* wsa_strerror(DWORD err) 392 { 393 static char unknown[32]; 394 395 switch(err) { 396 case WSA_INVALID_HANDLE: return "Specified event object handle is invalid."; 397 case WSA_NOT_ENOUGH_MEMORY: return "Insufficient memory available."; 398 case WSA_INVALID_PARAMETER: return "One or more parameters are invalid."; 399 case WSA_OPERATION_ABORTED: return "Overlapped operation aborted."; 400 case WSA_IO_INCOMPLETE: return "Overlapped I/O event object not in signaled state."; 401 case WSA_IO_PENDING: return "Overlapped operations will complete later."; 402 case WSAEINTR: return "Interrupted function call."; 403 case WSAEBADF: return "File handle is not valid."; 404 case WSAEACCES: return "Permission denied."; 405 case WSAEFAULT: return "Bad address."; 406 case WSAEINVAL: return "Invalid argument."; 407 case WSAEMFILE: return "Too many open files."; 408 case WSAEWOULDBLOCK: return "Resource temporarily unavailable."; 409 case WSAEINPROGRESS: return "Operation now in progress."; 410 case WSAEALREADY: return "Operation already in progress."; 411 case WSAENOTSOCK: return "Socket operation on nonsocket."; 412 case WSAEDESTADDRREQ: return "Destination address required."; 413 case WSAEMSGSIZE: return "Message too long."; 414 case WSAEPROTOTYPE: return "Protocol wrong type for socket."; 415 case WSAENOPROTOOPT: return "Bad protocol option."; 416 case WSAEPROTONOSUPPORT: return "Protocol not supported."; 417 case WSAESOCKTNOSUPPORT: return "Socket type not supported."; 418 case WSAEOPNOTSUPP: return "Operation not supported."; 419 case WSAEPFNOSUPPORT: return "Protocol family not supported."; 420 case WSAEAFNOSUPPORT: return "Address family not supported by protocol family."; 421 case WSAEADDRINUSE: return "Address already in use."; 422 case WSAEADDRNOTAVAIL: return "Cannot assign requested address."; 423 case WSAENETDOWN: return "Network is down."; 424 case WSAENETUNREACH: return "Network is unreachable."; 425 case WSAENETRESET: return "Network dropped connection on reset."; 426 case WSAECONNABORTED: return "Software caused connection abort."; 427 case WSAECONNRESET: return "Connection reset by peer."; 428 case WSAENOBUFS: return "No buffer space available."; 429 case WSAEISCONN: return "Socket is already connected."; 430 case WSAENOTCONN: return "Socket is not connected."; 431 case WSAESHUTDOWN: return "Cannot send after socket shutdown."; 432 case WSAETOOMANYREFS: return "Too many references."; 433 case WSAETIMEDOUT: return "Connection timed out."; 434 case WSAECONNREFUSED: return "Connection refused."; 435 case WSAELOOP: return "Cannot translate name."; 436 case WSAENAMETOOLONG: return "Name too long."; 437 case WSAEHOSTDOWN: return "Host is down."; 438 case WSAEHOSTUNREACH: return "No route to host."; 439 case WSAENOTEMPTY: return "Directory not empty."; 440 case WSAEPROCLIM: return "Too many processes."; 441 case WSAEUSERS: return "User quota exceeded."; 442 case WSAEDQUOT: return "Disk quota exceeded."; 443 case WSAESTALE: return "Stale file handle reference."; 444 case WSAEREMOTE: return "Item is remote."; 445 case WSASYSNOTREADY: return "Network subsystem is unavailable."; 446 case WSAVERNOTSUPPORTED: return "Winsock.dll version out of range."; 447 case WSANOTINITIALISED: return "Successful WSAStartup not yet performed."; 448 case WSAEDISCON: return "Graceful shutdown in progress."; 449 case WSAENOMORE: return "No more results."; 450 case WSAECANCELLED: return "Call has been canceled."; 451 case WSAEINVALIDPROCTABLE: return "Procedure call table is invalid."; 452 case WSAEINVALIDPROVIDER: return "Service provider is invalid."; 453 case WSAEPROVIDERFAILEDINIT: return "Service provider failed to initialize."; 454 case WSASYSCALLFAILURE: return "System call failure."; 455 case WSASERVICE_NOT_FOUND: return "Service not found."; 456 case WSATYPE_NOT_FOUND: return "Class type not found."; 457 case WSA_E_NO_MORE: return "No more results."; 458 case WSA_E_CANCELLED: return "Call was canceled."; 459 case WSAEREFUSED: return "Database query was refused."; 460 case WSAHOST_NOT_FOUND: return "Host not found."; 461 case WSATRY_AGAIN: return "Nonauthoritative host not found."; 462 case WSANO_RECOVERY: return "This is a nonrecoverable error."; 463 case WSANO_DATA: return "Valid name, no data record of requested type."; 464 case WSA_QOS_RECEIVERS: return "QOS receivers."; 465 case WSA_QOS_SENDERS: return "QOS senders."; 466 case WSA_QOS_NO_SENDERS: return "No QOS senders."; 467 case WSA_QOS_NO_RECEIVERS: return "QOS no receivers."; 468 case WSA_QOS_REQUEST_CONFIRMED: return "QOS request confirmed."; 469 case WSA_QOS_ADMISSION_FAILURE: return "QOS admission error."; 470 case WSA_QOS_POLICY_FAILURE: return "QOS policy failure."; 471 case WSA_QOS_BAD_STYLE: return "QOS bad style."; 472 case WSA_QOS_BAD_OBJECT: return "QOS bad object."; 473 case WSA_QOS_TRAFFIC_CTRL_ERROR: return "QOS traffic control error."; 474 case WSA_QOS_GENERIC_ERROR: return "QOS generic error."; 475 case WSA_QOS_ESERVICETYPE: return "QOS service type error."; 476 case WSA_QOS_EFLOWSPEC: return "QOS flowspec error."; 477 case WSA_QOS_EPROVSPECBUF: return "Invalid QOS provider buffer."; 478 case WSA_QOS_EFILTERSTYLE: return "Invalid QOS filter style."; 479 case WSA_QOS_EFILTERTYPE: return "Invalid QOS filter type."; 480 case WSA_QOS_EFILTERCOUNT: return "Incorrect QOS filter count."; 481 case WSA_QOS_EOBJLENGTH: return "Invalid QOS object length."; 482 case WSA_QOS_EFLOWCOUNT: return "Incorrect QOS flow count."; 483 /*case WSA_QOS_EUNKOWNPSOBJ: return "Unrecognized QOS object.";*/ 484 case WSA_QOS_EPOLICYOBJ: return "Invalid QOS policy object."; 485 case WSA_QOS_EFLOWDESC: return "Invalid QOS flow descriptor."; 486 case WSA_QOS_EPSFLOWSPEC: return "Invalid QOS provider-specific flowspec."; 487 case WSA_QOS_EPSFILTERSPEC: return "Invalid QOS provider-specific filterspec."; 488 case WSA_QOS_ESDMODEOBJ: return "Invalid QOS shape discard mode object."; 489 case WSA_QOS_ESHAPERATEOBJ: return "Invalid QOS shaping rate object."; 490 case WSA_QOS_RESERVED_PETYPE: return "Reserved policy QOS element type."; 491 default: 492 snprintf(unknown, sizeof(unknown), 493 "unknown WSA error code %d", (int)err); 494 return unknown; 495 } 496 } 497 #endif /* USE_WINSOCK */ 498