a97495392274edc0aa4a1021b70138c3dbb83f13
[nfs-utils.git] / utils / mount / network.c
1 /*
2  * network.c -- Provide common network functions for NFS mount/umount
3  *
4  * Copyright (C) 2007 Oracle.  All rights reserved.
5  * Copyright (C) 2007 Chuck Lever <chuck.lever@oracle.com>
6  *
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.
11  *
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.
16  *
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.
21  *
22  */
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <ctype.h>
29 #include <unistd.h>
30 #include <stdio.h>
31 #include <string.h>
32 #include <stdlib.h>
33 #include <errno.h>
34 #include <netdb.h>
35 #include <time.h>
36
37 #include <sys/types.h>
38 #include <sys/socket.h>
39 #include <sys/wait.h>
40 #include <netinet/in.h>
41 #include <rpc/rpc.h>
42 #include <rpc/pmap_prot.h>
43 #include <rpc/pmap_clnt.h>
44
45 #include "xcommon.h"
46 #include "mount.h"
47 #include "nls.h"
48 #include "nfs_mount.h"
49 #include "mount_constants.h"
50 #include "nfsrpc.h"
51 #include "parse_opt.h"
52 #include "network.h"
53
54 #define PMAP_TIMEOUT    (10)
55 #define CONNECT_TIMEOUT (20)
56 #define MOUNT_TIMEOUT   (30)
57
58 #if SIZEOF_SOCKLEN_T - 0 == 0
59 #define socklen_t unsigned int
60 #endif
61
62 extern int nfs_mount_data_version;
63 extern char *progname;
64 extern int verbose;
65
66 static const char *nfs_ns_pgmtbl[] = {
67         "status",
68         NULL,
69 };
70
71 static const char *nfs_mnt_pgmtbl[] = {
72         "mount",
73         "mountd",
74         NULL,
75 };
76
77 static const char *nfs_nfs_pgmtbl[] = {
78         "nfs",
79         "nfsprog",
80         NULL,
81 };
82
83 static const char *nfs_transport_opttbl[] = {
84         "udp",
85         "tcp",
86         "proto",
87         NULL,
88 };
89
90 static const char *nfs_version_opttbl[] = {
91         "v2",
92         "v3",
93         "vers",
94         "nfsvers",
95         NULL,
96 };
97
98 static const unsigned long nfs_to_mnt[] = {
99         0,
100         0,
101         1,
102         3,
103 };
104
105 static const unsigned long mnt_to_nfs[] = {
106         0,
107         2,
108         2,
109         3,
110 };
111
112 /*
113  * Map an NFS version into the corresponding Mountd version
114  */
115 unsigned long nfsvers_to_mnt(const unsigned long vers)
116 {
117         if (vers <= 3)
118                 return nfs_to_mnt[vers];
119         return 0;
120 }
121
122 /*
123  * Map a Mountd version into the corresponding NFS version
124  */
125 static unsigned long mntvers_to_nfs(const unsigned long vers)
126 {
127         if (vers <= 3)
128                 return mnt_to_nfs[vers];
129         return 0;
130 }
131
132 static const unsigned int probe_udp_only[] = {
133         IPPROTO_UDP,
134         0,
135 };
136
137 static const unsigned int probe_udp_first[] = {
138         IPPROTO_UDP,
139         IPPROTO_TCP,
140         0,
141 };
142
143 static const unsigned int probe_tcp_first[] = {
144         IPPROTO_TCP,
145         IPPROTO_UDP,
146         0,
147 };
148
149 static const unsigned long probe_nfs2_only[] = {
150         2,
151         0,
152 };
153
154 static const unsigned long probe_nfs3_first[] = {
155         3,
156         2,
157         0,
158 };
159
160 static const unsigned long probe_mnt1_first[] = {
161         1,
162         2,
163         0,
164 };
165
166 static const unsigned long probe_mnt3_first[] = {
167         3,
168         1,
169         2,
170         0,
171 };
172
173 static void nfs_set_port(struct sockaddr *sap, const unsigned short port)
174 {
175         switch (sap->sa_family) {
176         case AF_INET:
177                 ((struct sockaddr_in *)sap)->sin_port = htons(port);
178                 break;
179         case AF_INET6:
180                 ((struct sockaddr_in6 *)sap)->sin6_port = htons(port);
181                 break;
182         default:
183                 nfs_error(_("%s: unrecognized address family in %s"),
184                         progname, __func__);
185         }
186 }
187
188 #ifdef HAVE_DECL_AI_ADDRCONFIG
189 /**
190  * nfs_name_to_address - resolve hostname to an IPv4 or IPv6 socket address
191  * @hostname: pointer to C string containing DNS hostname to resolve
192  * @af_hint: hint to restrict resolution to one address family
193  * @sap: pointer to buffer to fill with socket address
194  * @len: IN: size of buffer to fill; OUT: size of socket address
195  *
196  * Returns 1 and places a socket address at @sap if successful;
197  * otherwise zero.
198  */
199 int nfs_name_to_address(const char *hostname,
200                         const sa_family_t af_hint,
201                         struct sockaddr *sap, socklen_t *salen)
202 {
203         struct addrinfo *gai_results;
204         struct addrinfo gai_hint = {
205                 .ai_family      = af_hint,
206                 .ai_flags       = AI_ADDRCONFIG,
207         };
208         socklen_t len = *salen;
209         int error, ret = 0;
210
211         if (af_hint == AF_INET6)
212                 gai_hint.ai_flags |= AI_V4MAPPED|AI_ALL;
213
214         *salen = 0;
215
216         error = getaddrinfo(hostname, NULL, &gai_hint, &gai_results);
217         if (error) {
218                 nfs_error(_("%s: DNS resolution failed for %s: %s"),
219                         progname, hostname, (error == EAI_SYSTEM ?
220                                 strerror(errno) : gai_strerror(error)));
221                 return ret;
222         }
223
224         switch (gai_results->ai_addr->sa_family) {
225         case AF_INET:
226         case AF_INET6:
227                 if (len >= gai_results->ai_addrlen) {
228                         *salen = gai_results->ai_addrlen;
229                         memcpy(sap, gai_results->ai_addr, *salen);
230                         ret = 1;
231                 }
232                 break;
233         default:
234                 /* things are really broken if we get here, so warn */
235                 nfs_error(_("%s: unrecognized DNS resolution results for %s"),
236                                 progname, hostname);
237                 break;
238         }
239
240         freeaddrinfo(gai_results);
241         return ret;
242 }
243 #else   /* HAVE_DECL_AI_ADDRCONFIG */
244 /**
245  * nfs_name_to_address - resolve hostname to an IPv4 socket address
246  * @hostname: pointer to C string containing DNS hostname to resolve
247  * @af_hint: hint to restrict resolution to one address family
248  * @sap: pointer to buffer to fill with socket address
249  * @len: IN: size of buffer to fill; OUT: size of socket address
250  *
251  * Returns 1 and places a socket address at @sap if successful;
252  * otherwise zero.
253  *
254  * Some older getaddrinfo(3) implementations don't support
255  * AI_ADDRCONFIG or AI_V4MAPPED properly.  For those cases, a DNS
256  * resolver based on the traditional gethostbyname(3) is provided.
257  */
258 int nfs_name_to_address(const char *hostname,
259                         const sa_family_t af_hint,
260                         struct sockaddr *sap, socklen_t *salen)
261 {
262         struct sockaddr_in *sin = (struct sockaddr_in *)sap;
263         socklen_t len = *salen;
264         struct hostent *hp;
265
266         *salen = 0;
267
268         if (af_hint != AF_INET) {
269                 nfs_error(_("%s: address family not supported by DNS resolver\n"),
270                                 progname, hostname);
271                 return 0;
272         }
273
274         sin->sin_family = AF_INET;
275         if (inet_aton(hostname, &sin->sin_addr)) {
276                 *salen = sizeof(*sin);
277                 return 1;
278         }
279
280         hp = gethostbyname(hostname);
281         if (hp == NULL) {
282                 nfs_error(_("%s: DNS resolution failed for %s: %s"),
283                                 progname, hostname, hstrerror(h_errno));
284                 return 0;
285         }
286
287         if (hp->h_length > len) {
288                 nfs_error(_("%s: DNS resolution results too long for buffer\n"),
289                                 progname);
290                 return 0;
291         }
292
293         memcpy(&sin->sin_addr, hp->h_addr, hp->h_length);
294         *salen = hp->h_length;
295         return 1;
296 }
297 #endif  /* HAVE_DECL_AI_ADDRCONFIG */
298
299 /**
300  * nfs_gethostbyname - resolve a hostname to an IPv4 address
301  * @hostname: pointer to a C string containing a DNS hostname
302  * @sin: returns an IPv4 address 
303  *
304  * Returns 1 if successful, otherwise zero.
305  */
306 int nfs_gethostbyname(const char *hostname, struct sockaddr_in *sin)
307 {
308         socklen_t len = sizeof(*sin);
309
310         return nfs_name_to_address(hostname, AF_INET,
311                                         (struct sockaddr *)sin, &len);
312 }
313
314 /**
315  * nfs_string_to_sockaddr - convert string address to sockaddr
316  * @address:    pointer to presentation format address to convert
317  * @addrlen:    length of presentation address
318  * @sap:        pointer to socket address buffer to fill in
319  * @salen:      IN: length of address buffer
320  *              OUT: length of converted socket address
321  *
322  * Convert a presentation format address string to a socket address.
323  * Similar to nfs_name_to_address(), but the DNS query is squelched,
324  * and won't make any noise if the getaddrinfo() call fails.
325  *
326  * Returns 1 and fills in @sap and @salen if successful; otherwise zero.
327  *
328  * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
329  * on presenting IPv6 addresses as text strings.
330  */
331 int nfs_string_to_sockaddr(const char *address, const size_t addrlen,
332                            struct sockaddr *sap, socklen_t *salen)
333 {
334         struct addrinfo *gai_results;
335         struct addrinfo gai_hint = {
336                 .ai_flags       = AI_NUMERICHOST,
337         };
338         socklen_t len = *salen;
339         int ret = 0;
340
341         *salen = 0;
342
343         if (getaddrinfo(address, NULL, &gai_hint, &gai_results) == 0) {
344                 switch (gai_results->ai_addr->sa_family) {
345                 case AF_INET:
346                 case AF_INET6:
347                         if (len >= gai_results->ai_addrlen) {
348                                 *salen = gai_results->ai_addrlen;
349                                 memcpy(sap, gai_results->ai_addr, *salen);
350                                 ret = 1;
351                         }
352                         break;
353                 }
354                 freeaddrinfo(gai_results);
355         }
356
357         return ret;
358 }
359
360 /**
361  * nfs_present_sockaddr - convert sockaddr to string
362  * @sap: pointer to socket address to convert
363  * @salen: length of socket address
364  * @buf: pointer to buffer to fill in
365  * @buflen: length of buffer
366  *
367  * Convert the passed-in sockaddr-style address to presentation format.
368  * The presentation format address is placed in @buf and is
369  * '\0'-terminated.
370  *
371  * Returns 1 if successful; otherwise zero.
372  *
373  * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
374  * on presenting IPv6 addresses as text strings.
375  */
376 int nfs_present_sockaddr(const struct sockaddr *sap, const socklen_t salen,
377                          char *buf, const size_t buflen)
378 {
379 #ifdef HAVE_GETNAMEINFO
380         int result;
381
382         result = getnameinfo(sap, salen, buf, buflen,
383                                         NULL, 0, NI_NUMERICHOST);
384         if (!result)
385                 return 1;
386
387         nfs_error(_("%s: invalid server address: %s"), progname,
388                         gai_strerror(result));
389         return 0;
390 #else   /* HAVE_GETNAMEINFO */
391         char *addr;
392
393         if (sap->sa_family == AF_INET) {
394                 addr = inet_ntoa(((struct sockaddr_in *)sap)->sin_addr);
395                 if (addr && strlen(addr) < buflen) {
396                         strcpy(buf, addr);
397                         return 1;
398                 }
399         }
400
401         nfs_error(_("%s: invalid server address"), progname);
402         return 0;
403 #endif  /* HAVE_GETNAMEINFO */
404 }
405
406 /*
407  * Attempt to connect a socket, but time out after "timeout" seconds.
408  *
409  * On error return, caller closes the socket.
410  */
411 static int connect_to(int fd, struct sockaddr *addr,
412                         socklen_t addrlen, int timeout)
413 {
414         int ret, saved;
415         fd_set rset, wset;
416         struct timeval tv = {
417                 .tv_sec = timeout,
418         };
419
420         saved = fcntl(fd, F_GETFL, 0);
421         fcntl(fd, F_SETFL, saved | O_NONBLOCK);
422
423         ret = connect(fd, addr, addrlen);
424         if (ret < 0 && errno != EINPROGRESS)
425                 return -1;
426         if (ret == 0)
427                 goto out;
428
429         FD_ZERO(&rset);
430         FD_SET(fd, &rset);
431         wset = rset;
432         ret = select(fd + 1, &rset, &wset, NULL, &tv);
433         if (ret == 0) {
434                 errno = ETIMEDOUT;
435                 return -1;
436         }
437         if (FD_ISSET(fd, &rset) || FD_ISSET(fd, &wset)) {
438                 int error;
439                 socklen_t len = sizeof(error);
440                 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0)
441                         return -1;
442                 if (error) {
443                         errno = error;
444                         return -1;
445                 }
446         } else
447                 return -1;
448
449 out:
450         fcntl(fd, F_SETFL, saved);
451         return 0;
452 }
453
454 /*
455  * Create a socket that is locally bound to a reserved or non-reserved port.
456  *
457  * The caller should check rpc_createerr to determine the cause of any error.
458  */
459 static int get_socket(struct sockaddr_in *saddr, unsigned int p_prot,
460                         unsigned int timeout, int resvp, int conn)
461 {
462         int so, cc, type;
463         struct sockaddr_in laddr;
464         socklen_t namelen = sizeof(laddr);
465
466         type = (p_prot == IPPROTO_UDP ? SOCK_DGRAM : SOCK_STREAM);
467         if ((so = socket (AF_INET, type, p_prot)) < 0)
468                 goto err_socket;
469
470         laddr.sin_family = AF_INET;
471         laddr.sin_port = 0;
472         laddr.sin_addr.s_addr = htonl(INADDR_ANY);
473         if (resvp) {
474                 if (bindresvport(so, &laddr) < 0)
475                         goto err_bindresvport;
476         } else {
477                 cc = bind(so, (struct sockaddr *)&laddr, namelen);
478                 if (cc < 0)
479                         goto err_bind;
480         }
481         if (type == SOCK_STREAM || (conn && type == SOCK_DGRAM)) {
482                 cc = connect_to(so, (struct sockaddr *)saddr, namelen,
483                                 timeout);
484                 if (cc < 0)
485                         goto err_connect;
486         }
487         return so;
488
489 err_socket:
490         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
491         rpc_createerr.cf_error.re_errno = errno;
492         if (verbose) {
493                 nfs_error(_("%s: Unable to create %s socket: errno %d (%s)\n"),
494                         progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
495                         errno, strerror(errno));
496         }
497         return RPC_ANYSOCK;
498
499 err_bindresvport:
500         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
501         rpc_createerr.cf_error.re_errno = errno;
502         if (verbose) {
503                 nfs_error(_("%s: Unable to bindresvport %s socket: errno %d"
504                                 " (%s)\n"),
505                         progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
506                         errno, strerror(errno));
507         }
508         close(so);
509         return RPC_ANYSOCK;
510
511 err_bind:
512         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
513         rpc_createerr.cf_error.re_errno = errno;
514         if (verbose) {
515                 nfs_error(_("%s: Unable to bind to %s socket: errno %d (%s)\n"),
516                         progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
517                         errno, strerror(errno));
518         }
519         close(so);
520         return RPC_ANYSOCK;
521
522 err_connect:
523         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
524         rpc_createerr.cf_error.re_errno = errno;
525         if (verbose) {
526                 nfs_error(_("%s: Unable to connect to %s:%d, errno %d (%s)\n"),
527                         progname, inet_ntoa(saddr->sin_addr),
528                         ntohs(saddr->sin_port), errno, strerror(errno));
529         }
530         close(so);
531         return RPC_ANYSOCK;
532 }
533
534 static void nfs_pp_debug(const struct sockaddr *sap, const socklen_t salen,
535                          const rpcprog_t program, const rpcvers_t version,
536                          const unsigned short protocol,
537                          const unsigned short port)
538 {
539         char buf[NI_MAXHOST];
540
541         if (!verbose)
542                 return;
543
544         if (nfs_present_sockaddr(sap, salen, buf, sizeof(buf)) == 0) {
545                 buf[0] = '\0';
546                 strcat(buf, "unknown host");
547         }
548
549         fprintf(stderr, _("%s: trying %s prog %ld vers %ld prot %s port %d\n"),
550                         progname, buf, program, version,
551                         (protocol == IPPROTO_UDP ? _("UDP") : _("TCP")),
552                         port);
553 }
554
555 /*
556  * Use the portmapper to discover whether or not the service we want is
557  * available. The lists 'versions' and 'protos' define ordered sequences
558  * of service versions and udp/tcp protocols to probe for.
559  *
560  * Returns 1 if the requested service port is unambiguous and pingable;
561  * @pmap is filled in with the version, port, and transport protocol used
562  * during the successful ping.  Note that if a port is already specified
563  * in @pmap and it matches the rpcbind query result, nfs_probe_port() does
564  * not perform an RPC ping.
565  * 
566  * If an error occurs or the requested service isn't available, zero is
567  * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
568  */
569 static int nfs_probe_port(const struct sockaddr *sap, const socklen_t salen,
570                           struct pmap *pmap, const unsigned long *versions,
571                           const unsigned int *protos)
572 {
573         struct sockaddr_storage address;
574         struct sockaddr *saddr = (struct sockaddr *)&address;
575         const unsigned long prog = pmap->pm_prog, *p_vers;
576         const unsigned int prot = (u_int)pmap->pm_prot, *p_prot;
577         const u_short port = (u_short) pmap->pm_port;
578         unsigned long vers = pmap->pm_vers;
579         unsigned short p_port;
580
581         memcpy(saddr, sap, salen);
582         p_prot = prot ? &prot : protos;
583         p_vers = vers ? &vers : versions;
584         rpc_createerr.cf_stat = 0;
585
586         for (;;) {
587                 p_port = nfs_getport(saddr, salen, prog, *p_vers, *p_prot);
588                 if (p_port) {
589                         if (!port || port == p_port) {
590                                 nfs_set_port(saddr, p_port);
591                                 nfs_pp_debug(saddr, salen, prog, *p_vers,
592                                                 *p_prot, p_port);
593                                 if (nfs_rpc_ping(saddr, salen, prog,
594                                                         *p_vers, *p_prot, NULL))
595                                         goto out_ok;
596                         }
597                 }
598                 if (rpc_createerr.cf_stat != RPC_PROGNOTREGISTERED &&
599                     rpc_createerr.cf_stat != RPC_TIMEDOUT &&
600                     rpc_createerr.cf_stat != RPC_CANTRECV &&
601                     rpc_createerr.cf_stat != RPC_PROGVERSMISMATCH)
602                         goto out_bad;
603
604                 if (!prot) {
605                         if (*++p_prot)
606                                 continue;
607                         p_prot = protos;
608                 }
609                 if (rpc_createerr.cf_stat == RPC_TIMEDOUT ||
610                     rpc_createerr.cf_stat == RPC_CANTRECV)
611                         goto out_bad;
612
613                 if (vers || !*++p_vers)
614                         break;
615         }
616
617 out_bad:
618         return 0;
619
620 out_ok:
621         if (!vers)
622                 pmap->pm_vers = *p_vers;
623         if (!prot)
624                 pmap->pm_prot = *p_prot;
625         if (!port)
626                 pmap->pm_port = p_port;
627         rpc_createerr.cf_stat = 0;
628         return 1;
629 }
630
631 /*
632  * Probe a server's NFS service to determine which versions and
633  * transport protocols are supported.
634  *
635  * Returns 1 if the requested service port is unambiguous and pingable;
636  * @pmap is filled in with the version, port, and transport protocol used
637  * during the successful ping.  If all three are already specified, simply
638  * return success without an rpcbind query or RPC ping (we may be trying
639  * to mount an NFS service that is not advertised via rpcbind).
640  *
641  * If an error occurs or the requested service isn't available, zero is
642  * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
643  */
644 static int nfs_probe_nfsport(const struct sockaddr *sap, const socklen_t salen,
645                                 struct pmap *pmap)
646 {
647         if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
648                 return 1;
649
650         if (nfs_mount_data_version >= 4)
651                 return nfs_probe_port(sap, salen, pmap,
652                                         probe_nfs3_first, probe_tcp_first);
653         else
654                 return nfs_probe_port(sap, salen, pmap,
655                                         probe_nfs2_only, probe_udp_only);
656 }
657
658 /*
659  * Probe a server's mountd service to determine which versions and
660  * transport protocols are supported.
661  *
662  * Returns 1 if the requested service port is unambiguous and pingable;
663  * @pmap is filled in with the version, port, and transport protocol used
664  * during the successful ping.  If all three are already specified, simply
665  * return success without an rpcbind query or RPC ping (we may be trying
666  * to mount an NFS service that is not advertised via rpcbind).
667  * 
668  * If an error occurs or the requested service isn't available, zero is
669  * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
670  */
671 static int nfs_probe_mntport(const struct sockaddr *sap, const socklen_t salen,
672                                 struct pmap *pmap)
673 {
674         if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
675                 return 1;
676
677         if (nfs_mount_data_version >= 4)
678                 return nfs_probe_port(sap, salen, pmap,
679                                         probe_mnt3_first, probe_udp_first);
680         else
681                 return nfs_probe_port(sap, salen, pmap,
682                                         probe_mnt1_first, probe_udp_only);
683 }
684
685 /*
686  * Probe a server's mountd service to determine which versions and
687  * transport protocols are supported.  Invoked when the protocol
688  * version is already known for both the NFS and mountd service.
689  *
690  * Returns 1 and fills in both @pmap structs if the requested service
691  * ports are unambiguous and pingable.  Otherwise zero is returned;
692  * rpccreateerr.cf_stat is set to reflect the nature of the error.
693  */
694 static int nfs_probe_version_fixed(const struct sockaddr *mnt_saddr,
695                         const socklen_t mnt_salen,
696                         struct pmap *mnt_pmap,
697                         const struct sockaddr *nfs_saddr,
698                         const socklen_t nfs_salen,
699                         struct pmap *nfs_pmap)
700 {
701         if (!nfs_probe_nfsport(nfs_saddr, nfs_salen, nfs_pmap))
702                 return 0;
703         return nfs_probe_mntport(mnt_saddr, mnt_salen, mnt_pmap);
704 }
705
706 /**
707  * nfs_probe_bothports - discover the RPC endpoints of mountd and NFS server
708  * @mnt_saddr:  pointer to socket address of mountd server
709  * @mnt_salen:  length of mountd server's address
710  * @mnt_pmap:   IN: partially filled-in mountd RPC service tuple;
711  *              OUT: fully filled-in mountd RPC service tuple
712  * @nfs_saddr:  pointer to socket address of NFS server
713  * @nfs_salen:  length of NFS server's address
714  * @nfs_pmap:   IN: partially filled-in NFS RPC service tuple;
715  *              OUT: fully filled-in NFS RPC service tuple
716  *
717  * Returns 1 and fills in both @pmap structs if the requested service
718  * ports are unambiguous and pingable.  Otherwise zero is returned;
719  * rpccreateerr.cf_stat is set to reflect the nature of the error.
720  */
721 int nfs_probe_bothports(const struct sockaddr *mnt_saddr,
722                         const socklen_t mnt_salen,
723                         struct pmap *mnt_pmap,
724                         const struct sockaddr *nfs_saddr,
725                         const socklen_t nfs_salen,
726                         struct pmap *nfs_pmap)
727 {
728         struct pmap save_nfs, save_mnt;
729         const unsigned long *probe_vers;
730
731         if (mnt_pmap->pm_vers && !nfs_pmap->pm_vers)
732                 nfs_pmap->pm_vers = mntvers_to_nfs(mnt_pmap->pm_vers);
733         else if (nfs_pmap->pm_vers && !mnt_pmap->pm_vers)
734                 mnt_pmap->pm_vers = nfsvers_to_mnt(nfs_pmap->pm_vers);
735
736         if (nfs_pmap->pm_vers)
737                 return nfs_probe_version_fixed(mnt_saddr, mnt_salen, mnt_pmap,
738                                                nfs_saddr, nfs_salen, nfs_pmap);
739
740         memcpy(&save_nfs, nfs_pmap, sizeof(save_nfs));
741         memcpy(&save_mnt, mnt_pmap, sizeof(save_mnt));
742         probe_vers = (nfs_mount_data_version >= 4) ?
743                         probe_mnt3_first : probe_mnt1_first;
744
745         for (; *probe_vers; probe_vers++) {
746                 nfs_pmap->pm_vers = mntvers_to_nfs(*probe_vers);
747                 if (nfs_probe_nfsport(nfs_saddr, nfs_salen, nfs_pmap) != 0) {
748                         mnt_pmap->pm_vers = *probe_vers;
749                         if (nfs_probe_mntport(mnt_saddr, mnt_salen, mnt_pmap) != 0)
750                                 return 1;
751                         memcpy(mnt_pmap, &save_mnt, sizeof(*mnt_pmap));
752                 }
753                 switch (rpc_createerr.cf_stat) {
754                 case RPC_PROGVERSMISMATCH:
755                 case RPC_PROGNOTREGISTERED:
756                         break;
757                 default:
758                         return 0;
759                 }
760                 memcpy(nfs_pmap, &save_nfs, sizeof(*nfs_pmap));
761         }
762
763         return 0;
764 }
765
766 /**
767  * probe_bothports - discover the RPC endpoints of mountd and NFS server
768  * @mnt_server: pointer to address and pmap argument for mountd results
769  * @nfs_server: pointer to address and pmap argument for NFS server
770  *
771  * This is the legacy API that takes "clnt_addr_t" for both servers,
772  * but supports only AF_INET addresses.
773  *
774  * Returns 1 and fills in the pmap field in both clnt_addr_t structs
775  * if the requested service ports are unambiguous and pingable.
776  * Otherwise zero is returned; rpccreateerr.cf_stat is set to reflect
777  * the nature of the error.
778  */
779 int probe_bothports(clnt_addr_t *mnt_server, clnt_addr_t *nfs_server)
780 {
781         return nfs_probe_bothports((struct sockaddr *)&mnt_server->saddr,
782                                         sizeof(mnt_server->saddr),
783                                         &mnt_server->pmap,
784                                         (struct sockaddr *)&nfs_server->saddr,
785                                         sizeof(nfs_server->saddr),
786                                         &nfs_server->pmap);
787 }
788
789 static int nfs_probe_statd(void)
790 {
791         struct sockaddr_in addr = {
792                 .sin_family             = AF_INET,
793                 .sin_addr.s_addr        = htonl(INADDR_LOOPBACK),
794         };
795         rpcprog_t program = nfs_getrpcbyname(NSMPROG, nfs_ns_pgmtbl);
796
797         return nfs_getport_ping((struct sockaddr *)&addr, sizeof(addr),
798                                 program, (rpcvers_t)1, IPPROTO_UDP);
799 }
800
801 /**
802  * start_statd - attempt to start rpc.statd
803  *
804  * Returns 1 if statd is running; otherwise zero.
805  */
806 int start_statd(void)
807 {
808 #ifdef START_STATD
809         struct stat stb;
810 #endif
811
812         if (nfs_probe_statd())
813                 return 1;
814
815 #ifdef START_STATD
816         if (stat(START_STATD, &stb) == 0) {
817                 if (S_ISREG(stb.st_mode) && (stb.st_mode & S_IXUSR)) {
818                         pid_t pid = fork();
819                         switch (pid) {
820                         case 0: /* child */
821                                 execl(START_STATD, START_STATD, NULL);
822                                 exit(1);
823                         case -1: /* error */
824                                 nfs_error(_("fork failed: %s"),
825                                                         strerror(errno));
826                                 break;
827                         default: /* parent */
828                                 waitpid(pid, NULL,0);
829                                 break;
830                         }
831                         if (nfs_probe_statd())
832                                 return 1;
833                 }
834         }
835 #endif
836
837         return 0;
838 }
839
840 /**
841  * nfs_call_umount - ask the server to remove a share from it's rmtab
842  * @mnt_server: address of RPC MNT program server
843  * @argp: directory path of share to "unmount"
844  *
845  * Returns one if the unmount call succeeded; zero if the unmount
846  * failed for any reason.
847  *
848  * Note that a side effect of calling this function is that rpccreateerr
849  * is set.
850  */
851 int nfs_call_umount(clnt_addr_t *mnt_server, dirpath *argp)
852 {
853         struct sockaddr *sap = (struct sockaddr *)&mnt_server->saddr;
854         socklen_t salen = sizeof(mnt_server->saddr);
855         struct pmap *pmap = &mnt_server->pmap;
856         CLIENT *clnt;
857         enum clnt_stat res = 0;
858         int msock;
859
860         if (!nfs_probe_mntport(sap, salen, pmap))
861                 return 0;
862         clnt = mnt_openclnt(mnt_server, &msock);
863         if (!clnt)
864                 return 0;
865         res = clnt_call(clnt, MOUNTPROC_UMNT,
866                         (xdrproc_t)xdr_dirpath, (caddr_t)argp,
867                         (xdrproc_t)xdr_void, NULL,
868                         TIMEOUT);
869         mnt_closeclnt(clnt, msock);
870
871         if (res == RPC_SUCCESS)
872                 return 1;
873         return 0;
874 }
875
876 /**
877  * mnt_openclnt - get a handle for a remote mountd service
878  * @mnt_server: address and pmap arguments of mountd service
879  * @msock: returns a file descriptor of the underlying transport socket
880  *
881  * Returns an active handle for the remote's mountd service
882  */
883 CLIENT *mnt_openclnt(clnt_addr_t *mnt_server, int *msock)
884 {
885         struct sockaddr_in *mnt_saddr = &mnt_server->saddr;
886         struct pmap *mnt_pmap = &mnt_server->pmap;
887         CLIENT *clnt = NULL;
888
889         mnt_saddr->sin_port = htons((u_short)mnt_pmap->pm_port);
890         *msock = get_socket(mnt_saddr, mnt_pmap->pm_prot, MOUNT_TIMEOUT,
891                                 TRUE, FALSE);
892         if (*msock == RPC_ANYSOCK) {
893                 if (rpc_createerr.cf_error.re_errno == EADDRINUSE)
894                         /*
895                          * Probably in-use by a TIME_WAIT connection,
896                          * It is worth waiting a while and trying again.
897                          */
898                         rpc_createerr.cf_stat = RPC_TIMEDOUT;
899                 return NULL;
900         }
901
902         switch (mnt_pmap->pm_prot) {
903         case IPPROTO_UDP:
904                 clnt = clntudp_bufcreate(mnt_saddr,
905                                          mnt_pmap->pm_prog, mnt_pmap->pm_vers,
906                                          RETRY_TIMEOUT, msock,
907                                          MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
908                 break;
909         case IPPROTO_TCP:
910                 clnt = clnttcp_create(mnt_saddr,
911                                       mnt_pmap->pm_prog, mnt_pmap->pm_vers,
912                                       msock,
913                                       MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
914                 break;
915         }
916         if (clnt) {
917                 /* try to mount hostname:dirname */
918                 clnt->cl_auth = authunix_create_default();
919                 return clnt;
920         }
921         return NULL;
922 }
923
924 /**
925  * mnt_closeclnt - terminate a handle for a remote mountd service
926  * @clnt: pointer to an active handle for a remote mountd service
927  * @msock: file descriptor of the underlying transport socket
928  *
929  */
930 void mnt_closeclnt(CLIENT *clnt, int msock)
931 {
932         auth_destroy(clnt->cl_auth);
933         clnt_destroy(clnt);
934         close(msock);
935 }
936
937 /**
938  * clnt_ping - send an RPC ping to the remote RPC service endpoint
939  * @saddr: server's address
940  * @prog: target RPC program number
941  * @vers: target RPC version number
942  * @prot: target RPC protocol
943  * @caddr: filled in with our network address
944  *
945  * Sigh... GETPORT queries don't actually check the version number.
946  * In order to make sure that the server actually supports the service
947  * we're requesting, we open an RPC client, and fire off a NULL
948  * RPC call.
949  *
950  * caddr is the network address that the server will use to call us back.
951  * On multi-homed clients, this address depends on which NIC we use to
952  * route requests to the server.
953  *
954  * Returns one if successful, otherwise zero.
955  */
956 int clnt_ping(struct sockaddr_in *saddr, const unsigned long prog,
957                 const unsigned long vers, const unsigned int prot,
958                 struct sockaddr_in *caddr)
959 {
960         CLIENT *clnt = NULL;
961         int sock, stat;
962         static char clnt_res;
963         struct sockaddr dissolve;
964
965         rpc_createerr.cf_stat = stat = 0;
966         sock = get_socket(saddr, prot, CONNECT_TIMEOUT, FALSE, TRUE);
967         if (sock == RPC_ANYSOCK) {
968                 if (rpc_createerr.cf_error.re_errno == ETIMEDOUT) {
969                         /*
970                          * TCP timeout. Bubble up the error to see 
971                          * how it should be handled.
972                          */
973                         rpc_createerr.cf_stat = RPC_TIMEDOUT;
974                 }
975                 return 0;
976         }
977
978         if (caddr) {
979                 /* Get the address of our end of this connection */
980                 socklen_t len = sizeof(*caddr);
981                 if (getsockname(sock, caddr, &len) != 0)
982                         caddr->sin_family = 0;
983         }
984
985         switch(prot) {
986         case IPPROTO_UDP:
987                 /* The socket is connected (so we could getsockname successfully),
988                  * but some servers on multi-homed hosts reply from
989                  * the wrong address, so if we stay connected, we lose the reply.
990                  */
991                 dissolve.sa_family = AF_UNSPEC;
992                 connect(sock, &dissolve, sizeof(dissolve));
993
994                 clnt = clntudp_bufcreate(saddr, prog, vers,
995                                          RETRY_TIMEOUT, &sock,
996                                          RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
997                 break;
998         case IPPROTO_TCP:
999                 clnt = clnttcp_create(saddr, prog, vers, &sock,
1000                                       RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
1001                 break;
1002         }
1003         if (!clnt) {
1004                 close(sock);
1005                 return 0;
1006         }
1007         memset(&clnt_res, 0, sizeof(clnt_res));
1008         stat = clnt_call(clnt, NULLPROC,
1009                          (xdrproc_t)xdr_void, (caddr_t)NULL,
1010                          (xdrproc_t)xdr_void, (caddr_t)&clnt_res,
1011                          TIMEOUT);
1012         if (stat) {
1013                 clnt_geterr(clnt, &rpc_createerr.cf_error);
1014                 rpc_createerr.cf_stat = stat;
1015         }
1016         clnt_destroy(clnt);
1017         close(sock);
1018
1019         if (stat == RPC_SUCCESS)
1020                 return 1;
1021         else
1022                 return 0;
1023 }
1024
1025 /*
1026  * Try a getsockname() on a connected datagram socket.
1027  *
1028  * Returns 1 and fills in @buf if successful; otherwise, zero.
1029  *
1030  * A connected datagram socket prevents leaving a socket in TIME_WAIT.
1031  * This conserves the ephemeral port number space, helping reduce failed
1032  * socket binds during mount storms.
1033  */
1034 static int nfs_ca_sockname(const struct sockaddr *sap, const socklen_t salen,
1035                            struct sockaddr *buf, socklen_t *buflen)
1036 {
1037         struct sockaddr_in sin = {
1038                 .sin_family             = AF_INET,
1039                 .sin_addr.s_addr        = htonl(INADDR_ANY),
1040         };
1041         struct sockaddr_in6 sin6 = {
1042                 .sin6_family            = AF_INET6,
1043                 .sin6_addr              = IN6ADDR_ANY_INIT,
1044         };
1045         int sock;
1046
1047         sock = socket(sap->sa_family, SOCK_DGRAM, IPPROTO_UDP);
1048         if (sock < 0)
1049                 return 0;
1050
1051         switch (sap->sa_family) {
1052         case AF_INET:
1053                 if (bind(sock, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
1054                         close(sock);
1055                         return 0;
1056                 }
1057                 break;
1058         case AF_INET6:
1059                 if (bind(sock, (struct sockaddr *)&sin6, sizeof(sin6)) < 0) {
1060                         close(sock);
1061                         return 0;
1062                 }
1063                 break;
1064         default:
1065                 errno = EAFNOSUPPORT;
1066                 return 0;
1067         }
1068
1069         if (connect(sock, sap, salen) < 0) {
1070                 close(sock);
1071                 return 0;
1072         }
1073
1074         return !getsockname(sock, buf, buflen);
1075 }
1076
1077 /*
1078  * Try to generate an address that prevents the server from calling us.
1079  *
1080  * Returns 1 and fills in @buf if successful; otherwise, zero.
1081  */
1082 static int nfs_ca_gai(const struct sockaddr *sap, const socklen_t salen,
1083                       struct sockaddr *buf, socklen_t *buflen)
1084 {
1085         struct addrinfo *gai_results;
1086         struct addrinfo gai_hint = {
1087                 .ai_family      = sap->sa_family,
1088                 .ai_flags       = AI_PASSIVE,   /* ANYADDR */
1089         };
1090
1091         if (getaddrinfo(NULL, "", &gai_hint, &gai_results))
1092                 return 0;
1093
1094         *buflen = gai_results->ai_addrlen;
1095         memcpy(buf, gai_results->ai_addr, *buflen);
1096
1097         freeaddrinfo(gai_results);
1098
1099         return 1;
1100 }
1101
1102 /**
1103  * nfs_callback_address - acquire our local network address
1104  * @sap: pointer to address of remote
1105  * @sap_len: length of address
1106  * @buf: pointer to buffer to be filled in with local network address
1107  * @buflen: IN: length of buffer to fill in; OUT: length of filled-in address
1108  *
1109  * Discover a network address that an NFSv4 server can use to call us back.
1110  * On multi-homed clients, this address depends on which NIC we use to
1111  * route requests to the server.
1112  *
1113  * Returns 1 and fills in @buf if an unambiguous local address is
1114  * available; returns 1 and fills in an appropriate ANYADDR address
1115  * if a local address isn't available; otherwise, returns zero.
1116  */
1117 int nfs_callback_address(const struct sockaddr *sap, const socklen_t salen,
1118                          struct sockaddr *buf, socklen_t *buflen)
1119 {
1120         struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1121
1122         if (nfs_ca_sockname(sap, salen, buf, buflen) == 0)
1123                 if (nfs_ca_gai(sap, salen, buf, buflen) == 0)
1124                         goto out_failed;
1125
1126         /*
1127          * The server can't use an interface ID that was generated
1128          * here on the client, so always clear sin6_scope_id.
1129          */
1130         if (sin6->sin6_family == AF_INET6)
1131                 sin6->sin6_scope_id = 0;
1132
1133         return 1;
1134
1135 out_failed:
1136         *buflen = 0;
1137         if (verbose)
1138                 nfs_error(_("%s: failed to construct callback address"));
1139         return 0;
1140
1141 }
1142
1143 /*
1144  * "nfsprog" is only supported by the legacy mount command.  The
1145  * kernel mount client does not support this option.
1146  *
1147  * Returns the value set by the nfsprog= option, the value of
1148  * the RPC NFS program specified in /etc/rpc, or a baked-in
1149  * default program number, if all fails.
1150  */
1151 static rpcprog_t nfs_nfs_program(struct mount_options *options)
1152 {
1153         long tmp;
1154
1155         if (po_get_numeric(options, "nfsprog", &tmp) == PO_FOUND)
1156                 if (tmp >= 0)
1157                         return tmp;
1158         return nfs_getrpcbyname(NFSPROG, nfs_nfs_pgmtbl);
1159 }
1160
1161
1162 /*
1163  * Returns the RPC version number specified by the given mount
1164  * options for the NFS service, or zero if all fails.
1165  */
1166 static rpcvers_t nfs_nfs_version(struct mount_options *options)
1167 {
1168         long tmp;
1169
1170         switch (po_rightmost(options, nfs_version_opttbl)) {
1171         case 0: /* v2 */
1172                 return 2;
1173         case 1: /* v3 */
1174                 return 3;
1175         case 2: /* vers */
1176                 if (po_get_numeric(options, "vers", &tmp) == PO_FOUND)
1177                         if (tmp >= 2 && tmp <= 3)
1178                                 return tmp;
1179                 break;
1180         case 3: /* nfsvers */
1181                 if (po_get_numeric(options, "nfsvers", &tmp) == PO_FOUND)
1182                         if (tmp >= 2 && tmp <= 3)
1183                                 return tmp;
1184                 break;
1185         }
1186
1187         return 0;
1188 }
1189
1190 /*
1191  * Returns the NFS transport protocol specified by the given mount options
1192  *
1193  * Returns the IPPROTO_ value specified by the given mount options, or
1194  * IPPROTO_UDP if all fails.
1195  */
1196 static unsigned short nfs_nfs_protocol(struct mount_options *options)
1197 {
1198         char *option;
1199
1200         switch (po_rightmost(options, nfs_transport_opttbl)) {
1201         case 1: /* tcp */
1202                 return IPPROTO_TCP;
1203         case 2: /* proto */
1204                 option = po_get(options, "proto");
1205                 if (option) {
1206                         if (strcmp(option, "tcp") == 0)
1207                                 return IPPROTO_TCP;
1208                         if (strcmp(option, "udp") == 0)
1209                                 return IPPROTO_UDP;
1210                 }
1211         }
1212
1213         return IPPROTO_UDP;
1214 }
1215
1216 /*
1217  * Returns the NFS server's port number specified by the given
1218  * mount options, or zero if all fails.  Zero results in a portmap
1219  * query to discover the server's mountd service port.
1220  *
1221  * port=0 will guarantee an rpcbind request precedes the first
1222  * NFS RPC so the client can determine the server's port number.
1223  */
1224 static unsigned short nfs_nfs_port(struct mount_options *options)
1225 {
1226         long tmp;
1227
1228         if (po_get_numeric(options, "port", &tmp) == PO_FOUND)
1229                 if (tmp >= 0 && tmp <= 65535)
1230                         return tmp;
1231         return 0;
1232 }
1233
1234 /*
1235  * "mountprog" is only supported by the legacy mount command.  The
1236  * kernel mount client does not support this option.
1237  *
1238  * Returns the value set by the mountprog= option, the value of
1239  * the RPC mount program specified in /etc/rpc, or a baked-in
1240  * default program number, if all fails.
1241  */
1242 static rpcprog_t nfs_mount_program(struct mount_options *options)
1243 {
1244         long tmp;
1245
1246         if (po_get_numeric(options, "mountprog", &tmp) == PO_FOUND)
1247                 if (tmp >= 0)
1248                         return tmp;
1249         return nfs_getrpcbyname(MOUNTPROG, nfs_mnt_pgmtbl);
1250 }
1251
1252 /*
1253  * Returns the RPC version number specified by the given mount options,
1254  * or the version "3" if all fails.
1255  */
1256 static rpcvers_t nfs_mount_version(struct mount_options *options)
1257 {
1258         long tmp;
1259
1260         if (po_get_numeric(options, "mountvers", &tmp) == PO_FOUND)
1261                 if (tmp >= 1 && tmp <= 4)
1262                         return tmp;
1263
1264         return nfsvers_to_mnt(nfs_nfs_version(options));
1265 }
1266
1267 /*
1268  * Returns the transport protocol to use for the mount service
1269  *
1270  * Returns the IPPROTO_ value specified by the mountproto option, or
1271  * if that doesn't exist, the IPPROTO_ value specified for NFS
1272  * itself.
1273  */
1274 static unsigned short nfs_mount_protocol(struct mount_options *options)
1275 {
1276         char *option;
1277
1278         option = po_get(options, "mountproto");
1279         if (option) {
1280                 if (strcmp(option, "tcp") == 0)
1281                         return IPPROTO_TCP;
1282                 if (strcmp(option, "udp") == 0)
1283                         return IPPROTO_UDP;
1284         }
1285
1286         return nfs_nfs_version(options);
1287 }
1288
1289 /*
1290  * Returns the mountd server's port number specified by the given
1291  * mount options, or zero if all fails.  Zero results in a portmap
1292  * query to discover the server's mountd service port.
1293  *
1294  * port=0 will guarantee an rpcbind request precedes the mount
1295  * RPC so the client can determine the server's port number.
1296  */
1297 static unsigned short nfs_mount_port(struct mount_options *options)
1298 {
1299         long tmp;
1300
1301         if (po_get_numeric(options, "mountport", &tmp) == PO_FOUND)
1302                 if (tmp >= 0 && tmp <= 65535)
1303                         return tmp;
1304         return 0;
1305 }
1306
1307 /**
1308  * nfs_options2pmap - set up pmap structs based on mount options
1309  * @options: pointer to mount options
1310  * @nfs_pmap: OUT: pointer to pmap arguments for NFS server
1311  * @mnt_pmap: OUT: pointer to pmap arguments for mountd server
1312  *
1313  */
1314 void nfs_options2pmap(struct mount_options *options,
1315                       struct pmap *nfs_pmap, struct pmap *mnt_pmap)
1316 {
1317         nfs_pmap->pm_prog = nfs_nfs_program(options);
1318         nfs_pmap->pm_vers = nfs_nfs_version(options);
1319         nfs_pmap->pm_prot = nfs_nfs_protocol(options);
1320         nfs_pmap->pm_port = nfs_nfs_port(options);
1321
1322         mnt_pmap->pm_prog = nfs_mount_program(options);
1323         mnt_pmap->pm_vers = nfs_mount_version(options);
1324         mnt_pmap->pm_prot = nfs_mount_protocol(options);
1325         mnt_pmap->pm_port = nfs_mount_port(options);
1326 }