src/util/serverLog.c

   1 /*
   2  * Copyright 2000, International Business Machines Corporation and others.
   3  * All Rights Reserved.
   4  *
   5  * This software has been released under the terms of the IBM Public
   6  * License.  For details, see the LICENSE file in the top-level source
   7  * directory or online at http://www.openafs.org/dl/license10.html
   8  */
   9
  10 /*  serverLog.c     - Server logging                                      */
  11 /*                                                                        */
  12 /*  Information Technology Center                                         */
  13 /*  Date: 05/21/97                                                        */
  14 /*                                                                        */
  15 /*  Function    - These routiens implement logging from the servers       */
  16 /*                                                                        */
  17 /* ********************************************************************** */
  18
  19 #include <afsconfig.h>
  20 #include <afs/param.h>
  21 #include <afs/stds.h>
  22
  23 #include <afs/procmgmt.h>       /* signal(), kill(), wait(), etc. */
  24
  25 #include <roken.h>              /* Must come after procmgmt.h */
  26 #ifdef AFS_PTHREAD_ENV
  27  #include <opr/softsig.h>
  28  #include <afs/procmgmt_softsig.h>      /* Must come after softsig.h */
  29 #endif
  30 #include <afs/opr.h>
  31 #include "afsutil.h"
  32 #include "fileutil.h"
  33 #include <lwp.h>
  34
  35 #if defined(AFS_PTHREAD_ENV)
  36 #include <pthread.h>
  37 static pthread_once_t serverLogOnce = PTHREAD_ONCE_INIT;
  38 static pthread_mutex_t serverLogMutex;
  39 #define LOCK_SERVERLOG() opr_Verify(pthread_mutex_lock(&serverLogMutex) == 0)
  40 #define UNLOCK_SERVERLOG() opr_Verify(pthread_mutex_unlock(&serverLogMutex) == 0)
  41
  42 #ifdef AFS_NT40_ENV
  43 #define NULLDEV "NUL"
  44 #else
  45 #define NULLDEV "/dev/null"
  46 #endif
  47
  48 #else /* AFS_PTHREAD_ENV */
  49 #define LOCK_SERVERLOG()
  50 #define UNLOCK_SERVERLOG()
  51 #endif /* AFS_PTHREAD_ENV */
  52
  53 #ifdef AFS_NT40_ENV
  54 #define F_OK 0
  55 #define O_NONBLOCK 0
  56 #endif
  57
  58 static int
  59 dummyThreadNum(void)
  60 {
  61     return -1;
  62 }
  63 static int (*threadNumProgram) (void) = dummyThreadNum;
  64
  65 static int serverLogFD = -1;
  66
  67 #ifndef AFS_NT40_ENV
  68 int serverLogSyslog = 0;
  69 int serverLogSyslogFacility = LOG_DAEMON;
  70 char *serverLogSyslogTag = 0;
  71 #endif
  72
  73 int LogLevel;
  74 int mrafsStyleLogs = 0;
  75 static int threadIdLogs = 0;
  76 int printLocks = 0;
  77 static int resetSignals = 0;
  78 static char *ourName = NULL;
  79
  80 void
  81 SetLogThreadNumProgram(int (*func) (void) )
  82 {
  83     threadNumProgram = func;
  84 }
  85
  86 void
  87 WriteLogBuffer(char *buf, afs_uint32 len)
  88 {
  89     LOCK_SERVERLOG();
  90     if (serverLogFD >= 0) {
  91         if (write(serverLogFD, buf, len) < 0)
  92             ; /* don't care */
  93     }
  94     UNLOCK_SERVERLOG();
  95 }
  96
  97 int
  98 LogThreadNum(void)
  99 {
 100   return (*threadNumProgram) ();
 101 }
 102
 103 void
 104 vFSLog(const char *format, va_list args)
 105 {
 106     time_t currenttime;
 107     char tbuffer[1024];
 108     char *info;
 109     size_t len;
 110     struct tm tm;
 111     int num;
 112
 113     currenttime = time(NULL);
 114     len = strftime(tbuffer, sizeof(tbuffer), "%a %b %d %H:%M:%S %Y ",
 115                    localtime_r(&currenttime, &tm));
 116     info = &tbuffer[len];
 117
 118     if (mrafsStyleLogs || threadIdLogs) {
 119         num = (*threadNumProgram) ();
 120         if (num > -1) {
 121             snprintf(info, (sizeof tbuffer) - strlen(tbuffer), "[%d] ",
 122                      num);
 123             info += strlen(info);
 124         }
 125     }
 126
 127     vsnprintf(info, (sizeof tbuffer) - strlen(tbuffer), format, args);
 128
 129     len = strlen(tbuffer);
 130     LOCK_SERVERLOG();
 131 #ifndef AFS_NT40_ENV
 132     if (serverLogSyslog) {
 133         syslog(LOG_INFO, "%s", info);
 134     } else
 135 #endif
 136     if (serverLogFD >= 0) {
 137         if (write(serverLogFD, tbuffer, len) < 0)
 138             ; /* don't care */
 139     }
 140     UNLOCK_SERVERLOG();
 141
 142 #if !defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
 143     if (!serverLogSyslog) {
 144         fflush(stdout);
 145         fflush(stderr);         /* in case they're sharing the same FD */
 146     }
 147 #endif
 148 }                               /*vFSLog */
 149
 150 /* VARARGS1 */
 151 /*@printflike@*/
 152 void
 153 FSLog(const char *format, ...)
 154 {
 155     va_list args;
 156
 157     va_start(args, format);
 158     vFSLog(format, args);
 159     va_end(args);
 160 }                               /*FSLog */
 161
 162 void
 163 LogCommandLine(int argc, char **argv, const char *progname,
 164                const char *version, const char *logstring,
 165                void (*log) (const char *format, ...))
 166 {
 167     int i, l;
 168     char *commandLine, *cx;
 169
 170     opr_Assert(argc > 0);
 171
 172     for (l = i = 0; i < argc; i++)
 173         l += strlen(argv[i]) + 1;
 174     if ((commandLine = malloc(l))) {
 175         for (cx = commandLine, i = 0; i < argc; i++) {
 176             strcpy(cx, argv[i]);
 177             cx += strlen(cx);
 178             *(cx++) = ' ';
 179         }
 180         commandLine[l-1] = '\0';
 181         (*log)("%s %s %s%s(%s)\n", logstring, progname,
 182                     version, strlen(version)>0?" ":"", commandLine);
 183         free(commandLine);
 184     } else {
 185         /* What, we're out of memory already!? */
 186         (*log)("%s %s%s%s\n", logstring,
 187               progname, strlen(version)>0?" ":"", version);
 188     }
 189 }
 190
 191 void
 192 LogDesWarning(void)
 193 {
 194     /* The blank newlines help this stand out a bit more in the log. */
 195     ViceLog(0, ("\n"));
 196     ViceLog(0, ("WARNING: You are using single-DES keys in a KeyFile. Using single-DES\n"));
 197     ViceLog(0, ("WARNING: long-term keys is considered insecure, and it is strongly\n"));
 198     ViceLog(0, ("WARNING: recommended that you migrate to stronger encryption. See\n"));
 199     ViceLog(0, ("WARNING: OPENAFS-SA-2013-003 on http://www.openafs.org/security/\n"));
 200     ViceLog(0, ("WARNING: for details.\n"));
 201     ViceLog(0, ("\n"));
 202 }
 203
 204 static void*
 205 DebugOn(void *param)
 206 {
 207     int loglevel = (intptr_t)param;
 208     if (loglevel == 0) {
 209         ViceLog(0, ("Reset Debug levels to 0\n"));
 210     } else {
 211         ViceLog(0, ("Set Debug On level = %d\n", loglevel));
 212     }
 213     return 0;
 214 }                               /*DebugOn */
 215
 216
 217
 218 void
 219 SetDebug_Signal(int signo)
 220 {
 221     if (LogLevel > 0) {
 222         LogLevel *= 5;
 223
 224 #if defined(AFS_PTHREAD_ENV)
 225         if (LogLevel > 1 && threadNumProgram != NULL &&
 226             threadIdLogs == 0) {
 227             threadIdLogs = 1;
 228         }
 229 #endif
 230     } else {
 231         LogLevel = 1;
 232
 233 #if defined(AFS_PTHREAD_ENV)
 234         if (threadIdLogs == 1)
 235             threadIdLogs = 0;
 236 #endif
 237     }
 238     printLocks = 2;
 239 #if defined(AFS_PTHREAD_ENV)
 240     DebugOn((void *)(intptr_t)LogLevel);
 241 #else /* AFS_PTHREAD_ENV */
 242     IOMGR_SoftSig(DebugOn, (void *)(intptr_t)LogLevel);
 243 #endif /* AFS_PTHREAD_ENV */
 244
 245     if (resetSignals) {
 246         /* When pthreaded softsig handlers are not in use, some platforms
 247          * require this signal handler to be set again. */
 248         (void)signal(signo, SetDebug_Signal);
 249     }
 250 }                               /*SetDebug_Signal */
 251
 252 void
 253 ResetDebug_Signal(int signo)
 254 {
 255     LogLevel = 0;
 256
 257     if (printLocks > 0)
 258         --printLocks;
 259 #if defined(AFS_PTHREAD_ENV)
 260     DebugOn((void *)(intptr_t)LogLevel);
 261 #else /* AFS_PTHREAD_ENV */
 262     IOMGR_SoftSig(DebugOn, (void *)(intptr_t)LogLevel);
 263 #endif /* AFS_PTHREAD_ENV */
 264
 265     if (resetSignals) {
 266         /* When pthreaded softsig handlers are not in use, some platforms
 267          * require this signal handler to be set again. */
 268         (void)signal(signo, ResetDebug_Signal);
 269     }
 270 #if defined(AFS_PTHREAD_ENV)
 271     if (threadIdLogs == 1)
 272         threadIdLogs = 0;
 273 #endif
 274     if (mrafsStyleLogs) {
 275         LOCK_SERVERLOG();
 276         if (ourName != NULL) {
 277             OpenLog(ourName);
 278         }
 279         UNLOCK_SERVERLOG();
 280     }
 281 }                               /*ResetDebug_Signal */
 282
 283
 284 #ifdef AFS_PTHREAD_ENV
 285 /*!
 286  * Register pthread-safe signal handlers for server log management.
 287  *
 288  * \note opr_softsig_Init() must be called before this function.
 289  */
 290 void
 291 SetupLogSoftSignals(void)
 292 {
 293     opr_softsig_Register(SIGHUP, ResetDebug_Signal);
 294     opr_softsig_Register(SIGTSTP, SetDebug_Signal);
 295 #ifndef AFS_NT40_ENV
 296     (void)signal(SIGPIPE, SIG_IGN);
 297 #endif
 298 }
 299 #endif /* AFS_PTHREAD_ENV */
 300
 301 /*!
 302  * Register signal handlers for server log management.
 303  *
 304  * \note This function is deprecated and should not be used
 305  *       in new code. This function should be removed when
 306  *       all the servers have been converted to pthreads
 307  *       and lwp has been removed.
 308  */
 309 void
 310 SetupLogSignals(void)
 311 {
 312     resetSignals = 1;
 313     (void)signal(SIGHUP, ResetDebug_Signal);
 314     /* Note that we cannot use SIGUSR1 -- Linux stole it for pthreads! */
 315     (void)signal(SIGTSTP, SetDebug_Signal);
 316 #ifndef AFS_NT40_ENV
 317     (void)signal(SIGPIPE, SIG_IGN);
 318 #endif
 319 }
 320
 321 #if defined(AFS_PTHREAD_ENV)
 322 static void
 323 InitServerLogMutex(void)
 324 {
 325     opr_Verify(pthread_mutex_init(&serverLogMutex, NULL) == 0);
 326 }
 327 #endif /* AFS_PTHREAD_ENV */
 328
 329 int
 330 OpenLog(const char *fileName)
 331 {
 332     /*
 333      * This function should allow various libraries that inconsistently
 334      * use stdout/stderr to all go to the same place
 335      */
 336     int tempfd, isfifo = 0;
 337     int code;
 338     char *nextName = NULL;
 339     struct timeval Start;
 340     struct tm *TimeFields;
 341
 342 #ifndef AFS_NT40_ENV
 343     struct stat statbuf;
 344 #endif
 345
 346 #if defined(AFS_PTHREAD_ENV)
 347     opr_Verify(pthread_once(&serverLogOnce, InitServerLogMutex) == 0);
 348 #endif /* AFS_PTHREAD_ENV */
 349
 350 #ifndef AFS_NT40_ENV
 351     if (serverLogSyslog) {
 352         openlog(serverLogSyslogTag, LOG_PID, serverLogSyslogFacility);
 353         return (0);
 354     }
 355 #endif
 356
 357     opr_Assert(fileName != NULL);
 358
 359 #ifndef AFS_NT40_ENV
 360     /* Support named pipes as logs by not rotating them */
 361     if ((lstat(fileName, &statbuf) == 0)  && (S_ISFIFO(statbuf.st_mode))) {
 362         isfifo = 1;
 363     }
 364 #endif
 365
 366     if (mrafsStyleLogs) {
 367         time_t t;
 368         struct stat buf;
 369         gettimeofday(&Start, NULL);
 370         t = Start.tv_sec;
 371         TimeFields = localtime(&t);
 372     makefilename:
 373         code = asprintf(&nextName, "%s.%d%02d%02d%02d%02d%02d",
 374                  fileName, TimeFields->tm_year + 1900,
 375                  TimeFields->tm_mon + 1, TimeFields->tm_mday,
 376                  TimeFields->tm_hour, TimeFields->tm_min,
 377                  TimeFields->tm_sec);
 378         if (code < 0) {
 379             nextName = NULL;
 380         } else if (lstat(nextName, &buf) == 0) {
 381             /* avoid clobbering a log */
 382             TimeFields->tm_sec++;
 383             free(nextName);
 384             nextName = NULL;
 385             goto makefilename;
 386         }
 387     } else {
 388         code = asprintf(&nextName, "%s.old", fileName);
 389         if (code < 0) {
 390             nextName = NULL;
 391         }
 392     }
 393     if (nextName != NULL) {
 394         if (!isfifo)
 395             rk_rename(fileName, nextName);      /* Don't check the error code. */
 396         free(nextName);
 397     }
 398
 399     tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | O_APPEND | (isfifo?O_NONBLOCK:0), 0666);
 400     if (tempfd < 0) {
 401         printf("Unable to open log file %s\n", fileName);
 402         return -1;
 403     }
 404     /* redirect stdout and stderr so random printf's don't write to data */
 405     if (freopen(fileName, "a", stdout) == NULL)
 406         ; /* don't care */
 407     if (freopen(fileName, "a", stderr) != NULL) {
 408 #ifdef HAVE_SETVBUF
 409         setvbuf(stderr, NULL, _IONBF, 0);
 410 #else
 411         setbuf(stderr, NULL);
 412 #endif
 413     }
 414
 415     /* Save our name for reopening. */
 416     free(ourName);
 417     ourName = strdup(fileName);
 418     opr_Assert(ourName != NULL);
 419
 420     serverLogFD = tempfd;
 421
 422     return 0;
 423 }                               /*OpenLog */
 424
 425 int
 426 ReOpenLog(const char *fileName)
 427 {
 428     int isfifo = 0;
 429 #if !defined(AFS_NT40_ENV)
 430     struct stat statbuf;
 431 #endif
 432
 433     if (access(fileName, F_OK) == 0)
 434         return 0;               /* exists, no need to reopen. */
 435
 436 #if !defined(AFS_NT40_ENV)
 437     if (serverLogSyslog) {
 438         return 0;
 439     }
 440
 441     /* Support named pipes as logs by not rotating them */
 442     if ((lstat(fileName, &statbuf) == 0)  && (S_ISFIFO(statbuf.st_mode))) {
 443         isfifo = 1;
 444     }
 445 #endif
 446
 447     LOCK_SERVERLOG();
 448     if (serverLogFD >= 0)
 449         close(serverLogFD);
 450     serverLogFD = open(fileName, O_WRONLY | O_APPEND | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
 451     if (serverLogFD >= 0) {
 452         if (freopen(fileName, "a", stdout) == NULL)
 453             ; /* don't care */
 454         if (freopen(fileName, "a", stderr) != NULL) {
 455 #ifdef HAVE_SETVBUF
 456             setvbuf(stderr, NULL, _IONBF, 0);
 457 #else
 458             setbuf(stderr, NULL);
 459 #endif
 460         }
 461
 462     }
 463     UNLOCK_SERVERLOG();
 464     return serverLogFD < 0 ? -1 : 0;
 465 }
 466
 467 /*!
 468  * Close the server log file.
 469  *
 470  * \note Must be preceeded by OpenLog().
 471  */
 472 void
 473 CloseLog(void)
 474 {
 475     LOCK_SERVERLOG();
 476 #ifndef AFS_NT40_ENV
 477     if (serverLogSyslog) {
 478         closelog();
 479     } else
 480 #endif
 481     {
 482         if (serverLogFD >= 0) {
 483             close(serverLogFD);
 484             serverLogFD = -1;
 485         }
 486         free(ourName);
 487         ourName = NULL;
 488     }
 489     UNLOCK_SERVERLOG();
 490 }