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"
54 #define PMAP_TIMEOUT (10)
55 #define CONNECT_TIMEOUT (20)
56 #define MOUNT_TIMEOUT (30)
58 #if SIZEOF_SOCKLEN_T - 0 == 0
59 #define socklen_t unsigned int
62 extern int nfs_mount_data_version;
63 extern char *progname;
66 static const char *nfs_ns_pgmtbl[] = {
71 static const char *nfs_mnt_pgmtbl[] = {
77 static const char *nfs_nfs_pgmtbl[] = {
83 static const char *nfs_transport_opttbl[] = {
90 static const char *nfs_version_opttbl[] = {
98 static const unsigned long nfs_to_mnt[] = {
105 static const unsigned long mnt_to_nfs[] = {
113 * Map an NFS version into the corresponding Mountd version
115 unsigned long nfsvers_to_mnt(const unsigned long vers)
118 return nfs_to_mnt[vers];
123 * Map a Mountd version into the corresponding NFS version
125 static unsigned long mntvers_to_nfs(const unsigned long vers)
128 return mnt_to_nfs[vers];
132 static const unsigned int probe_udp_only[] = {
137 static const unsigned int probe_udp_first[] = {
143 static const unsigned int probe_tcp_first[] = {
149 static const unsigned long probe_nfs2_only[] = {
154 static const unsigned long probe_nfs3_first[] = {
160 static const unsigned long probe_mnt1_first[] = {
166 static const unsigned long probe_mnt3_first[] = {
173 static void nfs_set_port(struct sockaddr *sap, const unsigned short port)
175 switch (sap->sa_family) {
177 ((struct sockaddr_in *)sap)->sin_port = htons(port);
180 ((struct sockaddr_in6 *)sap)->sin6_port = htons(port);
183 nfs_error(_("%s: unrecognized address family in %s"),
188 static int nfs_lookup(const char *hostname, const sa_family_t family,
189 struct sockaddr *sap, socklen_t *salen)
191 struct addrinfo *gai_results;
192 struct addrinfo gai_hint = {
193 #ifdef HAVE_DECL_AI_ADDRCONFIG
194 .ai_flags = AI_ADDRCONFIG,
195 #endif /* HAVE_DECL_AI_ADDRCONFIG */
198 socklen_t len = *salen;
203 error = getaddrinfo(hostname, NULL, &gai_hint, &gai_results);
208 nfs_error(_("%s: DNS resolution failed for %s: %s"),
209 progname, hostname, strerror(errno));
212 nfs_error(_("%s: DNS resolution failed for %s: %s"),
213 progname, hostname, gai_strerror(error));
217 switch (gai_results->ai_addr->sa_family) {
220 if (len >= gai_results->ai_addrlen) {
221 *salen = gai_results->ai_addrlen;
222 memcpy(sap, gai_results->ai_addr, *salen);
227 /* things are really broken if we get here, so warn */
228 nfs_error(_("%s: unrecognized DNS resolution results for %s"),
233 freeaddrinfo(gai_results);
238 * nfs_name_to_address - resolve hostname to an IPv4 or IPv6 socket address
239 * @hostname: pointer to C string containing DNS hostname to resolve
240 * @sap: pointer to buffer to fill with socket address
241 * @len: IN: size of buffer to fill; OUT: size of socket address
243 * Returns 1 and places a socket address at @sap if successful;
246 int nfs_name_to_address(const char *hostname,
247 struct sockaddr *sap, socklen_t *salen)
249 #ifdef IPV6_SUPPORTED
250 return nfs_lookup(hostname, AF_UNSPEC, sap, salen);
251 #else /* !IPV6_SUPPORTED */
252 return nfs_lookup(hostname, AF_INET, sap, salen);
253 #endif /* !IPV6_SUPPORTED */
257 * nfs_gethostbyname - resolve a hostname to an IPv4 address
258 * @hostname: pointer to a C string containing a DNS hostname
259 * @sin: returns an IPv4 address
261 * Returns 1 if successful, otherwise zero.
263 int nfs_gethostbyname(const char *hostname, struct sockaddr_in *sin)
265 socklen_t len = sizeof(*sin);
267 return nfs_lookup(hostname, AF_INET, (struct sockaddr *)sin, &len);
271 * nfs_string_to_sockaddr - convert string address to sockaddr
272 * @address: pointer to presentation format address to convert
273 * @addrlen: length of presentation address
274 * @sap: pointer to socket address buffer to fill in
275 * @salen: IN: length of address buffer
276 * OUT: length of converted socket address
278 * Convert a presentation format address string to a socket address.
279 * Similar to nfs_name_to_address(), but the DNS query is squelched,
280 * and won't make any noise if the getaddrinfo() call fails.
282 * Returns 1 and fills in @sap and @salen if successful; otherwise zero.
284 * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
285 * on presenting IPv6 addresses as text strings.
287 int nfs_string_to_sockaddr(const char *address, const size_t addrlen,
288 struct sockaddr *sap, socklen_t *salen)
290 struct addrinfo *gai_results;
291 struct addrinfo gai_hint = {
292 .ai_flags = AI_NUMERICHOST,
294 socklen_t len = *salen;
299 if (getaddrinfo(address, NULL, &gai_hint, &gai_results) == 0) {
300 switch (gai_results->ai_addr->sa_family) {
303 if (len >= gai_results->ai_addrlen) {
304 *salen = gai_results->ai_addrlen;
305 memcpy(sap, gai_results->ai_addr, *salen);
310 freeaddrinfo(gai_results);
317 * nfs_present_sockaddr - convert sockaddr to string
318 * @sap: pointer to socket address to convert
319 * @salen: length of socket address
320 * @buf: pointer to buffer to fill in
321 * @buflen: length of buffer
323 * Convert the passed-in sockaddr-style address to presentation format.
324 * The presentation format address is placed in @buf and is
327 * Returns 1 if successful; otherwise zero.
329 * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
330 * on presenting IPv6 addresses as text strings.
332 int nfs_present_sockaddr(const struct sockaddr *sap, const socklen_t salen,
333 char *buf, const size_t buflen)
335 #ifdef HAVE_GETNAMEINFO
338 result = getnameinfo(sap, salen, buf, buflen,
339 NULL, 0, NI_NUMERICHOST);
343 nfs_error(_("%s: invalid server address: %s"), progname,
344 gai_strerror(result));
346 #else /* HAVE_GETNAMEINFO */
349 if (sap->sa_family == AF_INET) {
350 addr = inet_ntoa(((struct sockaddr_in *)sap)->sin_addr);
351 if (addr && strlen(addr) < buflen) {
357 nfs_error(_("%s: invalid server address"), progname);
359 #endif /* HAVE_GETNAMEINFO */
363 * Attempt to connect a socket, but time out after "timeout" seconds.
365 * On error return, caller closes the socket.
367 static int connect_to(int fd, struct sockaddr *addr,
368 socklen_t addrlen, int timeout)
372 struct timeval tv = {
376 saved = fcntl(fd, F_GETFL, 0);
377 fcntl(fd, F_SETFL, saved | O_NONBLOCK);
379 ret = connect(fd, addr, addrlen);
380 if (ret < 0 && errno != EINPROGRESS)
388 ret = select(fd + 1, &rset, &wset, NULL, &tv);
393 if (FD_ISSET(fd, &rset) || FD_ISSET(fd, &wset)) {
395 socklen_t len = sizeof(error);
396 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0)
406 fcntl(fd, F_SETFL, saved);
411 * Create a socket that is locally bound to a reserved or non-reserved port.
413 * The caller should check rpc_createerr to determine the cause of any error.
415 static int get_socket(struct sockaddr_in *saddr, unsigned int p_prot,
416 unsigned int timeout, int resvp, int conn)
419 struct sockaddr_in laddr;
420 socklen_t namelen = sizeof(laddr);
422 type = (p_prot == IPPROTO_UDP ? SOCK_DGRAM : SOCK_STREAM);
423 if ((so = socket (AF_INET, type, p_prot)) < 0)
426 laddr.sin_family = AF_INET;
428 laddr.sin_addr.s_addr = htonl(INADDR_ANY);
430 if (bindresvport(so, &laddr) < 0)
431 goto err_bindresvport;
433 cc = bind(so, (struct sockaddr *)&laddr, namelen);
437 if (type == SOCK_STREAM || (conn && type == SOCK_DGRAM)) {
438 cc = connect_to(so, (struct sockaddr *)saddr, namelen,
446 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
447 rpc_createerr.cf_error.re_errno = errno;
449 nfs_error(_("%s: Unable to create %s socket: errno %d (%s)\n"),
450 progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
451 errno, strerror(errno));
456 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
457 rpc_createerr.cf_error.re_errno = errno;
459 nfs_error(_("%s: Unable to bindresvport %s socket: errno %d"
461 progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
462 errno, strerror(errno));
468 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
469 rpc_createerr.cf_error.re_errno = errno;
471 nfs_error(_("%s: Unable to bind to %s socket: errno %d (%s)\n"),
472 progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
473 errno, strerror(errno));
479 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
480 rpc_createerr.cf_error.re_errno = errno;
482 nfs_error(_("%s: Unable to connect to %s:%d, errno %d (%s)\n"),
483 progname, inet_ntoa(saddr->sin_addr),
484 ntohs(saddr->sin_port), errno, strerror(errno));
490 static void nfs_pp_debug(const struct sockaddr *sap, const socklen_t salen,
491 const rpcprog_t program, const rpcvers_t version,
492 const unsigned short protocol,
493 const unsigned short port)
495 char buf[NI_MAXHOST];
500 if (nfs_present_sockaddr(sap, salen, buf, sizeof(buf)) == 0) {
502 strcat(buf, "unknown host");
505 fprintf(stderr, _("%s: trying %s prog %lu vers %lu prot %s port %d\n"),
506 progname, buf, (unsigned long)program,
507 (unsigned long)version,
508 (protocol == IPPROTO_UDP ? _("UDP") : _("TCP")),
513 * Use the portmapper to discover whether or not the service we want is
514 * available. The lists 'versions' and 'protos' define ordered sequences
515 * of service versions and udp/tcp protocols to probe for.
517 * Returns 1 if the requested service port is unambiguous and pingable;
518 * @pmap is filled in with the version, port, and transport protocol used
519 * during the successful ping. Note that if a port is already specified
520 * in @pmap and it matches the rpcbind query result, nfs_probe_port() does
521 * not perform an RPC ping.
523 * If an error occurs or the requested service isn't available, zero is
524 * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
526 static int nfs_probe_port(const struct sockaddr *sap, const socklen_t salen,
527 struct pmap *pmap, const unsigned long *versions,
528 const unsigned int *protos)
530 struct sockaddr_storage address;
531 struct sockaddr *saddr = (struct sockaddr *)&address;
532 const unsigned long prog = pmap->pm_prog, *p_vers;
533 const unsigned int prot = (u_int)pmap->pm_prot, *p_prot;
534 const u_short port = (u_short) pmap->pm_port;
535 unsigned long vers = pmap->pm_vers;
536 unsigned short p_port;
538 memcpy(saddr, sap, salen);
539 p_prot = prot ? &prot : protos;
540 p_vers = vers ? &vers : versions;
541 rpc_createerr.cf_stat = 0;
544 p_port = nfs_getport(saddr, salen, prog, *p_vers, *p_prot);
546 if (!port || port == p_port) {
547 nfs_set_port(saddr, p_port);
548 nfs_pp_debug(saddr, salen, prog, *p_vers,
550 if (nfs_rpc_ping(saddr, salen, prog,
551 *p_vers, *p_prot, NULL))
555 if (rpc_createerr.cf_stat != RPC_PROGNOTREGISTERED &&
556 rpc_createerr.cf_stat != RPC_TIMEDOUT &&
557 rpc_createerr.cf_stat != RPC_CANTRECV &&
558 rpc_createerr.cf_stat != RPC_PROGVERSMISMATCH)
566 if (rpc_createerr.cf_stat == RPC_TIMEDOUT ||
567 rpc_createerr.cf_stat == RPC_CANTRECV)
570 if (vers || !*++p_vers)
579 pmap->pm_vers = *p_vers;
581 pmap->pm_prot = *p_prot;
583 pmap->pm_port = p_port;
584 rpc_createerr.cf_stat = 0;
589 * Probe a server's NFS service to determine which versions and
590 * transport protocols are supported.
592 * Returns 1 if the requested service port is unambiguous and pingable;
593 * @pmap is filled in with the version, port, and transport protocol used
594 * during the successful ping. If all three are already specified, simply
595 * return success without an rpcbind query or RPC ping (we may be trying
596 * to mount an NFS service that is not advertised via rpcbind).
598 * If an error occurs or the requested service isn't available, zero is
599 * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
601 static int nfs_probe_nfsport(const struct sockaddr *sap, const socklen_t salen,
604 if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
607 if (nfs_mount_data_version >= 4)
608 return nfs_probe_port(sap, salen, pmap,
609 probe_nfs3_first, probe_tcp_first);
611 return nfs_probe_port(sap, salen, pmap,
612 probe_nfs2_only, probe_udp_only);
616 * Probe a server's mountd service to determine which versions and
617 * transport protocols are supported.
619 * Returns 1 if the requested service port is unambiguous and pingable;
620 * @pmap is filled in with the version, port, and transport protocol used
621 * during the successful ping. If all three are already specified, simply
622 * return success without an rpcbind query or RPC ping (we may be trying
623 * to mount an NFS service that is not advertised via rpcbind).
625 * If an error occurs or the requested service isn't available, zero is
626 * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
628 static int nfs_probe_mntport(const struct sockaddr *sap, const socklen_t salen,
631 if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
634 if (nfs_mount_data_version >= 4)
635 return nfs_probe_port(sap, salen, pmap,
636 probe_mnt3_first, probe_udp_first);
638 return nfs_probe_port(sap, salen, pmap,
639 probe_mnt1_first, probe_udp_only);
643 * Probe a server's mountd service to determine which versions and
644 * transport protocols are supported. Invoked when the protocol
645 * version is already known for both the NFS and mountd service.
647 * Returns 1 and fills in both @pmap structs if the requested service
648 * ports are unambiguous and pingable. Otherwise zero is returned;
649 * rpccreateerr.cf_stat is set to reflect the nature of the error.
651 static int nfs_probe_version_fixed(const struct sockaddr *mnt_saddr,
652 const socklen_t mnt_salen,
653 struct pmap *mnt_pmap,
654 const struct sockaddr *nfs_saddr,
655 const socklen_t nfs_salen,
656 struct pmap *nfs_pmap)
658 if (!nfs_probe_nfsport(nfs_saddr, nfs_salen, nfs_pmap))
660 return nfs_probe_mntport(mnt_saddr, mnt_salen, mnt_pmap);
664 * nfs_probe_bothports - discover the RPC endpoints of mountd and NFS server
665 * @mnt_saddr: pointer to socket address of mountd server
666 * @mnt_salen: length of mountd server's address
667 * @mnt_pmap: IN: partially filled-in mountd RPC service tuple;
668 * OUT: fully filled-in mountd RPC service tuple
669 * @nfs_saddr: pointer to socket address of NFS server
670 * @nfs_salen: length of NFS server's address
671 * @nfs_pmap: IN: partially filled-in NFS RPC service tuple;
672 * OUT: fully filled-in NFS RPC service tuple
674 * Returns 1 and fills in both @pmap structs if the requested service
675 * ports are unambiguous and pingable. Otherwise zero is returned;
676 * rpccreateerr.cf_stat is set to reflect the nature of the error.
678 int nfs_probe_bothports(const struct sockaddr *mnt_saddr,
679 const socklen_t mnt_salen,
680 struct pmap *mnt_pmap,
681 const struct sockaddr *nfs_saddr,
682 const socklen_t nfs_salen,
683 struct pmap *nfs_pmap)
685 struct pmap save_nfs, save_mnt;
686 const unsigned long *probe_vers;
688 if (mnt_pmap->pm_vers && !nfs_pmap->pm_vers)
689 nfs_pmap->pm_vers = mntvers_to_nfs(mnt_pmap->pm_vers);
690 else if (nfs_pmap->pm_vers && !mnt_pmap->pm_vers)
691 mnt_pmap->pm_vers = nfsvers_to_mnt(nfs_pmap->pm_vers);
693 if (nfs_pmap->pm_vers)
694 return nfs_probe_version_fixed(mnt_saddr, mnt_salen, mnt_pmap,
695 nfs_saddr, nfs_salen, nfs_pmap);
697 memcpy(&save_nfs, nfs_pmap, sizeof(save_nfs));
698 memcpy(&save_mnt, mnt_pmap, sizeof(save_mnt));
699 probe_vers = (nfs_mount_data_version >= 4) ?
700 probe_mnt3_first : probe_mnt1_first;
702 for (; *probe_vers; probe_vers++) {
703 nfs_pmap->pm_vers = mntvers_to_nfs(*probe_vers);
704 if (nfs_probe_nfsport(nfs_saddr, nfs_salen, nfs_pmap) != 0) {
705 mnt_pmap->pm_vers = *probe_vers;
706 if (nfs_probe_mntport(mnt_saddr, mnt_salen, mnt_pmap) != 0)
708 memcpy(mnt_pmap, &save_mnt, sizeof(*mnt_pmap));
710 switch (rpc_createerr.cf_stat) {
711 case RPC_PROGVERSMISMATCH:
712 case RPC_PROGNOTREGISTERED:
717 memcpy(nfs_pmap, &save_nfs, sizeof(*nfs_pmap));
724 * probe_bothports - discover the RPC endpoints of mountd and NFS server
725 * @mnt_server: pointer to address and pmap argument for mountd results
726 * @nfs_server: pointer to address and pmap argument for NFS server
728 * This is the legacy API that takes "clnt_addr_t" for both servers,
729 * but supports only AF_INET addresses.
731 * Returns 1 and fills in the pmap field in both clnt_addr_t structs
732 * if the requested service ports are unambiguous and pingable.
733 * Otherwise zero is returned; rpccreateerr.cf_stat is set to reflect
734 * the nature of the error.
736 int probe_bothports(clnt_addr_t *mnt_server, clnt_addr_t *nfs_server)
738 return nfs_probe_bothports((struct sockaddr *)&mnt_server->saddr,
739 sizeof(mnt_server->saddr),
741 (struct sockaddr *)&nfs_server->saddr,
742 sizeof(nfs_server->saddr),
746 static int nfs_probe_statd(void)
748 struct sockaddr_in addr = {
749 .sin_family = AF_INET,
750 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
752 rpcprog_t program = nfs_getrpcbyname(NSMPROG, nfs_ns_pgmtbl);
754 return nfs_getport_ping((struct sockaddr *)&addr, sizeof(addr),
755 program, (rpcvers_t)1, IPPROTO_UDP);
759 * start_statd - attempt to start rpc.statd
761 * Returns 1 if statd is running; otherwise zero.
763 int start_statd(void)
769 if (nfs_probe_statd())
773 if (stat(START_STATD, &stb) == 0) {
774 if (S_ISREG(stb.st_mode) && (stb.st_mode & S_IXUSR)) {
778 execl(START_STATD, START_STATD, NULL);
781 nfs_error(_("fork failed: %s"),
784 default: /* parent */
785 waitpid(pid, NULL,0);
788 if (nfs_probe_statd())
798 * nfs_advise_umount - ask the server to remove a share from it's rmtab
799 * @sap: pointer to IP address of server to call
800 * @salen: length of server address
801 * @pmap: partially filled-in mountd RPC service tuple
802 * @argp: directory path of share to "unmount"
804 * Returns one if the unmount call succeeded; zero if the unmount
805 * failed for any reason; rpccreateerr.cf_stat is set to reflect
806 * the nature of the error.
808 * We use a fast timeout since this call is advisory only.
810 int nfs_advise_umount(const struct sockaddr *sap, const socklen_t salen,
811 const struct pmap *pmap, const dirpath *argp)
813 struct sockaddr_storage address;
814 struct sockaddr *saddr = (struct sockaddr *)&address;
815 struct pmap mnt_pmap = *pmap;
816 struct timeval timeout = {
817 .tv_sec = MOUNT_TIMEOUT >> 3,
820 enum clnt_stat res = 0;
822 memcpy(saddr, sap, salen);
823 if (nfs_probe_mntport(saddr, salen, &mnt_pmap) == 0) {
825 nfs_error(_("%s: Failed to discover mountd port%s"),
826 progname, clnt_spcreateerror(""));
829 nfs_set_port(saddr, mnt_pmap.pm_port);
831 client = nfs_get_priv_rpcclient(saddr, salen, mnt_pmap.pm_prot,
832 mnt_pmap.pm_prog, mnt_pmap.pm_vers,
834 if (client == NULL) {
836 nfs_error(_("%s: Failed to create RPC client%s"),
837 progname, clnt_spcreateerror(""));
841 client->cl_auth = authunix_create_default();
843 res = CLNT_CALL(client, MOUNTPROC_UMNT,
844 (xdrproc_t)xdr_dirpath, (caddr_t)argp,
845 (xdrproc_t)xdr_void, NULL,
847 if (verbose && res != RPC_SUCCESS)
848 nfs_error(_("%s: UMNT call failed: %s"),
849 progname, clnt_sperrno(res));
851 auth_destroy(client->cl_auth);
852 CLNT_DESTROY(client);
854 if (res != RPC_SUCCESS)
860 * nfs_call_umount - ask the server to remove a share from it's rmtab
861 * @mnt_server: address of RPC MNT program server
862 * @argp: directory path of share to "unmount"
864 * Returns one if the unmount call succeeded; zero if the unmount
865 * failed for any reason.
867 * Note that a side effect of calling this function is that rpccreateerr
870 int nfs_call_umount(clnt_addr_t *mnt_server, dirpath *argp)
872 struct sockaddr *sap = (struct sockaddr *)&mnt_server->saddr;
873 socklen_t salen = sizeof(mnt_server->saddr);
874 struct pmap *pmap = &mnt_server->pmap;
876 enum clnt_stat res = 0;
879 if (!nfs_probe_mntport(sap, salen, pmap))
881 clnt = mnt_openclnt(mnt_server, &msock);
884 res = clnt_call(clnt, MOUNTPROC_UMNT,
885 (xdrproc_t)xdr_dirpath, (caddr_t)argp,
886 (xdrproc_t)xdr_void, NULL,
888 mnt_closeclnt(clnt, msock);
890 if (res == RPC_SUCCESS)
896 * mnt_openclnt - get a handle for a remote mountd service
897 * @mnt_server: address and pmap arguments of mountd service
898 * @msock: returns a file descriptor of the underlying transport socket
900 * Returns an active handle for the remote's mountd service
902 CLIENT *mnt_openclnt(clnt_addr_t *mnt_server, int *msock)
904 struct sockaddr_in *mnt_saddr = &mnt_server->saddr;
905 struct pmap *mnt_pmap = &mnt_server->pmap;
908 mnt_saddr->sin_port = htons((u_short)mnt_pmap->pm_port);
909 *msock = get_socket(mnt_saddr, mnt_pmap->pm_prot, MOUNT_TIMEOUT,
911 if (*msock == RPC_ANYSOCK) {
912 if (rpc_createerr.cf_error.re_errno == EADDRINUSE)
914 * Probably in-use by a TIME_WAIT connection,
915 * It is worth waiting a while and trying again.
917 rpc_createerr.cf_stat = RPC_TIMEDOUT;
921 switch (mnt_pmap->pm_prot) {
923 clnt = clntudp_bufcreate(mnt_saddr,
924 mnt_pmap->pm_prog, mnt_pmap->pm_vers,
925 RETRY_TIMEOUT, msock,
926 MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
929 clnt = clnttcp_create(mnt_saddr,
930 mnt_pmap->pm_prog, mnt_pmap->pm_vers,
932 MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
936 /* try to mount hostname:dirname */
937 clnt->cl_auth = authunix_create_default();
944 * mnt_closeclnt - terminate a handle for a remote mountd service
945 * @clnt: pointer to an active handle for a remote mountd service
946 * @msock: file descriptor of the underlying transport socket
949 void mnt_closeclnt(CLIENT *clnt, int msock)
951 auth_destroy(clnt->cl_auth);
957 * clnt_ping - send an RPC ping to the remote RPC service endpoint
958 * @saddr: server's address
959 * @prog: target RPC program number
960 * @vers: target RPC version number
961 * @prot: target RPC protocol
962 * @caddr: filled in with our network address
964 * Sigh... GETPORT queries don't actually check the version number.
965 * In order to make sure that the server actually supports the service
966 * we're requesting, we open an RPC client, and fire off a NULL
969 * caddr is the network address that the server will use to call us back.
970 * On multi-homed clients, this address depends on which NIC we use to
971 * route requests to the server.
973 * Returns one if successful, otherwise zero.
975 int clnt_ping(struct sockaddr_in *saddr, const unsigned long prog,
976 const unsigned long vers, const unsigned int prot,
977 struct sockaddr_in *caddr)
981 static char clnt_res;
982 struct sockaddr dissolve;
984 rpc_createerr.cf_stat = stat = 0;
985 sock = get_socket(saddr, prot, CONNECT_TIMEOUT, FALSE, TRUE);
986 if (sock == RPC_ANYSOCK) {
987 if (rpc_createerr.cf_error.re_errno == ETIMEDOUT) {
989 * TCP timeout. Bubble up the error to see
990 * how it should be handled.
992 rpc_createerr.cf_stat = RPC_TIMEDOUT;
998 /* Get the address of our end of this connection */
999 socklen_t len = sizeof(*caddr);
1000 if (getsockname(sock, caddr, &len) != 0)
1001 caddr->sin_family = 0;
1006 /* The socket is connected (so we could getsockname successfully),
1007 * but some servers on multi-homed hosts reply from
1008 * the wrong address, so if we stay connected, we lose the reply.
1010 dissolve.sa_family = AF_UNSPEC;
1011 connect(sock, &dissolve, sizeof(dissolve));
1013 clnt = clntudp_bufcreate(saddr, prog, vers,
1014 RETRY_TIMEOUT, &sock,
1015 RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
1018 clnt = clnttcp_create(saddr, prog, vers, &sock,
1019 RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
1026 memset(&clnt_res, 0, sizeof(clnt_res));
1027 stat = clnt_call(clnt, NULLPROC,
1028 (xdrproc_t)xdr_void, (caddr_t)NULL,
1029 (xdrproc_t)xdr_void, (caddr_t)&clnt_res,
1032 clnt_geterr(clnt, &rpc_createerr.cf_error);
1033 rpc_createerr.cf_stat = stat;
1038 if (stat == RPC_SUCCESS)
1045 * Try a getsockname() on a connected datagram socket.
1047 * Returns 1 and fills in @buf if successful; otherwise, zero.
1049 * A connected datagram socket prevents leaving a socket in TIME_WAIT.
1050 * This conserves the ephemeral port number space, helping reduce failed
1051 * socket binds during mount storms.
1053 static int nfs_ca_sockname(const struct sockaddr *sap, const socklen_t salen,
1054 struct sockaddr *buf, socklen_t *buflen)
1056 struct sockaddr_in sin = {
1057 .sin_family = AF_INET,
1058 .sin_addr.s_addr = htonl(INADDR_ANY),
1060 struct sockaddr_in6 sin6 = {
1061 .sin6_family = AF_INET6,
1062 .sin6_addr = IN6ADDR_ANY_INIT,
1066 sock = socket(sap->sa_family, SOCK_DGRAM, IPPROTO_UDP);
1070 switch (sap->sa_family) {
1072 if (bind(sock, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
1078 if (bind(sock, (struct sockaddr *)&sin6, sizeof(sin6)) < 0) {
1084 errno = EAFNOSUPPORT;
1088 if (connect(sock, sap, salen) < 0) {
1093 return !getsockname(sock, buf, buflen);
1097 * Try to generate an address that prevents the server from calling us.
1099 * Returns 1 and fills in @buf if successful; otherwise, zero.
1101 static int nfs_ca_gai(const struct sockaddr *sap, const socklen_t salen,
1102 struct sockaddr *buf, socklen_t *buflen)
1104 struct addrinfo *gai_results;
1105 struct addrinfo gai_hint = {
1106 .ai_family = sap->sa_family,
1107 .ai_flags = AI_PASSIVE, /* ANYADDR */
1110 if (getaddrinfo(NULL, "", &gai_hint, &gai_results))
1113 *buflen = gai_results->ai_addrlen;
1114 memcpy(buf, gai_results->ai_addr, *buflen);
1116 freeaddrinfo(gai_results);
1122 * nfs_callback_address - acquire our local network address
1123 * @sap: pointer to address of remote
1124 * @sap_len: length of address
1125 * @buf: pointer to buffer to be filled in with local network address
1126 * @buflen: IN: length of buffer to fill in; OUT: length of filled-in address
1128 * Discover a network address that an NFSv4 server can use to call us back.
1129 * On multi-homed clients, this address depends on which NIC we use to
1130 * route requests to the server.
1132 * Returns 1 and fills in @buf if an unambiguous local address is
1133 * available; returns 1 and fills in an appropriate ANYADDR address
1134 * if a local address isn't available; otherwise, returns zero.
1136 int nfs_callback_address(const struct sockaddr *sap, const socklen_t salen,
1137 struct sockaddr *buf, socklen_t *buflen)
1139 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1141 if (nfs_ca_sockname(sap, salen, buf, buflen) == 0)
1142 if (nfs_ca_gai(sap, salen, buf, buflen) == 0)
1146 * The server can't use an interface ID that was generated
1147 * here on the client, so always clear sin6_scope_id.
1149 if (sin6->sin6_family == AF_INET6)
1150 sin6->sin6_scope_id = 0;
1157 nfs_error(_("%s: failed to construct callback address"));
1163 * "nfsprog" is only supported by the legacy mount command. The
1164 * kernel mount client does not support this option.
1166 * Returns the value set by the nfsprog= option, the value of
1167 * the RPC NFS program specified in /etc/rpc, or a baked-in
1168 * default program number, if all fails.
1170 static rpcprog_t nfs_nfs_program(struct mount_options *options)
1174 if (po_get_numeric(options, "nfsprog", &tmp) == PO_FOUND)
1177 return nfs_getrpcbyname(NFSPROG, nfs_nfs_pgmtbl);
1182 * Returns the RPC version number specified by the given mount
1183 * options for the NFS service, or zero if all fails.
1185 static rpcvers_t nfs_nfs_version(struct mount_options *options)
1189 switch (po_rightmost(options, nfs_version_opttbl)) {
1195 if (po_get_numeric(options, "vers", &tmp) == PO_FOUND)
1196 if (tmp >= 2 && tmp <= 3)
1199 case 3: /* nfsvers */
1200 if (po_get_numeric(options, "nfsvers", &tmp) == PO_FOUND)
1201 if (tmp >= 2 && tmp <= 3)
1210 * Returns the NFS transport protocol specified by the given mount options
1212 * Returns the IPPROTO_ value specified by the given mount options, or
1213 * IPPROTO_UDP if all fails.
1215 static unsigned short nfs_nfs_protocol(struct mount_options *options)
1219 switch (po_rightmost(options, nfs_transport_opttbl)) {
1223 option = po_get(options, "proto");
1225 if (strcmp(option, "tcp") == 0)
1227 if (strcmp(option, "udp") == 0)
1236 * Returns the NFS server's port number specified by the given
1237 * mount options, or zero if all fails. Zero results in a portmap
1238 * query to discover the server's mountd service port.
1240 * port=0 will guarantee an rpcbind request precedes the first
1241 * NFS RPC so the client can determine the server's port number.
1243 static unsigned short nfs_nfs_port(struct mount_options *options)
1247 if (po_get_numeric(options, "port", &tmp) == PO_FOUND)
1248 if (tmp >= 0 && tmp <= 65535)
1254 * "mountprog" is only supported by the legacy mount command. The
1255 * kernel mount client does not support this option.
1257 * Returns the value set by the mountprog= option, the value of
1258 * the RPC mount program specified in /etc/rpc, or a baked-in
1259 * default program number, if all fails.
1261 static rpcprog_t nfs_mount_program(struct mount_options *options)
1265 if (po_get_numeric(options, "mountprog", &tmp) == PO_FOUND)
1268 return nfs_getrpcbyname(MOUNTPROG, nfs_mnt_pgmtbl);
1272 * Returns the RPC version number specified by the given mount options,
1273 * or the version "3" if all fails.
1275 static rpcvers_t nfs_mount_version(struct mount_options *options)
1279 if (po_get_numeric(options, "mountvers", &tmp) == PO_FOUND)
1280 if (tmp >= 1 && tmp <= 4)
1283 return nfsvers_to_mnt(nfs_nfs_version(options));
1287 * Returns the transport protocol to use for the mount service
1289 * Returns the IPPROTO_ value specified by the mountproto option, or
1290 * if that doesn't exist, the IPPROTO_ value specified for NFS
1293 static unsigned short nfs_mount_protocol(struct mount_options *options)
1297 option = po_get(options, "mountproto");
1299 if (strcmp(option, "tcp") == 0)
1301 if (strcmp(option, "udp") == 0)
1305 return nfs_nfs_protocol(options);
1309 * Returns the mountd server's port number specified by the given
1310 * mount options, or zero if all fails. Zero results in a portmap
1311 * query to discover the server's mountd service port.
1313 * port=0 will guarantee an rpcbind request precedes the mount
1314 * RPC so the client can determine the server's port number.
1316 static unsigned short nfs_mount_port(struct mount_options *options)
1320 if (po_get_numeric(options, "mountport", &tmp) == PO_FOUND)
1321 if (tmp >= 0 && tmp <= 65535)
1327 * nfs_options2pmap - set up pmap structs based on mount options
1328 * @options: pointer to mount options
1329 * @nfs_pmap: OUT: pointer to pmap arguments for NFS server
1330 * @mnt_pmap: OUT: pointer to pmap arguments for mountd server
1333 void nfs_options2pmap(struct mount_options *options,
1334 struct pmap *nfs_pmap, struct pmap *mnt_pmap)
1336 nfs_pmap->pm_prog = nfs_nfs_program(options);
1337 nfs_pmap->pm_vers = nfs_nfs_version(options);
1338 nfs_pmap->pm_prot = nfs_nfs_protocol(options);
1339 nfs_pmap->pm_port = nfs_nfs_port(options);
1341 mnt_pmap->pm_prog = nfs_mount_program(options);
1342 mnt_pmap->pm_vers = nfs_mount_version(options);
1343 mnt_pmap->pm_prot = nfs_mount_protocol(options);
1344 mnt_pmap->pm_port = nfs_mount_port(options);