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[MAXPATHLEN];
  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         OpenLog((char *)&ourName);
 276 }                               /*ResetDebug_Signal */
 277
 278
 279 #ifdef AFS_PTHREAD_ENV
 280 /*!
 281  * Register pthread-safe signal handlers for server log management.
 282  *
 283  * \note opr_softsig_Init() must be called before this function.
 284  */
 285 void
 286 SetupLogSoftSignals(void)
 287 {
 288     opr_softsig_Register(SIGHUP, ResetDebug_Signal);
 289     opr_softsig_Register(SIGTSTP, SetDebug_Signal);
 290 #ifndef AFS_NT40_ENV
 291     (void)signal(SIGPIPE, SIG_IGN);
 292 #endif
 293 }
 294 #endif /* AFS_PTHREAD_ENV */
 295
 296 /*!
 297  * Register signal handlers for server log management.
 298  *
 299  * \note This function is deprecated and should not be used
 300  *       in new code. This function should be removed when
 301  *       all the servers have been converted to pthreads
 302  *       and lwp has been removed.
 303  */
 304 void
 305 SetupLogSignals(void)
 306 {
 307     resetSignals = 1;
 308     (void)signal(SIGHUP, ResetDebug_Signal);
 309     /* Note that we cannot use SIGUSR1 -- Linux stole it for pthreads! */
 310     (void)signal(SIGTSTP, SetDebug_Signal);
 311 #ifndef AFS_NT40_ENV
 312     (void)signal(SIGPIPE, SIG_IGN);
 313 #endif
 314 }
 315
 316 #if defined(AFS_PTHREAD_ENV)
 317 static void
 318 InitServerLogMutex(void)
 319 {
 320     opr_Verify(pthread_mutex_init(&serverLogMutex, NULL) == 0);
 321 }
 322 #endif /* AFS_PTHREAD_ENV */
 323
 324 int
 325 OpenLog(const char *fileName)
 326 {
 327     /*
 328      * This function should allow various libraries that inconsistently
 329      * use stdout/stderr to all go to the same place
 330      */
 331     int tempfd, isfifo = 0;
 332     char oldName[MAXPATHLEN];
 333     struct timeval Start;
 334     struct tm *TimeFields;
 335     char FileName[MAXPATHLEN];
 336
 337 #ifndef AFS_NT40_ENV
 338     struct stat statbuf;
 339 #endif
 340
 341 #if defined(AFS_PTHREAD_ENV)
 342     opr_Verify(pthread_once(&serverLogOnce, InitServerLogMutex) == 0);
 343 #endif /* AFS_PTHREAD_ENV */
 344
 345 #ifndef AFS_NT40_ENV
 346     if (serverLogSyslog) {
 347         openlog(serverLogSyslogTag, LOG_PID, serverLogSyslogFacility);
 348         return (0);
 349     }
 350
 351     /* Support named pipes as logs by not rotating them */
 352     if ((lstat(fileName, &statbuf) == 0)  && (S_ISFIFO(statbuf.st_mode))) {
 353         isfifo = 1;
 354     }
 355 #endif
 356
 357     if (mrafsStyleLogs) {
 358         time_t t;
 359         struct stat buf;
 360         gettimeofday(&Start, NULL);
 361         t = Start.tv_sec;
 362         TimeFields = localtime(&t);
 363         if (fileName) {
 364             if (strncmp(fileName, (char *)&ourName, strlen(fileName)))
 365                 strcpy((char *)&ourName, (char *)fileName);
 366         }
 367     makefilename:
 368         snprintf(FileName, MAXPATHLEN, "%s.%d%02d%02d%02d%02d%02d",
 369                  ourName, TimeFields->tm_year + 1900,
 370                  TimeFields->tm_mon + 1, TimeFields->tm_mday,
 371                  TimeFields->tm_hour, TimeFields->tm_min,
 372                  TimeFields->tm_sec);
 373         if(lstat(FileName, &buf) == 0) {
 374             /* avoid clobbering a log */
 375             TimeFields->tm_sec++;
 376             goto makefilename;
 377         }
 378         if (!isfifo)
 379             rk_rename(fileName, FileName);      /* don't check error code */
 380         tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
 381     } else {
 382         strcpy(oldName, fileName);
 383         strcat(oldName, ".old");
 384
 385         /* don't check error */
 386         if (!isfifo)
 387             rk_rename(fileName, oldName);
 388         tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | O_APPEND | (isfifo?O_NONBLOCK:0), 0666);
 389     }
 390
 391     if (tempfd < 0) {
 392         printf("Unable to open log file %s\n", fileName);
 393         return -1;
 394     }
 395     /* redirect stdout and stderr so random printf's don't write to data */
 396     if (freopen(fileName, "a", stdout) == NULL)
 397         ; /* don't care */
 398     if (freopen(fileName, "a", stderr) != NULL) {
 399 #ifdef HAVE_SETVBUF
 400         setvbuf(stderr, NULL, _IONBF, 0);
 401 #else
 402         setbuf(stderr, NULL);
 403 #endif
 404     }
 405
 406     serverLogFD = tempfd;
 407
 408     return 0;
 409 }                               /*OpenLog */
 410
 411 int
 412 ReOpenLog(const char *fileName)
 413 {
 414     int isfifo = 0;
 415 #if !defined(AFS_NT40_ENV)
 416     struct stat statbuf;
 417 #endif
 418
 419     if (access(fileName, F_OK) == 0)
 420         return 0;               /* exists, no need to reopen. */
 421
 422 #if !defined(AFS_NT40_ENV)
 423     if (serverLogSyslog) {
 424         return 0;
 425     }
 426
 427     /* Support named pipes as logs by not rotating them */
 428     if ((lstat(fileName, &statbuf) == 0)  && (S_ISFIFO(statbuf.st_mode))) {
 429         isfifo = 1;
 430     }
 431 #endif
 432
 433     LOCK_SERVERLOG();
 434     if (serverLogFD >= 0)
 435         close(serverLogFD);
 436     serverLogFD = open(fileName, O_WRONLY | O_APPEND | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
 437     if (serverLogFD >= 0) {
 438         if (freopen(fileName, "a", stdout) == NULL)
 439             ; /* don't care */
 440         if (freopen(fileName, "a", stderr) != NULL) {
 441 #ifdef HAVE_SETVBUF
 442 #ifdef SETVBUF_REVERSED
 443             setvbuf(stderr, _IONBF, NULL, 0);
 444 #else
 445             setvbuf(stderr, NULL, _IONBF, 0);
 446 #endif
 447 #else
 448             setbuf(stderr, NULL);
 449 #endif
 450         }
 451
 452     }
 453     UNLOCK_SERVERLOG();
 454     return serverLogFD < 0 ? -1 : 0;
 455 }
 456
 457 /*!
 458  * Close the server log file.
 459  *
 460  * \note Must be preceeded by OpenLog().
 461  */
 462 void
 463 CloseLog(void)
 464 {
 465     LOCK_SERVERLOG();
 466 #ifndef AFS_NT40_ENV
 467     if (serverLogSyslog) {
 468         closelog();
 469     } else
 470 #endif
 471     if (serverLogFD >= 0) {
 472         close(serverLogFD);
 473         serverLogFD = -1;
 474     }
 475     UNLOCK_SERVERLOG();
 476 }