2 * network.c -- Provide common network functions for NFS mount/umount
4 * Copyright (C) 2007 Oracle. All rights reserved.
5 * Copyright (C) 2007 Chuck Lever <chuck.lever@oracle.com>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
17 * You should have received a copy of the GNU General Public
18 * License along with this program; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 021110-1307, USA.
37 #include <sys/types.h>
38 #include <sys/socket.h>
40 #include <netinet/in.h>
42 #include <rpc/pmap_prot.h>
43 #include <rpc/pmap_clnt.h>
48 #include "nfs_mount.h"
49 #include "mount_constants.h"
51 #include "parse_opt.h"
55 #define PMAP_TIMEOUT (10)
56 #define CONNECT_TIMEOUT (20)
57 #define MOUNT_TIMEOUT (30)
59 #if SIZEOF_SOCKLEN_T - 0 == 0
60 #define socklen_t unsigned int
63 extern int nfs_mount_data_version;
64 extern char *progname;
67 static const char *nfs_ns_pgmtbl[] = {
72 static const char *nfs_mnt_pgmtbl[] = {
78 static const char *nfs_nfs_pgmtbl[] = {
84 static const char *nfs_transport_opttbl[] = {
91 static const char *nfs_version_opttbl[] = {
100 static const unsigned long nfs_to_mnt[] = {
107 static const unsigned long mnt_to_nfs[] = {
115 * Map an NFS version into the corresponding Mountd version
117 unsigned long nfsvers_to_mnt(const unsigned long vers)
120 return nfs_to_mnt[vers];
125 * Map a Mountd version into the corresponding NFS version
127 static unsigned long mntvers_to_nfs(const unsigned long vers)
130 return mnt_to_nfs[vers];
134 static const unsigned int probe_udp_only[] = {
139 static const unsigned int probe_udp_first[] = {
145 static const unsigned int probe_tcp_first[] = {
151 static const unsigned long probe_nfs2_only[] = {
156 static const unsigned long probe_nfs3_first[] = {
162 static const unsigned long probe_mnt1_first[] = {
168 static const unsigned long probe_mnt3_first[] = {
175 static const unsigned int *nfs_default_proto(void);
177 static const unsigned int *nfs_default_proto()
179 extern unsigned long config_default_proto;
181 * If the default proto has been set and
182 * its not TCP, start with UDP
184 if (config_default_proto && config_default_proto != IPPROTO_TCP)
185 return probe_udp_first;
187 return probe_tcp_first;
190 static const unsigned int *nfs_default_proto()
192 return probe_tcp_first;
194 #endif /* MOUNT_CONFIG */
197 * nfs_lookup - resolve hostname to an IPv4 or IPv6 socket address
198 * @hostname: pointer to C string containing DNS hostname to resolve
199 * @family: address family hint
200 * @sap: pointer to buffer to fill with socket address
201 * @len: IN: size of buffer to fill; OUT: size of socket address
203 * Returns 1 and places a socket address at @sap if successful;
206 int nfs_lookup(const char *hostname, const sa_family_t family,
207 struct sockaddr *sap, socklen_t *salen)
209 struct addrinfo *gai_results;
210 struct addrinfo gai_hint = {
211 #ifdef HAVE_DECL_AI_ADDRCONFIG
212 .ai_flags = AI_ADDRCONFIG,
213 #endif /* HAVE_DECL_AI_ADDRCONFIG */
216 socklen_t len = *salen;
221 error = getaddrinfo(hostname, NULL, &gai_hint, &gai_results);
226 nfs_error(_("%s: DNS resolution failed for %s: %s"),
227 progname, hostname, strerror(errno));
230 nfs_error(_("%s: DNS resolution failed for %s: %s"),
231 progname, hostname, gai_strerror(error));
235 switch (gai_results->ai_addr->sa_family) {
238 if (len >= gai_results->ai_addrlen) {
239 *salen = gai_results->ai_addrlen;
240 memcpy(sap, gai_results->ai_addr, *salen);
245 /* things are really broken if we get here, so warn */
246 nfs_error(_("%s: unrecognized DNS resolution results for %s"),
251 freeaddrinfo(gai_results);
256 * nfs_name_to_address - resolve hostname to an IPv4 or IPv6 socket address
257 * @hostname: pointer to C string containing DNS hostname to resolve
258 * @sap: pointer to buffer to fill with socket address
259 * @len: IN: size of buffer to fill; OUT: size of socket address
261 * Returns 1 and places a socket address at @sap if successful;
264 int nfs_name_to_address(const char *hostname,
265 struct sockaddr *sap, socklen_t *salen)
267 #ifdef IPV6_SUPPORTED
268 return nfs_lookup(hostname, AF_UNSPEC, sap, salen);
269 #else /* !IPV6_SUPPORTED */
270 return nfs_lookup(hostname, AF_INET, sap, salen);
271 #endif /* !IPV6_SUPPORTED */
275 * nfs_gethostbyname - resolve a hostname to an IPv4 address
276 * @hostname: pointer to a C string containing a DNS hostname
277 * @sin: returns an IPv4 address
279 * Returns 1 if successful, otherwise zero.
281 int nfs_gethostbyname(const char *hostname, struct sockaddr_in *sin)
283 socklen_t len = sizeof(*sin);
285 return nfs_lookup(hostname, AF_INET, (struct sockaddr *)sin, &len);
289 * nfs_string_to_sockaddr - convert string address to sockaddr
290 * @address: pointer to presentation format address to convert
291 * @sap: pointer to socket address buffer to fill in
292 * @salen: IN: length of address buffer
293 * OUT: length of converted socket address
295 * Convert a presentation format address string to a socket address.
296 * Similar to nfs_name_to_address(), but the DNS query is squelched,
297 * and won't make any noise if the getaddrinfo() call fails.
299 * Returns 1 and fills in @sap and @salen if successful; otherwise zero.
301 * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
302 * on presenting IPv6 addresses as text strings.
304 int nfs_string_to_sockaddr(const char *address, struct sockaddr *sap,
307 struct addrinfo *gai_results;
308 struct addrinfo gai_hint = {
309 .ai_flags = AI_NUMERICHOST,
311 socklen_t len = *salen;
316 if (getaddrinfo(address, NULL, &gai_hint, &gai_results) == 0) {
317 switch (gai_results->ai_addr->sa_family) {
320 if (len >= gai_results->ai_addrlen) {
321 *salen = gai_results->ai_addrlen;
322 memcpy(sap, gai_results->ai_addr, *salen);
327 freeaddrinfo(gai_results);
334 * nfs_present_sockaddr - convert sockaddr to string
335 * @sap: pointer to socket address to convert
336 * @salen: length of socket address
337 * @buf: pointer to buffer to fill in
338 * @buflen: length of buffer
340 * Convert the passed-in sockaddr-style address to presentation format.
341 * The presentation format address is placed in @buf and is
344 * Returns 1 if successful; otherwise zero.
346 * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
347 * on presenting IPv6 addresses as text strings.
349 int nfs_present_sockaddr(const struct sockaddr *sap, const socklen_t salen,
350 char *buf, const size_t buflen)
352 #ifdef HAVE_GETNAMEINFO
355 result = getnameinfo(sap, salen, buf, buflen,
356 NULL, 0, NI_NUMERICHOST);
360 nfs_error(_("%s: invalid server address: %s"), progname,
361 gai_strerror(result));
363 #else /* HAVE_GETNAMEINFO */
366 if (sap->sa_family == AF_INET) {
367 addr = inet_ntoa(((struct sockaddr_in *)sap)->sin_addr);
368 if (addr && strlen(addr) < buflen) {
374 nfs_error(_("%s: invalid server address"), progname);
376 #endif /* HAVE_GETNAMEINFO */
380 * Attempt to connect a socket, but time out after "timeout" seconds.
382 * On error return, caller closes the socket.
384 static int connect_to(int fd, struct sockaddr *addr,
385 socklen_t addrlen, int timeout)
389 struct timeval tv = {
393 saved = fcntl(fd, F_GETFL, 0);
394 fcntl(fd, F_SETFL, saved | O_NONBLOCK);
396 ret = connect(fd, addr, addrlen);
397 if (ret < 0 && errno != EINPROGRESS)
405 ret = select(fd + 1, &rset, &wset, NULL, &tv);
410 if (FD_ISSET(fd, &rset) || FD_ISSET(fd, &wset)) {
412 socklen_t len = sizeof(error);
413 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0)
423 fcntl(fd, F_SETFL, saved);
428 * Create a socket that is locally bound to a reserved or non-reserved port.
430 * The caller should check rpc_createerr to determine the cause of any error.
432 static int get_socket(struct sockaddr_in *saddr, unsigned int p_prot,
433 unsigned int timeout, int resvp, int conn)
436 struct sockaddr_in laddr;
437 socklen_t namelen = sizeof(laddr);
439 type = (p_prot == IPPROTO_UDP ? SOCK_DGRAM : SOCK_STREAM);
440 if ((so = socket (AF_INET, type, p_prot)) < 0)
443 laddr.sin_family = AF_INET;
445 laddr.sin_addr.s_addr = htonl(INADDR_ANY);
447 if (bindresvport(so, &laddr) < 0)
448 goto err_bindresvport;
450 cc = bind(so, (struct sockaddr *)&laddr, namelen);
454 if (type == SOCK_STREAM || (conn && type == SOCK_DGRAM)) {
455 cc = connect_to(so, (struct sockaddr *)saddr, namelen,
463 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
464 rpc_createerr.cf_error.re_errno = errno;
466 nfs_error(_("%s: Unable to create %s socket: errno %d (%s)\n"),
467 progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
468 errno, strerror(errno));
473 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
474 rpc_createerr.cf_error.re_errno = errno;
476 nfs_error(_("%s: Unable to bindresvport %s socket: errno %d"
478 progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
479 errno, strerror(errno));
485 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
486 rpc_createerr.cf_error.re_errno = errno;
488 nfs_error(_("%s: Unable to bind to %s socket: errno %d (%s)\n"),
489 progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
490 errno, strerror(errno));
496 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
497 rpc_createerr.cf_error.re_errno = errno;
499 nfs_error(_("%s: Unable to connect to %s:%d, errno %d (%s)\n"),
500 progname, inet_ntoa(saddr->sin_addr),
501 ntohs(saddr->sin_port), errno, strerror(errno));
507 static void nfs_pp_debug(const struct sockaddr *sap, const socklen_t salen,
508 const rpcprog_t program, const rpcvers_t version,
509 const unsigned short protocol,
510 const unsigned short port)
512 char buf[NI_MAXHOST];
517 if (nfs_present_sockaddr(sap, salen, buf, sizeof(buf)) == 0) {
519 strcat(buf, "unknown host");
522 fprintf(stderr, _("%s: trying %s prog %lu vers %lu prot %s port %d\n"),
523 progname, buf, (unsigned long)program,
524 (unsigned long)version,
525 (protocol == IPPROTO_UDP ? _("UDP") : _("TCP")),
529 static void nfs_pp_debug2(const char *str)
534 if (rpc_createerr.cf_error.re_status == RPC_CANTRECV ||
535 rpc_createerr.cf_error.re_status == RPC_CANTSEND)
536 nfs_error(_("%s: portmap query %s%s - %s"),
537 progname, str, clnt_spcreateerror(""),
538 strerror(rpc_createerr.cf_error.re_errno));
540 nfs_error(_("%s: portmap query %s%s"),
541 progname, str, clnt_spcreateerror(""));
545 * Use the portmapper to discover whether or not the service we want is
546 * available. The lists 'versions' and 'protos' define ordered sequences
547 * of service versions and udp/tcp protocols to probe for.
549 * Returns 1 if the requested service port is unambiguous and pingable;
550 * @pmap is filled in with the version, port, and transport protocol used
551 * during the successful ping. Note that if a port is already specified
552 * in @pmap and it matches the rpcbind query result, nfs_probe_port() does
553 * not perform an RPC ping.
555 * If an error occurs or the requested service isn't available, zero is
556 * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
558 static int nfs_probe_port(const struct sockaddr *sap, const socklen_t salen,
559 struct pmap *pmap, const unsigned long *versions,
560 const unsigned int *protos)
562 struct sockaddr_storage address;
563 struct sockaddr *saddr = (struct sockaddr *)&address;
564 const unsigned long prog = pmap->pm_prog, *p_vers;
565 const unsigned int prot = (u_int)pmap->pm_prot, *p_prot;
566 const u_short port = (u_short) pmap->pm_port;
567 unsigned long vers = pmap->pm_vers;
568 unsigned short p_port;
570 memcpy(saddr, sap, salen);
571 p_prot = prot ? &prot : protos;
572 p_vers = vers ? &vers : versions;
576 printf(_("%s: prog %lu, trying vers=%lu, prot=%u\n"),
577 progname, prog, *p_vers, *p_prot);
578 p_port = nfs_getport(saddr, salen, prog, *p_vers, *p_prot);
580 if (!port || port == p_port) {
581 nfs_set_port(saddr, p_port);
582 nfs_pp_debug(saddr, salen, prog, *p_vers,
584 if (nfs_rpc_ping(saddr, salen, prog,
585 *p_vers, *p_prot, NULL))
588 rpc_createerr.cf_stat = RPC_PROGNOTREGISTERED;
590 if (rpc_createerr.cf_stat != RPC_PROGNOTREGISTERED &&
591 rpc_createerr.cf_stat != RPC_TIMEDOUT &&
592 rpc_createerr.cf_stat != RPC_CANTRECV &&
593 rpc_createerr.cf_stat != RPC_PROGVERSMISMATCH)
598 nfs_pp_debug2("retrying");
603 if (rpc_createerr.cf_stat == RPC_TIMEDOUT ||
604 rpc_createerr.cf_stat == RPC_CANTRECV)
607 if (vers || !*++p_vers)
611 nfs_pp_debug2("failed");
616 pmap->pm_vers = *p_vers;
618 pmap->pm_prot = *p_prot;
620 pmap->pm_port = p_port;
621 nfs_clear_rpc_createerr();
625 * Probe a server's NFS service to determine which versions and
626 * transport protocols are supported.
628 * Returns 1 if the requested service port is unambiguous and pingable;
629 * @pmap is filled in with the version, port, and transport protocol used
630 * during the successful ping. If all three are already specified, simply
631 * return success without an rpcbind query or RPC ping (we may be trying
632 * to mount an NFS service that is not advertised via rpcbind).
634 * If an error occurs or the requested service isn't available, zero is
635 * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
637 static int nfs_probe_nfsport(const struct sockaddr *sap, const socklen_t salen,
640 if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
643 if (nfs_mount_data_version >= 4) {
644 const unsigned int *probe_proto;
646 probe_proto = nfs_default_proto();
648 return nfs_probe_port(sap, salen, pmap,
649 probe_nfs3_first, probe_proto);
651 return nfs_probe_port(sap, salen, pmap,
652 probe_nfs2_only, probe_udp_only);
656 * Probe a server's mountd service to determine which versions and
657 * transport protocols are supported.
659 * Returns 1 if the requested service port is unambiguous and pingable;
660 * @pmap is filled in with the version, port, and transport protocol used
661 * during the successful ping. If all three are already specified, simply
662 * return success without an rpcbind query or RPC ping (we may be trying
663 * to mount an NFS service that is not advertised via rpcbind).
665 * If an error occurs or the requested service isn't available, zero is
666 * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
668 static int nfs_probe_mntport(const struct sockaddr *sap, const socklen_t salen,
671 if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
674 if (nfs_mount_data_version >= 4)
675 return nfs_probe_port(sap, salen, pmap,
676 probe_mnt3_first, probe_udp_first);
678 return nfs_probe_port(sap, salen, pmap,
679 probe_mnt1_first, probe_udp_only);
683 * Probe a server's mountd service to determine which versions and
684 * transport protocols are supported. Invoked when the protocol
685 * version is already known for both the NFS and mountd service.
687 * Returns 1 and fills in both @pmap structs if the requested service
688 * ports are unambiguous and pingable. Otherwise zero is returned;
689 * rpccreateerr.cf_stat is set to reflect the nature of the error.
691 static int nfs_probe_version_fixed(const struct sockaddr *mnt_saddr,
692 const socklen_t mnt_salen,
693 struct pmap *mnt_pmap,
694 const struct sockaddr *nfs_saddr,
695 const socklen_t nfs_salen,
696 struct pmap *nfs_pmap)
698 if (!nfs_probe_nfsport(nfs_saddr, nfs_salen, nfs_pmap))
700 return nfs_probe_mntport(mnt_saddr, mnt_salen, mnt_pmap);
704 * nfs_probe_bothports - discover the RPC endpoints of mountd and NFS server
705 * @mnt_saddr: pointer to socket address of mountd server
706 * @mnt_salen: length of mountd server's address
707 * @mnt_pmap: IN: partially filled-in mountd RPC service tuple;
708 * OUT: fully filled-in mountd RPC service tuple
709 * @nfs_saddr: pointer to socket address of NFS server
710 * @nfs_salen: length of NFS server's address
711 * @nfs_pmap: IN: partially filled-in NFS RPC service tuple;
712 * OUT: fully filled-in NFS RPC service tuple
714 * Returns 1 and fills in both @pmap structs if the requested service
715 * ports are unambiguous and pingable. Otherwise zero is returned;
716 * rpccreateerr.cf_stat is set to reflect the nature of the error.
718 int nfs_probe_bothports(const struct sockaddr *mnt_saddr,
719 const socklen_t mnt_salen,
720 struct pmap *mnt_pmap,
721 const struct sockaddr *nfs_saddr,
722 const socklen_t nfs_salen,
723 struct pmap *nfs_pmap)
725 struct pmap save_nfs, save_mnt;
726 const unsigned long *probe_vers;
728 if (mnt_pmap->pm_vers && !nfs_pmap->pm_vers)
729 nfs_pmap->pm_vers = mntvers_to_nfs(mnt_pmap->pm_vers);
730 else if (nfs_pmap->pm_vers && !mnt_pmap->pm_vers)
731 mnt_pmap->pm_vers = nfsvers_to_mnt(nfs_pmap->pm_vers);
733 if (nfs_pmap->pm_vers)
734 return nfs_probe_version_fixed(mnt_saddr, mnt_salen, mnt_pmap,
735 nfs_saddr, nfs_salen, nfs_pmap);
737 memcpy(&save_nfs, nfs_pmap, sizeof(save_nfs));
738 memcpy(&save_mnt, mnt_pmap, sizeof(save_mnt));
739 probe_vers = (nfs_mount_data_version >= 4) ?
740 probe_mnt3_first : probe_mnt1_first;
742 for (; *probe_vers; probe_vers++) {
743 nfs_pmap->pm_vers = mntvers_to_nfs(*probe_vers);
744 if (nfs_probe_nfsport(nfs_saddr, nfs_salen, nfs_pmap) != 0) {
745 mnt_pmap->pm_vers = *probe_vers;
746 if (nfs_probe_mntport(mnt_saddr, mnt_salen, mnt_pmap) != 0)
748 memcpy(mnt_pmap, &save_mnt, sizeof(*mnt_pmap));
750 switch (rpc_createerr.cf_stat) {
751 case RPC_PROGVERSMISMATCH:
752 case RPC_PROGNOTREGISTERED:
757 memcpy(nfs_pmap, &save_nfs, sizeof(*nfs_pmap));
764 * probe_bothports - discover the RPC endpoints of mountd and NFS server
765 * @mnt_server: pointer to address and pmap argument for mountd results
766 * @nfs_server: pointer to address and pmap argument for NFS server
768 * This is the legacy API that takes "clnt_addr_t" for both servers,
769 * but supports only AF_INET addresses.
771 * Returns 1 and fills in the pmap field in both clnt_addr_t structs
772 * if the requested service ports are unambiguous and pingable.
773 * Otherwise zero is returned; rpccreateerr.cf_stat is set to reflect
774 * the nature of the error.
776 int probe_bothports(clnt_addr_t *mnt_server, clnt_addr_t *nfs_server)
778 return nfs_probe_bothports((struct sockaddr *)&mnt_server->saddr,
779 sizeof(mnt_server->saddr),
781 (struct sockaddr *)&nfs_server->saddr,
782 sizeof(nfs_server->saddr),
786 static int nfs_probe_statd(void)
788 struct sockaddr_in addr = {
789 .sin_family = AF_INET,
790 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
792 rpcprog_t program = nfs_getrpcbyname(NSMPROG, nfs_ns_pgmtbl);
794 return nfs_getport_ping((struct sockaddr *)&addr, sizeof(addr),
795 program, (rpcvers_t)1, IPPROTO_UDP);
799 * start_statd - attempt to start rpc.statd
801 * Returns 1 if statd is running; otherwise zero.
803 int start_statd(void)
809 if (nfs_probe_statd())
813 if (stat(START_STATD, &stb) == 0) {
814 if (S_ISREG(stb.st_mode) && (stb.st_mode & S_IXUSR)) {
818 execl(START_STATD, START_STATD, NULL);
821 nfs_error(_("%s: fork failed: %s"),
822 progname, strerror(errno));
824 default: /* parent */
825 waitpid(pid, NULL,0);
828 if (nfs_probe_statd())
838 * nfs_advise_umount - ask the server to remove a share from it's rmtab
839 * @sap: pointer to IP address of server to call
840 * @salen: length of server address
841 * @pmap: partially filled-in mountd RPC service tuple
842 * @argp: directory path of share to "unmount"
844 * Returns one if the unmount call succeeded; zero if the unmount
845 * failed for any reason; rpccreateerr.cf_stat is set to reflect
846 * the nature of the error.
848 * We use a fast timeout since this call is advisory only.
850 int nfs_advise_umount(const struct sockaddr *sap, const socklen_t salen,
851 const struct pmap *pmap, const dirpath *argp)
853 struct sockaddr_storage address;
854 struct sockaddr *saddr = (struct sockaddr *)&address;
855 struct pmap mnt_pmap = *pmap;
856 struct timeval timeout = {
857 .tv_sec = MOUNT_TIMEOUT >> 3,
860 enum clnt_stat res = 0;
862 memcpy(saddr, sap, salen);
863 if (nfs_probe_mntport(saddr, salen, &mnt_pmap) == 0) {
865 nfs_error(_("%s: Failed to discover mountd port%s"),
866 progname, clnt_spcreateerror(""));
869 nfs_set_port(saddr, mnt_pmap.pm_port);
871 client = nfs_get_priv_rpcclient(saddr, salen, mnt_pmap.pm_prot,
872 mnt_pmap.pm_prog, mnt_pmap.pm_vers,
874 if (client == NULL) {
876 nfs_error(_("%s: Failed to create RPC client%s"),
877 progname, clnt_spcreateerror(""));
881 client->cl_auth = authunix_create_default();
883 res = CLNT_CALL(client, MOUNTPROC_UMNT,
884 (xdrproc_t)xdr_dirpath, (caddr_t)argp,
885 (xdrproc_t)xdr_void, NULL,
887 if (res != RPC_SUCCESS) {
888 rpc_createerr.cf_stat = res;
889 CLNT_GETERR(client, &rpc_createerr.cf_error);
891 nfs_error(_("%s: UMNT call failed: %s"),
892 progname, clnt_sperrno(res));
895 auth_destroy(client->cl_auth);
896 CLNT_DESTROY(client);
898 if (res != RPC_SUCCESS)
904 * nfs_call_umount - ask the server to remove a share from it's rmtab
905 * @mnt_server: address of RPC MNT program server
906 * @argp: directory path of share to "unmount"
908 * Returns one if the unmount call succeeded; zero if the unmount
909 * failed for any reason.
911 * Note that a side effect of calling this function is that rpccreateerr
914 int nfs_call_umount(clnt_addr_t *mnt_server, dirpath *argp)
916 struct sockaddr *sap = (struct sockaddr *)&mnt_server->saddr;
917 socklen_t salen = sizeof(mnt_server->saddr);
918 struct pmap *pmap = &mnt_server->pmap;
920 enum clnt_stat res = 0;
923 if (!nfs_probe_mntport(sap, salen, pmap))
925 clnt = mnt_openclnt(mnt_server, &msock);
928 res = clnt_call(clnt, MOUNTPROC_UMNT,
929 (xdrproc_t)xdr_dirpath, (caddr_t)argp,
930 (xdrproc_t)xdr_void, NULL,
932 mnt_closeclnt(clnt, msock);
934 if (res == RPC_SUCCESS)
940 * mnt_openclnt - get a handle for a remote mountd service
941 * @mnt_server: address and pmap arguments of mountd service
942 * @msock: returns a file descriptor of the underlying transport socket
944 * Returns an active handle for the remote's mountd service
946 CLIENT *mnt_openclnt(clnt_addr_t *mnt_server, int *msock)
948 struct sockaddr_in *mnt_saddr = &mnt_server->saddr;
949 struct pmap *mnt_pmap = &mnt_server->pmap;
952 mnt_saddr->sin_port = htons((u_short)mnt_pmap->pm_port);
953 *msock = get_socket(mnt_saddr, mnt_pmap->pm_prot, MOUNT_TIMEOUT,
955 if (*msock == RPC_ANYSOCK) {
956 if (rpc_createerr.cf_error.re_errno == EADDRINUSE)
958 * Probably in-use by a TIME_WAIT connection,
959 * It is worth waiting a while and trying again.
961 rpc_createerr.cf_stat = RPC_TIMEDOUT;
965 switch (mnt_pmap->pm_prot) {
967 clnt = clntudp_bufcreate(mnt_saddr,
968 mnt_pmap->pm_prog, mnt_pmap->pm_vers,
969 RETRY_TIMEOUT, msock,
970 MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
973 clnt = clnttcp_create(mnt_saddr,
974 mnt_pmap->pm_prog, mnt_pmap->pm_vers,
976 MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
980 /* try to mount hostname:dirname */
981 clnt->cl_auth = authunix_create_default();
988 * mnt_closeclnt - terminate a handle for a remote mountd service
989 * @clnt: pointer to an active handle for a remote mountd service
990 * @msock: file descriptor of the underlying transport socket
993 void mnt_closeclnt(CLIENT *clnt, int msock)
995 auth_destroy(clnt->cl_auth);
1001 * clnt_ping - send an RPC ping to the remote RPC service endpoint
1002 * @saddr: server's address
1003 * @prog: target RPC program number
1004 * @vers: target RPC version number
1005 * @prot: target RPC protocol
1006 * @caddr: filled in with our network address
1008 * Sigh... GETPORT queries don't actually check the version number.
1009 * In order to make sure that the server actually supports the service
1010 * we're requesting, we open an RPC client, and fire off a NULL
1013 * caddr is the network address that the server will use to call us back.
1014 * On multi-homed clients, this address depends on which NIC we use to
1015 * route requests to the server.
1017 * Returns one if successful, otherwise zero.
1019 int clnt_ping(struct sockaddr_in *saddr, const unsigned long prog,
1020 const unsigned long vers, const unsigned int prot,
1021 struct sockaddr_in *caddr)
1023 CLIENT *clnt = NULL;
1025 static char clnt_res;
1026 struct sockaddr dissolve;
1028 rpc_createerr.cf_stat = stat = 0;
1029 sock = get_socket(saddr, prot, CONNECT_TIMEOUT, FALSE, TRUE);
1030 if (sock == RPC_ANYSOCK) {
1031 if (rpc_createerr.cf_error.re_errno == ETIMEDOUT) {
1033 * TCP timeout. Bubble up the error to see
1034 * how it should be handled.
1036 rpc_createerr.cf_stat = RPC_TIMEDOUT;
1042 /* Get the address of our end of this connection */
1043 socklen_t len = sizeof(*caddr);
1044 if (getsockname(sock, caddr, &len) != 0)
1045 caddr->sin_family = 0;
1050 /* The socket is connected (so we could getsockname successfully),
1051 * but some servers on multi-homed hosts reply from
1052 * the wrong address, so if we stay connected, we lose the reply.
1054 dissolve.sa_family = AF_UNSPEC;
1055 connect(sock, &dissolve, sizeof(dissolve));
1057 clnt = clntudp_bufcreate(saddr, prog, vers,
1058 RETRY_TIMEOUT, &sock,
1059 RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
1062 clnt = clnttcp_create(saddr, prog, vers, &sock,
1063 RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
1070 memset(&clnt_res, 0, sizeof(clnt_res));
1071 stat = clnt_call(clnt, NULLPROC,
1072 (xdrproc_t)xdr_void, (caddr_t)NULL,
1073 (xdrproc_t)xdr_void, (caddr_t)&clnt_res,
1076 clnt_geterr(clnt, &rpc_createerr.cf_error);
1077 rpc_createerr.cf_stat = stat;
1082 if (stat == RPC_SUCCESS)
1089 * Try a getsockname() on a connected datagram socket.
1091 * Returns 1 and fills in @buf if successful; otherwise, zero.
1093 * A connected datagram socket prevents leaving a socket in TIME_WAIT.
1094 * This conserves the ephemeral port number space, helping reduce failed
1095 * socket binds during mount storms.
1097 static int nfs_ca_sockname(const struct sockaddr *sap, const socklen_t salen,
1098 struct sockaddr *buf, socklen_t *buflen)
1100 struct sockaddr_in sin = {
1101 .sin_family = AF_INET,
1102 .sin_addr.s_addr = htonl(INADDR_ANY),
1104 struct sockaddr_in6 sin6 = {
1105 .sin6_family = AF_INET6,
1106 .sin6_addr = IN6ADDR_ANY_INIT,
1110 sock = socket(sap->sa_family, SOCK_DGRAM, IPPROTO_UDP);
1114 switch (sap->sa_family) {
1116 if (bind(sock, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
1122 if (bind(sock, (struct sockaddr *)&sin6, sizeof(sin6)) < 0) {
1128 errno = EAFNOSUPPORT;
1132 if (connect(sock, sap, salen) < 0) {
1137 return !getsockname(sock, buf, buflen);
1141 * Try to generate an address that prevents the server from calling us.
1143 * Returns 1 and fills in @buf if successful; otherwise, zero.
1145 static int nfs_ca_gai(const struct sockaddr *sap,
1146 struct sockaddr *buf, socklen_t *buflen)
1148 struct addrinfo *gai_results;
1149 struct addrinfo gai_hint = {
1150 .ai_family = sap->sa_family,
1151 .ai_flags = AI_PASSIVE, /* ANYADDR */
1154 if (getaddrinfo(NULL, "", &gai_hint, &gai_results))
1157 *buflen = gai_results->ai_addrlen;
1158 memcpy(buf, gai_results->ai_addr, *buflen);
1160 freeaddrinfo(gai_results);
1166 * nfs_callback_address - acquire our local network address
1167 * @sap: pointer to address of remote
1168 * @sap_len: length of address
1169 * @buf: pointer to buffer to be filled in with local network address
1170 * @buflen: IN: length of buffer to fill in; OUT: length of filled-in address
1172 * Discover a network address that an NFSv4 server can use to call us back.
1173 * On multi-homed clients, this address depends on which NIC we use to
1174 * route requests to the server.
1176 * Returns 1 and fills in @buf if an unambiguous local address is
1177 * available; returns 1 and fills in an appropriate ANYADDR address
1178 * if a local address isn't available; otherwise, returns zero.
1180 int nfs_callback_address(const struct sockaddr *sap, const socklen_t salen,
1181 struct sockaddr *buf, socklen_t *buflen)
1183 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1185 if (nfs_ca_sockname(sap, salen, buf, buflen) == 0)
1186 if (nfs_ca_gai(sap, buf, buflen) == 0)
1190 * The server can't use an interface ID that was generated
1191 * here on the client, so always clear sin6_scope_id.
1193 if (sin6->sin6_family == AF_INET6)
1194 sin6->sin6_scope_id = 0;
1201 nfs_error(_("%s: failed to construct callback address"),
1207 * "nfsprog" is supported only by the legacy mount command. The
1208 * kernel mount client does not support this option.
1210 * Returns TRUE if @program contains a valid value for this option,
1211 * or FALSE if the option was specified with an invalid value.
1214 nfs_nfs_program(struct mount_options *options, unsigned long *program)
1218 switch (po_get_numeric(options, "nfsprog", &tmp)) {
1231 * NFS RPC program wasn't specified. The RPC program
1232 * cannot be determined via an rpcbind query.
1234 *program = nfs_getrpcbyname(NFSPROG, nfs_nfs_pgmtbl);
1239 * Returns TRUE if @version contains a valid value for this option,
1240 * or FALSE if the option was specified with an invalid value.
1243 nfs_nfs_version(struct mount_options *options, unsigned long *version)
1247 switch (po_rightmost(options, nfs_version_opttbl)) {
1258 switch (po_get_numeric(options, "vers", &tmp)) {
1260 if (tmp >= 2 && tmp <= 4) {
1266 nfs_error(_("%s: option parsing error\n"),
1271 case 4: /* nfsvers */
1272 switch (po_get_numeric(options, "nfsvers", &tmp)) {
1274 if (tmp >= 2 && tmp <= 4) {
1280 nfs_error(_("%s: option parsing error\n"),
1288 * NFS version wasn't specified. The pmap version value
1289 * will be filled in later by an rpcbind query in this case.
1296 * Returns TRUE if @protocol contains a valid value for this option,
1297 * or FALSE if the option was specified with an invalid value.
1300 nfs_nfs_protocol(struct mount_options *options, unsigned long *protocol)
1305 switch (po_rightmost(options, nfs_transport_opttbl)) {
1307 *protocol = IPPROTO_UDP;
1310 *protocol = IPPROTO_TCP;
1313 option = po_get(options, "proto");
1315 return nfs_get_proto(option, &family, protocol);
1319 * NFS transport protocol wasn't specified. The pmap
1320 * protocol value will be filled in later by an rpcbind
1321 * query in this case.
1328 * Returns TRUE if @port contains a valid value for this option,
1329 * or FALSE if the option was specified with an invalid value.
1332 nfs_nfs_port(struct mount_options *options, unsigned long *port)
1336 switch (po_get_numeric(options, "port", &tmp)) {
1340 if (tmp >= 1 && tmp <= 65535) {
1349 * NFS service port wasn't specified. The pmap port value
1350 * will be filled in later by an rpcbind query in this case.
1357 * "mountprog" is supported only by the legacy mount command. The
1358 * kernel mount client does not support this option.
1360 * Returns TRUE if @program contains a valid value for this option,
1361 * or FALSE if the option was specified with an invalid value.
1364 nfs_mount_program(struct mount_options *options, unsigned long *program)
1368 switch (po_get_numeric(options, "mountprog", &tmp)) {
1381 * MNT RPC program wasn't specified. The RPC program
1382 * cannot be determined via an rpcbind query.
1384 *program = nfs_getrpcbyname(MOUNTPROG, nfs_mnt_pgmtbl);
1389 * Returns TRUE if @version contains a valid value for this option,
1390 * or FALSE if the option was specified with an invalid value.
1393 nfs_mount_version(struct mount_options *options, unsigned long *version)
1397 switch (po_get_numeric(options, "mountvers", &tmp)) {
1401 if (tmp >= 1 && tmp <= 4) {
1410 * MNT version wasn't specified. The pmap version value
1411 * will be filled in later by an rpcbind query in this case.
1418 * Returns TRUE if @protocol contains a valid value for this option,
1419 * or FALSE if the option was specified with an invalid value.
1422 nfs_mount_protocol(struct mount_options *options, unsigned long *protocol)
1427 option = po_get(options, "mountproto");
1429 return nfs_get_proto(option, &family, protocol);
1432 * MNT transport protocol wasn't specified. If the NFS
1433 * transport protocol was specified, use that; otherwise
1434 * set @protocol to zero. The pmap protocol value will
1435 * be filled in later by an rpcbind query in this case.
1437 return nfs_nfs_protocol(options, protocol);
1441 * Returns TRUE if @port contains a valid value for this option,
1442 * or FALSE if the option was specified with an invalid value.
1445 nfs_mount_port(struct mount_options *options, unsigned long *port)
1449 switch (po_get_numeric(options, "mountport", &tmp)) {
1453 if (tmp >= 1 && tmp <= 65535) {
1462 * MNT service port wasn't specified. The pmap port value
1463 * will be filled in later by an rpcbind query in this case.
1470 * nfs_options2pmap - set up pmap structs based on mount options
1471 * @options: pointer to mount options
1472 * @nfs_pmap: OUT: pointer to pmap arguments for NFS server
1473 * @mnt_pmap: OUT: pointer to pmap arguments for mountd server
1475 * Returns TRUE if the pmap options specified in @options have valid
1476 * values; otherwise FALSE is returned.
1478 int nfs_options2pmap(struct mount_options *options,
1479 struct pmap *nfs_pmap, struct pmap *mnt_pmap)
1481 if (!nfs_nfs_program(options, &nfs_pmap->pm_prog))
1483 if (!nfs_nfs_version(options, &nfs_pmap->pm_vers))
1485 if (!nfs_nfs_protocol(options, &nfs_pmap->pm_prot))
1487 if (!nfs_nfs_port(options, &nfs_pmap->pm_port))
1490 if (!nfs_mount_program(options, &mnt_pmap->pm_prog))
1492 if (!nfs_mount_version(options, &mnt_pmap->pm_vers))
1494 if (!nfs_mount_protocol(options, &mnt_pmap->pm_prot))
1496 if (!nfs_mount_port(options, &mnt_pmap->pm_port))