2 * Copyright 2000, International Business Machines Corporation and others.
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
10 /* serverLog.c - Server logging */
12 /* Information Technology Center */
15 /* Function - These routiens implement logging from the servers */
17 /* ********************************************************************** */
19 #include <afsconfig.h>
20 #include <afs/param.h>
23 #include <afs/procmgmt.h> /* signal(), kill(), wait(), etc. */
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 */
35 #if defined(AFS_PTHREAD_ENV)
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)
44 #define NULLDEV "/dev/null"
47 #else /* AFS_PTHREAD_ENV */
48 #define LOCK_SERVERLOG()
49 #define UNLOCK_SERVERLOG()
50 #endif /* AFS_PTHREAD_ENV */
62 static int (*threadNumProgram) (void) = dummyThreadNum;
64 static int serverLogFD = -1;
67 int serverLogSyslog = 0;
68 int serverLogSyslogFacility = LOG_DAEMON;
69 char *serverLogSyslogTag = 0;
73 int mrafsStyleLogs = 0;
74 static int threadIdLogs = 0;
76 static int resetSignals = 0;
77 static char ourName[MAXPATHLEN];
80 SetLogThreadNumProgram(int (*func) (void) )
82 threadNumProgram = func;
86 WriteLogBuffer(char *buf, afs_uint32 len)
89 if (serverLogFD >= 0) {
90 if (write(serverLogFD, buf, len) < 0)
99 return (*threadNumProgram) ();
103 vFSLog(const char *format, va_list args)
112 currenttime = time(NULL);
113 len = strftime(tbuffer, sizeof(tbuffer), "%a %b %d %H:%M:%S %Y ",
114 localtime_r(¤ttime, &tm));
115 info = &tbuffer[len];
117 if (mrafsStyleLogs || threadIdLogs) {
118 num = (*threadNumProgram) ();
120 snprintf(info, (sizeof tbuffer) - strlen(tbuffer), "[%d] ",
122 info += strlen(info);
126 vsnprintf(info, (sizeof tbuffer) - strlen(tbuffer), format, args);
128 len = strlen(tbuffer);
131 if (serverLogSyslog) {
132 syslog(LOG_INFO, "%s", info);
135 if (serverLogFD >= 0) {
136 if (write(serverLogFD, tbuffer, len) < 0)
141 #if !defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
142 if (!serverLogSyslog) {
144 fflush(stderr); /* in case they're sharing the same FD */
152 FSLog(const char *format, ...)
156 va_start(args, format);
157 vFSLog(format, args);
162 LogCommandLine(int argc, char **argv, const char *progname,
163 const char *version, const char *logstring,
164 void (*log) (const char *format, ...))
167 char *commandLine, *cx;
169 opr_Assert(argc > 0);
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++) {
179 commandLine[l-1] = '\0';
180 (*log)("%s %s %s%s(%s)\n", logstring, progname,
181 version, strlen(version)>0?" ":"", commandLine);
184 /* What, we're out of memory already!? */
185 (*log)("%s %s%s%s\n", logstring,
186 progname, strlen(version)>0?" ":"", version);
193 /* The blank newlines help this stand out a bit more in the log. */
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"));
206 int loglevel = (intptr_t)param;
208 ViceLog(0, ("Reset Debug levels to 0\n"));
210 ViceLog(0, ("Set Debug On level = %d\n", loglevel));
218 SetDebug_Signal(int signo)
223 #if defined(AFS_PTHREAD_ENV)
224 if (LogLevel > 1 && threadNumProgram != NULL &&
232 #if defined(AFS_PTHREAD_ENV)
233 if (threadIdLogs == 1)
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 */
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);
249 } /*SetDebug_Signal */
252 ResetDebug_Signal(int signo)
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 */
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);
269 #if defined(AFS_PTHREAD_ENV)
270 if (threadIdLogs == 1)
274 OpenLog((char *)&ourName);
275 } /*ResetDebug_Signal */
278 #ifdef AFS_PTHREAD_ENV
280 * Register pthread-safe signal handlers for server log management.
282 * \note opr_softsig_Init() must be called before this function.
285 SetupLogSoftSignals(void)
287 opr_softsig_Register(SIGHUP, ResetDebug_Signal);
288 opr_softsig_Register(SIGTSTP, SetDebug_Signal);
290 (void)signal(SIGPIPE, SIG_IGN);
293 #endif /* AFS_PTHREAD_ENV */
296 * Register signal handlers for server log management.
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.
304 SetupLogSignals(void)
307 (void)signal(SIGHUP, ResetDebug_Signal);
308 /* Note that we cannot use SIGUSR1 -- Linux stole it for pthreads! */
309 (void)signal(SIGTSTP, SetDebug_Signal);
311 (void)signal(SIGPIPE, SIG_IGN);
316 OpenLog(const char *fileName)
319 * This function should allow various libraries that inconsistently
320 * use stdout/stderr to all go to the same place
322 int tempfd, isfifo = 0;
323 char oldName[MAXPATHLEN];
324 struct timeval Start;
325 struct tm *TimeFields;
326 char FileName[MAXPATHLEN];
331 if (serverLogSyslog) {
332 openlog(serverLogSyslogTag, LOG_PID, serverLogSyslogFacility);
336 /* Support named pipes as logs by not rotating them */
337 if ((lstat(fileName, &statbuf) == 0) && (S_ISFIFO(statbuf.st_mode))) {
342 if (mrafsStyleLogs) {
345 gettimeofday(&Start, NULL);
347 TimeFields = localtime(&t);
349 if (strncmp(fileName, (char *)&ourName, strlen(fileName)))
350 strcpy((char *)&ourName, (char *)fileName);
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,
358 if(lstat(FileName, &buf) == 0) {
359 /* avoid clobbering a log */
360 TimeFields->tm_sec++;
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);
367 strcpy(oldName, fileName);
368 strcat(oldName, ".old");
370 /* don't check error */
372 rk_rename(fileName, oldName);
373 tempfd = open(fileName, O_WRONLY | O_TRUNC | O_CREAT | O_APPEND | (isfifo?O_NONBLOCK:0), 0666);
377 printf("Unable to open log file %s\n", fileName);
380 /* redirect stdout and stderr so random printf's don't write to data */
381 if (freopen(fileName, "a", stdout) == NULL)
383 if (freopen(fileName, "a", stderr) != NULL) {
385 setvbuf(stderr, NULL, _IONBF, 0);
387 setbuf(stderr, NULL);
391 #if defined(AFS_PTHREAD_ENV)
392 opr_Verify(pthread_mutex_init(&serverLogMutex, NULL) == 0);
393 #endif /* AFS_PTHREAD_ENV */
395 serverLogFD = tempfd;
401 ReOpenLog(const char *fileName)
404 #if !defined(AFS_NT40_ENV)
408 if (access(fileName, F_OK) == 0)
409 return 0; /* exists, no need to reopen. */
411 #if !defined(AFS_NT40_ENV)
412 if (serverLogSyslog) {
416 /* Support named pipes as logs by not rotating them */
417 if ((lstat(fileName, &statbuf) == 0) && (S_ISFIFO(statbuf.st_mode))) {
423 if (serverLogFD >= 0)
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)
429 if (freopen(fileName, "a", stderr) != NULL) {
431 #ifdef SETVBUF_REVERSED
432 setvbuf(stderr, _IONBF, NULL, 0);
434 setvbuf(stderr, NULL, _IONBF, 0);
437 setbuf(stderr, NULL);
443 return serverLogFD < 0 ? -1 : 0;
447 * Close the server log file.
449 * \note Must be preceeded by OpenLog().
456 if (serverLogSyslog) {
460 if (serverLogFD >= 0) {