2 * SPDX-License-Identifier: BSD-4-Clause
5 * A.R. Gordon (andrew.gordon@net-tel.co.uk). All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 * 3. All advertising materials mentioning features or use of this software
16 * must display the following acknowledgement:
17 * This product includes software developed for the FreeBSD project
18 * 4. Neither the name of the author nor the names of any co-contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY ANDREW GORDON AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
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>
57 struct sockaddr *saddr;
59 static char inet_buf[INET6_ADDRSTRLEN];
61 if (getnameinfo(saddr, saddr->sa_len, inet_buf, sizeof(inet_buf),
62 NULL, 0, NI_NUMERICHOST) == 0)
67 /* sm_check_hostname -------------------------------------------------------- */
69 * Purpose: Check `mon_name' member of sm_name struct to ensure that the array
70 * consists only of printable characters.
72 * Returns: TRUE if hostname is good. FALSE if hostname contains binary or
73 * otherwise non-printable characters.
75 * Notes: Will syslog(3) to warn of corrupt hostname.
78 int sm_check_hostname(struct svc_req *req, char *arg)
81 struct sockaddr *claddr;
85 dstlen = (4 * len) + 1;
87 claddr = (struct sockaddr *) (svc_getrpccaller(req->rq_xprt)->buf) ;
90 if (claddr == NULL || dst == NULL)
94 else if (strvis(dst, arg, VIS_WHITE) != len)
97 "sm_stat: client %s hostname %s contained invalid characters.",
106 /* sm_stat_1 --------------------------------------------------------------- */
108 Purpose: RPC call to enquire if a host can be monitored
109 Returns: TRUE for any hostname that can be looked up to give
113 struct sm_stat_res *sm_stat_1_svc(sm_name *arg, struct svc_req *req)
115 static sm_stat_res res;
117 struct sockaddr *claddr;
121 if ((err = sm_check_hostname(req, arg->mon_name)) == 0)
123 res.res_stat = stat_fail;
128 syslog(LOG_DEBUG, "stat called for host %s", arg->mon_name);
129 if (getaddrinfo(arg->mon_name, NULL, NULL, &ai) == 0) {
130 res.res_stat = stat_succ;
135 claddr = (struct sockaddr *) (svc_getrpccaller(req->rq_xprt)->buf) ;
136 syslog(LOG_ERR, "invalid hostname to sm_stat from %s: %s",
137 from_addr(claddr), arg->mon_name);
138 res.res_stat = stat_fail;
141 res.state = status_info->ourState;
145 /* sm_mon_1 ---------------------------------------------------------------- */
147 Purpose: RPC procedure to establish a monitor request
148 Returns: Success, unless lack of resources prevents
149 the necessary structures from being set up
150 to record the request, or if the hostname is not
151 valid (as judged by getaddrinfo())
154 struct sm_stat_res *sm_mon_1_svc(mon *arg, struct svc_req *req)
156 static sm_stat_res res;
162 if ((err = sm_check_hostname(req, arg->mon_id.mon_name)) == 0)
164 res.res_stat = stat_fail;
171 syslog(LOG_DEBUG, "monitor request for host %s", arg->mon_id.mon_name);
172 syslog(LOG_DEBUG, "recall host: %s prog: %d ver: %d proc: %d",
173 arg->mon_id.my_id.my_name,
174 arg->mon_id.my_id.my_prog,
175 arg->mon_id.my_id.my_vers,
176 arg->mon_id.my_id.my_proc);
178 res.res_stat = stat_fail; /* Assume fail until set otherwise */
179 res.state = status_info->ourState;
181 /* Find existing host entry, or create one if not found */
182 /* If find_host() fails, it will have logged the error already. */
183 if (getaddrinfo(arg->mon_id.mon_name, NULL, NULL, &ai) != 0)
185 syslog(LOG_ERR, "Invalid hostname to sm_mon: %s", arg->mon_id.mon_name);
189 if ((hp = find_host(arg->mon_id.mon_name, TRUE)))
191 lp = (MonList *)malloc(sizeof(MonList));
194 syslog(LOG_ERR, "Out of memory");
198 strncpy(lp->notifyHost, arg->mon_id.my_id.my_name, SM_MAXSTRLEN);
199 lp->notifyProg = arg->mon_id.my_id.my_prog;
200 lp->notifyVers = arg->mon_id.my_id.my_vers;
201 lp->notifyProc = arg->mon_id.my_id.my_proc;
202 memcpy(lp->notifyData, arg->priv, sizeof(lp->notifyData));
204 lp->next = hp->monList;
208 res.res_stat = stat_succ; /* Report success */
215 /* do_unmon ---------------------------------------------------------------- */
217 Purpose: Remove a monitor request from a host
218 Returns: TRUE if found, FALSE if not found.
219 Notes: Common code from sm_unmon_1_svc and sm_unmon_all_1_svc
220 In the unlikely event of more than one identical monitor
221 request, all are removed.
224 static int do_unmon(HostInfo *hp, my_id *idp)
227 MonList *last = NULL;
233 if (!strncasecmp(idp->my_name, lp->notifyHost, SM_MAXSTRLEN)
234 && (idp->my_prog == lp->notifyProg) && (idp->my_proc == lp->notifyProc)
235 && (idp->my_vers == lp->notifyVers))
237 /* found one. Unhook from chain and free. */
239 if (last) last->next = next;
240 else hp->monList = next;
254 /* sm_unmon_1 -------------------------------------------------------------- */
256 Purpose: RPC procedure to release a monitor request.
257 Returns: Local machine's status number
258 Notes: The supplied mon_id should match the value passed in an
259 earlier call to sm_mon_1
262 struct sm_stat *sm_unmon_1_svc(mon_id *arg, struct svc_req *req __unused)
269 syslog(LOG_DEBUG, "un-monitor request for host %s", arg->mon_name);
270 syslog(LOG_DEBUG, "recall host: %s prog: %d ver: %d proc: %d",
272 arg->my_id.my_prog, arg->my_id.my_vers, arg->my_id.my_proc);
275 if ((hp = find_host(arg->mon_name, FALSE)))
277 if (do_unmon(hp, &arg->my_id)) sync_file();
280 syslog(LOG_ERR, "unmon request from %s, no matching monitor",
284 else syslog(LOG_ERR, "unmon request from %s for unknown host %s",
285 arg->my_id.my_name, arg->mon_name);
287 res.state = status_info->ourState;
292 /* sm_unmon_all_1 ---------------------------------------------------------- */
294 Purpose: RPC procedure to release monitor requests.
295 Returns: Local machine's status number
296 Notes: Releases all monitor requests (if any) from the specified
297 host and program number.
300 struct sm_stat *sm_unmon_all_1_svc(my_id *arg, struct svc_req *req __unused)
308 syslog(LOG_DEBUG, "unmon_all for host: %s prog: %d ver: %d proc: %d",
309 arg->my_name, arg->my_prog, arg->my_vers, arg->my_proc);
312 for (i = status_info->noOfHosts, hp = status_info->hosts; i; i--, hp++)
318 res.state = status_info->ourState;
323 /* sm_simu_crash_1 --------------------------------------------------------- */
325 Purpose: RPC procedure to simulate a crash
327 Notes: Standardised mechanism for debug purposes
328 The specification says that we should drop all of our
329 status information (apart from the list of monitored hosts
330 on disc). However, this would confuse the rpc.lockd
331 which would be unaware that all of its monitor requests
332 had been silently junked. Hence we in fact retain all
333 current requests and simply increment the status counter
334 and inform all hosts on the monitor list.
337 void *sm_simu_crash_1_svc(void *v __unused, struct svc_req *req __unused)
345 if (debug) syslog(LOG_DEBUG, "simu_crash called!!");
347 /* Simulate crash by setting notify-required flag on all monitored */
348 /* hosts, and incrementing our status number. notify_hosts() is */
349 /* then called to fork a process to do the notifications. */
351 for (i = status_info->noOfHosts, hp = status_info->hosts; i ; i--, hp++)
356 hp->notifyReqd = TRUE;
359 status_info->ourState += 2; /* always even numbers if not crashed */
361 if (work_to_do) notify_hosts();
366 /* sm_notify_1 ------------------------------------------------------------- */
368 Purpose: RPC procedure notifying local statd of the crash of another
370 Notes: There is danger of deadlock, since it is quite likely that
371 the client procedure that we call will in turn call us
372 to remove or adjust the monitor request.
373 We therefore fork() a process to do the notifications.
374 Note that the main HostInfo structure is in a mmap()
375 region and so will be shared with the child, but the
376 monList pointed to by the HostInfo is in normal memory.
377 Hence if we read the monList before forking, we are
378 protected from the parent servicing other requests
379 that modify the list.
382 void *sm_notify_1_svc(stat_chge *arg, struct svc_req *req __unused)
384 struct timeval timeout = { 20, 0 }; /* 20 secs timeout */
387 sm_status tx_arg; /* arg sent to callback procedure */
392 if (debug) syslog(LOG_DEBUG, "notify from host %s, new state %d",
393 arg->mon_name, arg->state);
395 hp = find_host(arg->mon_name, FALSE);
398 /* Never heard of this host - why is it notifying us? */
399 syslog(LOG_ERR, "Unsolicited notification from host %s", arg->mon_name);
403 if (!lp) return (&dummy); /* We know this host, but have no */
404 /* outstanding requests. */
408 syslog(LOG_ERR, "Unable to fork notify process - %s", strerror(errno));
409 return (NULL); /* no answer, the client will retry */
411 if (pid) return (&dummy); /* Parent returns */
415 tx_arg.mon_name = arg->mon_name;
416 tx_arg.state = arg->state;
417 memcpy(tx_arg.priv, lp->notifyData, sizeof(tx_arg.priv));
418 cli = clnt_create(lp->notifyHost, lp->notifyProg, lp->notifyVers, "udp");
421 syslog(LOG_ERR, "Failed to contact host %s%s", lp->notifyHost,
422 clnt_spcreateerror(""));
426 if (clnt_call(cli, lp->notifyProc, (xdrproc_t)xdr_sm_status, &tx_arg,
427 (xdrproc_t)xdr_void, &dummy, timeout) != RPC_SUCCESS)
429 syslog(LOG_ERR, "Failed to call rpc.statd client at host %s",
437 exit (0); /* Child quits */