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>
41 #include <netinet/in.h>
43 #include <rpc/pmap_prot.h>
44 #include <rpc/pmap_clnt.h>
50 #include "nfs_mount.h"
51 #include "mount_constants.h"
53 #include "parse_opt.h"
58 #define PMAP_TIMEOUT (10)
59 #define CONNECT_TIMEOUT (20)
60 #define MOUNT_TIMEOUT (30)
62 #define SAFE_SOCKADDR(x) (struct sockaddr *)(char *)(x)
64 extern int nfs_mount_data_version;
65 extern char *progname;
68 static const char *nfs_ns_pgmtbl[] = {
73 static const char *nfs_mnt_pgmtbl[] = {
79 static const char *nfs_nfs_pgmtbl[] = {
85 static const char *nfs_transport_opttbl[] = {
93 static const char *nfs_version_opttbl[] = {
102 static const unsigned long nfs_to_mnt[] = {
109 static const unsigned long mnt_to_nfs[] = {
117 * Map an NFS version into the corresponding Mountd version
119 unsigned long nfsvers_to_mnt(const unsigned long vers)
122 return nfs_to_mnt[vers];
127 * Map a Mountd version into the corresponding NFS version
129 static unsigned long mntvers_to_nfs(const unsigned long vers)
132 return mnt_to_nfs[vers];
136 static const unsigned int probe_udp_only[] = {
141 static const unsigned int probe_udp_first[] = {
147 static const unsigned int probe_tcp_first[] = {
153 static const unsigned long probe_nfs2_only[] = {
158 static const unsigned long probe_nfs3_first[] = {
164 static const unsigned long probe_mnt1_first[] = {
170 static const unsigned long probe_mnt3_first[] = {
177 static const unsigned int *nfs_default_proto(void);
179 static const unsigned int *nfs_default_proto()
181 extern unsigned long config_default_proto;
183 * If the default proto has been set and
184 * its not TCP, start with UDP
186 if (config_default_proto && config_default_proto != IPPROTO_TCP)
187 return probe_udp_first;
189 return probe_tcp_first;
192 static const unsigned int *nfs_default_proto()
194 return probe_tcp_first;
196 #endif /* MOUNT_CONFIG */
199 * nfs_lookup - resolve hostname to an IPv4 or IPv6 socket address
200 * @hostname: pointer to C string containing DNS hostname to resolve
201 * @family: address family hint
202 * @sap: pointer to buffer to fill with socket address
203 * @len: IN: size of buffer to fill; OUT: size of socket address
205 * Returns 1 and places a socket address at @sap if successful;
208 int nfs_lookup(const char *hostname, const sa_family_t family,
209 struct sockaddr *sap, socklen_t *salen)
211 struct addrinfo *gai_results;
212 struct addrinfo gai_hint = {
215 socklen_t len = *salen;
220 error = getaddrinfo(hostname, NULL, &gai_hint, &gai_results);
225 nfs_error(_("%s: DNS resolution failed for %s: %s"),
226 progname, hostname, strerror(errno));
229 nfs_error(_("%s: DNS resolution failed for %s: %s"),
230 progname, hostname, gai_strerror(error));
234 switch (gai_results->ai_addr->sa_family) {
237 if (len >= gai_results->ai_addrlen) {
238 *salen = gai_results->ai_addrlen;
239 memcpy(sap, gai_results->ai_addr, *salen);
244 /* things are really broken if we get here, so warn */
245 nfs_error(_("%s: unrecognized DNS resolution results for %s"),
250 freeaddrinfo(gai_results);
255 * nfs_gethostbyname - resolve a hostname to an IPv4 address
256 * @hostname: pointer to a C string containing a DNS hostname
257 * @sin: returns an IPv4 address
259 * Returns 1 if successful, otherwise zero.
261 int nfs_gethostbyname(const char *hostname, struct sockaddr_in *sin)
263 socklen_t len = sizeof(*sin);
265 return nfs_lookup(hostname, AF_INET, (struct sockaddr *)sin, &len);
269 * nfs_string_to_sockaddr - convert string address to sockaddr
270 * @address: pointer to presentation format address to convert
271 * @sap: pointer to socket address buffer to fill in
272 * @salen: IN: length of address buffer
273 * OUT: length of converted socket address
275 * Convert a presentation format address string to a socket address.
276 * Similar to nfs_lookup(), but the DNS query is squelched, and it
277 * won't make any noise if the getaddrinfo() call fails.
279 * Returns 1 and fills in @sap and @salen if successful; otherwise zero.
281 * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
282 * on presenting IPv6 addresses as text strings.
284 int nfs_string_to_sockaddr(const char *address, struct sockaddr *sap,
287 struct addrinfo *gai_results;
288 struct addrinfo gai_hint = {
289 .ai_flags = AI_NUMERICHOST,
291 socklen_t len = *salen;
296 if (getaddrinfo(address, NULL, &gai_hint, &gai_results) == 0) {
297 switch (gai_results->ai_addr->sa_family) {
300 if (len >= gai_results->ai_addrlen) {
301 *salen = gai_results->ai_addrlen;
302 memcpy(sap, gai_results->ai_addr, *salen);
307 freeaddrinfo(gai_results);
314 * nfs_present_sockaddr - convert sockaddr to string
315 * @sap: pointer to socket address to convert
316 * @salen: length of socket address
317 * @buf: pointer to buffer to fill in
318 * @buflen: length of buffer
320 * Convert the passed-in sockaddr-style address to presentation format.
321 * The presentation format address is placed in @buf and is
324 * Returns 1 if successful; otherwise zero.
326 * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
327 * on presenting IPv6 addresses as text strings.
329 int nfs_present_sockaddr(const struct sockaddr *sap, const socklen_t salen,
330 char *buf, const size_t buflen)
332 #ifdef HAVE_GETNAMEINFO
335 result = getnameinfo(sap, salen, buf, buflen,
336 NULL, 0, NI_NUMERICHOST);
340 nfs_error(_("%s: invalid server address: %s"), progname,
341 gai_strerror(result));
343 #else /* HAVE_GETNAMEINFO */
346 if (sap->sa_family == AF_INET) {
347 addr = inet_ntoa(((struct sockaddr_in *)sap)->sin_addr);
348 if (addr && strlen(addr) < buflen) {
354 nfs_error(_("%s: invalid server address"), progname);
356 #endif /* HAVE_GETNAMEINFO */
360 * Attempt to connect a socket, but time out after "timeout" seconds.
362 * On error return, caller closes the socket.
364 static int connect_to(int fd, struct sockaddr *addr,
365 socklen_t addrlen, int timeout)
369 struct timeval tv = {
373 saved = fcntl(fd, F_GETFL, 0);
374 fcntl(fd, F_SETFL, saved | O_NONBLOCK);
376 ret = connect(fd, addr, addrlen);
377 if (ret < 0 && errno != EINPROGRESS)
385 ret = select(fd + 1, &rset, &wset, NULL, &tv);
390 if (FD_ISSET(fd, &rset) || FD_ISSET(fd, &wset)) {
392 socklen_t len = sizeof(error);
393 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0)
403 fcntl(fd, F_SETFL, saved);
408 * Create a socket that is locally bound to a reserved or non-reserved port.
410 * The caller should check rpc_createerr to determine the cause of any error.
412 static int get_socket(struct sockaddr_in *saddr, unsigned int p_prot,
413 unsigned int timeout, int resvp, int conn)
416 struct sockaddr_in laddr;
417 socklen_t namelen = sizeof(laddr);
419 type = (p_prot == IPPROTO_UDP ? SOCK_DGRAM : SOCK_STREAM);
420 if ((so = socket (AF_INET, type, p_prot)) < 0)
423 laddr.sin_family = AF_INET;
425 laddr.sin_addr.s_addr = htonl(INADDR_ANY);
427 if (bindresvport(so, &laddr) < 0)
428 goto err_bindresvport;
430 cc = bind(so, SAFE_SOCKADDR(&laddr), namelen);
434 if (type == SOCK_STREAM || (conn && type == SOCK_DGRAM)) {
435 cc = connect_to(so, SAFE_SOCKADDR(saddr), namelen,
443 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
444 rpc_createerr.cf_error.re_errno = errno;
446 nfs_error(_("%s: Unable to create %s socket: errno %d (%s)\n"),
447 progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
448 errno, strerror(errno));
453 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
454 rpc_createerr.cf_error.re_errno = errno;
456 nfs_error(_("%s: Unable to bindresvport %s socket: errno %d"
458 progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
459 errno, strerror(errno));
465 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
466 rpc_createerr.cf_error.re_errno = errno;
468 nfs_error(_("%s: Unable to bind to %s socket: errno %d (%s)\n"),
469 progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
470 errno, strerror(errno));
476 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
477 rpc_createerr.cf_error.re_errno = errno;
479 nfs_error(_("%s: Unable to connect to %s:%d, errno %d (%s)\n"),
480 progname, inet_ntoa(saddr->sin_addr),
481 ntohs(saddr->sin_port), errno, strerror(errno));
487 static void nfs_pp_debug(const struct sockaddr *sap, const socklen_t salen,
488 const rpcprog_t program, const rpcvers_t version,
489 const unsigned short protocol,
490 const unsigned short port)
492 char buf[NI_MAXHOST];
497 if (nfs_present_sockaddr(sap, salen, buf, sizeof(buf)) == 0) {
499 strcat(buf, "unknown host");
502 fprintf(stderr, _("%s: trying %s prog %lu vers %lu prot %s port %d\n"),
503 progname, buf, (unsigned long)program,
504 (unsigned long)version,
505 (protocol == IPPROTO_UDP ? _("UDP") : _("TCP")),
509 static void nfs_pp_debug2(const char *str)
514 if (rpc_createerr.cf_error.re_status == RPC_CANTRECV ||
515 rpc_createerr.cf_error.re_status == RPC_CANTSEND)
516 nfs_error(_("%s: portmap query %s%s - %s"),
517 progname, str, clnt_spcreateerror(""),
518 strerror(rpc_createerr.cf_error.re_errno));
520 nfs_error(_("%s: portmap query %s%s"),
521 progname, str, clnt_spcreateerror(""));
525 * Use the portmapper to discover whether or not the service we want is
526 * available. The lists 'versions' and 'protos' define ordered sequences
527 * of service versions and udp/tcp protocols to probe for.
529 * Returns 1 if the requested service port is unambiguous and pingable;
530 * @pmap is filled in with the version, port, and transport protocol used
531 * during the successful ping. Note that if a port is already specified
532 * in @pmap and it matches the rpcbind query result, nfs_probe_port() does
533 * not perform an RPC ping.
535 * If an error occurs or the requested service isn't available, zero is
536 * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
538 static int nfs_probe_port(const struct sockaddr *sap, const socklen_t salen,
539 struct pmap *pmap, const unsigned long *versions,
540 const unsigned int *protos)
542 union nfs_sockaddr address;
543 struct sockaddr *saddr = &address.sa;
544 const unsigned long prog = pmap->pm_prog, *p_vers;
545 const unsigned int prot = (u_int)pmap->pm_prot, *p_prot;
546 const u_short port = (u_short) pmap->pm_port;
547 unsigned long vers = pmap->pm_vers;
548 unsigned short p_port;
550 memcpy(saddr, sap, salen);
551 p_prot = prot ? &prot : protos;
552 p_vers = vers ? &vers : versions;
556 printf(_("%s: prog %lu, trying vers=%lu, prot=%u\n"),
557 progname, prog, *p_vers, *p_prot);
558 p_port = nfs_getport(saddr, salen, prog, *p_vers, *p_prot);
560 if (!port || port == p_port) {
561 nfs_set_port(saddr, p_port);
562 nfs_pp_debug(saddr, salen, prog, *p_vers,
564 if (nfs_rpc_ping(saddr, salen, prog,
565 *p_vers, *p_prot, NULL))
568 rpc_createerr.cf_stat = RPC_PROGNOTREGISTERED;
570 if (rpc_createerr.cf_stat != RPC_PROGNOTREGISTERED &&
571 rpc_createerr.cf_stat != RPC_TIMEDOUT &&
572 rpc_createerr.cf_stat != RPC_CANTRECV &&
573 rpc_createerr.cf_stat != RPC_PROGVERSMISMATCH)
578 nfs_pp_debug2("retrying");
583 if (rpc_createerr.cf_stat == RPC_TIMEDOUT ||
584 rpc_createerr.cf_stat == RPC_CANTRECV)
587 if (vers || !*++p_vers)
591 nfs_pp_debug2("failed");
596 pmap->pm_vers = *p_vers;
598 pmap->pm_prot = *p_prot;
600 pmap->pm_port = p_port;
601 nfs_clear_rpc_createerr();
605 * Probe a server's NFS service to determine which versions and
606 * transport protocols are supported.
608 * Returns 1 if the requested service port is unambiguous and pingable;
609 * @pmap is filled in with the version, port, and transport protocol used
610 * during the successful ping. If all three are already specified, simply
611 * return success without an rpcbind query or RPC ping (we may be trying
612 * to mount an NFS service that is not advertised via rpcbind).
614 * If an error occurs or the requested service isn't available, zero is
615 * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
617 static int nfs_probe_nfsport(const struct sockaddr *sap, const socklen_t salen,
620 if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
623 if (nfs_mount_data_version >= 4) {
624 const unsigned int *probe_proto;
626 probe_proto = nfs_default_proto();
628 return nfs_probe_port(sap, salen, pmap,
629 probe_nfs3_first, probe_proto);
631 return nfs_probe_port(sap, salen, pmap,
632 probe_nfs2_only, probe_udp_only);
636 * Probe a server's mountd service to determine which versions and
637 * transport protocols are supported.
639 * Returns 1 if the requested service port is unambiguous and pingable;
640 * @pmap is filled in with the version, port, and transport protocol used
641 * during the successful ping. If all three are already specified, simply
642 * return success without an rpcbind query or RPC ping (we may be trying
643 * to mount an NFS service that is not advertised via rpcbind).
645 * If an error occurs or the requested service isn't available, zero is
646 * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
648 static int nfs_probe_mntport(const struct sockaddr *sap, const socklen_t salen,
651 if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
654 if (nfs_mount_data_version >= 4)
655 return nfs_probe_port(sap, salen, pmap,
656 probe_mnt3_first, probe_udp_first);
658 return nfs_probe_port(sap, salen, pmap,
659 probe_mnt1_first, probe_udp_only);
663 * Probe a server's mountd service to determine which versions and
664 * transport protocols are supported. Invoked when the protocol
665 * version is already known for both the NFS and mountd service.
667 * Returns 1 and fills in both @pmap structs if the requested service
668 * ports are unambiguous and pingable. Otherwise zero is returned;
669 * rpccreateerr.cf_stat is set to reflect the nature of the error.
671 static int nfs_probe_version_fixed(const struct sockaddr *mnt_saddr,
672 const socklen_t mnt_salen,
673 struct pmap *mnt_pmap,
674 const struct sockaddr *nfs_saddr,
675 const socklen_t nfs_salen,
676 struct pmap *nfs_pmap)
678 if (!nfs_probe_nfsport(nfs_saddr, nfs_salen, nfs_pmap))
680 return nfs_probe_mntport(mnt_saddr, mnt_salen, mnt_pmap);
684 * nfs_probe_bothports - discover the RPC endpoints of mountd and NFS server
685 * @mnt_saddr: pointer to socket address of mountd server
686 * @mnt_salen: length of mountd server's address
687 * @mnt_pmap: IN: partially filled-in mountd RPC service tuple;
688 * OUT: fully filled-in mountd RPC service tuple
689 * @nfs_saddr: pointer to socket address of NFS server
690 * @nfs_salen: length of NFS server's address
691 * @nfs_pmap: IN: partially filled-in NFS RPC service tuple;
692 * OUT: fully filled-in NFS RPC service tuple
694 * Returns 1 and fills in both @pmap structs if the requested service
695 * ports are unambiguous and pingable. Otherwise zero is returned;
696 * rpccreateerr.cf_stat is set to reflect the nature of the error.
698 int nfs_probe_bothports(const struct sockaddr *mnt_saddr,
699 const socklen_t mnt_salen,
700 struct pmap *mnt_pmap,
701 const struct sockaddr *nfs_saddr,
702 const socklen_t nfs_salen,
703 struct pmap *nfs_pmap)
705 struct pmap save_nfs, save_mnt;
706 const unsigned long *probe_vers;
708 if (mnt_pmap->pm_vers && !nfs_pmap->pm_vers)
709 nfs_pmap->pm_vers = mntvers_to_nfs(mnt_pmap->pm_vers);
710 else if (nfs_pmap->pm_vers && !mnt_pmap->pm_vers)
711 mnt_pmap->pm_vers = nfsvers_to_mnt(nfs_pmap->pm_vers);
713 if (nfs_pmap->pm_vers)
714 return nfs_probe_version_fixed(mnt_saddr, mnt_salen, mnt_pmap,
715 nfs_saddr, nfs_salen, nfs_pmap);
717 memcpy(&save_nfs, nfs_pmap, sizeof(save_nfs));
718 memcpy(&save_mnt, mnt_pmap, sizeof(save_mnt));
719 probe_vers = (nfs_mount_data_version >= 4) ?
720 probe_mnt3_first : probe_mnt1_first;
722 for (; *probe_vers; probe_vers++) {
723 nfs_pmap->pm_vers = mntvers_to_nfs(*probe_vers);
724 if (nfs_probe_nfsport(nfs_saddr, nfs_salen, nfs_pmap) != 0) {
725 mnt_pmap->pm_vers = *probe_vers;
726 if (nfs_probe_mntport(mnt_saddr, mnt_salen, mnt_pmap) != 0)
728 memcpy(mnt_pmap, &save_mnt, sizeof(*mnt_pmap));
730 switch (rpc_createerr.cf_stat) {
731 case RPC_PROGVERSMISMATCH:
732 case RPC_PROGNOTREGISTERED:
737 memcpy(nfs_pmap, &save_nfs, sizeof(*nfs_pmap));
744 * probe_bothports - discover the RPC endpoints of mountd and NFS server
745 * @mnt_server: pointer to address and pmap argument for mountd results
746 * @nfs_server: pointer to address and pmap argument for NFS server
748 * This is the legacy API that takes "clnt_addr_t" for both servers,
749 * but supports only AF_INET addresses.
751 * Returns 1 and fills in the pmap field in both clnt_addr_t structs
752 * if the requested service ports are unambiguous and pingable.
753 * Otherwise zero is returned; rpccreateerr.cf_stat is set to reflect
754 * the nature of the error.
756 int probe_bothports(clnt_addr_t *mnt_server, clnt_addr_t *nfs_server)
758 struct sockaddr *mnt_addr = SAFE_SOCKADDR(&mnt_server->saddr);
759 struct sockaddr *nfs_addr = SAFE_SOCKADDR(&nfs_server->saddr);
761 return nfs_probe_bothports(mnt_addr, sizeof(mnt_server->saddr),
763 nfs_addr, sizeof(nfs_server->saddr),
767 static int nfs_probe_statd(void)
769 struct sockaddr_in addr = {
770 .sin_family = AF_INET,
771 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
773 rpcprog_t program = nfs_getrpcbyname(NSMPROG, nfs_ns_pgmtbl);
775 return nfs_getport_ping(SAFE_SOCKADDR(&addr), sizeof(addr),
776 program, (rpcvers_t)1, IPPROTO_UDP);
780 * start_statd - attempt to start rpc.statd
782 * Returns 1 if statd is running; otherwise zero.
784 int start_statd(void)
790 if (nfs_probe_statd())
794 if (stat(START_STATD, &stb) == 0) {
795 if (S_ISREG(stb.st_mode) && (stb.st_mode & S_IXUSR)) {
799 execl(START_STATD, START_STATD, NULL);
802 nfs_error(_("%s: fork failed: %s"),
803 progname, strerror(errno));
805 default: /* parent */
806 waitpid(pid, NULL,0);
809 if (nfs_probe_statd())
819 * nfs_advise_umount - ask the server to remove a share from it's rmtab
820 * @sap: pointer to IP address of server to call
821 * @salen: length of server address
822 * @pmap: partially filled-in mountd RPC service tuple
823 * @argp: directory path of share to "unmount"
825 * Returns one if the unmount call succeeded; zero if the unmount
826 * failed for any reason; rpccreateerr.cf_stat is set to reflect
827 * the nature of the error.
829 * We use a fast timeout since this call is advisory only.
831 int nfs_advise_umount(const struct sockaddr *sap, const socklen_t salen,
832 const struct pmap *pmap, const dirpath *argp)
834 union nfs_sockaddr address;
835 struct sockaddr *saddr = &address.sa;
836 struct pmap mnt_pmap = *pmap;
837 struct timeval timeout = {
838 .tv_sec = MOUNT_TIMEOUT >> 3,
841 enum clnt_stat res = 0;
843 memcpy(saddr, sap, salen);
844 if (nfs_probe_mntport(saddr, salen, &mnt_pmap) == 0) {
846 nfs_error(_("%s: Failed to discover mountd port%s"),
847 progname, clnt_spcreateerror(""));
850 nfs_set_port(saddr, mnt_pmap.pm_port);
852 client = nfs_get_priv_rpcclient(saddr, salen, mnt_pmap.pm_prot,
853 mnt_pmap.pm_prog, mnt_pmap.pm_vers,
855 if (client == NULL) {
857 nfs_error(_("%s: Failed to create RPC client%s"),
858 progname, clnt_spcreateerror(""));
862 client->cl_auth = nfs_authsys_create();
863 if (client->cl_auth == NULL) {
865 nfs_error(_("%s: Failed to create RPC auth handle"),
867 CLNT_DESTROY(client);
871 res = CLNT_CALL(client, MOUNTPROC_UMNT,
872 (xdrproc_t)xdr_dirpath, (caddr_t)argp,
873 (xdrproc_t)xdr_void, NULL,
875 if (res != RPC_SUCCESS) {
876 rpc_createerr.cf_stat = res;
877 CLNT_GETERR(client, &rpc_createerr.cf_error);
879 nfs_error(_("%s: UMNT call failed: %s"),
880 progname, clnt_sperrno(res));
883 auth_destroy(client->cl_auth);
884 CLNT_DESTROY(client);
886 if (res != RPC_SUCCESS)
892 * nfs_call_umount - ask the server to remove a share from it's rmtab
893 * @mnt_server: address of RPC MNT program server
894 * @argp: directory path of share to "unmount"
896 * Returns one if the unmount call succeeded; zero if the unmount
897 * failed for any reason.
899 * Note that a side effect of calling this function is that rpccreateerr
902 int nfs_call_umount(clnt_addr_t *mnt_server, dirpath *argp)
904 struct sockaddr *sap = SAFE_SOCKADDR(&mnt_server->saddr);
905 socklen_t salen = sizeof(mnt_server->saddr);
906 struct pmap *pmap = &mnt_server->pmap;
908 enum clnt_stat res = 0;
911 if (!nfs_probe_mntport(sap, salen, pmap))
913 clnt = mnt_openclnt(mnt_server, &msock);
916 res = clnt_call(clnt, MOUNTPROC_UMNT,
917 (xdrproc_t)xdr_dirpath, (caddr_t)argp,
918 (xdrproc_t)xdr_void, NULL,
920 mnt_closeclnt(clnt, msock);
922 if (res == RPC_SUCCESS)
928 * mnt_openclnt - get a handle for a remote mountd service
929 * @mnt_server: address and pmap arguments of mountd service
930 * @msock: returns a file descriptor of the underlying transport socket
932 * Returns an active handle for the remote's mountd service
934 CLIENT *mnt_openclnt(clnt_addr_t *mnt_server, int *msock)
936 struct sockaddr_in *mnt_saddr = &mnt_server->saddr;
937 struct pmap *mnt_pmap = &mnt_server->pmap;
940 mnt_saddr->sin_port = htons((u_short)mnt_pmap->pm_port);
941 *msock = get_socket(mnt_saddr, mnt_pmap->pm_prot, MOUNT_TIMEOUT,
943 if (*msock == RPC_ANYSOCK) {
944 if (rpc_createerr.cf_error.re_errno == EADDRINUSE)
946 * Probably in-use by a TIME_WAIT connection,
947 * It is worth waiting a while and trying again.
949 rpc_createerr.cf_stat = RPC_TIMEDOUT;
953 switch (mnt_pmap->pm_prot) {
955 clnt = clntudp_bufcreate(mnt_saddr,
956 mnt_pmap->pm_prog, mnt_pmap->pm_vers,
957 RETRY_TIMEOUT, msock,
958 MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
961 clnt = clnttcp_create(mnt_saddr,
962 mnt_pmap->pm_prog, mnt_pmap->pm_vers,
964 MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
968 /* try to mount hostname:dirname */
969 clnt->cl_auth = nfs_authsys_create();
978 * mnt_closeclnt - terminate a handle for a remote mountd service
979 * @clnt: pointer to an active handle for a remote mountd service
980 * @msock: file descriptor of the underlying transport socket
983 void mnt_closeclnt(CLIENT *clnt, int msock)
985 auth_destroy(clnt->cl_auth);
991 * clnt_ping - send an RPC ping to the remote RPC service endpoint
992 * @saddr: server's address
993 * @prog: target RPC program number
994 * @vers: target RPC version number
995 * @prot: target RPC protocol
996 * @caddr: filled in with our network address
998 * Sigh... GETPORT queries don't actually check the version number.
999 * In order to make sure that the server actually supports the service
1000 * we're requesting, we open an RPC client, and fire off a NULL
1003 * caddr is the network address that the server will use to call us back.
1004 * On multi-homed clients, this address depends on which NIC we use to
1005 * route requests to the server.
1007 * Returns one if successful, otherwise zero.
1009 int clnt_ping(struct sockaddr_in *saddr, const unsigned long prog,
1010 const unsigned long vers, const unsigned int prot,
1011 struct sockaddr_in *caddr)
1013 CLIENT *clnt = NULL;
1015 static char clnt_res;
1016 struct sockaddr dissolve;
1018 rpc_createerr.cf_stat = status = 0;
1019 sock = get_socket(saddr, prot, CONNECT_TIMEOUT, FALSE, TRUE);
1020 if (sock == RPC_ANYSOCK) {
1021 if (rpc_createerr.cf_error.re_errno == ETIMEDOUT) {
1023 * TCP timeout. Bubble up the error to see
1024 * how it should be handled.
1026 rpc_createerr.cf_stat = RPC_TIMEDOUT;
1032 /* Get the address of our end of this connection */
1033 socklen_t len = sizeof(*caddr);
1034 if (getsockname(sock, caddr, &len) != 0)
1035 caddr->sin_family = 0;
1040 /* The socket is connected (so we could getsockname successfully),
1041 * but some servers on multi-homed hosts reply from
1042 * the wrong address, so if we stay connected, we lose the reply.
1044 dissolve.sa_family = AF_UNSPEC;
1045 connect(sock, &dissolve, sizeof(dissolve));
1047 clnt = clntudp_bufcreate(saddr, prog, vers,
1048 RETRY_TIMEOUT, &sock,
1049 RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
1052 clnt = clnttcp_create(saddr, prog, vers, &sock,
1053 RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
1060 memset(&clnt_res, 0, sizeof(clnt_res));
1061 status = clnt_call(clnt, NULLPROC,
1062 (xdrproc_t)xdr_void, (caddr_t)NULL,
1063 (xdrproc_t)xdr_void, (caddr_t)&clnt_res,
1066 clnt_geterr(clnt, &rpc_createerr.cf_error);
1067 rpc_createerr.cf_stat = status;
1072 if (status == RPC_SUCCESS)
1079 * Try a getsockname() on a connected datagram socket.
1081 * Returns 1 and fills in @buf if successful; otherwise, zero.
1083 * A connected datagram socket prevents leaving a socket in TIME_WAIT.
1084 * This conserves the ephemeral port number space, helping reduce failed
1085 * socket binds during mount storms.
1087 static int nfs_ca_sockname(const struct sockaddr *sap, const socklen_t salen,
1088 struct sockaddr *buf, socklen_t *buflen)
1090 struct sockaddr_in sin = {
1091 .sin_family = AF_INET,
1092 .sin_addr.s_addr = htonl(INADDR_ANY),
1094 struct sockaddr_in6 sin6 = {
1095 .sin6_family = AF_INET6,
1096 .sin6_addr = IN6ADDR_ANY_INIT,
1098 int sock, result = 0;
1100 sock = socket(sap->sa_family, SOCK_DGRAM, IPPROTO_UDP);
1104 switch (sap->sa_family) {
1106 if (bind(sock, SAFE_SOCKADDR(&sin), sizeof(sin)) < 0)
1110 if (bind(sock, SAFE_SOCKADDR(&sin6), sizeof(sin6)) < 0)
1114 errno = EAFNOSUPPORT;
1118 if (connect(sock, sap, salen) < 0)
1121 result = !getsockname(sock, buf, buflen);
1129 * Try to generate an address that prevents the server from calling us.
1131 * Returns 1 and fills in @buf if successful; otherwise, zero.
1133 static int nfs_ca_gai(const struct sockaddr *sap,
1134 struct sockaddr *buf, socklen_t *buflen)
1136 struct addrinfo *gai_results;
1137 struct addrinfo gai_hint = {
1138 .ai_family = sap->sa_family,
1139 .ai_flags = AI_PASSIVE, /* ANYADDR */
1142 if (getaddrinfo(NULL, "", &gai_hint, &gai_results))
1145 *buflen = gai_results->ai_addrlen;
1146 memcpy(buf, gai_results->ai_addr, *buflen);
1148 freeaddrinfo(gai_results);
1154 * nfs_callback_address - acquire our local network address
1155 * @sap: pointer to address of remote
1156 * @sap_len: length of address
1157 * @buf: pointer to buffer to be filled in with local network address
1158 * @buflen: IN: length of buffer to fill in; OUT: length of filled-in address
1160 * Discover a network address that an NFSv4 server can use to call us back.
1161 * On multi-homed clients, this address depends on which NIC we use to
1162 * route requests to the server.
1164 * Returns 1 and fills in @buf if an unambiguous local address is
1165 * available; returns 1 and fills in an appropriate ANYADDR address
1166 * if a local address isn't available; otherwise, returns zero.
1168 int nfs_callback_address(const struct sockaddr *sap, const socklen_t salen,
1169 struct sockaddr *buf, socklen_t *buflen)
1171 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1173 if (nfs_ca_sockname(sap, salen, buf, buflen) == 0)
1174 if (nfs_ca_gai(sap, buf, buflen) == 0)
1178 * The server can't use an interface ID that was generated
1179 * here on the client, so always clear sin6_scope_id.
1181 if (sin6->sin6_family == AF_INET6)
1182 sin6->sin6_scope_id = 0;
1189 nfs_error(_("%s: failed to construct callback address"),
1195 * "nfsprog" is supported only by the legacy mount command. The
1196 * kernel mount client does not support this option.
1198 * Returns TRUE if @program contains a valid value for this option,
1199 * or FALSE if the option was specified with an invalid value.
1202 nfs_nfs_program(struct mount_options *options, unsigned long *program)
1206 switch (po_get_numeric(options, "nfsprog", &tmp)) {
1215 nfs_error(_("%s: invalid value for 'nfsprog=' option"),
1221 * NFS RPC program wasn't specified. The RPC program
1222 * cannot be determined via an rpcbind query.
1224 *program = nfs_getrpcbyname(NFSPROG, nfs_nfs_pgmtbl);
1229 * Returns TRUE if @version contains a valid value for this option,
1230 * or FALSE if the option was specified with an invalid value.
1233 nfs_nfs_version(struct mount_options *options, unsigned long *version)
1237 switch (po_rightmost(options, nfs_version_opttbl)) {
1248 switch (po_get_numeric(options, "vers", &tmp)) {
1250 if (tmp >= 2 && tmp <= 4) {
1256 nfs_error(_("%s: parsing error on 'vers=' option\n"),
1260 nfs_error(_("%s: invalid value for 'vers=' option"),
1264 case 4: /* nfsvers */
1265 switch (po_get_numeric(options, "nfsvers", &tmp)) {
1267 if (tmp >= 2 && tmp <= 4) {
1273 nfs_error(_("%s: parsing error on 'nfsvers=' option\n"),
1277 nfs_error(_("%s: invalid value for 'nfsvers=' option"),
1284 * NFS version wasn't specified. The pmap version value
1285 * will be filled in later by an rpcbind query in this case.
1292 * Returns TRUE if @protocol contains a valid value for this option,
1293 * or FALSE if the option was specified with an invalid value. On
1294 * error, errno is set.
1297 nfs_nfs_protocol(struct mount_options *options, unsigned long *protocol)
1302 switch (po_rightmost(options, nfs_transport_opttbl)) {
1304 *protocol = IPPROTO_UDP;
1307 *protocol = IPPROTO_TCP;
1310 *protocol = NFSPROTO_RDMA;
1313 option = po_get(options, "proto");
1314 if (option != NULL) {
1315 if (!nfs_get_proto(option, &family, protocol)) {
1316 errno = EPROTONOSUPPORT;
1317 nfs_error(_("%s: Failed to find '%s' protocol"),
1326 * NFS transport protocol wasn't specified. The pmap
1327 * protocol value will be filled in later by an rpcbind
1328 * query in this case.
1335 * Returns TRUE if @port contains a valid value for this option,
1336 * or FALSE if the option was specified with an invalid value.
1339 nfs_nfs_port(struct mount_options *options, unsigned long *port)
1343 switch (po_get_numeric(options, "port", &tmp)) {
1347 if (tmp >= 0 && tmp <= 65535) {
1352 nfs_error(_("%s: invalid value for 'port=' option"),
1358 * NFS service port wasn't specified. The pmap port value
1359 * will be filled in later by an rpcbind query in this case.
1365 #ifdef IPV6_SUPPORTED
1366 sa_family_t config_default_family = AF_UNSPEC;
1369 nfs_verify_family(sa_family_t UNUSED(family))
1373 #else /* IPV6_SUPPORTED */
1374 sa_family_t config_default_family = AF_INET;
1377 nfs_verify_family(sa_family_t family)
1379 if (family != AF_INET)
1384 #endif /* IPV6_SUPPORTED */
1387 * Returns TRUE and fills in @family if a valid NFS protocol option
1388 * is found, or FALSE if the option was specified with an invalid value
1389 * or if the protocol family isn't supported. On error, errno is set.
1391 int nfs_nfs_proto_family(struct mount_options *options,
1392 sa_family_t *family)
1394 unsigned long protocol;
1396 sa_family_t tmp_family = config_default_family;
1398 switch (po_rightmost(options, nfs_transport_opttbl)) {
1402 /* for compatibility; these are always AF_INET */
1406 option = po_get(options, "proto");
1407 if (option != NULL &&
1408 !nfs_get_proto(option, &tmp_family, &protocol)) {
1410 nfs_error(_("%s: Failed to find '%s' protocol"),
1412 errno = EPROTONOSUPPORT;
1417 if (!nfs_verify_family(tmp_family))
1419 *family = tmp_family;
1422 errno = EAFNOSUPPORT;
1427 * "mountprog" is supported only by the legacy mount command. The
1428 * kernel mount client does not support this option.
1430 * Returns TRUE if @program contains a valid value for this option,
1431 * or FALSE if the option was specified with an invalid value.
1434 nfs_mount_program(struct mount_options *options, unsigned long *program)
1438 switch (po_get_numeric(options, "mountprog", &tmp)) {
1447 nfs_error(_("%s: invalid value for 'mountprog=' option"),
1453 * MNT RPC program wasn't specified. The RPC program
1454 * cannot be determined via an rpcbind query.
1456 *program = nfs_getrpcbyname(MOUNTPROG, nfs_mnt_pgmtbl);
1461 * Returns TRUE if @version contains a valid value for this option,
1462 * or FALSE if the option was specified with an invalid value.
1465 nfs_mount_version(struct mount_options *options, unsigned long *version)
1469 switch (po_get_numeric(options, "mountvers", &tmp)) {
1473 if (tmp >= 1 && tmp <= 4) {
1478 nfs_error(_("%s: invalid value for 'mountvers=' option"),
1484 * MNT version wasn't specified. The pmap version value
1485 * will be filled in later by an rpcbind query in this case.
1492 * Returns TRUE if @protocol contains a valid value for this option,
1493 * or FALSE if the option was specified with an invalid value. On
1494 * error, errno is set.
1497 nfs_mount_protocol(struct mount_options *options, unsigned long *protocol)
1502 option = po_get(options, "mountproto");
1503 if (option != NULL) {
1504 if (!nfs_get_proto(option, &family, protocol)) {
1505 errno = EPROTONOSUPPORT;
1506 nfs_error(_("%s: Failed to find '%s' protocol"),
1514 * MNT transport protocol wasn't specified. If the NFS
1515 * transport protocol was specified, use that; otherwise
1516 * set @protocol to zero. The pmap protocol value will
1517 * be filled in later by an rpcbind query in this case.
1519 if (!nfs_nfs_protocol(options, protocol))
1521 if (*protocol == NFSPROTO_RDMA)
1522 *protocol = IPPROTO_TCP;
1527 * Returns TRUE if @port contains a valid value for this option,
1528 * or FALSE if the option was specified with an invalid value.
1531 nfs_mount_port(struct mount_options *options, unsigned long *port)
1535 switch (po_get_numeric(options, "mountport", &tmp)) {
1539 if (tmp >= 0 && tmp <= 65535) {
1544 nfs_error(_("%s: invalid value for 'mountport=' option"),
1550 * MNT service port wasn't specified. The pmap port value
1551 * will be filled in later by an rpcbind query in this case.
1558 * Returns TRUE and fills in @family if a valid MNT protocol option
1559 * is found, or FALSE if the option was specified with an invalid value
1560 * or if the protocol family isn't supported. On error, errno is set.
1562 int nfs_mount_proto_family(struct mount_options *options,
1563 sa_family_t *family)
1565 unsigned long protocol;
1567 sa_family_t tmp_family = config_default_family;
1569 option = po_get(options, "mountproto");
1570 if (option != NULL) {
1571 if (!nfs_get_proto(option, &tmp_family, &protocol)) {
1572 nfs_error(_("%s: Failed to find '%s' protocol"),
1574 errno = EPROTONOSUPPORT;
1577 if (!nfs_verify_family(tmp_family))
1579 *family = tmp_family;
1584 * MNT transport protocol wasn't specified. If the NFS
1585 * transport protocol was specified, derive the family
1586 * from that; otherwise, return the default family for
1589 return nfs_nfs_proto_family(options, family);
1591 errno = EAFNOSUPPORT;
1596 * nfs_options2pmap - set up pmap structs based on mount options
1597 * @options: pointer to mount options
1598 * @nfs_pmap: OUT: pointer to pmap arguments for NFS server
1599 * @mnt_pmap: OUT: pointer to pmap arguments for mountd server
1601 * Returns TRUE if the pmap options specified in @options have valid
1602 * values; otherwise FALSE is returned.
1604 int nfs_options2pmap(struct mount_options *options,
1605 struct pmap *nfs_pmap, struct pmap *mnt_pmap)
1607 if (!nfs_nfs_program(options, &nfs_pmap->pm_prog))
1609 if (!nfs_nfs_version(options, &nfs_pmap->pm_vers))
1611 if (!nfs_nfs_protocol(options, &nfs_pmap->pm_prot))
1613 if (!nfs_nfs_port(options, &nfs_pmap->pm_port))
1616 if (!nfs_mount_program(options, &mnt_pmap->pm_prog))
1618 if (!nfs_mount_version(options, &mnt_pmap->pm_vers))
1620 if (!nfs_mount_protocol(options, &mnt_pmap->pm_prot))
1622 if (!nfs_mount_port(options, &mnt_pmap->pm_port))
1629 * Discover mount server's hostname/address by examining mount options
1631 * Returns a pointer to a string that the caller must free, on
1632 * success; otherwise NULL is returned.
1634 static char *nfs_umount_hostname(struct mount_options *options,
1639 option = po_get(options, "mountaddr");
1642 option = po_get(options, "mounthost");
1645 option = po_get(options, "addr");
1653 return strdup(option);
1658 * Returns EX_SUCCESS if mount options and device name have been
1659 * parsed successfully; otherwise EX_FAIL.
1661 int nfs_umount_do_umnt(struct mount_options *options,
1662 char **hostname, char **dirname)
1664 union nfs_sockaddr address;
1665 struct sockaddr *sap = &address.sa;
1666 socklen_t salen = sizeof(address);
1667 struct pmap nfs_pmap, mnt_pmap;
1670 if (!nfs_options2pmap(options, &nfs_pmap, &mnt_pmap))
1673 /* Skip UMNT call for vers=4 mounts */
1674 if (nfs_pmap.pm_vers == 4)
1677 *hostname = nfs_umount_hostname(options, *hostname);
1679 nfs_error(_("%s: out of memory"), progname);
1683 if (!nfs_mount_proto_family(options, &family))
1685 if (!nfs_lookup(*hostname, family, sap, &salen))
1686 /* nfs_lookup reports any errors */
1689 if (nfs_advise_umount(sap, salen, &mnt_pmap, dirname) == 0)
1690 /* nfs_advise_umount reports any errors */