util: always initialize the server log mutex
[openafs.git] / src / util / serverLog.c
index d94dd84..b7b1465 100644 (file)
 #include <afs/procmgmt.h>      /* signal(), kill(), wait(), etc. */
 
 #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)
-/* can't include rx when we are libutil; it's too early */
-#include <rx/rx.h>
 #include <pthread.h>
+static pthread_once_t serverLogOnce = PTHREAD_ONCE_INIT;
 static pthread_mutex_t serverLogMutex;
-#define LOCK_SERVERLOG() MUTEX_ENTER(&serverLogMutex)
-#define UNLOCK_SERVERLOG() MUTEX_EXIT(&serverLogMutex)
+#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"
@@ -72,6 +74,7 @@ int LogLevel;
 int mrafsStyleLogs = 0;
 static int threadIdLogs = 0;
 int printLocks = 0;
+static int resetSignals = 0;
 static char ourName[MAXPATHLEN];
 
 void
@@ -84,8 +87,10 @@ void
 WriteLogBuffer(char *buf, afs_uint32 len)
 {
     LOCK_SERVERLOG();
-    if (serverLogFD > 0)
-       (void)write(serverLogFD, buf, len);
+    if (serverLogFD >= 0) {
+       if (write(serverLogFD, buf, len) < 0)
+           ; /* don't care */
+    }
     UNLOCK_SERVERLOG();
 }
 
@@ -128,8 +133,10 @@ vFSLog(const char *format, va_list args)
        syslog(LOG_INFO, "%s", info);
     } else
 #endif
-    if (serverLogFD > 0)
-       (void)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)
@@ -181,6 +188,19 @@ LogCommandLine(int argc, char **argv, const char *progname,
     }
 }
 
+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 void*
 DebugOn(void *param)
 {
@@ -222,9 +242,11 @@ SetDebug_Signal(int signo)
     IOMGR_SoftSig(DebugOn, (void *)(intptr_t)LogLevel);
 #endif /* AFS_PTHREAD_ENV */
 
-    (void)signal(signo, SetDebug_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, SetDebug_Signal);
+    }
 }                              /*SetDebug_Signal */
 
 void
@@ -240,10 +262,11 @@ ResetDebug_Signal(int signo)
     IOMGR_SoftSig(DebugOn, (void *)(intptr_t)LogLevel);
 #endif /* AFS_PTHREAD_ENV */
 
-    (void)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;
@@ -253,9 +276,35 @@ ResetDebug_Signal(int signo)
 }                              /*ResetDebug_Signal */
 
 
+#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)
+{
+    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! */
     (void)signal(SIGTSTP, SetDebug_Signal);
@@ -264,6 +313,14 @@ SetupLogSignals(void)
 #endif
 }
 
+#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)
 {
@@ -279,7 +336,13 @@ OpenLog(const char *fileName)
 
 #ifndef AFS_NT40_ENV
     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);
@@ -313,7 +376,7 @@ OpenLog(const char *fileName)
            goto makefilename;
        }
        if (!isfifo)
-           renamefile(fileName, FileName);     /* don't check error code */
+           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);
@@ -321,8 +384,8 @@ OpenLog(const char *fileName)
 
        /* don't check error */
        if (!isfifo)
-           renamefile(fileName, oldName);
-       tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
+           rk_rename(fileName, oldName);
+       tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | O_APPEND | (isfifo?O_NONBLOCK:0), 0666);
     }
 
     if (tempfd < 0) {
@@ -330,17 +393,15 @@ OpenLog(const char *fileName)
        return -1;
     }
     /* redirect stdout and stderr so random printf's don't write to data */
-    (void)freopen(fileName, "a", stdout);
-    (void)freopen(fileName, "a", stderr);
+    if (freopen(fileName, "a", stdout) == NULL)
+       ; /* don't care */
+    if (freopen(fileName, "a", stderr) != NULL) {
 #ifdef HAVE_SETVBUF
-    setvbuf(stderr, NULL, _IONBF, 0);
+       setvbuf(stderr, NULL, _IONBF, 0);
 #else
-    setbuf(stderr, NULL);
+       setbuf(stderr, NULL);
 #endif
-
-#if defined(AFS_PTHREAD_ENV)
-    MUTEX_INIT(&serverLogMutex, "serverlog", MUTEX_DEFAULT, 0);
-#endif /* AFS_PTHREAD_ENV */
+    }
 
     serverLogFD = tempfd;
 
@@ -370,23 +431,46 @@ ReOpenLog(const char *fileName)
 #endif
 
     LOCK_SERVERLOG();
-    if (serverLogFD > 0)
+    if (serverLogFD >= 0)
        close(serverLogFD);
     serverLogFD = open(fileName, O_WRONLY | O_APPEND | O_CREAT | (isfifo?O_NONBLOCK:0), 0666);
-    if (serverLogFD > 0) {
-       (void)freopen(fileName, "a", stdout);
-       (void)freopen(fileName, "a", stderr);
+    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);
+           setvbuf(stderr, _IONBF, NULL, 0);
 #else
-       setvbuf(stderr, NULL, _IONBF, 0);
+           setvbuf(stderr, NULL, _IONBF, 0);
 #endif
 #else
-       setbuf(stderr, NULL);
+           setbuf(stderr, NULL);
 #endif
+       }
 
     }
     UNLOCK_SERVERLOG();
     return serverLogFD < 0 ? -1 : 0;
 }
+
+/*!
+ * 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();
+}