/*
* Copyright 2000, International Business Machines Corporation and others.
* All Rights Reserved.
- *
+ *
* This software has been released under the terms of the IBM Public
* License. For details, see the LICENSE file in the top-level source
* directory or online at http://www.openafs.org/dl/license10.html
/* */
/* ********************************************************************** */
-#include <afs/param.h>
#include <afsconfig.h>
+#include <afs/param.h>
+#include <afs/stds.h>
-RCSID("$Header$");
+#include <afs/procmgmt.h> /* signal(), kill(), wait(), etc. */
-#include <stdio.h>
-#ifdef AFS_NT40_ENV
-#include <io.h>
-#include <time.h>
-#else
-#ifdef AFS_AIX_ENV
-#include <time.h>
-#endif
-#include <sys/param.h>
-#include <sys/time.h>
-#include <syslog.h>
-#endif
-#include <afs/procmgmt.h> /* signal(), kill(), wait(), etc. */
-#include <fcntl.h>
-#include <afs/stds.h>
-#ifdef HAVE_STRINGS_H
-#include <strings.h>
-#else
-#ifdef HAVE_STRING_H
-#include <string.h>
-#endif
+#include <roken.h> /* Must come after procmgmt.h */
+#ifdef AFS_PTHREAD_ENV
+ #include <opr/softsig.h>
+ #include <afs/procmgmt_softsig.h> /* Must come after softsig.h */
#endif
+#include <afs/opr.h>
#include "afsutil.h"
#include "fileutil.h"
+#include <lwp.h>
+
#if defined(AFS_PTHREAD_ENV)
-#include <assert.h>
#include <pthread.h>
+static pthread_once_t serverLogOnce = PTHREAD_ONCE_INIT;
static pthread_mutex_t serverLogMutex;
-#define LOCK_SERVERLOG() assert(pthread_mutex_lock(&serverLogMutex)==0)
-#define UNLOCK_SERVERLOG() assert(pthread_mutex_unlock(&serverLogMutex)==0)
+#define LOCK_SERVERLOG() opr_Verify(pthread_mutex_lock(&serverLogMutex) == 0)
+#define UNLOCK_SERVERLOG() opr_Verify(pthread_mutex_unlock(&serverLogMutex) == 0)
#ifdef AFS_NT40_ENV
#define NULLDEV "NUL"
#endif
#else /* AFS_PTHREAD_ENV */
-#define LOCK_SERVERLOG()
-#define UNLOCK_SERVERLOG()
-#endif /* AFS_PTHREAD_ENV */
+#define LOCK_SERVERLOG()
+#define UNLOCK_SERVERLOG()
+#endif /* AFS_PTHREAD_ENV */
#ifdef AFS_NT40_ENV
#define F_OK 0
+#define O_NONBLOCK 0
#endif
-char *(*threadNameProgram)();
+static int
+dummyThreadNum(void)
+{
+ return -1;
+}
+static int (*threadNumProgram) (void) = dummyThreadNum;
static int serverLogFD = -1;
#ifndef AFS_NT40_ENV
int serverLogSyslog = 0;
int serverLogSyslogFacility = LOG_DAEMON;
+char *serverLogSyslogTag = 0;
#endif
-#include <stdarg.h>
int LogLevel;
int mrafsStyleLogs = 0;
+static int threadIdLogs = 0;
int printLocks = 0;
+static int resetSignals = 0;
static char ourName[MAXPATHLEN];
-void WriteLogBuffer(buf,len)
- char *buf;
- afs_uint32 len;
+void
+SetLogThreadNumProgram(int (*func) (void) )
+{
+ threadNumProgram = func;
+}
+
+void
+WriteLogBuffer(char *buf, afs_uint32 len)
{
LOCK_SERVERLOG();
- if (serverLogFD > 0)
- write(serverLogFD, buf, len);
+ if (serverLogFD >= 0) {
+ if (write(serverLogFD, buf, len) < 0)
+ ; /* don't care */
+ }
UNLOCK_SERVERLOG();
}
-/* VARARGS1 */
-void FSLog (const char *format, ...)
+int
+LogThreadNum(void)
{
- va_list args;
+ return (*threadNumProgram) ();
+}
+void
+vFSLog(const char *format, va_list args)
+{
time_t currenttime;
- char *timeStamp;
char tbuffer[1024];
char *info;
- int len;
- char *name;
-
- currenttime = time(0);
- timeStamp = afs_ctime(¤ttime, tbuffer, sizeof(tbuffer));
- timeStamp[24] = ' '; /* ts[24] is the newline, 25 is the null */
- info = &timeStamp[25];
-
- if (mrafsStyleLogs) {
- name = (*threadNameProgram)();
- sprintf(info, "[%s] ", name);
- info += strlen(info);
+ size_t len;
+ struct tm tm;
+ int num;
+
+ currenttime = time(NULL);
+ len = strftime(tbuffer, sizeof(tbuffer), "%a %b %d %H:%M:%S %Y ",
+ localtime_r(¤ttime, &tm));
+ info = &tbuffer[len];
+
+ if (mrafsStyleLogs || threadIdLogs) {
+ num = (*threadNumProgram) ();
+ if (num > -1) {
+ snprintf(info, (sizeof tbuffer) - strlen(tbuffer), "[%d] ",
+ num);
+ info += strlen(info);
+ }
}
- va_start(args, format);
- (void) vsprintf(info, format, args);
- va_end(args);
+ vsnprintf(info, (sizeof tbuffer) - strlen(tbuffer), format, args);
len = strlen(tbuffer);
LOCK_SERVERLOG();
#ifndef AFS_NT40_ENV
- if ( serverLogSyslog ){
+ if (serverLogSyslog) {
syslog(LOG_INFO, "%s", info);
- } else
+ } else
#endif
- if (serverLogFD > 0)
- write(serverLogFD, tbuffer, len);
+ if (serverLogFD >= 0) {
+ if (write(serverLogFD, tbuffer, len) < 0)
+ ; /* don't care */
+ }
UNLOCK_SERVERLOG();
#if !defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
- if ( ! serverLogSyslog ) {
- fflush(stdout);
- fflush(stderr); /* in case they're sharing the same FD */
+ if (!serverLogSyslog) {
+ fflush(stdout);
+ fflush(stderr); /* in case they're sharing the same FD */
}
#endif
+} /*vFSLog */
+
+/* VARARGS1 */
+/*@printflike@*/
+void
+FSLog(const char *format, ...)
+{
+ va_list args;
+
+ va_start(args, format);
+ vFSLog(format, args);
+ va_end(args);
+} /*FSLog */
+
+void
+LogCommandLine(int argc, char **argv, const char *progname,
+ const char *version, const char *logstring,
+ void (*log) (const char *format, ...))
+{
+ int i, l;
+ char *commandLine, *cx;
+
+ opr_Assert(argc > 0);
+
+ for (l = i = 0; i < argc; i++)
+ l += strlen(argv[i]) + 1;
+ if ((commandLine = malloc(l))) {
+ for (cx = commandLine, i = 0; i < argc; i++) {
+ strcpy(cx, argv[i]);
+ cx += strlen(cx);
+ *(cx++) = ' ';
+ }
+ commandLine[l-1] = '\0';
+ (*log)("%s %s %s%s(%s)\n", logstring, progname,
+ version, strlen(version)>0?" ":"", commandLine);
+ free(commandLine);
+ } else {
+ /* What, we're out of memory already!? */
+ (*log)("%s %s%s%s\n", logstring,
+ progname, strlen(version)>0?" ":"", version);
+ }
+}
+
+void
+LogDesWarning(void)
+{
+ /* The blank newlines help this stand out a bit more in the log. */
+ ViceLog(0, ("\n"));
+ ViceLog(0, ("WARNING: You are using single-DES keys in a KeyFile. Using single-DES\n"));
+ ViceLog(0, ("WARNING: long-term keys is considered insecure, and it is strongly\n"));
+ ViceLog(0, ("WARNING: recommended that you migrate to stronger encryption. See\n"));
+ ViceLog(0, ("WARNING: OPENAFS-SA-2013-003 on http://www.openafs.org/security/\n"));
+ ViceLog(0, ("WARNING: for details.\n"));
+ ViceLog(0, ("\n"));
}
-static int DebugOn(int loglevel)
+static void*
+DebugOn(void *param)
{
+ int loglevel = (intptr_t)param;
if (loglevel == 0) {
- ViceLog(0, ("Reset Debug levels to 0\n"));
+ ViceLog(0, ("Reset Debug levels to 0\n"));
} else {
- ViceLog(0, ("Set Debug On level = %d\n",loglevel));
+ ViceLog(0, ("Set Debug On level = %d\n", loglevel));
}
return 0;
-} /*DebugOn*/
+} /*DebugOn */
-void SetDebug_Signal(int signo)
+void
+SetDebug_Signal(int signo)
{
- extern int IOMGR_SoftSig();
-
if (LogLevel > 0) {
- LogLevel *= 5;
- }
- else {
- LogLevel = 1;
+ LogLevel *= 5;
+
+#if defined(AFS_PTHREAD_ENV)
+ if (LogLevel > 1 && threadNumProgram != NULL &&
+ threadIdLogs == 0) {
+ threadIdLogs = 1;
+ }
+#endif
+ } else {
+ LogLevel = 1;
+
+#if defined(AFS_PTHREAD_ENV)
+ if (threadIdLogs == 1)
+ threadIdLogs = 0;
+#endif
}
printLocks = 2;
#if defined(AFS_PTHREAD_ENV)
- DebugOn(LogLevel);
+ DebugOn((void *)(intptr_t)LogLevel);
#else /* AFS_PTHREAD_ENV */
- IOMGR_SoftSig(DebugOn, LogLevel);
+ IOMGR_SoftSig(DebugOn, (void *)(intptr_t)LogLevel);
#endif /* AFS_PTHREAD_ENV */
- signal(signo, SetDebug_Signal); /* on some platforms, this signal */
- /* handler needs to be set again */
-} /*SetDebug_Signal*/
+ if (resetSignals) {
+ /* When pthreaded softsig handlers are not in use, some platforms
+ * require this signal handler to be set again. */
+ (void)signal(signo, SetDebug_Signal);
+ }
+} /*SetDebug_Signal */
-void ResetDebug_Signal(int signo)
+void
+ResetDebug_Signal(int signo)
{
LogLevel = 0;
- if (printLocks >0) --printLocks;
+ if (printLocks > 0)
+ --printLocks;
#if defined(AFS_PTHREAD_ENV)
- DebugOn(LogLevel);
+ DebugOn((void *)(intptr_t)LogLevel);
#else /* AFS_PTHREAD_ENV */
- IOMGR_SoftSig(DebugOn, (void *)LogLevel);
+ IOMGR_SoftSig(DebugOn, (void *)(intptr_t)LogLevel);
#endif /* AFS_PTHREAD_ENV */
- signal(signo, ResetDebug_Signal); /* on some platforms, this signal */
- /* handler needs to be set again */
+ if (resetSignals) {
+ /* When pthreaded softsig handlers are not in use, some platforms
+ * require this signal handler to be set again. */
+ (void)signal(signo, ResetDebug_Signal);
+ }
+#if defined(AFS_PTHREAD_ENV)
+ if (threadIdLogs == 1)
+ threadIdLogs = 0;
+#endif
if (mrafsStyleLogs)
OpenLog((char *)&ourName);
-} /*ResetDebug_Signal*/
+} /*ResetDebug_Signal */
-void SetupLogSignals(void)
+#ifdef AFS_PTHREAD_ENV
+/*!
+ * Register pthread-safe signal handlers for server log management.
+ *
+ * \note opr_softsig_Init() must be called before this function.
+ */
+void
+SetupLogSoftSignals(void)
{
- signal(SIGHUP, ResetDebug_Signal);
+ opr_softsig_Register(SIGHUP, ResetDebug_Signal);
+ opr_softsig_Register(SIGTSTP, SetDebug_Signal);
+#ifndef AFS_NT40_ENV
+ (void)signal(SIGPIPE, SIG_IGN);
+#endif
+}
+#endif /* AFS_PTHREAD_ENV */
+
+/*!
+ * Register signal handlers for server log management.
+ *
+ * \note This function is deprecated and should not be used
+ * in new code. This function should be removed when
+ * all the servers have been converted to pthreads
+ * and lwp has been removed.
+ */
+void
+SetupLogSignals(void)
+{
+ resetSignals = 1;
+ (void)signal(SIGHUP, ResetDebug_Signal);
/* Note that we cannot use SIGUSR1 -- Linux stole it for pthreads! */
- signal(SIGTSTP, SetDebug_Signal);
+ (void)signal(SIGTSTP, SetDebug_Signal);
+#ifndef AFS_NT40_ENV
+ (void)signal(SIGPIPE, SIG_IGN);
+#endif
}
-int OpenLog(const char *fileName)
+#if defined(AFS_PTHREAD_ENV)
+static void
+InitServerLogMutex(void)
+{
+ opr_Verify(pthread_mutex_init(&serverLogMutex, NULL) == 0);
+}
+#endif /* AFS_PTHREAD_ENV */
+
+int
+OpenLog(const char *fileName)
{
/*
* This function should allow various libraries that inconsistently
* use stdout/stderr to all go to the same place
*/
- int tempfd;
+ int tempfd, isfifo = 0;
char oldName[MAXPATHLEN];
struct timeval Start;
struct tm *TimeFields;
- char FileName[MAXPATHLEN];
+ char FileName[MAXPATHLEN];
#ifndef AFS_NT40_ENV
- if ( serverLogSyslog ) {
- openlog(NULL, LOG_PID, serverLogSyslogFacility);
- return(0);
+ struct stat statbuf;
+#endif
+
+#if defined(AFS_PTHREAD_ENV)
+ opr_Verify(pthread_once(&serverLogOnce, InitServerLogMutex) == 0);
+#endif /* AFS_PTHREAD_ENV */
+
+#ifndef AFS_NT40_ENV
+ if (serverLogSyslog) {
+ openlog(serverLogSyslogTag, LOG_PID, serverLogSyslogFacility);
+ return (0);
+ }
+
+ /* Support named pipes as logs by not rotating them */
+ if ((lstat(fileName, &statbuf) == 0) && (S_ISFIFO(statbuf.st_mode))) {
+ isfifo = 1;
}
#endif
if (mrafsStyleLogs) {
- TM_GetTimeOfDay(&Start, 0);
- TimeFields = localtime(&Start.tv_sec);
- if (fileName) {
- if (strncmp(fileName, (char *)&ourName, strlen(fileName)))
- strcpy((char *)&ourName, (char *) fileName);
+ time_t t;
+ struct stat buf;
+ gettimeofday(&Start, NULL);
+ t = Start.tv_sec;
+ TimeFields = localtime(&t);
+ if (fileName) {
+ if (strncmp(fileName, (char *)&ourName, strlen(fileName)))
+ strcpy((char *)&ourName, (char *)fileName);
}
- sprintf(FileName, "%s.%d%02d%02d%02d%02d%02d", ourName,
- TimeFields->tm_year + 1900, TimeFields->tm_mon + 1,
- TimeFields->tm_mday, TimeFields->tm_hour,
- TimeFields->tm_min, TimeFields->tm_sec);
- rename (fileName, FileName); /* don't check error code */
- tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT, 0666);
+ makefilename:
+ snprintf(FileName, MAXPATHLEN, "%s.%d%02d%02d%02d%02d%02d",
+ ourName, TimeFields->tm_year + 1900,
+ TimeFields->tm_mon + 1, TimeFields->tm_mday,
+ TimeFields->tm_hour, TimeFields->tm_min,
+ TimeFields->tm_sec);
+ if(lstat(FileName, &buf) == 0) {
+ /* avoid clobbering a log */
+ TimeFields->tm_sec++;
+ goto makefilename;
+ }
+ if (!isfifo)
+ rk_rename(fileName, FileName); /* don't check error code */
+ tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
} else {
- strcpy(oldName, fileName);
- strcat(oldName, ".old");
+ strcpy(oldName, fileName);
+ strcat(oldName, ".old");
- /* don't check error */
- renamefile(fileName, oldName);
- tempfd = open(fileName, O_WRONLY|O_TRUNC|O_CREAT, 0666);
+ /* don't check error */
+ if (!isfifo)
+ rk_rename(fileName, oldName);
+ tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | O_APPEND | (isfifo?O_NONBLOCK:0), 0666);
}
- if(tempfd < 0)
- {
+ if (tempfd < 0) {
printf("Unable to open log file %s\n", fileName);
return -1;
}
-
-#if defined(AFS_PTHREAD_ENV)
/* redirect stdout and stderr so random printf's don't write to data */
- assert(freopen(NULLDEV, "w", stdout) != NULL);
- assert(freopen(NULLDEV, "w", stderr) != NULL);
-
- assert(pthread_mutex_init(&serverLogMutex, NULL) == 0);
+ if (freopen(fileName, "a", stdout) == NULL)
+ ; /* don't care */
+ if (freopen(fileName, "a", stderr) != NULL) {
+#ifdef HAVE_SETVBUF
+ setvbuf(stderr, NULL, _IONBF, 0);
+#else
+ setbuf(stderr, NULL);
+#endif
+ }
serverLogFD = tempfd;
-#else
- close(tempfd); /* just checking.... */
- freopen(fileName, "w", stdout);
- freopen(fileName, "w", stderr);
- serverLogFD = fileno(stdout);
-#endif /* AFS_PTHREAD_ENV */
return 0;
-} /*OpenLog*/
+} /*OpenLog */
-int ReOpenLog(const char *fileName)
+int
+ReOpenLog(const char *fileName)
{
-#if !defined(AFS_PTHREAD_ENV)
- int tempfd;
+ int isfifo = 0;
+#if !defined(AFS_NT40_ENV)
+ struct stat statbuf;
#endif
- if (access(fileName, F_OK)==0)
- return 0; /* exists, no need to reopen. */
+ if (access(fileName, F_OK) == 0)
+ return 0; /* exists, no need to reopen. */
#if !defined(AFS_NT40_ENV)
- if ( serverLogSyslog ) {
+ if (serverLogSyslog) {
return 0;
}
+
+ /* Support named pipes as logs by not rotating them */
+ if ((lstat(fileName, &statbuf) == 0) && (S_ISFIFO(statbuf.st_mode))) {
+ isfifo = 1;
+ }
#endif
-#if defined(AFS_PTHREAD_ENV)
LOCK_SERVERLOG();
- if (serverLogFD > 0)
+ if (serverLogFD >= 0)
close(serverLogFD);
- serverLogFD = open(fileName,O_WRONLY|O_APPEND|O_CREAT, 0666);
- UNLOCK_SERVERLOG();
- return serverLogFD < 0 ? -1 : 0;
+ serverLogFD = open(fileName, O_WRONLY | O_APPEND | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
+ if (serverLogFD >= 0) {
+ if (freopen(fileName, "a", stdout) == NULL)
+ ; /* don't care */
+ if (freopen(fileName, "a", stderr) != NULL) {
+#ifdef HAVE_SETVBUF
+#ifdef SETVBUF_REVERSED
+ setvbuf(stderr, _IONBF, NULL, 0);
+#else
+ setvbuf(stderr, NULL, _IONBF, 0);
+#endif
#else
+ setbuf(stderr, NULL);
+#endif
+ }
- tempfd = open(fileName,O_WRONLY|O_APPEND|O_CREAT, 0666);
- if(tempfd < 0)
- {
- printf("Unable to open log file %s\n", fileName);
- return -1;
}
- close(tempfd);
-
- freopen(fileName, "a", stdout);
- freopen(fileName, "a", stderr);
- serverLogFD = fileno(stdout);
-
+ UNLOCK_SERVERLOG();
+ return serverLogFD < 0 ? -1 : 0;
+}
- return 0;
-#endif /* AFS_PTHREAD_ENV */
+/*!
+ * Close the server log file.
+ *
+ * \note Must be preceeded by OpenLog().
+ */
+void
+CloseLog(void)
+{
+ LOCK_SERVERLOG();
+#ifndef AFS_NT40_ENV
+ if (serverLogSyslog) {
+ closelog();
+ } else
+#endif
+ if (serverLogFD >= 0) {
+ close(serverLogFD);
+ serverLogFD = -1;
+ }
+ UNLOCK_SERVERLOG();
}
git://git.openafs.org / openafs.git / blobdiff