2
* stropts.c -- NFS mount using C string to pass options to kernel
4
* Copyright (C) 2007 Oracle. All rights reserved.
5
* Copyright (C) 2007 Chuck Lever <chuck.lever@oracle.com>
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.
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.
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.
32
#include <sys/socket.h>
33
#include <sys/mount.h>
38
#include "nfs_mount.h"
39
#include "mount_constants.h"
43
#include "parse_opt.h"
45
#ifdef HAVE_RPCSVC_NFS_PROT_H
46
#include <rpcsvc/nfs_prot.h>
48
#include <linux/nfs.h>
49
#define nfsstat nfs_stat
56
#ifndef NFS_MAXHOSTNAME
57
#define NFS_MAXHOSTNAME (255)
60
#ifndef NFS_MAXPATHNAME
61
#define NFS_MAXPATHNAME (1024)
64
extern int nfs_mount_data_version;
65
extern char *progname;
68
static int parse_devname(const char *spec, char **hostname)
71
char *dev, *pathname, *s;
75
if (!(pathname = strchr(dev, ':'))) {
76
nfs_error(_("%s: remote share not in 'host:dir' format"),
84
* We don't need a copy of the pathname, but let's
85
* sanity check it anyway.
87
if (strlen(pathname) > NFS_MAXPATHNAME) {
88
nfs_error(_("%s: export pathname is too long"),
94
* Ignore all but first hostname in replicated mounts
95
* until they can be fully supported. (mack@sgi.com)
97
if ((s = strchr(dev, ','))) {
99
nfs_error(_("%s: warning: multiple hostnames not supported"),
101
nfs_error(_("%s: ignoring hostnames that follow the first one"),
104
*hostname = xstrdup(dev);
105
if (strlen(*hostname) > NFS_MAXHOSTNAME) {
106
nfs_error(_("%s: server hostname is too long"),
119
static int fill_ipv4_sockaddr(const char *hostname, struct sockaddr_in *addr)
122
addr->sin_family = AF_INET;
124
if (inet_aton(hostname, &addr->sin_addr))
126
if ((hp = gethostbyname(hostname)) == NULL) {
127
nfs_error(_("%s: can't get address for %s\n"),
131
if (hp->h_length > sizeof(struct in_addr)) {
132
nfs_error(_("%s: got bad hp->h_length"), progname);
133
hp->h_length = sizeof(struct in_addr);
135
memcpy(&addr->sin_addr, hp->h_addr, hp->h_length);
140
* Append the 'addr=' option to the options string to pass a resolved
141
* server address to the kernel. After a successful mount, this address
142
* is also added to /etc/mtab for use when unmounting.
144
* If 'addr=' is already present, we strip it out. This prevents users
145
* from setting a bogus 'addr=' option themselves, and also allows bg
146
* retries to recompute the server's address, in case it has changed.
148
* Returns 1 if 'addr=' option appended successfully;
151
static int append_addr_option(struct sockaddr_in *saddr,
152
struct mount_options *options)
156
po_remove_all(options, "addr");
158
snprintf(new_option, sizeof(new_option) - 1,
159
"addr=%s", inet_ntoa(saddr->sin_addr));
161
if (po_append(options, new_option) == PO_SUCCEEDED)
167
* Called to discover our address and append an appropriate 'clientaddr='
168
* option to the options string.
170
* Returns 1 if 'clientaddr=' option created successfully or if
171
* 'clientaddr=' option is already present; otherwise zero.
173
static int append_clientaddr_option(struct sockaddr_in *saddr,
174
struct mount_options *options)
176
struct sockaddr_in my_addr;
179
if (po_contains(options, "clientaddr") == PO_SUCCEEDED)
182
if (!get_client_address(saddr, &my_addr))
185
snprintf(new_option, sizeof(new_option) - 1,
186
"clientaddr=%s", inet_ntoa(my_addr.sin_addr));
188
if (po_append(options, new_option) == PO_SUCCEEDED)
194
* Resolve the 'mounthost=' hostname and append a new option using
195
* the resulting IPv4 address.
197
static int fix_mounthost_option(struct mount_options *options)
199
struct sockaddr_in maddr;
200
char *mounthost, new_option[32];
202
mounthost = po_get(options, "mounthost");
206
if (!fill_ipv4_sockaddr(mounthost, &maddr))
209
snprintf(new_option, sizeof(new_option) - 1,
210
"mountaddr=%s", inet_ntoa(maddr.sin_addr));
212
if (po_append(options, new_option) == PO_SUCCEEDED)
218
* Set up mandatory mount options.
220
* Returns 1 if successful; otherwise zero.
222
static int set_mandatory_options(const char *type,
223
struct sockaddr_in *saddr,
224
struct mount_options *options)
226
if (!append_addr_option(saddr, options))
229
if (strncmp(type, "nfs4", 4) == 0) {
230
if (!append_clientaddr_option(saddr, options))
233
if (!fix_mounthost_option(options))
241
* Distinguish between permanent and temporary errors.
243
* Returns 0 if the passed-in error is temporary, thus the
244
* mount system call should be retried; returns one if the
245
* passed-in error is permanent, thus the mount system call
246
* should not be retried.
248
static int is_permanent_error(int error)
255
return 0; /* temporary */
257
return 1; /* permanent */
262
* Reconstruct the mount option string based on a portmapper probe
263
* of the server. Returns one if the server's portmapper returned
264
* something we can use, otherwise zero.
266
* To handle version and transport protocol fallback properly, we
267
* need to parse some of the mount options in order to set up a
268
* portmap probe. Mount options that rewrite_mount_options()
269
* doesn't recognize are left alone.
271
* Returns a new group of mount options if successful; otherwise
272
* NULL is returned if some failure occurred.
274
static struct mount_options *rewrite_mount_options(char *str)
276
struct mount_options *options;
277
char *option, new_option[64];
278
clnt_addr_t mnt_server = { };
279
clnt_addr_t nfs_server = { };
282
options = po_split(str);
286
option = po_get(options, "addr");
288
nfs_server.saddr.sin_family = AF_INET;
289
if (!inet_aton((const char *)option, &nfs_server.saddr.sin_addr))
294
option = po_get(options, "mountaddr");
296
mnt_server.saddr.sin_family = AF_INET;
297
if (!inet_aton((const char *)option, &mnt_server.saddr.sin_addr))
300
memcpy(&mnt_server.saddr, &nfs_server.saddr,
301
sizeof(mnt_server.saddr));
303
option = po_get(options, "mountport");
305
mnt_server.pmap.pm_port = atoi(option);
306
mnt_server.pmap.pm_prog = MOUNTPROG;
307
option = po_get(options, "mountprog");
309
mnt_server.pmap.pm_prog = atoi(option);
310
option = po_get(options, "mountvers");
312
mnt_server.pmap.pm_vers = atoi(option);
314
option = po_get(options, "port");
316
nfs_server.pmap.pm_port = atoi(option);
317
po_remove_all(options, "port");
319
nfs_server.pmap.pm_prog = NFS_PROGRAM;
320
option = po_get(options, "nfsprog");
322
nfs_server.pmap.pm_prog = atoi(option);
324
option = po_get(options, "nfsvers");
326
nfs_server.pmap.pm_vers = atoi(option);
327
po_remove_all(options, "nfsvers");
329
option = po_get(options, "vers");
331
nfs_server.pmap.pm_vers = atoi(option);
332
po_remove_all(options, "vers");
334
option = po_get(options, "proto");
336
if (strcmp(option, "tcp") == 0) {
337
nfs_server.pmap.pm_prot = IPPROTO_TCP;
338
po_remove_all(options, "proto");
340
if (strcmp(option, "udp") == 0) {
341
nfs_server.pmap.pm_prot = IPPROTO_UDP;
342
po_remove_all(options, "proto");
345
p = po_rightmost(options, "tcp", "udp");
347
case PO_KEY2_RIGHTMOST:
348
nfs_server.pmap.pm_prot = IPPROTO_UDP;
350
case PO_KEY1_RIGHTMOST:
351
nfs_server.pmap.pm_prot = IPPROTO_TCP;
354
po_remove_all(options, "tcp");
355
po_remove_all(options, "udp");
357
if (!probe_bothports(&mnt_server, &nfs_server)) {
358
rpc_mount_errors("rpcbind", 0, 0);
362
snprintf(new_option, sizeof(new_option) - 1,
363
"nfsvers=%lu", nfs_server.pmap.pm_vers);
364
if (po_append(options, new_option) == PO_FAILED)
367
if (nfs_server.pmap.pm_prot == IPPROTO_TCP)
368
snprintf(new_option, sizeof(new_option) - 1,
371
snprintf(new_option, sizeof(new_option) - 1,
373
if (po_append(options, new_option) == PO_FAILED)
376
if (nfs_server.pmap.pm_port != NFS_PORT) {
377
snprintf(new_option, sizeof(new_option) - 1,
378
"port=%lu", nfs_server.pmap.pm_port);
379
if (po_append(options, new_option) == PO_FAILED)
392
* Retry an NFS mount that failed because the requested service isn't
393
* available on the server.
395
* Returns 1 if successful. Otherwise, returns zero.
396
* "errno" is set to reflect the individual error.
398
* Side effect: If the retry is successful, both 'options' and
399
* 'extra_opts' are updated to reflect the mount options that worked.
400
* If the retry fails, 'options' and 'extra_opts' are left unchanged.
402
static int retry_nfsmount(const char *spec, const char *node,
403
int flags, struct mount_options *options,
404
int fake, char **extra_opts)
406
struct mount_options *retry_options;
407
char *retry_str = NULL;
409
retry_options = rewrite_mount_options(*extra_opts);
410
if (!retry_options) {
415
if (po_join(retry_options, &retry_str) == PO_FAILED) {
416
po_destroy(retry_options);
422
printf(_("%s: text-based options (retry): '%s'\n"),
423
progname, retry_str);
425
if (!mount(spec, node, "nfs",
426
flags & ~(MS_USER|MS_USERS), retry_str)) {
428
*extra_opts = retry_str;
429
po_replace(options, retry_options);
433
po_destroy(retry_options);
439
* Attempt an NFSv2/3 mount via a mount(2) system call. If the kernel
440
* claims the requested service isn't supported on the server, probe
441
* the server to see what's supported, rewrite the mount options,
442
* and retry the request.
444
* Returns 1 if successful. Otherwise, returns zero.
445
* "errno" is set to reflect the individual error.
447
* Side effect: If the retry is successful, both 'options' and
448
* 'extra_opts' are updated to reflect the mount options that worked.
449
* If the retry fails, 'options' and 'extra_opts' are left unchanged.
451
static int try_nfs23mount(const char *spec, const char *node,
452
int flags, struct mount_options *options,
453
int fake, char **extra_opts)
455
if (po_join(options, extra_opts) == PO_FAILED) {
461
printf(_("%s: text-based options: '%s'\n"),
462
progname, *extra_opts);
467
if (!mount(spec, node, "nfs",
468
flags & ~(MS_USER|MS_USERS), *extra_opts))
472
* The kernel returns EOPNOTSUPP if the RPC bind failed,
473
* and EPROTONOSUPPORT if the version isn't supported.
475
if (errno != EOPNOTSUPP && errno != EPROTONOSUPPORT)
478
return retry_nfsmount(spec, node, flags, options, fake, extra_opts);
482
* Attempt an NFS v4 mount via a mount(2) system call.
484
* Returns 1 if successful. Otherwise, returns zero.
485
* "errno" is set to reflect the individual error.
487
static int try_nfs4mount(const char *spec, const char *node,
488
int flags, struct mount_options *options,
489
int fake, char **extra_opts)
491
if (po_join(options, extra_opts) == PO_FAILED) {
497
printf(_("%s: text-based options: '%s'\n"),
498
progname, *extra_opts);
503
if (!mount(spec, node, "nfs4",
504
flags & ~(MS_USER|MS_USERS), *extra_opts))
510
* Try the mount(2) system call.
512
* Returns 1 if successful. Otherwise, returns zero.
513
* "errno" is set to reflect the individual error.
515
static int try_mount(const char *spec, const char *node, const char *type,
516
int flags, struct mount_options *options, int fake,
519
if (strncmp(type, "nfs4", 4) == 0)
520
return try_nfs4mount(spec, node, flags,
521
options, fake, extra_opts);
523
return try_nfs23mount(spec, node, flags,
524
options, fake, extra_opts);
528
* Handle "foreground" NFS mounts.
530
* Retry the mount request for as long as the 'retry=' option says.
532
* Returns a valid mount command exit code.
534
static int nfsmount_fg(const char *spec, const char *node,
535
const char *type, int flags,
536
struct mount_options *options, int fake,
539
unsigned int secs = 1;
540
time_t timeout = time(NULL);
543
timeout += 60 * 2; /* default: 2 minutes */
544
retry = po_get(options, "retry");
546
timeout += 60 * atoi(retry);
549
printf(_("%s: timeout set for %s"),
550
progname, ctime(&timeout));
553
if (try_mount(spec, node, type, flags,
554
options, fake, extra_opts))
557
if (is_permanent_error(errno))
560
if (time(NULL) > timeout) {
565
if (errno != ETIMEDOUT) {
574
mount_error(spec, node, errno);
579
* Handle "background" NFS mount [first try]
581
* Returns a valid mount command exit code.
583
* EX_BG should cause the caller to fork and invoke nfsmount_child.
585
static int nfsmount_parent(const char *spec, const char *node,
586
const char *type, char *hostname, int flags,
587
struct mount_options *options,
588
int fake, char **extra_opts)
590
if (try_mount(spec, node, type, flags, options,
594
if (is_permanent_error(errno)) {
595
mount_error(spec, node, errno);
599
sys_mount_errors(hostname, errno, 1, 1);
604
* Handle "background" NFS mount [retry daemon]
606
* Returns a valid mount command exit code: EX_SUCCESS if successful,
607
* EX_FAIL if a failure occurred. There's nothing to catch the
608
* error return, though, so we use sys_mount_errors to log the
611
static int nfsmount_child(const char *spec, const char *node,
612
const char *type, char *hostname, int flags,
613
struct mount_options *options,
614
int fake, char **extra_opts)
616
unsigned int secs = 1;
617
time_t timeout = time(NULL);
620
timeout += 60 * 10000; /* default: 10,000 minutes */
621
retry = po_get(options, "retry");
623
timeout += 60 * atoi(retry);
632
if (try_mount(spec, node, type, flags, options,
636
if (is_permanent_error(errno))
639
if (time(NULL) > timeout)
642
sys_mount_errors(hostname, errno, 1, 1);
645
sys_mount_errors(hostname, errno, 1, 0);
650
* Handle "background" NFS mount
652
* Returns a valid mount command exit code.
654
static int nfsmount_bg(const char *spec, const char *node,
655
const char *type, char *hostname, int flags,
656
struct mount_options *options,
657
int fake, int child, char **extra_opts)
660
return nfsmount_parent(spec, node, type, hostname, flags,
661
options, fake, extra_opts);
663
return nfsmount_child(spec, node, type, hostname, flags,
664
options, fake, extra_opts);
668
* nfsmount_string - Mount an NFS file system using C string options
669
* @spec: C string specifying remote share to mount ("hostname:path")
670
* @node: C string pathname of local mounted-on directory
671
* @type: C string that represents file system type ("nfs" or "nfs4")
672
* @flags: MS_ style mount flags
673
* @extra_opts: pointer to C string containing fs-specific mount options
674
* (input and output argument)
675
* @fake: flag indicating whether to carry out the whole operation
676
* @child: one if this is a mount daemon (bg)
678
int nfsmount_string(const char *spec, const char *node, const char *type,
679
int flags, char **extra_opts, int fake, int child)
681
struct mount_options *options = NULL;
682
struct sockaddr_in saddr;
684
int retval = EX_FAIL;
686
if (!parse_devname(spec, &hostname))
688
if (!fill_ipv4_sockaddr(hostname, &saddr))
691
options = po_split(*extra_opts);
693
nfs_error(_("%s: internal option parsing error"), progname);
697
if (!set_mandatory_options(type, &saddr, options))
700
if (po_rightmost(options, "bg", "fg") == PO_KEY1_RIGHTMOST)
701
retval = nfsmount_bg(spec, node, type, hostname, flags,
702
options, fake, child, extra_opts);
704
retval = nfsmount_fg(spec, node, type, flags, options,