99be0f3844023a35f975f6473aea41085432ba88
[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 "xcommon.h"
39 #include "mount.h"
40 #include "nls.h"
41 #include "mount_constants.h"
42 #include "stropts.h"
43 #include "error.h"
44 #include "network.h"
45 #include "parse_opt.h"
46 #include "version.h"
47 #include "parse_dev.h"
48
49 #ifndef NFS_PROGRAM
50 #define NFS_PROGRAM     (100003)
51 #endif
52
53 #ifndef NFS_PORT
54 #define NFS_PORT        (2049)
55 #endif
56
57 #ifndef NFS_MAXHOSTNAME
58 #define NFS_MAXHOSTNAME         (255)
59 #endif
60
61 #ifndef NFS_MAXPATHNAME
62 #define NFS_MAXPATHNAME         (1024)
63 #endif
64
65 #ifndef NFS_DEF_FG_TIMEOUT_MINUTES
66 #define NFS_DEF_FG_TIMEOUT_MINUTES      (2u)
67 #endif
68
69 #ifndef NFS_DEF_BG_TIMEOUT_MINUTES
70 #define NFS_DEF_BG_TIMEOUT_MINUTES      (10000u)
71 #endif
72
73 extern int nfs_mount_data_version;
74 extern char *progname;
75 extern int verbose;
76 extern int sloppy;
77
78 struct nfsmount_info {
79         const char              *spec,          /* server:/path */
80                                 *node,          /* mounted-on dir */
81                                 *type;          /* "nfs" or "nfs4" */
82         char                    *hostname;      /* server's hostname */
83
84         struct mount_options    *options;       /* parsed mount options */
85         char                    **extra_opts;   /* string for /etc/mtab */
86
87         int                     flags,          /* MS_ flags */
88                                 fake,           /* actually do the mount? */
89                                 child;          /* forked bg child? */
90
91         sa_family_t             family;         /* supported address family */
92 };
93
94 /*
95  * Obtain a retry timeout value based on the value of the "retry=" option.
96  *
97  * Returns a time_t timeout timestamp, in seconds.
98  */
99 static time_t nfs_parse_retry_option(struct mount_options *options,
100                                      unsigned int timeout_minutes)
101 {
102         long tmp;
103
104         switch (po_get_numeric(options, "retry", &tmp)) {
105         case PO_NOT_FOUND:
106                 break;
107         case PO_FOUND:
108                 if (tmp >= 0) {
109                         timeout_minutes = tmp;
110                         break;
111                 }
112         case PO_BAD_VALUE:
113                 if (verbose)
114                         nfs_error(_("%s: invalid retry timeout was specified; "
115                                         "using default timeout"), progname);
116                 break;
117         }
118
119         return time(NULL) + (time_t)(timeout_minutes * 60);
120 }
121
122 /*
123  * Convert the passed-in sockaddr-style address to presentation
124  * format, then append an option of the form "keyword=address".
125  *
126  * Returns 1 if the option was appended successfully; otherwise zero.
127  */
128 static int nfs_append_generic_address_option(const struct sockaddr *sap,
129                                              const socklen_t salen,
130                                              const char *keyword,
131                                              struct mount_options *options)
132 {
133         char address[NI_MAXHOST];
134         char new_option[512];
135
136         if (!nfs_present_sockaddr(sap, salen, address, sizeof(address)))
137                 goto out_err;
138
139         if (snprintf(new_option, sizeof(new_option), "%s=%s",
140                                         keyword, address) >= sizeof(new_option))
141                 goto out_err;
142
143         if (po_append(options, new_option) != PO_SUCCEEDED)
144                 goto out_err;
145
146         return 1;
147
148 out_err:
149         nfs_error(_("%s: failed to construct %s option"), progname, keyword);
150         return 0;
151 }
152
153 /*
154  * Append the 'addr=' option to the options string to pass a resolved
155  * server address to the kernel.  After a successful mount, this address
156  * is also added to /etc/mtab for use when unmounting.
157  *
158  * If 'addr=' is already present, we strip it out.  This prevents users
159  * from setting a bogus 'addr=' option themselves, and also allows bg
160  * retries to recompute the server's address, in case it has changed.
161  *
162  * Returns 1 if 'addr=' option appended successfully;
163  * otherwise zero.
164  */
165 static int nfs_append_addr_option(const struct sockaddr *sap,
166                                   socklen_t salen,
167                                   struct mount_options *options)
168 {
169         po_remove_all(options, "addr");
170         return nfs_append_generic_address_option(sap, salen, "addr", options);
171 }
172
173 /*
174  * Called to discover our address and append an appropriate 'clientaddr='
175  * option to the options string.
176  *
177  * Returns 1 if 'clientaddr=' option created successfully or if
178  * 'clientaddr=' option is already present; otherwise zero.
179  */
180 static int nfs_append_clientaddr_option(const struct sockaddr *sap,
181                                         socklen_t salen,
182                                         struct mount_options *options)
183 {
184         struct sockaddr_storage dummy;
185         struct sockaddr *my_addr = (struct sockaddr *)&dummy;
186         socklen_t my_len = sizeof(dummy);
187
188         if (po_contains(options, "clientaddr") == PO_FOUND)
189                 return 1;
190
191         nfs_callback_address(sap, salen, my_addr, &my_len);
192
193         return nfs_append_generic_address_option(my_addr, my_len,
194                                                         "clientaddr", options);
195 }
196
197 /*
198  * Resolve the 'mounthost=' hostname and append a new option using
199  * the resulting address.
200  */
201 static int nfs_fix_mounthost_option(const sa_family_t family,
202                                     struct mount_options *options)
203 {
204         struct sockaddr_storage dummy;
205         struct sockaddr *sap = (struct sockaddr *)&dummy;
206         socklen_t salen = sizeof(dummy);
207         char *mounthost;
208
209         mounthost = po_get(options, "mounthost");
210         if (!mounthost)
211                 return 1;
212
213         if (!nfs_name_to_address(mounthost, family, sap, &salen)) {
214                 nfs_error(_("%s: unable to determine mount server's address"),
215                                 progname);
216                 return 0;
217         }
218
219         return nfs_append_generic_address_option(sap, salen,
220                                                         "mountaddr", options);
221 }
222
223 /*
224  * Returns zero if the "lock" option is in effect, but statd
225  * can't be started.  Otherwise, returns 1.
226  */
227 static const char *nfs_lock_opttbl[] = {
228         "nolock",
229         "lock",
230         NULL,
231 };
232
233 static int nfs_verify_lock_option(struct mount_options *options)
234 {
235         if (po_rightmost(options, nfs_lock_opttbl) == 1)
236                 return 1;
237
238         if (!start_statd()) {
239                 nfs_error(_("%s: rpc.statd is not running but is "
240                             "required for remote locking."), progname);
241                 nfs_error(_("%s: Either use '-o nolock' to keep "
242                             "locks local, or start statd."), progname);
243                 return 0;
244         }
245
246         return 1;
247 }
248
249 static int nfs_append_sloppy_option(struct mount_options *options)
250 {
251         if (!sloppy || linux_version_code() < MAKE_VERSION(2, 6, 27))
252                 return 1;
253
254         if (po_append(options, "sloppy") == PO_FAILED)
255                 return 0;
256         return 1;
257 }
258
259 /*
260  * Set up mandatory NFS mount options.
261  *
262  * Returns 1 if successful; otherwise zero.
263  */
264 static int nfs_validate_options(struct nfsmount_info *mi)
265 {
266         struct sockaddr_storage dummy;
267         struct sockaddr *sap = (struct sockaddr *)&dummy;
268         socklen_t salen = sizeof(dummy);
269
270         if (!nfs_parse_devname(mi->spec, &mi->hostname, NULL))
271                 return 0;
272
273         if (!nfs_name_to_address(mi->hostname, mi->family, sap, &salen))
274                 return 0;
275
276         if (strncmp(mi->type, "nfs4", 4) == 0) {
277                 if (!nfs_append_clientaddr_option(sap, salen, mi->options))
278                         return 0;
279         } else {
280                 if (!nfs_fix_mounthost_option(mi->family, mi->options))
281                         return 0;
282                 if (!mi->fake && !nfs_verify_lock_option(mi->options))
283                         return 0;
284         }
285
286         if (!nfs_append_sloppy_option(mi->options))
287                 return 0;
288
289         return nfs_append_addr_option(sap, salen, mi->options);
290 }
291
292 /*
293  * Distinguish between permanent and temporary errors.
294  *
295  * Returns 0 if the passed-in error is temporary, thus the
296  * mount system call should be retried; returns one if the
297  * passed-in error is permanent, thus the mount system call
298  * should not be retried.
299  */
300 static int nfs_is_permanent_error(int error)
301 {
302         switch (error) {
303         case ESTALE:
304         case ETIMEDOUT:
305         case ECONNREFUSED:
306                 return 0;       /* temporary */
307         default:
308                 return 1;       /* permanent */
309         }
310 }
311
312 /*
313  * Reconstruct the mount option string based on a portmapper probe
314  * of the server.  Returns one if the server's portmapper returned
315  * something we can use, otherwise zero.
316  *
317  * To handle version and transport protocol fallback properly, we
318  * need to parse some of the mount options in order to set up a
319  * portmap probe.  Mount options that nfs_rewrite_mount_options()
320  * doesn't recognize are left alone.
321  *
322  * Returns a new group of mount options if successful; otherwise
323  * NULL is returned if some failure occurred.
324  */
325 static struct mount_options *nfs_rewrite_mount_options(char *str)
326 {
327         struct mount_options *options;
328         char *option, new_option[64];
329         clnt_addr_t mnt_server = { };
330         clnt_addr_t nfs_server = { };
331
332         options = po_split(str);
333         if (!options) {
334                 errno = EFAULT;
335                 return NULL;
336         }
337
338         errno = EINVAL;
339         option = po_get(options, "addr");
340         if (option) {
341                 nfs_server.saddr.sin_family = AF_INET;
342                 if (!inet_aton((const char *)option, &nfs_server.saddr.sin_addr))
343                         goto err;
344         } else
345                 goto err;
346
347         option = po_get(options, "mountaddr");
348         if (option) {
349                 mnt_server.saddr.sin_family = AF_INET;
350                 if (!inet_aton((const char *)option, &mnt_server.saddr.sin_addr))
351                         goto err;
352         } else
353                 memcpy(&mnt_server.saddr, &nfs_server.saddr,
354                                 sizeof(mnt_server.saddr));
355
356         nfs_options2pmap(options, &nfs_server.pmap, &mnt_server.pmap);
357
358         /* The kernel NFS client doesn't support changing the RPC program
359          * number for these services, so reset these fields before probing
360          * the server's ports.  */
361         nfs_server.pmap.pm_prog = NFS_PROGRAM;
362         mnt_server.pmap.pm_prog = MOUNTPROG;
363
364         if (!probe_bothports(&mnt_server, &nfs_server)) {
365                 errno = ESPIPE;
366                 goto err;
367         }
368
369         snprintf(new_option, sizeof(new_option) - 1,
370                  "nfsvers=%lu", nfs_server.pmap.pm_vers);
371         if (po_append(options, new_option) == PO_FAILED)
372                 goto err;
373
374         if (nfs_server.pmap.pm_prot == IPPROTO_TCP)
375                 snprintf(new_option, sizeof(new_option) - 1,
376                          "proto=tcp");
377         else
378                 snprintf(new_option, sizeof(new_option) - 1,
379                          "proto=udp");
380         if (po_append(options, new_option) == PO_FAILED)
381                 goto err;
382
383         if (nfs_server.pmap.pm_port != NFS_PORT) {
384                 snprintf(new_option, sizeof(new_option) - 1,
385                          "port=%lu", nfs_server.pmap.pm_port);
386                 if (po_append(options, new_option) == PO_FAILED)
387                         goto err;
388
389         }
390
391         if (mnt_server.pmap.pm_prot == IPPROTO_TCP)
392                 snprintf(new_option, sizeof(new_option) - 1,
393                          "mountproto=tcp");
394         else
395                 snprintf(new_option, sizeof(new_option) - 1,
396                          "mountproto=udp");
397         if (po_append(options, new_option) == PO_FAILED)
398                 goto err;
399
400         snprintf(new_option, sizeof(new_option) - 1,
401                  "mountport=%lu", mnt_server.pmap.pm_port);
402         if (po_append(options, new_option) == PO_FAILED)
403                 goto err;
404
405         errno = 0;
406         return options;
407
408 err:
409         po_destroy(options);
410         return NULL;
411 }
412
413 /*
414  * Do the mount(2) system call.
415  *
416  * Returns 1 if successful, otherwise zero.
417  * "errno" is set to reflect the individual error.
418  */
419 static int nfs_sys_mount(const struct nfsmount_info *mi, const char *type,
420                          const char *options)
421 {
422         int result;
423
424         result = mount(mi->spec, mi->node, type,
425                                 mi->flags & ~(MS_USER|MS_USERS), options);
426         if (verbose && result) {
427                 int save = errno;
428                 nfs_error(_("%s: mount(2): %s"), progname, strerror(save));
429                 errno = save;
430         }
431         return !result;
432 }
433
434 /*
435  * Retry an NFS mount that failed because the requested service isn't
436  * available on the server.
437  *
438  * Returns 1 if successful.  Otherwise, returns zero.
439  * "errno" is set to reflect the individual error.
440  *
441  * Side effect: If the retry is successful, both 'options' and
442  * 'extra_opts' are updated to reflect the mount options that worked.
443  * If the retry fails, 'options' and 'extra_opts' are left unchanged.
444  */
445 static int nfs_retry_nfs23mount(struct nfsmount_info *mi)
446 {
447         struct mount_options *retry_options;
448         char *retry_str = NULL;
449         char **extra_opts = mi->extra_opts;
450
451         retry_options = nfs_rewrite_mount_options(*extra_opts);
452         if (!retry_options)
453                 return 0;
454
455         if (po_join(retry_options, &retry_str) == PO_FAILED) {
456                 po_destroy(retry_options);
457                 errno = EIO;
458                 return 0;
459         }
460
461         if (verbose)
462                 printf(_("%s: text-based options (retry): '%s'\n"),
463                         progname, retry_str);
464
465         if (!nfs_sys_mount(mi, "nfs", retry_str)) {
466                 po_destroy(retry_options);
467                 free(retry_str);
468                 return 0;
469         }
470
471         free(*extra_opts);
472         *extra_opts = retry_str;
473         po_replace(mi->options, retry_options);
474         return 1;
475 }
476
477 /*
478  * Attempt an NFSv2/3 mount via a mount(2) system call.  If the kernel
479  * claims the requested service isn't supported on the server, probe
480  * the server to see what's supported, rewrite the mount options,
481  * and retry the request.
482  *
483  * Returns 1 if successful.  Otherwise, returns zero.
484  * "errno" is set to reflect the individual error.
485  *
486  * Side effect: If the retry is successful, both 'options' and
487  * 'extra_opts' are updated to reflect the mount options that worked.
488  * If the retry fails, 'options' and 'extra_opts' are left unchanged.
489  */
490 static int nfs_try_nfs23mount(struct nfsmount_info *mi)
491 {
492         char **extra_opts = mi->extra_opts;
493
494         if (po_join(mi->options, extra_opts) == PO_FAILED) {
495                 errno = EIO;
496                 return 0;
497         }
498
499         if (verbose)
500                 printf(_("%s: text-based options: '%s'\n"),
501                         progname, *extra_opts);
502
503         if (mi->fake)
504                 return 1;
505
506         if (nfs_sys_mount(mi, "nfs", *extra_opts))
507                 return 1;
508
509         /*
510          * The kernel returns EOPNOTSUPP if the RPC bind failed,
511          * and EPROTONOSUPPORT if the version isn't supported.
512          */
513         if (errno != EOPNOTSUPP && errno != EPROTONOSUPPORT)
514                 return 0;
515
516         return nfs_retry_nfs23mount(mi);
517 }
518
519 /*
520  * Attempt an NFS v4 mount via a mount(2) system call.
521  *
522  * Returns 1 if successful.  Otherwise, returns zero.
523  * "errno" is set to reflect the individual error.
524  */
525 static int nfs_try_nfs4mount(struct nfsmount_info *mi)
526 {
527         char **extra_opts = mi->extra_opts;
528
529         if (po_join(mi->options, extra_opts) == PO_FAILED) {
530                 errno = EIO;
531                 return 0;
532         }
533
534         if (verbose)
535                 printf(_("%s: text-based options: '%s'\n"),
536                         progname, *extra_opts);
537
538         if (mi->fake)
539                 return 1;
540
541         return nfs_sys_mount(mi, "nfs4", *extra_opts);
542 }
543
544 /*
545  * Perform either an NFSv2/3 mount, or an NFSv4 mount system call.
546  *
547  * Returns 1 if successful.  Otherwise, returns zero.
548  * "errno" is set to reflect the individual error.
549  */
550 static int nfs_try_mount(struct nfsmount_info *mi)
551 {
552         if (strncmp(mi->type, "nfs4", 4) == 0)
553                 return nfs_try_nfs4mount(mi);
554         else
555                 return nfs_try_nfs23mount(mi);
556 }
557
558 /*
559  * Handle "foreground" NFS mounts.
560  *
561  * Retry the mount request for as long as the 'retry=' option says.
562  *
563  * Returns a valid mount command exit code.
564  */
565 static int nfsmount_fg(struct nfsmount_info *mi)
566 {
567         unsigned int secs = 1;
568         time_t timeout;
569
570         timeout = nfs_parse_retry_option(mi->options,
571                                          NFS_DEF_FG_TIMEOUT_MINUTES);
572         if (verbose)
573                 printf(_("%s: timeout set for %s"),
574                         progname, ctime(&timeout));
575
576         for (;;) {
577                 if (nfs_try_mount(mi))
578                         return EX_SUCCESS;
579
580                 if (nfs_is_permanent_error(errno))
581                         break;
582
583                 if (time(NULL) > timeout) {
584                         errno = ETIMEDOUT;
585                         break;
586                 }
587
588                 if (errno != ETIMEDOUT) {
589                         if (sleep(secs))
590                                 break;
591                         secs <<= 1;
592                         if (secs > 10)
593                                 secs = 10;
594                 }
595         };
596
597         mount_error(mi->spec, mi->node, errno);
598         return EX_FAIL;
599 }
600
601 /*
602  * Handle "background" NFS mount [first try]
603  *
604  * Returns a valid mount command exit code.
605  *
606  * EX_BG should cause the caller to fork and invoke nfsmount_child.
607  */
608 static int nfsmount_parent(struct nfsmount_info *mi)
609 {
610         if (nfs_try_mount(mi))
611                 return EX_SUCCESS;
612
613         if (nfs_is_permanent_error(errno)) {
614                 mount_error(mi->spec, mi->node, errno);
615                 return EX_FAIL;
616         }
617
618         sys_mount_errors(mi->hostname, errno, 1, 1);
619         return EX_BG;
620 }
621
622 /*
623  * Handle "background" NFS mount [retry daemon]
624  *
625  * Returns a valid mount command exit code: EX_SUCCESS if successful,
626  * EX_FAIL if a failure occurred.  There's nothing to catch the
627  * error return, though, so we use sys_mount_errors to log the
628  * failure.
629  */
630 static int nfsmount_child(struct nfsmount_info *mi)
631 {
632         unsigned int secs = 1;
633         time_t timeout;
634
635         timeout = nfs_parse_retry_option(mi->options,
636                                          NFS_DEF_BG_TIMEOUT_MINUTES);
637
638         for (;;) {
639                 if (sleep(secs))
640                         break;
641                 secs <<= 1;
642                 if (secs > 120)
643                         secs = 120;
644
645                 if (nfs_try_mount(mi))
646                         return EX_SUCCESS;
647
648                 if (nfs_is_permanent_error(errno))
649                         break;
650
651                 if (time(NULL) > timeout)
652                         break;
653
654                 sys_mount_errors(mi->hostname, errno, 1, 1);
655         };
656
657         sys_mount_errors(mi->hostname, errno, 1, 0);
658         return EX_FAIL;
659 }
660
661 /*
662  * Handle "background" NFS mount
663  *
664  * Returns a valid mount command exit code.
665  */
666 static int nfsmount_bg(struct nfsmount_info *mi)
667 {
668         if (!mi->child)
669                 return nfsmount_parent(mi);
670         else
671                 return nfsmount_child(mi);
672 }
673
674 /*
675  * Process mount options and try a mount system call.
676  *
677  * Returns a valid mount command exit code.
678  */
679 static const char *nfs_background_opttbl[] = {
680         "bg",
681         "fg",
682         NULL,
683 };
684
685 static int nfsmount_start(struct nfsmount_info *mi)
686 {
687         if (!nfs_validate_options(mi))
688                 return EX_FAIL;
689
690         if (po_rightmost(mi->options, nfs_background_opttbl) == 1)
691                 return nfsmount_bg(mi);
692         else
693                 return nfsmount_fg(mi);
694 }
695
696 /**
697  * nfsmount_string - Mount an NFS file system using C string options
698  * @spec: C string specifying remote share to mount ("hostname:path")
699  * @node: C string pathname of local mounted-on directory
700  * @type: C string that represents file system type ("nfs" or "nfs4")
701  * @flags: MS_ style mount flags
702  * @extra_opts: pointer to C string containing fs-specific mount options
703  *              (input and output argument)
704  * @fake: flag indicating whether to carry out the whole operation
705  * @child: one if this is a mount daemon (bg)
706  */
707 int nfsmount_string(const char *spec, const char *node, const char *type,
708                     int flags, char **extra_opts, int fake, int child)
709 {
710         struct nfsmount_info mi = {
711                 .spec           = spec,
712                 .node           = node,
713                 .type           = type,
714                 .extra_opts     = extra_opts,
715                 .flags          = flags,
716                 .fake           = fake,
717                 .child          = child,
718 #ifdef IPV6_SUPPORTED
719                 .family         = AF_UNSPEC,    /* either IPv4 or v6 */
720 #else
721                 .family         = AF_INET,      /* only IPv4 */
722 #endif
723         };
724         int retval = EX_FAIL;
725
726         mi.options = po_split(*extra_opts);
727         if (mi.options) {
728                 retval = nfsmount_start(&mi);
729                 po_destroy(mi.options);
730         } else
731                 nfs_error(_("%s: internal option parsing error"), progname);
732
733         free(mi.hostname);
734         return retval;
735 }