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