Allow rpc.statd to *not* run sm-notify.
[nfs-utils.git] / utils / statd / statd.c
1 /* 
2  * Copyright (C) 1995, 1997-1999 Jeffrey A. Uphoff
3  * Modified by Olaf Kirch, Oct. 1996.
4  * Modified by H.J. Lu, 1998.
5  * Modified by L. Hohberger of Mission Critical Linux, 2000.
6  *
7  * NSM for Linux.
8  */
9
10 #ifdef HAVE_CONFIG_H
11 #include <config.h>
12 #endif
13
14 #include <sys/stat.h>
15 #include <limits.h>
16 #include <signal.h>
17 #include <unistd.h>
18 #include <fcntl.h>
19 #include <errno.h>
20 #include <string.h>
21 #include <getopt.h>
22 #include <rpc/rpc.h>
23 #include <rpc/pmap_clnt.h>
24 #include <rpcmisc.h>
25 #include <sys/resource.h>
26 #include <sys/wait.h>
27 #include <grp.h>
28 #include "statd.h"
29 #include "version.h"
30 #include "nfslib.h"
31
32 /* Socket operations */
33 #include <sys/types.h>
34 #include <sys/socket.h>
35
36 /* Added to enable specification of state directory path at run-time
37  * j_carlos_gomez@yahoo.com
38  */
39
40 char * DIR_BASE = DEFAULT_DIR_BASE;
41
42 char *  SM_DIR = DEFAULT_SM_DIR;
43 char *  SM_BAK_DIR =  DEFAULT_SM_BAK_DIR;
44 char *  SM_STAT_PATH = DEFAULT_SM_STAT_PATH;
45
46 /* ----- end of state directory path stuff ------- */
47
48 int     run_mode = 0;           /* foreground logging mode */
49
50 /* LH - I had these local to main, but it seemed silly to have 
51  * two copies of each - one in main(), one static in log.c... 
52  * It also eliminates the 256-char static in log.c */
53 char *name_p = NULL;
54 const char *version_p = NULL;
55
56 /* PRC: a high-availability callout program can be specified with -H
57  * When this is done, the program will receive callouts whenever clients
58  * are added or deleted to the notify list */
59 char *ha_callout_prog = NULL;
60
61 static struct option longopts[] =
62 {
63         { "foreground", 0, 0, 'F' },
64         { "no-syslog", 0, 0, 'd' },
65         { "help", 0, 0, 'h' },
66         { "version", 0, 0, 'v' },
67         { "outgoing-port", 1, 0, 'o' },
68         { "port", 1, 0, 'p' },
69         { "name", 1, 0, 'n' },
70         { "state-directory-path", 1, 0, 'P' },
71         { "notify-mode", 0, 0, 'N' },
72         { "ha-callout", 1, 0, 'H' },
73         { "no-notify", 0, 0, 'L' },
74         { NULL, 0, 0, 0 }
75 };
76
77 extern void sm_prog_1 (struct svc_req *, register SVCXPRT *);
78 extern int statd_get_socket(void);
79
80 #ifdef SIMULATIONS
81 extern void simulator (int, char **);
82 #endif
83
84
85 #ifdef HAVE_TCP_WRAPPER 
86 #include "tcpwrapper.h"
87
88 static void 
89 sm_prog_1_wrapper (struct svc_req *rqstp, register SVCXPRT *transp)
90 {
91         /* remote host authorization check */
92         if (!check_default("statd", svc_getcaller(transp),
93                                  rqstp->rq_proc, SM_PROG)) {
94                 svcerr_auth (transp, AUTH_FAILED);
95                 return;
96         }
97
98         sm_prog_1 (rqstp, transp);
99 }
100
101 #define sm_prog_1 sm_prog_1_wrapper
102 #endif
103
104 /*
105  * Signal handler.
106  */
107 static void 
108 killer (int sig)
109 {
110         note (N_FATAL, "Caught signal %d, un-registering and exiting.", sig);
111         pmap_unset (SM_PROG, SM_VERS);
112
113         exit (0);
114 }
115
116 static void
117 sigusr (int sig)
118 {
119         extern void my_svc_exit (void);
120         dprintf (N_DEBUG, "Caught signal %d, re-notifying (state %d).", sig,
121                                                                 MY_STATE);
122         my_svc_exit();
123 }
124
125 /*
126  * Startup information.
127  */
128 static void log_modes(void)
129 {
130         char buf[128];          /* watch stack size... */
131
132         /* No flags = no message */
133         if (!run_mode) return;
134
135         memset(buf,0,128);
136         sprintf(buf,"Flags: ");
137         if (run_mode & MODE_NODAEMON)
138                 strcat(buf,"No-Daemon ");
139         if (run_mode & MODE_LOG_STDERR)
140                 strcat(buf,"Log-STDERR ");
141
142         note(N_WARNING,buf);
143 }
144
145 /*
146  * Since we do more than standard statd stuff, we might need to
147  * help the occasional admin. 
148  */
149 static void 
150 usage()
151 {
152         fprintf(stderr,"usage: %s [options]\n", name_p);
153         fprintf(stderr,"      -h, -?, --help       Print this help screen.\n");
154         fprintf(stderr,"      -F, --foreground     Foreground (no-daemon mode)\n");
155         fprintf(stderr,"      -d, --no-syslog      Verbose logging to stderr.  Foreground mode only.\n");
156         fprintf(stderr,"      -p, --port           Port to listen on\n");
157         fprintf(stderr,"      -o, --outgoing-port  Port for outgoing connections\n");
158         fprintf(stderr,"      -V, -v, --version    Display version information and exit.\n");
159         fprintf(stderr,"      -n, --name           Specify a local hostname.\n");
160         fprintf(stderr,"      -P                   State directory path.\n");
161         fprintf(stderr,"      -N                   Run in notify only mode.\n");
162         fprintf(stderr,"      -L, --no-notify      Do not perform any notification.\n");
163         fprintf(stderr,"      -H                   Specify a high-availability callout program.\n");
164 }
165
166 static const char *pidfile = "/var/run/rpc.statd.pid";
167
168 int pidfd = -1;
169 static void create_pidfile(void)
170 {
171         FILE *fp;
172
173         unlink(pidfile);
174         fp = fopen(pidfile, "w");
175         if (!fp)
176                 die("Opening %s failed: %s\n",
177                     pidfile, strerror(errno));
178         fprintf(fp, "%d\n", getpid());
179         pidfd = dup(fileno(fp));
180         if (fclose(fp) < 0)
181                 note(N_WARNING, "Flushing pid file failed.\n");
182 }
183
184 static void truncate_pidfile(void)
185 {
186         if (pidfd >= 0)
187                 ftruncate(pidfd, 0);
188 }
189
190 static void drop_privs(void)
191 {
192         struct stat st;
193
194         if (stat(SM_DIR, &st) == -1 &&
195             stat(DIR_BASE, &st) == -1) {
196                 st.st_uid = 0;
197                 st.st_gid = 0;
198         }
199
200         if (st.st_uid == 0) {
201                 note(N_WARNING, "statd running as root. chown %s to choose different user\n",
202                     SM_DIR);
203                 return;
204         }
205         /* better chown the pid file before dropping, as if it
206          * if over nfs we might loose access
207          */
208         if (pidfd >= 0)
209                 fchown(pidfd, st.st_uid, st.st_gid);
210
211         setgroups(0, NULL);
212         if (setgid(st.st_gid) == -1
213             || setuid(st.st_uid) == -1) {
214                 note(N_ERROR, "Fail to drop privileges");
215                 exit(1);
216         }
217 }
218
219 static void run_sm_notify(int outport)
220 {
221         char op[20];
222         char *av[6];
223         int ac = 0;
224
225         av[ac++] = "/usr/sbin/sm-notify";
226         if (run_mode & MODE_NODAEMON)
227                 av[ac++] = "-d";
228         if (outport) {
229                 sprintf(op, "-p%d", outport);
230                 av[ac++] = op;
231         }
232         if (run_mode & STATIC_HOSTNAME) {
233                 av[ac++] = "-N";
234                 av[ac++] = MY_NAME;
235         }
236         av[ac] = NULL;
237         fprintf(stderr, "%s: -N deprecated, consider using /usr/sbin/sm-notify directly\n",
238                 name_p);
239         execv(av[0], av);
240         fprintf(stderr, "%s: failed to run %s\n", name_p, av[0]);
241         exit(2);
242
243 }
244 /* 
245  * Entry routine/main loop.
246  */
247 int main (int argc, char **argv)
248 {
249         extern char *optarg;
250         int pid;
251         int arg;
252         int port = 0, out_port = 0;
253         struct rlimit rlim;
254
255         int pipefds[2] = { -1, -1};
256         char status;
257
258         /* Default: daemon mode, no other options */
259         run_mode = 0;
260
261         /* Set the basename */
262         if ((name_p = strrchr(argv[0],'/')) != NULL) {
263                 name_p ++;
264         } else {
265                 name_p = argv[0];
266         }
267
268         /* Get the version */
269         if ((version_p = strrchr(VERSION,' ')) != NULL) {
270                 version_p++;
271         } else {
272                 version_p = VERSION;
273         }
274         
275         /* Set hostname */
276         MY_NAME = NULL;
277
278         /* Process command line switches */
279         while ((arg = getopt_long(argc, argv, "h?vVFNH:dn:p:o:P:L", longopts, NULL)) != EOF) {
280                 switch (arg) {
281                 case 'V':       /* Version */
282                 case 'v':
283                         printf("%s version %s\n",name_p,version_p);
284                         exit(0);
285                 case 'F':       /* Foreground/nodaemon mode */
286                         run_mode |= MODE_NODAEMON;
287                         break;
288                 case 'N':
289                         run_mode |= MODE_NOTIFY_ONLY;
290                         break;
291                 case 'L': /* Listen only */
292                         run_mode |= MODE_NO_NOTIFY;
293                         break;
294                 case 'd':       /* No daemon only - log to stderr */
295                         run_mode |= MODE_LOG_STDERR;
296                         break;
297                 case 'o':
298                         out_port = atoi(optarg);
299                         if (out_port < 1 || out_port > 65535) {
300                                 fprintf(stderr, "%s: bad port number: %s\n",
301                                         argv[0], optarg);
302                                 usage();
303                                 exit(1);
304                         }
305                         break;
306                 case 'p':
307                         port = atoi(optarg);
308                         if (port < 1 || port > 65535) {
309                                 fprintf(stderr, "%s: bad port number: %s\n",
310                                         argv[0], optarg);
311                                 usage();
312                                 exit(1);
313                         }
314                         break;
315                 case 'n':       /* Specify local hostname */
316                         run_mode |= STATIC_HOSTNAME;
317                         MY_NAME = xstrdup(optarg);
318                         break;
319                 case 'P':
320
321                         if ((DIR_BASE = xstrdup(optarg)) == NULL) {
322                                 fprintf(stderr, "%s: xstrdup(%s) failed!\n",
323                                         argv[0], optarg);
324                                 exit(1);
325                         }
326
327                         SM_DIR = xmalloc(strlen(DIR_BASE) + 1 + sizeof("sm"));
328                         SM_BAK_DIR = xmalloc(strlen(DIR_BASE) + 1 + sizeof("sm.bak"));
329                         SM_STAT_PATH = xmalloc(strlen(DIR_BASE) + 1 + sizeof("state"));
330
331                         if ((SM_DIR == NULL) 
332                             || (SM_BAK_DIR == NULL) 
333                             || (SM_STAT_PATH == NULL)) {
334
335                                 fprintf(stderr, "%s: xmalloc() failed!\n",
336                                         argv[0]);
337                                 exit(1);
338                         }
339                         if (DIR_BASE[strlen(DIR_BASE)-1] == '/') {
340                                 sprintf(SM_DIR, "%ssm", DIR_BASE );
341                                 sprintf(SM_BAK_DIR, "%ssm.bak", DIR_BASE );
342                                 sprintf(SM_STAT_PATH, "%sstate", DIR_BASE );
343                         } else {
344                                 sprintf(SM_DIR, "%s/sm", DIR_BASE );
345                                 sprintf(SM_BAK_DIR, "%s/sm.bak", DIR_BASE );
346                                 sprintf(SM_STAT_PATH, "%s/state", DIR_BASE );
347                         }
348                         break;
349                 case 'H': /* PRC: specify the ha-callout program */
350                         if ((ha_callout_prog = xstrdup(optarg)) == NULL) {
351                                 fprintf(stderr, "%s: xstrdup(%s) failed!\n",
352                                         argv[0], optarg);
353                                 exit(1);
354                         }
355                         break;
356                 case '?':       /* heeeeeelllllllpppp? heh */
357                 case 'h':
358                         usage();
359                         exit (0);
360                 default:        /* oh dear ... heh */
361                         usage();
362                         exit(-1);
363                 }
364         }
365
366         if (port == out_port && port != 0) {
367                 fprintf(stderr, "Listening and outgoing ports cannot be the same!\n");
368                 exit(-1);
369         }
370
371         if (run_mode & MODE_NOTIFY_ONLY)
372                 run_sm_notify(out_port);
373
374
375         if (!(run_mode & MODE_NODAEMON)) {
376                 run_mode &= ~MODE_LOG_STDERR;   /* Never log to console in
377                                                    daemon mode. */
378         }
379
380         if (getrlimit (RLIMIT_NOFILE, &rlim) != 0)
381                 fprintf(stderr, "%s: getrlimit (RLIMIT_NOFILE) failed: %s\n",
382                                 argv [0], strerror(errno));
383         else {
384                 /* glibc sunrpc code dies if getdtablesize > FD_SETSIZE */
385                 if (rlim.rlim_cur > FD_SETSIZE) {
386                         rlim.rlim_cur = FD_SETSIZE;
387
388                         if (setrlimit (RLIMIT_NOFILE, &rlim) != 0) {
389                                 fprintf(stderr, "%s: setrlimit (RLIMIT_NOFILE) failed: %s\n",
390                                         argv [0], strerror(errno));
391                         }
392                 }
393         }
394
395 #ifdef SIMULATIONS
396         if (argc > 1)
397                 /* LH - I _really_ need to update simulator... */
398                 simulator (--argc, ++argv);     /* simulator() does exit() */
399 #endif
400         
401         if (!(run_mode & MODE_NODAEMON)) {
402                 int tempfd;
403
404                 if (pipe(pipefds)<0) {
405                         perror("statd: unable to create pipe");
406                         exit(1);
407                 }
408                 if ((pid = fork ()) < 0) {
409                         perror ("statd: Could not fork");
410                         exit (1);
411                 } else if (pid != 0) {
412                         /* Parent.
413                          * Wait for status from child.
414                          */
415                         close(pipefds[1]);
416                         if (read(pipefds[0], &status, 1) != 1)
417                                 exit(1);
418                         exit (0);
419                 }
420                 /* Child.       */
421                 close(pipefds[0]);
422                 setsid ();
423                 if (chdir (DIR_BASE) == -1) {
424                         perror("statd: Could not chdir");
425                         exit(1);
426                 }
427
428                 while (pipefds[1] <= 2) {
429                         pipefds[1] = dup(pipefds[1]);
430                         if (pipefds[1]<0) {
431                                 perror("statd: dup");
432                                 exit(1);
433                         }
434                 }
435                 tempfd = open("/dev/null", O_RDWR);
436                 dup2(tempfd, 0);
437                 dup2(tempfd, 1);
438                 dup2(tempfd, 2);
439                 dup2(pipefds[1], 3);
440                 pipefds[1] = 3;
441                 closeall(4);
442         }
443
444         /* Child. */
445
446         log_init (name_p,version_p);
447
448         log_modes();
449
450         signal (SIGHUP, killer);
451         signal (SIGINT, killer);
452         signal (SIGTERM, killer);
453         /* PRC: trap SIGUSR1 to re-read notify list from disk */
454         signal(SIGUSR1, sigusr);
455         /* WARNING: the following works on Linux and SysV, but not BSD! */
456         signal(SIGCHLD, SIG_IGN);
457         /*
458          * Ignore SIGPIPE to avoid statd dying when peers close their
459          * TCP connection while we're trying to reply to them.
460          */
461         signal(SIGPIPE, SIG_IGN);
462
463         create_pidfile();
464         atexit(truncate_pidfile);
465
466         if (! (run_mode & MODE_NO_NOTIFY))
467                 switch (pid = fork()) {
468                 case 0:
469                         run_sm_notify(out_port);
470                         break;
471                 case -1:
472                         break;
473                 default:
474                         waitpid(pid, NULL, 0);
475                 }
476
477         drop_privs();
478
479         for (;;) {
480                 pmap_unset (SM_PROG, SM_VERS);
481
482                 /* If we got this far, we have successfully started, so notify parent */
483                 if (pipefds[1] > 0) {
484                         status = 0;
485                         write(pipefds[1], &status, 1);
486                         close(pipefds[1]);
487                         pipefds[1] = -1;
488                 }
489
490                 /* this registers both UDP and TCP services */
491                 rpc_init("statd", SM_PROG, SM_VERS, sm_prog_1, port);
492
493                 /*
494                  * Handle incoming requests:  SM_NOTIFY socket requests, as
495                  * well as callbacks from lockd.
496                  */
497                 my_svc_run();   /* I rolled my own, Olaf made it better... */
498
499                 /* Only get here when simulating a crash so we should probably
500                  * start sm-notify running again.  As we have already dropped
501                  * privileges, this might not work, but I don't think
502                  * responding to SM_SIMU_CRASH is an important use cases to
503                  * get perfect.
504                  */
505                 if (! (run_mode & MODE_NO_NOTIFY))
506                         switch (pid = fork()) {
507                         case 0:
508                                 run_sm_notify(out_port);
509                                 break;
510                         case -1:
511                                 break;
512                         default:
513                                 waitpid(pid, NULL, 0);
514                         }
515
516         }
517         return 0;
518 }