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