2 * Send NSM notify calls to all hosts listed in /var/lib/sm
4 * Copyright (C) 2004-2006 Olaf Kirch <okir@suse.de>
11 #include <sys/types.h>
12 #include <sys/socket.h>
15 #include <sys/param.h>
16 #include <sys/syslog.h>
17 #include <arpa/inet.h>
33 # define BASEDIR NFS_STATEDIR
35 # define BASEDIR "/var/lib/nfs"
39 #define DEFAULT_SM_STATE_PATH BASEDIR "/state"
40 #define DEFAULT_SM_DIR_PATH BASEDIR "/sm"
41 #define DEFAULT_SM_BAK_PATH DEFAULT_SM_DIR_PATH ".bak"
43 char *_SM_BASE_PATH = BASEDIR;
44 char *_SM_STATE_PATH = DEFAULT_SM_STATE_PATH;
45 char *_SM_DIR_PATH = DEFAULT_SM_DIR_PATH;
46 char *_SM_BAK_PATH = DEFAULT_SM_BAK_PATH;
48 #define NSM_PROG 100024
49 #define NSM_PROGRAM 100024
53 #define NSM_MAX_TIMEOUT 120 /* don't make this too big */
54 #define MAXMSGSIZE 256
56 typedef struct sockaddr_storage nsm_address;
59 struct nsm_host * next;
71 static char nsm_hostname[256];
72 static uint32_t nsm_state;
73 static int opt_debug = 0;
74 static int opt_quiet = 0;
75 static int opt_update_state = 1;
76 static unsigned int opt_max_retry = 15 * 60;
77 static char * opt_srcaddr = 0;
78 static uint16_t opt_srcport = 0;
79 static int log_syslog = 0;
81 static unsigned int nsm_get_state(int);
82 static void notify(void);
83 static int notify_host(int, struct nsm_host *);
84 static void recv_reply(int);
85 static void backup_hosts(const char *, const char *);
86 static void get_hosts(const char *);
87 static void insert_host(struct nsm_host *);
88 struct nsm_host * find_host(uint32_t);
89 static int addr_get_port(nsm_address *);
90 static void addr_set_port(nsm_address *, int);
91 static struct addrinfo *host_lookup(int, const char *);
92 void nsm_log(int fac, const char *fmt, ...);
93 static int record_pid(void);
94 static void drop_privs(void);
95 static void set_kernel_nsm_state(int state);
97 static struct nsm_host * hosts = NULL;
100 main(int argc, char **argv)
105 while ((c = getopt(argc, argv, "dm:np:v:qP:f")) != -1) {
114 opt_max_retry = atoi(optarg) * 60;
117 opt_update_state = 0;
120 opt_srcport = atoi(optarg);
123 opt_srcaddr = optarg;
129 _SM_BASE_PATH = strdup(optarg);
130 _SM_STATE_PATH = malloc(strlen(optarg)+1+sizeof("state"));
131 _SM_DIR_PATH = malloc(strlen(optarg)+1+sizeof("sm"));
132 _SM_BAK_PATH = malloc(strlen(optarg)+1+sizeof("sm.bak"));
133 if (_SM_BASE_PATH == NULL ||
134 _SM_STATE_PATH == NULL ||
135 _SM_DIR_PATH == NULL ||
136 _SM_BAK_PATH == NULL) {
137 nsm_log(LOG_WARNING, "unable to allocate memory");
140 strcat(strcpy(_SM_STATE_PATH, _SM_BASE_PATH), "/state");
141 strcat(strcpy(_SM_DIR_PATH, _SM_BASE_PATH), "/sm");
142 strcat(strcpy(_SM_BAK_PATH, _SM_BASE_PATH), "/sm.bak");
151 usage: fprintf(stderr,
152 "Usage: sm-notify [-dfq] [-m max-retry-minutes] [-p srcport]\n"
153 " [-P /path/to/state/directory] [-v my_host_name]\n");
157 if (strcmp(_SM_BASE_PATH, BASEDIR) == 0) {
158 if (record_pid() == 0 && force == 0 && opt_update_state == 1)
159 /* already run, don't try again */
164 strncpy(nsm_hostname, opt_srcaddr, sizeof(nsm_hostname)-1);
166 if (gethostname(nsm_hostname, sizeof(nsm_hostname)) < 0) {
167 perror("gethostname");
171 backup_hosts(_SM_DIR_PATH, _SM_BAK_PATH);
172 get_hosts(_SM_BAK_PATH);
174 /* Get and update the NSM state. This will call sync() */
175 nsm_state = nsm_get_state(opt_update_state);
176 set_kernel_nsm_state(nsm_state);
180 printf("Backgrounding to notify hosts...\n");
182 openlog("sm-notify", LOG_PID, LOG_DAEMON);
185 if (daemon(0, 0) < 0) {
186 nsm_log(LOG_WARNING, "unable to background: %s",
201 while ((hp = hosts) != 0) {
204 "Unable to notify %s, giving up",
219 nsm_address local_addr;
225 sock = socket(AF_INET, SOCK_DGRAM, 0);
230 fcntl(sock, F_SETFL, O_NONBLOCK);
232 memset(&local_addr, 0, sizeof(local_addr));
233 local_addr.ss_family = AF_INET; /* Default to IPv4 */
235 /* Bind source IP if provided on command line */
237 struct addrinfo *ai = host_lookup(AF_INET, opt_srcaddr);
240 "Not a valid hostname or address: \"%s\"\n",
245 /* We know it's IPv4 at this point */
246 memcpy(&local_addr, ai->ai_addr, ai->ai_addrlen);
251 /* Use source port if provided on the command line,
252 * otherwise use bindresvport */
254 addr_set_port(&local_addr, opt_srcport);
255 if (bind(sock, (struct sockaddr *) &local_addr, sizeof(local_addr)) < 0) {
261 struct sockaddr_in *sin = (struct sockaddr_in *)&local_addr;
262 (void) bindresvport(sock, sin);
263 /* try to avoid known ports */
264 se = getservbyport(sin->sin_port, "udp");
265 if (se && retry_cnt < 100) {
273 failtime = time(NULL) + opt_max_retry;
279 time_t now = time(NULL);
280 unsigned int sent = 0;
284 if (failtime && now >= failtime)
287 while (hosts && ((wait = hosts->send_next - now) <= 0)) {
288 /* Never send more than 10 packets at once */
292 /* Remove queue head */
296 if (notify_host(sock, hp)){
304 /* Set the timeout for this call, using an
305 exponential timeout strategy */
307 if ((hp->timeout <<= 1) > NSM_MAX_TIMEOUT)
308 hp->timeout = NSM_MAX_TIMEOUT;
309 hp->send_next = now + wait;
317 nsm_log(LOG_DEBUG, "Host %s due in %ld seconds",
326 if (poll(&pfd, 1, wait) != 1)
334 * Send notification to a single host
337 notify_host(int sock, struct nsm_host *host)
339 static unsigned int xid = 0;
341 uint32_t msgbuf[MAXMSGSIZE], *p;
345 xid = getpid() + time(NULL);
349 if (host->ai == NULL) {
350 host->ai = host_lookup(AF_UNSPEC, host->name);
351 if (host->ai == NULL) {
353 "%s doesn't seem to be a valid address,"
354 " skipped", host->name);
359 memset(msgbuf, 0, sizeof(msgbuf));
361 *p++ = htonl(host->xid);
365 /* If we retransmitted 4 times, reset the port to force
366 * a new portmap lookup (in case statd was restarted).
367 * We also rotate through multiple IP addresses at this
370 if (host->retries >= 4) {
371 struct addrinfo *first = host->ai;
372 struct addrinfo **next = &host->ai;
374 /* remove the first entry from the list */
375 host->ai = first->ai_next;
376 first->ai_next = NULL;
377 /* find the end of the list */
378 next = &first->ai_next;
380 next = & (*next)->ai_next;
381 /* put first entry at end */
383 memcpy(&host->addr, first->ai_addr, first->ai_addrlen);
384 addr_set_port(&host->addr, 0);
389 if (addr_get_port(&dest) == 0) {
390 /* Build a PMAP packet */
391 nsm_log(LOG_DEBUG, "Sending portmap query to %s", host->name);
393 addr_set_port(&dest, 111);
394 *p++ = htonl(100000);
402 *p++ = htonl(NSM_PROGRAM);
403 *p++ = htonl(NSM_VERSION);
404 *p++ = htonl(IPPROTO_UDP);
407 /* Build an SM_NOTIFY packet */
408 nsm_log(LOG_DEBUG, "Sending SM_NOTIFY to %s", host->name);
410 *p++ = htonl(NSM_PROGRAM);
411 *p++ = htonl(NSM_VERSION);
412 *p++ = htonl(NSM_NOTIFY);
419 len = strlen(nsm_hostname);
421 memcpy(p, nsm_hostname, len);
423 *p++ = htonl(nsm_state);
425 len = (p - msgbuf) << 2;
427 if (sendto(sock, msgbuf, len, 0, (struct sockaddr *) &dest, sizeof(dest)) < 0)
428 nsm_log(LOG_WARNING, "Sending Reboot Notification to "
429 "'%s' failed: errno %d (%s)", host->name, errno, strerror(errno));
435 * Receive reply from remote host
441 uint32_t msgbuf[MAXMSGSIZE], *p, *end;
445 res = recv(sock, msgbuf, sizeof(msgbuf), 0);
449 nsm_log(LOG_DEBUG, "Received packet...");
452 end = p + (res >> 2);
455 if (*p++ != htonl(1) /* must be REPLY */
456 || *p++ != htonl(0) /* must be ACCEPTED */
457 || *p++ != htonl(0) /* must be NULL verifier */
459 || *p++ != htonl(0)) /* must be SUCCESS */
462 /* Before we look at the data, find the host struct for
464 if ((hp = find_host(xid)) == NULL)
467 if (addr_get_port(&hp->addr) == 0) {
468 /* This was a portmap request */
475 hp->send_next = time(NULL);
477 /* No binding for statd. Delay the next
478 * portmap query for max timeout */
479 nsm_log(LOG_DEBUG, "No statd on %s", hp->name);
480 hp->timeout = NSM_MAX_TIMEOUT;
481 hp->send_next += NSM_MAX_TIMEOUT;
483 addr_set_port(&hp->addr, port);
484 if (hp->timeout >= NSM_MAX_TIMEOUT / 4)
485 hp->timeout = NSM_MAX_TIMEOUT / 4;
489 /* Successful NOTIFY call. Server returns void,
490 * so nothing we need to do here (except
491 * check that we didn't read past the end of the
495 nsm_log(LOG_DEBUG, "Host %s notified successfully", hp->name);
500 freeaddrinfo(hp->ai);
505 fail: /* Re-insert the host */
510 * Back up all hosts from the sm directory to sm.bak
513 backup_hosts(const char *dirname, const char *bakname)
518 if (!(dir = opendir(dirname))) {
523 while ((de = readdir(dir)) != NULL) {
524 char src[1024], dst[1024];
526 if (de->d_name[0] == '.')
529 snprintf(src, sizeof(src), "%s/%s", dirname, de->d_name);
530 snprintf(dst, sizeof(dst), "%s/%s", bakname, de->d_name);
531 if (rename(src, dst) < 0) {
533 "Failed to rename %s -> %s: %m",
541 * Get all entries from sm.bak and convert them to host entries
544 get_hosts(const char *dirname)
546 struct nsm_host *host;
550 if (!(dir = opendir(dirname))) {
556 while ((de = readdir(dir)) != NULL) {
560 if (de->d_name[0] == '.')
563 host = calloc(1, sizeof(*host));
565 snprintf(path, sizeof(path), "%s/%s", dirname, de->d_name);
566 if (stat(path, &stb) < 0)
569 host->last_used = stb.st_mtime;
570 host->timeout = NSM_TIMEOUT;
571 host->path = strdup(path);
572 host->name = strdup(de->d_name);
573 host->retries = 100; /* force address retry */
585 * Insert host into sorted list
588 insert_host(struct nsm_host *host)
590 struct nsm_host **where, *p;
593 while ((p = *where) != 0) {
594 /* Sort in ascending order of timeout */
595 if (host->send_next < p->send_next)
597 /* If we have the same timeout, put the
598 * most recently used host first.
599 * This makes sure that "recent" hosts
600 * get notified first.
602 if (host->send_next == p->send_next
603 && host->last_used > p->last_used)
613 * Find host given the XID
616 find_host(uint32_t xid)
618 struct nsm_host **where, *p;
621 while ((p = *where) != 0) {
633 * Retrieve the current NSM state
636 nsm_get_state(int update)
638 char newfile[PATH_MAX];
641 if ((fd = open(_SM_STATE_PATH, O_RDONLY)) < 0) {
643 nsm_log(LOG_WARNING, "%s: %m", _SM_STATE_PATH);
644 nsm_log(LOG_WARNING, "Creating %s, set initial state 1",
650 if (read(fd, &state, sizeof(state)) != sizeof(state)) {
652 "%s: bad file size, setting state = 1",
665 snprintf(newfile, sizeof(newfile),
666 "%s.new", _SM_STATE_PATH);
667 if ((fd = open(newfile, O_CREAT|O_WRONLY, 0644)) < 0) {
668 nsm_log(LOG_WARNING, "Cannot create %s: %m", newfile);
671 if (write(fd, &state, sizeof(state)) != sizeof(state)) {
673 "Failed to write state to %s", newfile);
677 if (rename(newfile, _SM_STATE_PATH) < 0) {
679 "Cannot create %s: %m", _SM_STATE_PATH);
689 * Address handling utilities
693 addr_get_port(nsm_address *addr)
695 switch (((struct sockaddr *) addr)->sa_family) {
697 return ntohs(((struct sockaddr_in *) addr)->sin_port);
699 return ntohs(((struct sockaddr_in6 *) addr)->sin6_port);
705 addr_set_port(nsm_address *addr, int port)
707 switch (((struct sockaddr *) addr)->sa_family) {
709 ((struct sockaddr_in *) addr)->sin_port = htons(port);
712 ((struct sockaddr_in6 *) addr)->sin6_port = htons(port);
716 static struct addrinfo *
717 host_lookup(int af, const char *name)
719 struct addrinfo hints, *ai;
721 memset(&hints, 0, sizeof(hints));
722 hints.ai_family = af;
723 hints.ai_protocol = IPPROTO_UDP;
725 if (getaddrinfo(name, NULL, &hints, &ai) != 0)
735 nsm_log(int fac, const char *fmt, ...)
739 if (fac == LOG_DEBUG && !opt_debug)
744 vsyslog(fac, fmt, ap);
746 vfprintf(stderr, fmt, ap);
753 * Record pid in /var/run/sm-notify.pid
754 * This file should remain until a reboot, even if the
756 * If file already exists, fail.
758 static int record_pid(void)
763 snprintf(pid, 20, "%d\n", getpid());
764 fd = open("/var/run/sm-notify.pid", O_CREAT|O_EXCL|O_WRONLY, 0600);
767 write(fd, pid, strlen(pid));
772 /* Drop privileges to match owner of state-directory
773 * (in case a reply triggers some unknown bug).
775 static void drop_privs(void)
779 if (stat(_SM_DIR_PATH, &st) == -1 &&
780 stat(_SM_BASE_PATH, &st) == -1) {
785 if (st.st_uid == 0) {
787 "sm-notify running as root. chown %s to choose different user\n",
793 if (setgid(st.st_gid) == -1
794 || setuid(st.st_uid) == -1) {
795 nsm_log(LOG_ERR, "Fail to drop privileges");
800 static void set_kernel_nsm_state(int state)
804 fd = open("/proc/sys/fs/nfs/nsm_local_state",O_WRONLY);
807 snprintf(buf, sizeof(buf), "%d", state);
808 write(fd, buf, strlen(buf));