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