]> git.proxmox.com Git - mirror_zfs-debian.git/blame - lib/libzfs/libzfs_util.c
Imported Upstream version 0.6.5.3
[mirror_zfs-debian.git] / lib / libzfs / libzfs_util.c
CommitLineData
34dc7c2f
BB
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 */
9ae529ec 21
34dc7c2f 22/*
428870ff 23 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
e10b0808 24 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
9ae529ec 25 * Copyright (c) 2012 by Delphix. All rights reserved.
34dc7c2f
BB
26 */
27
34dc7c2f
BB
28/*
29 * Internal utility routines for the ZFS library.
30 */
31
32#include <errno.h>
33#include <fcntl.h>
34#include <libintl.h>
35#include <stdarg.h>
36#include <stdio.h>
37#include <stdlib.h>
38#include <strings.h>
39#include <unistd.h>
40#include <ctype.h>
41#include <math.h>
d603ed6c 42#include <sys/stat.h>
34dc7c2f
BB
43#include <sys/mnttab.h>
44#include <sys/mntent.h>
45#include <sys/types.h>
4b1abce9 46#include <wait.h>
34dc7c2f
BB
47
48#include <libzfs.h>
a08ee875 49#include <libzfs_core.h>
34dc7c2f
BB
50
51#include "libzfs_impl.h"
52#include "zfs_prop.h"
9ae529ec 53#include "zfeature_common.h"
34dc7c2f
BB
54
55int
56libzfs_errno(libzfs_handle_t *hdl)
57{
58 return (hdl->libzfs_error);
59}
60
e10b0808
AX
61const char *
62libzfs_error_init(int error)
63{
64 switch (error) {
65 case ENXIO:
66 return (dgettext(TEXT_DOMAIN, "The ZFS modules are not "
67 "loaded.\nTry running '/sbin/modprobe zfs' as root "
68 "to load them.\n"));
69 case ENOENT:
70 return (dgettext(TEXT_DOMAIN, "The /dev/zfs device is "
71 "missing and must be created.\nTry running 'udevadm "
72 "trigger' as root to create it.\n"));
73 case ENOEXEC:
74 return (dgettext(TEXT_DOMAIN, "The ZFS modules cannot be "
75 "auto-loaded.\nTry running '/sbin/modprobe zfs' as "
76 "root to manually load them.\n"));
77 case EACCES:
78 return (dgettext(TEXT_DOMAIN, "Permission denied the "
79 "ZFS utilities must be run as root.\n"));
80 default:
81 return (dgettext(TEXT_DOMAIN, "Failed to initialize the "
82 "libzfs library.\n"));
83 }
84}
85
34dc7c2f
BB
86const char *
87libzfs_error_action(libzfs_handle_t *hdl)
88{
89 return (hdl->libzfs_action);
90}
91
92const char *
93libzfs_error_description(libzfs_handle_t *hdl)
94{
95 if (hdl->libzfs_desc[0] != '\0')
96 return (hdl->libzfs_desc);
97
98 switch (hdl->libzfs_error) {
99 case EZFS_NOMEM:
100 return (dgettext(TEXT_DOMAIN, "out of memory"));
101 case EZFS_BADPROP:
102 return (dgettext(TEXT_DOMAIN, "invalid property value"));
103 case EZFS_PROPREADONLY:
572e2857 104 return (dgettext(TEXT_DOMAIN, "read-only property"));
34dc7c2f
BB
105 case EZFS_PROPTYPE:
106 return (dgettext(TEXT_DOMAIN, "property doesn't apply to "
107 "datasets of this type"));
108 case EZFS_PROPNONINHERIT:
109 return (dgettext(TEXT_DOMAIN, "property cannot be inherited"));
110 case EZFS_PROPSPACE:
111 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation"));
112 case EZFS_BADTYPE:
113 return (dgettext(TEXT_DOMAIN, "operation not applicable to "
114 "datasets of this type"));
115 case EZFS_BUSY:
116 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy"));
117 case EZFS_EXISTS:
118 return (dgettext(TEXT_DOMAIN, "pool or dataset exists"));
119 case EZFS_NOENT:
120 return (dgettext(TEXT_DOMAIN, "no such pool or dataset"));
121 case EZFS_BADSTREAM:
122 return (dgettext(TEXT_DOMAIN, "invalid backup stream"));
123 case EZFS_DSREADONLY:
572e2857 124 return (dgettext(TEXT_DOMAIN, "dataset is read-only"));
34dc7c2f
BB
125 case EZFS_VOLTOOBIG:
126 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for "
127 "this system"));
34dc7c2f
BB
128 case EZFS_INVALIDNAME:
129 return (dgettext(TEXT_DOMAIN, "invalid name"));
130 case EZFS_BADRESTORE:
131 return (dgettext(TEXT_DOMAIN, "unable to restore to "
132 "destination"));
133 case EZFS_BADBACKUP:
134 return (dgettext(TEXT_DOMAIN, "backup failed"));
135 case EZFS_BADTARGET:
136 return (dgettext(TEXT_DOMAIN, "invalid target vdev"));
137 case EZFS_NODEVICE:
138 return (dgettext(TEXT_DOMAIN, "no such device in pool"));
139 case EZFS_BADDEV:
140 return (dgettext(TEXT_DOMAIN, "invalid device"));
141 case EZFS_NOREPLICAS:
142 return (dgettext(TEXT_DOMAIN, "no valid replicas"));
143 case EZFS_RESILVERING:
144 return (dgettext(TEXT_DOMAIN, "currently resilvering"));
145 case EZFS_BADVERSION:
9ae529ec
CS
146 return (dgettext(TEXT_DOMAIN, "unsupported version or "
147 "feature"));
34dc7c2f
BB
148 case EZFS_POOLUNAVAIL:
149 return (dgettext(TEXT_DOMAIN, "pool is unavailable"));
150 case EZFS_DEVOVERFLOW:
151 return (dgettext(TEXT_DOMAIN, "too many devices in one vdev"));
152 case EZFS_BADPATH:
153 return (dgettext(TEXT_DOMAIN, "must be an absolute path"));
154 case EZFS_CROSSTARGET:
155 return (dgettext(TEXT_DOMAIN, "operation crosses datasets or "
156 "pools"));
157 case EZFS_ZONED:
158 return (dgettext(TEXT_DOMAIN, "dataset in use by local zone"));
159 case EZFS_MOUNTFAILED:
160 return (dgettext(TEXT_DOMAIN, "mount failed"));
161 case EZFS_UMOUNTFAILED:
162 return (dgettext(TEXT_DOMAIN, "umount failed"));
163 case EZFS_UNSHARENFSFAILED:
164 return (dgettext(TEXT_DOMAIN, "unshare(1M) failed"));
165 case EZFS_SHARENFSFAILED:
166 return (dgettext(TEXT_DOMAIN, "share(1M) failed"));
167 case EZFS_UNSHARESMBFAILED:
168 return (dgettext(TEXT_DOMAIN, "smb remove share failed"));
169 case EZFS_SHARESMBFAILED:
170 return (dgettext(TEXT_DOMAIN, "smb add share failed"));
34dc7c2f
BB
171 case EZFS_PERM:
172 return (dgettext(TEXT_DOMAIN, "permission denied"));
173 case EZFS_NOSPC:
174 return (dgettext(TEXT_DOMAIN, "out of space"));
428870ff
BB
175 case EZFS_FAULT:
176 return (dgettext(TEXT_DOMAIN, "bad address"));
34dc7c2f
BB
177 case EZFS_IO:
178 return (dgettext(TEXT_DOMAIN, "I/O error"));
179 case EZFS_INTR:
180 return (dgettext(TEXT_DOMAIN, "signal received"));
181 case EZFS_ISSPARE:
182 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot "
183 "spare"));
184 case EZFS_INVALCONFIG:
185 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration"));
186 case EZFS_RECURSIVE:
187 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency"));
188 case EZFS_NOHISTORY:
189 return (dgettext(TEXT_DOMAIN, "no history available"));
34dc7c2f
BB
190 case EZFS_POOLPROPS:
191 return (dgettext(TEXT_DOMAIN, "failed to retrieve "
192 "pool properties"));
193 case EZFS_POOL_NOTSUP:
194 return (dgettext(TEXT_DOMAIN, "operation not supported "
195 "on this type of pool"));
196 case EZFS_POOL_INVALARG:
197 return (dgettext(TEXT_DOMAIN, "invalid argument for "
198 "this pool operation"));
199 case EZFS_NAMETOOLONG:
200 return (dgettext(TEXT_DOMAIN, "dataset name is too long"));
201 case EZFS_OPENFAILED:
202 return (dgettext(TEXT_DOMAIN, "open failed"));
203 case EZFS_NOCAP:
204 return (dgettext(TEXT_DOMAIN,
205 "disk capacity information could not be retrieved"));
206 case EZFS_LABELFAILED:
207 return (dgettext(TEXT_DOMAIN, "write of label failed"));
208 case EZFS_BADWHO:
209 return (dgettext(TEXT_DOMAIN, "invalid user/group"));
210 case EZFS_BADPERM:
211 return (dgettext(TEXT_DOMAIN, "invalid permission"));
212 case EZFS_BADPERMSET:
213 return (dgettext(TEXT_DOMAIN, "invalid permission set name"));
214 case EZFS_NODELEGATION:
215 return (dgettext(TEXT_DOMAIN, "delegated administration is "
216 "disabled on pool"));
34dc7c2f
BB
217 case EZFS_BADCACHE:
218 return (dgettext(TEXT_DOMAIN, "invalid or missing cache file"));
219 case EZFS_ISL2CACHE:
220 return (dgettext(TEXT_DOMAIN, "device is in use as a cache"));
221 case EZFS_VDEVNOTSUP:
222 return (dgettext(TEXT_DOMAIN, "vdev specification is not "
223 "supported"));
b128c09f
BB
224 case EZFS_NOTSUP:
225 return (dgettext(TEXT_DOMAIN, "operation not supported "
226 "on this dataset"));
227 case EZFS_ACTIVE_SPARE:
228 return (dgettext(TEXT_DOMAIN, "pool has active shared spare "
229 "device"));
9babb374
BB
230 case EZFS_UNPLAYED_LOGS:
231 return (dgettext(TEXT_DOMAIN, "log device has unplayed intent "
232 "logs"));
45d1cae3
BB
233 case EZFS_REFTAG_RELE:
234 return (dgettext(TEXT_DOMAIN, "no such tag on this dataset"));
235 case EZFS_REFTAG_HOLD:
236 return (dgettext(TEXT_DOMAIN, "tag already exists on this "
237 "dataset"));
428870ff
BB
238 case EZFS_TAGTOOLONG:
239 return (dgettext(TEXT_DOMAIN, "tag too long"));
240 case EZFS_PIPEFAILED:
241 return (dgettext(TEXT_DOMAIN, "pipe create failed"));
242 case EZFS_THREADCREATEFAILED:
243 return (dgettext(TEXT_DOMAIN, "thread create failed"));
244 case EZFS_POSTSPLIT_ONLINE:
245 return (dgettext(TEXT_DOMAIN, "disk was split from this pool "
246 "into a new one"));
247 case EZFS_SCRUBBING:
248 return (dgettext(TEXT_DOMAIN, "currently scrubbing; "
249 "use 'zpool scrub -s' to cancel current scrub"));
250 case EZFS_NO_SCRUB:
251 return (dgettext(TEXT_DOMAIN, "there is no active scrub"));
572e2857
BB
252 case EZFS_DIFF:
253 return (dgettext(TEXT_DOMAIN, "unable to generate diffs"));
254 case EZFS_DIFFDATA:
255 return (dgettext(TEXT_DOMAIN, "invalid diff data"));
256 case EZFS_POOLREADONLY:
257 return (dgettext(TEXT_DOMAIN, "pool is read-only"));
34dc7c2f
BB
258 case EZFS_UNKNOWN:
259 return (dgettext(TEXT_DOMAIN, "unknown error"));
260 default:
261 assert(hdl->libzfs_error == 0);
262 return (dgettext(TEXT_DOMAIN, "no error"));
263 }
264}
265
266/*PRINTFLIKE2*/
267void
268zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...)
269{
270 va_list ap;
271
272 va_start(ap, fmt);
273
274 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc),
275 fmt, ap);
276 hdl->libzfs_desc_active = 1;
277
278 va_end(ap);
279}
280
281static void
282zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap)
283{
284 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action),
285 fmt, ap);
286 hdl->libzfs_error = error;
287
288 if (hdl->libzfs_desc_active)
289 hdl->libzfs_desc_active = 0;
290 else
291 hdl->libzfs_desc[0] = '\0';
292
293 if (hdl->libzfs_printerr) {
294 if (error == EZFS_UNKNOWN) {
295 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal "
296 "error: %s\n"), libzfs_error_description(hdl));
297 abort();
298 }
299
300 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action,
301 libzfs_error_description(hdl));
302 if (error == EZFS_NOMEM)
303 exit(1);
304 }
305}
306
307int
308zfs_error(libzfs_handle_t *hdl, int error, const char *msg)
309{
310 return (zfs_error_fmt(hdl, error, "%s", msg));
311}
312
313/*PRINTFLIKE3*/
314int
315zfs_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
316{
317 va_list ap;
318
319 va_start(ap, fmt);
320
321 zfs_verror(hdl, error, fmt, ap);
322
323 va_end(ap);
324
325 return (-1);
326}
327
328static int
329zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt,
330 va_list ap)
331{
332 switch (error) {
333 case EPERM:
334 case EACCES:
335 zfs_verror(hdl, EZFS_PERM, fmt, ap);
336 return (-1);
337
338 case ECANCELED:
339 zfs_verror(hdl, EZFS_NODELEGATION, fmt, ap);
340 return (-1);
341
342 case EIO:
343 zfs_verror(hdl, EZFS_IO, fmt, ap);
344 return (-1);
345
428870ff
BB
346 case EFAULT:
347 zfs_verror(hdl, EZFS_FAULT, fmt, ap);
348 return (-1);
349
34dc7c2f
BB
350 case EINTR:
351 zfs_verror(hdl, EZFS_INTR, fmt, ap);
352 return (-1);
353 }
354
355 return (0);
356}
357
358int
359zfs_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
360{
361 return (zfs_standard_error_fmt(hdl, error, "%s", msg));
362}
363
364/*PRINTFLIKE3*/
365int
366zfs_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
367{
368 va_list ap;
369
370 va_start(ap, fmt);
371
372 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
373 va_end(ap);
374 return (-1);
375 }
376
377 switch (error) {
378 case ENXIO:
379 case ENODEV:
330d06f9 380 case EPIPE:
34dc7c2f
BB
381 zfs_verror(hdl, EZFS_IO, fmt, ap);
382 break;
383
384 case ENOENT:
385 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
386 "dataset does not exist"));
387 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
388 break;
389
390 case ENOSPC:
391 case EDQUOT:
392 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
393 return (-1);
394
395 case EEXIST:
396 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
397 "dataset already exists"));
398 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
399 break;
400
401 case EBUSY:
402 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
403 "dataset is busy"));
404 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
405 break;
406 case EROFS:
572e2857 407 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
34dc7c2f
BB
408 break;
409 case ENAMETOOLONG:
410 zfs_verror(hdl, EZFS_NAMETOOLONG, fmt, ap);
411 break;
412 case ENOTSUP:
413 zfs_verror(hdl, EZFS_BADVERSION, fmt, ap);
414 break;
9babb374
BB
415 case EAGAIN:
416 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
417 "pool I/O is currently suspended"));
418 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
419 break;
34dc7c2f 420 default:
428870ff 421 zfs_error_aux(hdl, strerror(error));
34dc7c2f
BB
422 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
423 break;
424 }
425
426 va_end(ap);
427 return (-1);
428}
429
430int
431zpool_standard_error(libzfs_handle_t *hdl, int error, const char *msg)
432{
433 return (zpool_standard_error_fmt(hdl, error, "%s", msg));
434}
435
436/*PRINTFLIKE3*/
437int
438zpool_standard_error_fmt(libzfs_handle_t *hdl, int error, const char *fmt, ...)
439{
440 va_list ap;
441
442 va_start(ap, fmt);
443
444 if (zfs_common_error(hdl, error, fmt, ap) != 0) {
445 va_end(ap);
446 return (-1);
447 }
448
449 switch (error) {
450 case ENODEV:
451 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap);
452 break;
453
454 case ENOENT:
455 zfs_error_aux(hdl,
456 dgettext(TEXT_DOMAIN, "no such pool or dataset"));
457 zfs_verror(hdl, EZFS_NOENT, fmt, ap);
458 break;
459
460 case EEXIST:
461 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
462 "pool already exists"));
463 zfs_verror(hdl, EZFS_EXISTS, fmt, ap);
464 break;
465
466 case EBUSY:
467 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy"));
b128c09f 468 zfs_verror(hdl, EZFS_BUSY, fmt, ap);
34dc7c2f
BB
469 break;
470
471 case ENXIO:
472 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
473 "one or more devices is currently unavailable"));
474 zfs_verror(hdl, EZFS_BADDEV, fmt, ap);
475 break;
476
477 case ENAMETOOLONG:
478 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap);
479 break;
480
481 case ENOTSUP:
482 zfs_verror(hdl, EZFS_POOL_NOTSUP, fmt, ap);
483 break;
484
485 case EINVAL:
486 zfs_verror(hdl, EZFS_POOL_INVALARG, fmt, ap);
487 break;
488
489 case ENOSPC:
490 case EDQUOT:
491 zfs_verror(hdl, EZFS_NOSPC, fmt, ap);
492 return (-1);
572e2857 493
9babb374
BB
494 case EAGAIN:
495 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
496 "pool I/O is currently suspended"));
497 zfs_verror(hdl, EZFS_POOLUNAVAIL, fmt, ap);
498 break;
34dc7c2f 499
572e2857
BB
500 case EROFS:
501 zfs_verror(hdl, EZFS_POOLREADONLY, fmt, ap);
502 break;
503
34dc7c2f
BB
504 default:
505 zfs_error_aux(hdl, strerror(error));
506 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap);
507 }
508
509 va_end(ap);
510 return (-1);
511}
512
513/*
514 * Display an out of memory error message and abort the current program.
515 */
516int
517no_memory(libzfs_handle_t *hdl)
518{
519 return (zfs_error(hdl, EZFS_NOMEM, "internal error"));
520}
521
522/*
523 * A safe form of malloc() which will die if the allocation fails.
524 */
525void *
526zfs_alloc(libzfs_handle_t *hdl, size_t size)
527{
528 void *data;
529
530 if ((data = calloc(1, size)) == NULL)
531 (void) no_memory(hdl);
532
533 return (data);
534}
535
572e2857
BB
536/*
537 * A safe form of asprintf() which will die if the allocation fails.
538 */
539/*PRINTFLIKE2*/
540char *
541zfs_asprintf(libzfs_handle_t *hdl, const char *fmt, ...)
542{
543 va_list ap;
544 char *ret;
545 int err;
546
547 va_start(ap, fmt);
548
549 err = vasprintf(&ret, fmt, ap);
550
551 va_end(ap);
552
553 if (err < 0)
554 (void) no_memory(hdl);
555
556 return (ret);
557}
558
34dc7c2f
BB
559/*
560 * A safe form of realloc(), which also zeroes newly allocated space.
561 */
562void *
563zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize)
564{
565 void *ret;
566
567 if ((ret = realloc(ptr, newsize)) == NULL) {
568 (void) no_memory(hdl);
34dc7c2f
BB
569 return (NULL);
570 }
571
572 bzero((char *)ret + oldsize, (newsize - oldsize));
573 return (ret);
574}
575
576/*
577 * A safe form of strdup() which will die if the allocation fails.
578 */
579char *
580zfs_strdup(libzfs_handle_t *hdl, const char *str)
581{
582 char *ret;
583
584 if ((ret = strdup(str)) == NULL)
585 (void) no_memory(hdl);
586
587 return (ret);
588}
589
590/*
591 * Convert a number to an appropriately human-readable output.
592 */
593void
594zfs_nicenum(uint64_t num, char *buf, size_t buflen)
595{
596 uint64_t n = num;
597 int index = 0;
598 char u;
599
ea04106b 600 while (n >= 1024 && index < 6) {
34dc7c2f
BB
601 n /= 1024;
602 index++;
603 }
604
605 u = " KMGTPE"[index];
606
607 if (index == 0) {
b8864a23 608 (void) snprintf(buf, buflen, "%llu", (u_longlong_t) n);
34dc7c2f
BB
609 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) {
610 /*
611 * If this is an even multiple of the base, always display
612 * without any decimal precision.
613 */
b8864a23 614 (void) snprintf(buf, buflen, "%llu%c", (u_longlong_t) n, u);
34dc7c2f
BB
615 } else {
616 /*
617 * We want to choose a precision that reflects the best choice
618 * for fitting in 5 characters. This can get rather tricky when
619 * we have numbers that are very close to an order of magnitude.
620 * For example, when displaying 10239 (which is really 9.999K),
621 * we want only a single place of precision for 10.0K. We could
622 * develop some complex heuristics for this, but it's much
623 * easier just to try each combination in turn.
624 */
625 int i;
626 for (i = 2; i >= 0; i--) {
627 if (snprintf(buf, buflen, "%.*f%c", i,
628 (double)num / (1ULL << 10 * index), u) <= 5)
629 break;
630 }
631 }
632}
633
634void
635libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr)
636{
637 hdl->libzfs_printerr = printerr;
638}
639
4b1abce9
NB
640static int
641libzfs_module_loaded(const char *module)
642{
f09398ce
ED
643 const char path_prefix[] = "/sys/module/";
644 char path[256];
645
a08ee875
LG
646 memcpy(path, path_prefix, sizeof (path_prefix) - 1);
647 strcpy(path + sizeof (path_prefix) - 1, module);
4b1abce9 648
f09398ce 649 return (access(path, F_OK) == 0);
4b1abce9
NB
650}
651
feb46b92 652int
9ac97c2a 653libzfs_run_process(const char *path, char *argv[], int flags)
4b1abce9
NB
654{
655 pid_t pid;
e10b0808 656 int error, devnull_fd;
4b1abce9
NB
657
658 pid = vfork();
659 if (pid == 0) {
3132cb39
GB
660 devnull_fd = open("/dev/null", O_WRONLY);
661
662 if (devnull_fd < 0)
663 _exit(-1);
664
9ac97c2a 665 if (!(flags & STDOUT_VERBOSE))
3132cb39 666 (void) dup2(devnull_fd, STDOUT_FILENO);
9ac97c2a
BB
667
668 if (!(flags & STDERR_VERBOSE))
3132cb39
GB
669 (void) dup2(devnull_fd, STDERR_FILENO);
670
671 close(devnull_fd);
9ac97c2a 672
4b1abce9
NB
673 (void) execvp(path, argv);
674 _exit(-1);
675 } else if (pid > 0) {
676 int status;
677
e10b0808 678 while ((error = waitpid(pid, &status, 0)) == -1 &&
4b1abce9 679 errno == EINTR);
e10b0808 680 if (error < 0 || !WIFEXITED(status))
a08ee875 681 return (-1);
4b1abce9 682
a08ee875 683 return (WEXITSTATUS(status));
4b1abce9
NB
684 }
685
a08ee875 686 return (-1);
4b1abce9
NB
687}
688
ea04106b
AX
689/*
690 * Verify the required ZFS_DEV device is available and optionally attempt
691 * to load the ZFS modules. Under normal circumstances the modules
692 * should already have been loaded by some external mechanism.
693 *
694 * Environment variables:
695 * - ZFS_MODULE_LOADING="YES|yes|ON|on" - Attempt to load modules.
696 * - ZFS_MODULE_TIMEOUT="<seconds>" - Seconds to wait for ZFS_DEV
697 */
e10b0808 698static int
4b1abce9
NB
699libzfs_load_module(const char *module)
700{
701 char *argv[4] = {"/sbin/modprobe", "-q", (char *)module, (char *)0};
ea04106b
AX
702 char *load_str, *timeout_str;
703 long timeout = 10; /* seconds */
704 long busy_timeout = 10; /* milliseconds */
e10b0808 705 int load = 0, fd;
ea04106b
AX
706 hrtime_t start;
707
708 /* Optionally request module loading */
709 if (!libzfs_module_loaded(module)) {
710 load_str = getenv("ZFS_MODULE_LOADING");
711 if (load_str) {
712 if (!strncasecmp(load_str, "YES", strlen("YES")) ||
713 !strncasecmp(load_str, "ON", strlen("ON")))
714 load = 1;
715 else
716 load = 0;
717 }
4b1abce9 718
ea04106b
AX
719 if (load && libzfs_run_process("/sbin/modprobe", argv, 0))
720 return (ENOEXEC);
721 }
feb46b92 722
ea04106b
AX
723 /* Module loading is synchronous it must be available */
724 if (!libzfs_module_loaded(module))
725 return (ENXIO);
726
727 /*
728 * Device creation by udev is asynchronous and waiting may be
729 * required. Busy wait for 10ms and then fall back to polling every
730 * 10ms for the allowed timeout (default 10s, max 10m). This is
731 * done to optimize for the common case where the device is
732 * immediately available and to avoid penalizing the possible
733 * case where udev is slow or unable to create the device.
734 */
735 timeout_str = getenv("ZFS_MODULE_TIMEOUT");
736 if (timeout_str) {
737 timeout = strtol(timeout_str, NULL, 0);
738 timeout = MAX(MIN(timeout, (10 * 60)), 0); /* 0 <= N <= 600 */
739 }
740
741 start = gethrtime();
742 do {
743 fd = open(ZFS_DEV, O_RDWR);
744 if (fd >= 0) {
745 (void) close(fd);
746 return (0);
747 } else if (errno != ENOENT) {
748 return (errno);
749 } else if (NSEC2MSEC(gethrtime() - start) < busy_timeout) {
750 sched_yield();
751 } else {
752 usleep(10 * MILLISEC);
753 }
754 } while (NSEC2MSEC(gethrtime() - start) < (timeout * MILLISEC));
755
756 return (ENOENT);
4b1abce9
NB
757}
758
34dc7c2f
BB
759libzfs_handle_t *
760libzfs_init(void)
761{
762 libzfs_handle_t *hdl;
ea04106b 763 int error;
34dc7c2f 764
ea04106b
AX
765 error = libzfs_load_module(ZFS_DRIVER);
766 if (error) {
e10b0808 767 errno = error;
4b1abce9
NB
768 return (NULL);
769 }
770
572e2857 771 if ((hdl = calloc(1, sizeof (libzfs_handle_t))) == NULL) {
34dc7c2f
BB
772 return (NULL);
773 }
774
775 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) {
776 free(hdl);
777 return (NULL);
778 }
779
2eadf037
BB
780#ifdef HAVE_SETMNTENT
781 if ((hdl->libzfs_mnttab = setmntent(MNTTAB, "r")) == NULL) {
782#else
34dc7c2f 783 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) {
2eadf037 784#endif
34dc7c2f
BB
785 (void) close(hdl->libzfs_fd);
786 free(hdl);
787 return (NULL);
788 }
789
790 hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r");
791
a08ee875
LG
792 if (libzfs_core_init() != 0) {
793 (void) close(hdl->libzfs_fd);
794 (void) fclose(hdl->libzfs_mnttab);
795 (void) fclose(hdl->libzfs_sharetab);
796 free(hdl);
797 return (NULL);
798 }
799
34dc7c2f
BB
800 zfs_prop_init();
801 zpool_prop_init();
9ae529ec 802 zpool_feature_init();
9babb374 803 libzfs_mnttab_init(hdl);
34dc7c2f
BB
804
805 return (hdl);
806}
807
808void
809libzfs_fini(libzfs_handle_t *hdl)
810{
811 (void) close(hdl->libzfs_fd);
812 if (hdl->libzfs_mnttab)
2eadf037
BB
813#ifdef HAVE_SETMNTENT
814 (void) endmntent(hdl->libzfs_mnttab);
815#else
34dc7c2f 816 (void) fclose(hdl->libzfs_mnttab);
2eadf037 817#endif
34dc7c2f
BB
818 if (hdl->libzfs_sharetab)
819 (void) fclose(hdl->libzfs_sharetab);
820 zfs_uninit_libshare(hdl);
b128c09f 821 zpool_free_handles(hdl);
428870ff 822 libzfs_fru_clear(hdl, B_TRUE);
34dc7c2f 823 namespace_clear(hdl);
9babb374 824 libzfs_mnttab_fini(hdl);
a08ee875 825 libzfs_core_fini();
34dc7c2f
BB
826 free(hdl);
827}
828
829libzfs_handle_t *
830zpool_get_handle(zpool_handle_t *zhp)
831{
832 return (zhp->zpool_hdl);
833}
834
835libzfs_handle_t *
836zfs_get_handle(zfs_handle_t *zhp)
837{
838 return (zhp->zfs_hdl);
839}
840
b128c09f
BB
841zpool_handle_t *
842zfs_get_pool_handle(const zfs_handle_t *zhp)
843{
844 return (zhp->zpool_hdl);
845}
846
34dc7c2f
BB
847/*
848 * Given a name, determine whether or not it's a valid path
849 * (starts with '/' or "./"). If so, walk the mnttab trying
850 * to match the device number. If not, treat the path as an
851 * fs/vol/snap name.
852 */
853zfs_handle_t *
854zfs_path_to_zhandle(libzfs_handle_t *hdl, char *path, zfs_type_t argtype)
855{
856 struct stat64 statbuf;
857 struct extmnttab entry;
858 int ret;
859
860 if (path[0] != '/' && strncmp(path, "./", strlen("./")) != 0) {
861 /*
862 * It's not a valid path, assume it's a name of type 'argtype'.
863 */
864 return (zfs_open(hdl, path, argtype));
865 }
866
867 if (stat64(path, &statbuf) != 0) {
868 (void) fprintf(stderr, "%s: %s\n", path, strerror(errno));
869 return (NULL);
870 }
871
ea04106b
AX
872 /* Reopen MNTTAB to prevent reading stale data from open file */
873 if (freopen(MNTTAB, "r", hdl->libzfs_mnttab) == NULL)
874 return (NULL);
875
34dc7c2f
BB
876 while ((ret = getextmntent(hdl->libzfs_mnttab, &entry, 0)) == 0) {
877 if (makedevice(entry.mnt_major, entry.mnt_minor) ==
878 statbuf.st_dev) {
879 break;
880 }
881 }
882 if (ret != 0) {
883 return (NULL);
884 }
885
886 if (strcmp(entry.mnt_fstype, MNTTYPE_ZFS) != 0) {
887 (void) fprintf(stderr, gettext("'%s': not a ZFS filesystem\n"),
888 path);
889 return (NULL);
890 }
891
892 return (zfs_open(hdl, entry.mnt_special, ZFS_TYPE_FILESYSTEM));
893}
894
79e7242a 895/*
eac47204
BB
896 * Append partition suffix to an otherwise fully qualified device path.
897 * This is used to generate the name the full path as its stored in
898 * ZPOOL_CONFIG_PATH for whole disk devices. On success the new length
899 * of 'path' will be returned on error a negative value is returned.
79e7242a
NB
900 */
901int
eac47204
BB
902zfs_append_partition(char *path, size_t max_len)
903{
904 int len = strlen(path);
905
906 if (strncmp(path, UDISK_ROOT, strlen(UDISK_ROOT)) == 0) {
907 if (len + 6 >= max_len)
908 return (-1);
909
910 (void) strcat(path, "-part1");
911 len += 6;
912 } else {
913 if (len + 2 >= max_len)
914 return (-1);
915
916 if (isdigit(path[len-1])) {
917 (void) strcat(path, "p1");
918 len += 2;
919 } else {
920 (void) strcat(path, "1");
921 len += 1;
922 }
79e7242a 923 }
b04c9fc0 924
eac47204 925 return (len);
79e7242a
NB
926}
927
928/*
eac47204
BB
929 * Given a shorthand device name check if a file by that name exists in any
930 * of the 'zpool_default_import_path' or ZPOOL_IMPORT_PATH directories. If
931 * one is found, store its fully qualified path in the 'path' buffer passed
932 * by the caller and return 0, otherwise return an error.
79e7242a 933 */
eac47204
BB
934int
935zfs_resolve_shortname(const char *name, char *path, size_t len)
79e7242a 936{
eac47204
BB
937 int i, error = -1;
938 char *dir, *env, *envdup;
939
940 env = getenv("ZPOOL_IMPORT_PATH");
941 errno = ENOENT;
942
943 if (env) {
944 envdup = strdup(env);
945 dir = strtok(envdup, ":");
946 while (dir && error) {
947 (void) snprintf(path, len, "%s/%s", dir, name);
948 error = access(path, F_OK);
949 dir = strtok(NULL, ":");
950 }
951 free(envdup);
952 } else {
953 for (i = 0; i < DEFAULT_IMPORT_PATH_SIZE && error < 0; i++) {
954 (void) snprintf(path, len, "%s/%s",
955 zpool_default_import_path[i], name);
956 error = access(path, F_OK);
957 }
958 }
959
960 return (error ? ENOENT : 0);
961}
962
963/*
964 * Given a shorthand device name look for a match against 'cmp_name'. This
965 * is done by checking all prefix expansions using either the default
966 * 'zpool_default_import_paths' or the ZPOOL_IMPORT_PATH environment
967 * variable. Proper partition suffixes will be appended if this is a
968 * whole disk. When a match is found 0 is returned otherwise ENOENT.
969 */
970static int
971zfs_strcmp_shortname(char *name, char *cmp_name, int wholedisk)
972{
973 int path_len, cmp_len, i = 0, error = ENOENT;
974 char *dir, *env, *envdup = NULL;
975 char path_name[MAXPATHLEN];
976
977 cmp_len = strlen(cmp_name);
978 env = getenv("ZPOOL_IMPORT_PATH");
979
980 if (env) {
981 envdup = strdup(env);
982 dir = strtok(envdup, ":");
983 } else {
984 dir = zpool_default_import_path[i];
985 }
986
987 while (dir) {
988 /* Trim trailing directory slashes from ZPOOL_IMPORT_PATH */
989 while (dir[strlen(dir)-1] == '/')
990 dir[strlen(dir)-1] = '\0';
991
992 path_len = snprintf(path_name, MAXPATHLEN, "%s/%s", dir, name);
993 if (wholedisk)
994 path_len = zfs_append_partition(path_name, MAXPATHLEN);
995
a08ee875 996 if ((path_len == cmp_len) && strcmp(path_name, cmp_name) == 0) {
eac47204
BB
997 error = 0;
998 break;
999 }
1000
1001 if (env) {
1002 dir = strtok(NULL, ":");
1003 } else if (++i < DEFAULT_IMPORT_PATH_SIZE) {
1004 dir = zpool_default_import_path[i];
1005 } else {
1006 dir = NULL;
1007 }
1008 }
1009
1010 if (env)
1011 free(envdup);
1012
1013 return (error);
1014}
1015
1016/*
1017 * Given either a shorthand or fully qualified path name look for a match
1018 * against 'cmp'. The passed name will be expanded as needed for comparison
1019 * purposes and redundant slashes stripped to ensure an accurate match.
1020 */
1021int
1022zfs_strcmp_pathname(char *name, char *cmp, int wholedisk)
1023{
1024 int path_len, cmp_len;
1025 char path_name[MAXPATHLEN];
1026 char cmp_name[MAXPATHLEN];
1027 char *dir;
1028
1029 /* Strip redundant slashes if one exists due to ZPOOL_IMPORT_PATH */
1030 memset(cmp_name, 0, MAXPATHLEN);
1031 dir = strtok(cmp, "/");
1032 while (dir) {
1033 strcat(cmp_name, "/");
1034 strcat(cmp_name, dir);
1035 dir = strtok(NULL, "/");
1036 }
1037
1038 if (name[0] != '/')
a08ee875 1039 return (zfs_strcmp_shortname(name, cmp_name, wholedisk));
eac47204 1040
ea04106b 1041 (void) strlcpy(path_name, name, MAXPATHLEN);
eac47204
BB
1042 path_len = strlen(path_name);
1043 cmp_len = strlen(cmp_name);
1044
1045 if (wholedisk) {
1046 path_len = zfs_append_partition(path_name, MAXPATHLEN);
1047 if (path_len == -1)
1048 return (ENOMEM);
1049 }
1050
1051 if ((path_len != cmp_len) || strcmp(path_name, cmp_name))
1052 return (ENOENT);
1053
1054 return (0);
79e7242a
NB
1055}
1056
34dc7c2f
BB
1057/*
1058 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from
1059 * an ioctl().
1060 */
1061int
1062zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len)
1063{
1064 if (len == 0)
572e2857 1065 len = 16 * 1024;
34dc7c2f
BB
1066 zc->zc_nvlist_dst_size = len;
1067 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
b8864a23 1068 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
34dc7c2f
BB
1069 return (-1);
1070
1071 return (0);
1072}
1073
1074/*
1075 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will
1076 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was
1077 * filled in by the kernel to indicate the actual required size.
1078 */
1079int
1080zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc)
1081{
1082 free((void *)(uintptr_t)zc->zc_nvlist_dst);
1083 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t)
b8864a23 1084 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == 0)
34dc7c2f
BB
1085 return (-1);
1086
1087 return (0);
1088}
1089
1090/*
1091 * Called to free the src and dst nvlists stored in the command structure.
1092 */
1093void
1094zcmd_free_nvlists(zfs_cmd_t *zc)
1095{
1096 free((void *)(uintptr_t)zc->zc_nvlist_conf);
1097 free((void *)(uintptr_t)zc->zc_nvlist_src);
1098 free((void *)(uintptr_t)zc->zc_nvlist_dst);
1099}
1100
1101static int
1102zcmd_write_nvlist_com(libzfs_handle_t *hdl, uint64_t *outnv, uint64_t *outlen,
1103 nvlist_t *nvl)
1104{
1105 char *packed;
1106 size_t len;
1107
1108 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0);
1109
1110 if ((packed = zfs_alloc(hdl, len)) == NULL)
1111 return (-1);
1112
1113 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0);
1114
1115 *outnv = (uint64_t)(uintptr_t)packed;
1116 *outlen = len;
1117
1118 return (0);
1119}
1120
1121int
1122zcmd_write_conf_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
1123{
1124 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_conf,
1125 &zc->zc_nvlist_conf_size, nvl));
1126}
1127
1128int
1129zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl)
1130{
1131 return (zcmd_write_nvlist_com(hdl, &zc->zc_nvlist_src,
1132 &zc->zc_nvlist_src_size, nvl));
1133}
1134
1135/*
1136 * Unpacks an nvlist from the ZFS ioctl command structure.
1137 */
1138int
1139zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp)
1140{
1141 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst,
1142 zc->zc_nvlist_dst_size, nvlp, 0) != 0)
1143 return (no_memory(hdl));
1144
1145 return (0);
1146}
1147
1148int
1149zfs_ioctl(libzfs_handle_t *hdl, int request, zfs_cmd_t *zc)
1150{
a08ee875 1151 return (ioctl(hdl->libzfs_fd, request, zc));
34dc7c2f
BB
1152}
1153
1154/*
1155 * ================================================================
1156 * API shared by zfs and zpool property management
1157 * ================================================================
1158 */
1159
1160static void
1161zprop_print_headers(zprop_get_cbdata_t *cbp, zfs_type_t type)
1162{
1163 zprop_list_t *pl = cbp->cb_proplist;
1164 int i;
1165 char *title;
1166 size_t len;
1167
1168 cbp->cb_first = B_FALSE;
1169 if (cbp->cb_scripted)
1170 return;
1171
1172 /*
1173 * Start with the length of the column headers.
1174 */
1175 cbp->cb_colwidths[GET_COL_NAME] = strlen(dgettext(TEXT_DOMAIN, "NAME"));
1176 cbp->cb_colwidths[GET_COL_PROPERTY] = strlen(dgettext(TEXT_DOMAIN,
1177 "PROPERTY"));
1178 cbp->cb_colwidths[GET_COL_VALUE] = strlen(dgettext(TEXT_DOMAIN,
1179 "VALUE"));
428870ff
BB
1180 cbp->cb_colwidths[GET_COL_RECVD] = strlen(dgettext(TEXT_DOMAIN,
1181 "RECEIVED"));
34dc7c2f
BB
1182 cbp->cb_colwidths[GET_COL_SOURCE] = strlen(dgettext(TEXT_DOMAIN,
1183 "SOURCE"));
1184
fb5f0bc8
BB
1185 /* first property is always NAME */
1186 assert(cbp->cb_proplist->pl_prop ==
1187 ((type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME : ZFS_PROP_NAME));
1188
34dc7c2f
BB
1189 /*
1190 * Go through and calculate the widths for each column. For the
1191 * 'source' column, we kludge it up by taking the worst-case scenario of
1192 * inheriting from the longest name. This is acceptable because in the
1193 * majority of cases 'SOURCE' is the last column displayed, and we don't
1194 * use the width anyway. Note that the 'VALUE' column can be oversized,
428870ff 1195 * if the name of the property is much longer than any values we find.
34dc7c2f
BB
1196 */
1197 for (pl = cbp->cb_proplist; pl != NULL; pl = pl->pl_next) {
1198 /*
1199 * 'PROPERTY' column
1200 */
1201 if (pl->pl_prop != ZPROP_INVAL) {
1202 const char *propname = (type == ZFS_TYPE_POOL) ?
1203 zpool_prop_to_name(pl->pl_prop) :
1204 zfs_prop_to_name(pl->pl_prop);
1205
1206 len = strlen(propname);
1207 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1208 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1209 } else {
1210 len = strlen(pl->pl_user_prop);
1211 if (len > cbp->cb_colwidths[GET_COL_PROPERTY])
1212 cbp->cb_colwidths[GET_COL_PROPERTY] = len;
1213 }
1214
1215 /*
fb5f0bc8
BB
1216 * 'VALUE' column. The first property is always the 'name'
1217 * property that was tacked on either by /sbin/zfs's
1218 * zfs_do_get() or when calling zprop_expand_list(), so we
1219 * ignore its width. If the user specified the name property
1220 * to display, then it will be later in the list in any case.
34dc7c2f 1221 */
fb5f0bc8 1222 if (pl != cbp->cb_proplist &&
34dc7c2f
BB
1223 pl->pl_width > cbp->cb_colwidths[GET_COL_VALUE])
1224 cbp->cb_colwidths[GET_COL_VALUE] = pl->pl_width;
1225
428870ff
BB
1226 /* 'RECEIVED' column. */
1227 if (pl != cbp->cb_proplist &&
1228 pl->pl_recvd_width > cbp->cb_colwidths[GET_COL_RECVD])
1229 cbp->cb_colwidths[GET_COL_RECVD] = pl->pl_recvd_width;
1230
34dc7c2f
BB
1231 /*
1232 * 'NAME' and 'SOURCE' columns
1233 */
1234 if (pl->pl_prop == (type == ZFS_TYPE_POOL ? ZPOOL_PROP_NAME :
1235 ZFS_PROP_NAME) &&
1236 pl->pl_width > cbp->cb_colwidths[GET_COL_NAME]) {
1237 cbp->cb_colwidths[GET_COL_NAME] = pl->pl_width;
1238 cbp->cb_colwidths[GET_COL_SOURCE] = pl->pl_width +
1239 strlen(dgettext(TEXT_DOMAIN, "inherited from"));
1240 }
1241 }
1242
1243 /*
1244 * Now go through and print the headers.
1245 */
428870ff 1246 for (i = 0; i < ZFS_GET_NCOLS; i++) {
34dc7c2f
BB
1247 switch (cbp->cb_columns[i]) {
1248 case GET_COL_NAME:
1249 title = dgettext(TEXT_DOMAIN, "NAME");
1250 break;
1251 case GET_COL_PROPERTY:
1252 title = dgettext(TEXT_DOMAIN, "PROPERTY");
1253 break;
1254 case GET_COL_VALUE:
1255 title = dgettext(TEXT_DOMAIN, "VALUE");
1256 break;
428870ff
BB
1257 case GET_COL_RECVD:
1258 title = dgettext(TEXT_DOMAIN, "RECEIVED");
1259 break;
34dc7c2f
BB
1260 case GET_COL_SOURCE:
1261 title = dgettext(TEXT_DOMAIN, "SOURCE");
1262 break;
1263 default:
1264 title = NULL;
1265 }
1266
1267 if (title != NULL) {
428870ff
BB
1268 if (i == (ZFS_GET_NCOLS - 1) ||
1269 cbp->cb_columns[i + 1] == GET_COL_NONE)
34dc7c2f
BB
1270 (void) printf("%s", title);
1271 else
1272 (void) printf("%-*s ",
1273 cbp->cb_colwidths[cbp->cb_columns[i]],
1274 title);
1275 }
1276 }
1277 (void) printf("\n");
1278}
1279
1280/*
1281 * Display a single line of output, according to the settings in the callback
1282 * structure.
1283 */
1284void
1285zprop_print_one_property(const char *name, zprop_get_cbdata_t *cbp,
1286 const char *propname, const char *value, zprop_source_t sourcetype,
428870ff 1287 const char *source, const char *recvd_value)
34dc7c2f
BB
1288{
1289 int i;
d4ed6673 1290 const char *str = NULL;
34dc7c2f
BB
1291 char buf[128];
1292
1293 /*
1294 * Ignore those source types that the user has chosen to ignore.
1295 */
1296 if ((sourcetype & cbp->cb_sources) == 0)
1297 return;
1298
1299 if (cbp->cb_first)
1300 zprop_print_headers(cbp, cbp->cb_type);
1301
428870ff 1302 for (i = 0; i < ZFS_GET_NCOLS; i++) {
34dc7c2f
BB
1303 switch (cbp->cb_columns[i]) {
1304 case GET_COL_NAME:
1305 str = name;
1306 break;
1307
1308 case GET_COL_PROPERTY:
1309 str = propname;
1310 break;
1311
1312 case GET_COL_VALUE:
1313 str = value;
1314 break;
1315
1316 case GET_COL_SOURCE:
1317 switch (sourcetype) {
1318 case ZPROP_SRC_NONE:
1319 str = "-";
1320 break;
1321
1322 case ZPROP_SRC_DEFAULT:
1323 str = "default";
1324 break;
1325
1326 case ZPROP_SRC_LOCAL:
1327 str = "local";
1328 break;
1329
1330 case ZPROP_SRC_TEMPORARY:
1331 str = "temporary";
1332 break;
1333
1334 case ZPROP_SRC_INHERITED:
1335 (void) snprintf(buf, sizeof (buf),
1336 "inherited from %s", source);
1337 str = buf;
1338 break;
428870ff
BB
1339 case ZPROP_SRC_RECEIVED:
1340 str = "received";
1341 break;
34dc7c2f
BB
1342 }
1343 break;
1344
428870ff
BB
1345 case GET_COL_RECVD:
1346 str = (recvd_value == NULL ? "-" : recvd_value);
1347 break;
1348
34dc7c2f
BB
1349 default:
1350 continue;
1351 }
1352
428870ff 1353 if (cbp->cb_columns[i + 1] == GET_COL_NONE)
34dc7c2f
BB
1354 (void) printf("%s", str);
1355 else if (cbp->cb_scripted)
1356 (void) printf("%s\t", str);
1357 else
1358 (void) printf("%-*s ",
1359 cbp->cb_colwidths[cbp->cb_columns[i]],
1360 str);
34dc7c2f
BB
1361 }
1362
1363 (void) printf("\n");
1364}
1365
1366/*
1367 * Given a numeric suffix, convert the value into a number of bits that the
1368 * resulting value must be shifted.
1369 */
1370static int
1371str2shift(libzfs_handle_t *hdl, const char *buf)
1372{
1373 const char *ends = "BKMGTPEZ";
1374 int i;
1375
1376 if (buf[0] == '\0')
1377 return (0);
1378 for (i = 0; i < strlen(ends); i++) {
1379 if (toupper(buf[0]) == ends[i])
1380 break;
1381 }
1382 if (i == strlen(ends)) {
53c2ec1d
JL
1383 if (hdl)
1384 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1385 "invalid numeric suffix '%s'"), buf);
34dc7c2f
BB
1386 return (-1);
1387 }
1388
1389 /*
826ab7ad
RL
1390 * Allow 'G' = 'GB' = 'GiB', case-insensitively.
1391 * However, 'BB' and 'BiB' are disallowed.
34dc7c2f 1392 */
826ab7ad
RL
1393 if (buf[1] == '\0' ||
1394 (toupper(buf[0]) != 'B' &&
a08ee875
LG
1395 ((toupper(buf[1]) == 'B' && buf[2] == '\0') ||
1396 (toupper(buf[1]) == 'I' && toupper(buf[2]) == 'B' &&
1397 buf[3] == '\0'))))
1398 return (10 * i);
34dc7c2f 1399
53c2ec1d
JL
1400 if (hdl)
1401 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1402 "invalid numeric suffix '%s'"), buf);
34dc7c2f
BB
1403 return (-1);
1404}
1405
1406/*
1407 * Convert a string of the form '100G' into a real number. Used when setting
1408 * properties or creating a volume. 'buf' is used to place an extended error
1409 * message for the caller to use.
1410 */
1411int
1412zfs_nicestrtonum(libzfs_handle_t *hdl, const char *value, uint64_t *num)
1413{
1414 char *end;
1415 int shift;
1416
1417 *num = 0;
1418
1419 /* Check to see if this looks like a number. */
1420 if ((value[0] < '0' || value[0] > '9') && value[0] != '.') {
1421 if (hdl)
1422 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1423 "bad numeric value '%s'"), value);
1424 return (-1);
1425 }
1426
428870ff 1427 /* Rely on strtoull() to process the numeric portion. */
34dc7c2f 1428 errno = 0;
d164b209 1429 *num = strtoull(value, &end, 10);
34dc7c2f
BB
1430
1431 /*
1432 * Check for ERANGE, which indicates that the value is too large to fit
1433 * in a 64-bit value.
1434 */
1435 if (errno == ERANGE) {
1436 if (hdl)
1437 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1438 "numeric value is too large"));
1439 return (-1);
1440 }
1441
1442 /*
1443 * If we have a decimal value, then do the computation with floating
1444 * point arithmetic. Otherwise, use standard arithmetic.
1445 */
1446 if (*end == '.') {
1447 double fval = strtod(value, &end);
1448
1449 if ((shift = str2shift(hdl, end)) == -1)
1450 return (-1);
1451
1452 fval *= pow(2, shift);
1453
1454 if (fval > UINT64_MAX) {
1455 if (hdl)
1456 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1457 "numeric value is too large"));
1458 return (-1);
1459 }
1460
1461 *num = (uint64_t)fval;
1462 } else {
1463 if ((shift = str2shift(hdl, end)) == -1)
1464 return (-1);
1465
1466 /* Check for overflow */
1467 if (shift >= 64 || (*num << shift) >> shift != *num) {
1468 if (hdl)
1469 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1470 "numeric value is too large"));
1471 return (-1);
1472 }
1473
1474 *num <<= shift;
1475 }
1476
1477 return (0);
1478}
1479
1480/*
1481 * Given a propname=value nvpair to set, parse any numeric properties
1482 * (index, boolean, etc) if they are specified as strings and add the
1483 * resulting nvpair to the returned nvlist.
1484 *
1485 * At the DSL layer, all properties are either 64-bit numbers or strings.
1486 * We want the user to be able to ignore this fact and specify properties
1487 * as native values (numbers, for example) or as strings (to simplify
1488 * command line utilities). This also handles converting index types
1489 * (compression, checksum, etc) from strings to their on-disk index.
1490 */
1491int
1492zprop_parse_value(libzfs_handle_t *hdl, nvpair_t *elem, int prop,
1493 zfs_type_t type, nvlist_t *ret, char **svalp, uint64_t *ivalp,
1494 const char *errbuf)
1495{
1496 data_type_t datatype = nvpair_type(elem);
1497 zprop_type_t proptype;
1498 const char *propname;
1499 char *value;
1500 boolean_t isnone = B_FALSE;
1501
1502 if (type == ZFS_TYPE_POOL) {
1503 proptype = zpool_prop_get_type(prop);
1504 propname = zpool_prop_to_name(prop);
1505 } else {
1506 proptype = zfs_prop_get_type(prop);
1507 propname = zfs_prop_to_name(prop);
1508 }
1509
1510 /*
1511 * Convert any properties to the internal DSL value types.
1512 */
1513 *svalp = NULL;
1514 *ivalp = 0;
1515
1516 switch (proptype) {
1517 case PROP_TYPE_STRING:
1518 if (datatype != DATA_TYPE_STRING) {
1519 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1520 "'%s' must be a string"), nvpair_name(elem));
1521 goto error;
1522 }
1523 (void) nvpair_value_string(elem, svalp);
1524 if (strlen(*svalp) >= ZFS_MAXPROPLEN) {
1525 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1526 "'%s' is too long"), nvpair_name(elem));
1527 goto error;
1528 }
1529 break;
1530
1531 case PROP_TYPE_NUMBER:
1532 if (datatype == DATA_TYPE_STRING) {
1533 (void) nvpair_value_string(elem, &value);
1534 if (strcmp(value, "none") == 0) {
1535 isnone = B_TRUE;
1536 } else if (zfs_nicestrtonum(hdl, value, ivalp)
1537 != 0) {
1538 goto error;
1539 }
1540 } else if (datatype == DATA_TYPE_UINT64) {
1541 (void) nvpair_value_uint64(elem, ivalp);
1542 } else {
1543 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1544 "'%s' must be a number"), nvpair_name(elem));
1545 goto error;
1546 }
1547
1548 /*
1549 * Quota special: force 'none' and don't allow 0.
1550 */
1551 if ((type & ZFS_TYPE_DATASET) && *ivalp == 0 && !isnone &&
1552 (prop == ZFS_PROP_QUOTA || prop == ZFS_PROP_REFQUOTA)) {
1553 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1554 "use 'none' to disable quota/refquota"));
1555 goto error;
1556 }
e10b0808
AX
1557
1558 /*
1559 * Special handling for "*_limit=none". In this case it's not
1560 * 0 but UINT64_MAX.
1561 */
1562 if ((type & ZFS_TYPE_DATASET) && isnone &&
1563 (prop == ZFS_PROP_FILESYSTEM_LIMIT ||
1564 prop == ZFS_PROP_SNAPSHOT_LIMIT)) {
1565 *ivalp = UINT64_MAX;
1566 }
34dc7c2f
BB
1567 break;
1568
1569 case PROP_TYPE_INDEX:
1570 if (datatype != DATA_TYPE_STRING) {
1571 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1572 "'%s' must be a string"), nvpair_name(elem));
1573 goto error;
1574 }
1575
1576 (void) nvpair_value_string(elem, &value);
1577
1578 if (zprop_string_to_index(prop, value, ivalp, type) != 0) {
1579 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1580 "'%s' must be one of '%s'"), propname,
1581 zprop_values(prop, type));
1582 goto error;
1583 }
1584 break;
1585
1586 default:
1587 abort();
1588 }
1589
1590 /*
1591 * Add the result to our return set of properties.
1592 */
1593 if (*svalp != NULL) {
1594 if (nvlist_add_string(ret, propname, *svalp) != 0) {
1595 (void) no_memory(hdl);
1596 return (-1);
1597 }
1598 } else {
1599 if (nvlist_add_uint64(ret, propname, *ivalp) != 0) {
1600 (void) no_memory(hdl);
1601 return (-1);
1602 }
1603 }
1604
1605 return (0);
1606error:
1607 (void) zfs_error(hdl, EZFS_BADPROP, errbuf);
1608 return (-1);
1609}
1610
b128c09f
BB
1611static int
1612addlist(libzfs_handle_t *hdl, char *propname, zprop_list_t **listp,
1613 zfs_type_t type)
1614{
1615 int prop;
1616 zprop_list_t *entry;
1617
1618 prop = zprop_name_to_prop(propname, type);
1619
ea04106b 1620 if (prop != ZPROP_INVAL && !zprop_valid_for_type(prop, type, B_FALSE))
b128c09f
BB
1621 prop = ZPROP_INVAL;
1622
1623 /*
1624 * When no property table entry can be found, return failure if
1625 * this is a pool property or if this isn't a user-defined
1626 * dataset property,
1627 */
9ae529ec
CS
1628 if (prop == ZPROP_INVAL && ((type == ZFS_TYPE_POOL &&
1629 !zpool_prop_feature(propname) &&
1630 !zpool_prop_unsupported(propname)) ||
1631 (type == ZFS_TYPE_DATASET && !zfs_prop_user(propname) &&
1632 !zfs_prop_userquota(propname) && !zfs_prop_written(propname)))) {
b128c09f
BB
1633 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1634 "invalid property '%s'"), propname);
1635 return (zfs_error(hdl, EZFS_BADPROP,
1636 dgettext(TEXT_DOMAIN, "bad property list")));
1637 }
1638
1639 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1640 return (-1);
1641
1642 entry->pl_prop = prop;
1643 if (prop == ZPROP_INVAL) {
9ae529ec
CS
1644 if ((entry->pl_user_prop = zfs_strdup(hdl, propname)) ==
1645 NULL) {
b128c09f
BB
1646 free(entry);
1647 return (-1);
1648 }
1649 entry->pl_width = strlen(propname);
1650 } else {
1651 entry->pl_width = zprop_width(prop, &entry->pl_fixed,
1652 type);
1653 }
1654
1655 *listp = entry;
1656
1657 return (0);
1658}
1659
34dc7c2f
BB
1660/*
1661 * Given a comma-separated list of properties, construct a property list
1662 * containing both user-defined and native properties. This function will
1663 * return a NULL list if 'all' is specified, which can later be expanded
1664 * by zprop_expand_list().
1665 */
1666int
1667zprop_get_list(libzfs_handle_t *hdl, char *props, zprop_list_t **listp,
1668 zfs_type_t type)
1669{
34dc7c2f 1670 *listp = NULL;
34dc7c2f
BB
1671
1672 /*
1673 * If 'all' is specified, return a NULL list.
1674 */
1675 if (strcmp(props, "all") == 0)
1676 return (0);
1677
1678 /*
1679 * If no props were specified, return an error.
1680 */
1681 if (props[0] == '\0') {
1682 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1683 "no properties specified"));
1684 return (zfs_error(hdl, EZFS_BADPROP, dgettext(TEXT_DOMAIN,
1685 "bad property list")));
1686 }
1687
1688 /*
1689 * It would be nice to use getsubopt() here, but the inclusion of column
1690 * aliases makes this more effort than it's worth.
1691 */
b128c09f
BB
1692 while (*props != '\0') {
1693 size_t len;
1694 char *p;
1695 char c;
1696
1697 if ((p = strchr(props, ',')) == NULL) {
1698 len = strlen(props);
1699 p = props + len;
34dc7c2f 1700 } else {
b128c09f 1701 len = p - props;
34dc7c2f
BB
1702 }
1703
1704 /*
1705 * Check for empty options.
1706 */
1707 if (len == 0) {
1708 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN,
1709 "empty property name"));
1710 return (zfs_error(hdl, EZFS_BADPROP,
1711 dgettext(TEXT_DOMAIN, "bad property list")));
1712 }
1713
1714 /*
1715 * Check all regular property names.
1716 */
b128c09f
BB
1717 c = props[len];
1718 props[len] = '\0';
1719
1720 if (strcmp(props, "space") == 0) {
1721 static char *spaceprops[] = {
1722 "name", "avail", "used", "usedbysnapshots",
1723 "usedbydataset", "usedbyrefreservation",
1724 "usedbychildren", NULL
1725 };
1726 int i;
1727
1728 for (i = 0; spaceprops[i]; i++) {
1729 if (addlist(hdl, spaceprops[i], listp, type))
1730 return (-1);
1731 listp = &(*listp)->pl_next;
34dc7c2f 1732 }
34dc7c2f 1733 } else {
b128c09f
BB
1734 if (addlist(hdl, props, listp, type))
1735 return (-1);
1736 listp = &(*listp)->pl_next;
34dc7c2f
BB
1737 }
1738
b128c09f 1739 props = p;
34dc7c2f 1740 if (c == ',')
b128c09f 1741 props++;
34dc7c2f
BB
1742 }
1743
1744 return (0);
1745}
1746
1747void
1748zprop_free_list(zprop_list_t *pl)
1749{
1750 zprop_list_t *next;
1751
1752 while (pl != NULL) {
1753 next = pl->pl_next;
1754 free(pl->pl_user_prop);
1755 free(pl);
1756 pl = next;
1757 }
1758}
1759
1760typedef struct expand_data {
1761 zprop_list_t **last;
1762 libzfs_handle_t *hdl;
1763 zfs_type_t type;
1764} expand_data_t;
1765
1766int
1767zprop_expand_list_cb(int prop, void *cb)
1768{
1769 zprop_list_t *entry;
1770 expand_data_t *edp = cb;
1771
1772 if ((entry = zfs_alloc(edp->hdl, sizeof (zprop_list_t))) == NULL)
1773 return (ZPROP_INVAL);
1774
1775 entry->pl_prop = prop;
1776 entry->pl_width = zprop_width(prop, &entry->pl_fixed, edp->type);
1777 entry->pl_all = B_TRUE;
1778
1779 *(edp->last) = entry;
1780 edp->last = &entry->pl_next;
1781
1782 return (ZPROP_CONT);
1783}
1784
1785int
1786zprop_expand_list(libzfs_handle_t *hdl, zprop_list_t **plp, zfs_type_t type)
1787{
1788 zprop_list_t *entry;
1789 zprop_list_t **last;
1790 expand_data_t exp;
1791
1792 if (*plp == NULL) {
1793 /*
1794 * If this is the very first time we've been called for an 'all'
1795 * specification, expand the list to include all native
1796 * properties.
1797 */
1798 last = plp;
1799
1800 exp.last = last;
1801 exp.hdl = hdl;
1802 exp.type = type;
1803
1804 if (zprop_iter_common(zprop_expand_list_cb, &exp, B_FALSE,
1805 B_FALSE, type) == ZPROP_INVAL)
1806 return (-1);
1807
1808 /*
1809 * Add 'name' to the beginning of the list, which is handled
1810 * specially.
1811 */
1812 if ((entry = zfs_alloc(hdl, sizeof (zprop_list_t))) == NULL)
1813 return (-1);
1814
1815 entry->pl_prop = (type == ZFS_TYPE_POOL) ? ZPOOL_PROP_NAME :
1816 ZFS_PROP_NAME;
1817 entry->pl_width = zprop_width(entry->pl_prop,
1818 &entry->pl_fixed, type);
1819 entry->pl_all = B_TRUE;
1820 entry->pl_next = *plp;
1821 *plp = entry;
1822 }
1823 return (0);
1824}
1825
1826int
1827zprop_iter(zprop_func func, void *cb, boolean_t show_all, boolean_t ordered,
1828 zfs_type_t type)
1829{
1830 return (zprop_iter_common(func, cb, show_all, ordered, type));
1831}