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