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