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 /* 22 * Copyright 2006 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 26 #pragma ident "%Z%%M% %I% %E% SMI" 27 28 /* 29 * Internal utility routines for the ZFS library. 30 */ 31 32 #include <errno.h> 33 #include <fcntl.h> 34 #include <libintl.h> 35 #include <stdarg.h> 36 #include <stdio.h> 37 #include <stdlib.h> 38 #include <strings.h> 39 #include <unistd.h> 40 #include <sys/mnttab.h> 41 42 #include <libzfs.h> 43 44 #include "libzfs_impl.h" 45 46 int 47 libzfs_errno(libzfs_handle_t *hdl) 48 { 49 return (hdl->libzfs_error); 50 } 51 52 const char * 53 libzfs_error_action(libzfs_handle_t *hdl) 54 { 55 return (hdl->libzfs_action); 56 } 57 58 const char * 59 libzfs_error_description(libzfs_handle_t *hdl) 60 { 61 if (hdl->libzfs_desc[0] != '\0') 62 return (hdl->libzfs_desc); 63 64 switch (hdl->libzfs_error) { 65 case EZFS_NOMEM: 66 return (dgettext(TEXT_DOMAIN, "out of memory")); 67 case EZFS_BADPROP: 68 return (dgettext(TEXT_DOMAIN, "invalid property value")); 69 case EZFS_PROPREADONLY: 70 return (dgettext(TEXT_DOMAIN, "read only property")); 71 case EZFS_PROPTYPE: 72 return (dgettext(TEXT_DOMAIN, "property doesn't apply to " 73 "datasets of this type")); 74 case EZFS_PROPNONINHERIT: 75 return (dgettext(TEXT_DOMAIN, "property cannot be inherited")); 76 case EZFS_PROPSPACE: 77 return (dgettext(TEXT_DOMAIN, "invalid quota or reservation")); 78 case EZFS_BADTYPE: 79 return (dgettext(TEXT_DOMAIN, "operation not applicable to " 80 "datasets of this type")); 81 case EZFS_BUSY: 82 return (dgettext(TEXT_DOMAIN, "pool or dataset is busy")); 83 case EZFS_EXISTS: 84 return (dgettext(TEXT_DOMAIN, "pool or dataset exists")); 85 case EZFS_NOENT: 86 return (dgettext(TEXT_DOMAIN, "no such pool or dataset")); 87 case EZFS_BADSTREAM: 88 return (dgettext(TEXT_DOMAIN, "invalid backup stream")); 89 case EZFS_DSREADONLY: 90 return (dgettext(TEXT_DOMAIN, "dataset is read only")); 91 case EZFS_VOLTOOBIG: 92 return (dgettext(TEXT_DOMAIN, "volume size exceeds limit for " 93 "this system")); 94 case EZFS_VOLHASDATA: 95 return (dgettext(TEXT_DOMAIN, "volume has data")); 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_DEVLINKS: 135 return (dgettext(TEXT_DOMAIN, "failed to create /dev links")); 136 case EZFS_PERM: 137 return (dgettext(TEXT_DOMAIN, "permission denied")); 138 case EZFS_NOSPC: 139 return (dgettext(TEXT_DOMAIN, "out of space")); 140 case EZFS_IO: 141 return (dgettext(TEXT_DOMAIN, "I/O error")); 142 case EZFS_INTR: 143 return (dgettext(TEXT_DOMAIN, "signal received")); 144 case EZFS_ISSPARE: 145 return (dgettext(TEXT_DOMAIN, "device is reserved as a hot " 146 "spare")); 147 case EZFS_INVALCONFIG: 148 return (dgettext(TEXT_DOMAIN, "invalid vdev configuration")); 149 case EZFS_RECURSIVE: 150 return (dgettext(TEXT_DOMAIN, "recursive dataset dependency")); 151 case EZFS_NOHISTORY: 152 return (dgettext(TEXT_DOMAIN, "no history available")); 153 case EZFS_UNSHAREISCSIFAILED: 154 return (dgettext(TEXT_DOMAIN, 155 "iscsitgtd failed request to unshare")); 156 case EZFS_SHAREISCSIFAILED: 157 return (dgettext(TEXT_DOMAIN, 158 "iscsitgtd failed request to share")); 159 case EZFS_UNKNOWN: 160 return (dgettext(TEXT_DOMAIN, "unknown error")); 161 default: 162 assert(hdl->libzfs_error == 0); 163 return (dgettext(TEXT_DOMAIN, "no error")); 164 } 165 } 166 167 /*PRINTFLIKE2*/ 168 void 169 zfs_error_aux(libzfs_handle_t *hdl, const char *fmt, ...) 170 { 171 va_list ap; 172 173 va_start(ap, fmt); 174 175 (void) vsnprintf(hdl->libzfs_desc, sizeof (hdl->libzfs_desc), 176 fmt, ap); 177 hdl->libzfs_desc_active = 1; 178 179 va_end(ap); 180 } 181 182 static void 183 zfs_verror(libzfs_handle_t *hdl, int error, const char *fmt, va_list ap) 184 { 185 (void) vsnprintf(hdl->libzfs_action, sizeof (hdl->libzfs_action), 186 fmt, ap); 187 hdl->libzfs_error = error; 188 189 if (hdl->libzfs_desc_active) 190 hdl->libzfs_desc_active = 0; 191 else 192 hdl->libzfs_desc[0] = '\0'; 193 194 if (hdl->libzfs_printerr) { 195 if (error == EZFS_UNKNOWN) { 196 (void) fprintf(stderr, dgettext(TEXT_DOMAIN, "internal " 197 "error: %s\n"), libzfs_error_description(hdl)); 198 abort(); 199 } 200 201 (void) fprintf(stderr, "%s: %s\n", hdl->libzfs_action, 202 libzfs_error_description(hdl)); 203 if (error == EZFS_NOMEM) 204 exit(1); 205 } 206 } 207 208 /*PRINTFLIKE3*/ 209 int 210 zfs_error(libzfs_handle_t *hdl, int error, const char *fmt, ...) 211 { 212 va_list ap; 213 214 va_start(ap, fmt); 215 216 zfs_verror(hdl, error, fmt, ap); 217 218 va_end(ap); 219 220 return (-1); 221 } 222 223 static int 224 zfs_common_error(libzfs_handle_t *hdl, int error, const char *fmt, 225 va_list ap) 226 { 227 switch (error) { 228 case EPERM: 229 case EACCES: 230 zfs_verror(hdl, EZFS_PERM, fmt, ap); 231 return (-1); 232 233 case EIO: 234 zfs_verror(hdl, EZFS_IO, fmt, ap); 235 return (-1); 236 237 case EINTR: 238 zfs_verror(hdl, EZFS_INTR, fmt, ap); 239 return (-1); 240 } 241 242 return (0); 243 } 244 245 /*PRINTFLIKE3*/ 246 int 247 zfs_standard_error(libzfs_handle_t *hdl, int error, const char *fmt, ...) 248 { 249 va_list ap; 250 251 va_start(ap, fmt); 252 253 if (zfs_common_error(hdl, error, fmt, ap) != 0) { 254 va_end(ap); 255 return (-1); 256 } 257 258 259 switch (error) { 260 case ENXIO: 261 zfs_verror(hdl, EZFS_IO, fmt, ap); 262 break; 263 264 case ENOENT: 265 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 266 "dataset does not exist")); 267 zfs_verror(hdl, EZFS_NOENT, fmt, ap); 268 break; 269 270 case ENOSPC: 271 case EDQUOT: 272 zfs_verror(hdl, EZFS_NOSPC, fmt, ap); 273 return (-1); 274 275 case EEXIST: 276 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 277 "dataset already exists")); 278 zfs_verror(hdl, EZFS_EXISTS, fmt, ap); 279 break; 280 281 case EBUSY: 282 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 283 "dataset is busy")); 284 zfs_verror(hdl, EZFS_BUSY, fmt, ap); 285 break; 286 287 default: 288 zfs_error_aux(hdl, strerror(errno)); 289 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap); 290 break; 291 } 292 293 va_end(ap); 294 return (-1); 295 } 296 297 /*PRINTFLIKE3*/ 298 int 299 zpool_standard_error(libzfs_handle_t *hdl, int error, const char *fmt, ...) 300 { 301 va_list ap; 302 303 va_start(ap, fmt); 304 305 if (zfs_common_error(hdl, error, fmt, ap) != 0) { 306 va_end(ap); 307 return (-1); 308 } 309 310 switch (error) { 311 case ENODEV: 312 zfs_verror(hdl, EZFS_NODEVICE, fmt, ap); 313 break; 314 315 case ENOENT: 316 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "no such pool")); 317 zfs_verror(hdl, EZFS_NOENT, fmt, ap); 318 break; 319 320 case EEXIST: 321 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 322 "pool already exists")); 323 zfs_verror(hdl, EZFS_EXISTS, fmt, ap); 324 break; 325 326 case EBUSY: 327 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, "pool is busy")); 328 zfs_verror(hdl, EZFS_EXISTS, fmt, ap); 329 break; 330 331 case ENXIO: 332 zfs_error_aux(hdl, dgettext(TEXT_DOMAIN, 333 "one or more devices is currently unavailable")); 334 zfs_verror(hdl, EZFS_BADDEV, fmt, ap); 335 break; 336 337 case ENAMETOOLONG: 338 zfs_verror(hdl, EZFS_DEVOVERFLOW, fmt, ap); 339 break; 340 341 default: 342 zfs_error_aux(hdl, strerror(error)); 343 zfs_verror(hdl, EZFS_UNKNOWN, fmt, ap); 344 } 345 346 va_end(ap); 347 return (-1); 348 } 349 350 /* 351 * Display an out of memory error message and abort the current program. 352 */ 353 int 354 no_memory(libzfs_handle_t *hdl) 355 { 356 return (zfs_error(hdl, EZFS_NOMEM, "internal error")); 357 } 358 359 /* 360 * A safe form of malloc() which will die if the allocation fails. 361 */ 362 void * 363 zfs_alloc(libzfs_handle_t *hdl, size_t size) 364 { 365 void *data; 366 367 if ((data = calloc(1, size)) == NULL) 368 (void) no_memory(hdl); 369 370 return (data); 371 } 372 373 /* 374 * A safe form of realloc(), which also zeroes newly allocated space. 375 */ 376 void * 377 zfs_realloc(libzfs_handle_t *hdl, void *ptr, size_t oldsize, size_t newsize) 378 { 379 void *ret; 380 381 if ((ret = realloc(ptr, newsize)) == NULL) { 382 (void) no_memory(hdl); 383 free(ptr); 384 return (NULL); 385 } 386 387 bzero((char *)ret + oldsize, (newsize - oldsize)); 388 return (ret); 389 } 390 391 /* 392 * A safe form of strdup() which will die if the allocation fails. 393 */ 394 char * 395 zfs_strdup(libzfs_handle_t *hdl, const char *str) 396 { 397 char *ret; 398 399 if ((ret = strdup(str)) == NULL) 400 (void) no_memory(hdl); 401 402 return (ret); 403 } 404 405 /* 406 * Convert a number to an appropriately human-readable output. 407 */ 408 void 409 zfs_nicenum(uint64_t num, char *buf, size_t buflen) 410 { 411 uint64_t n = num; 412 int index = 0; 413 char u; 414 415 while (n >= 1024) { 416 n /= 1024; 417 index++; 418 } 419 420 u = " KMGTPE"[index]; 421 422 if (index == 0) { 423 (void) snprintf(buf, buflen, "%llu", n); 424 } else if ((num & ((1ULL << 10 * index) - 1)) == 0) { 425 /* 426 * If this is an even multiple of the base, always display 427 * without any decimal precision. 428 */ 429 (void) snprintf(buf, buflen, "%llu%c", n, u); 430 } else { 431 /* 432 * We want to choose a precision that reflects the best choice 433 * for fitting in 5 characters. This can get rather tricky when 434 * we have numbers that are very close to an order of magnitude. 435 * For example, when displaying 10239 (which is really 9.999K), 436 * we want only a single place of precision for 10.0K. We could 437 * develop some complex heuristics for this, but it's much 438 * easier just to try each combination in turn. 439 */ 440 int i; 441 for (i = 2; i >= 0; i--) { 442 (void) snprintf(buf, buflen, "%.*f%c", i, 443 (double)num / (1ULL << 10 * index), u); 444 if (strlen(buf) <= 5) 445 break; 446 } 447 } 448 } 449 450 void 451 libzfs_print_on_error(libzfs_handle_t *hdl, boolean_t printerr) 452 { 453 hdl->libzfs_printerr = printerr; 454 } 455 456 libzfs_handle_t * 457 libzfs_init(void) 458 { 459 libzfs_handle_t *hdl; 460 461 if ((hdl = calloc(sizeof (libzfs_handle_t), 1)) == NULL) { 462 return (NULL); 463 } 464 465 if ((hdl->libzfs_fd = open(ZFS_DEV, O_RDWR)) < 0) { 466 free(hdl); 467 return (NULL); 468 } 469 470 if ((hdl->libzfs_mnttab = fopen(MNTTAB, "r")) == NULL) { 471 (void) close(hdl->libzfs_fd); 472 free(hdl); 473 return (NULL); 474 } 475 476 hdl->libzfs_sharetab = fopen("/etc/dfs/sharetab", "r"); 477 478 return (hdl); 479 } 480 481 void 482 libzfs_fini(libzfs_handle_t *hdl) 483 { 484 (void) close(hdl->libzfs_fd); 485 if (hdl->libzfs_mnttab) 486 (void) fclose(hdl->libzfs_mnttab); 487 if (hdl->libzfs_sharetab) 488 (void) fclose(hdl->libzfs_sharetab); 489 namespace_clear(hdl); 490 free(hdl); 491 } 492 493 libzfs_handle_t * 494 zpool_get_handle(zpool_handle_t *zhp) 495 { 496 return (zhp->zpool_hdl); 497 } 498 499 libzfs_handle_t * 500 zfs_get_handle(zfs_handle_t *zhp) 501 { 502 return (zhp->zfs_hdl); 503 } 504 505 /* 506 * Initialize the zc_nvlist_dst member to prepare for receiving an nvlist from 507 * an ioctl(). 508 */ 509 int 510 zcmd_alloc_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, size_t len) 511 { 512 if (len == 0) 513 len = 2048; 514 zc->zc_nvlist_dst_size = len; 515 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t) 516 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) == NULL) 517 return (-1); 518 519 return (0); 520 } 521 522 /* 523 * Called when an ioctl() which returns an nvlist fails with ENOMEM. This will 524 * expand the nvlist to the size specified in 'zc_nvlist_dst_size', which was 525 * filled in by the kernel to indicate the actual required size. 526 */ 527 int 528 zcmd_expand_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc) 529 { 530 free((void *)(uintptr_t)zc->zc_nvlist_dst); 531 if ((zc->zc_nvlist_dst = (uint64_t)(uintptr_t) 532 zfs_alloc(hdl, zc->zc_nvlist_dst_size)) 533 == NULL) 534 return (-1); 535 536 return (0); 537 } 538 539 /* 540 * Called to free the src and dst nvlists stored in the command structure. 541 */ 542 void 543 zcmd_free_nvlists(zfs_cmd_t *zc) 544 { 545 free((void *)(uintptr_t)zc->zc_nvlist_src); 546 free((void *)(uintptr_t)zc->zc_nvlist_dst); 547 } 548 549 int 550 zcmd_write_src_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t *nvl, 551 size_t *size) 552 { 553 char *packed; 554 size_t len; 555 556 verify(nvlist_size(nvl, &len, NV_ENCODE_NATIVE) == 0); 557 558 if ((packed = zfs_alloc(hdl, len)) == NULL) 559 return (-1); 560 561 verify(nvlist_pack(nvl, &packed, &len, NV_ENCODE_NATIVE, 0) == 0); 562 563 zc->zc_nvlist_src = (uint64_t)(uintptr_t)packed; 564 zc->zc_nvlist_src_size = len; 565 566 if (size) 567 *size = len; 568 return (0); 569 } 570 571 /* 572 * Unpacks an nvlist from the ZFS ioctl command structure. 573 */ 574 int 575 zcmd_read_dst_nvlist(libzfs_handle_t *hdl, zfs_cmd_t *zc, nvlist_t **nvlp) 576 { 577 if (nvlist_unpack((void *)(uintptr_t)zc->zc_nvlist_dst, 578 zc->zc_nvlist_dst_size, nvlp, 0) != 0) 579 return (no_memory(hdl)); 580 581 return (0); 582 } 583