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