f81db14e4d43e53ddebb7af98d73be4048ac7956
[nfs-utils.git] / utils / mount / nfsumount.c
1 /*
2  * nfsumount.c -- Linux NFS umount
3  * Copyright (C) 2006 Amit Gud <agud@redhat.com>
4  *
5  * - Basic code and wrapper around NFS umount code originally
6  *   in util-linux/mount/nfsmount.c
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2, or (at your option)
11  * any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  */
19
20 #include <unistd.h>
21 #include <stdio.h>
22 #include <errno.h>
23 #include <getopt.h>
24 #include <mntent.h>
25 #include <sys/mount.h>
26 #include <ctype.h>
27 #include <pwd.h>
28
29 #include "xcommon.h"
30 #include "fstab.h"
31 #include "nls.h"
32
33 #include "mount_constants.h"
34 #include "mount.h"
35 #include "error.h"
36 #include "network.h"
37 #include "parse_opt.h"
38 #include "parse_dev.h"
39
40 #if !defined(MNT_FORCE)
41 /* dare not try to include <linux/mount.h> -- lots of errors */
42 #define MNT_FORCE 1
43 #endif
44
45 #if !defined(MNT_DETACH)
46 #define MNT_DETACH 2
47 #endif
48
49 extern char *progname;
50 extern int nomtab;
51 extern int verbose;
52 int force;
53 int lazy;
54 int remount;
55
56
57 static int try_remount(const char *spec, const char *node)
58 {
59         int res;
60
61         res = mount(spec, node, NULL,
62                     MS_MGC_VAL | MS_REMOUNT | MS_RDONLY, NULL);
63         if (res == 0) {
64                 struct mntent remnt;
65                 nfs_error(_("%s: %s busy - remounted read-only"),
66                                 progname, spec);
67                 remnt.mnt_type = remnt.mnt_fsname = NULL;
68                 remnt.mnt_dir = xstrdup(node);
69                 remnt.mnt_opts = xstrdup("ro");
70                 if (!nomtab)
71                         update_mtab(node, &remnt);
72         } else if (errno != EBUSY) {    /* hmm ... */
73                 perror(_("remount"));
74                 nfs_error(_("%s: could not remount %s read-only"),
75                                 progname, spec);
76         }
77         return res;
78 }
79
80 static int del_mtab(const char *spec, const char *node)
81 {
82         int umnt_err, res;
83
84         umnt_err = 0;
85         if (lazy) {
86                 res = umount2 (node, MNT_DETACH);
87                 if (res < 0)
88                         umnt_err = errno;
89                 goto writemtab;
90         }
91
92         if (force) {
93                 res = umount2 (node, MNT_FORCE);
94                 if (res == -1) {
95                         int errsv = errno;
96                         perror(_("umount2"));
97                         errno = errsv;
98                         if (errno == ENOSYS) {
99                                 if (verbose)
100                                         printf(_("no umount2, trying umount...\n"));
101                                 res = umount (node);
102                         }
103                 }
104         } else
105                 res = umount (node);
106
107         if (res < 0) {
108                 if (remount && errno == EBUSY && spec) {
109                         res = try_remount(spec, node);
110                         if (res)
111                                 goto writemtab;
112                         return 0;
113                 } else
114                         umnt_err = errno;
115         }
116
117         if (res >= 0) {
118                 /* Umount succeeded */
119                 if (verbose)
120                         printf(_("%s umounted\n"), spec ? spec : node);
121         }
122
123  writemtab:
124         if (!nomtab &&
125             (umnt_err == 0 || umnt_err == EINVAL || umnt_err == ENOENT)) {
126                 update_mtab(node, NULL);
127         }
128
129         if (res >= 0)
130                 return 0;
131
132         if (umnt_err)
133                 umount_error(umnt_err, node);
134         return EX_FILEIO;
135 }
136
137 /*
138  * Discover mount server's hostname/address by examining mount options
139  *
140  * Returns a pointer to a string that the caller must free, on
141  * success; otherwise NULL is returned.
142  */
143 static char *nfs_umount_hostname(struct mount_options *options,
144                                  char *hostname)
145 {
146         char *option;
147
148         option = po_get(options, "mountaddr");
149         if (option)
150                 goto out;
151         option = po_get(options, "mounthost");
152         if (option)
153                 goto out;
154         option = po_get(options, "addr");
155         if (option)
156                 goto out;
157
158         return hostname;
159
160 out:
161         free(hostname);
162         return strdup(option);
163 }
164
165 /*
166  * Returns EX_SUCCESS if mount options and device name have been
167  * parsed successfully; otherwise EX_FAIL.
168  */
169 static int nfs_umount_do_umnt(struct mount_options *options,
170                               char **hostname, char **dirname)
171 {
172         struct sockaddr_storage address;
173         struct sockaddr *sap = (struct sockaddr *)&address;
174         socklen_t salen = sizeof(address);
175         struct pmap nfs_pmap, mnt_pmap;
176
177         if (!nfs_options2pmap(options, &nfs_pmap, &mnt_pmap)) {
178                 nfs_error(_("%s: bad mount options"), progname);
179                 return EX_FAIL;
180         }
181
182         *hostname = nfs_umount_hostname(options, *hostname);
183         if (!*hostname) {
184                 nfs_error(_("%s: out of memory"), progname);
185                 return EX_FAIL;
186         }
187
188         if (nfs_name_to_address(*hostname, sap, &salen) == 0)
189                 /* nfs_name_to_address reports any errors */
190                 return EX_FAIL;
191
192         if (nfs_advise_umount(sap, salen, &mnt_pmap, dirname) == 0)
193                 /* nfs_advise_umount reports any errors */
194                 return EX_FAIL;
195
196         return EX_SUCCESS;
197 }
198
199 /*
200  * Pick up certain mount options used during the original mount
201  * from /etc/mtab.  The basics include the server's IP address and
202  * the server pathname of the share to unregister.
203  *
204  * These options might also describe the mount port, mount protocol
205  * version, and transport protocol used to punch through a firewall.
206  * We will need this information to get through the firewall again
207  * to do the umount.
208  *
209  * Note that option parsing failures won't necessarily cause the
210  * umount request to fail.  Those values will be left zero in the
211  * pmap tuple.  If the GETPORT call later fails to disambiguate them,
212  * then we fail.
213  */
214 static int nfs_umount23(const char *devname, char *string)
215 {
216         char *hostname, *dirname;
217         struct mount_options *options;
218         int result = EX_FAIL;
219
220         if (!nfs_parse_devname(devname, &hostname, &dirname))
221                 return EX_USAGE;
222
223         options = po_split(string);
224         if (options) {
225                 result = nfs_umount_do_umnt(options, &hostname, &dirname);
226                 po_destroy(options);
227         } else
228                 nfs_error(_("%s: option parsing error"), progname);
229
230         free(hostname);
231         free(dirname);
232         return result;
233 }
234
235 static struct option umount_longopts[] =
236 {
237   { "force", 0, 0, 'f' },
238   { "help", 0, 0, 'h' },
239   { "no-mtab", 0, 0, 'n' },
240   { "verbose", 0, 0, 'v' },
241   { "read-only", 0, 0, 'r' },
242   { NULL, 0, 0, 0 }
243 };
244
245 static void umount_usage(void)
246 {
247         printf(_("usage: %s dir [-fvnrlh]\n"), progname);
248         printf(_("options:\n\t-f\t\tforce unmount\n"));
249         printf(_("\t-v\tverbose\n"));
250         printf(_("\t-n\tDo not update /etc/mtab\n"));
251         printf(_("\t-r\tremount\n"));
252         printf(_("\t-l\tlazy unmount\n"));
253         printf(_("\t-h\tprint this help\n\n"));
254 }
255
256 int nfsumount(int argc, char *argv[])
257 {
258         int c, ret;
259         char *spec;
260         struct mntentchn *mc;
261
262         if (argc < 2) {
263                 umount_usage();
264                 return EX_USAGE;
265         }
266
267         spec = argv[1];
268
269         argv += 1;
270         argc -= 1;
271
272         argv[0] = argv[-1]; /* So that getopt error messages are correct */
273         while ((c = getopt_long (argc, argv, "fvnrlh",
274                                 umount_longopts, NULL)) != -1) {
275
276                 switch (c) {
277                 case 'f':
278                         ++force;
279                         break;
280                 case 'v':
281                         ++verbose;
282                         break;
283                 case 'n':
284                         ++nomtab;
285                         break;
286                 case 'r':
287                         ++remount;
288                         break;
289                 case 'l':
290                         ++lazy;
291                         break;
292                 case 'h':
293                 default:
294                         umount_usage();
295                         return EX_USAGE;
296                 }
297         }
298         if (optind != argc) {
299                 umount_usage();
300                 return EX_USAGE;
301         }
302         
303         if (spec == NULL || (*spec != '/' && strchr(spec,':') == NULL)) {
304                 nfs_error(_("%s: %s: not found\n"), progname, spec);
305                 return EX_USAGE;
306         }
307
308         if (*spec == '/')
309                 mc = getmntdirbackward(spec, NULL);
310         else
311                 mc = getmntdevbackward(spec, NULL);
312         if (!mc && verbose)
313                 printf(_("Could not find %s in mtab\n"), spec);
314
315         if (mc && strcmp(mc->m.mnt_type, "nfs") != 0 &&
316             strcmp(mc->m.mnt_type, "nfs4") != 0) {
317                 nfs_error(_("%s: %s on %s is not an NFS filesystem"),
318                                 progname, mc->m.mnt_fsname, mc->m.mnt_dir);
319                 return EX_USAGE;
320         }
321
322         if (getuid() != 0) {
323                 /* only permitted if "user=" or "users" is in mount options */
324                 if (!mc) {
325                         /* umount might call us twice.  The second time there will
326                          * be no entry in mtab and we should just exit quietly
327                          */
328                         return EX_SUCCESS;
329
330                 only_root:
331                         nfs_error(_("%s: You are not permitted to unmount %s"),
332                                         progname, spec);
333                         return EX_USAGE;
334                 }
335                 if (hasmntopt(&mc->m, "users") == NULL) {
336                         char *opt = hasmntopt(&mc->m, "user");
337                         struct passwd *pw;
338                         char *comma;
339                         size_t len;
340                         if (!opt)
341                                 goto only_root;
342                         if (opt[4] != '=')
343                                 goto only_root;
344                         comma = strchr(opt, ',');
345                         if (comma)
346                                 len = comma - (opt + 5);
347                         else
348                                 len = strlen(opt+5);
349                         pw = getpwuid(getuid());
350                         if (pw == NULL || strlen(pw->pw_name) != len
351                             || strncmp(pw->pw_name, opt+5, len) != 0)
352                                 goto only_root;
353                 }
354         }
355
356         ret = 0;
357         if (mc) {
358                 if (!lazy && strcmp(mc->m.mnt_type, "nfs4") != 0)
359                         /* We ignore the error from nfs_umount23.
360                          * If the actual umount succeeds (in del_mtab),
361                          * we don't want to signal an error, as that
362                          * could cause /sbin/mount to retry!
363                          */
364                         nfs_umount23(mc->m.mnt_fsname, mc->m.mnt_opts);
365                 ret = del_mtab(mc->m.mnt_fsname, mc->m.mnt_dir) ?: ret;
366         } else if (*spec != '/') {
367                 if (!lazy)
368                         ret = nfs_umount23(spec, "tcp,v3");
369         } else
370                 ret = del_mtab(NULL, spec);
371
372         return ret;
373 }