Merge branch 'sid'
[nfs-utils.git] / utils / mount / stropts.c
1 /*
2  * stropts.c -- NFS mount using C string to pass options to kernel
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.,
20  * 51 Franklin Street, Fifth Floor, Boston, MA 0211-1301 USA
21  *
22  */
23
24 #ifdef HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <unistd.h>
29 #include <errno.h>
30 #include <netdb.h>
31 #include <time.h>
32
33 #include <sys/socket.h>
34 #include <sys/mount.h>
35 #include <netinet/in.h>
36 #include <arpa/inet.h>
37
38 #include "sockaddr.h"
39 #include "xcommon.h"
40 #include "mount.h"
41 #include "nls.h"
42 #include "nfsrpc.h"
43 #include "mount_constants.h"
44 #include "stropts.h"
45 #include "error.h"
46 #include "network.h"
47 #include "parse_opt.h"
48 #include "version.h"
49 #include "parse_dev.h"
50 #include "conffile.h"
51
52 #ifndef NFS_PROGRAM
53 #define NFS_PROGRAM     (100003)
54 #endif
55
56 #ifndef NFS_PORT
57 #define NFS_PORT        (2049)
58 #endif
59
60 #ifndef NFS_MAXHOSTNAME
61 #define NFS_MAXHOSTNAME         (255)
62 #endif
63
64 #ifndef NFS_MAXPATHNAME
65 #define NFS_MAXPATHNAME         (1024)
66 #endif
67
68 #ifndef NFS_DEF_FG_TIMEOUT_MINUTES
69 #define NFS_DEF_FG_TIMEOUT_MINUTES      (2u)
70 #endif
71
72 #ifndef NFS_DEF_BG_TIMEOUT_MINUTES
73 #define NFS_DEF_BG_TIMEOUT_MINUTES      (10000u)
74 #endif
75
76 extern int nfs_mount_data_version;
77 extern char *progname;
78 extern int verbose;
79 extern int sloppy;
80
81 struct nfsmount_info {
82         const char              *spec,          /* server:/path */
83                                 *node,          /* mounted-on dir */
84                                 *type;          /* "nfs" or "nfs4" */
85         char                    *hostname;      /* server's hostname */
86         struct addrinfo         *address;       /* server's addresses */
87
88         struct mount_options    *options;       /* parsed mount options */
89         char                    **extra_opts;   /* string for /etc/mtab */
90
91         unsigned long           version;        /* NFS version */
92         int                     flags,          /* MS_ flags */
93                                 fake,           /* actually do the mount? */
94                                 child;          /* forked bg child? */
95 };
96
97 #ifdef MOUNT_CONFIG
98 static void nfs_default_version(struct nfsmount_info *mi);
99
100 static void nfs_default_version(struct nfsmount_info *mi)
101 {
102         extern unsigned long config_default_vers;
103         /*
104          * Use the default value set in the config file when
105          * the version has not been explicitly set.
106          */
107         if (mi->version == 0 && config_default_vers) {
108                 if (config_default_vers < 4)
109                         mi->version = config_default_vers;
110         }
111 }
112 #else
113 inline void nfs_default_version(__attribute__ ((unused)) struct nfsmount_info *mi) {}
114 #endif /* MOUNT_CONFIG */
115
116 /*
117  * Obtain a retry timeout value based on the value of the "retry=" option.
118  *
119  * Returns a time_t timeout timestamp, in seconds.
120  */
121 static time_t nfs_parse_retry_option(struct mount_options *options,
122                                      const time_t default_timeout)
123 {
124         time_t timeout_minutes;
125         long tmp;
126
127         timeout_minutes = default_timeout;
128         switch (po_get_numeric(options, "retry", &tmp)) {
129         case PO_NOT_FOUND:
130                 break;
131         case PO_FOUND:
132                 if (tmp >= 0) {
133                         timeout_minutes = tmp;
134                         break;
135                 }
136                 /*FALLTHROUGH*/
137         case PO_BAD_VALUE:
138                 if (verbose)
139                         nfs_error(_("%s: invalid retry timeout was specified; "
140                                         "using default timeout"), progname);
141                 break;
142         }
143
144         return time(NULL) + (timeout_minutes * 60);
145 }
146
147 /*
148  * Convert the passed-in sockaddr-style address to presentation
149  * format, then append an option of the form "keyword=address".
150  *
151  * Returns 1 if the option was appended successfully; otherwise zero.
152  */
153 static int nfs_append_generic_address_option(const struct sockaddr *sap,
154                                              const socklen_t salen,
155                                              const char *keyword,
156                                              struct mount_options *options)
157 {
158         char address[NI_MAXHOST];
159         char new_option[512];
160         int len;
161
162         if (!nfs_present_sockaddr(sap, salen, address, sizeof(address)))
163                 goto out_err;
164
165         len = snprintf(new_option, sizeof(new_option), "%s=%s",
166                                                 keyword, address);
167         if (len < 0 || (size_t)len >= sizeof(new_option))
168                 goto out_err;
169
170         if (po_append(options, new_option) != PO_SUCCEEDED)
171                 goto out_err;
172
173         return 1;
174
175 out_err:
176         nfs_error(_("%s: failed to construct %s option"), progname, keyword);
177         return 0;
178 }
179
180 /*
181  * Append the 'addr=' option to the options string to pass a resolved
182  * server address to the kernel.  After a successful mount, this address
183  * is also added to /etc/mtab for use when unmounting.
184  *
185  * If 'addr=' is already present, we strip it out.  This prevents users
186  * from setting a bogus 'addr=' option themselves, and also allows bg
187  * retries to recompute the server's address, in case it has changed.
188  *
189  * Returns 1 if 'addr=' option appended successfully;
190  * otherwise zero.
191  */
192 static int nfs_append_addr_option(const struct sockaddr *sap,
193                                   socklen_t salen,
194                                   struct mount_options *options)
195 {
196         po_remove_all(options, "addr");
197         return nfs_append_generic_address_option(sap, salen, "addr", options);
198 }
199
200 /*
201  * Called to discover our address and append an appropriate 'clientaddr='
202  * option to the options string.
203  *
204  * Returns 1 if 'clientaddr=' option created successfully or if
205  * 'clientaddr=' option is already present; otherwise zero.
206  */
207 static int nfs_append_clientaddr_option(const struct sockaddr *sap,
208                                         socklen_t salen,
209                                         struct mount_options *options)
210 {
211         union nfs_sockaddr address;
212         struct sockaddr *my_addr = &address.sa;
213         socklen_t my_len = sizeof(address);
214
215         if (po_contains(options, "clientaddr") == PO_FOUND)
216                 return 1;
217
218         nfs_callback_address(sap, salen, my_addr, &my_len);
219
220         return nfs_append_generic_address_option(my_addr, my_len,
221                                                         "clientaddr", options);
222 }
223
224 /*
225  * Determine whether to append a 'mountaddr=' option.  The option is needed if:
226  *
227  *   1. "mounthost=" was specified, or
228  *   2. The address families for proto= and mountproto= are different.
229  */
230 static int nfs_fix_mounthost_option(struct mount_options *options,
231                 const char *nfs_hostname)
232 {
233         union nfs_sockaddr address;
234         struct sockaddr *sap = &address.sa;
235         socklen_t salen = sizeof(address);
236         sa_family_t nfs_family, mnt_family;
237         char *mounthost;
238
239         if (!nfs_nfs_proto_family(options, &nfs_family))
240                 return 0;
241         if (!nfs_mount_proto_family(options, &mnt_family))
242                 return 0;
243
244         mounthost = po_get(options, "mounthost");
245         if (mounthost == NULL) {
246                 if (nfs_family == mnt_family)
247                         return 1;
248                 mounthost = (char *)nfs_hostname;
249         }
250
251         if (!nfs_lookup(mounthost, mnt_family, sap, &salen)) {
252                 nfs_error(_("%s: unable to determine mount server's address"),
253                                 progname);
254                 return 0;
255         }
256
257         return nfs_append_generic_address_option(sap, salen,
258                                                         "mountaddr", options);
259 }
260
261 /*
262  * Returns zero if the "lock" option is in effect, but statd
263  * can't be started.  Otherwise, returns 1.
264  */
265 static const char *nfs_lock_opttbl[] = {
266         "nolock",
267         "lock",
268         NULL,
269 };
270
271 static int nfs_verify_lock_option(struct mount_options *options)
272 {
273         if (po_rightmost(options, nfs_lock_opttbl) == 0)
274                 return 1;
275
276         if (!start_statd()) {
277                 nfs_error(_("%s: rpc.statd is not running but is "
278                             "required for remote locking."), progname);
279                 nfs_error(_("%s: Either use '-o nolock' to keep "
280                             "locks local, or start statd."), progname);
281                 return 0;
282         }
283
284         return 1;
285 }
286
287 static int nfs_append_sloppy_option(struct mount_options *options)
288 {
289         if (!sloppy || linux_version_code() < MAKE_VERSION(2, 6, 27))
290                 return 1;
291
292         if (po_append(options, "sloppy") == PO_FAILED)
293                 return 0;
294         return 1;
295 }
296
297 static int nfs_set_version(struct nfsmount_info *mi)
298 {
299         if (!nfs_nfs_version(mi->options, &mi->version))
300                 return 0;
301
302         if (strncmp(mi->type, "nfs4", 4) == 0)
303                 mi->version = 4;
304
305         /*
306          * Before 2.6.32, the kernel NFS client didn't
307          * support "-t nfs vers=4" mounts, so NFS version
308          * 4 cannot be included when autonegotiating
309          * while running on those kernels.
310          */
311         if (mi->version == 0 &&
312             linux_version_code() <= MAKE_VERSION(2, 6, 31))
313                 mi->version = 3;
314
315         /*
316          * If we still don't know, check for version-specific
317          * mount options.
318          */
319         if (mi->version == 0) {
320                 if (po_contains(mi->options, "mounthost") ||
321                     po_contains(mi->options, "mountaddr") ||
322                     po_contains(mi->options, "mountvers") ||
323                     po_contains(mi->options, "mountproto"))
324                         mi->version = 3;
325         }
326
327         /*
328          * If enabled, see if the default version was
329          * set in the config file
330          */
331         nfs_default_version(mi);
332         
333         return 1;
334 }
335
336 /*
337  * Set up mandatory non-version specific NFS mount options.
338  *
339  * Returns 1 if successful; otherwise zero.
340  */
341 static int nfs_validate_options(struct nfsmount_info *mi)
342 {
343         struct addrinfo hint = {
344                 .ai_protocol    = (int)IPPROTO_UDP,
345         };
346         sa_family_t family;
347         int error;
348
349         if (!nfs_parse_devname(mi->spec, &mi->hostname, NULL))
350                 return 0;
351
352         if (!nfs_nfs_proto_family(mi->options, &family))
353                 return 0;
354
355         hint.ai_family = (int)family;
356         error = getaddrinfo(mi->hostname, NULL, &hint, &mi->address);
357         if (error != 0) {
358                 nfs_error(_("%s: Failed to resolve server %s: %s"),
359                         progname, mi->hostname, gai_strerror(error));
360                 mi->address = NULL;
361                 return 0;
362         }
363
364         if (!nfs_set_version(mi))
365                 return 0;
366
367         if (!nfs_append_sloppy_option(mi->options))
368                 return 0;
369
370         if (!nfs_append_addr_option(mi->address->ai_addr,
371                                         mi->address->ai_addrlen, mi->options))
372                 return 0;
373
374         return 1;
375 }
376
377 /*
378  * Get NFS/mnt server addresses from mount options
379  *
380  * Returns 1 and fills in @nfs_saddr, @nfs_salen, @mnt_saddr, and @mnt_salen
381  * if all goes well; otherwise zero.
382  */
383 static int nfs_extract_server_addresses(struct mount_options *options,
384                                         struct sockaddr *nfs_saddr,
385                                         socklen_t *nfs_salen,
386                                         struct sockaddr *mnt_saddr,
387                                         socklen_t *mnt_salen)
388 {
389         char *option;
390
391         option = po_get(options, "addr");
392         if (option == NULL)
393                 return 0;
394         if (!nfs_string_to_sockaddr(option, nfs_saddr, nfs_salen))
395                 return 0;
396
397         option = po_get(options, "mountaddr");
398         if (option == NULL) {
399                 memcpy(mnt_saddr, nfs_saddr, *nfs_salen);
400                 *mnt_salen = *nfs_salen;
401         } else if (!nfs_string_to_sockaddr(option, mnt_saddr, mnt_salen))
402                 return 0;
403
404         return 1;
405 }
406
407 static int nfs_construct_new_options(struct mount_options *options,
408                                      struct sockaddr *nfs_saddr,
409                                      struct pmap *nfs_pmap,
410                                      struct sockaddr *mnt_saddr,
411                                      struct pmap *mnt_pmap)
412 {
413         char new_option[64];
414         char *netid;
415
416         po_remove_all(options, "nfsprog");
417         po_remove_all(options, "mountprog");
418
419         po_remove_all(options, "v2");
420         po_remove_all(options, "v3");
421         po_remove_all(options, "vers");
422         po_remove_all(options, "nfsvers");
423         snprintf(new_option, sizeof(new_option) - 1,
424                  "vers=%lu", nfs_pmap->pm_vers);
425         if (po_append(options, new_option) == PO_FAILED)
426                 return 0;
427
428         po_remove_all(options, "proto");
429         po_remove_all(options, "udp");
430         po_remove_all(options, "tcp");
431         netid = nfs_get_netid(nfs_saddr->sa_family, nfs_pmap->pm_prot);
432         if (netid == NULL)
433                 return 0;
434         snprintf(new_option, sizeof(new_option) - 1,
435                          "proto=%s", netid);
436         free(netid);
437         if (po_append(options, new_option) == PO_FAILED)
438                 return 0;
439
440         if(po_remove_all(options, "port") == PO_FOUND ||
441            nfs_pmap->pm_port != NFS_PORT) {
442                 snprintf(new_option, sizeof(new_option) - 1,
443                          "port=%lu", nfs_pmap->pm_port);
444                 if (po_append(options, new_option) == PO_FAILED)
445                         return 0;
446         }
447
448         po_remove_all(options, "mountvers");
449         snprintf(new_option, sizeof(new_option) - 1,
450                  "mountvers=%lu", mnt_pmap->pm_vers);
451         if (po_append(options, new_option) == PO_FAILED)
452                 return 0;
453
454         po_remove_all(options, "mountproto");
455         netid = nfs_get_netid(mnt_saddr->sa_family, mnt_pmap->pm_prot);
456         if (netid == NULL)
457                 return 0;
458         snprintf(new_option, sizeof(new_option) - 1,
459                          "mountproto=%s", netid);
460         free(netid);
461         if (po_append(options, new_option) == PO_FAILED)
462                 return 0;
463
464         po_remove_all(options, "mountport");
465         snprintf(new_option, sizeof(new_option) - 1,
466                  "mountport=%lu", mnt_pmap->pm_port);
467         if (po_append(options, new_option) == PO_FAILED)
468                 return 0;
469
470         return 1;
471 }
472
473 /*
474  * Reconstruct the mount option string based on a portmapper probe
475  * of the server.  Returns one if the server's portmapper returned
476  * something we can use, otherwise zero.
477  *
478  * To handle version and transport protocol fallback properly, we
479  * need to parse some of the mount options in order to set up a
480  * portmap probe.  Mount options that nfs_rewrite_pmap_mount_options()
481  * doesn't recognize are left alone.
482  *
483  * Returns TRUE if rewriting was successful; otherwise
484  * FALSE is returned if some failure occurred.
485  */
486 static int
487 nfs_rewrite_pmap_mount_options(struct mount_options *options)
488 {
489         union nfs_sockaddr nfs_address;
490         struct sockaddr *nfs_saddr = &nfs_address.sa;
491         socklen_t nfs_salen = sizeof(nfs_address);
492         struct pmap nfs_pmap;
493         union nfs_sockaddr mnt_address;
494         struct sockaddr *mnt_saddr = &mnt_address.sa;
495         socklen_t mnt_salen = sizeof(mnt_address);
496         unsigned long protocol;
497         struct pmap mnt_pmap;
498
499         /*
500          * Version and transport negotiation is not required
501          * and does not work for RDMA mounts.
502          */
503         if (!nfs_nfs_protocol(options, &protocol)) {
504                 errno = EINVAL;
505                 return 0;
506         }
507         if (protocol == NFSPROTO_RDMA)
508                 goto out;
509
510         /*
511          * Extract just the options needed to contact server.
512          * Bail now if any of these have bad values.
513          */
514         if (!nfs_extract_server_addresses(options, nfs_saddr, &nfs_salen,
515                                                 mnt_saddr, &mnt_salen)) {
516                 errno = EINVAL;
517                 return 0;
518         }
519         if (!nfs_options2pmap(options, &nfs_pmap, &mnt_pmap)) {
520                 errno = EINVAL;
521                 return 0;
522         }
523
524         /*
525          * The kernel NFS client doesn't support changing the RPC
526          * program number for these services, so force the value of
527          * these fields before probing the server's ports.
528          */
529         nfs_pmap.pm_prog = NFS_PROGRAM;
530         mnt_pmap.pm_prog = MOUNTPROG;
531
532         /*
533          * If the server's rpcbind service isn't available, we can't
534          * negotiate.  Bail now if we can't contact it.
535          */
536         if (!nfs_probe_bothports(mnt_saddr, mnt_salen, &mnt_pmap,
537                                  nfs_saddr, nfs_salen, &nfs_pmap)) {
538                 errno = ESPIPE;
539                 if (rpc_createerr.cf_stat == RPC_PROGNOTREGISTERED)
540                         errno = EOPNOTSUPP;
541                 else if (rpc_createerr.cf_stat == RPC_AUTHERROR)
542                         errno = EACCES;
543                 else if (rpc_createerr.cf_stat == RPC_TIMEDOUT)
544                         errno = ETIMEDOUT;
545                 else if (rpc_createerr.cf_stat == RPC_PROGVERSMISMATCH)
546                         errno = EPROTONOSUPPORT;
547                 else if (rpc_createerr.cf_error.re_errno != 0)
548                         errno = rpc_createerr.cf_error.re_errno;
549                 return 0;
550         }
551
552         if (!nfs_construct_new_options(options, nfs_saddr, &nfs_pmap,
553                                         mnt_saddr, &mnt_pmap)) {
554                 if (rpc_createerr.cf_stat == RPC_UNKNOWNPROTO)
555                         errno = EPROTONOSUPPORT;
556                 else
557                         errno = EINVAL;
558                 return 0;
559         }
560
561 out:
562         errno = 0;
563         return 1;
564 }
565
566 /*
567  * Do the mount(2) system call.
568  *
569  * Returns TRUE if successful, otherwise FALSE.
570  * "errno" is set to reflect the individual error.
571  */
572 static int nfs_sys_mount(struct nfsmount_info *mi, struct mount_options *opts)
573 {
574         char *options = NULL;
575         int result;
576
577         if (mi->fake)
578                 return 1;
579
580         if (po_join(opts, &options) == PO_FAILED) {
581                 errno = EIO;
582                 return 0;
583         }
584
585         result = mount(mi->spec, mi->node, mi->type,
586                         mi->flags & ~(MS_USER|MS_USERS), options);
587         free(options);
588
589         if (verbose && result) {
590                 int save = errno;
591                 nfs_error(_("%s: mount(2): %s"), progname, strerror(save));
592                 errno = save;
593         }
594         return !result;
595 }
596
597 static int nfs_do_mount_v3v2(struct nfsmount_info *mi,
598                 struct sockaddr *sap, socklen_t salen)
599 {
600         struct mount_options *options = po_dup(mi->options);
601         int result = 0;
602
603         if (!options) {
604                 errno = ENOMEM;
605                 return result;
606         }
607         errno = 0;
608         if (!nfs_append_addr_option(sap, salen, options)) {
609                 if (errno == 0)
610                         errno = EINVAL;
611                 goto out_fail;
612         }
613
614         if (!nfs_fix_mounthost_option(options, mi->hostname)) {
615                 if (errno == 0)
616                         errno = EINVAL;
617                 goto out_fail;
618         }
619         if (!mi->fake && !nfs_verify_lock_option(options)) {
620                 if (errno == 0)
621                         errno = EINVAL;
622                 goto out_fail;
623         }
624
625         /*
626          * Options we negotiate below may be stale by the time this
627          * file system is unmounted.  In order to force umount.nfs
628          * to renegotiate with the server, only write the user-
629          * specified options, and not negotiated options, to /etc/mtab.
630          */
631         if (po_join(options, mi->extra_opts) == PO_FAILED) {
632                 errno = ENOMEM;
633                 goto out_fail;
634         }
635
636         if (verbose)
637                 printf(_("%s: trying text-based options '%s'\n"),
638                         progname, *mi->extra_opts);
639
640         if (!nfs_rewrite_pmap_mount_options(options))
641                 goto out_fail;
642
643         result = nfs_sys_mount(mi, options);
644
645 out_fail:
646         po_destroy(options);
647         return result;
648 }
649
650 /*
651  * Attempt a "-t nfs vers=2" or "-t nfs vers=3" mount.
652  *
653  * Returns TRUE if successful, otherwise FALSE.
654  * "errno" is set to reflect the individual error.
655  */
656 static int nfs_try_mount_v3v2(struct nfsmount_info *mi)
657 {
658         struct addrinfo *ai;
659         int ret = 0;
660
661         for (ai = mi->address; ai != NULL; ai = ai->ai_next) {
662                 ret = nfs_do_mount_v3v2(mi, ai->ai_addr, ai->ai_addrlen);
663                 if (ret != 0)
664                         return ret;
665
666                 switch (errno) {
667                 case ECONNREFUSED:
668                 case EOPNOTSUPP:
669                 case EHOSTUNREACH:
670                 case ETIMEDOUT:
671                 case EACCES:
672                         continue;
673                 default:
674                         goto out;
675                 }
676         }
677 out:
678         return ret;
679 }
680
681 static int nfs_do_mount_v4(struct nfsmount_info *mi,
682                 struct sockaddr *sap, socklen_t salen)
683 {
684         struct mount_options *options = po_dup(mi->options);
685         int result = 0;
686         char *extra_opts = NULL;
687
688         if (!options) {
689                 errno = ENOMEM;
690                 return result;
691         }
692
693         if (mi->version == 0) {
694                 if (po_contains(options, "mounthost") ||
695                         po_contains(options, "mountaddr") ||
696                         po_contains(options, "mountvers") ||
697                         po_contains(options, "mountproto")) {
698                 /*
699                  * Since these mountd options are set assume version 3
700                  * is wanted so error out with EPROTONOSUPPORT so the
701                  * protocol negation starts with v3.
702                  */
703                         errno = EPROTONOSUPPORT;
704                         goto out_fail;
705                 }
706                 if (po_append(options, "vers=4") == PO_FAILED) {
707                         errno = EINVAL;
708                         goto out_fail;
709                 }
710         }
711
712         if (!nfs_append_addr_option(sap, salen, options)) {
713                 errno = EINVAL;
714                 goto out_fail;
715         }
716
717         if (!nfs_append_clientaddr_option(sap, salen, options)) {
718                 errno = EINVAL;
719                 goto out_fail;
720         }
721
722         if (po_join(options, &extra_opts) == PO_FAILED) {
723                 errno = ENOMEM;
724                 goto out_fail;
725         }
726
727         if (verbose)
728                 printf(_("%s: trying text-based options '%s'\n"),
729                         progname, extra_opts);
730
731         result = nfs_sys_mount(mi, options);
732
733         /*
734          * If success, update option string to be recorded in /etc/mtab.
735          */
736         if (result) {
737             free(*mi->extra_opts);
738             *mi->extra_opts = extra_opts;
739         } else
740             free(extra_opts);
741
742 out_fail:
743         po_destroy(options);
744         return result;
745 }
746
747 /*
748  * Attempt a "-t nfs -o vers=4" or "-t nfs4" mount.
749  *
750  * Returns TRUE if successful, otherwise FALSE.
751  * "errno" is set to reflect the individual error.
752  */
753 static int nfs_try_mount_v4(struct nfsmount_info *mi)
754 {
755         struct addrinfo *ai;
756         int ret = 0;
757
758         for (ai = mi->address; ai != NULL; ai = ai->ai_next) {
759                 ret = nfs_do_mount_v4(mi, ai->ai_addr, ai->ai_addrlen);
760                 if (ret != 0)
761                         return ret;
762
763                 switch (errno) {
764                 case ECONNREFUSED:
765                 case EHOSTUNREACH:
766                 case ETIMEDOUT:
767                 case EACCES:
768                         continue;
769                 default:
770                         goto out;
771                 }
772         }
773 out:
774         return ret;
775 }
776
777 /*
778  * Handle NFS version and transport protocol
779  * autonegotiation.
780  *
781  * When no version or protocol is specified on the
782  * command line, mount.nfs negotiates with the server
783  * to determine appropriate settings for the new
784  * mount point.
785  *
786  * Returns TRUE if successful, otherwise FALSE.
787  * "errno" is set to reflect the individual error.
788  */
789 static int nfs_autonegotiate(struct nfsmount_info *mi)
790 {
791         int result;
792
793         result = nfs_try_mount_v4(mi);
794         if (result)
795                 return result;
796                 
797         switch (errno) {
798         case EPROTONOSUPPORT:
799                 /* A clear indication that the server or our
800                  * client does not support NFS version 4. */
801                 goto fall_back;
802         case ENOENT:
803                 /* Legacy Linux servers don't export an NFS
804                  * version 4 pseudoroot. */
805                 goto fall_back;
806         case EPERM:
807                 /* Linux servers prior to 2.6.25 may return
808                  * EPERM when NFS version 4 is not supported. */
809                 goto fall_back;
810         default:
811                 return result;
812         }
813
814 fall_back:
815         return nfs_try_mount_v3v2(mi);
816 }
817
818 /*
819  * This is a single pass through the fg/bg loop.
820  *
821  * Returns TRUE if successful, otherwise FALSE.
822  * "errno" is set to reflect the individual error.
823  */
824 static int nfs_try_mount(struct nfsmount_info *mi)
825 {
826         int result = 0;
827
828         switch (mi->version) {
829         case 0:
830                 result = nfs_autonegotiate(mi);
831                 break;
832         case 2:
833         case 3:
834                 result = nfs_try_mount_v3v2(mi);
835                 break;
836         case 4:
837                 result = nfs_try_mount_v4(mi);
838                 break;
839         default:
840                 errno = EIO;
841         }
842
843         return result;
844 }
845
846 /*
847  * Distinguish between permanent and temporary errors.
848  *
849  * Basically, we retry if communication with the server has
850  * failed so far, but fail immediately if there is a local
851  * error (like a bad mount option).
852  *
853  * ESTALE is also a temporary error because some servers
854  * return ESTALE when a share is temporarily offline.
855  *
856  * Returns 1 if we should fail immediately, or 0 if we
857  * should retry.
858  */
859 static int nfs_is_permanent_error(int error)
860 {
861         switch (error) {
862         case ESTALE:
863         case ETIMEDOUT:
864         case ECONNREFUSED:
865         case EHOSTUNREACH:
866                 return 0;       /* temporary */
867         default:
868                 return 1;       /* permanent */
869         }
870 }
871
872 /*
873  * Handle "foreground" NFS mounts.
874  *
875  * Retry the mount request for as long as the 'retry=' option says.
876  *
877  * Returns a valid mount command exit code.
878  */
879 static int nfsmount_fg(struct nfsmount_info *mi)
880 {
881         unsigned int secs = 1;
882         time_t timeout;
883
884         timeout = nfs_parse_retry_option(mi->options,
885                                          NFS_DEF_FG_TIMEOUT_MINUTES);
886         if (verbose)
887                 printf(_("%s: timeout set for %s"),
888                         progname, ctime(&timeout));
889
890         for (;;) {
891                 if (nfs_try_mount(mi))
892                         return EX_SUCCESS;
893
894                 if (nfs_is_permanent_error(errno))
895                         break;
896
897                 if (time(NULL) > timeout) {
898                         errno = ETIMEDOUT;
899                         break;
900                 }
901
902                 if (errno != ETIMEDOUT) {
903                         if (sleep(secs))
904                                 break;
905                         secs <<= 1;
906                         if (secs > 10)
907                                 secs = 10;
908                 }
909         };
910
911         mount_error(mi->spec, mi->node, errno);
912         return EX_FAIL;
913 }
914
915 /*
916  * Handle "background" NFS mount [first try]
917  *
918  * Returns a valid mount command exit code.
919  *
920  * EX_BG should cause the caller to fork and invoke nfsmount_child.
921  */
922 static int nfsmount_parent(struct nfsmount_info *mi)
923 {
924         if (nfs_try_mount(mi))
925                 return EX_SUCCESS;
926
927         /* retry background mounts when the server is not up */
928         if (nfs_is_permanent_error(errno) && errno != EOPNOTSUPP) {
929                 mount_error(mi->spec, mi->node, errno);
930                 return EX_FAIL;
931         }
932
933         sys_mount_errors(mi->hostname, errno, 1, 1);
934         return EX_BG;
935 }
936
937 /*
938  * Handle "background" NFS mount [retry daemon]
939  *
940  * Returns a valid mount command exit code: EX_SUCCESS if successful,
941  * EX_FAIL if a failure occurred.  There's nothing to catch the
942  * error return, though, so we use sys_mount_errors to log the
943  * failure.
944  */
945 static int nfsmount_child(struct nfsmount_info *mi)
946 {
947         unsigned int secs = 1;
948         time_t timeout;
949
950         timeout = nfs_parse_retry_option(mi->options,
951                                          NFS_DEF_BG_TIMEOUT_MINUTES);
952
953         for (;;) {
954                 if (sleep(secs))
955                         break;
956                 secs <<= 1;
957                 if (secs > 120)
958                         secs = 120;
959
960                 if (nfs_try_mount(mi))
961                         return EX_SUCCESS;
962
963                 /* retry background mounts when the server is not up */
964                 if (nfs_is_permanent_error(errno) && errno != EOPNOTSUPP)
965                         break;
966
967                 if (time(NULL) > timeout)
968                         break;
969
970                 sys_mount_errors(mi->hostname, errno, 1, 1);
971         };
972
973         sys_mount_errors(mi->hostname, errno, 1, 0);
974         return EX_FAIL;
975 }
976
977 /*
978  * Handle "background" NFS mount
979  *
980  * Returns a valid mount command exit code.
981  */
982 static int nfsmount_bg(struct nfsmount_info *mi)
983 {
984         if (!mi->child)
985                 return nfsmount_parent(mi);
986         else
987                 return nfsmount_child(mi);
988 }
989
990 /*
991  * Usually all that is needed for an NFS remount is to change
992  * generic mount options like "sync" or "ro".  These generic
993  * options are controlled by mi->flags, not by text-based
994  * options, and no contact with the server is needed.
995  *
996  * Take care with the /etc/mtab entry for this mount; just
997  * calling update_mtab() will change an "-t nfs -o vers=4"
998  * mount to an "-t nfs -o remount" mount, and that will
999  * confuse umount.nfs.
1000  *
1001  * Returns a valid mount command exit code.
1002  */
1003 static int nfs_remount(struct nfsmount_info *mi)
1004 {
1005         if (nfs_sys_mount(mi, mi->options))
1006                 return EX_SUCCESS;
1007         return EX_FAIL;
1008 }
1009
1010 /*
1011  * Process mount options and try a mount system call.
1012  *
1013  * Returns a valid mount command exit code.
1014  */
1015 static const char *nfs_background_opttbl[] = {
1016         "bg",
1017         "fg",
1018         NULL,
1019 };
1020
1021 static int nfsmount_start(struct nfsmount_info *mi)
1022 {
1023         if (!nfs_validate_options(mi))
1024                 return EX_FAIL;
1025
1026         /*
1027          * Avoid retry and negotiation logic when remounting
1028          */
1029         if (mi->flags & MS_REMOUNT)
1030                 return nfs_remount(mi);
1031
1032         if (po_rightmost(mi->options, nfs_background_opttbl) == 0)
1033                 return nfsmount_bg(mi);
1034         else
1035                 return nfsmount_fg(mi);
1036 }
1037
1038 /**
1039  * nfsmount_string - Mount an NFS file system using C string options
1040  * @spec: C string specifying remote share to mount ("hostname:path")
1041  * @node: C string pathname of local mounted-on directory
1042  * @type: C string that represents file system type ("nfs" or "nfs4")
1043  * @flags: MS_ style mount flags
1044  * @extra_opts: pointer to C string containing fs-specific mount options
1045  *              (input and output argument)
1046  * @fake: flag indicating whether to carry out the whole operation
1047  * @child: one if this is a mount daemon (bg)
1048  *
1049  * Returns a valid mount command exit code.
1050  */
1051 int nfsmount_string(const char *spec, const char *node, const char *type,
1052                     int flags, char **extra_opts, int fake, int child)
1053 {
1054         struct nfsmount_info mi = {
1055                 .spec           = spec,
1056                 .node           = node,
1057                 .address        = NULL,
1058                 .type           = type,
1059                 .extra_opts     = extra_opts,
1060                 .flags          = flags,
1061                 .fake           = fake,
1062                 .child          = child,
1063         };
1064         int retval = EX_FAIL;
1065
1066         mi.options = po_split(*extra_opts);
1067         if (mi.options) {
1068                 retval = nfsmount_start(&mi);
1069                 po_destroy(mi.options);
1070         } else
1071                 nfs_error(_("%s: internal option parsing error"), progname);
1072
1073         freeaddrinfo(mi.address);
1074         free(mi.hostname);
1075         return retval;
1076 }