Common interface for server security objects
[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 AFS_NT40_ENV
17 #include <time.h>
18 #include <fcntl.h>
19 #include <windows.h>
20 #include <WINNT/afsevent.h>
21 #else
22 #include <sys/time.h>
23 #include <sys/file.h>
24 #include <netinet/in.h>
25 #include <unistd.h>
26 #endif
27 #include <rx/xdr.h>
28 #include <afs/afsint.h>
29 #include <stdio.h>
30 #include <signal.h>
31 #ifdef AFS_PTHREAD_ENV
32 #include <assert.h>
33 #else /* AFS_PTHREAD_ENV */
34 #include <afs/assert.h>
35 #endif /* AFS_PTHREAD_ENV */
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         select(0, 0, 0, 0, &tv);
154 #else
155         (void)IOMGR_Select(0, 0, 0, 0, &tv);
156 #endif
157         GCTrans();
158         TryUnlock();
159         loop++;
160         if (loop == 10) {       /* reopen log every 5 minutes */
161             loop = 0;
162             ReOpenLog(AFSDIR_SERVER_VOLSERLOG_FILEPATH);
163         }
164     }
165
166     return NULL;
167 }
168
169 /* Background daemon for sleeping so the volserver does not become I/O bound */
170 afs_int32 TTsleep, TTrun;
171 #ifndef AFS_PTHREAD_ENV
172 static void *
173 BKGSleep(void *unused)
174 {
175     struct volser_trans *tt;
176
177     if (TTsleep) {
178         while (1) {
179 #ifdef AFS_PTHREAD_ENV
180             sleep(TTrun);
181 #else /* AFS_PTHREAD_ENV */
182             IOMGR_Sleep(TTrun);
183 #endif
184             VTRANS_LOCK;
185             for (tt = TransList(); tt; tt = tt->next) {
186                 VTRANS_OBJ_LOCK(tt);
187                 if ((strcmp(tt->lastProcName, "DeleteVolume") == 0)
188                     || (strcmp(tt->lastProcName, "Clone") == 0)
189                     || (strcmp(tt->lastProcName, "ReClone") == 0)
190                     || (strcmp(tt->lastProcName, "Forward") == 0)
191                     || (strcmp(tt->lastProcName, "Restore") == 0)
192                     || (strcmp(tt->lastProcName, "ForwardMulti") == 0)) {
193                     VTRANS_OBJ_UNLOCK(tt);
194                     break;
195                 }
196                 VTRANS_OBJ_UNLOCK(tt);
197             }
198             if (tt) {
199                 VTRANS_UNLOCK;
200                 sleep(TTsleep);
201             } else
202                 VTRANS_UNLOCK;
203         }
204     }
205     return NULL;
206 }
207 #endif
208
209 #ifndef AFS_NT40_ENV
210 int
211 volser_syscall(afs_uint32 a3, afs_uint32 a4, void *a5)
212 {
213     afs_uint32 rcode;
214 #ifndef AFS_LINUX20_ENV
215     void (*old) (int);
216
217     old = signal(SIGSYS, SIG_IGN);
218 #endif
219     rcode =
220         syscall(AFS_SYSCALL /* AFS_SYSCALL */ , 28 /* AFSCALL_CALL */ , a3,
221                 a4, a5);
222 #ifndef AFS_LINUX20_ENV
223     signal(SIGSYS, old);
224 #endif
225
226     return rcode;
227 }
228 #endif
229
230
231 /* check whether caller is authorized to manage RX statistics */
232 int
233 vol_rxstat_userok(struct rx_call *call)
234 {
235     return afsconf_SuperUser(tdir, call, NULL);
236 }
237
238 #include "AFS_component_version_number.c"
239 int 
240 main(int argc, char **argv)
241 {
242     register afs_int32 code;
243     struct rx_securityClass **securityClasses;
244     afs_int32 numClasses;
245     struct rx_service *service;
246     struct ktc_encryptionKey tkey;
247     int rxpackets = 100;
248     char commandLine[150];
249     int i;
250     int rxJumbograms = 0;       /* default is to send and receive jumbograms. */
251     int rxMaxMTU = -1;
252     int bufSize = 0;            /* temp variable to read in udp socket buf size */
253     afs_uint32 host = ntohl(INADDR_ANY);
254     char *auditFileName = NULL;
255     VolumePackageOptions opts;
256
257 #ifdef  AFS_AIX32_ENV
258     /*
259      * The following signal action for AIX is necessary so that in case of a 
260      * crash (i.e. core is generated) we can include the user's data section 
261      * in the core dump. Unfortunately, by default, only a partial core is
262      * generated which, in many cases, isn't too useful.
263      */
264     struct sigaction nsa;
265
266     sigemptyset(&nsa.sa_mask);
267     nsa.sa_handler = SIG_DFL;
268     nsa.sa_flags = SA_FULLDUMP;
269     sigaction(SIGABRT, &nsa, NULL);
270     sigaction(SIGSEGV, &nsa, NULL);
271 #endif
272     osi_audit_init();
273     osi_audit(VS_StartEvent, 0, AUD_END);
274
275     /* Initialize dirpaths */
276     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
277 #ifdef AFS_NT40_ENV
278         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
279 #endif
280         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
281                 argv[0]);
282         exit(2);
283     }
284
285     for (commandLine[0] = '\0', i = 0; i < argc; i++) {
286         if (i > 0)
287             strcat(commandLine, " ");
288         strcat(commandLine, argv[i]);
289     }
290
291     TTsleep = TTrun = 0;
292
293     /* parse cmd line */
294     for (code = 1; code < argc; code++) {
295         if (strcmp(argv[code], "-log") == 0) {
296             /* set extra logging flag */
297             DoLogging = 1;
298         } else if (strcmp(argv[code], "-help") == 0) {
299             goto usage;
300         } else if (strcmp(argv[code], "-rxbind") == 0) {
301             rxBind = 1;
302         } else if (strcmp(argv[code], "-allow-dotted-principals") == 0) {
303             rxkadDisableDotCheck = 1;
304         } else if (strcmp(argv[code], "-d") == 0) {
305             if ((code + 1) >= argc) {
306                 fprintf(stderr, "missing argument for -d\n"); 
307                 return -1; 
308             }
309             debuglevel = atoi(argv[++code]);
310             LogLevel = debuglevel;
311         } else if (strcmp(argv[code], "-p") == 0) {
312             lwps = atoi(argv[++code]);
313             if (lwps > MAXLWP) {
314                 printf("Warning: '-p %d' is too big; using %d instead\n",
315                        lwps, MAXLWP);
316                 lwps = MAXLWP;
317             }
318         } else if (strcmp(argv[code], "-auditlog") == 0) {
319             auditFileName = argv[++code];
320
321         } else if (strcmp(argv[code], "-audit-interface") == 0) {
322             char *interface = argv[++code];
323
324             if (osi_audit_interface(interface)) {
325                 printf("Invalid audit interface '%s'\n", interface);
326                 return -1;
327             }
328         } else if (strcmp(argv[code], "-nojumbo") == 0) {
329             rxJumbograms = 0;
330         } else if (strcmp(argv[code], "-jumbo") == 0) {
331             rxJumbograms = 1;
332         } else if (!strcmp(argv[code], "-rxmaxmtu")) {
333             if ((code + 1) >= argc) {
334                 fprintf(stderr, "missing argument for -rxmaxmtu\n"); 
335                 exit(1); 
336             }
337             rxMaxMTU = atoi(argv[++code]);
338             if ((rxMaxMTU < RX_MIN_PACKET_SIZE) || 
339                 (rxMaxMTU > RX_MAX_PACKET_DATA_SIZE)) {
340                 printf("rxMaxMTU %d invalid; must be between %d-%" AFS_SIZET_FMT "\n",
341                        rxMaxMTU, RX_MIN_PACKET_SIZE, 
342                        RX_MAX_PACKET_DATA_SIZE);
343                 exit(1);
344             }
345         } else if (strcmp(argv[code], "-sleep") == 0) {
346             sscanf(argv[++code], "%d/%d", &TTsleep, &TTrun);
347             if ((TTsleep < 0) || (TTrun <= 0)) {
348                 printf("Warning: '-sleep %d/%d' is incorrect; ignoring\n",
349                        TTsleep, TTrun);
350                 TTsleep = TTrun = 0;
351             }
352         } else if (strcmp(argv[code], "-udpsize") == 0) {
353             if ((code + 1) >= argc) {
354                 printf("You have to specify -udpsize <integer value>\n");
355                 exit(1);
356             }
357             sscanf(argv[++code], "%d", &bufSize);
358             if (bufSize < rx_GetMinUdpBufSize())
359                 printf
360                     ("Warning:udpsize %d is less than minimum %d; ignoring\n",
361                      bufSize, rx_GetMinUdpBufSize());
362             else
363                 udpBufSize = bufSize;
364         } else if (strcmp(argv[code], "-enable_peer_stats") == 0) {
365             rx_enablePeerRPCStats();
366         } else if (strcmp(argv[code], "-enable_process_stats") == 0) {
367             rx_enableProcessRPCStats();
368         }
369 #ifndef AFS_NT40_ENV
370         else if (strcmp(argv[code], "-syslog") == 0) {
371             /* set syslog logging flag */
372             serverLogSyslog = 1;
373         } else if (strncmp(argv[code], "-syslog=", 8) == 0) {
374             serverLogSyslog = 1;
375             serverLogSyslogFacility = atoi(argv[code] + 8);
376         }
377 #endif
378         else {
379             printf("volserver: unrecognized flag '%s'\n", argv[code]);
380           usage:
381 #ifndef AFS_NT40_ENV
382             printf("Usage: volserver [-log] [-p <number of processes>] "
383                    "[-auditlog <log path>] [-d <debug level>] "
384                    "[-nojumbo] [-jumbo] [-rxmaxmtu <bytes>] [-rxbind] [-allow-dotted-principals] "
385                    "[-udpsize <size of socket buffer in bytes>] "
386                    "[-syslog[=FACILITY]] "
387                    "[-enable_peer_stats] [-enable_process_stats] "
388                    "[-help]\n");
389 #else
390             printf("Usage: volserver [-log] [-p <number of processes>] "
391                    "[-auditlog <log path>] [-d <debug level>] "
392                    "[-nojumbo] [-jumbo] [-rxmaxmtu <bytes>] [-rxbind] [-allow-dotted-principals] "
393                    "[-udpsize <size of socket buffer in bytes>] "
394                    "[-enable_peer_stats] [-enable_process_stats] "
395                    "[-help]\n");
396 #endif
397             VS_EXIT(1);
398         }
399     }
400
401     if (auditFileName) {
402         osi_audit_file(auditFileName);
403         osi_audit(VS_StartEvent, 0, AUD_END);
404     }
405 #ifdef AFS_SGI_VNODE_GLUE
406     if (afs_init_kernel_config(-1) < 0) {
407         printf
408             ("Can't determine NUMA configuration, not starting volserver.\n");
409         exit(1);
410     }
411 #endif
412     InitErrTabs();
413
414 #ifdef AFS_PTHREAD_ENV
415     SetLogThreadNumProgram( threadNum );
416 #endif
417
418 #ifdef AFS_NT40_ENV
419     if (afs_winsockInit() < 0) {
420         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
421         printf("Volume server unable to start winsock, exiting.\n");
422         exit(1);
423     }
424 #endif
425     /* Open VolserLog and map stdout, stderr into it; VInitVolumePackage2 can
426        log, so we need to do this here */
427     OpenLog(AFSDIR_SERVER_VOLSERLOG_FILEPATH);
428
429     VOptDefaults(volumeServer, &opts);
430     if (VInitVolumePackage2(volumeServer, &opts)) {
431         Log("Shutting down: errors encountered initializing volume package\n");
432         exit(1);
433     }
434     /* For nuke() */
435     Lock_Init(&localLock);
436     DInit(40);
437 #ifndef AFS_PTHREAD_ENV
438     vol_PollProc = IOMGR_Poll;  /* tell vol pkg to poll io system periodically */
439 #endif
440 #ifndef AFS_NT40_ENV
441     rxi_syscallp = volser_syscall;
442 #endif
443     rx_nPackets = rxpackets;    /* set the max number of packets */
444     if (udpBufSize)
445         rx_SetUdpBufSize(udpBufSize);   /* set the UDP buffer size for receive */
446     if (rxBind) {
447         afs_int32 ccode;
448         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH || 
449             AFSDIR_SERVER_NETINFO_FILEPATH) {
450             char reason[1024];
451             ccode = parseNetFiles(SHostAddrs, NULL, NULL,
452                                            ADDRSPERSITE, reason,
453                                            AFSDIR_SERVER_NETINFO_FILEPATH,
454                                            AFSDIR_SERVER_NETRESTRICT_FILEPATH);
455         } else 
456         {
457             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
458         }
459         if (ccode == 1) 
460             host = SHostAddrs[0];
461     }
462
463     code = rx_InitHost(host, (int)htons(AFSCONF_VOLUMEPORT));
464     if (code) {
465         fprintf(stderr, "rx init failed on socket AFSCONF_VOLUMEPORT %u\n",
466                 AFSCONF_VOLUMEPORT);
467         VS_EXIT(1);
468     }
469     if (!rxJumbograms) {
470         /* Don't allow 3.4 vos clients to send jumbograms and we don't send. */
471         rx_SetNoJumbo();
472     }
473     if (rxMaxMTU != -1) {
474         rx_SetMaxMTU(rxMaxMTU);
475     }
476     rx_GetIFInfo();
477     rx_SetRxDeadTime(420);
478     memset(busyFlags, 0, sizeof(busyFlags));
479
480     SetupLogSignals();
481
482     {
483 #ifdef AFS_PTHREAD_ENV
484         pthread_t tid;
485         pthread_attr_t tattr;
486         assert(pthread_attr_init(&tattr) == 0);
487         assert(pthread_attr_setdetachstate(&tattr, PTHREAD_CREATE_DETACHED) == 0);
488
489         assert(pthread_create(&tid, &tattr, BKGLoop, NULL) == 0);
490 #else
491         PROCESS pid;
492         LWP_CreateProcess(BKGLoop, 16*1024, 3, 0, "vol bkg daemon", &pid);
493         LWP_CreateProcess(BKGSleep,16*1024, 3, 0, "vol slp daemon", &pid);
494 #endif
495     }
496
497     /* 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 */
498
499     tdir = afsconf_Open(AFSDIR_SERVER_ETC_DIRPATH);
500     if (!tdir) {
501         Abort("volser: could not open conf files in %s\n",
502               AFSDIR_SERVER_ETC_DIRPATH);
503         VS_EXIT(1);
504     }
505     afsconf_GetKey(tdir, 999, &tkey);
506     afsconf_BuildServerSecurityObjects(tdir, 0, &securityClasses, &numClasses);
507     if (securityClasses[0] == NULL)
508         Abort("rxnull_NewServerSecurityObject");
509     service =
510         rx_NewServiceHost(host, 0, VOLSERVICE_ID, "VOLSER", securityClasses,
511                           numClasses, AFSVolExecuteRequest);
512     if (service == (struct rx_service *)0)
513         Abort("rx_NewService");
514     rx_SetBeforeProc(service, MyBeforeProc);
515     rx_SetAfterProc(service, MyAfterProc);
516     rx_SetIdleDeadTime(service, 0);     /* never timeout */
517     if (lwps < 4)
518         lwps = 4;
519     rx_SetMaxProcs(service, lwps);
520 #if defined(AFS_XBSD_ENV)
521     rx_SetStackSize(service, (128 * 1024));
522 #elif defined(AFS_SGI_ENV)
523     rx_SetStackSize(service, (48 * 1024));
524 #else
525     rx_SetStackSize(service, (32 * 1024));
526 #endif
527
528     if (rxkadDisableDotCheck) {
529         rx_SetSecurityConfiguration(service, RXS_CONFIG_FLAGS,
530                                     (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
531     }
532
533     service =
534         rx_NewService(0, RX_STATS_SERVICE_ID, "rpcstats", securityClasses,
535                       numClasses, RXSTATS_ExecuteRequest);
536     if (service == (struct rx_service *)0)
537         Abort("rx_NewService");
538     rx_SetMinProcs(service, 2);
539     rx_SetMaxProcs(service, 4);
540
541     Log("Starting AFS Volserver %s (%s)\n", VolserVersion, commandLine);
542     if (TTsleep) {
543         Log("Will sleep %d second%s every %d second%s\n", TTsleep,
544             (TTsleep > 1) ? "s" : "", TTrun + TTsleep,
545             (TTrun + TTsleep > 1) ? "s" : "");
546     }
547
548     /* allow super users to manage RX statistics */
549     rx_SetRxStatUserOk(vol_rxstat_userok);
550
551     rx_StartServer(1);          /* Donate this process to the server process pool */
552
553     osi_audit(VS_FinishEvent, (-1), AUD_END);
554     Abort("StartServer returned?");
555     return 0; /* not reached */
556 }