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