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
35 static const char rcsid[] =
47 #include <netdb.h> /* for getaddrinfo() */
48 #include <sys/types.h>
49 #include <sys/socket.h>
50 #include <netinet/in.h>
51 #include <arpa/inet.h>
55 /* sm_check_hostname -------------------------------------------------------- */
57 * Purpose: Check `mon_name' member of sm_name struct to ensure that the array
58 * consists only of printable characters.
60 * Returns: TRUE if hostname is good. FALSE if hostname contains binary or
61 * otherwise non-printable characters.
63 * Notes: Will syslog(3) to warn of corrupt hostname.
66 int sm_check_hostname(struct svc_req *req, char *arg)
69 struct sockaddr_in *claddr;
73 dstlen = (4 * len) + 1;
75 claddr = svc_getcaller(req->rq_xprt);
78 if (claddr == NULL || dst == NULL)
82 else if (strvis(dst, arg, VIS_WHITE) != len)
85 "sm_stat: client %s hostname %s contained invalid characters.",
86 inet_ntoa(claddr->sin_addr),
94 /* sm_stat_1 --------------------------------------------------------------- */
96 Purpose: RPC call to enquire if a host can be monitored
97 Returns: TRUE for any hostname that can be looked up to give
101 struct sm_stat_res *sm_stat_1_svc(sm_name *arg, struct svc_req *req)
103 static sm_stat_res res;
105 struct sockaddr_in *claddr;
109 if ((err = sm_check_hostname(req, arg->mon_name)) == 0)
111 res.res_stat = stat_fail;
116 syslog(LOG_DEBUG, "stat called for host %s", arg->mon_name);
117 if (getaddrinfo(arg->mon_name, NULL, NULL, &ai) == 0) {
118 res.res_stat = stat_succ;
123 claddr = svc_getcaller(req->rq_xprt);
124 syslog(LOG_ERR, "invalid hostname to sm_stat from %s: %s",
125 inet_ntoa(claddr->sin_addr), arg->mon_name);
126 res.res_stat = stat_fail;
129 res.state = status_info->ourState;
133 /* sm_mon_1 ---------------------------------------------------------------- */
135 Purpose: RPC procedure to establish a monitor request
136 Returns: Success, unless lack of resources prevents
137 the necessary structures from being set up
138 to record the request, or if the hostname is not
139 valid (as judged by getaddrinfo())
142 struct sm_stat_res *sm_mon_1_svc(mon *arg, struct svc_req *req)
144 static sm_stat_res res;
150 if ((err = sm_check_hostname(req, arg->mon_id.mon_name)) == 0)
152 res.res_stat = stat_fail;
159 syslog(LOG_DEBUG, "monitor request for host %s", arg->mon_id.mon_name);
160 syslog(LOG_DEBUG, "recall host: %s prog: %d ver: %d proc: %d",
161 arg->mon_id.mon_name,
162 arg->mon_id.my_id.my_prog, arg->mon_id.my_id.my_vers,
163 arg->mon_id.my_id.my_proc);
165 res.res_stat = stat_fail; /* Assume fail until set otherwise */
166 res.state = status_info->ourState;
168 /* Find existing host entry, or create one if not found */
169 /* If find_host() fails, it will have logged the error already. */
170 if (getaddrinfo(arg->mon_id.mon_name, NULL, NULL, &ai) != 0)
172 syslog(LOG_ERR, "Invalid hostname to sm_mon: %s", arg->mon_id.mon_name);
176 if ((hp = find_host(arg->mon_id.mon_name, TRUE)))
178 lp = (MonList *)malloc(sizeof(MonList));
181 syslog(LOG_ERR, "Out of memory");
185 strncpy(lp->notifyHost, arg->mon_id.my_id.my_name, SM_MAXSTRLEN);
186 lp->notifyProg = arg->mon_id.my_id.my_prog;
187 lp->notifyVers = arg->mon_id.my_id.my_vers;
188 lp->notifyProc = arg->mon_id.my_id.my_proc;
189 memcpy(lp->notifyData, arg->priv, sizeof(lp->notifyData));
191 lp->next = hp->monList;
195 res.res_stat = stat_succ; /* Report success */
202 /* do_unmon ---------------------------------------------------------------- */
204 Purpose: Remove a monitor request from a host
205 Returns: TRUE if found, FALSE if not found.
206 Notes: Common code from sm_unmon_1_svc and sm_unmon_all_1_svc
207 In the unlikely event of more than one identical monitor
208 request, all are removed.
211 static int do_unmon(HostInfo *hp, my_id *idp)
214 MonList *last = NULL;
220 if (!strncasecmp(idp->my_name, lp->notifyHost, SM_MAXSTRLEN)
221 && (idp->my_prog == lp->notifyProg) && (idp->my_proc == lp->notifyProc)
222 && (idp->my_vers == lp->notifyVers))
224 /* found one. Unhook from chain and free. */
226 if (last) last->next = next;
227 else hp->monList = next;
241 /* sm_unmon_1 -------------------------------------------------------------- */
243 Purpose: RPC procedure to release a monitor request.
244 Returns: Local machine's status number
245 Notes: The supplied mon_id should match the value passed in an
246 earlier call to sm_mon_1
249 struct sm_stat *sm_unmon_1_svc(mon_id *arg, struct svc_req *req __unused)
256 syslog(LOG_DEBUG, "un-monitor request for host %s", arg->mon_name);
257 syslog(LOG_DEBUG, "recall host: %s prog: %d ver: %d proc: %d",
259 arg->my_id.my_prog, arg->my_id.my_vers, arg->my_id.my_proc);
262 if ((hp = find_host(arg->mon_name, FALSE)))
264 if (do_unmon(hp, &arg->my_id)) sync_file();
267 syslog(LOG_ERR, "unmon request from %s, no matching monitor",
271 else syslog(LOG_ERR, "unmon request from %s for unknown host %s",
272 arg->my_id.my_name, arg->mon_name);
274 res.state = status_info->ourState;
279 /* sm_unmon_all_1 ---------------------------------------------------------- */
281 Purpose: RPC procedure to release monitor requests.
282 Returns: Local machine's status number
283 Notes: Releases all monitor requests (if any) from the specified
284 host and program number.
287 struct sm_stat *sm_unmon_all_1_svc(my_id *arg, struct svc_req *req __unused)
295 syslog(LOG_DEBUG, "unmon_all for host: %s prog: %d ver: %d proc: %d",
296 arg->my_name, arg->my_prog, arg->my_vers, arg->my_proc);
299 for (i = status_info->noOfHosts, hp = status_info->hosts; i; i--, hp++)
305 res.state = status_info->ourState;
310 /* sm_simu_crash_1 --------------------------------------------------------- */
312 Purpose: RPC procedure to simulate a crash
314 Notes: Standardised mechanism for debug purposes
315 The specification says that we should drop all of our
316 status information (apart from the list of monitored hosts
317 on disc). However, this would confuse the rpc.lockd
318 which would be unaware that all of its monitor requests
319 had been silently junked. Hence we in fact retain all
320 current requests and simply increment the status counter
321 and inform all hosts on the monitor list.
324 void *sm_simu_crash_1_svc(void *v __unused, struct svc_req *req __unused)
331 if (debug) syslog(LOG_DEBUG, "simu_crash called!!");
333 /* Simulate crash by setting notify-required flag on all monitored */
334 /* hosts, and incrementing our status number. notify_hosts() is */
335 /* then called to fork a process to do the notifications. */
337 for (i = status_info->noOfHosts, hp = status_info->hosts; i ; i--, hp++)
342 hp->notifyReqd = TRUE;
345 status_info->ourState += 2; /* always even numbers if not crashed */
347 if (work_to_do) notify_hosts();
352 /* sm_notify_1 ------------------------------------------------------------- */
354 Purpose: RPC procedure notifying local statd of the crash of another
356 Notes: There is danger of deadlock, since it is quite likely that
357 the client procedure that we call will in turn call us
358 to remove or adjust the monitor request.
359 We therefore fork() a process to do the notifications.
360 Note that the main HostInfo structure is in a mmap()
361 region and so will be shared with the child, but the
362 monList pointed to by the HostInfo is in normal memory.
363 Hence if we read the monList before forking, we are
364 protected from the parent servicing other requests
365 that modify the list.
368 void *sm_notify_1_svc(stat_chge *arg, struct svc_req *req __unused)
370 struct timeval timeout = { 20, 0 }; /* 20 secs timeout */
373 sm_status tx_arg; /* arg sent to callback procedure */
378 if (debug) syslog(LOG_DEBUG, "notify from host %s, new state %d",
379 arg->mon_name, arg->state);
381 hp = find_host(arg->mon_name, FALSE);
384 /* Never heard of this host - why is it notifying us? */
385 syslog(LOG_ERR, "Unsolicited notification from host %s", arg->mon_name);
389 if (!lp) return (&dummy); /* We know this host, but have no */
390 /* outstanding requests. */
394 syslog(LOG_ERR, "Unable to fork notify process - %s", strerror(errno));
395 return (NULL); /* no answer, the client will retry */
397 if (pid) return (&dummy); /* Parent returns */
401 tx_arg.mon_name = arg->mon_name;
402 tx_arg.state = arg->state;
403 memcpy(tx_arg.priv, lp->notifyData, sizeof(tx_arg.priv));
404 cli = clnt_create(lp->notifyHost, lp->notifyProg, lp->notifyVers, "udp");
407 syslog(LOG_ERR, "Failed to contact host %s%s", lp->notifyHost,
408 clnt_spcreateerror(""));
412 if (clnt_call(cli, lp->notifyProc, (xdrproc_t)xdr_sm_status, &tx_arg,
413 (xdrproc_t)xdr_void, &dummy, timeout) != RPC_SUCCESS)
415 syslog(LOG_ERR, "Failed to call rpc.statd client at host %s",
423 exit (0); /* Child quits */