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