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 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
25 * Copyright (c) 2012 by Delphix. All rights reserved.
26 * Copyright (c) 2012 DEY Storage Systems, Inc. All rights reserved.
27 * Copyright 2012 Nexenta Systems, Inc. All rights reserved.
28 */
29
30 #include <ctype.h>
31 #include <errno.h>
32 #include <libintl.h>
33 #include <math.h>
34 #include <stdio.h>
35 #include <stdlib.h>
36 #include <strings.h>
37 #include <unistd.h>
38 #include <stddef.h>
39 #include <zone.h>
40 #include <fcntl.h>
41 #include <sys/mntent.h>
42 #include <sys/mount.h>
43 #include <priv.h>
44 #include <pwd.h>
45 #include <grp.h>
46 #include <stddef.h>
47 #include <ucred.h>
48 #include <idmap.h>
49 #include <aclutils.h>
50 #include <directory.h>
51
52 #include <sys/dnode.h>
53 #include <sys/spa.h>
54 #include <sys/zap.h>
55 #include <libzfs.h>
56
57 #include "zfs_namecheck.h"
58 #include "zfs_prop.h"
59 #include "libzfs_impl.h"
60 #include "zfs_deleg.h"
61
62 static int userquota_propname_decode(const char *propname, boolean_t zoned,
63 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp);
64
65 /*
66 * Given a single type (not a mask of types), return the type in a human
67 * readable form.
68 */
69 const char *
70 zfs_type_to_name(zfs_type_t type)
71 {
72 switch (type) {
73 case ZFS_TYPE_FILESYSTEM:
74 return (dgettext(TEXT_DOMAIN, "filesystem"));
75 case ZFS_TYPE_SNAPSHOT:
76 return (dgettext(TEXT_DOMAIN, "snapshot"));
77 case ZFS_TYPE_VOLUME:
78 return (dgettext(TEXT_DOMAIN, "volume"));
79 }
80
81 return (NULL);
82 }
83
84 /*
85 * Given a path and mask of ZFS types, return a string describing this dataset.
86 * This is used when we fail to open a dataset and we cannot get an exact type.
87 * We guess what the type would have been based on the path and the mask of
88 * acceptable types.
89 */
90 static const char *
91 path_to_str(const char *path, int types)
92 {
93 /*
94 * When given a single type, always report the exact type.
95 */
96 if (types == ZFS_TYPE_SNAPSHOT)
97 return (dgettext(TEXT_DOMAIN, "snapshot"));
98 if (types == ZFS_TYPE_FILESYSTEM)
99 return (dgettext(TEXT_DOMAIN, "filesystem"));
100 if (types == ZFS_TYPE_VOLUME)
101 return (dgettext(TEXT_DOMAIN, "volume"));
102
103 /*
104 * The user is requesting more than one type of dataset. If this is the
105 * case, consult the path itself. If we're looking for a snapshot, and
106 * a '@' is found, then report it as "snapshot". Otherwise, remove the
107 * snapshot attribute and try again.
108 */
109 if (types & ZFS_TYPE_SNAPSHOT) {
110 if (strchr(path, '@') != NULL)
111 return (dgettext(TEXT_DOMAIN, "snapshot"));
112 return (path_to_str(path, types & ~ZFS_TYPE_SNAPSHOT));
113 }
114
115 /*
116 * The user has requested either filesystems or volumes.
117 * We have no way of knowing a priori what type this would be, so always
118 * report it as "filesystem" or "volume", our two primitive types.
119 */
120 if (types & ZFS_TYPE_FILESYSTEM)
121 return (dgettext(TEXT_DOMAIN, "filesystem"));
122
123 assert(types & ZFS_TYPE_VOLUME);
124 return (dgettext(TEXT_DOMAIN, "volume"));
125 }
126
127 /*
128 * Validate a ZFS path. This is used even before trying to open the dataset, to
129 * provide a more meaningful error message. We call zfs_error_aux() to
130 * explain exactly why the name was not valid.
131 */
132 int
133 zfs_validate_name(libzfs_handle_t *hdl, const char *path, int type,
134 boolean_t modifying)
135 {
136 namecheck_err_t why;
137 char what;
138
139 (void) zfs_prop_get_table();
140 if (dataset_namecheck(path, &why, &what) != 0) {
141 if (hdl != NULL) {
142 switch (why) {
143 case NAME_ERR_TOOLONG:
144 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
145 "name is too long"));
146 break;
147
148 case NAME_ERR_LEADING_SLASH:
149 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
150 "leading slash in name"));
151 break;
152
153 case NAME_ERR_EMPTY_COMPONENT:
154 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
155 "empty component in name"));
156 break;
157
158 case NAME_ERR_TRAILING_SLASH:
159 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
160 "trailing slash in name"));
161 break;
162
163 case NAME_ERR_INVALCHAR:
164 zfs_error_aux(hdl,
165 dgettext(TEXT_DOMAIN, "invalid character "
166 "'%c' in name"), what);
167 break;
168
169 case NAME_ERR_MULTIPLE_AT:
170 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
171 "multiple '@' delimiters in name"));
172 break;
173
174 case NAME_ERR_NOLETTER:
175 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
176 "pool doesn't begin with a letter"));
177 break;
178
179 case NAME_ERR_RESERVED:
180 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
181 "name is reserved"));
182 break;
183
184 case NAME_ERR_DISKLIKE:
185 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
186 "reserved disk name"));
187 break;
188 }
189 }
190
191 return (0);
192 }
193
194 if (!(type & ZFS_TYPE_SNAPSHOT) && strchr(path, '@') != NULL) {
195 if (hdl != NULL)
196 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
197 "snapshot delimiter '@' in filesystem name"));
198 return (0);
199 }
200
201 if (type == ZFS_TYPE_SNAPSHOT && strchr(path, '@') == NULL) {
202 if (hdl != NULL)
203 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
204 "missing '@' delimiter in snapshot name"));
205 return (0);
206 }
207
208 if (modifying && strchr(path, '%') != NULL) {
209 if (hdl != NULL)
210 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
211 "invalid character %c in name"), '%');
212 return (0);
213 }
214
215 return (-1);
216 }
217
218 int
219 zfs_name_valid(const char *name, zfs_type_t type)
220 {
221 if (type == ZFS_TYPE_POOL)
222 return (zpool_name_valid(NULL, B_FALSE, name));
223 return (zfs_validate_name(NULL, name, type, B_FALSE));
224 }
225
226 /*
227 * This function takes the raw DSL properties, and filters out the user-defined
228 * properties into a separate nvlist.
229 */
230 static nvlist_t *
231 process_user_props(zfs_handle_t *zhp, nvlist_t *props)
232 {
233 libzfs_handle_t *hdl = zhp->zfs_hdl;
234 nvpair_t *elem;
235 nvlist_t *propval;
236 nvlist_t *nvl;
237
238 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0) {
239 (void) no_memory(hdl);
240 return (NULL);
241 }
242
243 elem = NULL;
244 while ((elem = nvlist_next_nvpair(props, elem)) != NULL) {
245 if (!zfs_prop_user(nvpair_name(elem)))
246 continue;
247
248 verify(nvpair_value_nvlist(elem, &propval) == 0);
249 if (nvlist_add_nvlist(nvl, nvpair_name(elem), propval) != 0) {
250 nvlist_free(nvl);
251 (void) no_memory(hdl);
252 return (NULL);
253 }
254 }
255
256 return (nvl);
257 }
258
259 static zpool_handle_t *
260 zpool_add_handle(zfs_handle_t *zhp, const char *pool_name)
261 {
262 libzfs_handle_t *hdl = zhp->zfs_hdl;
263 zpool_handle_t *zph;
264
265 if ((zph = zpool_open_canfail(hdl, pool_name)) != NULL) {
266 if (hdl->libzfs_pool_handles != NULL)
267 zph->zpool_next = hdl->libzfs_pool_handles;
268 hdl->libzfs_pool_handles = zph;
269 }
270 return (zph);
271 }
272
273 static zpool_handle_t *
274 zpool_find_handle(zfs_handle_t *zhp, const char *pool_name, int len)
275 {
276 libzfs_handle_t *hdl = zhp->zfs_hdl;
277 zpool_handle_t *zph = hdl->libzfs_pool_handles;
278
279 while ((zph != NULL) &&
280 (strncmp(pool_name, zpool_get_name(zph), len) != 0))
281 zph = zph->zpool_next;
282 return (zph);
283 }
284
285 /*
286 * Returns a handle to the pool that contains the provided dataset.
287 * If a handle to that pool already exists then that handle is returned.
288 * Otherwise, a new handle is created and added to the list of handles.
289 */
290 static zpool_handle_t *
291 zpool_handle(zfs_handle_t *zhp)
292 {
293 char *pool_name;
294 int len;
295 zpool_handle_t *zph;
296
297 len = strcspn(zhp->zfs_name, "/@") + 1;
298 pool_name = zfs_alloc(zhp->zfs_hdl, len);
299 (void) strlcpy(pool_name, zhp->zfs_name, len);
300
301 zph = zpool_find_handle(zhp, pool_name, len);
302 if (zph == NULL)
303 zph = zpool_add_handle(zhp, pool_name);
304
305 free(pool_name);
306 return (zph);
307 }
308
309 void
310 zpool_free_handles(libzfs_handle_t *hdl)
311 {
312 zpool_handle_t *next, *zph = hdl->libzfs_pool_handles;
313
314 while (zph != NULL) {
315 next = zph->zpool_next;
316 zpool_close(zph);
317 zph = next;
318 }
319 hdl->libzfs_pool_handles = NULL;
320 }
321
322 /*
323 * Utility function to gather stats (objset and zpl) for the given object.
324 */
325 static int
326 get_stats_ioctl(zfs_handle_t *zhp, zfs_cmd_t *zc)
327 {
328 libzfs_handle_t *hdl = zhp->zfs_hdl;
329
330 if (hdl->libzfs_cachedprops &&
331 libzfs_cmd_set_cachedprops(hdl, zc) != 0)
332 return (-1);
333
334 (void) strlcpy(zc->zc_name, zhp->zfs_name, sizeof (zc->zc_name));
335
336 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, zc) != 0) {
337 if (errno == ENOMEM) {
338 if (zcmd_expand_dst_nvlist(hdl, zc) != 0) {
339 return (-1);
340 }
341 } else {
342 return (-1);
343 }
344 }
345 return (0);
346 }
347
348 /*
349 * Utility function to get the received properties of the given object.
350 */
351 static int
352 get_recvd_props_ioctl(zfs_handle_t *zhp)
353 {
354 libzfs_handle_t *hdl = zhp->zfs_hdl;
355 nvlist_t *recvdprops;
356 zfs_cmd_t zc = { 0 };
357 int err;
358
359 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0)
360 return (-1);
361
362 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
363
364 while (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_RECVD_PROPS, &zc) != 0) {
365 if (errno == ENOMEM) {
366 if (zcmd_expand_dst_nvlist(hdl, &zc) != 0) {
367 return (-1);
368 }
369 } else {
370 zcmd_free_nvlists(&zc);
371 return (-1);
372 }
373 }
374
375 err = zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &recvdprops);
376 zcmd_free_nvlists(&zc);
377 if (err != 0)
378 return (-1);
379
380 nvlist_free(zhp->zfs_recvd_props);
381 zhp->zfs_recvd_props = recvdprops;
382
383 return (0);
384 }
385
386 static int
387 put_stats_zhdl(zfs_handle_t *zhp, zfs_cmd_t *zc)
388 {
389 nvlist_t *allprops, *userprops;
390
391 zhp->zfs_dmustats = zc->zc_objset_stats; /* structure assignment */
392
393 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, zc, &allprops) != 0) {
394 return (-1);
395 }
396
397 /*
398 * XXX Why do we store the user props separately, in addition to
399 * storing them in zfs_props?
400 */
401 if ((userprops = process_user_props(zhp, allprops)) == NULL) {
402 nvlist_free(allprops);
403 return (-1);
404 }
405
406 nvlist_free(zhp->zfs_props);
407 nvlist_free(zhp->zfs_user_props);
408
409 zhp->zfs_props = allprops;
410 zhp->zfs_user_props = userprops;
411
412 return (0);
413 }
414
415 static int
416 get_stats(zfs_handle_t *zhp)
417 {
418 int rc = 0;
419 zfs_cmd_t zc = { 0 };
420
421 if (zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
422 return (-1);
423 if (get_stats_ioctl(zhp, &zc) != 0)
424 rc = -1;
425 else if (put_stats_zhdl(zhp, &zc) != 0)
426 rc = -1;
427 zcmd_free_nvlists(&zc);
428 return (rc);
429 }
430
431 /*
432 * Refresh the properties currently stored in the handle.
433 */
434 void
435 zfs_refresh_properties(zfs_handle_t *zhp)
436 {
437 (void) get_stats(zhp);
438 }
439
440 /*
441 * Makes a handle from the given dataset name. Used by zfs_open() and
442 * zfs_iter_* to create child handles on the fly.
443 */
444 static int
445 make_dataset_handle_common(zfs_handle_t *zhp, zfs_cmd_t *zc)
446 {
447 if (put_stats_zhdl(zhp, zc) != 0)
448 return (-1);
449
450 /*
451 * We've managed to open the dataset and gather statistics. Determine
452 * the high-level type.
453 */
454 if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
455 zhp->zfs_head_type = ZFS_TYPE_VOLUME;
456 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
457 zhp->zfs_head_type = ZFS_TYPE_FILESYSTEM;
458 else
459 abort();
460
461 if (zhp->zfs_dmustats.dds_is_snapshot)
462 zhp->zfs_type = ZFS_TYPE_SNAPSHOT;
463 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZVOL)
464 zhp->zfs_type = ZFS_TYPE_VOLUME;
465 else if (zhp->zfs_dmustats.dds_type == DMU_OST_ZFS)
466 zhp->zfs_type = ZFS_TYPE_FILESYSTEM;
467 else
468 abort(); /* we should never see any other types */
469
470 if ((zhp->zpool_hdl = zpool_handle(zhp)) == NULL)
471 return (-1);
472
473 return (0);
474 }
475
476 zfs_handle_t *
477 make_dataset_handle(libzfs_handle_t *hdl, const char *path)
478 {
479 zfs_cmd_t zc = { 0 };
480
481 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
482
483 if (zhp == NULL)
484 return (NULL);
485
486 zhp->zfs_hdl = hdl;
487 (void) strlcpy(zhp->zfs_name, path, sizeof (zhp->zfs_name));
488 if (zcmd_alloc_dst_nvlist(hdl, &zc, 0) != 0) {
489 free(zhp);
490 return (NULL);
491 }
492 if (get_stats_ioctl(zhp, &zc) == -1) {
493 zcmd_free_nvlists(&zc);
494 free(zhp);
495 return (NULL);
496 }
497 if (make_dataset_handle_common(zhp, &zc) == -1) {
498 free(zhp);
499 zhp = NULL;
500 }
501 zcmd_free_nvlists(&zc);
502 return (zhp);
503 }
504
505 zfs_handle_t *
506 make_dataset_handle_zc(libzfs_handle_t *hdl, zfs_cmd_t *zc)
507 {
508 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
509
510 if (zhp == NULL)
511 return (NULL);
512
513 zhp->zfs_hdl = hdl;
514 (void) strlcpy(zhp->zfs_name, zc->zc_name, sizeof (zhp->zfs_name));
515 if (make_dataset_handle_common(zhp, zc) == -1) {
516 free(zhp);
517 return (NULL);
518 }
519 return (zhp);
520 }
521
522 zfs_handle_t *
523 zfs_handle_dup(zfs_handle_t *zhp_orig)
524 {
525 zfs_handle_t *zhp = calloc(sizeof (zfs_handle_t), 1);
526
527 if (zhp == NULL)
528 return (NULL);
529
530 zhp->zfs_hdl = zhp_orig->zfs_hdl;
531 zhp->zpool_hdl = zhp_orig->zpool_hdl;
532 (void) strlcpy(zhp->zfs_name, zhp_orig->zfs_name,
533 sizeof (zhp->zfs_name));
534 zhp->zfs_type = zhp_orig->zfs_type;
535 zhp->zfs_head_type = zhp_orig->zfs_head_type;
536 zhp->zfs_dmustats = zhp_orig->zfs_dmustats;
537 if (zhp_orig->zfs_props != NULL) {
538 if (nvlist_dup(zhp_orig->zfs_props, &zhp->zfs_props, 0) != 0) {
539 (void) no_memory(zhp->zfs_hdl);
540 zfs_close(zhp);
541 return (NULL);
542 }
543 }
544 if (zhp_orig->zfs_user_props != NULL) {
545 if (nvlist_dup(zhp_orig->zfs_user_props,
546 &zhp->zfs_user_props, 0) != 0) {
547 (void) no_memory(zhp->zfs_hdl);
548 zfs_close(zhp);
549 return (NULL);
550 }
551 }
552 if (zhp_orig->zfs_recvd_props != NULL) {
553 if (nvlist_dup(zhp_orig->zfs_recvd_props,
554 &zhp->zfs_recvd_props, 0)) {
555 (void) no_memory(zhp->zfs_hdl);
556 zfs_close(zhp);
557 return (NULL);
558 }
559 }
560 zhp->zfs_mntcheck = zhp_orig->zfs_mntcheck;
561 if (zhp_orig->zfs_mntopts != NULL) {
562 zhp->zfs_mntopts = zfs_strdup(zhp_orig->zfs_hdl,
563 zhp_orig->zfs_mntopts);
564 }
565 zhp->zfs_props_table = zhp_orig->zfs_props_table;
566 return (zhp);
567 }
568
569 /*
570 * Opens the given snapshot, filesystem, or volume. The 'types'
571 * argument is a mask of acceptable types. The function will print an
572 * appropriate error message and return NULL if it can't be opened.
573 */
574 zfs_handle_t *
575 zfs_open(libzfs_handle_t *hdl, const char *path, int types)
576 {
577 zfs_handle_t *zhp;
578 char errbuf[1024];
579
580 (void) snprintf(errbuf, sizeof (errbuf),
581 dgettext(TEXT_DOMAIN, "cannot open '%s'"), path);
582
583 /*
584 * Validate the name before we even try to open it.
585 */
586 if (!zfs_validate_name(hdl, path, ZFS_TYPE_DATASET, B_FALSE)) {
587 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
588 "invalid dataset name"));
589 (void) zfs_error(hdl, EZFS_INVALIDNAME, errbuf);
590 return (NULL);
591 }
592
593 /*
594 * Try to get stats for the dataset, which will tell us if it exists.
595 */
596 errno = 0;
597 if ((zhp = make_dataset_handle(hdl, path)) == NULL) {
598 (void) zfs_standard_error(hdl, errno, errbuf);
599 return (NULL);
600 }
601
602 if (!(types & zhp->zfs_type)) {
603 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
604 zfs_close(zhp);
605 return (NULL);
606 }
607
608 return (zhp);
609 }
610
611 /*
612 * Release a ZFS handle. Nothing to do but free the associated memory.
613 */
614 void
615 zfs_close(zfs_handle_t *zhp)
616 {
617 if (zhp->zfs_mntopts)
618 free(zhp->zfs_mntopts);
619 nvlist_free(zhp->zfs_props);
620 nvlist_free(zhp->zfs_user_props);
621 nvlist_free(zhp->zfs_recvd_props);
622 free(zhp);
623 }
624
625 typedef struct mnttab_node {
626 struct mnttab mtn_mt;
627 avl_node_t mtn_node;
628 } mnttab_node_t;
629
630 static int
631 libzfs_mnttab_cache_compare(const void *arg1, const void *arg2)
632 {
633 const mnttab_node_t *mtn1 = arg1;
634 const mnttab_node_t *mtn2 = arg2;
635 int rv;
636
637 rv = strcmp(mtn1->mtn_mt.mnt_special, mtn2->mtn_mt.mnt_special);
638
639 if (rv == 0)
640 return (0);
641 return (rv > 0 ? 1 : -1);
642 }
643
644 void
645 libzfs_mnttab_init(libzfs_handle_t *hdl)
646 {
647 assert(avl_numnodes(&hdl->libzfs_mnttab_cache) == 0);
648 avl_create(&hdl->libzfs_mnttab_cache, libzfs_mnttab_cache_compare,
649 sizeof (mnttab_node_t), offsetof(mnttab_node_t, mtn_node));
650 }
651
652 void
653 libzfs_mnttab_update(libzfs_handle_t *hdl)
654 {
655 struct mnttab entry;
656
657 rewind(hdl->libzfs_mnttab);
658 while (getmntent(hdl->libzfs_mnttab, &entry) == 0) {
659 mnttab_node_t *mtn;
660
661 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0)
662 continue;
663 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
664 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, entry.mnt_special);
665 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, entry.mnt_mountp);
666 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, entry.mnt_fstype);
667 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, entry.mnt_mntopts);
668 avl_add(&hdl->libzfs_mnttab_cache, mtn);
669 }
670 }
671
672 void
673 libzfs_mnttab_fini(libzfs_handle_t *hdl)
674 {
675 void *cookie = NULL;
676 mnttab_node_t *mtn;
677
678 while (mtn = avl_destroy_nodes(&hdl->libzfs_mnttab_cache, &cookie)) {
679 free(mtn->mtn_mt.mnt_special);
680 free(mtn->mtn_mt.mnt_mountp);
681 free(mtn->mtn_mt.mnt_fstype);
682 free(mtn->mtn_mt.mnt_mntopts);
683 free(mtn);
684 }
685 avl_destroy(&hdl->libzfs_mnttab_cache);
686 }
687
688 void
689 libzfs_mnttab_cache(libzfs_handle_t *hdl, boolean_t enable)
690 {
691 hdl->libzfs_mnttab_enable = enable;
692 }
693
694 int
695 libzfs_mnttab_find(libzfs_handle_t *hdl, const char *fsname,
696 struct mnttab *entry)
697 {
698 mnttab_node_t find;
699 mnttab_node_t *mtn;
700
701 if (!hdl->libzfs_mnttab_enable) {
702 struct mnttab srch = { 0 };
703
704 if (avl_numnodes(&hdl->libzfs_mnttab_cache))
705 libzfs_mnttab_fini(hdl);
706 rewind(hdl->libzfs_mnttab);
707 srch.mnt_special = (char *)fsname;
708 srch.mnt_fstype = MNTTYPE_ZFS;
709 if (getmntany(hdl->libzfs_mnttab, entry, &srch) == 0)
710 return (0);
711 else
712 return (ENOENT);
713 }
714
715 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
716 libzfs_mnttab_update(hdl);
717
718 find.mtn_mt.mnt_special = (char *)fsname;
719 mtn = avl_find(&hdl->libzfs_mnttab_cache, &find, NULL);
720 if (mtn) {
721 *entry = mtn->mtn_mt;
722 return (0);
723 }
724 return (ENOENT);
725 }
726
727 void
728 libzfs_mnttab_add(libzfs_handle_t *hdl, const char *special,
729 const char *mountp, const char *mntopts)
730 {
731 mnttab_node_t *mtn;
732
733 if (avl_numnodes(&hdl->libzfs_mnttab_cache) == 0)
734 return;
735 mtn = zfs_alloc(hdl, sizeof (mnttab_node_t));
736 mtn->mtn_mt.mnt_special = zfs_strdup(hdl, special);
737 mtn->mtn_mt.mnt_mountp = zfs_strdup(hdl, mountp);
738 mtn->mtn_mt.mnt_fstype = zfs_strdup(hdl, MNTTYPE_ZFS);
739 mtn->mtn_mt.mnt_mntopts = zfs_strdup(hdl, mntopts);
740 avl_add(&hdl->libzfs_mnttab_cache, mtn);
741 }
742
743 void
744 libzfs_mnttab_remove(libzfs_handle_t *hdl, const char *fsname)
745 {
746 mnttab_node_t find;
747 mnttab_node_t *ret;
748
749 find.mtn_mt.mnt_special = (char *)fsname;
750 if (ret = avl_find(&hdl->libzfs_mnttab_cache, (void *)&find, NULL)) {
751 avl_remove(&hdl->libzfs_mnttab_cache, ret);
752 free(ret->mtn_mt.mnt_special);
753 free(ret->mtn_mt.mnt_mountp);
754 free(ret->mtn_mt.mnt_fstype);
755 free(ret->mtn_mt.mnt_mntopts);
756 free(ret);
757 }
758 }
759
760 int
761 zfs_spa_version(zfs_handle_t *zhp, int *spa_version)
762 {
763 zpool_handle_t *zpool_handle = zhp->zpool_hdl;
764
765 if (zpool_handle == NULL)
766 return (-1);
767
768 *spa_version = zpool_get_prop_int(zpool_handle,
769 ZPOOL_PROP_VERSION, NULL);
770 return (0);
771 }
772
773 /*
774 * The choice of reservation property depends on the SPA version.
775 */
776 static int
777 zfs_which_resv_prop(zfs_handle_t *zhp, zfs_prop_t *resv_prop)
778 {
779 int spa_version;
780
781 if (zfs_spa_version(zhp, &spa_version) < 0)
782 return (-1);
783
784 if (spa_version >= SPA_VERSION_REFRESERVATION)
785 *resv_prop = ZFS_PROP_REFRESERVATION;
786 else
787 *resv_prop = ZFS_PROP_RESERVATION;
788
789 return (0);
790 }
791
792 /*
793 * Given an nvlist of properties to set, validates that they are correct, and
794 * parses any numeric properties (index, boolean, etc) if they are specified as
795 * strings.
796 */
797 nvlist_t *
798 zfs_valid_proplist(libzfs_handle_t *hdl, zfs_type_t type, nvlist_t *nvl,
799 uint64_t zoned, zfs_handle_t *zhp, const char *errbuf)
800 {
801 nvpair_t *elem;
802 uint64_t intval;
803 char *strval;
804 zfs_prop_t prop;
805 nvlist_t *ret;
806 int chosen_normal = -1;
807 int chosen_utf = -1;
808
809 if (nvlist_alloc(&ret, NV_UNIQUE_NAME, 0) != 0) {
810 (void) no_memory(hdl);
811 return (NULL);
812 }
813
814 /*
815 * Make sure this property is valid and applies to this type.
816 */
817
818 elem = NULL;
819 while ((elem = nvlist_next_nvpair(nvl, elem)) != NULL) {
820 const char *propname = nvpair_name(elem);
821
822 prop = zfs_name_to_prop(propname);
823 if (prop == ZPROP_INVAL && zfs_prop_user(propname)) {
824 /*
825 * This is a user property: make sure it's a
826 * string, and that it's less than ZAP_MAXNAMELEN.
827 */
828 if (nvpair_type(elem) != DATA_TYPE_STRING) {
829 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
830 "'%s' must be a string"), propname);
831 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
832 goto error;
833 }
834
835 if (strlen(nvpair_name(elem)) >= ZAP_MAXNAMELEN) {
836 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
837 "property name '%s' is too long"),
838 propname);
839 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
840 goto error;
841 }
842
843 (void) nvpair_value_string(elem, &strval);
844 if (nvlist_add_string(ret, propname, strval) != 0) {
845 (void) no_memory(hdl);
846 goto error;
847 }
848 continue;
849 }
850
851 /*
852 * Currently, only user properties can be modified on
853 * snapshots.
854 */
855 if (type == ZFS_TYPE_SNAPSHOT) {
856 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
857 "this property can not be modified for snapshots"));
858 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
859 goto error;
860 }
861
862 if (prop == ZPROP_INVAL && zfs_prop_userquota(propname)) {
863 zfs_userquota_prop_t uqtype;
864 char newpropname[128];
865 char domain[128];
866 uint64_t rid;
867 uint64_t valary[3];
868
869 if (userquota_propname_decode(propname, zoned,
870 &uqtype, domain, sizeof (domain), &rid) != 0) {
871 zfs_error_aux(hdl,
872 dgettext(TEXT_DOMAIN,
873 "'%s' has an invalid user/group name"),
874 propname);
875 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
876 goto error;
877 }
878
879 if (uqtype != ZFS_PROP_USERQUOTA &&
880 uqtype != ZFS_PROP_GROUPQUOTA) {
881 zfs_error_aux(hdl,
882 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
883 propname);
884 (void) zfs_error(hdl, EZFS_PROPREADONLY,
885 errbuf);
886 goto error;
887 }
888
889 if (nvpair_type(elem) == DATA_TYPE_STRING) {
890 (void) nvpair_value_string(elem, &strval);
891 if (strcmp(strval, "none") == 0) {
892 intval = 0;
893 } else if (zfs_nicestrtonum(hdl,
894 strval, &intval) != 0) {
895 (void) zfs_error(hdl,
896 EZFS_BADPROP, errbuf);
897 goto error;
898 }
899 } else if (nvpair_type(elem) ==
900 DATA_TYPE_UINT64) {
901 (void) nvpair_value_uint64(elem, &intval);
902 if (intval == 0) {
903 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
904 "use 'none' to disable "
905 "userquota/groupquota"));
906 goto error;
907 }
908 } else {
909 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
910 "'%s' must be a number"), propname);
911 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
912 goto error;
913 }
914
915 /*
916 * Encode the prop name as
917 * userquota@<hex-rid>-domain, to make it easy
918 * for the kernel to decode.
919 */
920 (void) snprintf(newpropname, sizeof (newpropname),
921 "%s%llx-%s", zfs_userquota_prop_prefixes[uqtype],
922 (longlong_t)rid, domain);
923 valary[0] = uqtype;
924 valary[1] = rid;
925 valary[2] = intval;
926 if (nvlist_add_uint64_array(ret, newpropname,
927 valary, 3) != 0) {
928 (void) no_memory(hdl);
929 goto error;
930 }
931 continue;
932 } else if (prop == ZPROP_INVAL && zfs_prop_written(propname)) {
933 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
934 "'%s' is readonly"),
935 propname);
936 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
937 goto error;
938 }
939
940 if (prop == ZPROP_INVAL) {
941 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
942 "invalid property '%s'"), propname);
943 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
944 goto error;
945 }
946
947 if (!zfs_prop_valid_for_type(prop, type)) {
948 zfs_error_aux(hdl,
949 dgettext(TEXT_DOMAIN, "'%s' does not "
950 "apply to datasets of this type"), propname);
951 (void) zfs_error(hdl, EZFS_PROPTYPE, errbuf);
952 goto error;
953 }
954
955 if (zfs_prop_readonly(prop) &&
956 (!zfs_prop_setonce(prop) || zhp != NULL)) {
957 zfs_error_aux(hdl,
958 dgettext(TEXT_DOMAIN, "'%s' is readonly"),
959 propname);
960 (void) zfs_error(hdl, EZFS_PROPREADONLY, errbuf);
961 goto error;
962 }
963
964 if (zprop_parse_value(hdl, elem, prop, type, ret,
965 &strval, &intval, errbuf) != 0)
966 goto error;
967
968 /*
969 * Perform some additional checks for specific properties.
970 */
971 switch (prop) {
972 case ZFS_PROP_VERSION:
973 {
974 int version;
975
976 if (zhp == NULL)
977 break;
978 version = zfs_prop_get_int(zhp, ZFS_PROP_VERSION);
979 if (intval < version) {
980 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
981 "Can not downgrade; already at version %u"),
982 version);
983 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
984 goto error;
985 }
986 break;
987 }
988
989 case ZFS_PROP_RECORDSIZE:
990 case ZFS_PROP_VOLBLOCKSIZE:
991 /* must be power of two within SPA_{MIN,MAX}BLOCKSIZE */
992 if (intval < SPA_MINBLOCKSIZE ||
993 intval > SPA_MAXBLOCKSIZE || !ISP2(intval)) {
994 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
995 "'%s' must be power of 2 from %u "
996 "to %uk"), propname,
997 (uint_t)SPA_MINBLOCKSIZE,
998 (uint_t)SPA_MAXBLOCKSIZE >> 10);
999 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1000 goto error;
1001 }
1002 break;
1003
1004 case ZFS_PROP_MLSLABEL:
1005 {
1006 /*
1007 * Verify the mlslabel string and convert to
1008 * internal hex label string.
1009 */
1010
1011 m_label_t *new_sl;
1012 char *hex = NULL; /* internal label string */
1013
1014 /* Default value is already OK. */
1015 if (strcasecmp(strval, ZFS_MLSLABEL_DEFAULT) == 0)
1016 break;
1017
1018 /* Verify the label can be converted to binary form */
1019 if (((new_sl = m_label_alloc(MAC_LABEL)) == NULL) ||
1020 (str_to_label(strval, &new_sl, MAC_LABEL,
1021 L_NO_CORRECTION, NULL) == -1)) {
1022 goto badlabel;
1023 }
1024
1025 /* Now translate to hex internal label string */
1026 if (label_to_str(new_sl, &hex, M_INTERNAL,
1027 DEF_NAMES) != 0) {
1028 if (hex)
1029 free(hex);
1030 goto badlabel;
1031 }
1032 m_label_free(new_sl);
1033
1034 /* If string is already in internal form, we're done. */
1035 if (strcmp(strval, hex) == 0) {
1036 free(hex);
1037 break;
1038 }
1039
1040 /* Replace the label string with the internal form. */
1041 (void) nvlist_remove(ret, zfs_prop_to_name(prop),
1042 DATA_TYPE_STRING);
1043 verify(nvlist_add_string(ret, zfs_prop_to_name(prop),
1044 hex) == 0);
1045 free(hex);
1046
1047 break;
1048
1049 badlabel:
1050 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1051 "invalid mlslabel '%s'"), strval);
1052 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1053 m_label_free(new_sl); /* OK if null */
1054 goto error;
1055
1056 }
1057
1058 case ZFS_PROP_MOUNTPOINT:
1059 {
1060 namecheck_err_t why;
1061
1062 if (strcmp(strval, ZFS_MOUNTPOINT_NONE) == 0 ||
1063 strcmp(strval, ZFS_MOUNTPOINT_LEGACY) == 0)
1064 break;
1065
1066 if (mountpoint_namecheck(strval, &why)) {
1067 switch (why) {
1068 case NAME_ERR_LEADING_SLASH:
1069 zfs_error_aux(hdl,
1070 dgettext(TEXT_DOMAIN,
1071 "'%s' must be an absolute path, "
1072 "'none', or 'legacy'"), propname);
1073 break;
1074 case NAME_ERR_TOOLONG:
1075 zfs_error_aux(hdl,
1076 dgettext(TEXT_DOMAIN,
1077 "component of '%s' is too long"),
1078 propname);
1079 break;
1080 }
1081 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1082 goto error;
1083 }
1084 }
1085
1086 /*FALLTHRU*/
1087
1088 case ZFS_PROP_SHARESMB:
1089 case ZFS_PROP_SHARENFS:
1090 /*
1091 * For the mountpoint and sharenfs or sharesmb
1092 * properties, check if it can be set in a
1093 * global/non-global zone based on
1094 * the zoned property value:
1095 *
1096 * global zone non-global zone
1097 * --------------------------------------------------
1098 * zoned=on mountpoint (no) mountpoint (yes)
1099 * sharenfs (no) sharenfs (no)
1100 * sharesmb (no) sharesmb (no)
1101 *
1102 * zoned=off mountpoint (yes) N/A
1103 * sharenfs (yes)
1104 * sharesmb (yes)
1105 */
1106 if (zoned) {
1107 if (getzoneid() == GLOBAL_ZONEID) {
1108 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1109 "'%s' cannot be set on "
1110 "dataset in a non-global zone"),
1111 propname);
1112 (void) zfs_error(hdl, EZFS_ZONED,
1113 errbuf);
1114 goto error;
1115 } else if (prop == ZFS_PROP_SHARENFS ||
1116 prop == ZFS_PROP_SHARESMB) {
1117 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1118 "'%s' cannot be set in "
1119 "a non-global zone"), propname);
1120 (void) zfs_error(hdl, EZFS_ZONED,
1121 errbuf);
1122 goto error;
1123 }
1124 } else if (getzoneid() != GLOBAL_ZONEID) {
1125 /*
1126 * If zoned property is 'off', this must be in
1127 * a global zone. If not, something is wrong.
1128 */
1129 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1130 "'%s' cannot be set while dataset "
1131 "'zoned' property is set"), propname);
1132 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
1133 goto error;
1134 }
1135
1136 /*
1137 * At this point, it is legitimate to set the
1138 * property. Now we want to make sure that the
1139 * property value is valid if it is sharenfs.
1140 */
1141 if ((prop == ZFS_PROP_SHARENFS ||
1142 prop == ZFS_PROP_SHARESMB) &&
1143 strcmp(strval, "on") != 0 &&
1144 strcmp(strval, "off") != 0) {
1145 zfs_share_proto_t proto;
1146
1147 if (prop == ZFS_PROP_SHARESMB)
1148 proto = PROTO_SMB;
1149 else
1150 proto = PROTO_NFS;
1151
1152 /*
1153 * Must be an valid sharing protocol
1154 * option string so init the libshare
1155 * in order to enable the parser and
1156 * then parse the options. We use the
1157 * control API since we don't care about
1158 * the current configuration and don't
1159 * want the overhead of loading it
1160 * until we actually do something.
1161 */
1162
1163 if (zfs_init_libshare(hdl,
1164 SA_INIT_CONTROL_API) != SA_OK) {
1165 /*
1166 * An error occurred so we can't do
1167 * anything
1168 */
1169 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1170 "'%s' cannot be set: problem "
1171 "in share initialization"),
1172 propname);
1173 (void) zfs_error(hdl, EZFS_BADPROP,
1174 errbuf);
1175 goto error;
1176 }
1177
1178 if (zfs_parse_options(strval, proto) != SA_OK) {
1179 /*
1180 * There was an error in parsing so
1181 * deal with it by issuing an error
1182 * message and leaving after
1183 * uninitializing the the libshare
1184 * interface.
1185 */
1186 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1187 "'%s' cannot be set to invalid "
1188 "options"), propname);
1189 (void) zfs_error(hdl, EZFS_BADPROP,
1190 errbuf);
1191 zfs_uninit_libshare(hdl);
1192 goto error;
1193 }
1194 zfs_uninit_libshare(hdl);
1195 }
1196
1197 break;
1198 case ZFS_PROP_UTF8ONLY:
1199 chosen_utf = (int)intval;
1200 break;
1201 case ZFS_PROP_NORMALIZE:
1202 chosen_normal = (int)intval;
1203 break;
1204 }
1205
1206 /*
1207 * For changes to existing volumes, we have some additional
1208 * checks to enforce.
1209 */
1210 if (type == ZFS_TYPE_VOLUME && zhp != NULL) {
1211 uint64_t volsize = zfs_prop_get_int(zhp,
1212 ZFS_PROP_VOLSIZE);
1213 uint64_t blocksize = zfs_prop_get_int(zhp,
1214 ZFS_PROP_VOLBLOCKSIZE);
1215 char buf[64];
1216
1217 switch (prop) {
1218 case ZFS_PROP_RESERVATION:
1219 case ZFS_PROP_REFRESERVATION:
1220 if (intval > volsize) {
1221 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1222 "'%s' is greater than current "
1223 "volume size"), propname);
1224 (void) zfs_error(hdl, EZFS_BADPROP,
1225 errbuf);
1226 goto error;
1227 }
1228 break;
1229
1230 case ZFS_PROP_VOLSIZE:
1231 if (intval % blocksize != 0) {
1232 zfs_nicenum(blocksize, buf,
1233 sizeof (buf));
1234 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1235 "'%s' must be a multiple of "
1236 "volume block size (%s)"),
1237 propname, buf);
1238 (void) zfs_error(hdl, EZFS_BADPROP,
1239 errbuf);
1240 goto error;
1241 }
1242
1243 if (intval == 0) {
1244 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1245 "'%s' cannot be zero"),
1246 propname);
1247 (void) zfs_error(hdl, EZFS_BADPROP,
1248 errbuf);
1249 goto error;
1250 }
1251 break;
1252 }
1253 }
1254 }
1255
1256 /*
1257 * If normalization was chosen, but no UTF8 choice was made,
1258 * enforce rejection of non-UTF8 names.
1259 *
1260 * If normalization was chosen, but rejecting non-UTF8 names
1261 * was explicitly not chosen, it is an error.
1262 */
1263 if (chosen_normal > 0 && chosen_utf < 0) {
1264 if (nvlist_add_uint64(ret,
1265 zfs_prop_to_name(ZFS_PROP_UTF8ONLY), 1) != 0) {
1266 (void) no_memory(hdl);
1267 goto error;
1268 }
1269 } else if (chosen_normal > 0 && chosen_utf == 0) {
1270 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1271 "'%s' must be set 'on' if normalization chosen"),
1272 zfs_prop_to_name(ZFS_PROP_UTF8ONLY));
1273 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1274 goto error;
1275 }
1276 return (ret);
1277
1278 error:
1279 nvlist_free(ret);
1280 return (NULL);
1281 }
1282
1283 int
1284 zfs_add_synthetic_resv(zfs_handle_t *zhp, nvlist_t *nvl)
1285 {
1286 uint64_t old_volsize;
1287 uint64_t new_volsize;
1288 uint64_t old_reservation;
1289 uint64_t new_reservation;
1290 zfs_prop_t resv_prop;
1291
1292 /*
1293 * If this is an existing volume, and someone is setting the volsize,
1294 * make sure that it matches the reservation, or add it if necessary.
1295 */
1296 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
1297 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
1298 return (-1);
1299 old_reservation = zfs_prop_get_int(zhp, resv_prop);
1300 if ((zvol_volsize_to_reservation(old_volsize, zhp->zfs_props) !=
1301 old_reservation) || nvlist_lookup_uint64(nvl,
1302 zfs_prop_to_name(resv_prop), &new_reservation) != ENOENT) {
1303 return (0);
1304 }
1305 if (nvlist_lookup_uint64(nvl, zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1306 &new_volsize) != 0)
1307 return (-1);
1308 new_reservation = zvol_volsize_to_reservation(new_volsize,
1309 zhp->zfs_props);
1310 if (nvlist_add_uint64(nvl, zfs_prop_to_name(resv_prop),
1311 new_reservation) != 0) {
1312 (void) no_memory(zhp->zfs_hdl);
1313 return (-1);
1314 }
1315 return (1);
1316 }
1317
1318 void
1319 zfs_setprop_error(libzfs_handle_t *hdl, zfs_prop_t prop, int err,
1320 char *errbuf)
1321 {
1322 switch (err) {
1323
1324 case ENOSPC:
1325 /*
1326 * For quotas and reservations, ENOSPC indicates
1327 * something different; setting a quota or reservation
1328 * doesn't use any disk space.
1329 */
1330 switch (prop) {
1331 case ZFS_PROP_QUOTA:
1332 case ZFS_PROP_REFQUOTA:
1333 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1334 "size is less than current used or "
1335 "reserved space"));
1336 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1337 break;
1338
1339 case ZFS_PROP_RESERVATION:
1340 case ZFS_PROP_REFRESERVATION:
1341 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1342 "size is greater than available space"));
1343 (void) zfs_error(hdl, EZFS_PROPSPACE, errbuf);
1344 break;
1345
1346 default:
1347 (void) zfs_standard_error(hdl, err, errbuf);
1348 break;
1349 }
1350 break;
1351
1352 case EBUSY:
1353 (void) zfs_standard_error(hdl, EBUSY, errbuf);
1354 break;
1355
1356 case EROFS:
1357 (void) zfs_error(hdl, EZFS_DSREADONLY, errbuf);
1358 break;
1359
1360 case ENOTSUP:
1361 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1362 "pool and or dataset must be upgraded to set this "
1363 "property or value"));
1364 (void) zfs_error(hdl, EZFS_BADVERSION, errbuf);
1365 break;
1366
1367 case ERANGE:
1368 if (prop == ZFS_PROP_COMPRESSION) {
1369 (void) zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1370 "property setting is not allowed on "
1371 "bootable datasets"));
1372 (void) zfs_error(hdl, EZFS_NOTSUP, errbuf);
1373 } else {
1374 (void) zfs_standard_error(hdl, err, errbuf);
1375 }
1376 break;
1377
1378 case EINVAL:
1379 if (prop == ZPROP_INVAL) {
1380 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1381 } else {
1382 (void) zfs_standard_error(hdl, err, errbuf);
1383 }
1384 break;
1385
1386 case EOVERFLOW:
1387 /*
1388 * This platform can't address a volume this big.
1389 */
1390 #ifdef _ILP32
1391 if (prop == ZFS_PROP_VOLSIZE) {
1392 (void) zfs_error(hdl, EZFS_VOLTOOBIG, errbuf);
1393 break;
1394 }
1395 #endif
1396 /* FALLTHROUGH */
1397 default:
1398 (void) zfs_standard_error(hdl, err, errbuf);
1399 }
1400 }
1401
1402 /*
1403 * Given a property name and value, set the property for the given dataset.
1404 */
1405 int
1406 zfs_prop_set(zfs_handle_t *zhp, const char *propname, const char *propval)
1407 {
1408 zfs_cmd_t zc = { 0 };
1409 int ret = -1;
1410 prop_changelist_t *cl = NULL;
1411 char errbuf[1024];
1412 libzfs_handle_t *hdl = zhp->zfs_hdl;
1413 nvlist_t *nvl = NULL, *realprops;
1414 zfs_prop_t prop;
1415 boolean_t do_prefix = B_TRUE;
1416 int added_resv;
1417
1418 (void) snprintf(errbuf, sizeof (errbuf),
1419 dgettext(TEXT_DOMAIN, "cannot set property for '%s'"),
1420 zhp->zfs_name);
1421
1422 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0 ||
1423 nvlist_add_string(nvl, propname, propval) != 0) {
1424 (void) no_memory(hdl);
1425 goto error;
1426 }
1427
1428 if ((realprops = zfs_valid_proplist(hdl, zhp->zfs_type, nvl,
1429 zfs_prop_get_int(zhp, ZFS_PROP_ZONED), zhp, errbuf)) == NULL)
1430 goto error;
1431
1432 nvlist_free(nvl);
1433 nvl = realprops;
1434
1435 prop = zfs_name_to_prop(propname);
1436
1437 if (prop == ZFS_PROP_VOLSIZE) {
1438 if ((added_resv = zfs_add_synthetic_resv(zhp, nvl)) == -1)
1439 goto error;
1440 }
1441
1442 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1443 goto error;
1444
1445 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1446 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1447 "child dataset with inherited mountpoint is used "
1448 "in a non-global zone"));
1449 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1450 goto error;
1451 }
1452
1453 /*
1454 * We don't want to unmount & remount the dataset when changing
1455 * its canmount property to 'on' or 'noauto'. We only use
1456 * the changelist logic to unmount when setting canmount=off.
1457 */
1458 if (prop == ZFS_PROP_CANMOUNT) {
1459 uint64_t idx;
1460 int err = zprop_string_to_index(prop, propval, &idx,
1461 ZFS_TYPE_DATASET);
1462 if (err == 0 && idx != ZFS_CANMOUNT_OFF)
1463 do_prefix = B_FALSE;
1464 }
1465
1466 if (do_prefix && (ret = changelist_prefix(cl)) != 0)
1467 goto error;
1468
1469 /*
1470 * Execute the corresponding ioctl() to set this property.
1471 */
1472 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1473
1474 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1475 goto error;
1476
1477 ret = zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1478
1479 if (ret != 0) {
1480 zfs_setprop_error(hdl, prop, errno, errbuf);
1481 if (added_resv && errno == ENOSPC) {
1482 /* clean up the volsize property we tried to set */
1483 uint64_t old_volsize = zfs_prop_get_int(zhp,
1484 ZFS_PROP_VOLSIZE);
1485 nvlist_free(nvl);
1486 zcmd_free_nvlists(&zc);
1487 if (nvlist_alloc(&nvl, NV_UNIQUE_NAME, 0) != 0)
1488 goto error;
1489 if (nvlist_add_uint64(nvl,
1490 zfs_prop_to_name(ZFS_PROP_VOLSIZE),
1491 old_volsize) != 0)
1492 goto error;
1493 if (zcmd_write_src_nvlist(hdl, &zc, nvl) != 0)
1494 goto error;
1495 (void) zfs_ioctl(hdl, ZFS_IOC_SET_PROP, &zc);
1496 }
1497 } else {
1498 if (do_prefix)
1499 ret = changelist_postfix(cl);
1500
1501 /*
1502 * Refresh the statistics so the new property value
1503 * is reflected.
1504 */
1505 if (ret == 0)
1506 (void) get_stats(zhp);
1507 }
1508
1509 error:
1510 nvlist_free(nvl);
1511 zcmd_free_nvlists(&zc);
1512 if (cl)
1513 changelist_free(cl);
1514 return (ret);
1515 }
1516
1517 /*
1518 * Given a property, inherit the value from the parent dataset, or if received
1519 * is TRUE, revert to the received value, if any.
1520 */
1521 int
1522 zfs_prop_inherit(zfs_handle_t *zhp, const char *propname, boolean_t received)
1523 {
1524 zfs_cmd_t zc = { 0 };
1525 int ret;
1526 prop_changelist_t *cl;
1527 libzfs_handle_t *hdl = zhp->zfs_hdl;
1528 char errbuf[1024];
1529 zfs_prop_t prop;
1530
1531 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
1532 "cannot inherit %s for '%s'"), propname, zhp->zfs_name);
1533
1534 zc.zc_cookie = received;
1535 if ((prop = zfs_name_to_prop(propname)) == ZPROP_INVAL) {
1536 /*
1537 * For user properties, the amount of work we have to do is very
1538 * small, so just do it here.
1539 */
1540 if (!zfs_prop_user(propname)) {
1541 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1542 "invalid property"));
1543 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
1544 }
1545
1546 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1547 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1548
1549 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc) != 0)
1550 return (zfs_standard_error(hdl, errno, errbuf));
1551
1552 return (0);
1553 }
1554
1555 /*
1556 * Verify that this property is inheritable.
1557 */
1558 if (zfs_prop_readonly(prop))
1559 return (zfs_error(hdl, EZFS_PROPREADONLY, errbuf));
1560
1561 if (!zfs_prop_inheritable(prop) && !received)
1562 return (zfs_error(hdl, EZFS_PROPNONINHERIT, errbuf));
1563
1564 /*
1565 * Check to see if the value applies to this type
1566 */
1567 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
1568 return (zfs_error(hdl, EZFS_PROPTYPE, errbuf));
1569
1570 /*
1571 * Normalize the name, to get rid of shorthand abbreviations.
1572 */
1573 propname = zfs_prop_to_name(prop);
1574 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1575 (void) strlcpy(zc.zc_value, propname, sizeof (zc.zc_value));
1576
1577 if (prop == ZFS_PROP_MOUNTPOINT && getzoneid() == GLOBAL_ZONEID &&
1578 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
1579 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1580 "dataset is used in a non-global zone"));
1581 return (zfs_error(hdl, EZFS_ZONED, errbuf));
1582 }
1583
1584 /*
1585 * Determine datasets which will be affected by this change, if any.
1586 */
1587 if ((cl = changelist_gather(zhp, prop, 0, 0)) == NULL)
1588 return (-1);
1589
1590 if (prop == ZFS_PROP_MOUNTPOINT && changelist_haszonedchild(cl)) {
1591 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1592 "child dataset with inherited mountpoint is used "
1593 "in a non-global zone"));
1594 ret = zfs_error(hdl, EZFS_ZONED, errbuf);
1595 goto error;
1596 }
1597
1598 if ((ret = changelist_prefix(cl)) != 0)
1599 goto error;
1600
1601 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_INHERIT_PROP, &zc)) != 0) {
1602 return (zfs_standard_error(hdl, errno, errbuf));
1603 } else {
1604
1605 if ((ret = changelist_postfix(cl)) != 0)
1606 goto error;
1607
1608 /*
1609 * Refresh the statistics so the new property is reflected.
1610 */
1611 (void) get_stats(zhp);
1612 }
1613
1614 error:
1615 changelist_free(cl);
1616 return (ret);
1617 }
1618
1619 /*
1620 * True DSL properties are stored in an nvlist. The following two functions
1621 * extract them appropriately.
1622 */
1623 static uint64_t
1624 getprop_uint64(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1625 {
1626 nvlist_t *nv;
1627 uint64_t value;
1628
1629 *source = NULL;
1630 if (nvlist_lookup_nvlist(zhp->zfs_props,
1631 zfs_prop_to_name(prop), &nv) == 0) {
1632 verify(nvlist_lookup_uint64(nv, ZPROP_VALUE, &value) == 0);
1633 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1634 } else {
1635 verify(!zhp->zfs_props_table ||
1636 zhp->zfs_props_table[prop] == B_TRUE);
1637 value = zfs_prop_default_numeric(prop);
1638 *source = "";
1639 }
1640
1641 return (value);
1642 }
1643
1644 static char *
1645 getprop_string(zfs_handle_t *zhp, zfs_prop_t prop, char **source)
1646 {
1647 nvlist_t *nv;
1648 char *value;
1649
1650 *source = NULL;
1651 if (nvlist_lookup_nvlist(zhp->zfs_props,
1652 zfs_prop_to_name(prop), &nv) == 0) {
1653 verify(nvlist_lookup_string(nv, ZPROP_VALUE, &value) == 0);
1654 (void) nvlist_lookup_string(nv, ZPROP_SOURCE, source);
1655 } else {
1656 verify(!zhp->zfs_props_table ||
1657 zhp->zfs_props_table[prop] == B_TRUE);
1658 if ((value = (char *)zfs_prop_default_string(prop)) == NULL)
1659 value = "";
1660 *source = "";
1661 }
1662
1663 return (value);
1664 }
1665
1666 static boolean_t
1667 zfs_is_recvd_props_mode(zfs_handle_t *zhp)
1668 {
1669 return (zhp->zfs_props == zhp->zfs_recvd_props);
1670 }
1671
1672 static void
1673 zfs_set_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1674 {
1675 *cookie = (uint64_t)(uintptr_t)zhp->zfs_props;
1676 zhp->zfs_props = zhp->zfs_recvd_props;
1677 }
1678
1679 static void
1680 zfs_unset_recvd_props_mode(zfs_handle_t *zhp, uint64_t *cookie)
1681 {
1682 zhp->zfs_props = (nvlist_t *)(uintptr_t)*cookie;
1683 *cookie = 0;
1684 }
1685
1686 /*
1687 * Internal function for getting a numeric property. Both zfs_prop_get() and
1688 * zfs_prop_get_int() are built using this interface.
1689 *
1690 * Certain properties can be overridden using 'mount -o'. In this case, scan
1691 * the contents of the /etc/mnttab entry, searching for the appropriate options.
1692 * If they differ from the on-disk values, report the current values and mark
1693 * the source "temporary".
1694 */
1695 static int
1696 get_numeric_property(zfs_handle_t *zhp, zfs_prop_t prop, zprop_source_t *src,
1697 char **source, uint64_t *val)
1698 {
1699 zfs_cmd_t zc = { 0 };
1700 nvlist_t *zplprops = NULL;
1701 struct mnttab mnt;
1702 char *mntopt_on = NULL;
1703 char *mntopt_off = NULL;
1704 boolean_t received = zfs_is_recvd_props_mode(zhp);
1705
1706 *source = NULL;
1707
1708 switch (prop) {
1709 case ZFS_PROP_ATIME:
1710 mntopt_on = MNTOPT_ATIME;
1711 mntopt_off = MNTOPT_NOATIME;
1712 break;
1713
1714 case ZFS_PROP_DEVICES:
1715 mntopt_on = MNTOPT_DEVICES;
1716 mntopt_off = MNTOPT_NODEVICES;
1717 break;
1718
1719 case ZFS_PROP_EXEC:
1720 mntopt_on = MNTOPT_EXEC;
1721 mntopt_off = MNTOPT_NOEXEC;
1722 break;
1723
1724 case ZFS_PROP_READONLY:
1725 mntopt_on = MNTOPT_RO;
1726 mntopt_off = MNTOPT_RW;
1727 break;
1728
1729 case ZFS_PROP_SETUID:
1730 mntopt_on = MNTOPT_SETUID;
1731 mntopt_off = MNTOPT_NOSETUID;
1732 break;
1733
1734 case ZFS_PROP_XATTR:
1735 mntopt_on = MNTOPT_XATTR;
1736 mntopt_off = MNTOPT_NOXATTR;
1737 break;
1738
1739 case ZFS_PROP_NBMAND:
1740 mntopt_on = MNTOPT_NBMAND;
1741 mntopt_off = MNTOPT_NONBMAND;
1742 break;
1743 }
1744
1745 /*
1746 * Because looking up the mount options is potentially expensive
1747 * (iterating over all of /etc/mnttab), we defer its calculation until
1748 * we're looking up a property which requires its presence.
1749 */
1750 if (!zhp->zfs_mntcheck &&
1751 (mntopt_on != NULL || prop == ZFS_PROP_MOUNTED)) {
1752 libzfs_handle_t *hdl = zhp->zfs_hdl;
1753 struct mnttab entry;
1754
1755 if (libzfs_mnttab_find(hdl, zhp->zfs_name, &entry) == 0) {
1756 zhp->zfs_mntopts = zfs_strdup(hdl,
1757 entry.mnt_mntopts);
1758 if (zhp->zfs_mntopts == NULL)
1759 return (-1);
1760 }
1761
1762 zhp->zfs_mntcheck = B_TRUE;
1763 }
1764
1765 if (zhp->zfs_mntopts == NULL)
1766 mnt.mnt_mntopts = "";
1767 else
1768 mnt.mnt_mntopts = zhp->zfs_mntopts;
1769
1770 switch (prop) {
1771 case ZFS_PROP_ATIME:
1772 case ZFS_PROP_DEVICES:
1773 case ZFS_PROP_EXEC:
1774 case ZFS_PROP_READONLY:
1775 case ZFS_PROP_SETUID:
1776 case ZFS_PROP_XATTR:
1777 case ZFS_PROP_NBMAND:
1778 *val = getprop_uint64(zhp, prop, source);
1779
1780 if (received)
1781 break;
1782
1783 if (hasmntopt(&mnt, mntopt_on) && !*val) {
1784 *val = B_TRUE;
1785 if (src)
1786 *src = ZPROP_SRC_TEMPORARY;
1787 } else if (hasmntopt(&mnt, mntopt_off) && *val) {
1788 *val = B_FALSE;
1789 if (src)
1790 *src = ZPROP_SRC_TEMPORARY;
1791 }
1792 break;
1793
1794 case ZFS_PROP_CANMOUNT:
1795 case ZFS_PROP_VOLSIZE:
1796 case ZFS_PROP_QUOTA:
1797 case ZFS_PROP_REFQUOTA:
1798 case ZFS_PROP_RESERVATION:
1799 case ZFS_PROP_REFRESERVATION:
1800 *val = getprop_uint64(zhp, prop, source);
1801
1802 if (*source == NULL) {
1803 /* not default, must be local */
1804 *source = zhp->zfs_name;
1805 }
1806 break;
1807
1808 case ZFS_PROP_MOUNTED:
1809 *val = (zhp->zfs_mntopts != NULL);
1810 break;
1811
1812 case ZFS_PROP_NUMCLONES:
1813 *val = zhp->zfs_dmustats.dds_num_clones;
1814 break;
1815
1816 case ZFS_PROP_VERSION:
1817 case ZFS_PROP_NORMALIZE:
1818 case ZFS_PROP_UTF8ONLY:
1819 case ZFS_PROP_CASE:
1820 if (zhp->zfs_hdl->libzfs_cachedprops) {
1821 return (zfs_error(zhp->zfs_hdl, EZFS_PROPCACHED,
1822 "property unavailable since not cached"));
1823 }
1824
1825 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
1826 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
1827 return (-1);
1828 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1829 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
1830 zcmd_free_nvlists(&zc);
1831 return (-1);
1832 }
1833 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
1834 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
1835 val) != 0) {
1836 zcmd_free_nvlists(&zc);
1837 return (-1);
1838 }
1839 if (zplprops)
1840 nvlist_free(zplprops);
1841 zcmd_free_nvlists(&zc);
1842 break;
1843
1844 default:
1845 switch (zfs_prop_get_type(prop)) {
1846 case PROP_TYPE_NUMBER:
1847 case PROP_TYPE_INDEX:
1848 *val = getprop_uint64(zhp, prop, source);
1849 /*
1850 * If we tried to use a default value for a
1851 * readonly property, it means that it was not
1852 * present.
1853 */
1854 if (zfs_prop_readonly(prop) &&
1855 *source != NULL && (*source)[0] == '\0') {
1856 *source = NULL;
1857 }
1858 break;
1859
1860 case PROP_TYPE_STRING:
1861 default:
1862 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
1863 "cannot get non-numeric property"));
1864 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
1865 dgettext(TEXT_DOMAIN, "internal error")));
1866 }
1867 }
1868
1869 return (0);
1870 }
1871
1872 /*
1873 * Calculate the source type, given the raw source string.
1874 */
1875 static void
1876 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
1877 char *statbuf, size_t statlen)
1878 {
1879 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
1880 return;
1881
1882 if (source == NULL) {
1883 *srctype = ZPROP_SRC_NONE;
1884 } else if (source[0] == '\0') {
1885 *srctype = ZPROP_SRC_DEFAULT;
1886 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
1887 *srctype = ZPROP_SRC_RECEIVED;
1888 } else {
1889 if (strcmp(source, zhp->zfs_name) == 0) {
1890 *srctype = ZPROP_SRC_LOCAL;
1891 } else {
1892 (void) strlcpy(statbuf, source, statlen);
1893 *srctype = ZPROP_SRC_INHERITED;
1894 }
1895 }
1896
1897 }
1898
1899 int
1900 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
1901 size_t proplen, boolean_t literal)
1902 {
1903 zfs_prop_t prop;
1904 int err = 0;
1905
1906 if (zhp->zfs_recvd_props == NULL)
1907 if (get_recvd_props_ioctl(zhp) != 0)
1908 return (-1);
1909
1910 prop = zfs_name_to_prop(propname);
1911
1912 if (prop != ZPROP_INVAL) {
1913 uint64_t cookie;
1914 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
1915 return (-1);
1916 zfs_set_recvd_props_mode(zhp, &cookie);
1917 err = zfs_prop_get(zhp, prop, propbuf, proplen,
1918 NULL, NULL, 0, literal);
1919 zfs_unset_recvd_props_mode(zhp, &cookie);
1920 } else {
1921 nvlist_t *propval;
1922 char *recvdval;
1923 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
1924 propname, &propval) != 0)
1925 return (-1);
1926 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
1927 &recvdval) == 0);
1928 (void) strlcpy(propbuf, recvdval, proplen);
1929 }
1930
1931 return (err == 0 ? 0 : -1);
1932 }
1933
1934 static int
1935 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
1936 {
1937 nvlist_t *value;
1938 nvpair_t *pair;
1939
1940 value = zfs_get_clones_nvl(zhp);
1941 if (value == NULL)
1942 return (-1);
1943
1944 propbuf[0] = '\0';
1945 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
1946 pair = nvlist_next_nvpair(value, pair)) {
1947 if (propbuf[0] != '\0')
1948 (void) strlcat(propbuf, ",", proplen);
1949 (void) strlcat(propbuf, nvpair_name(pair), proplen);
1950 }
1951
1952 return (0);
1953 }
1954
1955 struct get_clones_arg {
1956 uint64_t numclones;
1957 nvlist_t *value;
1958 const char *origin;
1959 char buf[ZFS_MAXNAMELEN];
1960 };
1961
1962 int
1963 get_clones_cb(zfs_handle_t *zhp, void *arg)
1964 {
1965 struct get_clones_arg *gca = arg;
1966
1967 if (gca->numclones == 0) {
1968 zfs_close(zhp);
1969 return (0);
1970 }
1971
1972 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
1973 NULL, NULL, 0, B_TRUE) != 0)
1974 goto out;
1975 if (strcmp(gca->buf, gca->origin) == 0) {
1976 if (nvlist_add_boolean(gca->value, zfs_get_name(zhp)) != 0) {
1977 zfs_close(zhp);
1978 return (no_memory(zhp->zfs_hdl));
1979 }
1980 gca->numclones--;
1981 }
1982
1983 out:
1984 (void) zfs_iter_children(zhp, get_clones_cb, gca);
1985 zfs_close(zhp);
1986 return (0);
1987 }
1988
1989 nvlist_t *
1990 zfs_get_clones_nvl(zfs_handle_t *zhp)
1991 {
1992 nvlist_t *nv, *value;
1993
1994 if (nvlist_lookup_nvlist(zhp->zfs_props,
1995 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
1996 struct get_clones_arg gca;
1997
1998 /*
1999 * if this is a snapshot, then the kernel wasn't able
2000 * to get the clones. Do it by slowly iterating.
2001 */
2002 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2003 return (NULL);
2004 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2005 return (NULL);
2006 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2007 nvlist_free(nv);
2008 return (NULL);
2009 }
2010
2011 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2012 gca.value = value;
2013 gca.origin = zhp->zfs_name;
2014
2015 if (gca.numclones != 0) {
2016 zfs_handle_t *root;
2017 char pool[ZFS_MAXNAMELEN];
2018 char *cp = pool;
2019
2020 /* get the pool name */
2021 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2022 (void) strsep(&cp, "/@");
2023 root = zfs_open(zhp->zfs_hdl, pool,
2024 ZFS_TYPE_FILESYSTEM);
2025
2026 (void) get_clones_cb(root, &gca);
2027 }
2028
2029 if (gca.numclones != 0 ||
2030 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2031 nvlist_add_nvlist(zhp->zfs_props,
2032 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2033 nvlist_free(nv);
2034 nvlist_free(value);
2035 return (NULL);
2036 }
2037 nvlist_free(nv);
2038 nvlist_free(value);
2039 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2040 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2041 }
2042
2043 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2044
2045 return (value);
2046 }
2047
2048 /*
2049 * Retrieve a property from the given object. If 'literal' is specified, then
2050 * numbers are left as exact values. Otherwise, numbers are converted to a
2051 * human-readable form.
2052 *
2053 * Returns 0 on success, or -1 on error.
2054 */
2055 int
2056 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2057 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2058 {
2059 char *source = NULL;
2060 uint64_t val;
2061 char *str;
2062 const char *strval;
2063 boolean_t received = zfs_is_recvd_props_mode(zhp);
2064 boolean_t printerr;
2065
2066 /*
2067 * Check to see if this property applies to our object
2068 */
2069 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2070 return (-1);
2071
2072 if (received && zfs_prop_readonly(prop))
2073 return (-1);
2074
2075 if (zhp->zfs_hdl->libzfs_cachedprops &&
2076 zfs_prop_cacheable(prop)) {
2077 printerr = zhp->zfs_hdl->libzfs_printerr;
2078 libzfs_print_on_error(zhp->zfs_hdl, B_FALSE);
2079 (void) zfs_error(zhp->zfs_hdl, EZFS_PROPCACHED,
2080 "property unavailable since not cached");
2081 libzfs_print_on_error(zhp->zfs_hdl, printerr);
2082 return (-1);
2083 }
2084
2085 if (src)
2086 *src = ZPROP_SRC_NONE;
2087
2088 switch (prop) {
2089 case ZFS_PROP_CREATION:
2090 /*
2091 * 'creation' is a time_t stored in the statistics. We convert
2092 * this into a string unless 'literal' is specified.
2093 */
2094 {
2095 val = getprop_uint64(zhp, prop, &source);
2096 time_t time = (time_t)val;
2097 struct tm t;
2098
2099 if (literal ||
2100 localtime_r(&time, &t) == NULL ||
2101 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2102 &t) == 0)
2103 (void) snprintf(propbuf, proplen, "%llu", val);
2104 }
2105 break;
2106
2107 case ZFS_PROP_MOUNTPOINT:
2108 /*
2109 * Getting the precise mountpoint can be tricky.
2110 *
2111 * - for 'none' or 'legacy', return those values.
2112 * - for inherited mountpoints, we want to take everything
2113 * after our ancestor and append it to the inherited value.
2114 *
2115 * If the pool has an alternate root, we want to prepend that
2116 * root to any values we return.
2117 */
2118
2119 str = getprop_string(zhp, prop, &source);
2120
2121 if (str[0] == '/') {
2122 char buf[MAXPATHLEN];
2123 char *root = buf;
2124 const char *relpath;
2125
2126 /*
2127 * If we inherit the mountpoint, even from a dataset
2128 * with a received value, the source will be the path of
2129 * the dataset we inherit from. If source is
2130 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2131 * inherited.
2132 */
2133 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2134 relpath = "";
2135 } else {
2136 relpath = zhp->zfs_name + strlen(source);
2137 if (relpath[0] == '/')
2138 relpath++;
2139 }
2140
2141 if ((zpool_get_prop(zhp->zpool_hdl,
2142 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2143 B_FALSE)) || (strcmp(root, "-") == 0))
2144 root[0] = '\0';
2145 /*
2146 * Special case an alternate root of '/'. This will
2147 * avoid having multiple leading slashes in the
2148 * mountpoint path.
2149 */
2150 if (strcmp(root, "/") == 0)
2151 root++;
2152
2153 /*
2154 * If the mountpoint is '/' then skip over this
2155 * if we are obtaining either an alternate root or
2156 * an inherited mountpoint.
2157 */
2158 if (str[1] == '\0' && (root[0] != '\0' ||
2159 relpath[0] != '\0'))
2160 str++;
2161
2162 if (relpath[0] == '\0')
2163 (void) snprintf(propbuf, proplen, "%s%s",
2164 root, str);
2165 else
2166 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2167 root, str, relpath[0] == '@' ? "" : "/",
2168 relpath);
2169 } else {
2170 /* 'legacy' or 'none' */
2171 (void) strlcpy(propbuf, str, proplen);
2172 }
2173
2174 break;
2175
2176 case ZFS_PROP_ORIGIN:
2177 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source),
2178 proplen);
2179 /*
2180 * If there is no parent at all, return failure to indicate that
2181 * it doesn't apply to this dataset.
2182 */
2183 if (propbuf[0] == '\0')
2184 return (-1);
2185 break;
2186
2187 case ZFS_PROP_CLONES:
2188 if (get_clones_string(zhp, propbuf, proplen) != 0)
2189 return (-1);
2190 break;
2191
2192 case ZFS_PROP_QUOTA:
2193 case ZFS_PROP_REFQUOTA:
2194 case ZFS_PROP_RESERVATION:
2195 case ZFS_PROP_REFRESERVATION:
2196
2197 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2198 return (-1);
2199
2200 /*
2201 * If quota or reservation is 0, we translate this into 'none'
2202 * (unless literal is set), and indicate that it's the default
2203 * value. Otherwise, we print the number nicely and indicate
2204 * that its set locally.
2205 */
2206 if (val == 0) {
2207 if (literal)
2208 (void) strlcpy(propbuf, "0", proplen);
2209 else
2210 (void) strlcpy(propbuf, "none", proplen);
2211 } else {
2212 if (literal)
2213 (void) snprintf(propbuf, proplen, "%llu",
2214 (u_longlong_t)val);
2215 else
2216 zfs_nicenum(val, propbuf, proplen);
2217 }
2218 break;
2219
2220 case ZFS_PROP_REFRATIO:
2221 case ZFS_PROP_COMPRESSRATIO:
2222 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2223 return (-1);
2224 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2225 (u_longlong_t)(val / 100),
2226 (u_longlong_t)(val % 100));
2227 break;
2228
2229 case ZFS_PROP_TYPE:
2230 switch (zhp->zfs_type) {
2231 case ZFS_TYPE_FILESYSTEM:
2232 str = "filesystem";
2233 break;
2234 case ZFS_TYPE_VOLUME:
2235 str = "volume";
2236 break;
2237 case ZFS_TYPE_SNAPSHOT:
2238 str = "snapshot";
2239 break;
2240 default:
2241 abort();
2242 }
2243 (void) snprintf(propbuf, proplen, "%s", str);
2244 break;
2245
2246 case ZFS_PROP_MOUNTED:
2247 /*
2248 * The 'mounted' property is a pseudo-property that described
2249 * whether the filesystem is currently mounted. Even though
2250 * it's a boolean value, the typical values of "on" and "off"
2251 * don't make sense, so we translate to "yes" and "no".
2252 */
2253 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2254 src, &source, &val) != 0)
2255 return (-1);
2256 if (val)
2257 (void) strlcpy(propbuf, "yes", proplen);
2258 else
2259 (void) strlcpy(propbuf, "no", proplen);
2260 break;
2261
2262 case ZFS_PROP_NAME:
2263 /*
2264 * The 'name' property is a pseudo-property derived from the
2265 * dataset name. It is presented as a real property to simplify
2266 * consumers.
2267 */
2268 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2269 break;
2270
2271 case ZFS_PROP_MLSLABEL:
2272 {
2273 m_label_t *new_sl = NULL;
2274 char *ascii = NULL; /* human readable label */
2275
2276 (void) strlcpy(propbuf,
2277 getprop_string(zhp, prop, &source), proplen);
2278
2279 if (literal || (strcasecmp(propbuf,
2280 ZFS_MLSLABEL_DEFAULT) == 0))
2281 break;
2282
2283 /*
2284 * Try to translate the internal hex string to
2285 * human-readable output. If there are any
2286 * problems just use the hex string.
2287 */
2288
2289 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2290 L_NO_CORRECTION, NULL) == -1) {
2291 m_label_free(new_sl);
2292 break;
2293 }
2294
2295 if (label_to_str(new_sl, &ascii, M_LABEL,
2296 DEF_NAMES) != 0) {
2297 if (ascii)
2298 free(ascii);
2299 m_label_free(new_sl);
2300 break;
2301 }
2302 m_label_free(new_sl);
2303
2304 (void) strlcpy(propbuf, ascii, proplen);
2305 free(ascii);
2306 }
2307 break;
2308
2309 case ZFS_PROP_GUID:
2310 /*
2311 * GUIDs are stored as numbers, but they are identifiers.
2312 * We don't want them to be pretty printed, because pretty
2313 * printing mangles the ID into a truncated and useless value.
2314 */
2315 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2316 return (-1);
2317 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2318 break;
2319
2320 default:
2321 switch (zfs_prop_get_type(prop)) {
2322 case PROP_TYPE_NUMBER:
2323 if (get_numeric_property(zhp, prop, src,
2324 &source, &val) != 0)
2325 return (-1);
2326 if (literal)
2327 (void) snprintf(propbuf, proplen, "%llu",
2328 (u_longlong_t)val);
2329 else
2330 zfs_nicenum(val, propbuf, proplen);
2331 break;
2332
2333 case PROP_TYPE_STRING:
2334 (void) strlcpy(propbuf,
2335 getprop_string(zhp, prop, &source), proplen);
2336 break;
2337
2338 case PROP_TYPE_INDEX:
2339 if (get_numeric_property(zhp, prop, src,
2340 &source, &val) != 0)
2341 return (-1);
2342 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2343 return (-1);
2344 (void) strlcpy(propbuf, strval, proplen);
2345 break;
2346
2347 default:
2348 abort();
2349 }
2350 }
2351
2352 get_source(zhp, src, source, statbuf, statlen);
2353
2354 return (0);
2355 }
2356
2357 /*
2358 * Utility function to get the given numeric property. Does no validation that
2359 * the given property is the appropriate type; should only be used with
2360 * hard-coded property types.
2361 */
2362 uint64_t
2363 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2364 {
2365 char *source;
2366 uint64_t val;
2367
2368 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2369
2370 return (val);
2371 }
2372
2373 int
2374 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2375 {
2376 char buf[64];
2377
2378 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2379 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2380 }
2381
2382 /*
2383 * Similar to zfs_prop_get(), but returns the value as an integer.
2384 */
2385 int
2386 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2387 zprop_source_t *src, char *statbuf, size_t statlen)
2388 {
2389 char *source;
2390
2391 /*
2392 * Check to see if this property applies to our object
2393 */
2394 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2395 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2396 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2397 zfs_prop_to_name(prop)));
2398 }
2399
2400 if (src)
2401 *src = ZPROP_SRC_NONE;
2402
2403 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2404 return (-1);
2405
2406 get_source(zhp, src, source, statbuf, statlen);
2407
2408 return (0);
2409 }
2410
2411 static int
2412 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2413 char **domainp, idmap_rid_t *ridp)
2414 {
2415 idmap_get_handle_t *get_hdl = NULL;
2416 idmap_stat status;
2417 int err = EINVAL;
2418
2419 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2420 goto out;
2421
2422 if (isuser) {
2423 err = idmap_get_sidbyuid(get_hdl, id,
2424 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2425 } else {
2426 err = idmap_get_sidbygid(get_hdl, id,
2427 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2428 }
2429 if (err == IDMAP_SUCCESS &&
2430 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2431 status == IDMAP_SUCCESS)
2432 err = 0;
2433 else
2434 err = EINVAL;
2435 out:
2436 if (get_hdl)
2437 idmap_get_destroy(get_hdl);
2438 return (err);
2439 }
2440
2441 /*
2442 * convert the propname into parameters needed by kernel
2443 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2444 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2445 */
2446 static int
2447 userquota_propname_decode(const char *propname, boolean_t zoned,
2448 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2449 {
2450 zfs_userquota_prop_t type;
2451 char *cp, *end;
2452 char *numericsid = NULL;
2453 boolean_t isuser;
2454
2455 domain[0] = '\0';
2456
2457 /* Figure out the property type ({user|group}{quota|space}) */
2458 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2459 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2460 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2461 break;
2462 }
2463 if (type == ZFS_NUM_USERQUOTA_PROPS)
2464 return (EINVAL);
2465 *typep = type;
2466
2467 isuser = (type == ZFS_PROP_USERQUOTA ||
2468 type == ZFS_PROP_USERUSED);
2469
2470 cp = strchr(propname, '@') + 1;
2471
2472 if (strchr(cp, '@')) {
2473 /*
2474 * It's a SID name (eg "user@domain") that needs to be
2475 * turned into S-1-domainID-RID.
2476 */
2477 directory_error_t e;
2478 if (zoned && getzoneid() == GLOBAL_ZONEID)
2479 return (ENOENT);
2480 if (isuser) {
2481 e = directory_sid_from_user_name(NULL,
2482 cp, &numericsid);
2483 } else {
2484 e = directory_sid_from_group_name(NULL,
2485 cp, &numericsid);
2486 }
2487 if (e != NULL) {
2488 directory_error_free(e);
2489 return (ENOENT);
2490 }
2491 if (numericsid == NULL)
2492 return (ENOENT);
2493 cp = numericsid;
2494 /* will be further decoded below */
2495 }
2496
2497 if (strncmp(cp, "S-1-", 4) == 0) {
2498 /* It's a numeric SID (eg "S-1-234-567-89") */
2499 (void) strlcpy(domain, cp, domainlen);
2500 cp = strrchr(domain, '-');
2501 *cp = '\0';
2502 cp++;
2503
2504 errno = 0;
2505 *ridp = strtoull(cp, &end, 10);
2506 if (numericsid) {
2507 free(numericsid);
2508 numericsid = NULL;
2509 }
2510 if (errno != 0 || *end != '\0')
2511 return (EINVAL);
2512 } else if (!isdigit(*cp)) {
2513 /*
2514 * It's a user/group name (eg "user") that needs to be
2515 * turned into a uid/gid
2516 */
2517 if (zoned && getzoneid() == GLOBAL_ZONEID)
2518 return (ENOENT);
2519 if (isuser) {
2520 struct passwd *pw;
2521 pw = getpwnam(cp);
2522 if (pw == NULL)
2523 return (ENOENT);
2524 *ridp = pw->pw_uid;
2525 } else {
2526 struct group *gr;
2527 gr = getgrnam(cp);
2528 if (gr == NULL)
2529 return (ENOENT);
2530 *ridp = gr->gr_gid;
2531 }
2532 } else {
2533 /* It's a user/group ID (eg "12345"). */
2534 uid_t id = strtoul(cp, &end, 10);
2535 idmap_rid_t rid;
2536 char *mapdomain;
2537
2538 if (*end != '\0')
2539 return (EINVAL);
2540 if (id > MAXUID) {
2541 /* It's an ephemeral ID. */
2542 if (idmap_id_to_numeric_domain_rid(id, isuser,
2543 &mapdomain, &rid) != 0)
2544 return (ENOENT);
2545 (void) strlcpy(domain, mapdomain, domainlen);
2546 *ridp = rid;
2547 } else {
2548 *ridp = id;
2549 }
2550 }
2551
2552 ASSERT3P(numericsid, ==, NULL);
2553 return (0);
2554 }
2555
2556 static int
2557 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2558 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2559 {
2560 int err;
2561 zfs_cmd_t zc = { 0 };
2562
2563 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2564
2565 err = userquota_propname_decode(propname,
2566 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2567 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2568 zc.zc_objset_type = *typep;
2569 if (err)
2570 return (err);
2571
2572 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2573 if (err)
2574 return (err);
2575
2576 *propvalue = zc.zc_cookie;
2577 return (0);
2578 }
2579
2580 int
2581 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2582 uint64_t *propvalue)
2583 {
2584 zfs_userquota_prop_t type;
2585
2586 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2587 &type));
2588 }
2589
2590 int
2591 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2592 char *propbuf, int proplen, boolean_t literal)
2593 {
2594 int err;
2595 uint64_t propvalue;
2596 zfs_userquota_prop_t type;
2597
2598 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2599 &type);
2600
2601 if (err)
2602 return (err);
2603
2604 if (literal) {
2605 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2606 } else if (propvalue == 0 &&
2607 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2608 (void) strlcpy(propbuf, "none", proplen);
2609 } else {
2610 zfs_nicenum(propvalue, propbuf, proplen);
2611 }
2612 return (0);
2613 }
2614
2615 int
2616 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2617 uint64_t *propvalue)
2618 {
2619 int err;
2620 zfs_cmd_t zc = { 0 };
2621 const char *snapname;
2622
2623 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2624
2625 snapname = strchr(propname, '@') + 1;
2626 if (strchr(snapname, '@')) {
2627 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2628 } else {
2629 /* snapname is the short name, append it to zhp's fsname */
2630 char *cp;
2631
2632 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2633 sizeof (zc.zc_value));
2634 cp = strchr(zc.zc_value, '@');
2635 if (cp != NULL)
2636 *cp = '\0';
2637 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2638 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2639 }
2640
2641 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2642 if (err)
2643 return (err);
2644
2645 *propvalue = zc.zc_cookie;
2646 return (0);
2647 }
2648
2649 int
2650 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2651 char *propbuf, int proplen, boolean_t literal)
2652 {
2653 int err;
2654 uint64_t propvalue;
2655
2656 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2657
2658 if (err)
2659 return (err);
2660
2661 if (literal) {
2662 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2663 } else {
2664 zfs_nicenum(propvalue, propbuf, proplen);
2665 }
2666 return (0);
2667 }
2668
2669 /*
2670 * Returns the name of the given zfs handle.
2671 */
2672 const char *
2673 zfs_get_name(const zfs_handle_t *zhp)
2674 {
2675 return (zhp->zfs_name);
2676 }
2677
2678 /*
2679 * Returns the type of the given zfs handle.
2680 */
2681 zfs_type_t
2682 zfs_get_type(const zfs_handle_t *zhp)
2683 {
2684 return (zhp->zfs_type);
2685 }
2686
2687 /*
2688 * Is one dataset name a child dataset of another?
2689 *
2690 * Needs to handle these cases:
2691 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2692 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2693 * Descendant? No. No. No. Yes.
2694 */
2695 static boolean_t
2696 is_descendant(const char *ds1, const char *ds2)
2697 {
2698 size_t d1len = strlen(ds1);
2699
2700 /* ds2 can't be a descendant if it's smaller */
2701 if (strlen(ds2) < d1len)
2702 return (B_FALSE);
2703
2704 /* otherwise, compare strings and verify that there's a '/' char */
2705 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2706 }
2707
2708 /*
2709 * Given a complete name, return just the portion that refers to the parent.
2710 * Will return -1 if there is no parent (path is just the name of the
2711 * pool).
2712 */
2713 static int
2714 parent_name(const char *path, char *buf, size_t buflen)
2715 {
2716 char *slashp;
2717
2718 (void) strlcpy(buf, path, buflen);
2719
2720 if ((slashp = strrchr(buf, '/')) == NULL)
2721 return (-1);
2722 *slashp = '\0';
2723
2724 return (0);
2725 }
2726
2727 /*
2728 * If accept_ancestor is false, then check to make sure that the given path has
2729 * a parent, and that it exists. If accept_ancestor is true, then find the
2730 * closest existing ancestor for the given path. In prefixlen return the
2731 * length of already existing prefix of the given path. We also fetch the
2732 * 'zoned' property, which is used to validate property settings when creating
2733 * new datasets.
2734 */
2735 static int
2736 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
2737 boolean_t accept_ancestor, int *prefixlen)
2738 {
2739 zfs_cmd_t zc = { 0 };
2740 char parent[ZFS_MAXNAMELEN];
2741 char *slash;
2742 zfs_handle_t *zhp;
2743 char errbuf[1024];
2744 uint64_t is_zoned;
2745
2746 (void) snprintf(errbuf, sizeof (errbuf),
2747 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
2748
2749 /* get parent, and check to see if this is just a pool */
2750 if (parent_name(path, parent, sizeof (parent)) != 0) {
2751 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2752 "missing dataset name"));
2753 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2754 }
2755
2756 /* check to see if the pool exists */
2757 if ((slash = strchr(parent, '/')) == NULL)
2758 slash = parent + strlen(parent);
2759 (void) strncpy(zc.zc_name, parent, slash - parent);
2760 zc.zc_name[slash - parent] = '\0';
2761 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
2762 errno == ENOENT) {
2763 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2764 "no such pool '%s'"), zc.zc_name);
2765 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2766 }
2767
2768 /* check to see if the parent dataset exists */
2769 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
2770 if (errno == ENOENT && accept_ancestor) {
2771 /*
2772 * Go deeper to find an ancestor, give up on top level.
2773 */
2774 if (parent_name(parent, parent, sizeof (parent)) != 0) {
2775 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2776 "no such pool '%s'"), zc.zc_name);
2777 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2778 }
2779 } else if (errno == ENOENT) {
2780 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2781 "parent does not exist"));
2782 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2783 } else
2784 return (zfs_standard_error(hdl, errno, errbuf));
2785 }
2786
2787 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
2788 if (zoned != NULL)
2789 *zoned = is_zoned;
2790
2791 /* we are in a non-global zone, but parent is in the global zone */
2792 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
2793 (void) zfs_standard_error(hdl, EPERM, errbuf);
2794 zfs_close(zhp);
2795 return (-1);
2796 }
2797
2798 /* make sure parent is a filesystem */
2799 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
2800 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2801 "parent is not a filesystem"));
2802 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
2803 zfs_close(zhp);
2804 return (-1);
2805 }
2806
2807 zfs_close(zhp);
2808 if (prefixlen != NULL)
2809 *prefixlen = strlen(parent);
2810 return (0);
2811 }
2812
2813 /*
2814 * Finds whether the dataset of the given type(s) exists.
2815 */
2816 boolean_t
2817 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
2818 {
2819 zfs_handle_t *zhp;
2820
2821 if (!zfs_validate_name(hdl, path, types, B_FALSE))
2822 return (B_FALSE);
2823
2824 /*
2825 * Try to get stats for the dataset, which will tell us if it exists.
2826 */
2827 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
2828 int ds_type = zhp->zfs_type;
2829
2830 zfs_close(zhp);
2831 if (types & ds_type)
2832 return (B_TRUE);
2833 }
2834 return (B_FALSE);
2835 }
2836
2837 /*
2838 * Given a path to 'target', create all the ancestors between
2839 * the prefixlen portion of the path, and the target itself.
2840 * Fail if the initial prefixlen-ancestor does not already exist.
2841 */
2842 int
2843 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
2844 {
2845 zfs_handle_t *h;
2846 char *cp;
2847 const char *opname;
2848
2849 /* make sure prefix exists */
2850 cp = target + prefixlen;
2851 if (*cp != '/') {
2852 assert(strchr(cp, '/') == NULL);
2853 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2854 } else {
2855 *cp = '\0';
2856 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2857 *cp = '/';
2858 }
2859 if (h == NULL)
2860 return (-1);
2861 zfs_close(h);
2862
2863 /*
2864 * Attempt to create, mount, and share any ancestor filesystems,
2865 * up to the prefixlen-long one.
2866 */
2867 for (cp = target + prefixlen + 1;
2868 cp = strchr(cp, '/'); *cp = '/', cp++) {
2869
2870 *cp = '\0';
2871
2872 h = make_dataset_handle(hdl, target);
2873 if (h) {
2874 /* it already exists, nothing to do here */
2875 zfs_close(h);
2876 continue;
2877 }
2878
2879 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
2880 NULL) != 0) {
2881 opname = dgettext(TEXT_DOMAIN, "create");
2882 goto ancestorerr;
2883 }
2884
2885 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2886 if (h == NULL) {
2887 opname = dgettext(TEXT_DOMAIN, "open");
2888 goto ancestorerr;
2889 }
2890
2891 if (zfs_mount(h, NULL, 0) != 0) {
2892 opname = dgettext(TEXT_DOMAIN, "mount");
2893 goto ancestorerr;
2894 }
2895
2896 if (zfs_share(h) != 0) {
2897 opname = dgettext(TEXT_DOMAIN, "share");
2898 goto ancestorerr;
2899 }
2900
2901 zfs_close(h);
2902 }
2903
2904 return (0);
2905
2906 ancestorerr:
2907 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2908 "failed to %s ancestor '%s'"), opname, target);
2909 return (-1);
2910 }
2911
2912 /*
2913 * Creates non-existing ancestors of the given path.
2914 */
2915 int
2916 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
2917 {
2918 int prefix;
2919 char *path_copy;
2920 int rc;
2921
2922 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
2923 return (-1);
2924
2925 if ((path_copy = strdup(path)) != NULL) {
2926 rc = create_parents(hdl, path_copy, prefix);
2927 free(path_copy);
2928 }
2929 if (path_copy == NULL || rc != 0)
2930 return (-1);
2931
2932 return (0);
2933 }
2934
2935 /*
2936 * Create a new filesystem or volume.
2937 */
2938 int
2939 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
2940 nvlist_t *props)
2941 {
2942 int ret;
2943 uint64_t size = 0;
2944 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
2945 char errbuf[1024];
2946 uint64_t zoned;
2947 dmu_objset_type_t ost;
2948
2949 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
2950 "cannot create '%s'"), path);
2951
2952 /* validate the path, taking care to note the extended error message */
2953 if (!zfs_validate_name(hdl, path, type, B_TRUE))
2954 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2955
2956 /* validate parents exist */
2957 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
2958 return (-1);
2959
2960 /*
2961 * The failure modes when creating a dataset of a different type over
2962 * one that already exists is a little strange. In particular, if you
2963 * try to create a dataset on top of an existing dataset, the ioctl()
2964 * will return ENOENT, not EEXIST. To prevent this from happening, we
2965 * first try to see if the dataset exists.
2966 */
2967 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
2968 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2969 "dataset already exists"));
2970 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
2971 }
2972
2973 if (type == ZFS_TYPE_VOLUME)
2974 ost = DMU_OST_ZVOL;
2975 else
2976 ost = DMU_OST_ZFS;
2977
2978 if (props && (props = zfs_valid_proplist(hdl, type, props,
2979 zoned, NULL, errbuf)) == 0)
2980 return (-1);
2981
2982 if (type == ZFS_TYPE_VOLUME) {
2983 /*
2984 * If we are creating a volume, the size and block size must
2985 * satisfy a few restraints. First, the blocksize must be a
2986 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
2987 * volsize must be a multiple of the block size, and cannot be
2988 * zero.
2989 */
2990 if (props == NULL || nvlist_lookup_uint64(props,
2991 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
2992 nvlist_free(props);
2993 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2994 "missing volume size"));
2995 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
2996 }
2997
2998 if ((ret = nvlist_lookup_uint64(props,
2999 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3000 &blocksize)) != 0) {
3001 if (ret == ENOENT) {
3002 blocksize = zfs_prop_default_numeric(
3003 ZFS_PROP_VOLBLOCKSIZE);
3004 } else {
3005 nvlist_free(props);
3006 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3007 "missing volume block size"));
3008 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3009 }
3010 }
3011
3012 if (size == 0) {
3013 nvlist_free(props);
3014 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3015 "volume size cannot be zero"));
3016 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3017 }
3018
3019 if (size % blocksize != 0) {
3020 nvlist_free(props);
3021 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3022 "volume size must be a multiple of volume block "
3023 "size"));
3024 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3025 }
3026 }
3027
3028 /* create the dataset */
3029 ret = lzc_create(path, ost, props);
3030 nvlist_free(props);
3031
3032 /* check for failure */
3033 if (ret != 0) {
3034 char parent[ZFS_MAXNAMELEN];
3035 (void) parent_name(path, parent, sizeof (parent));
3036
3037 switch (errno) {
3038 case ENOENT:
3039 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3040 "no such parent '%s'"), parent);
3041 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3042
3043 case EINVAL:
3044 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3045 "parent '%s' is not a filesystem"), parent);
3046 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3047
3048 case EDOM:
3049 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3050 "volume block size must be power of 2 from "
3051 "%u to %uk"),
3052 (uint_t)SPA_MINBLOCKSIZE,
3053 (uint_t)SPA_MAXBLOCKSIZE >> 10);
3054
3055 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3056
3057 case ENOTSUP:
3058 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3059 "pool must be upgraded to set this "
3060 "property or value"));
3061 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3062 #ifdef _ILP32
3063 case EOVERFLOW:
3064 /*
3065 * This platform can't address a volume this big.
3066 */
3067 if (type == ZFS_TYPE_VOLUME)
3068 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3069 errbuf));
3070 #endif
3071 /* FALLTHROUGH */
3072 default:
3073 return (zfs_standard_error(hdl, errno, errbuf));
3074 }
3075 }
3076
3077 return (0);
3078 }
3079
3080 /*
3081 * Destroys the given dataset. The caller must make sure that the filesystem
3082 * isn't mounted, and that there are no active dependents. If the file system
3083 * does not exist this function does nothing.
3084 */
3085 int
3086 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3087 {
3088 zfs_cmd_t zc = { 0 };
3089
3090 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3091
3092 if (ZFS_IS_VOLUME(zhp)) {
3093 zc.zc_objset_type = DMU_OST_ZVOL;
3094 } else {
3095 zc.zc_objset_type = DMU_OST_ZFS;
3096 }
3097
3098 zc.zc_defer_destroy = defer;
3099 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3100 errno != ENOENT) {
3101 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3102 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3103 zhp->zfs_name));
3104 }
3105
3106 remove_mountpoint(zhp);
3107
3108 return (0);
3109 }
3110
3111 struct destroydata {
3112 nvlist_t *nvl;
3113 const char *snapname;
3114 };
3115
3116 static int
3117 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3118 {
3119 struct destroydata *dd = arg;
3120 zfs_handle_t *szhp;
3121 char name[ZFS_MAXNAMELEN];
3122 int rv = 0;
3123
3124 (void) snprintf(name, sizeof (name),
3125 "%s@%s", zhp->zfs_name, dd->snapname);
3126
3127 szhp = make_dataset_handle(zhp->zfs_hdl, name);
3128 if (szhp) {
3129 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3130 zfs_close(szhp);
3131 }
3132
3133 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3134 zfs_close(zhp);
3135 return (rv);
3136 }
3137
3138 /*
3139 * Destroys all snapshots with the given name in zhp & descendants.
3140 */
3141 int
3142 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3143 {
3144 int ret;
3145 struct destroydata dd = { 0 };
3146
3147 dd.snapname = snapname;
3148 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3149 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3150
3151 if (nvlist_next_nvpair(dd.nvl, NULL) == NULL) {
3152 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3153 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3154 zhp->zfs_name, snapname);
3155 } else {
3156 ret = zfs_destroy_snaps_nvl(zhp, dd.nvl, defer);
3157 }
3158 nvlist_free(dd.nvl);
3159 return (ret);
3160 }
3161
3162 /*
3163 * Destroys all the snapshots named in the nvlist. They must be underneath
3164 * the zhp (either snapshots of it, or snapshots of its descendants).
3165 */
3166 int
3167 zfs_destroy_snaps_nvl(zfs_handle_t *zhp, nvlist_t *snaps, boolean_t defer)
3168 {
3169 int ret;
3170 nvlist_t *errlist;
3171
3172 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3173
3174 if (ret != 0) {
3175 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3176 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3177 char errbuf[1024];
3178 (void) snprintf(errbuf, sizeof (errbuf),
3179 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3180 nvpair_name(pair));
3181
3182 switch (fnvpair_value_int32(pair)) {
3183 case EEXIST:
3184 zfs_error_aux(zhp->zfs_hdl,
3185 dgettext(TEXT_DOMAIN,
3186 "snapshot is cloned"));
3187 ret = zfs_error(zhp->zfs_hdl, EZFS_EXISTS,
3188 errbuf);
3189 break;
3190 default:
3191 ret = zfs_standard_error(zhp->zfs_hdl, errno,
3192 errbuf);
3193 break;
3194 }
3195 }
3196 }
3197
3198 return (ret);
3199 }
3200
3201 /*
3202 * Clones the given dataset. The target must be of the same type as the source.
3203 */
3204 int
3205 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3206 {
3207 char parent[ZFS_MAXNAMELEN];
3208 int ret;
3209 char errbuf[1024];
3210 libzfs_handle_t *hdl = zhp->zfs_hdl;
3211 uint64_t zoned;
3212
3213 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3214
3215 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3216 "cannot create '%s'"), target);
3217
3218 /* validate the target/clone name */
3219 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3220 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3221
3222 /* validate parents exist */
3223 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3224 return (-1);
3225
3226 (void) parent_name(target, parent, sizeof (parent));
3227
3228 /* do the clone */
3229
3230 if (props) {
3231 zfs_type_t type;
3232 if (ZFS_IS_VOLUME(zhp)) {
3233 type = ZFS_TYPE_VOLUME;
3234 } else {
3235 type = ZFS_TYPE_FILESYSTEM;
3236 }
3237 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3238 zhp, errbuf)) == NULL)
3239 return (-1);
3240 }
3241
3242 ret = lzc_clone(target, zhp->zfs_name, props);
3243 nvlist_free(props);
3244
3245 if (ret != 0) {
3246 switch (errno) {
3247
3248 case ENOENT:
3249 /*
3250 * The parent doesn't exist. We should have caught this
3251 * above, but there may a race condition that has since
3252 * destroyed the parent.
3253 *
3254 * At this point, we don't know whether it's the source
3255 * that doesn't exist anymore, or whether the target
3256 * dataset doesn't exist.
3257 */
3258 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3259 "no such parent '%s'"), parent);
3260 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3261
3262 case EXDEV:
3263 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3264 "source and target pools differ"));
3265 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3266 errbuf));
3267
3268 default:
3269 return (zfs_standard_error(zhp->zfs_hdl, errno,
3270 errbuf));
3271 }
3272 }
3273
3274 return (ret);
3275 }
3276
3277 /*
3278 * Promotes the given clone fs to be the clone parent.
3279 */
3280 int
3281 zfs_promote(zfs_handle_t *zhp)
3282 {
3283 libzfs_handle_t *hdl = zhp->zfs_hdl;
3284 zfs_cmd_t zc = { 0 };
3285 char parent[MAXPATHLEN];
3286 int ret;
3287 char errbuf[1024];
3288
3289 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3290 "cannot promote '%s'"), zhp->zfs_name);
3291
3292 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3293 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3294 "snapshots can not be promoted"));
3295 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3296 }
3297
3298 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3299 if (parent[0] == '\0') {
3300 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3301 "not a cloned filesystem"));
3302 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3303 }
3304
3305 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3306 sizeof (zc.zc_value));
3307 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3308 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3309
3310 if (ret != 0) {
3311 int save_errno = errno;
3312
3313 switch (save_errno) {
3314 case EEXIST:
3315 /* There is a conflicting snapshot name. */
3316 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3317 "conflicting snapshot '%s' from parent '%s'"),
3318 zc.zc_string, parent);
3319 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3320
3321 default:
3322 return (zfs_standard_error(hdl, save_errno, errbuf));
3323 }
3324 }
3325 return (ret);
3326 }
3327
3328 typedef struct snapdata {
3329 nvlist_t *sd_nvl;
3330 const char *sd_snapname;
3331 } snapdata_t;
3332
3333 static int
3334 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3335 {
3336 snapdata_t *sd = arg;
3337 char name[ZFS_MAXNAMELEN];
3338 int rv = 0;
3339
3340 (void) snprintf(name, sizeof (name),
3341 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3342
3343 fnvlist_add_boolean(sd->sd_nvl, name);
3344
3345 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3346 zfs_close(zhp);
3347 return (rv);
3348 }
3349
3350 /*
3351 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3352 * created.
3353 */
3354 int
3355 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3356 {
3357 int ret;
3358 char errbuf[1024];
3359 nvpair_t *elem;
3360 nvlist_t *errors;
3361
3362 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3363 "cannot create snapshots "));
3364
3365 elem = NULL;
3366 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3367 const char *snapname = nvpair_name(elem);
3368
3369 /* validate the target name */
3370 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3371 B_TRUE)) {
3372 (void) snprintf(errbuf, sizeof (errbuf),
3373 dgettext(TEXT_DOMAIN,
3374 "cannot create snapshot '%s'"), snapname);
3375 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3376 }
3377 }
3378
3379 if (props != NULL &&
3380 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3381 props, B_FALSE, NULL, errbuf)) == NULL) {
3382 return (-1);
3383 }
3384
3385 ret = lzc_snapshot(snaps, props, &errors);
3386
3387 if (ret != 0) {
3388 boolean_t printed = B_FALSE;
3389 for (elem = nvlist_next_nvpair(errors, NULL);
3390 elem != NULL;
3391 elem = nvlist_next_nvpair(errors, elem)) {
3392 (void) snprintf(errbuf, sizeof (errbuf),
3393 dgettext(TEXT_DOMAIN,
3394 "cannot create snapshot '%s'"), nvpair_name(elem));
3395 (void) zfs_standard_error(hdl,
3396 fnvpair_value_int32(elem), errbuf);
3397 printed = B_TRUE;
3398 }
3399 if (!printed) {
3400 switch (ret) {
3401 case EXDEV:
3402 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3403 "multiple snapshots of same "
3404 "fs not allowed"));
3405 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3406
3407 break;
3408 default:
3409 (void) zfs_standard_error(hdl, ret, errbuf);
3410 }
3411 }
3412 }
3413
3414 nvlist_free(props);
3415 nvlist_free(errors);
3416 return (ret);
3417 }
3418
3419 int
3420 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3421 nvlist_t *props)
3422 {
3423 int ret;
3424 snapdata_t sd = { 0 };
3425 char fsname[ZFS_MAXNAMELEN];
3426 char *cp;
3427 zfs_handle_t *zhp;
3428 char errbuf[1024];
3429
3430 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3431 "cannot snapshot %s"), path);
3432
3433 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3434 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3435
3436 (void) strlcpy(fsname, path, sizeof (fsname));
3437 cp = strchr(fsname, '@');
3438 *cp = '\0';
3439 sd.sd_snapname = cp + 1;
3440
3441 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3442 ZFS_TYPE_VOLUME)) == NULL) {
3443 return (-1);
3444 }
3445
3446 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3447 if (recursive) {
3448 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3449 } else {
3450 fnvlist_add_boolean(sd.sd_nvl, path);
3451 }
3452
3453 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3454 nvlist_free(sd.sd_nvl);
3455 zfs_close(zhp);
3456 return (ret);
3457 }
3458
3459 /*
3460 * Destroy any more recent snapshots. We invoke this callback on any dependents
3461 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3462 * is a dependent and we should just destroy it without checking the transaction
3463 * group.
3464 */
3465 typedef struct rollback_data {
3466 const char *cb_target; /* the snapshot */
3467 uint64_t cb_create; /* creation time reference */
3468 boolean_t cb_error;
3469 boolean_t cb_dependent;
3470 boolean_t cb_force;
3471 } rollback_data_t;
3472
3473 static int
3474 rollback_destroy(zfs_handle_t *zhp, void *data)
3475 {
3476 rollback_data_t *cbp = data;
3477
3478 if (!cbp->cb_dependent) {
3479 if (strcmp(zhp->zfs_name, cbp->cb_target) != 0 &&
3480 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT &&
3481 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) >
3482 cbp->cb_create) {
3483
3484 cbp->cb_dependent = B_TRUE;
3485 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3486 rollback_destroy, cbp);
3487 cbp->cb_dependent = B_FALSE;
3488
3489 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3490 }
3491 } else {
3492 /* We must destroy this clone; first unmount it */
3493 prop_changelist_t *clp;
3494
3495 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3496 cbp->cb_force ? MS_FORCE: 0);
3497 if (clp == NULL || changelist_prefix(clp) != 0) {
3498 cbp->cb_error = B_TRUE;
3499 zfs_close(zhp);
3500 return (0);
3501 }
3502 if (zfs_destroy(zhp, B_FALSE) != 0)
3503 cbp->cb_error = B_TRUE;
3504 else
3505 changelist_remove(clp, zhp->zfs_name);
3506 (void) changelist_postfix(clp);
3507 changelist_free(clp);
3508 }
3509
3510 zfs_close(zhp);
3511 return (0);
3512 }
3513
3514 /*
3515 * Given a dataset, rollback to a specific snapshot, discarding any
3516 * data changes since then and making it the active dataset.
3517 *
3518 * Any snapshots more recent than the target are destroyed, along with
3519 * their dependents.
3520 */
3521 int
3522 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3523 {
3524 rollback_data_t cb = { 0 };
3525 int err;
3526 zfs_cmd_t zc = { 0 };
3527 boolean_t restore_resv = 0;
3528 uint64_t old_volsize, new_volsize;
3529 zfs_prop_t resv_prop;
3530
3531 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3532 zhp->zfs_type == ZFS_TYPE_VOLUME);
3533
3534 /*
3535 * Destroy all recent snapshots and their dependents.
3536 */
3537 cb.cb_force = force;
3538 cb.cb_target = snap->zfs_name;
3539 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3540 (void) zfs_iter_children(zhp, rollback_destroy, &cb);
3541
3542 if (cb.cb_error)
3543 return (-1);
3544
3545 /*
3546 * Now that we have verified that the snapshot is the latest,
3547 * rollback to the given snapshot.
3548 */
3549
3550 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3551 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3552 return (-1);
3553 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3554 restore_resv =
3555 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3556 }
3557
3558 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3559
3560 if (ZFS_IS_VOLUME(zhp))
3561 zc.zc_objset_type = DMU_OST_ZVOL;
3562 else
3563 zc.zc_objset_type = DMU_OST_ZFS;
3564
3565 /*
3566 * We rely on zfs_iter_children() to verify that there are no
3567 * newer snapshots for the given dataset. Therefore, we can
3568 * simply pass the name on to the ioctl() call. There is still
3569 * an unlikely race condition where the user has taken a
3570 * snapshot since we verified that this was the most recent.
3571 *
3572 */
3573 if ((err = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_ROLLBACK, &zc)) != 0) {
3574 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3575 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3576 zhp->zfs_name);
3577 return (err);
3578 }
3579
3580 /*
3581 * For volumes, if the pre-rollback volsize matched the pre-
3582 * rollback reservation and the volsize has changed then set
3583 * the reservation property to the post-rollback volsize.
3584 * Make a new handle since the rollback closed the dataset.
3585 */
3586 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3587 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3588 if (restore_resv) {
3589 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3590 if (old_volsize != new_volsize)
3591 err = zfs_prop_set_int(zhp, resv_prop,
3592 new_volsize);
3593 }
3594 zfs_close(zhp);
3595 }
3596 return (err);
3597 }
3598
3599 /*
3600 * Renames the given dataset.
3601 */
3602 int
3603 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive,
3604 boolean_t force_unmount)
3605 {
3606 int ret;
3607 zfs_cmd_t zc = { 0 };
3608 char *delim;
3609 prop_changelist_t *cl = NULL;
3610 zfs_handle_t *zhrp = NULL;
3611 char *parentname = NULL;
3612 char parent[ZFS_MAXNAMELEN];
3613 libzfs_handle_t *hdl = zhp->zfs_hdl;
3614 char errbuf[1024];
3615
3616 /* if we have the same exact name, just return success */
3617 if (strcmp(zhp->zfs_name, target) == 0)
3618 return (0);
3619
3620 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3621 "cannot rename to '%s'"), target);
3622
3623 /*
3624 * Make sure the target name is valid
3625 */
3626 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3627 if ((strchr(target, '@') == NULL) ||
3628 *target == '@') {
3629 /*
3630 * Snapshot target name is abbreviated,
3631 * reconstruct full dataset name
3632 */
3633 (void) strlcpy(parent, zhp->zfs_name,
3634 sizeof (parent));
3635 delim = strchr(parent, '@');
3636 if (strchr(target, '@') == NULL)
3637 *(++delim) = '\0';
3638 else
3639 *delim = '\0';
3640 (void) strlcat(parent, target, sizeof (parent));
3641 target = parent;
3642 } else {
3643 /*
3644 * Make sure we're renaming within the same dataset.
3645 */
3646 delim = strchr(target, '@');
3647 if (strncmp(zhp->zfs_name, target, delim - target)
3648 != 0 || zhp->zfs_name[delim - target] != '@') {
3649 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3650 "snapshots must be part of same "
3651 "dataset"));
3652 return (zfs_error(hdl, EZFS_CROSSTARGET,
3653 errbuf));
3654 }
3655 }
3656 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3657 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3658 } else {
3659 if (recursive) {
3660 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3661 "recursive rename must be a snapshot"));
3662 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3663 }
3664
3665 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3666 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3667
3668 /* validate parents */
3669 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3670 return (-1);
3671
3672 /* make sure we're in the same pool */
3673 verify((delim = strchr(target, '/')) != NULL);
3674 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3675 zhp->zfs_name[delim - target] != '/') {
3676 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3677 "datasets must be within same pool"));
3678 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3679 }
3680
3681 /* new name cannot be a child of the current dataset name */
3682 if (is_descendant(zhp->zfs_name, target)) {
3683 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3684 "New dataset name cannot be a descendant of "
3685 "current dataset name"));
3686 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3687 }
3688 }
3689
3690 (void) snprintf(errbuf, sizeof (errbuf),
3691 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
3692
3693 if (getzoneid() == GLOBAL_ZONEID &&
3694 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
3695 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3696 "dataset is used in a non-global zone"));
3697 return (zfs_error(hdl, EZFS_ZONED, errbuf));
3698 }
3699
3700 if (recursive) {
3701
3702 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
3703 if (parentname == NULL) {
3704 ret = -1;
3705 goto error;
3706 }
3707 delim = strchr(parentname, '@');
3708 *delim = '\0';
3709 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
3710 if (zhrp == NULL) {
3711 ret = -1;
3712 goto error;
3713 }
3714
3715 } else {
3716 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3717 force_unmount ? MS_FORCE : 0)) == NULL)
3718 return (-1);
3719
3720 if (changelist_haszonedchild(cl)) {
3721 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3722 "child dataset with inherited mountpoint is used "
3723 "in a non-global zone"));
3724 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
3725 goto error;
3726 }
3727
3728 if ((ret = changelist_prefix(cl)) != 0)
3729 goto error;
3730 }
3731
3732 if (ZFS_IS_VOLUME(zhp))
3733 zc.zc_objset_type = DMU_OST_ZVOL;
3734 else
3735 zc.zc_objset_type = DMU_OST_ZFS;
3736
3737 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3738 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
3739
3740 zc.zc_cookie = recursive;
3741
3742 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
3743 /*
3744 * if it was recursive, the one that actually failed will
3745 * be in zc.zc_name
3746 */
3747 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3748 "cannot rename '%s'"), zc.zc_name);
3749
3750 if (recursive && errno == EEXIST) {
3751 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3752 "a child dataset already has a snapshot "
3753 "with the new name"));
3754 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3755 } else {
3756 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
3757 }
3758
3759 /*
3760 * On failure, we still want to remount any filesystems that
3761 * were previously mounted, so we don't alter the system state.
3762 */
3763 if (!recursive)
3764 (void) changelist_postfix(cl);
3765 } else {
3766 if (!recursive) {
3767 changelist_rename(cl, zfs_get_name(zhp), target);
3768 ret = changelist_postfix(cl);
3769 }
3770 }
3771
3772 error:
3773 if (parentname) {
3774 free(parentname);
3775 }
3776 if (zhrp) {
3777 zfs_close(zhrp);
3778 }
3779 if (cl) {
3780 changelist_free(cl);
3781 }
3782 return (ret);
3783 }
3784
3785 nvlist_t *
3786 zfs_get_user_props(zfs_handle_t *zhp)
3787 {
3788 return (zhp->zfs_user_props);
3789 }
3790
3791 nvlist_t *
3792 zfs_get_recvd_props(zfs_handle_t *zhp)
3793 {
3794 if (zhp->zfs_recvd_props == NULL)
3795 if (get_recvd_props_ioctl(zhp) != 0)
3796 return (NULL);
3797 return (zhp->zfs_recvd_props);
3798 }
3799
3800 /*
3801 * This function is used by 'zfs list' to determine the exact set of columns to
3802 * display, and their maximum widths. This does two main things:
3803 *
3804 * - If this is a list of all properties, then expand the list to include
3805 * all native properties, and set a flag so that for each dataset we look
3806 * for new unique user properties and add them to the list.
3807 *
3808 * - For non fixed-width properties, keep track of the maximum width seen
3809 * so that we can size the column appropriately. If the user has
3810 * requested received property values, we also need to compute the width
3811 * of the RECEIVED column.
3812 */
3813 int
3814 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received)
3815 {
3816 libzfs_handle_t *hdl = zhp->zfs_hdl;
3817 zprop_list_t *entry;
3818 zprop_list_t **last, **start;
3819 nvlist_t *userprops, *propval;
3820 nvpair_t *elem;
3821 char *strval;
3822 char buf[ZFS_MAXPROPLEN];
3823
3824 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
3825 return (-1);
3826
3827 userprops = zfs_get_user_props(zhp);
3828
3829 entry = *plp;
3830 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
3831 /*
3832 * Go through and add any user properties as necessary. We
3833 * start by incrementing our list pointer to the first
3834 * non-native property.
3835 */
3836 start = plp;
3837 while (*start != NULL) {
3838 if ((*start)->pl_prop == ZPROP_INVAL)
3839 break;
3840 start = &(*start)->pl_next;
3841 }
3842
3843 elem = NULL;
3844 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
3845 /*
3846 * See if we've already found this property in our list.
3847 */
3848 for (last = start; *last != NULL;
3849 last = &(*last)->pl_next) {
3850 if (strcmp((*last)->pl_user_prop,
3851 nvpair_name(elem)) == 0)
3852 break;
3853 }
3854
3855 if (*last == NULL) {
3856 if ((entry = zfs_alloc(hdl,
3857 sizeof (zprop_list_t))) == NULL ||
3858 ((entry->pl_user_prop = zfs_strdup(hdl,
3859 nvpair_name(elem)))) == NULL) {
3860 free(entry);
3861 return (-1);
3862 }
3863
3864 entry->pl_prop = ZPROP_INVAL;
3865 entry->pl_width = strlen(nvpair_name(elem));
3866 entry->pl_all = B_TRUE;
3867 *last = entry;
3868 }
3869 }
3870 }
3871
3872 /*
3873 * Now go through and check the width of any non-fixed columns
3874 */
3875 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
3876 if (entry->pl_fixed)
3877 continue;
3878
3879 if (entry->pl_prop != ZPROP_INVAL) {
3880 if (zfs_prop_get(zhp, entry->pl_prop,
3881 buf, sizeof (buf), NULL, NULL, 0, B_FALSE) == 0) {
3882 if (strlen(buf) > entry->pl_width)
3883 entry->pl_width = strlen(buf);
3884 }
3885 if (received && zfs_prop_get_recvd(zhp,
3886 zfs_prop_to_name(entry->pl_prop),
3887 buf, sizeof (buf), B_FALSE) == 0)
3888 if (strlen(buf) > entry->pl_recvd_width)
3889 entry->pl_recvd_width = strlen(buf);
3890 } else {
3891 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
3892 &propval) == 0) {
3893 verify(nvlist_lookup_string(propval,
3894 ZPROP_VALUE, &strval) == 0);
3895 if (strlen(strval) > entry->pl_width)
3896 entry->pl_width = strlen(strval);
3897 }
3898 if (received && zfs_prop_get_recvd(zhp,
3899 entry->pl_user_prop,
3900 buf, sizeof (buf), B_FALSE) == 0)
3901 if (strlen(buf) > entry->pl_recvd_width)
3902 entry->pl_recvd_width = strlen(buf);
3903 }
3904 }
3905
3906 return (0);
3907 }
3908
3909 int
3910 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
3911 char *resource, void *export, void *sharetab,
3912 int sharemax, zfs_share_op_t operation)
3913 {
3914 zfs_cmd_t zc = { 0 };
3915 int error;
3916
3917 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3918 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3919 if (resource)
3920 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
3921 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
3922 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
3923 zc.zc_share.z_sharetype = operation;
3924 zc.zc_share.z_sharemax = sharemax;
3925 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
3926 return (error);
3927 }
3928
3929 void
3930 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
3931 {
3932 nvpair_t *curr;
3933
3934 /*
3935 * Keep a reference to the props-table against which we prune the
3936 * properties.
3937 */
3938 zhp->zfs_props_table = props;
3939
3940 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
3941
3942 while (curr) {
3943 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
3944 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
3945
3946 /*
3947 * User properties will result in ZPROP_INVAL, and since we
3948 * only know how to prune standard ZFS properties, we always
3949 * leave these in the list. This can also happen if we
3950 * encounter an unknown DSL property (when running older
3951 * software, for example).
3952 */
3953 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
3954 (void) nvlist_remove(zhp->zfs_props,
3955 nvpair_name(curr), nvpair_type(curr));
3956 curr = next;
3957 }
3958 }
3959
3960 static int
3961 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
3962 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
3963 {
3964 zfs_cmd_t zc = { 0 };
3965 nvlist_t *nvlist = NULL;
3966 int error;
3967
3968 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3969 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3970 zc.zc_cookie = (uint64_t)cmd;
3971
3972 if (cmd == ZFS_SMB_ACL_RENAME) {
3973 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
3974 (void) no_memory(hdl);
3975 return (NULL);
3976 }
3977 }
3978
3979 switch (cmd) {
3980 case ZFS_SMB_ACL_ADD:
3981 case ZFS_SMB_ACL_REMOVE:
3982 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
3983 break;
3984 case ZFS_SMB_ACL_RENAME:
3985 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
3986 resource1) != 0) {
3987 (void) no_memory(hdl);
3988 return (-1);
3989 }
3990 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
3991 resource2) != 0) {
3992 (void) no_memory(hdl);
3993 return (-1);
3994 }
3995 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
3996 nvlist_free(nvlist);
3997 return (-1);
3998 }
3999 break;
4000 case ZFS_SMB_ACL_PURGE:
4001 break;
4002 default:
4003 return (-1);
4004 }
4005 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4006 if (nvlist)
4007 nvlist_free(nvlist);
4008 return (error);
4009 }
4010
4011 int
4012 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4013 char *path, char *resource)
4014 {
4015 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4016 resource, NULL));
4017 }
4018
4019 int
4020 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4021 char *path, char *resource)
4022 {
4023 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4024 resource, NULL));
4025 }
4026
4027 int
4028 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4029 {
4030 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4031 NULL, NULL));
4032 }
4033
4034 int
4035 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4036 char *oldname, char *newname)
4037 {
4038 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4039 oldname, newname));
4040 }
4041
4042 int
4043 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4044 zfs_userspace_cb_t func, void *arg)
4045 {
4046 zfs_cmd_t zc = { 0 };
4047 zfs_useracct_t buf[100];
4048 libzfs_handle_t *hdl = zhp->zfs_hdl;
4049 int ret;
4050
4051 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4052
4053 zc.zc_objset_type = type;
4054 zc.zc_nvlist_dst = (uintptr_t)buf;
4055
4056 for (;;) {
4057 zfs_useracct_t *zua = buf;
4058
4059 zc.zc_nvlist_dst_size = sizeof (buf);
4060 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4061 char errbuf[ZFS_MAXNAMELEN + 32];
4062
4063 (void) snprintf(errbuf, sizeof (errbuf),
4064 dgettext(TEXT_DOMAIN,
4065 "cannot get used/quota for %s"), zc.zc_name);
4066 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4067 }
4068 if (zc.zc_nvlist_dst_size == 0)
4069 break;
4070
4071 while (zc.zc_nvlist_dst_size > 0) {
4072 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4073 zua->zu_space)) != 0)
4074 return (ret);
4075 zua++;
4076 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4077 }
4078 }
4079
4080 return (0);
4081 }
4082
4083 int
4084 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4085 boolean_t recursive, boolean_t temphold, boolean_t enoent_ok,
4086 int cleanup_fd, uint64_t dsobj, uint64_t createtxg)
4087 {
4088 zfs_cmd_t zc = { 0 };
4089 libzfs_handle_t *hdl = zhp->zfs_hdl;
4090
4091 ASSERT(!recursive || dsobj == 0);
4092
4093 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4094 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
4095 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
4096 >= sizeof (zc.zc_string))
4097 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
4098 zc.zc_cookie = recursive;
4099 zc.zc_temphold = temphold;
4100 zc.zc_cleanup_fd = cleanup_fd;
4101 zc.zc_sendobj = dsobj;
4102 zc.zc_createtxg = createtxg;
4103
4104 if (zfs_ioctl(hdl, ZFS_IOC_HOLD, &zc) != 0) {
4105 char errbuf[ZFS_MAXNAMELEN+32];
4106
4107 /*
4108 * if it was recursive, the one that actually failed will be in
4109 * zc.zc_name.
4110 */
4111 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4112 "cannot hold '%s@%s'"), zc.zc_name, snapname);
4113 switch (errno) {
4114 case E2BIG:
4115 /*
4116 * Temporary tags wind up having the ds object id
4117 * prepended. So even if we passed the length check
4118 * above, it's still possible for the tag to wind
4119 * up being slightly too long.
4120 */
4121 return (zfs_error(hdl, EZFS_TAGTOOLONG, errbuf));
4122 case ENOTSUP:
4123 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4124 "pool must be upgraded"));
4125 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
4126 case EINVAL:
4127 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4128 case EEXIST:
4129 return (zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf));
4130 case ENOENT:
4131 if (enoent_ok)
4132 return (ENOENT);
4133 /* FALLTHROUGH */
4134 default:
4135 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4136 }
4137 }
4138
4139 return (0);
4140 }
4141
4142 int
4143 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4144 boolean_t recursive)
4145 {
4146 zfs_cmd_t zc = { 0 };
4147 libzfs_handle_t *hdl = zhp->zfs_hdl;
4148
4149 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4150 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
4151 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
4152 >= sizeof (zc.zc_string))
4153 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
4154 zc.zc_cookie = recursive;
4155
4156 if (zfs_ioctl(hdl, ZFS_IOC_RELEASE, &zc) != 0) {
4157 char errbuf[ZFS_MAXNAMELEN+32];
4158
4159 /*
4160 * if it was recursive, the one that actually failed will be in
4161 * zc.zc_name.
4162 */
4163 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4164 "cannot release '%s' from '%s@%s'"), tag, zc.zc_name,
4165 snapname);
4166 switch (errno) {
4167 case ESRCH:
4168 return (zfs_error(hdl, EZFS_REFTAG_RELE, errbuf));
4169 case ENOTSUP:
4170 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4171 "pool must be upgraded"));
4172 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
4173 case EINVAL:
4174 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4175 default:
4176 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4177 }
4178 }
4179
4180 return (0);
4181 }
4182
4183 int
4184 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4185 {
4186 zfs_cmd_t zc = { 0 };
4187 libzfs_handle_t *hdl = zhp->zfs_hdl;
4188 int nvsz = 2048;
4189 void *nvbuf;
4190 int err = 0;
4191 char errbuf[ZFS_MAXNAMELEN+32];
4192
4193 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4194 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4195
4196 tryagain:
4197
4198 nvbuf = malloc(nvsz);
4199 if (nvbuf == NULL) {
4200 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4201 goto out;
4202 }
4203
4204 zc.zc_nvlist_dst_size = nvsz;
4205 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4206
4207 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4208
4209 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4210 (void) snprintf(errbuf, sizeof (errbuf),
4211 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4212 zc.zc_name);
4213 switch (errno) {
4214 case ENOMEM:
4215 free(nvbuf);
4216 nvsz = zc.zc_nvlist_dst_size;
4217 goto tryagain;
4218
4219 case ENOTSUP:
4220 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4221 "pool must be upgraded"));
4222 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4223 break;
4224 case EINVAL:
4225 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4226 break;
4227 case ENOENT:
4228 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4229 break;
4230 default:
4231 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4232 break;
4233 }
4234 } else {
4235 /* success */
4236 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4237 if (rc) {
4238 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4239 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4240 zc.zc_name);
4241 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4242 }
4243 }
4244
4245 free(nvbuf);
4246 out:
4247 return (err);
4248 }
4249
4250 int
4251 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4252 {
4253 zfs_cmd_t zc = { 0 };
4254 libzfs_handle_t *hdl = zhp->zfs_hdl;
4255 char *nvbuf;
4256 char errbuf[ZFS_MAXNAMELEN+32];
4257 size_t nvsz;
4258 int err;
4259
4260 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4261 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4262
4263 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4264 assert(err == 0);
4265
4266 nvbuf = malloc(nvsz);
4267
4268 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4269 assert(err == 0);
4270
4271 zc.zc_nvlist_src_size = nvsz;
4272 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4273 zc.zc_perm_action = un;
4274
4275 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4276
4277 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4278 (void) snprintf(errbuf, sizeof (errbuf),
4279 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4280 zc.zc_name);
4281 switch (errno) {
4282 case ENOTSUP:
4283 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4284 "pool must be upgraded"));
4285 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4286 break;
4287 case EINVAL:
4288 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4289 break;
4290 case ENOENT:
4291 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4292 break;
4293 default:
4294 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4295 break;
4296 }
4297 }
4298
4299 free(nvbuf);
4300
4301 return (err);
4302 }
4303
4304 int
4305 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4306 {
4307 zfs_cmd_t zc = { 0 };
4308 libzfs_handle_t *hdl = zhp->zfs_hdl;
4309 int nvsz = 2048;
4310 void *nvbuf;
4311 int err = 0;
4312 char errbuf[ZFS_MAXNAMELEN+32];
4313
4314 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
4315
4316 tryagain:
4317
4318 nvbuf = malloc(nvsz);
4319 if (nvbuf == NULL) {
4320 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4321 goto out;
4322 }
4323
4324 zc.zc_nvlist_dst_size = nvsz;
4325 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4326
4327 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4328
4329 if (zfs_ioctl(hdl, ZFS_IOC_GET_HOLDS, &zc) != 0) {
4330 (void) snprintf(errbuf, sizeof (errbuf),
4331 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4332 zc.zc_name);
4333 switch (errno) {
4334 case ENOMEM:
4335 free(nvbuf);
4336 nvsz = zc.zc_nvlist_dst_size;
4337 goto tryagain;
4338
4339 case ENOTSUP:
4340 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4341 "pool must be upgraded"));
4342 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4343 break;
4344 case EINVAL:
4345 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4346 break;
4347 case ENOENT:
4348 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4349 break;
4350 default:
4351 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4352 break;
4353 }
4354 } else {
4355 /* success */
4356 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4357 if (rc) {
4358 (void) snprintf(errbuf, sizeof (errbuf),
4359 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4360 zc.zc_name);
4361 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4362 }
4363 }
4364
4365 free(nvbuf);
4366 out:
4367 return (err);
4368 }
4369
4370 uint64_t
4371 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4372 {
4373 uint64_t numdb;
4374 uint64_t nblocks, volblocksize;
4375 int ncopies;
4376 char *strval;
4377
4378 if (nvlist_lookup_string(props,
4379 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4380 ncopies = atoi(strval);
4381 else
4382 ncopies = 1;
4383 if (nvlist_lookup_uint64(props,
4384 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4385 &volblocksize) != 0)
4386 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4387 nblocks = volsize/volblocksize;
4388 /* start with metadnode L0-L6 */
4389 numdb = 7;
4390 /* calculate number of indirects */
4391 while (nblocks > 1) {
4392 nblocks += DNODES_PER_LEVEL - 1;
4393 nblocks /= DNODES_PER_LEVEL;
4394 numdb += nblocks;
4395 }
4396 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4397 volsize *= ncopies;
4398 /*
4399 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4400 * compressed, but in practice they compress down to about
4401 * 1100 bytes
4402 */
4403 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
4404 volsize += numdb;
4405 return (volsize);
4406 }