9137deb731fab06a7c3e6f87f129c261b78bb821
[openafs.git] / src / vlserver / vlserver.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 #include <afs/stds.h>
13
14 #include <roken.h>
15 #ifdef AFS_PTHREAD_ENV
16 # include <opr/softsig.h>
17 # include <afs/procmgmt_softsig.h> /* must come after softsig.h */
18 #endif
19
20 #ifdef AFS_NT40_ENV
21 #include <WINNT/afsevent.h>
22 #endif
23
24 #ifdef HAVE_SYS_FILE_H
25 #include <sys/file.h>
26 #endif
27
28 #include <rx/xdr.h>
29 #include <rx/rx.h>
30 #include <rx/rx_globals.h>
31 #include <rx/rxstat.h>
32 #include <afs/cmd.h>
33 #include <afs/cellconfig.h>
34 #include <afs/keys.h>
35 #include <afs/auth.h>
36 #include <afs/audit.h>
37 #include <afs/com_err.h>
38 #include <lock.h>
39 #include <ubik.h>
40 #include <afs/afsutil.h>
41
42 #include "vlserver.h"
43 #include "vlserver_internal.h"
44
45 #define MAXLWP 64
46 struct afsconf_dir *vldb_confdir = 0;   /* vldb configuration dir */
47 int lwps = 9;
48
49 struct vldstats dynamic_statistics;
50 struct ubik_dbase *VL_dbase;
51 afs_uint32 rd_HostAddress[MAXSERVERID + 1];
52 afs_uint32 wr_HostAddress[MAXSERVERID + 1];
53
54 static void *CheckSignal(void*);
55 int smallMem = 0;
56 int restrictedQueryLevel = RESTRICTED_QUERY_ANYUSER;
57 int rxJumbograms = 0;           /* default is to not send and receive jumbo grams */
58 int rxMaxMTU = -1;
59 afs_int32 rxBind = 0;
60 int rxkadDisableDotCheck = 0;
61
62 #define ADDRSPERSITE 16         /* Same global is in rx/rx_user.c */
63 afs_uint32 SHostAddrs[ADDRSPERSITE];
64
65 static void
66 CheckSignal_Signal(int unused)
67 {
68 #if defined(AFS_PTHREAD_ENV)
69     CheckSignal(0);
70 #else
71     IOMGR_SoftSig(CheckSignal, 0);
72 #endif
73 }
74
75 static void *
76 CheckSignal(void *unused)
77 {
78     int i, errorcode;
79     struct vl_ctx ctx;
80
81     if ((errorcode =
82         Init_VLdbase(&ctx, LOCKREAD, VLGETSTATS - VL_LOWEST_OPCODE)))
83         return (void *)(intptr_t)errorcode;
84     VLog(0, ("Dump name hash table out\n"));
85     for (i = 0; i < HASHSIZE; i++) {
86         HashNDump(&ctx, i);
87     }
88     VLog(0, ("Dump id hash table out\n"));
89     for (i = 0; i < HASHSIZE; i++) {
90         HashIdDump(&ctx, i);
91     }
92     return ((void *)(intptr_t)ubik_EndTrans(ctx.trans));
93 }                               /*CheckSignal */
94
95
96 /* Initialize the stats for the opcodes */
97 void
98 initialize_dstats(void)
99 {
100     int i;
101
102     dynamic_statistics.start_time = (afs_uint32) time(0);
103     for (i = 0; i < MAX_NUMBER_OPCODES; i++) {
104         dynamic_statistics.requests[i] = 0;
105         dynamic_statistics.aborts[i] = 0;
106     }
107 }
108
109 /* check whether caller is authorized to manage RX statistics */
110 int
111 vldb_rxstat_userok(struct rx_call *call)
112 {
113     return afsconf_SuperUser(vldb_confdir, call, NULL);
114 }
115
116 /**
117  * Return true if this name is a member of the local realm.
118  */
119 int
120 vldb_IsLocalRealmMatch(void *rock, char *name, char *inst, char *cell)
121 {
122     struct afsconf_dir *dir = (struct afsconf_dir *)rock;
123     afs_int32 islocal = 0;      /* default to no */
124     int code;
125
126     code = afsconf_IsLocalRealmMatch(dir, &islocal, name, inst, cell);
127     if (code) {
128         VLog(0,
129                 ("Failed local realm check; code=%d, name=%s, inst=%s, cell=%s\n",
130                  code, name, inst, cell));
131     }
132     return islocal;
133 }
134
135 /* Main server module */
136
137 #include "AFS_component_version_number.c"
138
139 enum optionsList {
140     OPT_noauth,
141     OPT_smallmem,
142     OPT_auditlog,
143     OPT_auditiface,
144     OPT_config,
145     OPT_debug,
146     OPT_database,
147     OPT_logfile,
148     OPT_threads,
149 #ifdef HAVE_SYSLOG
150     OPT_syslog,
151 #endif
152     OPT_peer,
153     OPT_process,
154     OPT_nojumbo,
155     OPT_jumbo,
156     OPT_rxbind,
157     OPT_rxmaxmtu,
158     OPT_trace,
159     OPT_dotted,
160     OPT_restricted_query
161 };
162
163 int
164 main(int argc, char **argv)
165 {
166     afs_int32 code;
167     afs_uint32 myHost;
168     struct rx_service *tservice;
169     struct rx_securityClass **securityClasses;
170     afs_int32 numClasses;
171     struct afsconf_dir *tdir;
172     struct ktc_encryptionKey tkey;
173     struct afsconf_cell info;
174     struct hostent *th;
175     char hostname[VL_MAXNAMELEN];
176     int noAuth = 0;
177     char clones[MAXHOSTSPERCELL];
178     afs_uint32 host = ntohl(INADDR_ANY);
179     struct cmd_syndesc *opts;
180     struct logOptions logopts;
181
182     char *vl_dbaseName;
183     char *configDir;
184
185     char *auditFileName = NULL;
186     char *interface = NULL;
187     char *optstring = NULL;
188
189     char *restricted_query_parameter = NULL;
190
191 #ifdef  AFS_AIX32_ENV
192     /*
193      * The following signal action for AIX is necessary so that in case of a
194      * crash (i.e. core is generated) we can include the user's data section
195      * in the core dump. Unfortunately, by default, only a partial core is
196      * generated which, in many cases, isn't too useful.
197      */
198     struct sigaction nsa;
199
200     rx_extraPackets = 100;      /* should be a switch, I guess... */
201     sigemptyset(&nsa.sa_mask);
202     nsa.sa_handler = SIG_DFL;
203     nsa.sa_flags = SA_FULLDUMP;
204     sigaction(SIGABRT, &nsa, NULL);
205     sigaction(SIGSEGV, &nsa, NULL);
206 #endif
207     osi_audit_init();
208
209     memset(&logopts, 0, sizeof(logopts));
210
211     /* Initialize dirpaths */
212     if (!(initAFSDirPath() & AFSDIR_SERVER_PATHS_OK)) {
213 #ifdef AFS_NT40_ENV
214         ReportErrorEventAlt(AFSEVT_SVR_NO_INSTALL_DIR, 0, argv[0], 0);
215 #endif
216         fprintf(stderr, "%s: Unable to obtain AFS server directory.\n",
217                 argv[0]);
218         exit(2);
219     }
220
221     vl_dbaseName = strdup(AFSDIR_SERVER_VLDB_FILEPATH);
222     configDir = strdup(AFSDIR_SERVER_ETC_DIRPATH);
223
224     cmd_DisableAbbreviations();
225     cmd_DisablePositionalCommands();
226     opts = cmd_CreateSyntax(NULL, NULL, NULL, 0, NULL);
227
228     /* vlserver specific options */
229     cmd_AddParmAtOffset(opts, OPT_noauth, "-noauth", CMD_FLAG,
230                         CMD_OPTIONAL, "disable authentication");
231     cmd_AddParmAtOffset(opts, OPT_smallmem, "-smallmem", CMD_FLAG,
232                         CMD_OPTIONAL, "optimise for small memory systems");
233
234     /* general server options */
235     cmd_AddParmAtOffset(opts, OPT_auditlog, "-auditlog", CMD_SINGLE,
236                         CMD_OPTIONAL, "location of audit log");
237     cmd_AddParmAtOffset(opts, OPT_auditiface, "-audit-interface", CMD_SINGLE,
238                         CMD_OPTIONAL, "interface to use for audit logging");
239     cmd_AddParmAtOffset(opts, OPT_config, "-config", CMD_SINGLE,
240                         CMD_OPTIONAL, "configuration location");
241     cmd_AddParmAtOffset(opts, OPT_debug, "-d", CMD_SINGLE,
242                         CMD_OPTIONAL, "debug level");
243     cmd_AddParmAtOffset(opts, OPT_database, "-database", CMD_SINGLE,
244                         CMD_OPTIONAL, "database file");
245     cmd_AddParmAlias(opts, OPT_database, "-db");
246     cmd_AddParmAtOffset(opts, OPT_logfile, "-logfile", CMD_SINGLE,
247                         CMD_OPTIONAL, "location of logfile");
248     cmd_AddParmAtOffset(opts, OPT_threads, "-p", CMD_SINGLE, CMD_OPTIONAL,
249                         "number of threads");
250 #ifdef HAVE_SYSLOG
251     cmd_AddParmAtOffset(opts, OPT_syslog, "-syslog", CMD_SINGLE_OR_FLAG,
252                         CMD_OPTIONAL, "log to syslog");
253 #endif
254
255     /* rx options */
256     cmd_AddParmAtOffset(opts, OPT_peer, "-enable_peer_stats", CMD_FLAG,
257                         CMD_OPTIONAL, "enable RX transport statistics");
258     cmd_AddParmAtOffset(opts, OPT_process, "-enable_process_stats", CMD_FLAG,
259                         CMD_OPTIONAL, "enable RX RPC statistics");
260     cmd_AddParmAtOffset(opts, OPT_nojumbo, "-nojumbo", CMD_FLAG,
261                         CMD_OPTIONAL, "disable jumbograms");
262     cmd_AddParmAtOffset(opts, OPT_jumbo, "-jumbo", CMD_FLAG,
263                         CMD_OPTIONAL, "enable jumbograms");
264     cmd_AddParmAtOffset(opts, OPT_rxbind, "-rxbind", CMD_FLAG,
265                         CMD_OPTIONAL, "bind only to the primary interface");
266     cmd_AddParmAtOffset(opts, OPT_rxmaxmtu, "-rxmaxmtu", CMD_SINGLE,
267                         CMD_OPTIONAL, "maximum MTU for RX");
268     cmd_AddParmAtOffset(opts, OPT_trace, "-trace", CMD_SINGLE,
269                         CMD_OPTIONAL, "rx trace file");
270     cmd_AddParmAtOffset(opts, OPT_restricted_query, "-restricted_query",
271                         CMD_SINGLE, CMD_OPTIONAL, "anyuser | admin");
272
273
274     /* rxkad options */
275     cmd_AddParmAtOffset(opts, OPT_dotted, "-allow-dotted-principals",
276                         CMD_FLAG, CMD_OPTIONAL,
277                         "permit Kerberos 5 principals with dots");
278
279     code = cmd_Parse(argc, argv, &opts);
280     if (code == CMD_HELP) {
281         exit(0);
282     }
283     if (code)
284         return -1;
285
286     cmd_OptionAsString(opts, OPT_config, &configDir);
287
288     cmd_OpenConfigFile(AFSDIR_SERVER_CONFIG_FILE_FILEPATH);
289     cmd_SetCommandName("vlserver");
290
291     /* vlserver options */
292     cmd_OptionAsFlag(opts, OPT_noauth, &noAuth);
293     cmd_OptionAsFlag(opts, OPT_smallmem, &smallMem);
294     if (cmd_OptionAsString(opts, OPT_trace, &optstring) == 0) {
295         extern char rxi_tracename[80];
296         strcpy(rxi_tracename, optstring);
297         free(optstring);
298         optstring = NULL;
299     }
300
301     /* general server options */
302
303     cmd_OptionAsString(opts, OPT_auditlog, &auditFileName);
304
305     if (cmd_OptionAsString(opts, OPT_auditiface, &interface) == 0) {
306         if (osi_audit_interface(interface)) {
307             printf("Invalid audit interface '%s'\n", interface);
308             return -1;
309         }
310         free(interface);
311     }
312
313     cmd_OptionAsString(opts, OPT_database, &vl_dbaseName);
314
315     if (cmd_OptionAsInt(opts, OPT_threads, &lwps) == 0) {
316         if (lwps > MAXLWP) {
317              printf("Warning: '-p %d' is too big; using %d instead\n",
318                     lwps, MAXLWP);
319              lwps = MAXLWP;
320         }
321     }
322
323     cmd_OptionAsInt(opts, OPT_debug, &logopts.lopt_logLevel);
324 #ifdef HAVE_SYSLOG
325     if (cmd_OptionPresent(opts, OPT_syslog)) {
326         if (cmd_OptionPresent(opts, OPT_logfile)) {
327             fprintf(stderr, "Invalid options: -syslog and -logfile are exclusive.\n");
328             return -1;
329         }
330
331         logopts.lopt_dest = logDest_syslog;
332         logopts.lopt_facility = LOG_DAEMON; /* default value */
333         logopts.lopt_tag = "vlserver";
334         cmd_OptionAsInt(opts, OPT_syslog, &logopts.lopt_facility);
335     } else
336 #endif
337     {
338         logopts.lopt_dest = logDest_file;
339         logopts.lopt_rotateOnOpen = 1;
340         logopts.lopt_rotateStyle = logRotate_old;
341
342         if (cmd_OptionPresent(opts, OPT_logfile))
343             cmd_OptionAsString(opts, OPT_logfile, (char**)&logopts.lopt_filename);
344         else
345             logopts.lopt_filename = AFSDIR_SERVER_VLOG_FILEPATH;
346     }
347
348
349     /* rx options */
350     if (cmd_OptionPresent(opts, OPT_peer))
351         rx_enablePeerRPCStats();
352     if (cmd_OptionPresent(opts, OPT_process))
353         rx_enableProcessRPCStats();
354     if (cmd_OptionPresent(opts, OPT_nojumbo))
355         rxJumbograms = 0;
356     if (cmd_OptionPresent(opts, OPT_jumbo))
357         rxJumbograms = 1;
358
359     cmd_OptionAsFlag(opts, OPT_rxbind, &rxBind);
360
361     cmd_OptionAsInt(opts, OPT_rxmaxmtu, &rxMaxMTU);
362
363     /* rxkad options */
364     cmd_OptionAsFlag(opts, OPT_dotted, &rxkadDisableDotCheck);
365
366     /* restricted query */
367     if (cmd_OptionAsString(opts, OPT_restricted_query,
368                            &restricted_query_parameter) == 0) {
369         if (strcmp(restricted_query_parameter, "anyuser") == 0)
370             restrictedQueryLevel = RESTRICTED_QUERY_ANYUSER;
371         else if (strcmp(restricted_query_parameter, "admin") == 0)
372             restrictedQueryLevel = RESTRICTED_QUERY_ADMIN;
373         else {
374             printf("invalid argument for -restricted_query: %s\n",
375                    restricted_query_parameter);
376             return -1;
377         }
378         free(restricted_query_parameter);
379     }
380
381     if (auditFileName) {
382         osi_audit_file(auditFileName);
383     }
384
385     OpenLog(&logopts);
386 #ifdef AFS_PTHREAD_ENV
387     opr_softsig_Init();
388     SetupLogSoftSignals();
389 #else
390     SetupLogSignals();
391 #endif
392
393     tdir = afsconf_Open(configDir);
394     if (!tdir) {
395         VLog(0,
396             ("vlserver: can't open configuration files in dir %s, giving up.\n",
397              configDir));
398         exit(1);
399     }
400
401     /* initialize audit user check */
402     osi_audit_set_user_check(tdir, vldb_IsLocalRealmMatch);
403
404 #ifdef AFS_NT40_ENV
405     /* initialize winsock */
406     if (afs_winsockInit() < 0) {
407         ReportErrorEventAlt(AFSEVT_SVR_WINSOCK_INIT_FAILED, 0, argv[0], 0);
408         VLog(0, ("vlserver: couldn't initialize winsock. \n"));
409         exit(1);
410     }
411 #endif
412     /* get this host */
413     gethostname(hostname, sizeof(hostname));
414     th = gethostbyname(hostname);
415     if (!th) {
416         VLog(0, ("vlserver: couldn't get address of this host (%s).\n",
417                hostname));
418         exit(1);
419     }
420     memcpy(&myHost, th->h_addr, sizeof(afs_uint32));
421
422 #if !defined(AFS_HPUX_ENV) && !defined(AFS_NT40_ENV)
423     signal(SIGXCPU, CheckSignal_Signal);
424 #endif
425     /* get list of servers */
426     code =
427         afsconf_GetExtendedCellInfo(tdir, NULL, AFSCONF_VLDBSERVICE, &info,
428                                     clones);
429     if (code) {
430         printf("vlserver: Couldn't get cell server list for 'afsvldb'.\n");
431         exit(2);
432     }
433
434     vldb_confdir = tdir;        /* Preserve our configuration dir */
435     /* rxvab no longer supported */
436     memset(&tkey, 0, sizeof(tkey));
437
438     if (noAuth)
439         afsconf_SetNoAuthFlag(tdir, 1);
440
441     if (rxBind) {
442         afs_int32 ccode;
443 #ifndef AFS_NT40_ENV
444         if (AFSDIR_SERVER_NETRESTRICT_FILEPATH ||
445             AFSDIR_SERVER_NETINFO_FILEPATH) {
446             char reason[1024];
447             ccode = afsconf_ParseNetFiles(SHostAddrs, NULL, NULL,
448                                           ADDRSPERSITE, reason,
449                                           AFSDIR_SERVER_NETINFO_FILEPATH,
450                                           AFSDIR_SERVER_NETRESTRICT_FILEPATH);
451         } else
452 #endif
453         {
454             ccode = rx_getAllAddr(SHostAddrs, ADDRSPERSITE);
455         }
456         if (ccode == 1) {
457             host = SHostAddrs[0];
458             rx_InitHost(host, htons(AFSCONF_VLDBPORT));
459         }
460     }
461
462     if (!rxJumbograms) {
463         rx_SetNoJumbo();
464     }
465     if (rxMaxMTU != -1) {
466         if (rx_SetMaxMTU(rxMaxMTU) != 0) {
467             VLog(0, ("rxMaxMTU %d invalid\n", rxMaxMTU));
468             return -1;
469         }
470     }
471
472     ubik_nBuffers = 512;
473     ubik_SetClientSecurityProcs(afsconf_ClientAuth, afsconf_UpToDate, tdir);
474     ubik_SetServerSecurityProcs(afsconf_BuildServerSecurityObjects,
475                                 afsconf_CheckAuth, tdir);
476
477     ubik_SyncWriterCacheProc = vlsynccache;
478     code =
479         ubik_ServerInitByInfo(myHost, htons(AFSCONF_VLDBPORT), &info, clones,
480                               vl_dbaseName, &VL_dbase);
481     if (code) {
482         VLog(0, ("vlserver: Ubik init failed: %s\n", afs_error_message(code)));
483         exit(2);
484     }
485     rx_SetRxDeadTime(50);
486
487     memset(rd_HostAddress, 0, sizeof(rd_HostAddress));
488     memset(wr_HostAddress, 0, sizeof(wr_HostAddress));
489     initialize_dstats();
490
491     afsconf_BuildServerSecurityObjects(tdir, &securityClasses, &numClasses);
492
493     tservice =
494         rx_NewServiceHost(host, 0, USER_SERVICE_ID, "Vldb server",
495                           securityClasses, numClasses,
496                           VL_ExecuteRequest);
497     if (tservice == (struct rx_service *)0) {
498         VLog(0, ("vlserver: Could not create VLDB_SERVICE rx service\n"));
499         exit(3);
500     }
501     rx_SetMinProcs(tservice, 2);
502     if (lwps < 4)
503         lwps = 4;
504     rx_SetMaxProcs(tservice, lwps);
505
506     if (rxkadDisableDotCheck) {
507         rx_SetSecurityConfiguration(tservice, RXS_CONFIG_FLAGS,
508                                     (void *)RXS_CONFIG_FLAGS_DISABLE_DOTCHECK);
509     }
510
511     tservice =
512         rx_NewServiceHost(host, 0, RX_STATS_SERVICE_ID, "rpcstats",
513                           securityClasses, numClasses,
514                           RXSTATS_ExecuteRequest);
515     if (tservice == (struct rx_service *)0) {
516         VLog(0, ("vlserver: Could not create rpc stats rx service\n"));
517         exit(3);
518     }
519     rx_SetMinProcs(tservice, 2);
520     rx_SetMaxProcs(tservice, 4);
521
522     LogCommandLine(argc, argv, "vlserver", VldbVersion, "Starting AFS", FSLog);
523     if (afsconf_GetLatestKey(tdir, NULL, NULL) == 0) {
524         LogDesWarning();
525     }
526     VLog(0, ("%s\n", cml_version_number));
527
528     /* allow super users to manage RX statistics */
529     rx_SetRxStatUserOk(vldb_rxstat_userok);
530
531     rx_StartServer(1);          /* Why waste this idle process?? */
532
533     return 0; /* not reachable */
534 }