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