]> git.decadent.org.uk Git - nfs-utils.git/blob - utils/mount/network.c
umount.nfs: Harden umount.nfs error reporting
[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 static int nfs_lookup(const char *hostname, const sa_family_t family,
189                       struct sockaddr *sap, socklen_t *salen)
190 {
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 */
196                 .ai_family      = family,
197         };
198         socklen_t len = *salen;
199         int error, ret = 0;
200
201         *salen = 0;
202
203         error = getaddrinfo(hostname, NULL, &gai_hint, &gai_results);
204         switch (error) {
205         case 0:
206                 break;
207         case EAI_SYSTEM:
208                 nfs_error(_("%s: DNS resolution failed for %s: %s"),
209                         progname, hostname, strerror(errno));
210                 return ret;
211         default:
212                 nfs_error(_("%s: DNS resolution failed for %s: %s"),
213                         progname, hostname, gai_strerror(error));
214                 return ret;
215         }
216
217         switch (gai_results->ai_addr->sa_family) {
218         case AF_INET:
219         case AF_INET6:
220                 if (len >= gai_results->ai_addrlen) {
221                         *salen = gai_results->ai_addrlen;
222                         memcpy(sap, gai_results->ai_addr, *salen);
223                         ret = 1;
224                 }
225                 break;
226         default:
227                 /* things are really broken if we get here, so warn */
228                 nfs_error(_("%s: unrecognized DNS resolution results for %s"),
229                                 progname, hostname);
230                 break;
231         }
232
233         freeaddrinfo(gai_results);
234         return ret;
235 }
236
237 /**
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
242  *
243  * Returns 1 and places a socket address at @sap if successful;
244  * otherwise zero.
245  */
246 int nfs_name_to_address(const char *hostname,
247                         struct sockaddr *sap, socklen_t *salen)
248 {
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 */
254 }
255
256 /**
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 
260  *
261  * Returns 1 if successful, otherwise zero.
262  */
263 int nfs_gethostbyname(const char *hostname, struct sockaddr_in *sin)
264 {
265         socklen_t len = sizeof(*sin);
266
267         return nfs_lookup(hostname, AF_INET, (struct sockaddr *)sin, &len);
268 }
269
270 /**
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
277  *
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.
281  *
282  * Returns 1 and fills in @sap and @salen if successful; otherwise zero.
283  *
284  * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
285  * on presenting IPv6 addresses as text strings.
286  */
287 int nfs_string_to_sockaddr(const char *address, const size_t addrlen,
288                            struct sockaddr *sap, socklen_t *salen)
289 {
290         struct addrinfo *gai_results;
291         struct addrinfo gai_hint = {
292                 .ai_flags       = AI_NUMERICHOST,
293         };
294         socklen_t len = *salen;
295         int ret = 0;
296
297         *salen = 0;
298
299         if (getaddrinfo(address, NULL, &gai_hint, &gai_results) == 0) {
300                 switch (gai_results->ai_addr->sa_family) {
301                 case AF_INET:
302                 case AF_INET6:
303                         if (len >= gai_results->ai_addrlen) {
304                                 *salen = gai_results->ai_addrlen;
305                                 memcpy(sap, gai_results->ai_addr, *salen);
306                                 ret = 1;
307                         }
308                         break;
309                 }
310                 freeaddrinfo(gai_results);
311         }
312
313         return ret;
314 }
315
316 /**
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
322  *
323  * Convert the passed-in sockaddr-style address to presentation format.
324  * The presentation format address is placed in @buf and is
325  * '\0'-terminated.
326  *
327  * Returns 1 if successful; otherwise zero.
328  *
329  * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
330  * on presenting IPv6 addresses as text strings.
331  */
332 int nfs_present_sockaddr(const struct sockaddr *sap, const socklen_t salen,
333                          char *buf, const size_t buflen)
334 {
335 #ifdef HAVE_GETNAMEINFO
336         int result;
337
338         result = getnameinfo(sap, salen, buf, buflen,
339                                         NULL, 0, NI_NUMERICHOST);
340         if (!result)
341                 return 1;
342
343         nfs_error(_("%s: invalid server address: %s"), progname,
344                         gai_strerror(result));
345         return 0;
346 #else   /* HAVE_GETNAMEINFO */
347         char *addr;
348
349         if (sap->sa_family == AF_INET) {
350                 addr = inet_ntoa(((struct sockaddr_in *)sap)->sin_addr);
351                 if (addr && strlen(addr) < buflen) {
352                         strcpy(buf, addr);
353                         return 1;
354                 }
355         }
356
357         nfs_error(_("%s: invalid server address"), progname);
358         return 0;
359 #endif  /* HAVE_GETNAMEINFO */
360 }
361
362 /*
363  * Attempt to connect a socket, but time out after "timeout" seconds.
364  *
365  * On error return, caller closes the socket.
366  */
367 static int connect_to(int fd, struct sockaddr *addr,
368                         socklen_t addrlen, int timeout)
369 {
370         int ret, saved;
371         fd_set rset, wset;
372         struct timeval tv = {
373                 .tv_sec = timeout,
374         };
375
376         saved = fcntl(fd, F_GETFL, 0);
377         fcntl(fd, F_SETFL, saved | O_NONBLOCK);
378
379         ret = connect(fd, addr, addrlen);
380         if (ret < 0 && errno != EINPROGRESS)
381                 return -1;
382         if (ret == 0)
383                 goto out;
384
385         FD_ZERO(&rset);
386         FD_SET(fd, &rset);
387         wset = rset;
388         ret = select(fd + 1, &rset, &wset, NULL, &tv);
389         if (ret == 0) {
390                 errno = ETIMEDOUT;
391                 return -1;
392         }
393         if (FD_ISSET(fd, &rset) || FD_ISSET(fd, &wset)) {
394                 int error;
395                 socklen_t len = sizeof(error);
396                 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0)
397                         return -1;
398                 if (error) {
399                         errno = error;
400                         return -1;
401                 }
402         } else
403                 return -1;
404
405 out:
406         fcntl(fd, F_SETFL, saved);
407         return 0;
408 }
409
410 /*
411  * Create a socket that is locally bound to a reserved or non-reserved port.
412  *
413  * The caller should check rpc_createerr to determine the cause of any error.
414  */
415 static int get_socket(struct sockaddr_in *saddr, unsigned int p_prot,
416                         unsigned int timeout, int resvp, int conn)
417 {
418         int so, cc, type;
419         struct sockaddr_in laddr;
420         socklen_t namelen = sizeof(laddr);
421
422         type = (p_prot == IPPROTO_UDP ? SOCK_DGRAM : SOCK_STREAM);
423         if ((so = socket (AF_INET, type, p_prot)) < 0)
424                 goto err_socket;
425
426         laddr.sin_family = AF_INET;
427         laddr.sin_port = 0;
428         laddr.sin_addr.s_addr = htonl(INADDR_ANY);
429         if (resvp) {
430                 if (bindresvport(so, &laddr) < 0)
431                         goto err_bindresvport;
432         } else {
433                 cc = bind(so, (struct sockaddr *)&laddr, namelen);
434                 if (cc < 0)
435                         goto err_bind;
436         }
437         if (type == SOCK_STREAM || (conn && type == SOCK_DGRAM)) {
438                 cc = connect_to(so, (struct sockaddr *)saddr, namelen,
439                                 timeout);
440                 if (cc < 0)
441                         goto err_connect;
442         }
443         return so;
444
445 err_socket:
446         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
447         rpc_createerr.cf_error.re_errno = errno;
448         if (verbose) {
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));
452         }
453         return RPC_ANYSOCK;
454
455 err_bindresvport:
456         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
457         rpc_createerr.cf_error.re_errno = errno;
458         if (verbose) {
459                 nfs_error(_("%s: Unable to bindresvport %s socket: errno %d"
460                                 " (%s)\n"),
461                         progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
462                         errno, strerror(errno));
463         }
464         close(so);
465         return RPC_ANYSOCK;
466
467 err_bind:
468         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
469         rpc_createerr.cf_error.re_errno = errno;
470         if (verbose) {
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));
474         }
475         close(so);
476         return RPC_ANYSOCK;
477
478 err_connect:
479         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
480         rpc_createerr.cf_error.re_errno = errno;
481         if (verbose) {
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));
485         }
486         close(so);
487         return RPC_ANYSOCK;
488 }
489
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)
494 {
495         char buf[NI_MAXHOST];
496
497         if (!verbose)
498                 return;
499
500         if (nfs_present_sockaddr(sap, salen, buf, sizeof(buf)) == 0) {
501                 buf[0] = '\0';
502                 strcat(buf, "unknown host");
503         }
504
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")),
509                         port);
510 }
511
512 /*
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.
516  *
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.
522  * 
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.
525  */
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)
529 {
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;
537
538         memcpy(saddr, sap, salen);
539         p_prot = prot ? &prot : protos;
540         p_vers = vers ? &vers : versions;
541         rpc_createerr.cf_stat = 0;
542
543         for (;;) {
544                 p_port = nfs_getport(saddr, salen, prog, *p_vers, *p_prot);
545                 if (p_port) {
546                         if (!port || port == p_port) {
547                                 nfs_set_port(saddr, p_port);
548                                 nfs_pp_debug(saddr, salen, prog, *p_vers,
549                                                 *p_prot, p_port);
550                                 if (nfs_rpc_ping(saddr, salen, prog,
551                                                         *p_vers, *p_prot, NULL))
552                                         goto out_ok;
553                         }
554                 }
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)
559                         goto out_bad;
560
561                 if (!prot) {
562                         if (*++p_prot)
563                                 continue;
564                         p_prot = protos;
565                 }
566                 if (rpc_createerr.cf_stat == RPC_TIMEDOUT ||
567                     rpc_createerr.cf_stat == RPC_CANTRECV)
568                         goto out_bad;
569
570                 if (vers || !*++p_vers)
571                         break;
572         }
573
574 out_bad:
575         return 0;
576
577 out_ok:
578         if (!vers)
579                 pmap->pm_vers = *p_vers;
580         if (!prot)
581                 pmap->pm_prot = *p_prot;
582         if (!port)
583                 pmap->pm_port = p_port;
584         rpc_createerr.cf_stat = 0;
585         return 1;
586 }
587
588 /*
589  * Probe a server's NFS service to determine which versions and
590  * transport protocols are supported.
591  *
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).
597  *
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.
600  */
601 static int nfs_probe_nfsport(const struct sockaddr *sap, const socklen_t salen,
602                                 struct pmap *pmap)
603 {
604         if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
605                 return 1;
606
607         if (nfs_mount_data_version >= 4)
608                 return nfs_probe_port(sap, salen, pmap,
609                                         probe_nfs3_first, probe_tcp_first);
610         else
611                 return nfs_probe_port(sap, salen, pmap,
612                                         probe_nfs2_only, probe_udp_only);
613 }
614
615 /*
616  * Probe a server's mountd service to determine which versions and
617  * transport protocols are supported.
618  *
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).
624  * 
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.
627  */
628 static int nfs_probe_mntport(const struct sockaddr *sap, const socklen_t salen,
629                                 struct pmap *pmap)
630 {
631         if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
632                 return 1;
633
634         if (nfs_mount_data_version >= 4)
635                 return nfs_probe_port(sap, salen, pmap,
636                                         probe_mnt3_first, probe_udp_first);
637         else
638                 return nfs_probe_port(sap, salen, pmap,
639                                         probe_mnt1_first, probe_udp_only);
640 }
641
642 /*
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.
646  *
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.
650  */
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)
657 {
658         if (!nfs_probe_nfsport(nfs_saddr, nfs_salen, nfs_pmap))
659                 return 0;
660         return nfs_probe_mntport(mnt_saddr, mnt_salen, mnt_pmap);
661 }
662
663 /**
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
673  *
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.
677  */
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)
684 {
685         struct pmap save_nfs, save_mnt;
686         const unsigned long *probe_vers;
687
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);
692
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);
696
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;
701
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)
707                                 return 1;
708                         memcpy(mnt_pmap, &save_mnt, sizeof(*mnt_pmap));
709                 }
710                 switch (rpc_createerr.cf_stat) {
711                 case RPC_PROGVERSMISMATCH:
712                 case RPC_PROGNOTREGISTERED:
713                         break;
714                 default:
715                         return 0;
716                 }
717                 memcpy(nfs_pmap, &save_nfs, sizeof(*nfs_pmap));
718         }
719
720         return 0;
721 }
722
723 /**
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
727  *
728  * This is the legacy API that takes "clnt_addr_t" for both servers,
729  * but supports only AF_INET addresses.
730  *
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.
735  */
736 int probe_bothports(clnt_addr_t *mnt_server, clnt_addr_t *nfs_server)
737 {
738         return nfs_probe_bothports((struct sockaddr *)&mnt_server->saddr,
739                                         sizeof(mnt_server->saddr),
740                                         &mnt_server->pmap,
741                                         (struct sockaddr *)&nfs_server->saddr,
742                                         sizeof(nfs_server->saddr),
743                                         &nfs_server->pmap);
744 }
745
746 static int nfs_probe_statd(void)
747 {
748         struct sockaddr_in addr = {
749                 .sin_family             = AF_INET,
750                 .sin_addr.s_addr        = htonl(INADDR_LOOPBACK),
751         };
752         rpcprog_t program = nfs_getrpcbyname(NSMPROG, nfs_ns_pgmtbl);
753
754         return nfs_getport_ping((struct sockaddr *)&addr, sizeof(addr),
755                                 program, (rpcvers_t)1, IPPROTO_UDP);
756 }
757
758 /**
759  * start_statd - attempt to start rpc.statd
760  *
761  * Returns 1 if statd is running; otherwise zero.
762  */
763 int start_statd(void)
764 {
765 #ifdef START_STATD
766         struct stat stb;
767 #endif
768
769         if (nfs_probe_statd())
770                 return 1;
771
772 #ifdef START_STATD
773         if (stat(START_STATD, &stb) == 0) {
774                 if (S_ISREG(stb.st_mode) && (stb.st_mode & S_IXUSR)) {
775                         pid_t pid = fork();
776                         switch (pid) {
777                         case 0: /* child */
778                                 execl(START_STATD, START_STATD, NULL);
779                                 exit(1);
780                         case -1: /* error */
781                                 nfs_error(_("fork failed: %s"),
782                                                         strerror(errno));
783                                 break;
784                         default: /* parent */
785                                 waitpid(pid, NULL,0);
786                                 break;
787                         }
788                         if (nfs_probe_statd())
789                                 return 1;
790                 }
791         }
792 #endif
793
794         return 0;
795 }
796
797 /**
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"
803  *
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.
807  *
808  * We use a fast timeout since this call is advisory only.
809  */
810 int nfs_advise_umount(const struct sockaddr *sap, const socklen_t salen,
811                       const struct pmap *pmap, const dirpath *argp)
812 {
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,
818         };
819         CLIENT *client;
820         enum clnt_stat res = 0;
821
822         memcpy(saddr, sap, salen);
823         if (nfs_probe_mntport(saddr, salen, &mnt_pmap) == 0) {
824                 if (verbose)
825                         nfs_error(_("%s: Failed to discover mountd port%s"),
826                                 progname, clnt_spcreateerror(""));
827                 return 0;
828         }
829         nfs_set_port(saddr, mnt_pmap.pm_port);
830
831         client = nfs_get_priv_rpcclient(saddr, salen, mnt_pmap.pm_prot,
832                                         mnt_pmap.pm_prog, mnt_pmap.pm_vers,
833                                         &timeout);
834         if (client == NULL) {
835                 if (verbose)
836                         nfs_error(_("%s: Failed to create RPC client%s"),
837                                 progname, clnt_spcreateerror(""));
838                 return 0;
839         }
840
841         client->cl_auth = authunix_create_default();
842
843         res = CLNT_CALL(client, MOUNTPROC_UMNT,
844                         (xdrproc_t)xdr_dirpath, (caddr_t)argp,
845                         (xdrproc_t)xdr_void, NULL,
846                         timeout);
847         if (verbose && res != RPC_SUCCESS)
848                 nfs_error(_("%s: UMNT call failed: %s"),
849                         progname, clnt_sperrno(res));
850
851         auth_destroy(client->cl_auth);
852         CLNT_DESTROY(client);
853
854         if (res != RPC_SUCCESS)
855                 return 0;
856         return 1;
857 }
858
859 /**
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"
863  *
864  * Returns one if the unmount call succeeded; zero if the unmount
865  * failed for any reason.
866  *
867  * Note that a side effect of calling this function is that rpccreateerr
868  * is set.
869  */
870 int nfs_call_umount(clnt_addr_t *mnt_server, dirpath *argp)
871 {
872         struct sockaddr *sap = (struct sockaddr *)&mnt_server->saddr;
873         socklen_t salen = sizeof(mnt_server->saddr);
874         struct pmap *pmap = &mnt_server->pmap;
875         CLIENT *clnt;
876         enum clnt_stat res = 0;
877         int msock;
878
879         if (!nfs_probe_mntport(sap, salen, pmap))
880                 return 0;
881         clnt = mnt_openclnt(mnt_server, &msock);
882         if (!clnt)
883                 return 0;
884         res = clnt_call(clnt, MOUNTPROC_UMNT,
885                         (xdrproc_t)xdr_dirpath, (caddr_t)argp,
886                         (xdrproc_t)xdr_void, NULL,
887                         TIMEOUT);
888         mnt_closeclnt(clnt, msock);
889
890         if (res == RPC_SUCCESS)
891                 return 1;
892         return 0;
893 }
894
895 /**
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
899  *
900  * Returns an active handle for the remote's mountd service
901  */
902 CLIENT *mnt_openclnt(clnt_addr_t *mnt_server, int *msock)
903 {
904         struct sockaddr_in *mnt_saddr = &mnt_server->saddr;
905         struct pmap *mnt_pmap = &mnt_server->pmap;
906         CLIENT *clnt = NULL;
907
908         mnt_saddr->sin_port = htons((u_short)mnt_pmap->pm_port);
909         *msock = get_socket(mnt_saddr, mnt_pmap->pm_prot, MOUNT_TIMEOUT,
910                                 TRUE, FALSE);
911         if (*msock == RPC_ANYSOCK) {
912                 if (rpc_createerr.cf_error.re_errno == EADDRINUSE)
913                         /*
914                          * Probably in-use by a TIME_WAIT connection,
915                          * It is worth waiting a while and trying again.
916                          */
917                         rpc_createerr.cf_stat = RPC_TIMEDOUT;
918                 return NULL;
919         }
920
921         switch (mnt_pmap->pm_prot) {
922         case IPPROTO_UDP:
923                 clnt = clntudp_bufcreate(mnt_saddr,
924                                          mnt_pmap->pm_prog, mnt_pmap->pm_vers,
925                                          RETRY_TIMEOUT, msock,
926                                          MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
927                 break;
928         case IPPROTO_TCP:
929                 clnt = clnttcp_create(mnt_saddr,
930                                       mnt_pmap->pm_prog, mnt_pmap->pm_vers,
931                                       msock,
932                                       MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
933                 break;
934         }
935         if (clnt) {
936                 /* try to mount hostname:dirname */
937                 clnt->cl_auth = authunix_create_default();
938                 return clnt;
939         }
940         return NULL;
941 }
942
943 /**
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
947  *
948  */
949 void mnt_closeclnt(CLIENT *clnt, int msock)
950 {
951         auth_destroy(clnt->cl_auth);
952         clnt_destroy(clnt);
953         close(msock);
954 }
955
956 /**
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
963  *
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
967  * RPC call.
968  *
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.
972  *
973  * Returns one if successful, otherwise zero.
974  */
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)
978 {
979         CLIENT *clnt = NULL;
980         int sock, stat;
981         static char clnt_res;
982         struct sockaddr dissolve;
983
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) {
988                         /*
989                          * TCP timeout. Bubble up the error to see 
990                          * how it should be handled.
991                          */
992                         rpc_createerr.cf_stat = RPC_TIMEDOUT;
993                 }
994                 return 0;
995         }
996
997         if (caddr) {
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;
1002         }
1003
1004         switch(prot) {
1005         case IPPROTO_UDP:
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.
1009                  */
1010                 dissolve.sa_family = AF_UNSPEC;
1011                 connect(sock, &dissolve, sizeof(dissolve));
1012
1013                 clnt = clntudp_bufcreate(saddr, prog, vers,
1014                                          RETRY_TIMEOUT, &sock,
1015                                          RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
1016                 break;
1017         case IPPROTO_TCP:
1018                 clnt = clnttcp_create(saddr, prog, vers, &sock,
1019                                       RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
1020                 break;
1021         }
1022         if (!clnt) {
1023                 close(sock);
1024                 return 0;
1025         }
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,
1030                          TIMEOUT);
1031         if (stat) {
1032                 clnt_geterr(clnt, &rpc_createerr.cf_error);
1033                 rpc_createerr.cf_stat = stat;
1034         }
1035         clnt_destroy(clnt);
1036         close(sock);
1037
1038         if (stat == RPC_SUCCESS)
1039                 return 1;
1040         else
1041                 return 0;
1042 }
1043
1044 /*
1045  * Try a getsockname() on a connected datagram socket.
1046  *
1047  * Returns 1 and fills in @buf if successful; otherwise, zero.
1048  *
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.
1052  */
1053 static int nfs_ca_sockname(const struct sockaddr *sap, const socklen_t salen,
1054                            struct sockaddr *buf, socklen_t *buflen)
1055 {
1056         struct sockaddr_in sin = {
1057                 .sin_family             = AF_INET,
1058                 .sin_addr.s_addr        = htonl(INADDR_ANY),
1059         };
1060         struct sockaddr_in6 sin6 = {
1061                 .sin6_family            = AF_INET6,
1062                 .sin6_addr              = IN6ADDR_ANY_INIT,
1063         };
1064         int sock;
1065
1066         sock = socket(sap->sa_family, SOCK_DGRAM, IPPROTO_UDP);
1067         if (sock < 0)
1068                 return 0;
1069
1070         switch (sap->sa_family) {
1071         case AF_INET:
1072                 if (bind(sock, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
1073                         close(sock);
1074                         return 0;
1075                 }
1076                 break;
1077         case AF_INET6:
1078                 if (bind(sock, (struct sockaddr *)&sin6, sizeof(sin6)) < 0) {
1079                         close(sock);
1080                         return 0;
1081                 }
1082                 break;
1083         default:
1084                 errno = EAFNOSUPPORT;
1085                 return 0;
1086         }
1087
1088         if (connect(sock, sap, salen) < 0) {
1089                 close(sock);
1090                 return 0;
1091         }
1092
1093         return !getsockname(sock, buf, buflen);
1094 }
1095
1096 /*
1097  * Try to generate an address that prevents the server from calling us.
1098  *
1099  * Returns 1 and fills in @buf if successful; otherwise, zero.
1100  */
1101 static int nfs_ca_gai(const struct sockaddr *sap, const socklen_t salen,
1102                       struct sockaddr *buf, socklen_t *buflen)
1103 {
1104         struct addrinfo *gai_results;
1105         struct addrinfo gai_hint = {
1106                 .ai_family      = sap->sa_family,
1107                 .ai_flags       = AI_PASSIVE,   /* ANYADDR */
1108         };
1109
1110         if (getaddrinfo(NULL, "", &gai_hint, &gai_results))
1111                 return 0;
1112
1113         *buflen = gai_results->ai_addrlen;
1114         memcpy(buf, gai_results->ai_addr, *buflen);
1115
1116         freeaddrinfo(gai_results);
1117
1118         return 1;
1119 }
1120
1121 /**
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
1127  *
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.
1131  *
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.
1135  */
1136 int nfs_callback_address(const struct sockaddr *sap, const socklen_t salen,
1137                          struct sockaddr *buf, socklen_t *buflen)
1138 {
1139         struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
1140
1141         if (nfs_ca_sockname(sap, salen, buf, buflen) == 0)
1142                 if (nfs_ca_gai(sap, salen, buf, buflen) == 0)
1143                         goto out_failed;
1144
1145         /*
1146          * The server can't use an interface ID that was generated
1147          * here on the client, so always clear sin6_scope_id.
1148          */
1149         if (sin6->sin6_family == AF_INET6)
1150                 sin6->sin6_scope_id = 0;
1151
1152         return 1;
1153
1154 out_failed:
1155         *buflen = 0;
1156         if (verbose)
1157                 nfs_error(_("%s: failed to construct callback address"));
1158         return 0;
1159
1160 }
1161
1162 /*
1163  * "nfsprog" is only supported by the legacy mount command.  The
1164  * kernel mount client does not support this option.
1165  *
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.
1169  */
1170 static rpcprog_t nfs_nfs_program(struct mount_options *options)
1171 {
1172         long tmp;
1173
1174         if (po_get_numeric(options, "nfsprog", &tmp) == PO_FOUND)
1175                 if (tmp >= 0)
1176                         return tmp;
1177         return nfs_getrpcbyname(NFSPROG, nfs_nfs_pgmtbl);
1178 }
1179
1180
1181 /*
1182  * Returns the RPC version number specified by the given mount
1183  * options for the NFS service, or zero if all fails.
1184  */
1185 static rpcvers_t nfs_nfs_version(struct mount_options *options)
1186 {
1187         long tmp;
1188
1189         switch (po_rightmost(options, nfs_version_opttbl)) {
1190         case 0: /* v2 */
1191                 return 2;
1192         case 1: /* v3 */
1193                 return 3;
1194         case 2: /* vers */
1195                 if (po_get_numeric(options, "vers", &tmp) == PO_FOUND)
1196                         if (tmp >= 2 && tmp <= 3)
1197                                 return tmp;
1198                 break;
1199         case 3: /* nfsvers */
1200                 if (po_get_numeric(options, "nfsvers", &tmp) == PO_FOUND)
1201                         if (tmp >= 2 && tmp <= 3)
1202                                 return tmp;
1203                 break;
1204         }
1205
1206         return 0;
1207 }
1208
1209 /*
1210  * Returns the NFS transport protocol specified by the given mount options
1211  *
1212  * Returns the IPPROTO_ value specified by the given mount options, or
1213  * IPPROTO_UDP if all fails.
1214  */
1215 static unsigned short nfs_nfs_protocol(struct mount_options *options)
1216 {
1217         char *option;
1218
1219         switch (po_rightmost(options, nfs_transport_opttbl)) {
1220         case 1: /* tcp */
1221                 return IPPROTO_TCP;
1222         case 2: /* proto */
1223                 option = po_get(options, "proto");
1224                 if (option) {
1225                         if (strcmp(option, "tcp") == 0)
1226                                 return IPPROTO_TCP;
1227                         if (strcmp(option, "udp") == 0)
1228                                 return IPPROTO_UDP;
1229                 }
1230         }
1231
1232         return IPPROTO_UDP;
1233 }
1234
1235 /*
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.
1239  *
1240  * port=0 will guarantee an rpcbind request precedes the first
1241  * NFS RPC so the client can determine the server's port number.
1242  */
1243 static unsigned short nfs_nfs_port(struct mount_options *options)
1244 {
1245         long tmp;
1246
1247         if (po_get_numeric(options, "port", &tmp) == PO_FOUND)
1248                 if (tmp >= 0 && tmp <= 65535)
1249                         return tmp;
1250         return 0;
1251 }
1252
1253 /*
1254  * "mountprog" is only supported by the legacy mount command.  The
1255  * kernel mount client does not support this option.
1256  *
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.
1260  */
1261 static rpcprog_t nfs_mount_program(struct mount_options *options)
1262 {
1263         long tmp;
1264
1265         if (po_get_numeric(options, "mountprog", &tmp) == PO_FOUND)
1266                 if (tmp >= 0)
1267                         return tmp;
1268         return nfs_getrpcbyname(MOUNTPROG, nfs_mnt_pgmtbl);
1269 }
1270
1271 /*
1272  * Returns the RPC version number specified by the given mount options,
1273  * or the version "3" if all fails.
1274  */
1275 static rpcvers_t nfs_mount_version(struct mount_options *options)
1276 {
1277         long tmp;
1278
1279         if (po_get_numeric(options, "mountvers", &tmp) == PO_FOUND)
1280                 if (tmp >= 1 && tmp <= 4)
1281                         return tmp;
1282
1283         return nfsvers_to_mnt(nfs_nfs_version(options));
1284 }
1285
1286 /*
1287  * Returns the transport protocol to use for the mount service
1288  *
1289  * Returns the IPPROTO_ value specified by the mountproto option, or
1290  * if that doesn't exist, the IPPROTO_ value specified for NFS
1291  * itself.
1292  */
1293 static unsigned short nfs_mount_protocol(struct mount_options *options)
1294 {
1295         char *option;
1296
1297         option = po_get(options, "mountproto");
1298         if (option) {
1299                 if (strcmp(option, "tcp") == 0)
1300                         return IPPROTO_TCP;
1301                 if (strcmp(option, "udp") == 0)
1302                         return IPPROTO_UDP;
1303         }
1304
1305         return nfs_nfs_protocol(options);
1306 }
1307
1308 /*
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.
1312  *
1313  * port=0 will guarantee an rpcbind request precedes the mount
1314  * RPC so the client can determine the server's port number.
1315  */
1316 static unsigned short nfs_mount_port(struct mount_options *options)
1317 {
1318         long tmp;
1319
1320         if (po_get_numeric(options, "mountport", &tmp) == PO_FOUND)
1321                 if (tmp >= 0 && tmp <= 65535)
1322                         return tmp;
1323         return 0;
1324 }
1325
1326 /**
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
1331  *
1332  */
1333 void nfs_options2pmap(struct mount_options *options,
1334                       struct pmap *nfs_pmap, struct pmap *mnt_pmap)
1335 {
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);
1340
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);
1345 }