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