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 case ZFS_PROP_FILESYSTEM_LIMIT:
1801 case ZFS_PROP_SNAPSHOT_LIMIT:
1802 *val = getprop_uint64(zhp, prop, source);
1803
1804 if (*source == NULL) {
1805 /* not default, must be local */
1806 *source = zhp->zfs_name;
1807 }
1808 break;
1809
1810 case ZFS_PROP_MOUNTED:
1811 *val = (zhp->zfs_mntopts != NULL);
1812 break;
1813
1814 case ZFS_PROP_NUMCLONES:
1815 *val = zhp->zfs_dmustats.dds_num_clones;
1816 break;
1817
1818 case ZFS_PROP_VERSION:
1819 case ZFS_PROP_NORMALIZE:
1820 case ZFS_PROP_UTF8ONLY:
1821 case ZFS_PROP_CASE:
1822 if (zhp->zfs_hdl->libzfs_cachedprops) {
1823 return (zfs_error(zhp->zfs_hdl, EZFS_PROPCACHED,
1824 "property unavailable since not cached"));
1825 }
1826
1827 if (!zfs_prop_valid_for_type(prop, zhp->zfs_head_type) ||
1828 zcmd_alloc_dst_nvlist(zhp->zfs_hdl, &zc, 0) != 0)
1829 return (-1);
1830 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
1831 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_OBJSET_ZPLPROPS, &zc)) {
1832 zcmd_free_nvlists(&zc);
1833 return (-1);
1834 }
1835 if (zcmd_read_dst_nvlist(zhp->zfs_hdl, &zc, &zplprops) != 0 ||
1836 nvlist_lookup_uint64(zplprops, zfs_prop_to_name(prop),
1837 val) != 0) {
1838 zcmd_free_nvlists(&zc);
1839 return (-1);
1840 }
1841 if (zplprops)
1842 nvlist_free(zplprops);
1843 zcmd_free_nvlists(&zc);
1844 break;
1845
1846 default:
1847 switch (zfs_prop_get_type(prop)) {
1848 case PROP_TYPE_NUMBER:
1849 case PROP_TYPE_INDEX:
1850 *val = getprop_uint64(zhp, prop, source);
1851 /*
1852 * If we tried to use a default value for a
1853 * readonly property, it means that it was not
1854 * present.
1855 */
1856 if (zfs_prop_readonly(prop) &&
1857 *source != NULL && (*source)[0] == '\0') {
1858 *source = NULL;
1859 }
1860 break;
1861
1862 case PROP_TYPE_STRING:
1863 default:
1864 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
1865 "cannot get non-numeric property"));
1866 return (zfs_error(zhp->zfs_hdl, EZFS_BADPROP,
1867 dgettext(TEXT_DOMAIN, "internal error")));
1868 }
1869 }
1870
1871 return (0);
1872 }
1873
1874 /*
1875 * Calculate the source type, given the raw source string.
1876 */
1877 static void
1878 get_source(zfs_handle_t *zhp, zprop_source_t *srctype, char *source,
1879 char *statbuf, size_t statlen)
1880 {
1881 if (statbuf == NULL || *srctype == ZPROP_SRC_TEMPORARY)
1882 return;
1883
1884 if (source == NULL) {
1885 *srctype = ZPROP_SRC_NONE;
1886 } else if (source[0] == '\0') {
1887 *srctype = ZPROP_SRC_DEFAULT;
1888 } else if (strstr(source, ZPROP_SOURCE_VAL_RECVD) != NULL) {
1889 *srctype = ZPROP_SRC_RECEIVED;
1890 } else {
1891 if (strcmp(source, zhp->zfs_name) == 0) {
1892 *srctype = ZPROP_SRC_LOCAL;
1893 } else {
1894 (void) strlcpy(statbuf, source, statlen);
1895 *srctype = ZPROP_SRC_INHERITED;
1896 }
1897 }
1898
1899 }
1900
1901 int
1902 zfs_prop_get_recvd(zfs_handle_t *zhp, const char *propname, char *propbuf,
1903 size_t proplen, boolean_t literal)
1904 {
1905 zfs_prop_t prop;
1906 int err = 0;
1907
1908 if (zhp->zfs_recvd_props == NULL)
1909 if (get_recvd_props_ioctl(zhp) != 0)
1910 return (-1);
1911
1912 prop = zfs_name_to_prop(propname);
1913
1914 if (prop != ZPROP_INVAL) {
1915 uint64_t cookie;
1916 if (!nvlist_exists(zhp->zfs_recvd_props, propname))
1917 return (-1);
1918 zfs_set_recvd_props_mode(zhp, &cookie);
1919 err = zfs_prop_get(zhp, prop, propbuf, proplen,
1920 NULL, NULL, 0, literal);
1921 zfs_unset_recvd_props_mode(zhp, &cookie);
1922 } else {
1923 nvlist_t *propval;
1924 char *recvdval;
1925 if (nvlist_lookup_nvlist(zhp->zfs_recvd_props,
1926 propname, &propval) != 0)
1927 return (-1);
1928 verify(nvlist_lookup_string(propval, ZPROP_VALUE,
1929 &recvdval) == 0);
1930 (void) strlcpy(propbuf, recvdval, proplen);
1931 }
1932
1933 return (err == 0 ? 0 : -1);
1934 }
1935
1936 static int
1937 get_clones_string(zfs_handle_t *zhp, char *propbuf, size_t proplen)
1938 {
1939 nvlist_t *value;
1940 nvpair_t *pair;
1941
1942 value = zfs_get_clones_nvl(zhp);
1943 if (value == NULL)
1944 return (-1);
1945
1946 propbuf[0] = '\0';
1947 for (pair = nvlist_next_nvpair(value, NULL); pair != NULL;
1948 pair = nvlist_next_nvpair(value, pair)) {
1949 if (propbuf[0] != '\0')
1950 (void) strlcat(propbuf, ",", proplen);
1951 (void) strlcat(propbuf, nvpair_name(pair), proplen);
1952 }
1953
1954 return (0);
1955 }
1956
1957 struct get_clones_arg {
1958 uint64_t numclones;
1959 nvlist_t *value;
1960 const char *origin;
1961 char buf[ZFS_MAXNAMELEN];
1962 };
1963
1964 int
1965 get_clones_cb(zfs_handle_t *zhp, void *arg)
1966 {
1967 struct get_clones_arg *gca = arg;
1968
1969 if (gca->numclones == 0) {
1970 zfs_close(zhp);
1971 return (0);
1972 }
1973
1974 if (zfs_prop_get(zhp, ZFS_PROP_ORIGIN, gca->buf, sizeof (gca->buf),
1975 NULL, NULL, 0, B_TRUE) != 0)
1976 goto out;
1977 if (strcmp(gca->buf, gca->origin) == 0) {
1978 if (nvlist_add_boolean(gca->value, zfs_get_name(zhp)) != 0) {
1979 zfs_close(zhp);
1980 return (no_memory(zhp->zfs_hdl));
1981 }
1982 gca->numclones--;
1983 }
1984
1985 out:
1986 (void) zfs_iter_children(zhp, get_clones_cb, gca);
1987 zfs_close(zhp);
1988 return (0);
1989 }
1990
1991 nvlist_t *
1992 zfs_get_clones_nvl(zfs_handle_t *zhp)
1993 {
1994 nvlist_t *nv, *value;
1995
1996 if (nvlist_lookup_nvlist(zhp->zfs_props,
1997 zfs_prop_to_name(ZFS_PROP_CLONES), &nv) != 0) {
1998 struct get_clones_arg gca;
1999
2000 /*
2001 * if this is a snapshot, then the kernel wasn't able
2002 * to get the clones. Do it by slowly iterating.
2003 */
2004 if (zhp->zfs_type != ZFS_TYPE_SNAPSHOT)
2005 return (NULL);
2006 if (nvlist_alloc(&nv, NV_UNIQUE_NAME, 0) != 0)
2007 return (NULL);
2008 if (nvlist_alloc(&value, NV_UNIQUE_NAME, 0) != 0) {
2009 nvlist_free(nv);
2010 return (NULL);
2011 }
2012
2013 gca.numclones = zfs_prop_get_int(zhp, ZFS_PROP_NUMCLONES);
2014 gca.value = value;
2015 gca.origin = zhp->zfs_name;
2016
2017 if (gca.numclones != 0) {
2018 zfs_handle_t *root;
2019 char pool[ZFS_MAXNAMELEN];
2020 char *cp = pool;
2021
2022 /* get the pool name */
2023 (void) strlcpy(pool, zhp->zfs_name, sizeof (pool));
2024 (void) strsep(&cp, "/@");
2025 root = zfs_open(zhp->zfs_hdl, pool,
2026 ZFS_TYPE_FILESYSTEM);
2027
2028 (void) get_clones_cb(root, &gca);
2029 }
2030
2031 if (gca.numclones != 0 ||
2032 nvlist_add_nvlist(nv, ZPROP_VALUE, value) != 0 ||
2033 nvlist_add_nvlist(zhp->zfs_props,
2034 zfs_prop_to_name(ZFS_PROP_CLONES), nv) != 0) {
2035 nvlist_free(nv);
2036 nvlist_free(value);
2037 return (NULL);
2038 }
2039 nvlist_free(nv);
2040 nvlist_free(value);
2041 verify(0 == nvlist_lookup_nvlist(zhp->zfs_props,
2042 zfs_prop_to_name(ZFS_PROP_CLONES), &nv));
2043 }
2044
2045 verify(nvlist_lookup_nvlist(nv, ZPROP_VALUE, &value) == 0);
2046
2047 return (value);
2048 }
2049
2050 /*
2051 * Retrieve a property from the given object. If 'literal' is specified, then
2052 * numbers are left as exact values. Otherwise, numbers are converted to a
2053 * human-readable form.
2054 *
2055 * Returns 0 on success, or -1 on error.
2056 */
2057 int
2058 zfs_prop_get(zfs_handle_t *zhp, zfs_prop_t prop, char *propbuf, size_t proplen,
2059 zprop_source_t *src, char *statbuf, size_t statlen, boolean_t literal)
2060 {
2061 char *source = NULL;
2062 uint64_t val;
2063 char *str;
2064 const char *strval;
2065 boolean_t received = zfs_is_recvd_props_mode(zhp);
2066 boolean_t printerr;
2067
2068 /*
2069 * Check to see if this property applies to our object
2070 */
2071 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type))
2072 return (-1);
2073
2074 if (received && zfs_prop_readonly(prop))
2075 return (-1);
2076
2077 if (zhp->zfs_hdl->libzfs_cachedprops &&
2078 zfs_prop_cacheable(prop)) {
2079 printerr = zhp->zfs_hdl->libzfs_printerr;
2080 libzfs_print_on_error(zhp->zfs_hdl, B_FALSE);
2081 (void) zfs_error(zhp->zfs_hdl, EZFS_PROPCACHED,
2082 "property unavailable since not cached");
2083 libzfs_print_on_error(zhp->zfs_hdl, printerr);
2084 return (-1);
2085 }
2086
2087 if (src)
2088 *src = ZPROP_SRC_NONE;
2089
2090 switch (prop) {
2091 case ZFS_PROP_CREATION:
2092 /*
2093 * 'creation' is a time_t stored in the statistics. We convert
2094 * this into a string unless 'literal' is specified.
2095 */
2096 {
2097 val = getprop_uint64(zhp, prop, &source);
2098 time_t time = (time_t)val;
2099 struct tm t;
2100
2101 if (literal ||
2102 localtime_r(&time, &t) == NULL ||
2103 strftime(propbuf, proplen, "%a %b %e %k:%M %Y",
2104 &t) == 0)
2105 (void) snprintf(propbuf, proplen, "%llu", val);
2106 }
2107 break;
2108
2109 case ZFS_PROP_MOUNTPOINT:
2110 /*
2111 * Getting the precise mountpoint can be tricky.
2112 *
2113 * - for 'none' or 'legacy', return those values.
2114 * - for inherited mountpoints, we want to take everything
2115 * after our ancestor and append it to the inherited value.
2116 *
2117 * If the pool has an alternate root, we want to prepend that
2118 * root to any values we return.
2119 */
2120
2121 str = getprop_string(zhp, prop, &source);
2122
2123 if (str[0] == '/') {
2124 char buf[MAXPATHLEN];
2125 char *root = buf;
2126 const char *relpath;
2127
2128 /*
2129 * If we inherit the mountpoint, even from a dataset
2130 * with a received value, the source will be the path of
2131 * the dataset we inherit from. If source is
2132 * ZPROP_SOURCE_VAL_RECVD, the received value is not
2133 * inherited.
2134 */
2135 if (strcmp(source, ZPROP_SOURCE_VAL_RECVD) == 0) {
2136 relpath = "";
2137 } else {
2138 relpath = zhp->zfs_name + strlen(source);
2139 if (relpath[0] == '/')
2140 relpath++;
2141 }
2142
2143 if ((zpool_get_prop(zhp->zpool_hdl,
2144 ZPOOL_PROP_ALTROOT, buf, MAXPATHLEN, NULL,
2145 B_FALSE)) || (strcmp(root, "-") == 0))
2146 root[0] = '\0';
2147 /*
2148 * Special case an alternate root of '/'. This will
2149 * avoid having multiple leading slashes in the
2150 * mountpoint path.
2151 */
2152 if (strcmp(root, "/") == 0)
2153 root++;
2154
2155 /*
2156 * If the mountpoint is '/' then skip over this
2157 * if we are obtaining either an alternate root or
2158 * an inherited mountpoint.
2159 */
2160 if (str[1] == '\0' && (root[0] != '\0' ||
2161 relpath[0] != '\0'))
2162 str++;
2163
2164 if (relpath[0] == '\0')
2165 (void) snprintf(propbuf, proplen, "%s%s",
2166 root, str);
2167 else
2168 (void) snprintf(propbuf, proplen, "%s%s%s%s",
2169 root, str, relpath[0] == '@' ? "" : "/",
2170 relpath);
2171 } else {
2172 /* 'legacy' or 'none' */
2173 (void) strlcpy(propbuf, str, proplen);
2174 }
2175
2176 break;
2177
2178 case ZFS_PROP_ORIGIN:
2179 (void) strlcpy(propbuf, getprop_string(zhp, prop, &source),
2180 proplen);
2181 /*
2182 * If there is no parent at all, return failure to indicate that
2183 * it doesn't apply to this dataset.
2184 */
2185 if (propbuf[0] == '\0')
2186 return (-1);
2187 break;
2188
2189 case ZFS_PROP_CLONES:
2190 if (get_clones_string(zhp, propbuf, proplen) != 0)
2191 return (-1);
2192 break;
2193
2194 case ZFS_PROP_QUOTA:
2195 case ZFS_PROP_REFQUOTA:
2196 case ZFS_PROP_RESERVATION:
2197 case ZFS_PROP_REFRESERVATION:
2198
2199 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2200 return (-1);
2201
2202 /*
2203 * If quota or reservation is 0, we translate this into 'none'
2204 * (unless literal is set), and indicate that it's the default
2205 * value. Otherwise, we print the number nicely and indicate
2206 * that its set locally.
2207 */
2208 if (val == 0) {
2209 if (literal)
2210 (void) strlcpy(propbuf, "0", proplen);
2211 else
2212 (void) strlcpy(propbuf, "none", proplen);
2213 } else {
2214 if (literal)
2215 (void) snprintf(propbuf, proplen, "%llu",
2216 (u_longlong_t)val);
2217 else
2218 zfs_nicenum(val, propbuf, proplen);
2219 }
2220 break;
2221
2222 case ZFS_PROP_FILESYSTEM_LIMIT:
2223 case ZFS_PROP_SNAPSHOT_LIMIT:
2224
2225 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2226 return (-1);
2227
2228 /*
2229 * If limit is UINT64_MAX, we translate this into 'none' (unless
2230 * literal is set), and indicate that it's the default value.
2231 * Otherwise, we print the number nicely and indicate that it's
2232 * set locally.
2233 */
2234 if (literal) {
2235 (void) snprintf(propbuf, proplen, "%llu",
2236 (u_longlong_t)val);
2237 } else if (val == UINT64_MAX) {
2238 (void) strlcpy(propbuf, "none", proplen);
2239 } else {
2240 zfs_nicenum(val, propbuf, proplen);
2241 }
2242 break;
2243
2244 case ZFS_PROP_REFRATIO:
2245 case ZFS_PROP_COMPRESSRATIO:
2246 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2247 return (-1);
2248 (void) snprintf(propbuf, proplen, "%llu.%02llux",
2249 (u_longlong_t)(val / 100),
2250 (u_longlong_t)(val % 100));
2251 break;
2252
2253 case ZFS_PROP_TYPE:
2254 switch (zhp->zfs_type) {
2255 case ZFS_TYPE_FILESYSTEM:
2256 str = "filesystem";
2257 break;
2258 case ZFS_TYPE_VOLUME:
2259 str = "volume";
2260 break;
2261 case ZFS_TYPE_SNAPSHOT:
2262 str = "snapshot";
2263 break;
2264 default:
2265 abort();
2266 }
2267 (void) snprintf(propbuf, proplen, "%s", str);
2268 break;
2269
2270 case ZFS_PROP_MOUNTED:
2271 /*
2272 * The 'mounted' property is a pseudo-property that described
2273 * whether the filesystem is currently mounted. Even though
2274 * it's a boolean value, the typical values of "on" and "off"
2275 * don't make sense, so we translate to "yes" and "no".
2276 */
2277 if (get_numeric_property(zhp, ZFS_PROP_MOUNTED,
2278 src, &source, &val) != 0)
2279 return (-1);
2280 if (val)
2281 (void) strlcpy(propbuf, "yes", proplen);
2282 else
2283 (void) strlcpy(propbuf, "no", proplen);
2284 break;
2285
2286 case ZFS_PROP_NAME:
2287 /*
2288 * The 'name' property is a pseudo-property derived from the
2289 * dataset name. It is presented as a real property to simplify
2290 * consumers.
2291 */
2292 (void) strlcpy(propbuf, zhp->zfs_name, proplen);
2293 break;
2294
2295 case ZFS_PROP_MLSLABEL:
2296 {
2297 m_label_t *new_sl = NULL;
2298 char *ascii = NULL; /* human readable label */
2299
2300 (void) strlcpy(propbuf,
2301 getprop_string(zhp, prop, &source), proplen);
2302
2303 if (literal || (strcasecmp(propbuf,
2304 ZFS_MLSLABEL_DEFAULT) == 0))
2305 break;
2306
2307 /*
2308 * Try to translate the internal hex string to
2309 * human-readable output. If there are any
2310 * problems just use the hex string.
2311 */
2312
2313 if (str_to_label(propbuf, &new_sl, MAC_LABEL,
2314 L_NO_CORRECTION, NULL) == -1) {
2315 m_label_free(new_sl);
2316 break;
2317 }
2318
2319 if (label_to_str(new_sl, &ascii, M_LABEL,
2320 DEF_NAMES) != 0) {
2321 if (ascii)
2322 free(ascii);
2323 m_label_free(new_sl);
2324 break;
2325 }
2326 m_label_free(new_sl);
2327
2328 (void) strlcpy(propbuf, ascii, proplen);
2329 free(ascii);
2330 }
2331 break;
2332
2333 case ZFS_PROP_GUID:
2334 /*
2335 * GUIDs are stored as numbers, but they are identifiers.
2336 * We don't want them to be pretty printed, because pretty
2337 * printing mangles the ID into a truncated and useless value.
2338 */
2339 if (get_numeric_property(zhp, prop, src, &source, &val) != 0)
2340 return (-1);
2341 (void) snprintf(propbuf, proplen, "%llu", (u_longlong_t)val);
2342 break;
2343
2344 default:
2345 switch (zfs_prop_get_type(prop)) {
2346 case PROP_TYPE_NUMBER:
2347 if (get_numeric_property(zhp, prop, src,
2348 &source, &val) != 0)
2349 return (-1);
2350 if (literal)
2351 (void) snprintf(propbuf, proplen, "%llu",
2352 (u_longlong_t)val);
2353 else
2354 zfs_nicenum(val, propbuf, proplen);
2355 break;
2356
2357 case PROP_TYPE_STRING:
2358 (void) strlcpy(propbuf,
2359 getprop_string(zhp, prop, &source), proplen);
2360 break;
2361
2362 case PROP_TYPE_INDEX:
2363 if (get_numeric_property(zhp, prop, src,
2364 &source, &val) != 0)
2365 return (-1);
2366 if (zfs_prop_index_to_string(prop, val, &strval) != 0)
2367 return (-1);
2368 (void) strlcpy(propbuf, strval, proplen);
2369 break;
2370
2371 default:
2372 abort();
2373 }
2374 }
2375
2376 get_source(zhp, src, source, statbuf, statlen);
2377
2378 return (0);
2379 }
2380
2381 /*
2382 * Utility function to get the given numeric property. Does no validation that
2383 * the given property is the appropriate type; should only be used with
2384 * hard-coded property types.
2385 */
2386 uint64_t
2387 zfs_prop_get_int(zfs_handle_t *zhp, zfs_prop_t prop)
2388 {
2389 char *source;
2390 uint64_t val;
2391
2392 (void) get_numeric_property(zhp, prop, NULL, &source, &val);
2393
2394 return (val);
2395 }
2396
2397 int
2398 zfs_prop_set_int(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t val)
2399 {
2400 char buf[64];
2401
2402 (void) snprintf(buf, sizeof (buf), "%llu", (longlong_t)val);
2403 return (zfs_prop_set(zhp, zfs_prop_to_name(prop), buf));
2404 }
2405
2406 /*
2407 * Similar to zfs_prop_get(), but returns the value as an integer.
2408 */
2409 int
2410 zfs_prop_get_numeric(zfs_handle_t *zhp, zfs_prop_t prop, uint64_t *value,
2411 zprop_source_t *src, char *statbuf, size_t statlen)
2412 {
2413 char *source;
2414
2415 /*
2416 * Check to see if this property applies to our object
2417 */
2418 if (!zfs_prop_valid_for_type(prop, zhp->zfs_type)) {
2419 return (zfs_error_fmt(zhp->zfs_hdl, EZFS_PROPTYPE,
2420 dgettext(TEXT_DOMAIN, "cannot get property '%s'"),
2421 zfs_prop_to_name(prop)));
2422 }
2423
2424 if (src)
2425 *src = ZPROP_SRC_NONE;
2426
2427 if (get_numeric_property(zhp, prop, src, &source, value) != 0)
2428 return (-1);
2429
2430 get_source(zhp, src, source, statbuf, statlen);
2431
2432 return (0);
2433 }
2434
2435 static int
2436 idmap_id_to_numeric_domain_rid(uid_t id, boolean_t isuser,
2437 char **domainp, idmap_rid_t *ridp)
2438 {
2439 idmap_get_handle_t *get_hdl = NULL;
2440 idmap_stat status;
2441 int err = EINVAL;
2442
2443 if (idmap_get_create(&get_hdl) != IDMAP_SUCCESS)
2444 goto out;
2445
2446 if (isuser) {
2447 err = idmap_get_sidbyuid(get_hdl, id,
2448 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2449 } else {
2450 err = idmap_get_sidbygid(get_hdl, id,
2451 IDMAP_REQ_FLG_USE_CACHE, domainp, ridp, &status);
2452 }
2453 if (err == IDMAP_SUCCESS &&
2454 idmap_get_mappings(get_hdl) == IDMAP_SUCCESS &&
2455 status == IDMAP_SUCCESS)
2456 err = 0;
2457 else
2458 err = EINVAL;
2459 out:
2460 if (get_hdl)
2461 idmap_get_destroy(get_hdl);
2462 return (err);
2463 }
2464
2465 /*
2466 * convert the propname into parameters needed by kernel
2467 * Eg: userquota@ahrens -> ZFS_PROP_USERQUOTA, "", 126829
2468 * Eg: userused@matt@domain -> ZFS_PROP_USERUSED, "S-1-123-456", 789
2469 */
2470 static int
2471 userquota_propname_decode(const char *propname, boolean_t zoned,
2472 zfs_userquota_prop_t *typep, char *domain, int domainlen, uint64_t *ridp)
2473 {
2474 zfs_userquota_prop_t type;
2475 char *cp, *end;
2476 char *numericsid = NULL;
2477 boolean_t isuser;
2478
2479 domain[0] = '\0';
2480
2481 /* Figure out the property type ({user|group}{quota|space}) */
2482 for (type = 0; type < ZFS_NUM_USERQUOTA_PROPS; type++) {
2483 if (strncmp(propname, zfs_userquota_prop_prefixes[type],
2484 strlen(zfs_userquota_prop_prefixes[type])) == 0)
2485 break;
2486 }
2487 if (type == ZFS_NUM_USERQUOTA_PROPS)
2488 return (EINVAL);
2489 *typep = type;
2490
2491 isuser = (type == ZFS_PROP_USERQUOTA ||
2492 type == ZFS_PROP_USERUSED);
2493
2494 cp = strchr(propname, '@') + 1;
2495
2496 if (strchr(cp, '@')) {
2497 /*
2498 * It's a SID name (eg "user@domain") that needs to be
2499 * turned into S-1-domainID-RID.
2500 */
2501 directory_error_t e;
2502 if (zoned && getzoneid() == GLOBAL_ZONEID)
2503 return (ENOENT);
2504 if (isuser) {
2505 e = directory_sid_from_user_name(NULL,
2506 cp, &numericsid);
2507 } else {
2508 e = directory_sid_from_group_name(NULL,
2509 cp, &numericsid);
2510 }
2511 if (e != NULL) {
2512 directory_error_free(e);
2513 return (ENOENT);
2514 }
2515 if (numericsid == NULL)
2516 return (ENOENT);
2517 cp = numericsid;
2518 /* will be further decoded below */
2519 }
2520
2521 if (strncmp(cp, "S-1-", 4) == 0) {
2522 /* It's a numeric SID (eg "S-1-234-567-89") */
2523 (void) strlcpy(domain, cp, domainlen);
2524 cp = strrchr(domain, '-');
2525 *cp = '\0';
2526 cp++;
2527
2528 errno = 0;
2529 *ridp = strtoull(cp, &end, 10);
2530 if (numericsid) {
2531 free(numericsid);
2532 numericsid = NULL;
2533 }
2534 if (errno != 0 || *end != '\0')
2535 return (EINVAL);
2536 } else if (!isdigit(*cp)) {
2537 /*
2538 * It's a user/group name (eg "user") that needs to be
2539 * turned into a uid/gid
2540 */
2541 if (zoned && getzoneid() == GLOBAL_ZONEID)
2542 return (ENOENT);
2543 if (isuser) {
2544 struct passwd *pw;
2545 pw = getpwnam(cp);
2546 if (pw == NULL)
2547 return (ENOENT);
2548 *ridp = pw->pw_uid;
2549 } else {
2550 struct group *gr;
2551 gr = getgrnam(cp);
2552 if (gr == NULL)
2553 return (ENOENT);
2554 *ridp = gr->gr_gid;
2555 }
2556 } else {
2557 /* It's a user/group ID (eg "12345"). */
2558 uid_t id = strtoul(cp, &end, 10);
2559 idmap_rid_t rid;
2560 char *mapdomain;
2561
2562 if (*end != '\0')
2563 return (EINVAL);
2564 if (id > MAXUID) {
2565 /* It's an ephemeral ID. */
2566 if (idmap_id_to_numeric_domain_rid(id, isuser,
2567 &mapdomain, &rid) != 0)
2568 return (ENOENT);
2569 (void) strlcpy(domain, mapdomain, domainlen);
2570 *ridp = rid;
2571 } else {
2572 *ridp = id;
2573 }
2574 }
2575
2576 ASSERT3P(numericsid, ==, NULL);
2577 return (0);
2578 }
2579
2580 static int
2581 zfs_prop_get_userquota_common(zfs_handle_t *zhp, const char *propname,
2582 uint64_t *propvalue, zfs_userquota_prop_t *typep)
2583 {
2584 int err;
2585 zfs_cmd_t zc = { 0 };
2586
2587 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2588
2589 err = userquota_propname_decode(propname,
2590 zfs_prop_get_int(zhp, ZFS_PROP_ZONED),
2591 typep, zc.zc_value, sizeof (zc.zc_value), &zc.zc_guid);
2592 zc.zc_objset_type = *typep;
2593 if (err)
2594 return (err);
2595
2596 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_USERSPACE_ONE, &zc);
2597 if (err)
2598 return (err);
2599
2600 *propvalue = zc.zc_cookie;
2601 return (0);
2602 }
2603
2604 int
2605 zfs_prop_get_userquota_int(zfs_handle_t *zhp, const char *propname,
2606 uint64_t *propvalue)
2607 {
2608 zfs_userquota_prop_t type;
2609
2610 return (zfs_prop_get_userquota_common(zhp, propname, propvalue,
2611 &type));
2612 }
2613
2614 int
2615 zfs_prop_get_userquota(zfs_handle_t *zhp, const char *propname,
2616 char *propbuf, int proplen, boolean_t literal)
2617 {
2618 int err;
2619 uint64_t propvalue;
2620 zfs_userquota_prop_t type;
2621
2622 err = zfs_prop_get_userquota_common(zhp, propname, &propvalue,
2623 &type);
2624
2625 if (err)
2626 return (err);
2627
2628 if (literal) {
2629 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2630 } else if (propvalue == 0 &&
2631 (type == ZFS_PROP_USERQUOTA || type == ZFS_PROP_GROUPQUOTA)) {
2632 (void) strlcpy(propbuf, "none", proplen);
2633 } else {
2634 zfs_nicenum(propvalue, propbuf, proplen);
2635 }
2636 return (0);
2637 }
2638
2639 int
2640 zfs_prop_get_written_int(zfs_handle_t *zhp, const char *propname,
2641 uint64_t *propvalue)
2642 {
2643 int err;
2644 zfs_cmd_t zc = { 0 };
2645 const char *snapname;
2646
2647 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
2648
2649 snapname = strchr(propname, '@') + 1;
2650 if (strchr(snapname, '@')) {
2651 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
2652 } else {
2653 /* snapname is the short name, append it to zhp's fsname */
2654 char *cp;
2655
2656 (void) strlcpy(zc.zc_value, zhp->zfs_name,
2657 sizeof (zc.zc_value));
2658 cp = strchr(zc.zc_value, '@');
2659 if (cp != NULL)
2660 *cp = '\0';
2661 (void) strlcat(zc.zc_value, "@", sizeof (zc.zc_value));
2662 (void) strlcat(zc.zc_value, snapname, sizeof (zc.zc_value));
2663 }
2664
2665 err = ioctl(zhp->zfs_hdl->libzfs_fd, ZFS_IOC_SPACE_WRITTEN, &zc);
2666 if (err)
2667 return (err);
2668
2669 *propvalue = zc.zc_cookie;
2670 return (0);
2671 }
2672
2673 int
2674 zfs_prop_get_written(zfs_handle_t *zhp, const char *propname,
2675 char *propbuf, int proplen, boolean_t literal)
2676 {
2677 int err;
2678 uint64_t propvalue;
2679
2680 err = zfs_prop_get_written_int(zhp, propname, &propvalue);
2681
2682 if (err)
2683 return (err);
2684
2685 if (literal) {
2686 (void) snprintf(propbuf, proplen, "%llu", propvalue);
2687 } else {
2688 zfs_nicenum(propvalue, propbuf, proplen);
2689 }
2690 return (0);
2691 }
2692
2693 /*
2694 * Returns the name of the given zfs handle.
2695 */
2696 const char *
2697 zfs_get_name(const zfs_handle_t *zhp)
2698 {
2699 return (zhp->zfs_name);
2700 }
2701
2702 /*
2703 * Returns the type of the given zfs handle.
2704 */
2705 zfs_type_t
2706 zfs_get_type(const zfs_handle_t *zhp)
2707 {
2708 return (zhp->zfs_type);
2709 }
2710
2711 /*
2712 * Is one dataset name a child dataset of another?
2713 *
2714 * Needs to handle these cases:
2715 * Dataset 1 "a/foo" "a/foo" "a/foo" "a/foo"
2716 * Dataset 2 "a/fo" "a/foobar" "a/bar/baz" "a/foo/bar"
2717 * Descendant? No. No. No. Yes.
2718 */
2719 static boolean_t
2720 is_descendant(const char *ds1, const char *ds2)
2721 {
2722 size_t d1len = strlen(ds1);
2723
2724 /* ds2 can't be a descendant if it's smaller */
2725 if (strlen(ds2) < d1len)
2726 return (B_FALSE);
2727
2728 /* otherwise, compare strings and verify that there's a '/' char */
2729 return (ds2[d1len] == '/' && (strncmp(ds1, ds2, d1len) == 0));
2730 }
2731
2732 /*
2733 * Given a complete name, return just the portion that refers to the parent.
2734 * Will return -1 if there is no parent (path is just the name of the
2735 * pool).
2736 */
2737 static int
2738 parent_name(const char *path, char *buf, size_t buflen)
2739 {
2740 char *slashp;
2741
2742 (void) strlcpy(buf, path, buflen);
2743
2744 if ((slashp = strrchr(buf, '/')) == NULL)
2745 return (-1);
2746 *slashp = '\0';
2747
2748 return (0);
2749 }
2750
2751 /*
2752 * If accept_ancestor is false, then check to make sure that the given path has
2753 * a parent, and that it exists. If accept_ancestor is true, then find the
2754 * closest existing ancestor for the given path. In prefixlen return the
2755 * length of already existing prefix of the given path. We also fetch the
2756 * 'zoned' property, which is used to validate property settings when creating
2757 * new datasets.
2758 */
2759 static int
2760 check_parents(libzfs_handle_t *hdl, const char *path, uint64_t *zoned,
2761 boolean_t accept_ancestor, int *prefixlen)
2762 {
2763 zfs_cmd_t zc = { 0 };
2764 char parent[ZFS_MAXNAMELEN];
2765 char *slash;
2766 zfs_handle_t *zhp;
2767 char errbuf[1024];
2768 uint64_t is_zoned;
2769
2770 (void) snprintf(errbuf, sizeof (errbuf),
2771 dgettext(TEXT_DOMAIN, "cannot create '%s'"), path);
2772
2773 /* get parent, and check to see if this is just a pool */
2774 if (parent_name(path, parent, sizeof (parent)) != 0) {
2775 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2776 "missing dataset name"));
2777 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2778 }
2779
2780 /* check to see if the pool exists */
2781 if ((slash = strchr(parent, '/')) == NULL)
2782 slash = parent + strlen(parent);
2783 (void) strncpy(zc.zc_name, parent, slash - parent);
2784 zc.zc_name[slash - parent] = '\0';
2785 if (ioctl(hdl->libzfs_fd, ZFS_IOC_OBJSET_STATS, &zc) != 0 &&
2786 errno == ENOENT) {
2787 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2788 "no such pool '%s'"), zc.zc_name);
2789 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2790 }
2791
2792 /* check to see if the parent dataset exists */
2793 while ((zhp = make_dataset_handle(hdl, parent)) == NULL) {
2794 if (errno == ENOENT && accept_ancestor) {
2795 /*
2796 * Go deeper to find an ancestor, give up on top level.
2797 */
2798 if (parent_name(parent, parent, sizeof (parent)) != 0) {
2799 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2800 "no such pool '%s'"), zc.zc_name);
2801 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2802 }
2803 } else if (errno == ENOENT) {
2804 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2805 "parent does not exist"));
2806 return (zfs_error(hdl, EZFS_NOENT, errbuf));
2807 } else
2808 return (zfs_standard_error(hdl, errno, errbuf));
2809 }
2810
2811 is_zoned = zfs_prop_get_int(zhp, ZFS_PROP_ZONED);
2812 if (zoned != NULL)
2813 *zoned = is_zoned;
2814
2815 /* we are in a non-global zone, but parent is in the global zone */
2816 if (getzoneid() != GLOBAL_ZONEID && !is_zoned) {
2817 (void) zfs_standard_error(hdl, EPERM, errbuf);
2818 zfs_close(zhp);
2819 return (-1);
2820 }
2821
2822 /* make sure parent is a filesystem */
2823 if (zfs_get_type(zhp) != ZFS_TYPE_FILESYSTEM) {
2824 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2825 "parent is not a filesystem"));
2826 (void) zfs_error(hdl, EZFS_BADTYPE, errbuf);
2827 zfs_close(zhp);
2828 return (-1);
2829 }
2830
2831 zfs_close(zhp);
2832 if (prefixlen != NULL)
2833 *prefixlen = strlen(parent);
2834 return (0);
2835 }
2836
2837 /*
2838 * Finds whether the dataset of the given type(s) exists.
2839 */
2840 boolean_t
2841 zfs_dataset_exists(libzfs_handle_t *hdl, const char *path, zfs_type_t types)
2842 {
2843 zfs_handle_t *zhp;
2844
2845 if (!zfs_validate_name(hdl, path, types, B_FALSE))
2846 return (B_FALSE);
2847
2848 /*
2849 * Try to get stats for the dataset, which will tell us if it exists.
2850 */
2851 if ((zhp = make_dataset_handle(hdl, path)) != NULL) {
2852 int ds_type = zhp->zfs_type;
2853
2854 zfs_close(zhp);
2855 if (types & ds_type)
2856 return (B_TRUE);
2857 }
2858 return (B_FALSE);
2859 }
2860
2861 /*
2862 * Given a path to 'target', create all the ancestors between
2863 * the prefixlen portion of the path, and the target itself.
2864 * Fail if the initial prefixlen-ancestor does not already exist.
2865 */
2866 int
2867 create_parents(libzfs_handle_t *hdl, char *target, int prefixlen)
2868 {
2869 zfs_handle_t *h;
2870 char *cp;
2871 const char *opname;
2872
2873 /* make sure prefix exists */
2874 cp = target + prefixlen;
2875 if (*cp != '/') {
2876 assert(strchr(cp, '/') == NULL);
2877 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2878 } else {
2879 *cp = '\0';
2880 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2881 *cp = '/';
2882 }
2883 if (h == NULL)
2884 return (-1);
2885 zfs_close(h);
2886
2887 /*
2888 * Attempt to create, mount, and share any ancestor filesystems,
2889 * up to the prefixlen-long one.
2890 */
2891 for (cp = target + prefixlen + 1;
2892 cp = strchr(cp, '/'); *cp = '/', cp++) {
2893
2894 *cp = '\0';
2895
2896 h = make_dataset_handle(hdl, target);
2897 if (h) {
2898 /* it already exists, nothing to do here */
2899 zfs_close(h);
2900 continue;
2901 }
2902
2903 if (zfs_create(hdl, target, ZFS_TYPE_FILESYSTEM,
2904 NULL) != 0) {
2905 opname = dgettext(TEXT_DOMAIN, "create");
2906 goto ancestorerr;
2907 }
2908
2909 h = zfs_open(hdl, target, ZFS_TYPE_FILESYSTEM);
2910 if (h == NULL) {
2911 opname = dgettext(TEXT_DOMAIN, "open");
2912 goto ancestorerr;
2913 }
2914
2915 if (zfs_mount(h, NULL, 0) != 0) {
2916 opname = dgettext(TEXT_DOMAIN, "mount");
2917 goto ancestorerr;
2918 }
2919
2920 if (zfs_share(h) != 0) {
2921 opname = dgettext(TEXT_DOMAIN, "share");
2922 goto ancestorerr;
2923 }
2924
2925 zfs_close(h);
2926 }
2927
2928 return (0);
2929
2930 ancestorerr:
2931 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2932 "failed to %s ancestor '%s'"), opname, target);
2933 return (-1);
2934 }
2935
2936 /*
2937 * Creates non-existing ancestors of the given path.
2938 */
2939 int
2940 zfs_create_ancestors(libzfs_handle_t *hdl, const char *path)
2941 {
2942 int prefix;
2943 char *path_copy;
2944 int rc;
2945
2946 if (check_parents(hdl, path, NULL, B_TRUE, &prefix) != 0)
2947 return (-1);
2948
2949 if ((path_copy = strdup(path)) != NULL) {
2950 rc = create_parents(hdl, path_copy, prefix);
2951 free(path_copy);
2952 }
2953 if (path_copy == NULL || rc != 0)
2954 return (-1);
2955
2956 return (0);
2957 }
2958
2959 /*
2960 * Create a new filesystem or volume.
2961 */
2962 int
2963 zfs_create(libzfs_handle_t *hdl, const char *path, zfs_type_t type,
2964 nvlist_t *props)
2965 {
2966 int ret;
2967 uint64_t size = 0;
2968 uint64_t blocksize = zfs_prop_default_numeric(ZFS_PROP_VOLBLOCKSIZE);
2969 char errbuf[1024];
2970 uint64_t zoned;
2971 dmu_objset_type_t ost;
2972
2973 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
2974 "cannot create '%s'"), path);
2975
2976 /* validate the path, taking care to note the extended error message */
2977 if (!zfs_validate_name(hdl, path, type, B_TRUE))
2978 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
2979
2980 /* validate parents exist */
2981 if (check_parents(hdl, path, &zoned, B_FALSE, NULL) != 0)
2982 return (-1);
2983
2984 /*
2985 * The failure modes when creating a dataset of a different type over
2986 * one that already exists is a little strange. In particular, if you
2987 * try to create a dataset on top of an existing dataset, the ioctl()
2988 * will return ENOENT, not EEXIST. To prevent this from happening, we
2989 * first try to see if the dataset exists.
2990 */
2991 if (zfs_dataset_exists(hdl, path, ZFS_TYPE_DATASET)) {
2992 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
2993 "dataset already exists"));
2994 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
2995 }
2996
2997 if (type == ZFS_TYPE_VOLUME)
2998 ost = DMU_OST_ZVOL;
2999 else
3000 ost = DMU_OST_ZFS;
3001
3002 if (props && (props = zfs_valid_proplist(hdl, type, props,
3003 zoned, NULL, errbuf)) == 0)
3004 return (-1);
3005
3006 if (type == ZFS_TYPE_VOLUME) {
3007 /*
3008 * If we are creating a volume, the size and block size must
3009 * satisfy a few restraints. First, the blocksize must be a
3010 * valid block size between SPA_{MIN,MAX}BLOCKSIZE. Second, the
3011 * volsize must be a multiple of the block size, and cannot be
3012 * zero.
3013 */
3014 if (props == NULL || nvlist_lookup_uint64(props,
3015 zfs_prop_to_name(ZFS_PROP_VOLSIZE), &size) != 0) {
3016 nvlist_free(props);
3017 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3018 "missing volume size"));
3019 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3020 }
3021
3022 if ((ret = nvlist_lookup_uint64(props,
3023 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
3024 &blocksize)) != 0) {
3025 if (ret == ENOENT) {
3026 blocksize = zfs_prop_default_numeric(
3027 ZFS_PROP_VOLBLOCKSIZE);
3028 } else {
3029 nvlist_free(props);
3030 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3031 "missing volume block size"));
3032 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3033 }
3034 }
3035
3036 if (size == 0) {
3037 nvlist_free(props);
3038 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3039 "volume size cannot be zero"));
3040 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3041 }
3042
3043 if (size % blocksize != 0) {
3044 nvlist_free(props);
3045 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3046 "volume size must be a multiple of volume block "
3047 "size"));
3048 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3049 }
3050 }
3051
3052 /* create the dataset */
3053 ret = lzc_create(path, ost, props);
3054 nvlist_free(props);
3055
3056 /* check for failure */
3057 if (ret != 0) {
3058 char parent[ZFS_MAXNAMELEN];
3059 (void) parent_name(path, parent, sizeof (parent));
3060
3061 switch (errno) {
3062 case ENOENT:
3063 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3064 "no such parent '%s'"), parent);
3065 return (zfs_error(hdl, EZFS_NOENT, errbuf));
3066
3067 case EINVAL:
3068 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3069 "parent '%s' is not a filesystem"), parent);
3070 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3071
3072 case EDOM:
3073 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3074 "volume block size must be power of 2 from "
3075 "%u to %uk"),
3076 (uint_t)SPA_MINBLOCKSIZE,
3077 (uint_t)SPA_MAXBLOCKSIZE >> 10);
3078
3079 return (zfs_error(hdl, EZFS_BADPROP, errbuf));
3080
3081 case ENOTSUP:
3082 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3083 "pool must be upgraded to set this "
3084 "property or value"));
3085 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
3086 #ifdef _ILP32
3087 case EOVERFLOW:
3088 /*
3089 * This platform can't address a volume this big.
3090 */
3091 if (type == ZFS_TYPE_VOLUME)
3092 return (zfs_error(hdl, EZFS_VOLTOOBIG,
3093 errbuf));
3094 #endif
3095 /* FALLTHROUGH */
3096 default:
3097 return (zfs_standard_error(hdl, errno, errbuf));
3098 }
3099 }
3100
3101 return (0);
3102 }
3103
3104 /*
3105 * Destroys the given dataset. The caller must make sure that the filesystem
3106 * isn't mounted, and that there are no active dependents. If the file system
3107 * does not exist this function does nothing.
3108 */
3109 int
3110 zfs_destroy(zfs_handle_t *zhp, boolean_t defer)
3111 {
3112 zfs_cmd_t zc = { 0 };
3113
3114 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3115
3116 if (ZFS_IS_VOLUME(zhp)) {
3117 zc.zc_objset_type = DMU_OST_ZVOL;
3118 } else {
3119 zc.zc_objset_type = DMU_OST_ZFS;
3120 }
3121
3122 zc.zc_defer_destroy = defer;
3123 if (zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_DESTROY, &zc) != 0 &&
3124 errno != ENOENT) {
3125 return (zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3126 dgettext(TEXT_DOMAIN, "cannot destroy '%s'"),
3127 zhp->zfs_name));
3128 }
3129
3130 remove_mountpoint(zhp);
3131
3132 return (0);
3133 }
3134
3135 struct destroydata {
3136 nvlist_t *nvl;
3137 const char *snapname;
3138 };
3139
3140 static int
3141 zfs_check_snap_cb(zfs_handle_t *zhp, void *arg)
3142 {
3143 struct destroydata *dd = arg;
3144 zfs_handle_t *szhp;
3145 char name[ZFS_MAXNAMELEN];
3146 int rv = 0;
3147
3148 (void) snprintf(name, sizeof (name),
3149 "%s@%s", zhp->zfs_name, dd->snapname);
3150
3151 szhp = make_dataset_handle(zhp->zfs_hdl, name);
3152 if (szhp) {
3153 verify(nvlist_add_boolean(dd->nvl, name) == 0);
3154 zfs_close(szhp);
3155 }
3156
3157 rv = zfs_iter_filesystems(zhp, zfs_check_snap_cb, dd);
3158 zfs_close(zhp);
3159 return (rv);
3160 }
3161
3162 /*
3163 * Destroys all snapshots with the given name in zhp & descendants.
3164 */
3165 int
3166 zfs_destroy_snaps(zfs_handle_t *zhp, char *snapname, boolean_t defer)
3167 {
3168 int ret;
3169 struct destroydata dd = { 0 };
3170
3171 dd.snapname = snapname;
3172 verify(nvlist_alloc(&dd.nvl, NV_UNIQUE_NAME, 0) == 0);
3173 (void) zfs_check_snap_cb(zfs_handle_dup(zhp), &dd);
3174
3175 if (nvlist_next_nvpair(dd.nvl, NULL) == NULL) {
3176 ret = zfs_standard_error_fmt(zhp->zfs_hdl, ENOENT,
3177 dgettext(TEXT_DOMAIN, "cannot destroy '%s@%s'"),
3178 zhp->zfs_name, snapname);
3179 } else {
3180 ret = zfs_destroy_snaps_nvl(zhp, dd.nvl, defer);
3181 }
3182 nvlist_free(dd.nvl);
3183 return (ret);
3184 }
3185
3186 /*
3187 * Destroys all the snapshots named in the nvlist. They must be underneath
3188 * the zhp (either snapshots of it, or snapshots of its descendants).
3189 */
3190 int
3191 zfs_destroy_snaps_nvl(zfs_handle_t *zhp, nvlist_t *snaps, boolean_t defer)
3192 {
3193 int ret;
3194 nvlist_t *errlist;
3195
3196 ret = lzc_destroy_snaps(snaps, defer, &errlist);
3197
3198 if (ret != 0) {
3199 for (nvpair_t *pair = nvlist_next_nvpair(errlist, NULL);
3200 pair != NULL; pair = nvlist_next_nvpair(errlist, pair)) {
3201 char errbuf[1024];
3202 (void) snprintf(errbuf, sizeof (errbuf),
3203 dgettext(TEXT_DOMAIN, "cannot destroy snapshot %s"),
3204 nvpair_name(pair));
3205
3206 switch (fnvpair_value_int32(pair)) {
3207 case EEXIST:
3208 zfs_error_aux(zhp->zfs_hdl,
3209 dgettext(TEXT_DOMAIN,
3210 "snapshot is cloned"));
3211 ret = zfs_error(zhp->zfs_hdl, EZFS_EXISTS,
3212 errbuf);
3213 break;
3214 default:
3215 ret = zfs_standard_error(zhp->zfs_hdl, errno,
3216 errbuf);
3217 break;
3218 }
3219 }
3220 }
3221
3222 return (ret);
3223 }
3224
3225 /*
3226 * Clones the given dataset. The target must be of the same type as the source.
3227 */
3228 int
3229 zfs_clone(zfs_handle_t *zhp, const char *target, nvlist_t *props)
3230 {
3231 char parent[ZFS_MAXNAMELEN];
3232 int ret;
3233 char errbuf[1024];
3234 libzfs_handle_t *hdl = zhp->zfs_hdl;
3235 uint64_t zoned;
3236
3237 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
3238
3239 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3240 "cannot create '%s'"), target);
3241
3242 /* validate the target/clone name */
3243 if (!zfs_validate_name(hdl, target, ZFS_TYPE_FILESYSTEM, B_TRUE))
3244 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3245
3246 /* validate parents exist */
3247 if (check_parents(hdl, target, &zoned, B_FALSE, NULL) != 0)
3248 return (-1);
3249
3250 (void) parent_name(target, parent, sizeof (parent));
3251
3252 /* do the clone */
3253
3254 if (props) {
3255 zfs_type_t type;
3256 if (ZFS_IS_VOLUME(zhp)) {
3257 type = ZFS_TYPE_VOLUME;
3258 } else {
3259 type = ZFS_TYPE_FILESYSTEM;
3260 }
3261 if ((props = zfs_valid_proplist(hdl, type, props, zoned,
3262 zhp, errbuf)) == NULL)
3263 return (-1);
3264 }
3265
3266 ret = lzc_clone(target, zhp->zfs_name, props);
3267 nvlist_free(props);
3268
3269 if (ret != 0) {
3270 switch (errno) {
3271
3272 case ENOENT:
3273 /*
3274 * The parent doesn't exist. We should have caught this
3275 * above, but there may a race condition that has since
3276 * destroyed the parent.
3277 *
3278 * At this point, we don't know whether it's the source
3279 * that doesn't exist anymore, or whether the target
3280 * dataset doesn't exist.
3281 */
3282 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3283 "no such parent '%s'"), parent);
3284 return (zfs_error(zhp->zfs_hdl, EZFS_NOENT, errbuf));
3285
3286 case EXDEV:
3287 zfs_error_aux(zhp->zfs_hdl, dgettext(TEXT_DOMAIN,
3288 "source and target pools differ"));
3289 return (zfs_error(zhp->zfs_hdl, EZFS_CROSSTARGET,
3290 errbuf));
3291
3292 default:
3293 return (zfs_standard_error(zhp->zfs_hdl, errno,
3294 errbuf));
3295 }
3296 }
3297
3298 return (ret);
3299 }
3300
3301 /*
3302 * Promotes the given clone fs to be the clone parent.
3303 */
3304 int
3305 zfs_promote(zfs_handle_t *zhp)
3306 {
3307 libzfs_handle_t *hdl = zhp->zfs_hdl;
3308 zfs_cmd_t zc = { 0 };
3309 char parent[MAXPATHLEN];
3310 int ret;
3311 char errbuf[1024];
3312
3313 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3314 "cannot promote '%s'"), zhp->zfs_name);
3315
3316 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3317 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3318 "snapshots can not be promoted"));
3319 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3320 }
3321
3322 (void) strlcpy(parent, zhp->zfs_dmustats.dds_origin, sizeof (parent));
3323 if (parent[0] == '\0') {
3324 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3325 "not a cloned filesystem"));
3326 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3327 }
3328
3329 (void) strlcpy(zc.zc_value, zhp->zfs_dmustats.dds_origin,
3330 sizeof (zc.zc_value));
3331 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3332 ret = zfs_ioctl(hdl, ZFS_IOC_PROMOTE, &zc);
3333
3334 if (ret != 0) {
3335 int save_errno = errno;
3336
3337 switch (save_errno) {
3338 case EEXIST:
3339 /* There is a conflicting snapshot name. */
3340 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3341 "conflicting snapshot '%s' from parent '%s'"),
3342 zc.zc_string, parent);
3343 return (zfs_error(hdl, EZFS_EXISTS, errbuf));
3344
3345 default:
3346 return (zfs_standard_error(hdl, save_errno, errbuf));
3347 }
3348 }
3349 return (ret);
3350 }
3351
3352 typedef struct snapdata {
3353 nvlist_t *sd_nvl;
3354 const char *sd_snapname;
3355 } snapdata_t;
3356
3357 static int
3358 zfs_snapshot_cb(zfs_handle_t *zhp, void *arg)
3359 {
3360 snapdata_t *sd = arg;
3361 char name[ZFS_MAXNAMELEN];
3362 int rv = 0;
3363
3364 (void) snprintf(name, sizeof (name),
3365 "%s@%s", zfs_get_name(zhp), sd->sd_snapname);
3366
3367 fnvlist_add_boolean(sd->sd_nvl, name);
3368
3369 rv = zfs_iter_filesystems(zhp, zfs_snapshot_cb, sd);
3370 zfs_close(zhp);
3371 return (rv);
3372 }
3373
3374 /*
3375 * Creates snapshots. The keys in the snaps nvlist are the snapshots to be
3376 * created.
3377 */
3378 int
3379 zfs_snapshot_nvl(libzfs_handle_t *hdl, nvlist_t *snaps, nvlist_t *props)
3380 {
3381 int ret;
3382 char errbuf[1024];
3383 nvpair_t *elem;
3384 nvlist_t *errors;
3385
3386 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3387 "cannot create snapshots "));
3388
3389 elem = NULL;
3390 while ((elem = nvlist_next_nvpair(snaps, elem)) != NULL) {
3391 const char *snapname = nvpair_name(elem);
3392
3393 /* validate the target name */
3394 if (!zfs_validate_name(hdl, snapname, ZFS_TYPE_SNAPSHOT,
3395 B_TRUE)) {
3396 (void) snprintf(errbuf, sizeof (errbuf),
3397 dgettext(TEXT_DOMAIN,
3398 "cannot create snapshot '%s'"), snapname);
3399 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3400 }
3401 }
3402
3403 if (props != NULL &&
3404 (props = zfs_valid_proplist(hdl, ZFS_TYPE_SNAPSHOT,
3405 props, B_FALSE, NULL, errbuf)) == NULL) {
3406 return (-1);
3407 }
3408
3409 ret = lzc_snapshot(snaps, props, &errors);
3410
3411 if (ret != 0) {
3412 boolean_t printed = B_FALSE;
3413 for (elem = nvlist_next_nvpair(errors, NULL);
3414 elem != NULL;
3415 elem = nvlist_next_nvpair(errors, elem)) {
3416 (void) snprintf(errbuf, sizeof (errbuf),
3417 dgettext(TEXT_DOMAIN,
3418 "cannot create snapshot '%s'"), nvpair_name(elem));
3419 (void) zfs_standard_error(hdl,
3420 fnvpair_value_int32(elem), errbuf);
3421 printed = B_TRUE;
3422 }
3423 if (!printed) {
3424 switch (ret) {
3425 case EXDEV:
3426 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3427 "multiple snapshots of same "
3428 "fs not allowed"));
3429 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3430
3431 break;
3432 default:
3433 (void) zfs_standard_error(hdl, ret, errbuf);
3434 }
3435 }
3436 }
3437
3438 nvlist_free(props);
3439 nvlist_free(errors);
3440 return (ret);
3441 }
3442
3443 int
3444 zfs_snapshot(libzfs_handle_t *hdl, const char *path, boolean_t recursive,
3445 nvlist_t *props)
3446 {
3447 int ret;
3448 snapdata_t sd = { 0 };
3449 char fsname[ZFS_MAXNAMELEN];
3450 char *cp;
3451 zfs_handle_t *zhp;
3452 char errbuf[1024];
3453
3454 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3455 "cannot snapshot %s"), path);
3456
3457 if (!zfs_validate_name(hdl, path, ZFS_TYPE_SNAPSHOT, B_TRUE))
3458 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3459
3460 (void) strlcpy(fsname, path, sizeof (fsname));
3461 cp = strchr(fsname, '@');
3462 *cp = '\0';
3463 sd.sd_snapname = cp + 1;
3464
3465 if ((zhp = zfs_open(hdl, fsname, ZFS_TYPE_FILESYSTEM |
3466 ZFS_TYPE_VOLUME)) == NULL) {
3467 return (-1);
3468 }
3469
3470 verify(nvlist_alloc(&sd.sd_nvl, NV_UNIQUE_NAME, 0) == 0);
3471 if (recursive) {
3472 (void) zfs_snapshot_cb(zfs_handle_dup(zhp), &sd);
3473 } else {
3474 fnvlist_add_boolean(sd.sd_nvl, path);
3475 }
3476
3477 ret = zfs_snapshot_nvl(hdl, sd.sd_nvl, props);
3478 nvlist_free(sd.sd_nvl);
3479 zfs_close(zhp);
3480 return (ret);
3481 }
3482
3483 /*
3484 * Destroy any more recent snapshots. We invoke this callback on any dependents
3485 * of the snapshot first. If the 'cb_dependent' member is non-zero, then this
3486 * is a dependent and we should just destroy it without checking the transaction
3487 * group.
3488 */
3489 typedef struct rollback_data {
3490 const char *cb_target; /* the snapshot */
3491 uint64_t cb_create; /* creation time reference */
3492 boolean_t cb_error;
3493 boolean_t cb_dependent;
3494 boolean_t cb_force;
3495 } rollback_data_t;
3496
3497 static int
3498 rollback_destroy(zfs_handle_t *zhp, void *data)
3499 {
3500 rollback_data_t *cbp = data;
3501
3502 if (!cbp->cb_dependent) {
3503 if (strcmp(zhp->zfs_name, cbp->cb_target) != 0 &&
3504 zfs_get_type(zhp) == ZFS_TYPE_SNAPSHOT &&
3505 zfs_prop_get_int(zhp, ZFS_PROP_CREATETXG) >
3506 cbp->cb_create) {
3507
3508 cbp->cb_dependent = B_TRUE;
3509 cbp->cb_error |= zfs_iter_dependents(zhp, B_FALSE,
3510 rollback_destroy, cbp);
3511 cbp->cb_dependent = B_FALSE;
3512
3513 cbp->cb_error |= zfs_destroy(zhp, B_FALSE);
3514 }
3515 } else {
3516 /* We must destroy this clone; first unmount it */
3517 prop_changelist_t *clp;
3518
3519 clp = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3520 cbp->cb_force ? MS_FORCE: 0);
3521 if (clp == NULL || changelist_prefix(clp) != 0) {
3522 cbp->cb_error = B_TRUE;
3523 zfs_close(zhp);
3524 return (0);
3525 }
3526 if (zfs_destroy(zhp, B_FALSE) != 0)
3527 cbp->cb_error = B_TRUE;
3528 else
3529 changelist_remove(clp, zhp->zfs_name);
3530 (void) changelist_postfix(clp);
3531 changelist_free(clp);
3532 }
3533
3534 zfs_close(zhp);
3535 return (0);
3536 }
3537
3538 /*
3539 * Given a dataset, rollback to a specific snapshot, discarding any
3540 * data changes since then and making it the active dataset.
3541 *
3542 * Any snapshots more recent than the target are destroyed, along with
3543 * their dependents.
3544 */
3545 int
3546 zfs_rollback(zfs_handle_t *zhp, zfs_handle_t *snap, boolean_t force)
3547 {
3548 rollback_data_t cb = { 0 };
3549 int err;
3550 zfs_cmd_t zc = { 0 };
3551 boolean_t restore_resv = 0;
3552 uint64_t old_volsize, new_volsize;
3553 zfs_prop_t resv_prop;
3554
3555 assert(zhp->zfs_type == ZFS_TYPE_FILESYSTEM ||
3556 zhp->zfs_type == ZFS_TYPE_VOLUME);
3557
3558 /*
3559 * Destroy all recent snapshots and their dependents.
3560 */
3561 cb.cb_force = force;
3562 cb.cb_target = snap->zfs_name;
3563 cb.cb_create = zfs_prop_get_int(snap, ZFS_PROP_CREATETXG);
3564 (void) zfs_iter_children(zhp, rollback_destroy, &cb);
3565
3566 if (cb.cb_error)
3567 return (-1);
3568
3569 /*
3570 * Now that we have verified that the snapshot is the latest,
3571 * rollback to the given snapshot.
3572 */
3573
3574 if (zhp->zfs_type == ZFS_TYPE_VOLUME) {
3575 if (zfs_which_resv_prop(zhp, &resv_prop) < 0)
3576 return (-1);
3577 old_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3578 restore_resv =
3579 (old_volsize == zfs_prop_get_int(zhp, resv_prop));
3580 }
3581
3582 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3583
3584 if (ZFS_IS_VOLUME(zhp))
3585 zc.zc_objset_type = DMU_OST_ZVOL;
3586 else
3587 zc.zc_objset_type = DMU_OST_ZFS;
3588
3589 /*
3590 * We rely on zfs_iter_children() to verify that there are no
3591 * newer snapshots for the given dataset. Therefore, we can
3592 * simply pass the name on to the ioctl() call. There is still
3593 * an unlikely race condition where the user has taken a
3594 * snapshot since we verified that this was the most recent.
3595 *
3596 */
3597 if ((err = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_ROLLBACK, &zc)) != 0) {
3598 (void) zfs_standard_error_fmt(zhp->zfs_hdl, errno,
3599 dgettext(TEXT_DOMAIN, "cannot rollback '%s'"),
3600 zhp->zfs_name);
3601 return (err);
3602 }
3603
3604 /*
3605 * For volumes, if the pre-rollback volsize matched the pre-
3606 * rollback reservation and the volsize has changed then set
3607 * the reservation property to the post-rollback volsize.
3608 * Make a new handle since the rollback closed the dataset.
3609 */
3610 if ((zhp->zfs_type == ZFS_TYPE_VOLUME) &&
3611 (zhp = make_dataset_handle(zhp->zfs_hdl, zhp->zfs_name))) {
3612 if (restore_resv) {
3613 new_volsize = zfs_prop_get_int(zhp, ZFS_PROP_VOLSIZE);
3614 if (old_volsize != new_volsize)
3615 err = zfs_prop_set_int(zhp, resv_prop,
3616 new_volsize);
3617 }
3618 zfs_close(zhp);
3619 }
3620 return (err);
3621 }
3622
3623 /*
3624 * Renames the given dataset.
3625 */
3626 int
3627 zfs_rename(zfs_handle_t *zhp, const char *target, boolean_t recursive,
3628 boolean_t force_unmount)
3629 {
3630 int ret;
3631 zfs_cmd_t zc = { 0 };
3632 char *delim;
3633 prop_changelist_t *cl = NULL;
3634 zfs_handle_t *zhrp = NULL;
3635 char *parentname = NULL;
3636 char parent[ZFS_MAXNAMELEN];
3637 libzfs_handle_t *hdl = zhp->zfs_hdl;
3638 char errbuf[1024];
3639
3640 /* if we have the same exact name, just return success */
3641 if (strcmp(zhp->zfs_name, target) == 0)
3642 return (0);
3643
3644 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3645 "cannot rename to '%s'"), target);
3646
3647 /*
3648 * Make sure the target name is valid
3649 */
3650 if (zhp->zfs_type == ZFS_TYPE_SNAPSHOT) {
3651 if ((strchr(target, '@') == NULL) ||
3652 *target == '@') {
3653 /*
3654 * Snapshot target name is abbreviated,
3655 * reconstruct full dataset name
3656 */
3657 (void) strlcpy(parent, zhp->zfs_name,
3658 sizeof (parent));
3659 delim = strchr(parent, '@');
3660 if (strchr(target, '@') == NULL)
3661 *(++delim) = '\0';
3662 else
3663 *delim = '\0';
3664 (void) strlcat(parent, target, sizeof (parent));
3665 target = parent;
3666 } else {
3667 /*
3668 * Make sure we're renaming within the same dataset.
3669 */
3670 delim = strchr(target, '@');
3671 if (strncmp(zhp->zfs_name, target, delim - target)
3672 != 0 || zhp->zfs_name[delim - target] != '@') {
3673 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3674 "snapshots must be part of same "
3675 "dataset"));
3676 return (zfs_error(hdl, EZFS_CROSSTARGET,
3677 errbuf));
3678 }
3679 }
3680 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3681 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3682 } else {
3683 if (recursive) {
3684 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3685 "recursive rename must be a snapshot"));
3686 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
3687 }
3688
3689 if (!zfs_validate_name(hdl, target, zhp->zfs_type, B_TRUE))
3690 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3691
3692 /* validate parents */
3693 if (check_parents(hdl, target, NULL, B_FALSE, NULL) != 0)
3694 return (-1);
3695
3696 /* make sure we're in the same pool */
3697 verify((delim = strchr(target, '/')) != NULL);
3698 if (strncmp(zhp->zfs_name, target, delim - target) != 0 ||
3699 zhp->zfs_name[delim - target] != '/') {
3700 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3701 "datasets must be within same pool"));
3702 return (zfs_error(hdl, EZFS_CROSSTARGET, errbuf));
3703 }
3704
3705 /* new name cannot be a child of the current dataset name */
3706 if (is_descendant(zhp->zfs_name, target)) {
3707 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3708 "New dataset name cannot be a descendant of "
3709 "current dataset name"));
3710 return (zfs_error(hdl, EZFS_INVALIDNAME, errbuf));
3711 }
3712 }
3713
3714 (void) snprintf(errbuf, sizeof (errbuf),
3715 dgettext(TEXT_DOMAIN, "cannot rename '%s'"), zhp->zfs_name);
3716
3717 if (getzoneid() == GLOBAL_ZONEID &&
3718 zfs_prop_get_int(zhp, ZFS_PROP_ZONED)) {
3719 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3720 "dataset is used in a non-global zone"));
3721 return (zfs_error(hdl, EZFS_ZONED, errbuf));
3722 }
3723
3724 if (recursive) {
3725
3726 parentname = zfs_strdup(zhp->zfs_hdl, zhp->zfs_name);
3727 if (parentname == NULL) {
3728 ret = -1;
3729 goto error;
3730 }
3731 delim = strchr(parentname, '@');
3732 *delim = '\0';
3733 zhrp = zfs_open(zhp->zfs_hdl, parentname, ZFS_TYPE_DATASET);
3734 if (zhrp == NULL) {
3735 ret = -1;
3736 goto error;
3737 }
3738
3739 } else {
3740 if ((cl = changelist_gather(zhp, ZFS_PROP_NAME, 0,
3741 force_unmount ? MS_FORCE : 0)) == NULL)
3742 return (-1);
3743
3744 if (changelist_haszonedchild(cl)) {
3745 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3746 "child dataset with inherited mountpoint is used "
3747 "in a non-global zone"));
3748 (void) zfs_error(hdl, EZFS_ZONED, errbuf);
3749 goto error;
3750 }
3751
3752 if ((ret = changelist_prefix(cl)) != 0)
3753 goto error;
3754 }
3755
3756 if (ZFS_IS_VOLUME(zhp))
3757 zc.zc_objset_type = DMU_OST_ZVOL;
3758 else
3759 zc.zc_objset_type = DMU_OST_ZFS;
3760
3761 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
3762 (void) strlcpy(zc.zc_value, target, sizeof (zc.zc_value));
3763
3764 zc.zc_cookie = recursive;
3765
3766 if ((ret = zfs_ioctl(zhp->zfs_hdl, ZFS_IOC_RENAME, &zc)) != 0) {
3767 /*
3768 * if it was recursive, the one that actually failed will
3769 * be in zc.zc_name
3770 */
3771 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
3772 "cannot rename '%s'"), zc.zc_name);
3773
3774 if (recursive && errno == EEXIST) {
3775 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
3776 "a child dataset already has a snapshot "
3777 "with the new name"));
3778 (void) zfs_error(hdl, EZFS_EXISTS, errbuf);
3779 } else {
3780 (void) zfs_standard_error(zhp->zfs_hdl, errno, errbuf);
3781 }
3782
3783 /*
3784 * On failure, we still want to remount any filesystems that
3785 * were previously mounted, so we don't alter the system state.
3786 */
3787 if (!recursive)
3788 (void) changelist_postfix(cl);
3789 } else {
3790 if (!recursive) {
3791 changelist_rename(cl, zfs_get_name(zhp), target);
3792 ret = changelist_postfix(cl);
3793 }
3794 }
3795
3796 error:
3797 if (parentname) {
3798 free(parentname);
3799 }
3800 if (zhrp) {
3801 zfs_close(zhrp);
3802 }
3803 if (cl) {
3804 changelist_free(cl);
3805 }
3806 return (ret);
3807 }
3808
3809 nvlist_t *
3810 zfs_get_user_props(zfs_handle_t *zhp)
3811 {
3812 return (zhp->zfs_user_props);
3813 }
3814
3815 nvlist_t *
3816 zfs_get_recvd_props(zfs_handle_t *zhp)
3817 {
3818 if (zhp->zfs_recvd_props == NULL)
3819 if (get_recvd_props_ioctl(zhp) != 0)
3820 return (NULL);
3821 return (zhp->zfs_recvd_props);
3822 }
3823
3824 /*
3825 * This function is used by 'zfs list' to determine the exact set of columns to
3826 * display, and their maximum widths. This does two main things:
3827 *
3828 * - If this is a list of all properties, then expand the list to include
3829 * all native properties, and set a flag so that for each dataset we look
3830 * for new unique user properties and add them to the list.
3831 *
3832 * - For non fixed-width properties, keep track of the maximum width seen
3833 * so that we can size the column appropriately. If the user has
3834 * requested received property values, we also need to compute the width
3835 * of the RECEIVED column.
3836 */
3837 int
3838 zfs_expand_proplist(zfs_handle_t *zhp, zprop_list_t **plp, boolean_t received)
3839 {
3840 libzfs_handle_t *hdl = zhp->zfs_hdl;
3841 zprop_list_t *entry;
3842 zprop_list_t **last, **start;
3843 nvlist_t *userprops, *propval;
3844 nvpair_t *elem;
3845 char *strval;
3846 char buf[ZFS_MAXPROPLEN];
3847
3848 if (zprop_expand_list(hdl, plp, ZFS_TYPE_DATASET) != 0)
3849 return (-1);
3850
3851 userprops = zfs_get_user_props(zhp);
3852
3853 entry = *plp;
3854 if (entry->pl_all && nvlist_next_nvpair(userprops, NULL) != NULL) {
3855 /*
3856 * Go through and add any user properties as necessary. We
3857 * start by incrementing our list pointer to the first
3858 * non-native property.
3859 */
3860 start = plp;
3861 while (*start != NULL) {
3862 if ((*start)->pl_prop == ZPROP_INVAL)
3863 break;
3864 start = &(*start)->pl_next;
3865 }
3866
3867 elem = NULL;
3868 while ((elem = nvlist_next_nvpair(userprops, elem)) != NULL) {
3869 /*
3870 * See if we've already found this property in our list.
3871 */
3872 for (last = start; *last != NULL;
3873 last = &(*last)->pl_next) {
3874 if (strcmp((*last)->pl_user_prop,
3875 nvpair_name(elem)) == 0)
3876 break;
3877 }
3878
3879 if (*last == NULL) {
3880 if ((entry = zfs_alloc(hdl,
3881 sizeof (zprop_list_t))) == NULL ||
3882 ((entry->pl_user_prop = zfs_strdup(hdl,
3883 nvpair_name(elem)))) == NULL) {
3884 free(entry);
3885 return (-1);
3886 }
3887
3888 entry->pl_prop = ZPROP_INVAL;
3889 entry->pl_width = strlen(nvpair_name(elem));
3890 entry->pl_all = B_TRUE;
3891 *last = entry;
3892 }
3893 }
3894 }
3895
3896 /*
3897 * Now go through and check the width of any non-fixed columns
3898 */
3899 for (entry = *plp; entry != NULL; entry = entry->pl_next) {
3900 if (entry->pl_fixed)
3901 continue;
3902
3903 if (entry->pl_prop != ZPROP_INVAL) {
3904 if (zfs_prop_get(zhp, entry->pl_prop,
3905 buf, sizeof (buf), NULL, NULL, 0, B_FALSE) == 0) {
3906 if (strlen(buf) > entry->pl_width)
3907 entry->pl_width = strlen(buf);
3908 }
3909 if (received && zfs_prop_get_recvd(zhp,
3910 zfs_prop_to_name(entry->pl_prop),
3911 buf, sizeof (buf), B_FALSE) == 0)
3912 if (strlen(buf) > entry->pl_recvd_width)
3913 entry->pl_recvd_width = strlen(buf);
3914 } else {
3915 if (nvlist_lookup_nvlist(userprops, entry->pl_user_prop,
3916 &propval) == 0) {
3917 verify(nvlist_lookup_string(propval,
3918 ZPROP_VALUE, &strval) == 0);
3919 if (strlen(strval) > entry->pl_width)
3920 entry->pl_width = strlen(strval);
3921 }
3922 if (received && zfs_prop_get_recvd(zhp,
3923 entry->pl_user_prop,
3924 buf, sizeof (buf), B_FALSE) == 0)
3925 if (strlen(buf) > entry->pl_recvd_width)
3926 entry->pl_recvd_width = strlen(buf);
3927 }
3928 }
3929
3930 return (0);
3931 }
3932
3933 int
3934 zfs_deleg_share_nfs(libzfs_handle_t *hdl, char *dataset, char *path,
3935 char *resource, void *export, void *sharetab,
3936 int sharemax, zfs_share_op_t operation)
3937 {
3938 zfs_cmd_t zc = { 0 };
3939 int error;
3940
3941 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3942 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3943 if (resource)
3944 (void) strlcpy(zc.zc_string, resource, sizeof (zc.zc_string));
3945 zc.zc_share.z_sharedata = (uint64_t)(uintptr_t)sharetab;
3946 zc.zc_share.z_exportdata = (uint64_t)(uintptr_t)export;
3947 zc.zc_share.z_sharetype = operation;
3948 zc.zc_share.z_sharemax = sharemax;
3949 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SHARE, &zc);
3950 return (error);
3951 }
3952
3953 void
3954 zfs_prune_proplist(zfs_handle_t *zhp, uint8_t *props)
3955 {
3956 nvpair_t *curr;
3957
3958 /*
3959 * Keep a reference to the props-table against which we prune the
3960 * properties.
3961 */
3962 zhp->zfs_props_table = props;
3963
3964 curr = nvlist_next_nvpair(zhp->zfs_props, NULL);
3965
3966 while (curr) {
3967 zfs_prop_t zfs_prop = zfs_name_to_prop(nvpair_name(curr));
3968 nvpair_t *next = nvlist_next_nvpair(zhp->zfs_props, curr);
3969
3970 /*
3971 * User properties will result in ZPROP_INVAL, and since we
3972 * only know how to prune standard ZFS properties, we always
3973 * leave these in the list. This can also happen if we
3974 * encounter an unknown DSL property (when running older
3975 * software, for example).
3976 */
3977 if (zfs_prop != ZPROP_INVAL && props[zfs_prop] == B_FALSE)
3978 (void) nvlist_remove(zhp->zfs_props,
3979 nvpair_name(curr), nvpair_type(curr));
3980 curr = next;
3981 }
3982 }
3983
3984 static int
3985 zfs_smb_acl_mgmt(libzfs_handle_t *hdl, char *dataset, char *path,
3986 zfs_smb_acl_op_t cmd, char *resource1, char *resource2)
3987 {
3988 zfs_cmd_t zc = { 0 };
3989 nvlist_t *nvlist = NULL;
3990 int error;
3991
3992 (void) strlcpy(zc.zc_name, dataset, sizeof (zc.zc_name));
3993 (void) strlcpy(zc.zc_value, path, sizeof (zc.zc_value));
3994 zc.zc_cookie = (uint64_t)cmd;
3995
3996 if (cmd == ZFS_SMB_ACL_RENAME) {
3997 if (nvlist_alloc(&nvlist, NV_UNIQUE_NAME, 0) != 0) {
3998 (void) no_memory(hdl);
3999 return (NULL);
4000 }
4001 }
4002
4003 switch (cmd) {
4004 case ZFS_SMB_ACL_ADD:
4005 case ZFS_SMB_ACL_REMOVE:
4006 (void) strlcpy(zc.zc_string, resource1, sizeof (zc.zc_string));
4007 break;
4008 case ZFS_SMB_ACL_RENAME:
4009 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_SRC,
4010 resource1) != 0) {
4011 (void) no_memory(hdl);
4012 return (-1);
4013 }
4014 if (nvlist_add_string(nvlist, ZFS_SMB_ACL_TARGET,
4015 resource2) != 0) {
4016 (void) no_memory(hdl);
4017 return (-1);
4018 }
4019 if (zcmd_write_src_nvlist(hdl, &zc, nvlist) != 0) {
4020 nvlist_free(nvlist);
4021 return (-1);
4022 }
4023 break;
4024 case ZFS_SMB_ACL_PURGE:
4025 break;
4026 default:
4027 return (-1);
4028 }
4029 error = ioctl(hdl->libzfs_fd, ZFS_IOC_SMB_ACL, &zc);
4030 if (nvlist)
4031 nvlist_free(nvlist);
4032 return (error);
4033 }
4034
4035 int
4036 zfs_smb_acl_add(libzfs_handle_t *hdl, char *dataset,
4037 char *path, char *resource)
4038 {
4039 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_ADD,
4040 resource, NULL));
4041 }
4042
4043 int
4044 zfs_smb_acl_remove(libzfs_handle_t *hdl, char *dataset,
4045 char *path, char *resource)
4046 {
4047 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_REMOVE,
4048 resource, NULL));
4049 }
4050
4051 int
4052 zfs_smb_acl_purge(libzfs_handle_t *hdl, char *dataset, char *path)
4053 {
4054 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_PURGE,
4055 NULL, NULL));
4056 }
4057
4058 int
4059 zfs_smb_acl_rename(libzfs_handle_t *hdl, char *dataset, char *path,
4060 char *oldname, char *newname)
4061 {
4062 return (zfs_smb_acl_mgmt(hdl, dataset, path, ZFS_SMB_ACL_RENAME,
4063 oldname, newname));
4064 }
4065
4066 int
4067 zfs_userspace(zfs_handle_t *zhp, zfs_userquota_prop_t type,
4068 zfs_userspace_cb_t func, void *arg)
4069 {
4070 zfs_cmd_t zc = { 0 };
4071 zfs_useracct_t buf[100];
4072 libzfs_handle_t *hdl = zhp->zfs_hdl;
4073 int ret;
4074
4075 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4076
4077 zc.zc_objset_type = type;
4078 zc.zc_nvlist_dst = (uintptr_t)buf;
4079
4080 for (;;) {
4081 zfs_useracct_t *zua = buf;
4082
4083 zc.zc_nvlist_dst_size = sizeof (buf);
4084 if (zfs_ioctl(hdl, ZFS_IOC_USERSPACE_MANY, &zc) != 0) {
4085 char errbuf[ZFS_MAXNAMELEN + 32];
4086
4087 (void) snprintf(errbuf, sizeof (errbuf),
4088 dgettext(TEXT_DOMAIN,
4089 "cannot get used/quota for %s"), zc.zc_name);
4090 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4091 }
4092 if (zc.zc_nvlist_dst_size == 0)
4093 break;
4094
4095 while (zc.zc_nvlist_dst_size > 0) {
4096 if ((ret = func(arg, zua->zu_domain, zua->zu_rid,
4097 zua->zu_space)) != 0)
4098 return (ret);
4099 zua++;
4100 zc.zc_nvlist_dst_size -= sizeof (zfs_useracct_t);
4101 }
4102 }
4103
4104 return (0);
4105 }
4106
4107 int
4108 zfs_hold(zfs_handle_t *zhp, const char *snapname, const char *tag,
4109 boolean_t recursive, boolean_t temphold, boolean_t enoent_ok,
4110 int cleanup_fd, uint64_t dsobj, uint64_t createtxg)
4111 {
4112 zfs_cmd_t zc = { 0 };
4113 libzfs_handle_t *hdl = zhp->zfs_hdl;
4114
4115 ASSERT(!recursive || dsobj == 0);
4116
4117 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4118 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
4119 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
4120 >= sizeof (zc.zc_string))
4121 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
4122 zc.zc_cookie = recursive;
4123 zc.zc_temphold = temphold;
4124 zc.zc_cleanup_fd = cleanup_fd;
4125 zc.zc_sendobj = dsobj;
4126 zc.zc_createtxg = createtxg;
4127
4128 if (zfs_ioctl(hdl, ZFS_IOC_HOLD, &zc) != 0) {
4129 char errbuf[ZFS_MAXNAMELEN+32];
4130
4131 /*
4132 * if it was recursive, the one that actually failed will be in
4133 * zc.zc_name.
4134 */
4135 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4136 "cannot hold '%s@%s'"), zc.zc_name, snapname);
4137 switch (errno) {
4138 case E2BIG:
4139 /*
4140 * Temporary tags wind up having the ds object id
4141 * prepended. So even if we passed the length check
4142 * above, it's still possible for the tag to wind
4143 * up being slightly too long.
4144 */
4145 return (zfs_error(hdl, EZFS_TAGTOOLONG, errbuf));
4146 case ENOTSUP:
4147 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4148 "pool must be upgraded"));
4149 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
4150 case EINVAL:
4151 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4152 case EEXIST:
4153 return (zfs_error(hdl, EZFS_REFTAG_HOLD, errbuf));
4154 case ENOENT:
4155 if (enoent_ok)
4156 return (ENOENT);
4157 /* FALLTHROUGH */
4158 default:
4159 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4160 }
4161 }
4162
4163 return (0);
4164 }
4165
4166 int
4167 zfs_release(zfs_handle_t *zhp, const char *snapname, const char *tag,
4168 boolean_t recursive)
4169 {
4170 zfs_cmd_t zc = { 0 };
4171 libzfs_handle_t *hdl = zhp->zfs_hdl;
4172
4173 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4174 (void) strlcpy(zc.zc_value, snapname, sizeof (zc.zc_value));
4175 if (strlcpy(zc.zc_string, tag, sizeof (zc.zc_string))
4176 >= sizeof (zc.zc_string))
4177 return (zfs_error(hdl, EZFS_TAGTOOLONG, tag));
4178 zc.zc_cookie = recursive;
4179
4180 if (zfs_ioctl(hdl, ZFS_IOC_RELEASE, &zc) != 0) {
4181 char errbuf[ZFS_MAXNAMELEN+32];
4182
4183 /*
4184 * if it was recursive, the one that actually failed will be in
4185 * zc.zc_name.
4186 */
4187 (void) snprintf(errbuf, sizeof (errbuf), dgettext(TEXT_DOMAIN,
4188 "cannot release '%s' from '%s@%s'"), tag, zc.zc_name,
4189 snapname);
4190 switch (errno) {
4191 case ESRCH:
4192 return (zfs_error(hdl, EZFS_REFTAG_RELE, errbuf));
4193 case ENOTSUP:
4194 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4195 "pool must be upgraded"));
4196 return (zfs_error(hdl, EZFS_BADVERSION, errbuf));
4197 case EINVAL:
4198 return (zfs_error(hdl, EZFS_BADTYPE, errbuf));
4199 default:
4200 return (zfs_standard_error_fmt(hdl, errno, errbuf));
4201 }
4202 }
4203
4204 return (0);
4205 }
4206
4207 int
4208 zfs_get_fsacl(zfs_handle_t *zhp, nvlist_t **nvl)
4209 {
4210 zfs_cmd_t zc = { 0 };
4211 libzfs_handle_t *hdl = zhp->zfs_hdl;
4212 int nvsz = 2048;
4213 void *nvbuf;
4214 int err = 0;
4215 char errbuf[ZFS_MAXNAMELEN+32];
4216
4217 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4218 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4219
4220 tryagain:
4221
4222 nvbuf = malloc(nvsz);
4223 if (nvbuf == NULL) {
4224 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4225 goto out;
4226 }
4227
4228 zc.zc_nvlist_dst_size = nvsz;
4229 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4230
4231 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4232
4233 if (ioctl(hdl->libzfs_fd, ZFS_IOC_GET_FSACL, &zc) != 0) {
4234 (void) snprintf(errbuf, sizeof (errbuf),
4235 dgettext(TEXT_DOMAIN, "cannot get permissions on '%s'"),
4236 zc.zc_name);
4237 switch (errno) {
4238 case ENOMEM:
4239 free(nvbuf);
4240 nvsz = zc.zc_nvlist_dst_size;
4241 goto tryagain;
4242
4243 case ENOTSUP:
4244 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4245 "pool must be upgraded"));
4246 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4247 break;
4248 case EINVAL:
4249 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4250 break;
4251 case ENOENT:
4252 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4253 break;
4254 default:
4255 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4256 break;
4257 }
4258 } else {
4259 /* success */
4260 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4261 if (rc) {
4262 (void) snprintf(errbuf, sizeof (errbuf), dgettext(
4263 TEXT_DOMAIN, "cannot get permissions on '%s'"),
4264 zc.zc_name);
4265 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4266 }
4267 }
4268
4269 free(nvbuf);
4270 out:
4271 return (err);
4272 }
4273
4274 int
4275 zfs_set_fsacl(zfs_handle_t *zhp, boolean_t un, nvlist_t *nvl)
4276 {
4277 zfs_cmd_t zc = { 0 };
4278 libzfs_handle_t *hdl = zhp->zfs_hdl;
4279 char *nvbuf;
4280 char errbuf[ZFS_MAXNAMELEN+32];
4281 size_t nvsz;
4282 int err;
4283
4284 assert(zhp->zfs_type == ZFS_TYPE_VOLUME ||
4285 zhp->zfs_type == ZFS_TYPE_FILESYSTEM);
4286
4287 err = nvlist_size(nvl, &nvsz, NV_ENCODE_NATIVE);
4288 assert(err == 0);
4289
4290 nvbuf = malloc(nvsz);
4291
4292 err = nvlist_pack(nvl, &nvbuf, &nvsz, NV_ENCODE_NATIVE, 0);
4293 assert(err == 0);
4294
4295 zc.zc_nvlist_src_size = nvsz;
4296 zc.zc_nvlist_src = (uintptr_t)nvbuf;
4297 zc.zc_perm_action = un;
4298
4299 (void) strlcpy(zc.zc_name, zhp->zfs_name, sizeof (zc.zc_name));
4300
4301 if (zfs_ioctl(hdl, ZFS_IOC_SET_FSACL, &zc) != 0) {
4302 (void) snprintf(errbuf, sizeof (errbuf),
4303 dgettext(TEXT_DOMAIN, "cannot set permissions on '%s'"),
4304 zc.zc_name);
4305 switch (errno) {
4306 case ENOTSUP:
4307 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4308 "pool must be upgraded"));
4309 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4310 break;
4311 case EINVAL:
4312 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4313 break;
4314 case ENOENT:
4315 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4316 break;
4317 default:
4318 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4319 break;
4320 }
4321 }
4322
4323 free(nvbuf);
4324
4325 return (err);
4326 }
4327
4328 int
4329 zfs_get_holds(zfs_handle_t *zhp, nvlist_t **nvl)
4330 {
4331 zfs_cmd_t zc = { 0 };
4332 libzfs_handle_t *hdl = zhp->zfs_hdl;
4333 int nvsz = 2048;
4334 void *nvbuf;
4335 int err = 0;
4336 char errbuf[ZFS_MAXNAMELEN+32];
4337
4338 assert(zhp->zfs_type == ZFS_TYPE_SNAPSHOT);
4339
4340 tryagain:
4341
4342 nvbuf = malloc(nvsz);
4343 if (nvbuf == NULL) {
4344 err = (zfs_error(hdl, EZFS_NOMEM, strerror(errno)));
4345 goto out;
4346 }
4347
4348 zc.zc_nvlist_dst_size = nvsz;
4349 zc.zc_nvlist_dst = (uintptr_t)nvbuf;
4350
4351 (void) strlcpy(zc.zc_name, zhp->zfs_name, ZFS_MAXNAMELEN);
4352
4353 if (zfs_ioctl(hdl, ZFS_IOC_GET_HOLDS, &zc) != 0) {
4354 (void) snprintf(errbuf, sizeof (errbuf),
4355 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4356 zc.zc_name);
4357 switch (errno) {
4358 case ENOMEM:
4359 free(nvbuf);
4360 nvsz = zc.zc_nvlist_dst_size;
4361 goto tryagain;
4362
4363 case ENOTSUP:
4364 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
4365 "pool must be upgraded"));
4366 err = zfs_error(hdl, EZFS_BADVERSION, errbuf);
4367 break;
4368 case EINVAL:
4369 err = zfs_error(hdl, EZFS_BADTYPE, errbuf);
4370 break;
4371 case ENOENT:
4372 err = zfs_error(hdl, EZFS_NOENT, errbuf);
4373 break;
4374 default:
4375 err = zfs_standard_error_fmt(hdl, errno, errbuf);
4376 break;
4377 }
4378 } else {
4379 /* success */
4380 int rc = nvlist_unpack(nvbuf, zc.zc_nvlist_dst_size, nvl, 0);
4381 if (rc) {
4382 (void) snprintf(errbuf, sizeof (errbuf),
4383 dgettext(TEXT_DOMAIN, "cannot get holds for '%s'"),
4384 zc.zc_name);
4385 err = zfs_standard_error_fmt(hdl, rc, errbuf);
4386 }
4387 }
4388
4389 free(nvbuf);
4390 out:
4391 return (err);
4392 }
4393
4394 uint64_t
4395 zvol_volsize_to_reservation(uint64_t volsize, nvlist_t *props)
4396 {
4397 uint64_t numdb;
4398 uint64_t nblocks, volblocksize;
4399 int ncopies;
4400 char *strval;
4401
4402 if (nvlist_lookup_string(props,
4403 zfs_prop_to_name(ZFS_PROP_COPIES), &strval) == 0)
4404 ncopies = atoi(strval);
4405 else
4406 ncopies = 1;
4407 if (nvlist_lookup_uint64(props,
4408 zfs_prop_to_name(ZFS_PROP_VOLBLOCKSIZE),
4409 &volblocksize) != 0)
4410 volblocksize = ZVOL_DEFAULT_BLOCKSIZE;
4411 nblocks = volsize/volblocksize;
4412 /* start with metadnode L0-L6 */
4413 numdb = 7;
4414 /* calculate number of indirects */
4415 while (nblocks > 1) {
4416 nblocks += DNODES_PER_LEVEL - 1;
4417 nblocks /= DNODES_PER_LEVEL;
4418 numdb += nblocks;
4419 }
4420 numdb *= MIN(SPA_DVAS_PER_BP, ncopies + 1);
4421 volsize *= ncopies;
4422 /*
4423 * this is exactly DN_MAX_INDBLKSHIFT when metadata isn't
4424 * compressed, but in practice they compress down to about
4425 * 1100 bytes
4426 */
4427 numdb *= 1ULL << DN_MAX_INDBLKSHIFT;
4428 volsize += numdb;
4429 return (volsize);
4430 }