3 * A.R. Gordon (andrew.gordon@net-tel.co.uk). All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. All advertising materials mentioning features or use of this software
14 * must display the following acknowledgement:
15 * This product includes software developed for the FreeBSD project
16 * 4. Neither the name of the author nor the names of any co-contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY ANDREW GORDON AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 #include <sys/types.h>
41 #include <sys/mman.h> /* For mmap() */
47 FileLayout *status_info; /* Pointer to the mmap()ed status file */
48 static int status_fd; /* File descriptor for the open file */
49 static off_t status_file_len; /* Current on-disc length of file */
51 /* sync_file --------------------------------------------------------------- */
53 Purpose: Packaged call of msync() to flush changes to mmap()ed file
54 Returns: Nothing. Errors to syslog.
59 if (msync((void *)status_info, 0, 0) < 0)
61 syslog(LOG_ERR, "msync() failed: %s", strerror(errno));
65 /* find_host -------------------------------------------------------------- */
67 Purpose: Find the entry in the status file for a given host
68 Returns: Pointer to that entry in the mmap() region, or NULL.
69 Notes: Also creates entries if requested.
70 Failure to create also returns NULL.
73 HostInfo *find_host(char *hostname, int create)
76 HostInfo *spare_slot = NULL;
77 HostInfo *result = NULL;
80 for (i = 0, hp = status_info->hosts; i < status_info->noOfHosts; i++, hp++)
82 if (!strncasecmp(hostname, hp->hostname, SM_MAXSTRLEN))
87 if (!spare_slot && !hp->monList && !hp->notifyReqd)
91 /* Return if entry found, or if not asked to create one. */
92 if (result || !create) return (result);
94 /* Now create an entry, using the spare slot if one was found or */
95 /* adding to the end of the list otherwise, extending file if reqd */
99 spare_slot = &status_info->hosts[status_info->noOfHosts];
100 desired_size = ((char*)spare_slot - (char*)status_info) + sizeof(HostInfo);
101 if (desired_size > status_file_len)
103 /* Extend file by writing 1 byte of junk at the desired end pos */
104 lseek(status_fd, desired_size - 1, SEEK_SET);
105 i = write(status_fd, &i, 1);
108 syslog(LOG_ERR, "Unable to extend status file");
111 status_file_len = desired_size;
113 status_info->noOfHosts++;
116 /* Initialise the spare slot that has been found/created */
117 /* Note that we do not msync(), since the caller is presumed to be */
118 /* about to modify the entry further */
119 memset(spare_slot, 0, sizeof(HostInfo));
120 strncpy(spare_slot->hostname, hostname, SM_MAXSTRLEN);
124 /* init_file -------------------------------------------------------------- */
126 Purpose: Open file, create if necessary, initialise it.
127 Returns: Nothing - exits on error
128 Notes: Called before process becomes daemon, hence logs to
129 stderr rather than syslog.
130 Opens the file, then mmap()s it for ease of access.
131 Also performs initial clean-up of the file, zeroing
132 monitor list pointers, setting the notifyReqd flag in
133 all hosts that had a monitor list, and incrementing
134 the state number to the next even value.
137 void init_file(char *filename)
139 int new_file = FALSE;
140 char buf[HEADER_LEN];
143 /* try to open existing file - if not present, create one */
144 status_fd = open(filename, O_RDWR);
145 if ((status_fd < 0) && (errno == ENOENT))
147 status_fd = open(filename, O_RDWR | O_CREAT, 0644);
151 errx(1, "unable to open status file %s", filename);
153 /* File now open. mmap() it, with a generous size to allow for */
154 /* later growth, where we will extend the file but not re-map it. */
155 status_info = (FileLayout *)
156 mmap(NULL, 0x10000000, PROT_READ | PROT_WRITE, MAP_SHARED, status_fd, 0);
158 if (status_info == (FileLayout *) MAP_FAILED)
159 warn("unable to mmap() status file");
161 status_file_len = lseek(status_fd, 0L, SEEK_END);
163 /* If the file was not newly created, validate the contents, and if */
164 /* defective, re-create from scratch. */
167 if ((status_file_len < HEADER_LEN) || (status_file_len
168 < (HEADER_LEN + sizeof(HostInfo) * status_info->noOfHosts)) )
170 warnx("status file is corrupt");
175 /* Initialisation of a new, empty file. */
178 memset(buf, 0, sizeof(buf));
179 lseek(status_fd, 0L, SEEK_SET);
180 write(status_fd, buf, HEADER_LEN);
181 status_file_len = HEADER_LEN;
185 /* Clean-up of existing file - monitored hosts will have a pointer */
186 /* to a list of clients, which refers to memory in the previous */
187 /* incarnation of the program and so are meaningless now. These */
188 /* pointers are zeroed and the fact that the host was previously */
189 /* monitored is recorded by setting the notifyReqd flag, which will */
190 /* in due course cause a SM_NOTIFY to be sent. */
191 /* Note that if we crash twice in quick succession, some hosts may */
192 /* already have notifyReqd set, where we didn't manage to notify */
193 /* them before the second crash occurred. */
194 for (i = 0; i < status_info->noOfHosts; i++)
196 HostInfo *this_host = &status_info->hosts[i];
198 if (this_host->monList)
200 this_host->notifyReqd = TRUE;
201 this_host->monList = NULL;
204 /* Select the next higher even number for the state counter */
205 status_info->ourState = (status_info->ourState + 2) & 0xfffffffe;
206 /*???????******/ status_info->ourState++;
210 /* xdr_stat_chge ----------------------------------------------------------- */
212 Purpose: XDR-encode structure of type stat_chge
213 Returns: TRUE if successful
214 Notes: This function is missing from librpcsvc, because the
215 sm_inter.x distributed by Sun omits the SM_NOTIFY
216 procedure used between co-operating statd's
219 bool_t xdr_stat_chge(XDR *xdrs, stat_chge *objp)
221 if (!xdr_string(xdrs, &objp->mon_name, SM_MAXSTRLEN))
225 if (!xdr_int(xdrs, &objp->state))
233 /* notify_one_host --------------------------------------------------------- */
235 Purpose: Perform SM_NOTIFY procedure at specified host
236 Returns: TRUE if success, FALSE if failed.
239 static int notify_one_host(char *hostname)
241 struct timeval timeout = { 20, 0 }; /* 20 secs timeout */
245 char our_hostname[SM_MAXSTRLEN+1];
247 gethostname(our_hostname, sizeof(our_hostname));
248 our_hostname[SM_MAXSTRLEN] = '\0';
249 arg.mon_name = our_hostname;
250 arg.state = status_info->ourState;
252 if (debug) syslog (LOG_DEBUG, "Sending SM_NOTIFY to host %s from %s", hostname, our_hostname);
254 cli = clnt_create(hostname, SM_PROG, SM_VERS, "udp");
257 syslog(LOG_ERR, "Failed to contact host %s%s", hostname,
258 clnt_spcreateerror(""));
262 if (clnt_call(cli, SM_NOTIFY, xdr_stat_chge, &arg, xdr_void, &dummy, timeout)
265 syslog(LOG_ERR, "Failed to contact rpc.statd at host %s", hostname);
274 /* notify_hosts ------------------------------------------------------------ */
276 Purpose: Send SM_NOTIFY to all hosts marked as requiring it
277 Returns: Nothing, immediately - forks a process to do the work.
278 Notes: Does nothing if there are no monitored hosts.
279 Called after all the initialisation has been done -
283 void notify_hosts(void)
287 int work_to_do = FALSE;
291 /* First check if there is in fact any work to do. */
292 for (i = status_info->noOfHosts, hp = status_info->hosts; i ; i--, hp++)
301 if (!work_to_do) return; /* No work found */
306 syslog(LOG_ERR, "Unable to fork notify process - %s", strerror(errno));
311 /* Here in the child process. We continue until all the hosts marked */
312 /* as requiring notification have been duly notified. */
313 /* If one of the initial attempts fails, we sleep for a while and */
314 /* have another go. This is necessary because when we have crashed, */
315 /* (eg. a power outage) it is quite possible that we won't be able to */
316 /* contact all monitored hosts immediately on restart, either because */
317 /* they crashed too and take longer to come up (in which case the */
318 /* notification isn't really required), or more importantly if some */
319 /* router etc. needed to reach the monitored host has not come back */
320 /* up yet. In this case, we will be a bit late in re-establishing */
321 /* locks (after the grace period) but that is the best we can do. */
322 /* We try 10 times at 5 sec intervals, 10 more times at 1 minute */
323 /* intervals, then 24 more times at hourly intervals, finally */
324 /* giving up altogether if the host hasn't come back to life after */
327 for (attempts = 0; attempts < 44; attempts++)
329 work_to_do = FALSE; /* Unless anything fails */
330 for (i = status_info->noOfHosts, hp = status_info->hosts; i ; i--, hp++)
334 if (notify_one_host(hp->hostname))
336 hp->notifyReqd = FALSE;
339 else work_to_do = TRUE;
342 if (!work_to_do) break;
343 if (attempts < 10) sleep(5);
344 else if (attempts < 20) sleep(60);