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