mount command: full support for AF_INET6 addresses in probe_port()
[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 "network.h"
52
53 /*
54  * Earlier versions of glibc's /usr/include/netdb.h exclude these
55  * definitions because it was thought they were not part of a stable
56  * POSIX standard.  However, they are defined by RFC 2553 and 3493
57  * and in POSIX 1003.1-2001, so these definitions were added in later
58  * versions of netdb.h.
59  */
60 #ifndef AI_V4MAPPED
61 #define AI_V4MAPPED     0x0008  /* IPv4-mapped addresses are acceptable.  */
62 #endif  /* AI_V4MAPPED */
63 #ifndef AI_ALL
64 #define AI_ALL          0x0010  /* Return both IPv4 and IPv6 addresses.  */
65 #endif  /* AI_ALL */
66 #ifndef AI_ADDRCONFIG
67 #define AI_ADDRCONFIG   0x0020  /* Use configuration of this host to choose \
68                                    returned address type.  */
69 #endif  /* AI_ADDRCONFIG */
70
71 #define PMAP_TIMEOUT    (10)
72 #define CONNECT_TIMEOUT (20)
73 #define MOUNT_TIMEOUT   (30)
74
75 #if SIZEOF_SOCKLEN_T - 0 == 0
76 #define socklen_t unsigned int
77 #endif
78
79 extern int nfs_mount_data_version;
80 extern char *progname;
81 extern int verbose;
82
83 static const char *nfs_ns_pgmtbl[] = {
84         "status",
85         NULL,
86 };
87
88 static const unsigned long nfs_to_mnt[] = {
89         0,
90         0,
91         1,
92         3,
93 };
94
95 static const unsigned long mnt_to_nfs[] = {
96         0,
97         2,
98         2,
99         3,
100 };
101
102 /*
103  * Map an NFS version into the corresponding Mountd version
104  */
105 unsigned long nfsvers_to_mnt(const unsigned long vers)
106 {
107         if (vers <= 3)
108                 return nfs_to_mnt[vers];
109         return 0;
110 }
111
112 /*
113  * Map a Mountd version into the corresponding NFS version
114  */
115 static unsigned long mntvers_to_nfs(const unsigned long vers)
116 {
117         if (vers <= 3)
118                 return mnt_to_nfs[vers];
119         return 0;
120 }
121
122 static const unsigned int probe_udp_only[] = {
123         IPPROTO_UDP,
124         0,
125 };
126
127 static const unsigned int probe_udp_first[] = {
128         IPPROTO_UDP,
129         IPPROTO_TCP,
130         0,
131 };
132
133 static const unsigned int probe_tcp_first[] = {
134         IPPROTO_TCP,
135         IPPROTO_UDP,
136         0,
137 };
138
139 static const unsigned long probe_nfs2_only[] = {
140         2,
141         0,
142 };
143
144 static const unsigned long probe_nfs3_first[] = {
145         3,
146         2,
147         0,
148 };
149
150 static const unsigned long probe_mnt1_first[] = {
151         1,
152         2,
153         0,
154 };
155
156 static const unsigned long probe_mnt3_first[] = {
157         3,
158         1,
159         2,
160         0,
161 };
162
163 static void nfs_set_port(struct sockaddr *sap, const unsigned short port)
164 {
165         switch (sap->sa_family) {
166         case AF_INET:
167                 ((struct sockaddr_in *)sap)->sin_port = htons(port);
168                 break;
169         case AF_INET6:
170                 ((struct sockaddr_in6 *)sap)->sin6_port = htons(port);
171                 break;
172         default:
173                 nfs_error(_("%s: unrecognized address family in %s"),
174                         progname, __func__);
175         }
176 }
177
178 /**
179  * nfs_name_to_address - resolve hostname to an IPv4 or IPv6 socket address
180  * @hostname: pointer to C string containing DNS hostname to resolve
181  * @sap: pointer to buffer to fill with socket address
182  * @len: IN: size of buffer to fill; OUT: size of socket address
183  *
184  * Returns 1 and places a socket address at @sap if successful;
185  * otherwise zero.
186  */
187 int nfs_name_to_address(const char *hostname,
188                         const sa_family_t af_hint,
189                         struct sockaddr *sap, socklen_t *salen)
190 {
191         struct addrinfo *gai_results;
192         struct addrinfo gai_hint = {
193                 .ai_family      = af_hint,
194                 .ai_flags       = AI_ADDRCONFIG,
195         };
196         socklen_t len = *salen;
197         int error, ret = 0;
198
199         if (af_hint == AF_INET6)
200                 gai_hint.ai_flags |= AI_V4MAPPED|AI_ALL;
201
202         *salen = 0;
203
204         error = getaddrinfo(hostname, NULL, &gai_hint, &gai_results);
205         if (error) {
206                 nfs_error(_("%s: DNS resolution failed for %s: %s"),
207                         progname, hostname, (error == EAI_SYSTEM ?
208                                 strerror(errno) : gai_strerror(error)));
209                 return ret;
210         }
211
212         switch (gai_results->ai_addr->sa_family) {
213         case AF_INET:
214         case AF_INET6:
215                 if (len >= gai_results->ai_addrlen) {
216                         *salen = gai_results->ai_addrlen;
217                         memcpy(sap, gai_results->ai_addr, *salen);
218                         ret = 1;
219                 }
220                 break;
221         default:
222                 /* things are really broken if we get here, so warn */
223                 nfs_error(_("%s: unrecognized DNS resolution results for %s"),
224                                 progname, hostname);
225                 break;
226         }
227
228         freeaddrinfo(gai_results);
229         return ret;
230 }
231
232 /**
233  * nfs_gethostbyname - resolve a hostname to an IPv4 address
234  * @hostname: pointer to a C string containing a DNS hostname
235  * @saddr: returns an IPv4 address 
236  *
237  * Returns 1 if successful, otherwise zero.
238  */
239 int nfs_gethostbyname(const char *hostname, struct sockaddr_in *sin)
240 {
241         socklen_t len = sizeof(*sin);
242
243         return nfs_name_to_address(hostname, AF_INET,
244                                         (struct sockaddr *)sin, &len);
245 }
246
247 /**
248  * nfs_string_to_sockaddr - convert string address to sockaddr
249  * @address:    pointer to presentation format address to convert
250  * @addrlen:    length of presentation address
251  * @sap:        pointer to socket address buffer to fill in
252  * @salen:      IN: length of address buffer
253  *              OUT: length of converted socket address
254  *
255  * Convert a presentation format address string to a socket address.
256  * Similar to nfs_name_to_address(), but the DNS query is squelched,
257  * and won't make any noise if the getaddrinfo() call fails.
258  *
259  * Returns 1 and fills in @sap and @salen if successful; otherwise zero.
260  *
261  * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
262  * on presenting IPv6 addresses as text strings.
263  */
264 int nfs_string_to_sockaddr(const char *address, const size_t addrlen,
265                            struct sockaddr *sap, socklen_t *salen)
266 {
267         struct addrinfo *gai_results;
268         struct addrinfo gai_hint = {
269                 .ai_flags       = AI_NUMERICHOST,
270         };
271         socklen_t len = *salen;
272         int ret = 0;
273
274         *salen = 0;
275
276         if (getaddrinfo(address, NULL, &gai_hint, &gai_results) == 0) {
277                 switch (gai_results->ai_addr->sa_family) {
278                 case AF_INET:
279                 case AF_INET6:
280                         if (len >= gai_results->ai_addrlen) {
281                                 *salen = gai_results->ai_addrlen;
282                                 memcpy(sap, gai_results->ai_addr, *salen);
283                                 ret = 1;
284                         }
285                         break;
286                 }
287                 freeaddrinfo(gai_results);
288         }
289
290         return ret;
291 }
292
293 /**
294  * nfs_present_sockaddr - convert sockaddr to string
295  * @sap: pointer to socket address to convert
296  * @salen: length of socket address
297  * @buf: pointer to buffer to fill in
298  * @buflen: length of buffer
299  *
300  * Convert the passed-in sockaddr-style address to presentation format.
301  * The presentation format address is placed in @buf and is
302  * '\0'-terminated.
303  *
304  * Returns 1 if successful; otherwise zero.
305  *
306  * See RFC 4038 section 5.1 or RFC 3513 section 2.2 for more details
307  * on presenting IPv6 addresses as text strings.
308  */
309 int nfs_present_sockaddr(const struct sockaddr *sap, const socklen_t salen,
310                          char *buf, const size_t buflen)
311 {
312 #ifdef HAVE_GETNAMEINFO
313         int result;
314
315         result = getnameinfo(sap, salen, buf, buflen,
316                                         NULL, 0, NI_NUMERICHOST);
317         if (!result)
318                 return 1;
319
320         nfs_error(_("%s: invalid server address: %s"), progname,
321                         gai_strerror(result));
322         return 0;
323 #else   /* HAVE_GETNAMEINFO */
324         char *addr;
325
326         if (sap->sa_family == AF_INET) {
327                 addr = inet_ntoa(((struct sockaddr_in *)sap)->sin_addr);
328                 if (addr && strlen(addr) < buflen) {
329                         strcpy(buf, addr);
330                         return 1;
331                 }
332         }
333
334         nfs_error(_("%s: invalid server address"), progname);
335         return 0;
336 #endif  /* HAVE_GETNAMEINFO */
337 }
338
339 /*
340  * Attempt to connect a socket, but time out after "timeout" seconds.
341  *
342  * On error return, caller closes the socket.
343  */
344 static int connect_to(int fd, struct sockaddr *addr,
345                         socklen_t addrlen, int timeout)
346 {
347         int ret, saved;
348         fd_set rset, wset;
349         struct timeval tv = {
350                 .tv_sec = timeout,
351         };
352
353         saved = fcntl(fd, F_GETFL, 0);
354         fcntl(fd, F_SETFL, saved | O_NONBLOCK);
355
356         ret = connect(fd, addr, addrlen);
357         if (ret < 0 && errno != EINPROGRESS)
358                 return -1;
359         if (ret == 0)
360                 goto out;
361
362         FD_ZERO(&rset);
363         FD_SET(fd, &rset);
364         wset = rset;
365         ret = select(fd + 1, &rset, &wset, NULL, &tv);
366         if (ret == 0) {
367                 errno = ETIMEDOUT;
368                 return -1;
369         }
370         if (FD_ISSET(fd, &rset) || FD_ISSET(fd, &wset)) {
371                 int error;
372                 socklen_t len = sizeof(error);
373                 if (getsockopt(fd, SOL_SOCKET, SO_ERROR, &error, &len) < 0)
374                         return -1;
375                 if (error) {
376                         errno = error;
377                         return -1;
378                 }
379         } else
380                 return -1;
381
382 out:
383         fcntl(fd, F_SETFL, saved);
384         return 0;
385 }
386
387 /*
388  * Create a socket that is locally bound to a reserved or non-reserved port.
389  *
390  * The caller should check rpc_createerr to determine the cause of any error.
391  */
392 static int get_socket(struct sockaddr_in *saddr, unsigned int p_prot,
393                         unsigned int timeout, int resvp, int conn)
394 {
395         int so, cc, type;
396         struct sockaddr_in laddr;
397         socklen_t namelen = sizeof(laddr);
398
399         type = (p_prot == IPPROTO_UDP ? SOCK_DGRAM : SOCK_STREAM);
400         if ((so = socket (AF_INET, type, p_prot)) < 0)
401                 goto err_socket;
402
403         laddr.sin_family = AF_INET;
404         laddr.sin_port = 0;
405         laddr.sin_addr.s_addr = htonl(INADDR_ANY);
406         if (resvp) {
407                 if (bindresvport(so, &laddr) < 0)
408                         goto err_bindresvport;
409         } else {
410                 cc = bind(so, (struct sockaddr *)&laddr, namelen);
411                 if (cc < 0)
412                         goto err_bind;
413         }
414         if (type == SOCK_STREAM || (conn && type == SOCK_DGRAM)) {
415                 cc = connect_to(so, (struct sockaddr *)saddr, namelen,
416                                 timeout);
417                 if (cc < 0)
418                         goto err_connect;
419         }
420         return so;
421
422 err_socket:
423         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
424         rpc_createerr.cf_error.re_errno = errno;
425         if (verbose) {
426                 nfs_error(_("%s: Unable to create %s socket: errno %d (%s)\n"),
427                         progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
428                         errno, strerror(errno));
429         }
430         return RPC_ANYSOCK;
431
432 err_bindresvport:
433         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
434         rpc_createerr.cf_error.re_errno = errno;
435         if (verbose) {
436                 nfs_error(_("%s: Unable to bindresvport %s socket: errno %d"
437                                 " (%s)\n"),
438                         progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
439                         errno, strerror(errno));
440         }
441         close(so);
442         return RPC_ANYSOCK;
443
444 err_bind:
445         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
446         rpc_createerr.cf_error.re_errno = errno;
447         if (verbose) {
448                 nfs_error(_("%s: Unable to bind to %s socket: errno %d (%s)\n"),
449                         progname, p_prot == IPPROTO_UDP ? _("UDP") : _("TCP"),
450                         errno, strerror(errno));
451         }
452         close(so);
453         return RPC_ANYSOCK;
454
455 err_connect:
456         rpc_createerr.cf_stat = RPC_SYSTEMERROR;
457         rpc_createerr.cf_error.re_errno = errno;
458         if (verbose) {
459                 nfs_error(_("%s: Unable to connect to %s:%d, errno %d (%s)\n"),
460                         progname, inet_ntoa(saddr->sin_addr),
461                         ntohs(saddr->sin_port), errno, strerror(errno));
462         }
463         close(so);
464         return RPC_ANYSOCK;
465 }
466
467 static void nfs_pp_debug(const struct sockaddr *sap, const socklen_t salen,
468                          const rpcprog_t program, const rpcvers_t version,
469                          const unsigned short protocol,
470                          const unsigned short port)
471 {
472         char buf[NI_MAXHOST];
473
474         if (!verbose)
475                 return;
476
477         if (nfs_present_sockaddr(sap, salen, buf, sizeof(buf)) == 0) {
478                 buf[0] = '\0';
479                 strcat(buf, "unknown host");
480         }
481
482         fprintf(stderr, _("%s: trying %s prog %ld vers %ld prot %s port %d\n"),
483                         progname, buf, program, version,
484                         (protocol == IPPROTO_UDP ? _("UDP") : _("TCP")),
485                         port);
486 }
487
488 /*
489  * Use the portmapper to discover whether or not the service we want is
490  * available. The lists 'versions' and 'protos' define ordered sequences
491  * of service versions and udp/tcp protocols to probe for.
492  *
493  * Returns 1 if the requested service port is unambiguous and pingable;
494  * @pmap is filled in with the version, port, and transport protocol used
495  * during the successful ping.  Note that if a port is already specified
496  * in @pmap and it matches the rpcbind query result, nfs_probe_port() does
497  * not perform an RPC ping.
498  * 
499  * If an error occurs or the requested service isn't available, zero is
500  * returned; rpccreateerr.cf_stat is set to reflect the nature of the error.
501  */
502 static int nfs_probe_port(const struct sockaddr *sap, const socklen_t salen,
503                           struct pmap *pmap, const unsigned long *versions,
504                           const unsigned int *protos)
505 {
506         struct sockaddr_storage address;
507         struct sockaddr *saddr = (struct sockaddr *)&address;
508         const unsigned long prog = pmap->pm_prog, *p_vers;
509         const unsigned int prot = (u_int)pmap->pm_prot, *p_prot;
510         const u_short port = (u_short) pmap->pm_port;
511         unsigned long vers = pmap->pm_vers;
512         unsigned short p_port;
513
514         memcpy(saddr, sap, salen);
515         p_prot = prot ? &prot : protos;
516         p_vers = vers ? &vers : versions;
517         rpc_createerr.cf_stat = 0;
518
519         for (;;) {
520                 p_port = nfs_getport(saddr, salen, prog, *p_vers, *p_prot);
521                 if (p_port) {
522                         if (!port || port == p_port) {
523                                 nfs_set_port(saddr, p_port);
524                                 nfs_pp_debug(saddr, salen, prog, *p_vers,
525                                                 *p_prot, p_port);
526                                 if (nfs_rpc_ping(saddr, salen, prog,
527                                                         *p_vers, *p_prot, NULL))
528                                         goto out_ok;
529                         }
530                 }
531                 if (rpc_createerr.cf_stat != RPC_PROGNOTREGISTERED &&
532                     rpc_createerr.cf_stat != RPC_TIMEDOUT &&
533                     rpc_createerr.cf_stat != RPC_CANTRECV &&
534                     rpc_createerr.cf_stat != RPC_PROGVERSMISMATCH)
535                         goto out_bad;
536
537                 if (!prot) {
538                         if (*++p_prot)
539                                 continue;
540                         p_prot = protos;
541                 }
542                 if (rpc_createerr.cf_stat == RPC_TIMEDOUT ||
543                     rpc_createerr.cf_stat == RPC_CANTRECV)
544                         goto out_bad;
545
546                 if (vers || !*++p_vers)
547                         break;
548         }
549
550 out_bad:
551         return 0;
552
553 out_ok:
554         if (!vers)
555                 pmap->pm_vers = *p_vers;
556         if (!prot)
557                 pmap->pm_prot = *p_prot;
558         if (!port)
559                 pmap->pm_port = p_port;
560         rpc_createerr.cf_stat = 0;
561         return 1;
562 }
563
564 static int probe_nfsport(clnt_addr_t *nfs_server)
565 {
566         struct sockaddr *sap = (struct sockaddr *)&nfs_server->saddr;
567         socklen_t salen = sizeof(nfs_server->saddr);
568         struct pmap *pmap = &nfs_server->pmap;
569
570         if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
571                 return 1;
572
573         if (nfs_mount_data_version >= 4)
574                 return nfs_probe_port(sap, salen, pmap,
575                                         probe_nfs3_first, probe_tcp_first);
576         else
577                 return nfs_probe_port(sap, salen, pmap,
578                                         probe_nfs2_only, probe_udp_only);
579 }
580
581 static int probe_mntport(clnt_addr_t *mnt_server)
582 {
583         struct sockaddr *sap = (struct sockaddr *)&mnt_server->saddr;
584         socklen_t salen = sizeof(mnt_server->saddr);
585         struct pmap *pmap = &mnt_server->pmap;
586
587         if (pmap->pm_vers && pmap->pm_prot && pmap->pm_port)
588                 return 1;
589
590         if (nfs_mount_data_version >= 4)
591                 return nfs_probe_port(sap, salen, pmap,
592                                         probe_mnt3_first, probe_udp_first);
593         else
594                 return nfs_probe_port(sap, salen, pmap,
595                                         probe_mnt1_first, probe_udp_only);
596 }
597
598 /**
599  * probe_bothports - discover the RPC endpoints of mountd and NFS server
600  * @mnt_server: pointer to address and pmap argument for mountd results
601  * @nfs_server: pointer to address and pmap argument for NFS server
602  *
603  * Returns 1 if successful, otherwise zero if some error occurred.
604  * Note that the arguments are both input and output arguments.
605  *
606  * A side effect of calling this function is that rpccreateerr is set.
607  */
608 int probe_bothports(clnt_addr_t *mnt_server, clnt_addr_t *nfs_server)
609 {
610         struct pmap *nfs_pmap = &nfs_server->pmap;
611         struct pmap *mnt_pmap = &mnt_server->pmap;
612         struct pmap save_nfs, save_mnt;
613         int res;
614         const unsigned long *probe_vers;
615
616         if (mnt_pmap->pm_vers && !nfs_pmap->pm_vers)
617                 nfs_pmap->pm_vers = mntvers_to_nfs(mnt_pmap->pm_vers);
618         else if (nfs_pmap->pm_vers && !mnt_pmap->pm_vers)
619                 mnt_pmap->pm_vers = nfsvers_to_mnt(nfs_pmap->pm_vers);
620         if (nfs_pmap->pm_vers)
621                 goto version_fixed;
622
623         memcpy(&save_nfs, nfs_pmap, sizeof(save_nfs));
624         memcpy(&save_mnt, mnt_pmap, sizeof(save_mnt));
625         probe_vers = (nfs_mount_data_version >= 4) ?
626                         probe_mnt3_first : probe_mnt1_first;
627
628         for (; *probe_vers; probe_vers++) {
629                 nfs_pmap->pm_vers = mntvers_to_nfs(*probe_vers);
630                 if ((res = probe_nfsport(nfs_server) != 0)) {
631                         mnt_pmap->pm_vers = *probe_vers;
632                         if ((res = probe_mntport(mnt_server)) != 0)
633                                 return 1;
634                         memcpy(mnt_pmap, &save_mnt, sizeof(*mnt_pmap));
635                 }
636                 switch (rpc_createerr.cf_stat) {
637                 case RPC_PROGVERSMISMATCH:
638                 case RPC_PROGNOTREGISTERED:
639                         break;
640                 default:
641                         goto out_bad;
642                 }
643                 memcpy(nfs_pmap, &save_nfs, sizeof(*nfs_pmap));
644         }
645
646 out_bad:
647         return 0;
648
649 version_fixed:
650         if (!probe_nfsport(nfs_server))
651                 goto out_bad;
652         return probe_mntport(mnt_server);
653 }
654
655 static int nfs_probe_statd(void)
656 {
657         struct sockaddr_in addr = {
658                 .sin_family             = AF_INET,
659                 .sin_addr.s_addr        = htonl(INADDR_LOOPBACK),
660         };
661         rpcprog_t program = nfs_getrpcbyname(NSMPROG, nfs_ns_pgmtbl);
662
663         return nfs_getport_ping((struct sockaddr *)&addr, sizeof(addr),
664                                 program, (rpcvers_t)1, IPPROTO_UDP);
665 }
666
667 /**
668  * start_statd - attempt to start rpc.statd
669  *
670  * Returns 1 if statd is running; otherwise zero.
671  */
672 int start_statd(void)
673 {
674 #ifdef START_STATD
675         struct stat stb;
676 #endif
677
678         if (nfs_probe_statd())
679                 return 1;
680
681 #ifdef START_STATD
682         if (stat(START_STATD, &stb) == 0) {
683                 if (S_ISREG(stb.st_mode) && (stb.st_mode & S_IXUSR)) {
684                         pid_t pid = fork();
685                         switch (pid) {
686                         case 0: /* child */
687                                 execl(START_STATD, START_STATD, NULL);
688                                 exit(1);
689                         case -1: /* error */
690                                 nfs_error(_("fork failed: %s"),
691                                                         strerror(errno));
692                                 break;
693                         default: /* parent */
694                                 waitpid(pid, NULL,0);
695                                 break;
696                         }
697                         if (nfs_probe_statd())
698                                 return 1;
699                 }
700         }
701 #endif
702
703         return 0;
704 }
705
706 /**
707  * nfs_call_umount - ask the server to remove a share from it's rmtab
708  * @mnt_server: address of RPC MNT program server
709  * @argp: directory path of share to "unmount"
710  *
711  * Returns one if the unmount call succeeded; zero if the unmount
712  * failed for any reason.
713  *
714  * Note that a side effect of calling this function is that rpccreateerr
715  * is set.
716  */
717 int nfs_call_umount(clnt_addr_t *mnt_server, dirpath *argp)
718 {
719         CLIENT *clnt;
720         enum clnt_stat res = 0;
721         int msock;
722
723         if (!probe_mntport(mnt_server))
724                 return 0;
725         clnt = mnt_openclnt(mnt_server, &msock);
726         if (!clnt)
727                 return 0;
728         res = clnt_call(clnt, MOUNTPROC_UMNT,
729                         (xdrproc_t)xdr_dirpath, (caddr_t)argp,
730                         (xdrproc_t)xdr_void, NULL,
731                         TIMEOUT);
732         mnt_closeclnt(clnt, msock);
733
734         if (res == RPC_SUCCESS)
735                 return 1;
736         return 0;
737 }
738
739 /**
740  * mnt_openclnt - get a handle for a remote mountd service
741  * @mnt_server: address and pmap arguments of mountd service
742  * @msock: returns a file descriptor of the underlying transport socket
743  *
744  * Returns an active handle for the remote's mountd service
745  */
746 CLIENT *mnt_openclnt(clnt_addr_t *mnt_server, int *msock)
747 {
748         struct sockaddr_in *mnt_saddr = &mnt_server->saddr;
749         struct pmap *mnt_pmap = &mnt_server->pmap;
750         CLIENT *clnt = NULL;
751
752         mnt_saddr->sin_port = htons((u_short)mnt_pmap->pm_port);
753         *msock = get_socket(mnt_saddr, mnt_pmap->pm_prot, MOUNT_TIMEOUT,
754                                 TRUE, FALSE);
755         if (*msock == RPC_ANYSOCK) {
756                 if (rpc_createerr.cf_error.re_errno == EADDRINUSE)
757                         /*
758                          * Probably in-use by a TIME_WAIT connection,
759                          * It is worth waiting a while and trying again.
760                          */
761                         rpc_createerr.cf_stat = RPC_TIMEDOUT;
762                 return NULL;
763         }
764
765         switch (mnt_pmap->pm_prot) {
766         case IPPROTO_UDP:
767                 clnt = clntudp_bufcreate(mnt_saddr,
768                                          mnt_pmap->pm_prog, mnt_pmap->pm_vers,
769                                          RETRY_TIMEOUT, msock,
770                                          MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
771                 break;
772         case IPPROTO_TCP:
773                 clnt = clnttcp_create(mnt_saddr,
774                                       mnt_pmap->pm_prog, mnt_pmap->pm_vers,
775                                       msock,
776                                       MNT_SENDBUFSIZE, MNT_RECVBUFSIZE);
777                 break;
778         }
779         if (clnt) {
780                 /* try to mount hostname:dirname */
781                 clnt->cl_auth = authunix_create_default();
782                 return clnt;
783         }
784         return NULL;
785 }
786
787 /**
788  * mnt_closeclnt - terminate a handle for a remote mountd service
789  * @clnt: pointer to an active handle for a remote mountd service
790  * @msock: file descriptor of the underlying transport socket
791  *
792  */
793 void mnt_closeclnt(CLIENT *clnt, int msock)
794 {
795         auth_destroy(clnt->cl_auth);
796         clnt_destroy(clnt);
797         close(msock);
798 }
799
800 /**
801  * clnt_ping - send an RPC ping to the remote RPC service endpoint
802  * @saddr: server's address
803  * @prog: target RPC program number
804  * @vers: target RPC version number
805  * @prot: target RPC protocol
806  * @caddr: filled in with our network address
807  *
808  * Sigh... GETPORT queries don't actually check the version number.
809  * In order to make sure that the server actually supports the service
810  * we're requesting, we open an RPC client, and fire off a NULL
811  * RPC call.
812  *
813  * caddr is the network address that the server will use to call us back.
814  * On multi-homed clients, this address depends on which NIC we use to
815  * route requests to the server.
816  *
817  * Returns one if successful, otherwise zero.
818  */
819 int clnt_ping(struct sockaddr_in *saddr, const unsigned long prog,
820                 const unsigned long vers, const unsigned int prot,
821                 struct sockaddr_in *caddr)
822 {
823         CLIENT *clnt = NULL;
824         int sock, stat;
825         static char clnt_res;
826         struct sockaddr dissolve;
827
828         rpc_createerr.cf_stat = stat = 0;
829         sock = get_socket(saddr, prot, CONNECT_TIMEOUT, FALSE, TRUE);
830         if (sock == RPC_ANYSOCK) {
831                 if (rpc_createerr.cf_error.re_errno == ETIMEDOUT) {
832                         /*
833                          * TCP timeout. Bubble up the error to see 
834                          * how it should be handled.
835                          */
836                         rpc_createerr.cf_stat = RPC_TIMEDOUT;
837                 }
838                 return 0;
839         }
840
841         if (caddr) {
842                 /* Get the address of our end of this connection */
843                 socklen_t len = sizeof(*caddr);
844                 if (getsockname(sock, caddr, &len) != 0)
845                         caddr->sin_family = 0;
846         }
847
848         switch(prot) {
849         case IPPROTO_UDP:
850                 /* The socket is connected (so we could getsockname successfully),
851                  * but some servers on multi-homed hosts reply from
852                  * the wrong address, so if we stay connected, we lose the reply.
853                  */
854                 dissolve.sa_family = AF_UNSPEC;
855                 connect(sock, &dissolve, sizeof(dissolve));
856
857                 clnt = clntudp_bufcreate(saddr, prog, vers,
858                                          RETRY_TIMEOUT, &sock,
859                                          RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
860                 break;
861         case IPPROTO_TCP:
862                 clnt = clnttcp_create(saddr, prog, vers, &sock,
863                                       RPCSMALLMSGSIZE, RPCSMALLMSGSIZE);
864                 break;
865         }
866         if (!clnt) {
867                 close(sock);
868                 return 0;
869         }
870         memset(&clnt_res, 0, sizeof(clnt_res));
871         stat = clnt_call(clnt, NULLPROC,
872                          (xdrproc_t)xdr_void, (caddr_t)NULL,
873                          (xdrproc_t)xdr_void, (caddr_t)&clnt_res,
874                          TIMEOUT);
875         if (stat) {
876                 clnt_geterr(clnt, &rpc_createerr.cf_error);
877                 rpc_createerr.cf_stat = stat;
878         }
879         clnt_destroy(clnt);
880         close(sock);
881
882         if (stat == RPC_SUCCESS)
883                 return 1;
884         else
885                 return 0;
886 }
887
888 /*
889  * Try a getsockname() on a connected datagram socket.
890  *
891  * Returns 1 and fills in @buf if successful; otherwise, zero.
892  *
893  * A connected datagram socket prevents leaving a socket in TIME_WAIT.
894  * This conserves the ephemeral port number space, helping reduce failed
895  * socket binds during mount storms.
896  */
897 static int nfs_ca_sockname(const struct sockaddr *sap, const socklen_t salen,
898                            struct sockaddr *buf, socklen_t *buflen)
899 {
900         struct sockaddr_in sin = {
901                 .sin_family             = AF_INET,
902                 .sin_addr.s_addr        = htonl(INADDR_ANY),
903         };
904         struct sockaddr_in6 sin6 = {
905                 .sin6_family            = AF_INET6,
906                 .sin6_addr              = IN6ADDR_ANY_INIT,
907         };
908         int sock;
909
910         sock = socket(sap->sa_family, SOCK_DGRAM, IPPROTO_UDP);
911         if (sock < 0)
912                 return 0;
913
914         switch (sap->sa_family) {
915         case AF_INET:
916                 if (bind(sock, (struct sockaddr *)&sin, sizeof(sin)) < 0) {
917                         close(sock);
918                         return 0;
919                 }
920                 break;
921         case AF_INET6:
922                 if (bind(sock, (struct sockaddr *)&sin6, sizeof(sin6)) < 0) {
923                         close(sock);
924                         return 0;
925                 }
926                 break;
927         default:
928                 errno = EAFNOSUPPORT;
929                 return 0;
930         }
931
932         if (connect(sock, sap, salen) < 0) {
933                 close(sock);
934                 return 0;
935         }
936
937         return !getsockname(sock, buf, buflen);
938 }
939
940 /*
941  * Try to generate an address that prevents the server from calling us.
942  *
943  * Returns 1 and fills in @buf if successful; otherwise, zero.
944  */
945 static int nfs_ca_gai(const struct sockaddr *sap, const socklen_t salen,
946                       struct sockaddr *buf, socklen_t *buflen)
947 {
948         struct addrinfo *gai_results;
949         struct addrinfo gai_hint = {
950                 .ai_family      = sap->sa_family,
951                 .ai_flags       = AI_PASSIVE,   /* ANYADDR */
952         };
953
954         if (getaddrinfo(NULL, "", &gai_hint, &gai_results))
955                 return 0;
956
957         *buflen = gai_results->ai_addrlen;
958         memcpy(buf, gai_results->ai_addr, *buflen);
959
960         freeaddrinfo(gai_results);
961
962         return 1;
963 }
964
965 /**
966  * nfs_callback_address - acquire our local network address
967  * @sap: pointer to address of remote
968  * @sap_len: length of address
969  * @buf: pointer to buffer to be filled in with local network address
970  * @buflen: IN: length of buffer to fill in; OUT: length of filled-in address
971  *
972  * Discover a network address that an NFSv4 server can use to call us back.
973  * On multi-homed clients, this address depends on which NIC we use to
974  * route requests to the server.
975  *
976  * Returns 1 and fills in @buf if an unambiguous local address is
977  * available; returns 1 and fills in an appropriate ANYADDR address
978  * if a local address isn't available; otherwise, returns zero.
979  */
980 int nfs_callback_address(const struct sockaddr *sap, const socklen_t salen,
981                          struct sockaddr *buf, socklen_t *buflen)
982 {
983         struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)buf;
984
985         if (nfs_ca_sockname(sap, salen, buf, buflen) == 0)
986                 if (nfs_ca_gai(sap, salen, buf, buflen) == 0)
987                         goto out_failed;
988
989         /*
990          * The server can't use an interface ID that was generated
991          * here on the client, so always clear sin6_scope_id.
992          */
993         if (sin6->sin6_family == AF_INET6)
994                 sin6->sin6_scope_id = 0;
995
996         return 1;
997
998 out_failed:
999         *buflen = 0;
1000         if (verbose)
1001                 nfs_error(_("%s: failed to construct callback address"));
1002         return 0;
1003
1004 }