mount.nfs: teach [u]mount.nfs[4] to exit with EX_SUCCESS instead of 0
[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 #include <ctype.h>
25 #include <unistd.h>
26 #include <stdio.h>
27 #include <string.h>
28 #include <stdlib.h>
29 #include <errno.h>
30 #include <netdb.h>
31 #include <time.h>
32 #include <sys/socket.h>
33 #include <sys/mount.h>
34
35 #include "xcommon.h"
36 #include "mount.h"
37 #include "nls.h"
38 #include "nfs_mount.h"
39 #include "mount_constants.h"
40 #include "stropts.h"
41 #include "error.h"
42 #include "network.h"
43
44 #ifdef HAVE_RPCSVC_NFS_PROT_H
45 #include <rpcsvc/nfs_prot.h>
46 #else
47 #include <linux/nfs.h>
48 #define nfsstat nfs_stat
49 #endif
50
51 #ifndef NFS_PORT
52 #define NFS_PORT 2049
53 #endif
54
55 #ifndef NFS_MAXHOSTNAME
56 #define NFS_MAXHOSTNAME         (255)
57 #endif
58
59 #ifndef NFS_MAXPATHNAME
60 #define NFS_MAXPATHNAME         (1024)
61 #endif
62
63 extern int nfs_mount_data_version;
64 extern char *progname;
65 extern int verbose;
66
67 static int retry_opt = 10000;           /* 10,000 minutes ~= 1 week */
68 static int bg_opt = 0;
69 static int addr_opt = 0;
70 static int ca_opt = 0;
71
72 static int parse_devname(const char *spec, char **hostname)
73 {
74         int ret = 0;
75         char *dev, *pathname, *s;
76
77         dev = xstrdup(spec);
78
79         if (!(pathname = strchr(dev, ':'))) {
80                 nfs_error(_("%s: remote share not in 'host:dir' format"),
81                                 progname);
82                 goto out;
83         }
84         *pathname = '\0';
85         pathname++;
86
87         /*
88          * We don't need a copy of the pathname, but let's
89          * sanity check it anyway.
90          */
91         if (strlen(pathname) > NFS_MAXPATHNAME) {
92                 nfs_error(_("%s: export pathname is too long"),
93                                 progname);
94                 goto out;
95         }
96
97         /*
98          * Ignore all but first hostname in replicated mounts
99          * until they can be fully supported. (mack@sgi.com)
100          */
101         if ((s = strchr(dev, ','))) {
102                 *s = '\0';
103                 nfs_error(_("%s: warning: multiple hostnames not supported"),
104                                 progname);
105                 nfs_error(_("%s: ignoring hostnames that follow the first one"),
106                                 progname);
107         }
108         *hostname = xstrdup(dev);
109         if (strlen(*hostname) > NFS_MAXHOSTNAME) {
110                 nfs_error(_("%s: server hostname is too long"),
111                                 progname);
112                 free(*hostname);
113                 goto out;
114         }
115
116         ret = 1;
117
118 out:
119         free(dev);
120         return ret;
121 }
122
123 static int fill_ipv4_sockaddr(const char *hostname, struct sockaddr_in *addr)
124 {
125         struct hostent *hp;
126         addr->sin_family = AF_INET;
127
128         if (inet_aton(hostname, &addr->sin_addr))
129                 return 1;
130         if ((hp = gethostbyname(hostname)) == NULL) {
131                 nfs_error(_("%s: can't get address for %s\n"),
132                                 progname, hostname);
133                 return 0;
134         }
135         if (hp->h_length > sizeof(struct in_addr)) {
136                 nfs_error(_("%s: got bad hp->h_length"), progname);
137                 hp->h_length = sizeof(struct in_addr);
138         }
139         memcpy(&addr->sin_addr, hp->h_addr, hp->h_length);
140         return 1;
141 }
142
143 /*
144  * Walk through our mount options string, and indicate the presence
145  * of 'bg', 'retry=', 'addr=', and 'clientaddr='.
146  */
147 static void extract_interesting_options(char *opts)
148 {
149         char *opt, *opteq;
150         int val;
151
152         opts = xstrdup(opts);
153
154         for (opt = strtok(opts, ","); opt; opt = strtok(NULL, ",")) {
155                 if ((opteq = strchr(opt, '='))) {
156                         val = atoi(opteq + 1);
157                         *opteq = '\0';
158                         if (strcmp(opt, "bg") == 0)
159                                 bg_opt++;
160                         else if (strcmp(opt, "retry") == 0)
161                                 retry_opt = val;
162                         else if (strcmp(opt, "addr") == 0)
163                                 addr_opt++;
164                         else if (strcmp(opt, "clientaddr") == 0)
165                                 ca_opt++;
166                 } else {
167                         if (strcmp(opt, "bg") == 0)
168                                 bg_opt++;
169                 }
170         }
171
172         free(opts);
173 }
174
175 /*
176  * Append the 'addr=' option to the options string.  The server
177  * address is added to /etc/mtab for use when unmounting.
178  *
179  * Returns 1 if 'addr=' option created successfully;
180  * otherwise zero.
181  */
182 static int append_addr_opt(struct sockaddr_in *saddr, char **extra_opts)
183 {
184         static char new_opts[1024];
185         char *s, *old_opts;
186
187         s = inet_ntoa(saddr->sin_addr);
188         old_opts = *extra_opts;
189         if (!old_opts)
190                 old_opts = "";
191         if (strlen(old_opts) + strlen(s) + 10 >= sizeof(new_opts)) {
192                 nfs_error(_("%s: too many mount options\n"),
193                                 progname);
194                 return 0;
195         }
196         snprintf(new_opts, sizeof(new_opts), "%s%saddr=%s",
197                  old_opts, *old_opts ? "," : "", s);
198         *extra_opts = xstrdup(new_opts);
199
200         return 1;
201 }
202
203 /*
204  * Called if no 'clientaddr=' option was specified in the options string
205  * to discover our address and append an appropriate 'clientaddr=' option
206  * to the options string.
207  *
208  * Returns 1 if 'clientaddr=' option created successfully;
209  * otherwise zero.
210  */
211 static int append_clientaddr_opt(struct sockaddr_in *saddr, char **extra_opts)
212 {
213         static char new_opts[2048], cbuf[256];
214         struct sockaddr_in my_addr;
215
216         if (!get_client_address(saddr, &my_addr))
217                 return 0;
218
219         if (strlen(*extra_opts) + 30 >= sizeof(new_opts)) {
220                 nfs_error(_("%s: too many mount options"),
221                                 progname);
222                 return 0;
223         }
224
225         strcat(new_opts, *extra_opts);
226
227         snprintf(cbuf, sizeof(cbuf) - 1, "%sclientaddr=%s",
228                         *extra_opts ? "," : "", inet_ntoa(my_addr.sin_addr));
229
230         strcat(new_opts, cbuf);
231
232         *extra_opts = xstrdup(new_opts);
233
234         return 1;
235 }
236
237 /*
238  * nfsmount_s - Mount an NFSv2 or v3 file system using C string options
239  *
240  * @spec:       C string hostname:path specifying remoteshare to mount
241  * @node:       C string pathname of local mounted on directory
242  * @flags:      MS_ style flags
243  * @extra_opts: pointer to C string containing fs-specific mount options
244  *              (possibly also a return argument)
245  * @fake:       flag indicating whether to carry out the whole operation
246  * @bg:         one if this is a backgrounded mount attempt
247  *
248  * XXX: need to handle bg, fg, and retry options.
249  */
250 int nfsmount_s(const char *spec, const char *node, int flags,
251                 char **extra_opts, int fake, int bg)
252 {
253         struct sockaddr_in saddr;
254         char *hostname;
255         int err;
256
257         if (!parse_devname(spec, &hostname))
258                 return EX_FAIL;
259         err = fill_ipv4_sockaddr(hostname, &saddr);
260         free(hostname);
261         if (!err)
262                 return EX_FAIL;
263
264         extract_interesting_options(*extra_opts);
265
266         if (!bg && addr_opt) {
267                 nfs_error(_("%s: Illegal option: 'addr='"), progname);
268                 return EX_FAIL;
269         }
270
271         if (!append_addr_opt(&saddr, extra_opts))
272                 return EX_FAIL;
273
274         if (verbose)
275                 printf(_("%s: text-based options: '%s'\n"),
276                         progname, *extra_opts);
277
278         if (!fake) {
279                 if (mount(spec, node, "nfs",
280                                 flags & ~(MS_USER|MS_USERS), *extra_opts)) {
281                         mount_error(spec, node, errno);
282                         return EX_FAIL;
283                 }
284         }
285
286         return EX_SUCCESS;
287 }
288
289 /*
290  * nfs4mount_s - Mount an NFSv4 file system using C string options
291  *
292  * @spec:       C string hostname:path specifying remoteshare to mount
293  * @node:       C string pathname of local mounted on directory
294  * @flags:      MS_ style flags
295  * @extra_opts: pointer to C string containing fs-specific mount options
296  *              (possibly also a return argument)
297  * @fake:       flag indicating whether to carry out the whole operation
298  * @child:      one if this is a backgrounded mount
299  *
300  * XXX: need to handle bg, fg, and retry options.
301  *
302  */
303 int nfs4mount_s(const char *spec, const char *node, int flags,
304                 char **extra_opts, int fake, int child)
305 {
306         struct sockaddr_in saddr;
307         char *hostname;
308         int err;
309
310         if (!parse_devname(spec, &hostname))
311                 return EX_FAIL;
312         err = fill_ipv4_sockaddr(hostname, &saddr);
313         free(hostname);
314         if (!err)
315                 return EX_FAIL;
316
317         extract_interesting_options(*extra_opts);
318
319         if (addr_opt) {
320                 nfs_error(_("%s: Illegal option: 'addr='"), progname);
321                 return EX_FAIL;
322         }
323
324         if (!append_addr_opt(&saddr, extra_opts))
325                 return EX_FAIL;
326
327         if (!ca_opt && !append_clientaddr_opt(&saddr, extra_opts))
328                 return EX_FAIL;
329
330         if (verbose)
331                 printf(_("%s: text-based options: '%s'\n"),
332                         progname, *extra_opts);
333
334         if (!fake) {
335                 if (mount(spec, node, "nfs4",
336                                 flags & ~(MS_USER|MS_USERS), *extra_opts)) {
337                         mount_error(spec, node, errno);
338                         return EX_FAIL;
339                 }
340         }
341
342         return EX_SUCCESS;
343 }