Print mount/umount errors
[zfs.git] / lib / libzfs / libzfs_mount.c
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21
22 /*
23  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
24  */
25
26 /*
27  * Routines to manage ZFS mounts.  We separate all the nasty routines that have
28  * to deal with the OS.  The following functions are the main entry points --
29  * they are used by mount and unmount and when changing a filesystem's
30  * mountpoint.
31  *
32  *      zfs_is_mounted()
33  *      zfs_mount()
34  *      zfs_unmount()
35  *      zfs_unmountall()
36  *
37  * This file also contains the functions used to manage sharing filesystems via
38  * NFS and iSCSI:
39  *
40  *      zfs_is_shared()
41  *      zfs_share()
42  *      zfs_unshare()
43  *
44  *      zfs_is_shared_nfs()
45  *      zfs_is_shared_smb()
46  *      zfs_share_proto()
47  *      zfs_shareall();
48  *      zfs_unshare_nfs()
49  *      zfs_unshare_smb()
50  *      zfs_unshareall_nfs()
51  *      zfs_unshareall_smb()
52  *      zfs_unshareall()
53  *      zfs_unshareall_bypath()
54  *
55  * The following functions are available for pool consumers, and will
56  * mount/unmount and share/unshare all datasets within pool:
57  *
58  *      zpool_enable_datasets()
59  *      zpool_disable_datasets()
60  */
61
62 #include <dirent.h>
63 #include <dlfcn.h>
64 #include <errno.h>
65 #include <libgen.h>
66 #include <libintl.h>
67 #include <stdio.h>
68 #include <stdlib.h>
69 #include <strings.h>
70 #include <unistd.h>
71 #include <zone.h>
72 #include <sys/mntent.h>
73 #include <sys/mount.h>
74 #include <sys/stat.h>
75
76 #include <libzfs.h>
77
78 #include "libzfs_impl.h"
79
80 #include <libshare.h>
81 #include <sys/systeminfo.h>
82 #define MAXISALEN       257     /* based on sysinfo(2) man page */
83
84 static int zfs_share_proto(zfs_handle_t *, zfs_share_proto_t *);
85 zfs_share_type_t zfs_is_shared_proto(zfs_handle_t *, char **,
86     zfs_share_proto_t);
87
88 /*
89  * The share protocols table must be in the same order as the zfs_share_prot_t
90  * enum in libzfs_impl.h
91  */
92 typedef struct {
93         zfs_prop_t p_prop;
94         char *p_name;
95         int p_share_err;
96         int p_unshare_err;
97 } proto_table_t;
98
99 proto_table_t proto_table[PROTO_END] = {
100         {ZFS_PROP_SHARENFS, "nfs", EZFS_SHARENFSFAILED, EZFS_UNSHARENFSFAILED},
101         {ZFS_PROP_SHARESMB, "smb", EZFS_SHARESMBFAILED, EZFS_UNSHARESMBFAILED},
102 };
103
104 zfs_share_proto_t nfs_only[] = {
105         PROTO_NFS,
106         PROTO_END
107 };
108
109 zfs_share_proto_t smb_only[] = {
110         PROTO_SMB,
111         PROTO_END
112 };
113 zfs_share_proto_t share_all_proto[] = {
114         PROTO_NFS,
115         PROTO_SMB,
116         PROTO_END
117 };
118
119 /*
120  * Search for NFS and SMB exports for the given mountpoint and protocol, returning
121  * a zfs_share_type_t value.
122  */
123 static zfs_share_type_t
124 is_shared(libzfs_handle_t *hdl, const char *mountpoint, zfs_share_proto_t proto)
125 {
126         char buf[MAXPATHLEN], *tab;
127
128         if (hdl->libzfs_sharetab == NULL)
129                 return (SHARED_NOT_SHARED);
130
131         (void) fseek(hdl->libzfs_sharetab, 0, SEEK_SET);
132
133         /* Search /etc/exports for NFS exports */
134         /* FIXME: Assumes the file is tab delimited. */
135         while (fgets(buf, sizeof (buf), hdl->libzfs_sharetab) != NULL) {
136
137                 /* the mountpoint is the first entry on each line */
138                 if ((tab = strchr(buf, '\t')) == NULL)
139                         continue;
140
141                 *tab = '\0';
142                 if (strcmp(buf, mountpoint) == 0) {
143                         if (proto == PROTO_NFS)
144                                 return (SHARED_NFS);
145                         else
146                                 return (SHARED_NOT_SHARED);
147                 }
148         }
149
150         /* XXX: Search /etc/samba/smb.conf for SMB exports, return SHARED_SMB */
151
152         return (SHARED_NOT_SHARED);
153 }
154
155 /*
156  * Returns true if the specified directory is empty.  If we can't open the
157  * directory at all, return true so that the mount can fail with a more
158  * informative error message.
159  */
160 static boolean_t
161 dir_is_empty(const char *dirname)
162 {
163         DIR *dirp;
164         struct dirent64 *dp;
165
166         if ((dirp = opendir(dirname)) == NULL)
167                 return (B_TRUE);
168
169         while ((dp = readdir64(dirp)) != NULL) {
170
171                 if (strcmp(dp->d_name, ".") == 0 ||
172                     strcmp(dp->d_name, "..") == 0)
173                         continue;
174
175                 (void) closedir(dirp);
176                 return (B_FALSE);
177         }
178
179         (void) closedir(dirp);
180         return (B_TRUE);
181 }
182
183 /*
184  * Checks to see if the mount is active.  If the filesystem is mounted, we fill
185  * in 'where' with the current mountpoint, and return 1.  Otherwise, we return
186  * 0.
187  */
188 boolean_t
189 is_mounted(libzfs_handle_t *zfs_hdl, const char *special, char **where)
190 {
191         struct mnttab entry;
192
193         if (libzfs_mnttab_find(zfs_hdl, special, &entry) != 0)
194                 return (B_FALSE);
195
196         if (where != NULL)
197                 *where = zfs_strdup(zfs_hdl, entry.mnt_mountp);
198
199         return (B_TRUE);
200 }
201
202 boolean_t
203 zfs_is_mounted(zfs_handle_t *zhp, char **where)
204 {
205         return (is_mounted(zhp->zfs_hdl, zfs_get_name(zhp), where));
206 }
207
208 /*
209  * Returns true if the given dataset is mountable, false otherwise.  Returns the
210  * mountpoint in 'buf'.
211  */
212 static boolean_t
213 zfs_is_mountable(zfs_handle_t *zhp, char *buf, size_t buflen,
214     zprop_source_t *source)
215 {
216         char sourceloc[ZFS_MAXNAMELEN];
217         zprop_source_t sourcetype;
218
219         if (!zfs_prop_valid_for_type(ZFS_PROP_MOUNTPOINT, zhp->zfs_type))
220                 return (B_FALSE);
221
222         verify(zfs_prop_get(zhp, ZFS_PROP_MOUNTPOINT, buf, buflen,
223             &sourcetype, sourceloc, sizeof (sourceloc), B_FALSE) == 0);
224
225         if (strcmp(buf, ZFS_MOUNTPOINT_NONE) == 0 ||
226             strcmp(buf, ZFS_MOUNTPOINT_LEGACY) == 0)
227                 return (B_FALSE);
228
229         if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_OFF)
230                 return (B_FALSE);
231
232         if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED) &&
233             getzoneid() == GLOBAL_ZONEID)
234                 return (B_FALSE);
235
236         if (source)
237                 *source = sourcetype;
238
239         return (B_TRUE);
240 }
241
242 /*
243  * The filesystem is mounted by invoking the system mount utility rather
244  * than by the system call mount(2).  This ensures that the /etc/mtab
245  * file is correctly locked for the update.  Performing our own locking
246  * and /etc/mtab update requires making an unsafe assumption about how
247  * the mount utility performs its locking.  Unfortunately, this also means
248  * in the case of a mount failure we do not have the exact errno.  We must
249  * make due with return value from the mount process.
250  *
251  * In the long term a shared library called libmount is under development
252  * which provides a common API to address the locking and errno issues.
253  * Once the standard mount utility has been updated to use this library
254  * we can add an autoconf check to conditionally use it.
255  *
256  * http://www.kernel.org/pub/linux/utils/util-linux/libmount-docs/index.html
257  */
258
259 static int
260 do_mount(const char *src, const char *mntpt, char *opts)
261 {
262         char *argv[8] = {
263             "/bin/mount",
264             "-t", MNTTYPE_ZFS,
265             "-o", opts,
266             (char *)src,
267             (char *)mntpt,
268             (char *)NULL };
269         int rc;
270
271         /* Return only the most critical mount error */
272         rc = libzfs_run_process(argv[0], argv, STDOUT_VERBOSE|STDERR_VERBOSE);
273         if (rc) {
274                 if (rc & MOUNT_FILEIO)
275                         return EIO;
276                 if (rc & MOUNT_USER)
277                         return EINTR;
278                 if (rc & MOUNT_SOFTWARE)
279                         return EPIPE;
280                 if (rc & MOUNT_SYSERR)
281                         return EAGAIN;
282                 if (rc & MOUNT_USAGE)
283                         return EINVAL;
284
285                 return ENXIO; /* Generic error */
286         }
287
288         return 0;
289 }
290
291 static int
292 do_unmount(const char *mntpt, int flags)
293 {
294         char force_opt[] = "-f";
295         char lazy_opt[] = "-l";
296         char *argv[7] = {
297             "/bin/umount",
298             "-t", MNTTYPE_ZFS,
299             NULL, NULL, NULL, NULL };
300         int rc, count = 3;
301
302         if (flags & MS_FORCE) {
303                 argv[count] = force_opt;
304                 count++;
305         }
306
307         if (flags & MS_DETACH) {
308                 argv[count] = lazy_opt;
309                 count++;
310         }
311
312         argv[count] = (char *)mntpt;
313         rc = libzfs_run_process(argv[0], argv, STDOUT_VERBOSE|STDERR_VERBOSE);
314
315         return (rc ? EINVAL : 0);
316 }
317
318 /*
319  * Mount the given filesystem.
320  */
321 int
322 zfs_mount(zfs_handle_t *zhp, const char *options, int flags)
323 {
324         struct stat buf;
325         char mountpoint[ZFS_MAXPROPLEN];
326         char mntopts[MNT_LINE_MAX];
327         libzfs_handle_t *hdl = zhp->zfs_hdl;
328         int rc;
329
330         if (options == NULL)
331                 (void) strlcpy(mntopts, MNTOPT_DEFAULTS, sizeof (mntopts));
332         else
333                 (void) strlcpy(mntopts, options, sizeof (mntopts));
334
335         /*
336          * If the pool is imported read-only then all mounts must be read-only
337          */
338         if (zpool_get_prop_int(zhp->zpool_hdl, ZPOOL_PROP_READONLY, NULL))
339                 (void) strlcat(mntopts, "," MNTOPT_RO, sizeof (mntopts));
340
341         /*
342          * Append zfsutil option so the mount helper allow the mount
343          */
344         strlcat(mntopts, "," MNTOPT_ZFSUTIL, sizeof (mntopts));
345
346         if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
347                 return (0);
348
349         /* Create the directory if it doesn't already exist */
350         if (lstat(mountpoint, &buf) != 0) {
351                 if (mkdirp(mountpoint, 0755) != 0) {
352                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
353                             "failed to create mountpoint"));
354                         return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
355                             dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
356                             mountpoint));
357                 }
358         }
359
360         /*
361          * Determine if the mountpoint is empty.  If so, refuse to perform the
362          * mount.  We don't perform this check if 'remount' is specified.
363          */
364         if (strstr(mntopts, MNTOPT_REMOUNT) == NULL &&
365             !dir_is_empty(mountpoint)) {
366                 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
367                     "directory is not empty"));
368                 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
369                     dgettext(TEXT_DOMAIN, "cannot mount '%s'"), mountpoint));
370         }
371
372         /* perform the mount */
373         rc = do_mount(zfs_get_name(zhp), mountpoint, mntopts);
374         if (rc) {
375                 /*
376                  * Generic errors are nasty, but there are just way too many
377                  * from mount(), and they're well-understood.  We pick a few
378                  * common ones to improve upon.
379                  */
380                 if (rc == EBUSY) {
381                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
382                             "mountpoint or dataset is busy"));
383                 } else if (rc == EPERM) {
384                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
385                             "Insufficient privileges"));
386                 } else if (rc == ENOTSUP) {
387                         char buf[256];
388                         int spa_version;
389
390                         VERIFY(zfs_spa_version(zhp, &spa_version) == 0);
391                         (void) snprintf(buf, sizeof (buf),
392                             dgettext(TEXT_DOMAIN, "Can't mount a version %lld "
393                             "file system on a version %d pool. Pool must be"
394                             " upgraded to mount this file system."),
395                             (u_longlong_t)zfs_prop_get_int(zhp,
396                             ZFS_PROP_VERSION), spa_version);
397                         zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, buf));
398                 } else {
399                         zfs_error_aux(hdl, strerror(rc));
400                 }
401                 return (zfs_error_fmt(hdl, EZFS_MOUNTFAILED,
402                     dgettext(TEXT_DOMAIN, "cannot mount '%s'"),
403                     zhp->zfs_name));
404         }
405
406         /* add the mounted entry into our cache */
407         libzfs_mnttab_add(hdl, zfs_get_name(zhp), mountpoint, mntopts);
408         return (0);
409 }
410
411 /*
412  * Unmount a single filesystem.
413  */
414 static int
415 unmount_one(libzfs_handle_t *hdl, const char *mountpoint, int flags)
416 {
417         int error;
418
419         error = do_unmount(mountpoint, flags);
420         if (error != 0) {
421                 return (zfs_error_fmt(hdl, EZFS_UMOUNTFAILED,
422                     dgettext(TEXT_DOMAIN, "cannot unmount '%s'"),
423                     mountpoint));
424         }
425
426         return (0);
427 }
428
429 /*
430  * Unmount the given filesystem.
431  */
432 int
433 zfs_unmount(zfs_handle_t *zhp, const char *mountpoint, int flags)
434 {
435         libzfs_handle_t *hdl = zhp->zfs_hdl;
436         struct mnttab entry;
437         char *mntpt = NULL;
438
439         /* check to see if we need to unmount the filesystem */
440         if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
441             libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0)) {
442                 /*
443                  * mountpoint may have come from a call to
444                  * getmnt/getmntany if it isn't NULL. If it is NULL,
445                  * we know it comes from libzfs_mnttab_find which can
446                  * then get freed later. We strdup it to play it safe.
447                  */
448                 if (mountpoint == NULL)
449                         mntpt = zfs_strdup(hdl, entry.mnt_mountp);
450                 else
451                         mntpt = zfs_strdup(hdl, mountpoint);
452
453                 /*
454                  * Unshare and unmount the filesystem
455                  */
456                 if (zfs_unshare_proto(zhp, mntpt, share_all_proto) != 0)
457                         return (-1);
458
459                 if (unmount_one(hdl, mntpt, flags) != 0) {
460                         free(mntpt);
461                         (void) zfs_shareall(zhp);
462                         return (-1);
463                 }
464                 libzfs_mnttab_remove(hdl, zhp->zfs_name);
465                 free(mntpt);
466         }
467
468         return (0);
469 }
470
471 /*
472  * Unmount this filesystem and any children inheriting the mountpoint property.
473  * To do this, just act like we're changing the mountpoint property, but don't
474  * remount the filesystems afterwards.
475  */
476 int
477 zfs_unmountall(zfs_handle_t *zhp, int flags)
478 {
479         prop_changelist_t *clp;
480         int ret;
481
482         clp = changelist_gather(zhp, ZFS_PROP_MOUNTPOINT, 0, flags);
483         if (clp == NULL)
484                 return (-1);
485
486         ret = changelist_prefix(clp);
487         changelist_free(clp);
488
489         return (ret);
490 }
491
492 boolean_t
493 zfs_is_shared(zfs_handle_t *zhp)
494 {
495         zfs_share_type_t rc = 0;
496         zfs_share_proto_t *curr_proto;
497
498         if (ZFS_IS_VOLUME(zhp))
499                 return (B_FALSE);
500
501         for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
502             curr_proto++)
503                 rc |= zfs_is_shared_proto(zhp, NULL, *curr_proto);
504
505         return (rc ? B_TRUE : B_FALSE);
506 }
507
508 int
509 zfs_share(zfs_handle_t *zhp)
510 {
511         assert(!ZFS_IS_VOLUME(zhp));
512         return (zfs_share_proto(zhp, share_all_proto));
513 }
514
515 int
516 zfs_unshare(zfs_handle_t *zhp)
517 {
518         assert(!ZFS_IS_VOLUME(zhp));
519         return (zfs_unshareall(zhp));
520 }
521
522 /*
523  * Check to see if the filesystem is currently shared.
524  */
525 zfs_share_type_t
526 zfs_is_shared_proto(zfs_handle_t *zhp, char **where, zfs_share_proto_t proto)
527 {
528         char *mountpoint;
529         zfs_share_type_t rc;
530
531         if (!zfs_is_mounted(zhp, &mountpoint))
532                 return (SHARED_NOT_SHARED);
533
534         if ((rc = is_shared(zhp->zfs_hdl, mountpoint, proto))) {
535                 if (where != NULL)
536                         *where = mountpoint;
537                 else
538                         free(mountpoint);
539                 return (rc);
540         } else {
541                 free(mountpoint);
542                 return (SHARED_NOT_SHARED);
543         }
544 }
545
546 boolean_t
547 zfs_is_shared_nfs(zfs_handle_t *zhp, char **where)
548 {
549         return (zfs_is_shared_proto(zhp, where,
550             PROTO_NFS) != SHARED_NOT_SHARED);
551 }
552
553 boolean_t
554 zfs_is_shared_smb(zfs_handle_t *zhp, char **where)
555 {
556         return (zfs_is_shared_proto(zhp, where,
557             PROTO_SMB) != SHARED_NOT_SHARED);
558 }
559
560 /*
561  * Make sure things will work if libshare isn't installed by using
562  * wrapper functions that check to see that the pointers to functions
563  * initialized in _zfs_init_libshare() are actually present.
564  */
565
566 static sa_handle_t (*_sa_init)(int);
567 static void (*_sa_fini)(sa_handle_t);
568 static sa_share_t (*_sa_find_share)(sa_handle_t, char *);
569 static int (*_sa_enable_share)(sa_share_t, char *);
570 static int (*_sa_disable_share)(sa_share_t, char *);
571 static char *(*_sa_errorstr)(int);
572 static int (*_sa_parse_legacy_options)(sa_group_t, char *, char *);
573 static boolean_t (*_sa_needs_refresh)(sa_handle_t *);
574 static libzfs_handle_t *(*_sa_get_zfs_handle)(sa_handle_t);
575 static int (*_sa_zfs_process_share)(sa_handle_t, sa_group_t, sa_share_t,
576     char *, char *, zprop_source_t, char *, char *, char *);
577 static void (*_sa_update_sharetab_ts)(sa_handle_t);
578
579 /*
580  * _zfs_init_libshare()
581  *
582  * Find the libshare.so.1 entry points that we use here and save the
583  * values to be used later. This is triggered by the runtime loader.
584  * Make sure the correct ISA version is loaded.
585  */
586 #ifdef __GNUC__
587 static void
588 _zfs_init_libshare(void) __attribute__((constructor));
589 #else
590 #pragma init(_zfs_init_libshare)
591 #endif
592 static void
593 _zfs_init_libshare(void)
594 {
595         void *libshare;
596         char path[MAXPATHLEN];
597         char isa[MAXISALEN];
598
599 #if defined(_LP64)
600         if (sysinfo(SI_ARCHITECTURE_64, isa, MAXISALEN) == -1)
601                 isa[0] = '\0';
602 #else
603         isa[0] = '\0';
604 #endif
605         (void) snprintf(path, MAXPATHLEN,
606             "/usr/lib/%s/libshare.so.1", isa);
607
608         if ((libshare = dlopen(path, RTLD_LAZY | RTLD_GLOBAL)) != NULL) {
609                 _sa_init = (sa_handle_t (*)(int))dlsym(libshare, "sa_init");
610                 _sa_fini = (void (*)(sa_handle_t))dlsym(libshare, "sa_fini");
611                 _sa_find_share = (sa_share_t (*)(sa_handle_t, char *))
612                     dlsym(libshare, "sa_find_share");
613                 _sa_enable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
614                     "sa_enable_share");
615                 _sa_disable_share = (int (*)(sa_share_t, char *))dlsym(libshare,
616                     "sa_disable_share");
617                 _sa_errorstr = (char *(*)(int))dlsym(libshare, "sa_errorstr");
618                 _sa_parse_legacy_options = (int (*)(sa_group_t, char *, char *))
619                     dlsym(libshare, "sa_parse_legacy_options");
620                 _sa_needs_refresh = (boolean_t (*)(sa_handle_t *))
621                     dlsym(libshare, "sa_needs_refresh");
622                 _sa_get_zfs_handle = (libzfs_handle_t *(*)(sa_handle_t))
623                     dlsym(libshare, "sa_get_zfs_handle");
624                 _sa_zfs_process_share = (int (*)(sa_handle_t, sa_group_t,
625                     sa_share_t, char *, char *, zprop_source_t, char *,
626                     char *, char *))dlsym(libshare, "sa_zfs_process_share");
627                 _sa_update_sharetab_ts = (void (*)(sa_handle_t))
628                     dlsym(libshare, "sa_update_sharetab_ts");
629                 if (_sa_init == NULL || _sa_fini == NULL ||
630                     _sa_find_share == NULL || _sa_enable_share == NULL ||
631                     _sa_disable_share == NULL || _sa_errorstr == NULL ||
632                     _sa_parse_legacy_options == NULL ||
633                     _sa_needs_refresh == NULL || _sa_get_zfs_handle == NULL ||
634                     _sa_zfs_process_share == NULL ||
635                     _sa_update_sharetab_ts == NULL) {
636                         _sa_init = NULL;
637                         _sa_fini = NULL;
638                         _sa_disable_share = NULL;
639                         _sa_enable_share = NULL;
640                         _sa_errorstr = NULL;
641                         _sa_parse_legacy_options = NULL;
642                         (void) dlclose(libshare);
643                         _sa_needs_refresh = NULL;
644                         _sa_get_zfs_handle = NULL;
645                         _sa_zfs_process_share = NULL;
646                         _sa_update_sharetab_ts = NULL;
647                 }
648         }
649 }
650
651 /*
652  * zfs_init_libshare(zhandle, service)
653  *
654  * Initialize the libshare API if it hasn't already been initialized.
655  * In all cases it returns 0 if it succeeded and an error if not. The
656  * service value is which part(s) of the API to initialize and is a
657  * direct map to the libshare sa_init(service) interface.
658  */
659 int
660 zfs_init_libshare(libzfs_handle_t *zhandle, int service)
661 {
662         int ret = SA_OK;
663
664         if (_sa_init == NULL)
665                 ret = SA_CONFIG_ERR;
666
667         if (ret == SA_OK && zhandle->libzfs_shareflags & ZFSSHARE_MISS) {
668                 /*
669                  * We had a cache miss. Most likely it is a new ZFS
670                  * dataset that was just created. We want to make sure
671                  * so check timestamps to see if a different process
672                  * has updated any of the configuration. If there was
673                  * some non-ZFS change, we need to re-initialize the
674                  * internal cache.
675                  */
676                 zhandle->libzfs_shareflags &= ~ZFSSHARE_MISS;
677                 if (_sa_needs_refresh != NULL &&
678                     _sa_needs_refresh(zhandle->libzfs_sharehdl)) {
679                         zfs_uninit_libshare(zhandle);
680                         zhandle->libzfs_sharehdl = _sa_init(service);
681                 }
682         }
683
684         if (ret == SA_OK && zhandle && zhandle->libzfs_sharehdl == NULL)
685                 zhandle->libzfs_sharehdl = _sa_init(service);
686
687         if (ret == SA_OK && zhandle->libzfs_sharehdl == NULL)
688                 ret = SA_NO_MEMORY;
689
690         return (ret);
691 }
692
693 /*
694  * zfs_uninit_libshare(zhandle)
695  *
696  * Uninitialize the libshare API if it hasn't already been
697  * uninitialized. It is OK to call multiple times.
698  */
699 void
700 zfs_uninit_libshare(libzfs_handle_t *zhandle)
701 {
702         if (zhandle != NULL && zhandle->libzfs_sharehdl != NULL) {
703                 if (_sa_fini != NULL)
704                         _sa_fini(zhandle->libzfs_sharehdl);
705                 zhandle->libzfs_sharehdl = NULL;
706         }
707 }
708
709 /*
710  * zfs_parse_options(options, proto)
711  *
712  * Call the legacy parse interface to get the protocol specific
713  * options using the NULL arg to indicate that this is a "parse" only.
714  */
715 int
716 zfs_parse_options(char *options, zfs_share_proto_t proto)
717 {
718         if (_sa_parse_legacy_options != NULL) {
719                 return (_sa_parse_legacy_options(NULL, options,
720                     proto_table[proto].p_name));
721         }
722         return (SA_CONFIG_ERR);
723 }
724
725 /*
726  * zfs_sa_find_share(handle, path)
727  *
728  * wrapper around sa_find_share to find a share path in the
729  * configuration.
730  */
731 static sa_share_t
732 zfs_sa_find_share(sa_handle_t handle, char *path)
733 {
734         if (_sa_find_share != NULL)
735                 return (_sa_find_share(handle, path));
736         return (NULL);
737 }
738
739 /*
740  * zfs_sa_enable_share(share, proto)
741  *
742  * Wrapper for sa_enable_share which enables a share for a specified
743  * protocol.
744  */
745 static int
746 zfs_sa_enable_share(sa_share_t share, char *proto)
747 {
748         if (_sa_enable_share != NULL)
749                 return (_sa_enable_share(share, proto));
750         return (SA_CONFIG_ERR);
751 }
752
753 /*
754  * zfs_sa_disable_share(share, proto)
755  *
756  * Wrapper for sa_enable_share which disables a share for a specified
757  * protocol.
758  */
759 static int
760 zfs_sa_disable_share(sa_share_t share, char *proto)
761 {
762         if (_sa_disable_share != NULL)
763                 return (_sa_disable_share(share, proto));
764         return (SA_CONFIG_ERR);
765 }
766
767 /*
768  * Share the given filesystem according to the options in the specified
769  * protocol specific properties (sharenfs, sharesmb).  We rely
770  * on "libshare" to the dirty work for us.
771  */
772 static int
773 zfs_share_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
774 {
775         char mountpoint[ZFS_MAXPROPLEN];
776         char shareopts[ZFS_MAXPROPLEN];
777         char sourcestr[ZFS_MAXPROPLEN];
778         libzfs_handle_t *hdl = zhp->zfs_hdl;
779         sa_share_t share;
780         zfs_share_proto_t *curr_proto;
781         zprop_source_t sourcetype;
782         int ret;
783
784         if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint), NULL))
785                 return (0);
786
787         if ((ret = zfs_init_libshare(hdl, SA_INIT_SHARE_API)) != SA_OK) {
788 #ifdef HAVE_SHARE
789                 (void) zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
790                     dgettext(TEXT_DOMAIN, "cannot share '%s': %s"),
791                     zfs_get_name(zhp), _sa_errorstr != NULL ?
792                     _sa_errorstr(ret) : "");
793                 return (-1);
794 #endif /* HAVE_SHARE */
795                 return (0);
796         }
797
798         for (curr_proto = proto; *curr_proto != PROTO_END; curr_proto++) {
799                 /*
800                  * Return success if there are no share options.
801                  */
802                 if (zfs_prop_get(zhp, proto_table[*curr_proto].p_prop,
803                     shareopts, sizeof (shareopts), &sourcetype, sourcestr,
804                     ZFS_MAXPROPLEN, B_FALSE) != 0 ||
805                     strcmp(shareopts, "off") == 0)
806                         continue;
807
808                 /*
809                  * If the 'zoned' property is set, then zfs_is_mountable()
810                  * will have already bailed out if we are in the global zone.
811                  * But local zones cannot be NFS servers, so we ignore it for
812                  * local zones as well.
813                  */
814                 if (zfs_prop_get_int(zhp, ZFS_PROP_ZONED))
815                         continue;
816
817                 share = zfs_sa_find_share(hdl->libzfs_sharehdl, mountpoint);
818                 if (share == NULL) {
819                         /*
820                          * This may be a new file system that was just
821                          * created so isn't in the internal cache
822                          * (second time through). Rather than
823                          * reloading the entire configuration, we can
824                          * assume ZFS has done the checking and it is
825                          * safe to add this to the internal
826                          * configuration.
827                          */
828                         if (_sa_zfs_process_share(hdl->libzfs_sharehdl,
829                             NULL, NULL, mountpoint,
830                             proto_table[*curr_proto].p_name, sourcetype,
831                             shareopts, sourcestr, zhp->zfs_name) != SA_OK) {
832                                 (void) zfs_error_fmt(hdl,
833                                     proto_table[*curr_proto].p_share_err,
834                                     dgettext(TEXT_DOMAIN, "cannot share '%s'"),
835                                     zfs_get_name(zhp));
836                                 return (-1);
837                         }
838                         hdl->libzfs_shareflags |= ZFSSHARE_MISS;
839                         share = zfs_sa_find_share(hdl->libzfs_sharehdl,
840                             mountpoint);
841                 }
842                 if (share != NULL) {
843                         int err;
844                         err = zfs_sa_enable_share(share,
845                             proto_table[*curr_proto].p_name);
846                         if (err != SA_OK) {
847                                 (void) zfs_error_fmt(hdl,
848                                     proto_table[*curr_proto].p_share_err,
849                                     dgettext(TEXT_DOMAIN, "cannot share '%s'"),
850                                     zfs_get_name(zhp));
851                                 return (-1);
852                         }
853                 } else {
854                         (void) zfs_error_fmt(hdl,
855                             proto_table[*curr_proto].p_share_err,
856                             dgettext(TEXT_DOMAIN, "cannot share '%s'"),
857                             zfs_get_name(zhp));
858                         return (-1);
859                 }
860
861         }
862         return (0);
863 }
864
865
866 int
867 zfs_share_nfs(zfs_handle_t *zhp)
868 {
869         return (zfs_share_proto(zhp, nfs_only));
870 }
871
872 int
873 zfs_share_smb(zfs_handle_t *zhp)
874 {
875         return (zfs_share_proto(zhp, smb_only));
876 }
877
878 int
879 zfs_shareall(zfs_handle_t *zhp)
880 {
881         return (zfs_share_proto(zhp, share_all_proto));
882 }
883
884 /*
885  * Unshare a filesystem by mountpoint.
886  */
887 static int
888 unshare_one(libzfs_handle_t *hdl, const char *name, const char *mountpoint,
889     zfs_share_proto_t proto)
890 {
891         sa_share_t share;
892         int err;
893         char *mntpt;
894         /*
895          * Mountpoint could get trashed if libshare calls getmntany
896          * which it does during API initialization, so strdup the
897          * value.
898          */
899         mntpt = zfs_strdup(hdl, mountpoint);
900
901         /* make sure libshare initialized */
902         if ((err = zfs_init_libshare(hdl, SA_INIT_SHARE_API)) != SA_OK) {
903                 free(mntpt);    /* don't need the copy anymore */
904                 return (zfs_error_fmt(hdl, EZFS_SHARENFSFAILED,
905                     dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
906                     name, _sa_errorstr(err)));
907         }
908
909         share = zfs_sa_find_share(hdl->libzfs_sharehdl, mntpt);
910         free(mntpt);    /* don't need the copy anymore */
911
912         if (share != NULL) {
913                 err = zfs_sa_disable_share(share, proto_table[proto].p_name);
914                 if (err != SA_OK) {
915                         return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
916                             dgettext(TEXT_DOMAIN, "cannot unshare '%s': %s"),
917                             name, _sa_errorstr(err)));
918                 }
919         } else {
920                 return (zfs_error_fmt(hdl, EZFS_UNSHARENFSFAILED,
921                     dgettext(TEXT_DOMAIN, "cannot unshare '%s': not found"),
922                     name));
923         }
924         return (0);
925 }
926
927 /*
928  * Unshare the given filesystem.
929  */
930 int
931 zfs_unshare_proto(zfs_handle_t *zhp, const char *mountpoint,
932     zfs_share_proto_t *proto)
933 {
934         libzfs_handle_t *hdl = zhp->zfs_hdl;
935         struct mnttab entry;
936         char *mntpt = NULL;
937
938         /* check to see if need to unmount the filesystem */
939         rewind(zhp->zfs_hdl->libzfs_mnttab);
940         if (mountpoint != NULL)
941                 mountpoint = mntpt = zfs_strdup(hdl, mountpoint);
942
943         if (mountpoint != NULL || ((zfs_get_type(zhp) == ZFS_TYPE_FILESYSTEM) &&
944             libzfs_mnttab_find(hdl, zfs_get_name(zhp), &entry) == 0)) {
945                 zfs_share_proto_t *curr_proto;
946
947                 if (mountpoint == NULL)
948                         mntpt = zfs_strdup(zhp->zfs_hdl, entry.mnt_mountp);
949
950                 for (curr_proto = proto; *curr_proto != PROTO_END;
951                     curr_proto++) {
952
953                         if (is_shared(hdl, mntpt, *curr_proto) &&
954                             unshare_one(hdl, zhp->zfs_name,
955                             mntpt, *curr_proto) != 0) {
956                                 if (mntpt != NULL)
957                                         free(mntpt);
958                                 return (-1);
959                         }
960                 }
961         }
962         if (mntpt != NULL)
963                 free(mntpt);
964
965         return (0);
966 }
967
968 int
969 zfs_unshare_nfs(zfs_handle_t *zhp, const char *mountpoint)
970 {
971         return (zfs_unshare_proto(zhp, mountpoint, nfs_only));
972 }
973
974 int
975 zfs_unshare_smb(zfs_handle_t *zhp, const char *mountpoint)
976 {
977         return (zfs_unshare_proto(zhp, mountpoint, smb_only));
978 }
979
980 /*
981  * Same as zfs_unmountall(), but for NFS and SMB unshares.
982  */
983 int
984 zfs_unshareall_proto(zfs_handle_t *zhp, zfs_share_proto_t *proto)
985 {
986         prop_changelist_t *clp;
987         int ret;
988
989         clp = changelist_gather(zhp, ZFS_PROP_SHARENFS, 0, 0);
990         if (clp == NULL)
991                 return (-1);
992
993         ret = changelist_unshare(clp, proto);
994         changelist_free(clp);
995
996         return (ret);
997 }
998
999 int
1000 zfs_unshareall_nfs(zfs_handle_t *zhp)
1001 {
1002         return (zfs_unshareall_proto(zhp, nfs_only));
1003 }
1004
1005 int
1006 zfs_unshareall_smb(zfs_handle_t *zhp)
1007 {
1008         return (zfs_unshareall_proto(zhp, smb_only));
1009 }
1010
1011 int
1012 zfs_unshareall(zfs_handle_t *zhp)
1013 {
1014         return (zfs_unshareall_proto(zhp, share_all_proto));
1015 }
1016
1017 int
1018 zfs_unshareall_bypath(zfs_handle_t *zhp, const char *mountpoint)
1019 {
1020         return (zfs_unshare_proto(zhp, mountpoint, share_all_proto));
1021 }
1022
1023 /*
1024  * Remove the mountpoint associated with the current dataset, if necessary.
1025  * We only remove the underlying directory if:
1026  *
1027  *      - The mountpoint is not 'none' or 'legacy'
1028  *      - The mountpoint is non-empty
1029  *      - The mountpoint is the default or inherited
1030  *      - The 'zoned' property is set, or we're in a local zone
1031  *
1032  * Any other directories we leave alone.
1033  */
1034 void
1035 remove_mountpoint(zfs_handle_t *zhp)
1036 {
1037         char mountpoint[ZFS_MAXPROPLEN];
1038         zprop_source_t source;
1039
1040         if (!zfs_is_mountable(zhp, mountpoint, sizeof (mountpoint),
1041             &source))
1042                 return;
1043
1044         if (source == ZPROP_SRC_DEFAULT ||
1045             source == ZPROP_SRC_INHERITED) {
1046                 /*
1047                  * Try to remove the directory, silently ignoring any errors.
1048                  * The filesystem may have since been removed or moved around,
1049                  * and this error isn't really useful to the administrator in
1050                  * any way.
1051                  */
1052                 (void) rmdir(mountpoint);
1053         }
1054 }
1055
1056 void
1057 libzfs_add_handle(get_all_cb_t *cbp, zfs_handle_t *zhp)
1058 {
1059         if (cbp->cb_alloc == cbp->cb_used) {
1060                 size_t newsz;
1061                 void *ptr;
1062
1063                 newsz = cbp->cb_alloc ? cbp->cb_alloc * 2 : 64;
1064                 ptr = zfs_realloc(zhp->zfs_hdl,
1065                     cbp->cb_handles, cbp->cb_alloc * sizeof (void *),
1066                     newsz * sizeof (void *));
1067                 cbp->cb_handles = ptr;
1068                 cbp->cb_alloc = newsz;
1069         }
1070         cbp->cb_handles[cbp->cb_used++] = zhp;
1071 }
1072
1073 static int
1074 mount_cb(zfs_handle_t *zhp, void *data)
1075 {
1076         get_all_cb_t *cbp = data;
1077
1078         if (!(zfs_get_type(zhp) & ZFS_TYPE_FILESYSTEM)) {
1079                 zfs_close(zhp);
1080                 return (0);
1081         }
1082
1083         if (zfs_prop_get_int(zhp, ZFS_PROP_CANMOUNT) == ZFS_CANMOUNT_NOAUTO) {
1084                 zfs_close(zhp);
1085                 return (0);
1086         }
1087
1088         libzfs_add_handle(cbp, zhp);
1089         if (zfs_iter_filesystems(zhp, mount_cb, cbp) != 0) {
1090                 zfs_close(zhp);
1091                 return (-1);
1092         }
1093         return (0);
1094 }
1095
1096 int
1097 libzfs_dataset_cmp(const void *a, const void *b)
1098 {
1099         zfs_handle_t **za = (zfs_handle_t **)a;
1100         zfs_handle_t **zb = (zfs_handle_t **)b;
1101         char mounta[MAXPATHLEN];
1102         char mountb[MAXPATHLEN];
1103         boolean_t gota, gotb;
1104
1105         if ((gota = (zfs_get_type(*za) == ZFS_TYPE_FILESYSTEM)) != 0)
1106                 verify(zfs_prop_get(*za, ZFS_PROP_MOUNTPOINT, mounta,
1107                     sizeof (mounta), NULL, NULL, 0, B_FALSE) == 0);
1108         if ((gotb = (zfs_get_type(*zb) == ZFS_TYPE_FILESYSTEM)) != 0)
1109                 verify(zfs_prop_get(*zb, ZFS_PROP_MOUNTPOINT, mountb,
1110                     sizeof (mountb), NULL, NULL, 0, B_FALSE) == 0);
1111
1112         if (gota && gotb)
1113                 return (strcmp(mounta, mountb));
1114
1115         if (gota)
1116                 return (-1);
1117         if (gotb)
1118                 return (1);
1119
1120         return (strcmp(zfs_get_name(a), zfs_get_name(b)));
1121 }
1122
1123 /*
1124  * Mount and share all datasets within the given pool.  This assumes that no
1125  * datasets within the pool are currently mounted.  Because users can create
1126  * complicated nested hierarchies of mountpoints, we first gather all the
1127  * datasets and mountpoints within the pool, and sort them by mountpoint.  Once
1128  * we have the list of all filesystems, we iterate over them in order and mount
1129  * and/or share each one.
1130  */
1131 #pragma weak zpool_mount_datasets = zpool_enable_datasets
1132 int
1133 zpool_enable_datasets(zpool_handle_t *zhp, const char *mntopts, int flags)
1134 {
1135         get_all_cb_t cb = { 0 };
1136         libzfs_handle_t *hdl = zhp->zpool_hdl;
1137         zfs_handle_t *zfsp;
1138         int i, ret = -1;
1139         int *good;
1140
1141         /*
1142          * Gather all non-snap datasets within the pool.
1143          */
1144         if ((zfsp = zfs_open(hdl, zhp->zpool_name, ZFS_TYPE_DATASET)) == NULL)
1145                 goto out;
1146
1147         libzfs_add_handle(&cb, zfsp);
1148         if (zfs_iter_filesystems(zfsp, mount_cb, &cb) != 0)
1149                 goto out;
1150         /*
1151          * Sort the datasets by mountpoint.
1152          */
1153         qsort(cb.cb_handles, cb.cb_used, sizeof (void *),
1154             libzfs_dataset_cmp);
1155
1156         /*
1157          * And mount all the datasets, keeping track of which ones
1158          * succeeded or failed.
1159          */
1160         if ((good = zfs_alloc(zhp->zpool_hdl,
1161             cb.cb_used * sizeof (int))) == NULL)
1162                 goto out;
1163
1164         ret = 0;
1165         for (i = 0; i < cb.cb_used; i++) {
1166                 if (zfs_mount(cb.cb_handles[i], mntopts, flags) != 0)
1167                         ret = -1;
1168                 else
1169                         good[i] = 1;
1170         }
1171
1172         /*
1173          * Then share all the ones that need to be shared. This needs
1174          * to be a separate pass in order to avoid excessive reloading
1175          * of the configuration. Good should never be NULL since
1176          * zfs_alloc is supposed to exit if memory isn't available.
1177          */
1178         for (i = 0; i < cb.cb_used; i++) {
1179                 if (good[i] && zfs_share(cb.cb_handles[i]) != 0)
1180                         ret = -1;
1181         }
1182
1183         free(good);
1184
1185 out:
1186         for (i = 0; i < cb.cb_used; i++)
1187                 zfs_close(cb.cb_handles[i]);
1188         free(cb.cb_handles);
1189
1190         return (ret);
1191 }
1192
1193 static int
1194 mountpoint_compare(const void *a, const void *b)
1195 {
1196         const char *mounta = *((char **)a);
1197         const char *mountb = *((char **)b);
1198
1199         return (strcmp(mountb, mounta));
1200 }
1201
1202 /* alias for 2002/240 */
1203 #pragma weak zpool_unmount_datasets = zpool_disable_datasets
1204 /*
1205  * Unshare and unmount all datasets within the given pool.  We don't want to
1206  * rely on traversing the DSL to discover the filesystems within the pool,
1207  * because this may be expensive (if not all of them are mounted), and can fail
1208  * arbitrarily (on I/O error, for example).  Instead, we walk /etc/mtab and
1209  * gather all the filesystems that are currently mounted.
1210  */
1211 int
1212 zpool_disable_datasets(zpool_handle_t *zhp, boolean_t force)
1213 {
1214         int used, alloc;
1215         struct mnttab entry;
1216         size_t namelen;
1217         char **mountpoints = NULL;
1218         zfs_handle_t **datasets = NULL;
1219         libzfs_handle_t *hdl = zhp->zpool_hdl;
1220         int i;
1221         int ret = -1;
1222         int flags = (force ? MS_FORCE : 0);
1223
1224         namelen = strlen(zhp->zpool_name);
1225
1226         rewind(hdl->libzfs_mnttab);
1227         used = alloc = 0;
1228         while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
1229                 /*
1230                  * Ignore non-ZFS entries.
1231                  */
1232                 if (entry.mnt_fstype == NULL ||
1233                     strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
1234                         continue;
1235
1236                 /*
1237                  * Ignore filesystems not within this pool.
1238                  */
1239                 if (entry.mnt_mountp == NULL ||
1240                     strncmp(entry.mnt_special, zhp->zpool_name, namelen) != 0 ||
1241                     (entry.mnt_special[namelen] != '/' &&
1242                     entry.mnt_special[namelen] != '\0'))
1243                         continue;
1244
1245                 /*
1246                  * At this point we've found a filesystem within our pool.  Add
1247                  * it to our growing list.
1248                  */
1249                 if (used == alloc) {
1250                         if (alloc == 0) {
1251                                 if ((mountpoints = zfs_alloc(hdl,
1252                                     8 * sizeof (void *))) == NULL)
1253                                         goto out;
1254
1255                                 if ((datasets = zfs_alloc(hdl,
1256                                     8 * sizeof (void *))) == NULL)
1257                                         goto out;
1258
1259                                 alloc = 8;
1260                         } else {
1261                                 void *ptr;
1262
1263                                 if ((ptr = zfs_realloc(hdl, mountpoints,
1264                                     alloc * sizeof (void *),
1265                                     alloc * 2 * sizeof (void *))) == NULL)
1266                                         goto out;
1267                                 mountpoints = ptr;
1268
1269                                 if ((ptr = zfs_realloc(hdl, datasets,
1270                                     alloc * sizeof (void *),
1271                                     alloc * 2 * sizeof (void *))) == NULL)
1272                                         goto out;
1273                                 datasets = ptr;
1274
1275                                 alloc *= 2;
1276                         }
1277                 }
1278
1279                 if ((mountpoints[used] = zfs_strdup(hdl,
1280                     entry.mnt_mountp)) == NULL)
1281                         goto out;
1282
1283                 /*
1284                  * This is allowed to fail, in case there is some I/O error.  It
1285                  * is only used to determine if we need to remove the underlying
1286                  * mountpoint, so failure is not fatal.
1287                  */
1288                 datasets[used] = make_dataset_handle(hdl, entry.mnt_special);
1289
1290                 used++;
1291         }
1292
1293         /*
1294          * At this point, we have the entire list of filesystems, so sort it by
1295          * mountpoint.
1296          */
1297         qsort(mountpoints, used, sizeof (char *), mountpoint_compare);
1298
1299         /*
1300          * Walk through and first unshare everything.
1301          */
1302         for (i = 0; i < used; i++) {
1303                 zfs_share_proto_t *curr_proto;
1304                 for (curr_proto = share_all_proto; *curr_proto != PROTO_END;
1305                     curr_proto++) {
1306                         if (is_shared(hdl, mountpoints[i], *curr_proto) &&
1307                             unshare_one(hdl, mountpoints[i],
1308                             mountpoints[i], *curr_proto) != 0)
1309                                 goto out;
1310                 }
1311         }
1312
1313         /*
1314          * Now unmount everything, removing the underlying directories as
1315          * appropriate.
1316          */
1317         for (i = 0; i < used; i++) {
1318                 if (unmount_one(hdl, mountpoints[i], flags) != 0)
1319                         goto out;
1320         }
1321
1322         for (i = 0; i < used; i++) {
1323                 if (datasets[i])
1324                         remove_mountpoint(datasets[i]);
1325         }
1326
1327         ret = 0;
1328 out:
1329         for (i = 0; i < used; i++) {
1330                 if (datasets[i])
1331                         zfs_close(datasets[i]);
1332                 free(mountpoints[i]);
1333         }
1334         free(datasets);
1335         free(mountpoints);
1336
1337         return (ret);
1338 }