Don't overflow a buffer on the server's stack at startup
[openafs.git] / src / volser / volmain.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 #include <afsconfig.h>
11 #include <afs/param.h>
12
13
14 #include <sys/types.h>
15 #include <string.h>
16 #ifdef HAVE_STDINT_H
17 # include <stdint.h>
18 #endif
19 #ifdef AFS_NT40_ENV
20 #include <time.h>
21 #include <fcntl.h>
22 #include <windows.h>
23 #include <WINNT/afsevent.h>
24 #else
25 #include <sys/time.h>
26 #include <sys/file.h>
27 #include <netinet/in.h>
28 #include <unistd.h>
29 #endif
30 #include <rx/xdr.h>
31 #include <afs/afsint.h>
32 #include <stdio.h>
33 #include <signal.h>
34 #ifdef AFS_PTHREAD_ENV
35 #include <assert.h>
36 #else /* AFS_PTHREAD_ENV */
37 #include <afs/assert.h>
38 #endif /* AFS_PTHREAD_ENV */
39 #include <afs/prs_fs.h>
40 #include <afs/nfs.h>
41 #include <lwp.h>
42 #include <lock.h>
43 #include <afs/afssyscalls.h>
44 #include <afs/ihandle.h>
45 #ifdef AFS_NT40_ENV
46 #include <afs/ntops.h>
47 #endif
48 #include <afs/vnode.h>
49 #include <afs/volume.h>
50 #include <afs/partition.h>
51 #include <rx/rx.h>
52 #include <rx/rxstat.h>
53 #include <rx/rx_globals.h>
54 #include <afs/auth.h>
55 #include <afs/cellconfig.h>
56 #include <afs/keys.h>
57 #include <afs/dir.h>
58 #include <ubik.h>
59 #include <fcntl.h>
60 #include <sys/stat.h>
61
62 #include <errno.h>
63 #include <afs/audit.h>
64 #include <afs/afsutil.h>
65 #include <lwp.h>
66 #include "volser.h"
67 #include "volint.h"
68 #include "volser_internal.h"
69
70 /*@printflike@*/ extern void Log(const char *format, ...);
71 /*@printflike@*/ extern void Abort(const char *format, ...);
72
73 #define VolserVersion "2.0"
74 #define N_SECURITY_OBJECTS 3
75
76 extern struct Lock localLock;
77 char *GlobalNameHack = NULL;
78 int hackIsIn = 0;
79 afs_int32 GlobalVolCloneId, GlobalVolParentId;
80 int GlobalVolType;
81 int VolumeChanged;              /* XXXX */
82 static char busyFlags[MAXHELPERS];
83 struct volser_trans *QI_GlobalWriteTrans = 0;
84 struct afsconf_dir *tdir;
85 static afs_int32 runningCalls = 0;
86 int DoLogging = 0;
87 int debuglevel = 0; 
88 #define MAXLWP 128
89 int lwps = 9;
90 int udpBufSize = 0;             /* UDP buffer size for receive */
91
92 int rxBind = 0;
93 int rxkadDisableDotCheck = 0;
94
95 #define ADDRSPERSITE 16         /* Same global is in rx/rx_user.c */
96 afs_uint32 SHostAddrs[ADDRSPERSITE];
97
98 #define VS_EXIT(code)  {                                          \
99                           osi_audit(VS_ExitEvent, code, AUD_END); \
100                           exit(code);                             \
101                        }
102
103 #if defined(AFS_PTHREAD_ENV)
104 int
105 threadNum(void)
106 {
107     return (intptr_t)pthread_getspecific(rx_thread_id_key);
108 }
109 #endif
110
111 static void
112 MyBeforeProc(struct rx_call *acall)
113 {
114     VTRANS_LOCK;
115     runningCalls++;
116     VTRANS_UNLOCK;
117     return;
118 }
119
120 static void
121 MyAfterProc(struct rx_call *acall, afs_int32 code)
122 {
123     VTRANS_LOCK;
124     runningCalls--;
125     VTRANS_UNLOCK;
126     return;
127 }
128
129 /* Called every GCWAKEUP seconds to try to unlock all our partitions,
130  * if we're idle and there are no active transactions 
131  */
132 static void
133 TryUnlock(void)
134 {
135     /* if there are no running calls, and there are no active transactions, then
136      * it should be safe to release any partition locks we've accumulated */
137     VTRANS_LOCK;
138     if (runningCalls == 0 && TransList() == (struct volser_trans *)0) {
139         VTRANS_UNLOCK;
140         VPFullUnlock();         /* in volprocs.c */
141     } else
142         VTRANS_UNLOCK;
143 }
144
145 /* background daemon for timing out transactions */
146 static void*
147 BKGLoop(void *unused)
148 {
149     struct timeval tv;
150     int loop = 0;
151
152     while (1) {
153         tv.tv_sec = GCWAKEUP;
154         tv.tv_usec = 0;
155 #ifdef AFS_PTHREAD_ENV
156         select(0, 0, 0, 0, &tv);
157 #else
158         (void)IOMGR_Select(0, 0, 0, 0, &tv);
159 #endif
160         GCTrans();
161         TryUnlock();
162         loop++;
163         if (loop == 10) {       /* reopen log every 5 minutes */
164             loop = 0;
165             ReOpenLog(AFSDIR_SERVER_VOLSERLOG_FILEPATH);
166         }
167     }
168
169     return NULL;
170 }
171
172 /* Background daemon for sleeping so the volserver does not become I/O bound */
173 afs_int32 TTsleep, TTrun;
174 #ifndef AFS_PTHREAD_ENV
175 static void *
176 BKGSleep(void *unused)
177 {
178     struct volser_trans *tt;
179
180     if (TTsleep) {
181         while (1) {
182 #ifdef AFS_PTHREAD_ENV
183             sleep(TTrun);
184 #else /* AFS_PTHREAD_ENV */
185             IOMGR_Sleep(TTrun);
186 #endif
187             VTRANS_LOCK;
188             for (tt = TransList(); tt; tt = tt->next) {
189                 VTRANS_OBJ_LOCK(tt);
190                 if ((strcmp(tt->lastProcName, "DeleteVolume") == 0)
191                     || (strcmp(tt->lastProcName, "Clone") == 0)
192                     || (strcmp(tt->lastProcName, "ReClone") == 0)
193                     || (strcmp(tt->lastProcName, "Forward") == 0)
194                     || (strcmp(tt->lastProcName, "Restore") == 0)
195                     || (strcmp(tt->lastProcName, "ForwardMulti") == 0)) {
196                     VTRANS_OBJ_UNLOCK(tt);
197                     break;
198                 }
199                 VTRANS_OBJ_UNLOCK(tt);
200             }
201             if (tt) {
202                 VTRANS_UNLOCK;
203                 sleep(TTsleep);
204             } else
205                 VTRANS_UNLOCK;
206         }
207     }
208     return NULL;
209 }
210 #endif
211
212 #ifndef AFS_NT40_ENV
213 int
214 volser_syscall(afs_uint32 a3, afs_uint32 a4, void *a5)
215 {
216     afs_uint32 rcode;
217 #ifndef AFS_LINUX20_ENV
218     void (*old) (int);
219
220     old = signal(SIGSYS, SIG_IGN);
221 #endif
222     rcode =
223         syscall(AFS_SYSCALL /* AFS_SYSCALL */ , 28 /* AFSCALL_CALL */ , a3,
224                 a4, a5);
225 #ifndef AFS_LINUX20_ENV
226     signal(SIGSYS, old);
227 #endif
228
229     return rcode;
230 }
231 #endif
232
233
234 /* check whether caller is authorized to manage RX statistics */
235 int
236 vol_rxstat_userok(struct rx_call *call)
237 {
238     return afsconf_SuperUser(tdir, call, NULL);
239 }
240
241 #include "AFS_component_version_number.c"
242 int 
243 main(int argc, char **argv)
244 {
245     register afs_int32 code;
246     struct rx_securityClass **securityClasses;
247     afs_int32 numClasses;
248     struct rx_service *service;
249     struct ktc_encryptionKey tkey;
250     int rxpackets = 100;
251     int rxJumbograms = 0;       /* default is to send and receive jumbograms. */
252     int rxMaxMTU = -1;
253     int bufSize = 0;            /* temp variable to read in udp socket buf size */
254     afs_uint32 host = ntohl(INADDR_ANY);
255     char *auditFileName = NULL;
256     VolumePackageOptions opts;
257
258 #ifdef  AFS_AIX32_ENV
259     /*
260      * The following signal action for AIX is necessary so that in case of a 
261      * crash (i.e. core is generated) we can include the user's data section 
262      * in the core dump. Unfortunately, by default, only a partial core is
263      * generated which, in many cases, isn't too useful.
264      */
265     struct sigaction nsa;
266
267     sigemptyset(&nsa.sa_mask);
268     nsa.sa_handler = SIG_DFL;
269     nsa.sa_flags = SA_FULLDUMP;
270     sigaction(SIGABRT, &nsa, NULL);
271     sigaction(SIGSEGV, &nsa, NULL);
272 #endif
273     osi_audit_init();
274     osi_audit(VS_StartEvent, 0, AUD_END);
275
276     /* Initialize dirpaths */
277     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
278 #ifdef AFS_NT40_ENV
279         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
280 #endif
281         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
282                 argv[0]);
283         exit(2);
284     }
285
286     TTsleep = TTrun = 0;
287
288     /* parse cmd line */
289     for (code = 1; code < argc; code++) {
290         if (strcmp(argv[code], "-log") == 0) {
291             /* set extra logging flag */
292             DoLogging = 1;
293         } else if (strcmp(argv[code], "-help") == 0) {
294             goto usage;
295         } else if (strcmp(argv[code], "-rxbind") == 0) {
296             rxBind = 1;
297         } else if (strcmp(argv[code], "-allow-dotted-principals") == 0) {
298             rxkadDisableDotCheck = 1;
299         } else if (strcmp(argv[code], "-d") == 0) {
300             if ((code + 1) >= argc) {
301                 fprintf(stderr, "missing argument for -d\n"); 
302                 return -1; 
303             }
304             debuglevel = atoi(argv[++code]);
305             LogLevel = debuglevel;
306         } else if (strcmp(argv[code], "-p") == 0) {
307             lwps = atoi(argv[++code]);
308             if (lwps > MAXLWP) {
309                 printf("Warning: '-p %d' is too big; using %d instead\n",
310                        lwps, MAXLWP);
311                 lwps = MAXLWP;
312             }
313         } else if (strcmp(argv[code], "-auditlog") == 0) {
314             auditFileName = argv[++code];
315
316         } else if (strcmp(argv[code], "-audit-interface") == 0) {
317             char *interface = argv[++code];
318
319             if (osi_audit_interface(interface)) {
320                 printf("Invalid audit interface '%s'\n", interface);
321                 return -1;
322             }
323         } else if (strcmp(argv[code], "-nojumbo") == 0) {
324             rxJumbograms = 0;
325         } else if (strcmp(argv[code], "-jumbo") == 0) {
326             rxJumbograms = 1;
327         } else if (!strcmp(argv[code], "-rxmaxmtu")) {
328             if ((code + 1) >= argc) {
329                 fprintf(stderr, "missing argument for -rxmaxmtu\n"); 
330                 exit(1); 
331             }
332             rxMaxMTU = atoi(argv[++code]);
333             if ((rxMaxMTU < RX_MIN_PACKET_SIZE) || 
334                 (rxMaxMTU > RX_MAX_PACKET_DATA_SIZE)) {
335                 printf("rxMaxMTU %d invalid; must be between %d-%" AFS_SIZET_FMT "\n",
336                        rxMaxMTU, RX_MIN_PACKET_SIZE, 
337                        RX_MAX_PACKET_DATA_SIZE);
338                 exit(1);
339             }
340         } else if (strcmp(argv[code], "-sleep") == 0) {
341             sscanf(argv[++code], "%d/%d", &TTsleep, &TTrun);
342             if ((TTsleep < 0) || (TTrun <= 0)) {
343                 printf("Warning: '-sleep %d/%d' is incorrect; ignoring\n",
344                        TTsleep, TTrun);
345                 TTsleep = TTrun = 0;
346             }
347         } else if (strcmp(argv[code], "-udpsize") == 0) {
348             if ((code + 1) >= argc) {
349                 printf("You have to specify -udpsize <integer value>\n");
350                 exit(1);
351             }
352             sscanf(argv[++code], "%d", &bufSize);
353             if (bufSize < rx_GetMinUdpBufSize())
354                 printf
355                     ("Warning:udpsize %d is less than minimum %d; ignoring\n",
356                      bufSize, rx_GetMinUdpBufSize());
357             else
358                 udpBufSize = bufSize;
359         } else if (strcmp(argv[code], "-enable_peer_stats") == 0) {
360             rx_enablePeerRPCStats();
361         } else if (strcmp(argv[code], "-enable_process_stats") == 0) {
362             rx_enableProcessRPCStats();
363         }
364 #ifndef AFS_NT40_ENV
365         else if (strcmp(argv[code], "-syslog") == 0) {
366             /* set syslog logging flag */
367             serverLogSyslog = 1;
368         } else if (strncmp(argv[code], "-syslog=", 8) == 0) {
369             serverLogSyslog = 1;
370             serverLogSyslogFacility = atoi(argv[code] + 8);
371         }
372 #endif
373         else {
374             printf("volserver: unrecognized flag '%s'\n", argv[code]);
375           usage:
376 #ifndef AFS_NT40_ENV
377             printf("Usage: volserver [-log] [-p <number of processes>] "
378                    "[-auditlog <log path>] [-d <debug level>] "
379                    "[-nojumbo] [-jumbo] [-rxmaxmtu <bytes>] [-rxbind] [-allow-dotted-principals] "
380                    "[-udpsize <size of socket buffer in bytes>] "
381                    "[-syslog[=FACILITY]] "
382                    "[-enable_peer_stats] [-enable_process_stats] "
383                    "[-help]\n");
384 #else
385             printf("Usage: volserver [-log] [-p <number of processes>] "
386                    "[-auditlog <log path>] [-d <debug level>] "
387                    "[-nojumbo] [-jumbo] [-rxmaxmtu <bytes>] [-rxbind] [-allow-dotted-principals] "
388                    "[-udpsize <size of socket buffer in bytes>] "
389                    "[-enable_peer_stats] [-enable_process_stats] "
390                    "[-help]\n");
391 #endif
392             VS_EXIT(1);
393         }
394     }
395
396     if (auditFileName) {
397         osi_audit_file(auditFileName);
398         osi_audit(VS_StartEvent, 0, AUD_END);
399     }
400 #ifdef AFS_SGI_VNODE_GLUE
401     if (afs_init_kernel_config(-1) < 0) {
402         printf
403             ("Can't determine NUMA configuration, not starting volserver.\n");
404         exit(1);
405     }
406 #endif
407     InitErrTabs();
408
409 #ifdef AFS_PTHREAD_ENV
410     SetLogThreadNumProgram( threadNum );
411 #endif
412
413 #ifdef AFS_NT40_ENV
414     if (afs_winsockInit() < 0) {
415         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
416         printf("Volume server unable to start winsock, exiting.\n");
417         exit(1);
418     }
419 #endif
420     /* Open VolserLog and map stdout, stderr into it; VInitVolumePackage2 can
421        log, so we need to do this here */
422     OpenLog(AFSDIR_SERVER_VOLSERLOG_FILEPATH);
423
424     VOptDefaults(volumeServer, &opts);
425     if (VInitVolumePackage2(volumeServer, &opts)) {
426         Log("Shutting down: errors encountered initializing volume package\n");
427         exit(1);
428     }
429     /* For nuke() */
430     Lock_Init(&localLock);
431     DInit(40);
432 #ifndef AFS_PTHREAD_ENV
433     vol_PollProc = IOMGR_Poll;  /* tell vol pkg to poll io system periodically */
434 #endif
435 #ifndef AFS_NT40_ENV
436     rxi_syscallp = volser_syscall;
437 #endif
438     rx_nPackets = rxpackets;    /* set the max number of packets */
439     if (udpBufSize)
440         rx_SetUdpBufSize(udpBufSize);   /* set the UDP buffer size for receive */
441     if (rxBind) {
442         afs_int32 ccode;
443         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH || 
444             AFSDIR_SERVER_NETINFO_FILEPATH) {
445             char reason[1024];
446             ccode = parseNetFiles(SHostAddrs, NULL, NULL,
447                                            ADDRSPERSITE, reason,
448                                            AFSDIR_SERVER_NETINFO_FILEPATH,
449                                            AFSDIR_SERVER_NETRESTRICT_FILEPATH);
450         } else 
451         {
452             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
453         }
454         if (ccode == 1) 
455             host = SHostAddrs[0];
456     }
457
458     code = rx_InitHost(host, (int)htons(AFSCONF_VOLUMEPORT));
459     if (code) {
460         fprintf(stderr, "rx init failed on socket AFSCONF_VOLUMEPORT %u\n",
461                 AFSCONF_VOLUMEPORT);
462         VS_EXIT(1);
463     }
464     if (!rxJumbograms) {
465         /* Don't allow 3.4 vos clients to send jumbograms and we don't send. */
466         rx_SetNoJumbo();
467     }
468     if (rxMaxMTU != -1) {
469         rx_SetMaxMTU(rxMaxMTU);
470     }
471     rx_GetIFInfo();
472     rx_SetRxDeadTime(420);
473     memset(busyFlags, 0, sizeof(busyFlags));
474
475     SetupLogSignals();
476
477     {
478 #ifdef AFS_PTHREAD_ENV
479         pthread_t tid;
480         pthread_attr_t tattr;
481         assert(pthread_attr_init(&tattr) == 0);
482         assert(pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED) == 0);
483
484         assert(pthread_create(&tid, &tattr, BKGLoop, NULL) == 0);
485 #else
486         PROCESS pid;
487         LWP_CreateProcess(BKGLoop, 16*1024, 3, 0, "vol bkg daemon", &pid);
488         LWP_CreateProcess(BKGSleep,16*1024, 3, 0, "vol slp daemon", &pid);
489 #endif
490     }
491
492     /* Create a single security object, in this case the null security object, for unauthenticated connections, which will be used to control security on connections made to this server */
493
494     tdir = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH);
495     if (!tdir) {
496         Abort("volser: could not open conf files in %s\n",
497               AFSDIR_SERVER_ETC_DIRPATH);
498         VS_EXIT(1);
499     }
500     afsconf_GetKey(tdir, 999, &tkey);
501     afsconf_BuildServerSecurityObjects(tdir, 0, &securityClasses, &numClasses);
502     if (securityClasses[0] == NULL)
503         Abort("rxnull_NewServerSecurityObject");
504     service =
505         rx_NewServiceHost(host, 0, VOLSERVICE_ID, "VOLSER", securityClasses,
506                           numClasses, AFSVolExecuteRequest);
507     if (service == (struct rx_service *)0)
508         Abort("rx_NewService");
509     rx_SetBeforeProc(service, MyBeforeProc);
510     rx_SetAfterProc(service, MyAfterProc);
511     rx_SetIdleDeadTime(service, 0);     /* never timeout */
512     if (lwps < 4)
513         lwps = 4;
514     rx_SetMaxProcs(service, lwps);
515 #if defined(AFS_XBSD_ENV)
516     rx_SetStackSize(service, (128 * 1024));
517 #elif defined(AFS_SGI_ENV)
518     rx_SetStackSize(service, (48 * 1024));
519 #else
520     rx_SetStackSize(service, (32 * 1024));
521 #endif
522
523     if (rxkadDisableDotCheck) {
524         rx_SetSecurityConfiguration(service, RXS_CONFIG_FLAGS,
525                                     (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
526     }
527
528     service =
529         rx_NewService(0, RX_STATS_SERVICE_ID, "rpcstats", securityClasses,
530                       numClasses, RXSTATS_ExecuteRequest);
531     if (service == (struct rx_service *)0)
532         Abort("rx_NewService");
533     rx_SetMinProcs(service, 2);
534     rx_SetMaxProcs(service, 4);
535
536     LogCommandLine(argc, argv, "Volserver", VolserVersion, "Starting AFS",
537                    Log);
538     if (TTsleep) {
539         Log("Will sleep %d second%s every %d second%s\n", TTsleep,
540             (TTsleep > 1) ? "s" : "", TTrun + TTsleep,
541             (TTrun + TTsleep > 1) ? "s" : "");
542     }
543
544     /* allow super users to manage RX statistics */
545     rx_SetRxStatUserOk(vol_rxstat_userok);
546
547     rx_StartServer(1);          /* Donate this process to the server process pool */
548
549     osi_audit(VS_FinishEvent, (-1), AUD_END);
550     Abort("StartServer returned?");
551     return 0; /* not reached */
552 }