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