2 * Send NSM notify calls to all hosts listed in /var/lib/sm
4 * Copyright (C) 2004-2006 Olaf Kirch <okir@suse.de>
8 #include <sys/socket.h>
11 #include <sys/param.h>
12 #include <sys/syslog.h>
13 #include <arpa/inet.h>
31 # define BASEDIR NFS_STATEDIR
33 # define BASEDIR "/var/lib/nfs"
37 #define DEFAULT_SM_STATE_PATH BASEDIR "/state"
38 #define DEFAULT_SM_DIR_PATH BASEDIR "/sm"
39 #define DEFAULT_SM_BAK_PATH DEFAULT_SM_DIR_PATH ".bak"
41 char *_SM_BASE_PATH = BASEDIR;
42 char *_SM_STATE_PATH = DEFAULT_SM_STATE_PATH;
43 char *_SM_DIR_PATH = DEFAULT_SM_DIR_PATH;
44 char *_SM_BAK_PATH = DEFAULT_SM_BAK_PATH;
46 #define NSM_PROG 100024
47 #define NSM_PROGRAM 100024
51 #define NSM_MAX_TIMEOUT 120 /* don't make this too big */
52 #define MAXMSGSIZE 256
54 typedef struct sockaddr_storage nsm_address;
57 struct nsm_host * next;
69 static char nsm_hostname[256];
70 static uint32_t nsm_state;
71 static int opt_debug = 0;
72 static int opt_quiet = 0;
73 static int opt_update_state = 1;
74 static unsigned int opt_max_retry = 15 * 60;
75 static char * opt_srcaddr = 0;
76 static uint16_t opt_srcport = 0;
77 static int log_syslog = 0;
79 static unsigned int nsm_get_state(int);
80 static void notify(void);
81 static int notify_host(int, struct nsm_host *);
82 static void recv_reply(int);
83 static void backup_hosts(const char *, const char *);
84 static void get_hosts(const char *);
85 static void insert_host(struct nsm_host *);
86 struct nsm_host * find_host(uint32_t);
87 static int addr_get_port(nsm_address *);
88 static void addr_set_port(nsm_address *, int);
89 static struct addrinfo *host_lookup(int, const char *);
90 void nsm_log(int fac, const char *fmt, ...);
91 static int record_pid(void);
92 static void drop_privs(void);
93 static void set_kernel_nsm_state(int state);
95 static struct nsm_host * hosts = NULL;
98 main(int argc, char **argv)
103 while ((c = getopt(argc, argv, "dm:np:v:qP:f")) != -1) {
112 opt_max_retry = atoi(optarg) * 60;
115 opt_update_state = 0;
118 opt_srcport = atoi(optarg);
121 opt_srcaddr = optarg;
127 _SM_BASE_PATH = strdup(optarg);
128 _SM_STATE_PATH = malloc(strlen(optarg)+1+sizeof("state"));
129 _SM_DIR_PATH = malloc(strlen(optarg)+1+sizeof("sm"));
130 _SM_BAK_PATH = malloc(strlen(optarg)+1+sizeof("sm.bak"));
131 if (_SM_BASE_PATH == NULL ||
132 _SM_STATE_PATH == NULL ||
133 _SM_DIR_PATH == NULL ||
134 _SM_BAK_PATH == NULL) {
135 nsm_log(LOG_WARNING, "unable to allocate memory");
138 strcat(strcpy(_SM_STATE_PATH, _SM_BASE_PATH), "/state");
139 strcat(strcpy(_SM_DIR_PATH, _SM_BASE_PATH), "/sm");
140 strcat(strcpy(_SM_BAK_PATH, _SM_BASE_PATH), "/sm.bak");
149 usage: fprintf(stderr,
150 "Usage: sm-notify [-dfq] [-m max-retry-minutes] [-p srcport]\n"
151 " [-P /path/to/state/directory] [-v my_host_name]\n");
155 if (strcmp(_SM_BASE_PATH, BASEDIR) == 0) {
156 if (record_pid() == 0 && force == 0 && opt_update_state == 1)
157 /* already run, don't try again */
162 strncpy(nsm_hostname, opt_srcaddr, sizeof(nsm_hostname)-1);
164 if (gethostname(nsm_hostname, sizeof(nsm_hostname)) < 0) {
165 perror("gethostname");
169 backup_hosts(_SM_DIR_PATH, _SM_BAK_PATH);
170 get_hosts(_SM_BAK_PATH);
172 /* Get and update the NSM state. This will call sync() */
173 nsm_state = nsm_get_state(opt_update_state);
174 set_kernel_nsm_state(nsm_state);
178 printf("Backgrounding to notify hosts...\n");
180 openlog("sm-notify", LOG_PID, LOG_DAEMON);
183 if (daemon(0, 0) < 0) {
184 nsm_log(LOG_WARNING, "unable to background: %s",
199 while ((hp = hosts) != 0) {
202 "Unable to notify %s, giving up",
217 nsm_address local_addr;
223 sock = socket(AF_INET, SOCK_DGRAM, 0);
228 fcntl(sock, F_SETFL, O_NONBLOCK);
230 memset(&local_addr, 0, sizeof(local_addr));
231 local_addr.ss_family = AF_INET; /* Default to IPv4 */
233 /* Bind source IP if provided on command line */
235 struct addrinfo *ai = host_lookup(AF_INET, opt_srcaddr);
238 "Not a valid hostname or address: \"%s\"\n",
242 memcpy(&local_addr, ai->ai_addr, ai->ai_addrlen);
243 /* We know it's IPv4 at this point */
246 /* Use source port if provided on the command line,
247 * otherwise use bindresvport */
249 addr_set_port(&local_addr, opt_srcport);
250 if (bind(sock, (struct sockaddr *) &local_addr, sizeof(local_addr)) < 0) {
256 struct sockaddr_in *sin = (struct sockaddr_in *)&local_addr;
257 (void) bindresvport(sock, sin);
258 /* try to avoid known ports */
259 se = getservbyport(sin->sin_port, "udp");
260 if (se && retry_cnt < 100) {
268 failtime = time(NULL) + opt_max_retry;
274 time_t now = time(NULL);
275 unsigned int sent = 0;
279 if (failtime && now >= failtime)
282 while (hosts && ((wait = hosts->send_next - now) <= 0)) {
283 /* Never send more than 10 packets at once */
287 /* Remove queue head */
291 if (notify_host(sock, hp)){
299 /* Set the timeout for this call, using an
300 exponential timeout strategy */
302 if ((hp->timeout <<= 1) > NSM_MAX_TIMEOUT)
303 hp->timeout = NSM_MAX_TIMEOUT;
304 hp->send_next = now + wait;
312 nsm_log(LOG_DEBUG, "Host %s due in %ld seconds",
321 if (poll(&pfd, 1, wait) != 1)
329 * Send notification to a single host
332 notify_host(int sock, struct nsm_host *host)
334 static unsigned int xid = 0;
336 uint32_t msgbuf[MAXMSGSIZE], *p;
340 xid = getpid() + time(NULL);
344 if (host->ai == NULL) {
345 host->ai = host_lookup(AF_UNSPEC, host->name);
346 if (host->ai == NULL) {
348 "%s doesn't seem to be a valid address,"
349 " skipped", host->name);
354 memset(msgbuf, 0, sizeof(msgbuf));
356 *p++ = htonl(host->xid);
360 /* If we retransmitted 4 times, reset the port to force
361 * a new portmap lookup (in case statd was restarted).
362 * We also rotate through multiple IP addresses at this
365 if (host->retries >= 4) {
366 struct addrinfo *first = host->ai;
367 struct addrinfo **next = &host->ai;
369 /* remove the first entry from the list */
370 host->ai = first->ai_next;
371 first->ai_next = NULL;
372 /* find the end of the list */
373 next = &first->ai_next;
375 next = & (*next)->ai_next;
376 /* put first entry at end */
378 memcpy(&host->addr, first->ai_addr, first->ai_addrlen);
379 addr_set_port(&host->addr, 0);
384 if (addr_get_port(&dest) == 0) {
385 /* Build a PMAP packet */
386 nsm_log(LOG_DEBUG, "Sending portmap query to %s", host->name);
388 addr_set_port(&dest, 111);
389 *p++ = htonl(100000);
397 *p++ = htonl(NSM_PROGRAM);
398 *p++ = htonl(NSM_VERSION);
399 *p++ = htonl(IPPROTO_UDP);
402 /* Build an SM_NOTIFY packet */
403 nsm_log(LOG_DEBUG, "Sending SM_NOTIFY to %s", host->name);
405 *p++ = htonl(NSM_PROGRAM);
406 *p++ = htonl(NSM_VERSION);
407 *p++ = htonl(NSM_NOTIFY);
414 len = strlen(nsm_hostname);
416 memcpy(p, nsm_hostname, len);
418 *p++ = htonl(nsm_state);
420 len = (p - msgbuf) << 2;
422 if (sendto(sock, msgbuf, len, 0, (struct sockaddr *) &dest, sizeof(dest)) < 0)
423 nsm_log(LOG_WARNING, "Sending Reboot Notification to "
424 "'%s' failed: errno %d (%s)", host->name, errno, strerror(errno));
430 * Receive reply from remote host
436 uint32_t msgbuf[MAXMSGSIZE], *p, *end;
440 res = recv(sock, msgbuf, sizeof(msgbuf), 0);
444 nsm_log(LOG_DEBUG, "Received packet...");
447 end = p + (res >> 2);
450 if (*p++ != htonl(1) /* must be REPLY */
451 || *p++ != htonl(0) /* must be ACCEPTED */
452 || *p++ != htonl(0) /* must be NULL verifier */
454 || *p++ != htonl(0)) /* must be SUCCESS */
457 /* Before we look at the data, find the host struct for
459 if ((hp = find_host(xid)) == NULL)
462 if (addr_get_port(&hp->addr) == 0) {
463 /* This was a portmap request */
470 hp->send_next = time(NULL);
472 /* No binding for statd. Delay the next
473 * portmap query for max timeout */
474 nsm_log(LOG_DEBUG, "No statd on %s", hp->name);
475 hp->timeout = NSM_MAX_TIMEOUT;
476 hp->send_next += NSM_MAX_TIMEOUT;
478 addr_set_port(&hp->addr, port);
479 if (hp->timeout >= NSM_MAX_TIMEOUT / 4)
480 hp->timeout = NSM_MAX_TIMEOUT / 4;
484 /* Successful NOTIFY call. Server returns void,
485 * so nothing we need to do here (except
486 * check that we didn't read past the end of the
490 nsm_log(LOG_DEBUG, "Host %s notified successfully", hp->name);
495 freeaddrinfo(hp->ai);
500 fail: /* Re-insert the host */
505 * Back up all hosts from the sm directory to sm.bak
508 backup_hosts(const char *dirname, const char *bakname)
513 if (!(dir = opendir(dirname))) {
518 while ((de = readdir(dir)) != NULL) {
519 char src[1024], dst[1024];
521 if (de->d_name[0] == '.')
524 snprintf(src, sizeof(src), "%s/%s", dirname, de->d_name);
525 snprintf(dst, sizeof(dst), "%s/%s", bakname, de->d_name);
526 if (rename(src, dst) < 0) {
528 "Failed to rename %s -> %s: %m",
536 * Get all entries from sm.bak and convert them to host entries
539 get_hosts(const char *dirname)
541 struct nsm_host *host;
545 if (!(dir = opendir(dirname))) {
551 while ((de = readdir(dir)) != NULL) {
555 if (de->d_name[0] == '.')
558 host = calloc(1, sizeof(*host));
560 snprintf(path, sizeof(path), "%s/%s", dirname, de->d_name);
561 if (stat(path, &stb) < 0)
564 host->last_used = stb.st_mtime;
565 host->timeout = NSM_TIMEOUT;
566 host->path = strdup(path);
567 host->name = strdup(de->d_name);
568 host->retries = 100; /* force address retry */
580 * Insert host into sorted list
583 insert_host(struct nsm_host *host)
585 struct nsm_host **where, *p;
588 while ((p = *where) != 0) {
589 /* Sort in ascending order of timeout */
590 if (host->send_next < p->send_next)
592 /* If we have the same timeout, put the
593 * most recently used host first.
594 * This makes sure that "recent" hosts
595 * get notified first.
597 if (host->send_next == p->send_next
598 && host->last_used > p->last_used)
608 * Find host given the XID
611 find_host(uint32_t xid)
613 struct nsm_host **where, *p;
616 while ((p = *where) != 0) {
628 * Retrieve the current NSM state
631 nsm_get_state(int update)
633 char newfile[PATH_MAX];
636 if ((fd = open(_SM_STATE_PATH, O_RDONLY)) < 0) {
638 nsm_log(LOG_WARNING, "%s: %m", _SM_STATE_PATH);
639 nsm_log(LOG_WARNING, "Creating %s, set initial state 1",
645 if (read(fd, &state, sizeof(state)) != sizeof(state)) {
647 "%s: bad file size, setting state = 1",
660 snprintf(newfile, sizeof(newfile),
661 "%s.new", _SM_STATE_PATH);
662 if ((fd = open(newfile, O_CREAT|O_WRONLY, 0644)) < 0) {
663 nsm_log(LOG_WARNING, "Cannot create %s: %m", newfile);
666 if (write(fd, &state, sizeof(state)) != sizeof(state)) {
668 "Failed to write state to %s", newfile);
672 if (rename(newfile, _SM_STATE_PATH) < 0) {
674 "Cannot create %s: %m", _SM_STATE_PATH);
684 * Address handling utilities
688 addr_get_port(nsm_address *addr)
690 switch (((struct sockaddr *) addr)->sa_family) {
692 return ntohs(((struct sockaddr_in *) addr)->sin_port);
694 return ntohs(((struct sockaddr_in6 *) addr)->sin6_port);
700 addr_set_port(nsm_address *addr, int port)
702 switch (((struct sockaddr *) addr)->sa_family) {
704 ((struct sockaddr_in *) addr)->sin_port = htons(port);
707 ((struct sockaddr_in6 *) addr)->sin6_port = htons(port);
711 static struct addrinfo *
712 host_lookup(int af, const char *name)
714 struct addrinfo hints, *ai;
716 memset(&hints, 0, sizeof(hints));
717 hints.ai_family = af;
718 hints.ai_protocol = IPPROTO_UDP;
720 if (getaddrinfo(name, NULL, &hints, &ai) != 0)
730 nsm_log(int fac, const char *fmt, ...)
734 if (fac == LOG_DEBUG && !opt_debug)
739 vsyslog(fac, fmt, ap);
741 vfprintf(stderr, fmt, ap);
748 * Record pid in /var/run/sm-notify.pid
749 * This file should remain until a reboot, even if the
751 * If file already exists, fail.
753 static int record_pid(void)
758 snprintf(pid, 20, "%d\n", getpid());
759 fd = open("/var/run/sm-notify.pid", O_CREAT|O_EXCL|O_WRONLY, 0600);
762 write(fd, pid, strlen(pid));
767 /* Drop privileges to match owner of state-directory
768 * (in case a reply triggers some unknown bug).
770 static void drop_privs(void)
774 if (stat(_SM_DIR_PATH, &st) == -1 &&
775 stat(_SM_BASE_PATH, &st) == -1) {
780 if (st.st_uid == 0) {
782 "sm-notify running as root. chown %s to choose different user\n",
788 if (setgid(st.st_gid) == -1
789 || setuid(st.st_uid) == -1) {
790 nsm_log(LOG_ERR, "Fail to drop privileges");
795 static void set_kernel_nsm_state(int state)
799 fd = open("/proc/sys/fs/nfs/nsm_local_state",O_WRONLY);
802 snprintf(buf, sizeof(buf), "%d", state);
803 write(fd, buf, strlen(buf));