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