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