libbb/xfuncs.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Utility routines.
   4  *
   5  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
   6  * Copyright (C) 2006 Rob Landley
   7  * Copyright (C) 2006 Denis Vlasenko
   8  *
   9  * Licensed under GPL version 2, see file LICENSE in this tarball for details.
  10  */
  11
  12 #include "libbb.h"
  13
  14 /* All the functions starting with "x" call bb_error_msg_and_die() if they
  15  * fail, so callers never need to check for errors.  If it returned, it
  16  * succeeded. */
  17
  18 #ifndef DMALLOC
  19 /* dmalloc provides variants of these that do abort() on failure.
  20  * Since dmalloc's prototypes overwrite the impls here as they are
  21  * included after these prototypes in libbb.h, all is well.
  22  */
  23 // Warn if we can't allocate size bytes of memory.
  24 void *malloc_or_warn(size_t size)
  25 {
  26         void *ptr = malloc(size);
  27         if (ptr == NULL && size != 0)
  28                 bb_error_msg(bb_msg_memory_exhausted);
  29         return ptr;
  30 }
  31
  32 // Die if we can't allocate size bytes of memory.
  33 void *xmalloc(size_t size)
  34 {
  35         void *ptr = malloc(size);
  36         if (ptr == NULL && size != 0)
  37                 bb_error_msg_and_die(bb_msg_memory_exhausted);
  38         return ptr;
  39 }
  40
  41 // Die if we can't resize previously allocated memory.  (This returns a pointer
  42 // to the new memory, which may or may not be the same as the old memory.
  43 // It'll copy the contents to a new chunk and free the old one if necessary.)
  44 void *xrealloc(void *ptr, size_t size)
  45 {
  46         ptr = realloc(ptr, size);
  47         if (ptr == NULL && size != 0)
  48                 bb_error_msg_and_die(bb_msg_memory_exhausted);
  49         return ptr;
  50 }
  51 #endif /* DMALLOC */
  52
  53 // Die if we can't allocate and zero size bytes of memory.
  54 void *xzalloc(size_t size)
  55 {
  56         void *ptr = xmalloc(size);
  57         memset(ptr, 0, size);
  58         return ptr;
  59 }
  60
  61 // Die if we can't copy a string to freshly allocated memory.
  62 char * xstrdup(const char *s)
  63 {
  64         char *t;
  65
  66         if (s == NULL)
  67                 return NULL;
  68
  69         t = strdup(s);
  70
  71         if (t == NULL)
  72                 bb_error_msg_and_die(bb_msg_memory_exhausted);
  73
  74         return t;
  75 }
  76
  77 // Die if we can't allocate n+1 bytes (space for the null terminator) and copy
  78 // the (possibly truncated to length n) string into it.
  79 char * xstrndup(const char *s, int n)
  80 {
  81         int m;
  82         char *t;
  83
  84         if (ENABLE_DEBUG && s == NULL)
  85                 bb_error_msg_and_die("xstrndup bug");
  86
  87         /* We can just xmalloc(n+1) and strncpy into it, */
  88         /* but think about xstrndup("abc", 10000) wastage! */
  89         m = n;
  90         t = (char*) s;
  91         while (m) {
  92                 if (!*t) break;
  93                 m--;
  94                 t++;
  95         }
  96         n -= m;
  97         t = xmalloc(n + 1);
  98         t[n] = '\0';
  99
 100         return memcpy(t, s, n);
 101 }
 102
 103 // Die if we can't open a file and return a FILE * to it.
 104 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
 105 FILE *xfopen(const char *path, const char *mode)
 106 {
 107         FILE *fp = fopen(path, mode);
 108         if (fp == NULL)
 109                 bb_perror_msg_and_die("can't open '%s'", path);
 110         return fp;
 111 }
 112
 113 // Die if we can't open a file and return a fd.
 114 int xopen3(const char *pathname, int flags, int mode)
 115 {
 116         int ret;
 117
 118         ret = open(pathname, flags, mode);
 119         if (ret < 0) {
 120                 bb_perror_msg_and_die("can't open '%s'", pathname);
 121         }
 122         return ret;
 123 }
 124
 125 // Die if we can't open an existing file and return a fd.
 126 int xopen(const char *pathname, int flags)
 127 {
 128         return xopen3(pathname, flags, 0666);
 129 }
 130
 131 // Warn if we can't open a file and return a fd.
 132 int open3_or_warn(const char *pathname, int flags, int mode)
 133 {
 134         int ret;
 135
 136         ret = open(pathname, flags, mode);
 137         if (ret < 0) {
 138                 bb_perror_msg("can't open '%s'", pathname);
 139         }
 140         return ret;
 141 }
 142
 143 // Warn if we can't open a file and return a fd.
 144 int open_or_warn(const char *pathname, int flags)
 145 {
 146         return open3_or_warn(pathname, flags, 0666);
 147 }
 148
 149 void xpipe(int filedes[2])
 150 {
 151         if (pipe(filedes))
 152                 bb_perror_msg_and_die("can't create pipe");
 153 }
 154
 155 void xunlink(const char *pathname)
 156 {
 157         if (unlink(pathname))
 158                 bb_perror_msg_and_die("can't remove file '%s'", pathname);
 159 }
 160
 161 // Turn on nonblocking I/O on a fd
 162 int ndelay_on(int fd)
 163 {
 164         return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL) | O_NONBLOCK);
 165 }
 166
 167 int ndelay_off(int fd)
 168 {
 169         return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL) & ~O_NONBLOCK);
 170 }
 171
 172 void xdup2(int from, int to)
 173 {
 174         if (dup2(from, to) != to)
 175                 bb_perror_msg_and_die("can't duplicate file descriptor");
 176 }
 177
 178 // "Renumber" opened fd
 179 void xmove_fd(int from, int to)
 180 {
 181         if (from == to)
 182                 return;
 183         xdup2(from, to);
 184         close(from);
 185 }
 186
 187 // Die with an error message if we can't write the entire buffer.
 188 void xwrite(int fd, const void *buf, size_t count)
 189 {
 190         if (count) {
 191                 ssize_t size = full_write(fd, buf, count);
 192                 if (size != count)
 193                         bb_error_msg_and_die("short write");
 194         }
 195 }
 196
 197 // Die with an error message if we can't lseek to the right spot.
 198 off_t xlseek(int fd, off_t offset, int whence)
 199 {
 200         off_t off = lseek(fd, offset, whence);
 201         if (off == (off_t)-1) {
 202                 if (whence == SEEK_SET)
 203                         bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
 204                 bb_perror_msg_and_die("lseek");
 205         }
 206         return off;
 207 }
 208
 209 // Die with supplied filename if this FILE * has ferror set.
 210 void die_if_ferror(FILE *fp, const char *fn)
 211 {
 212         if (ferror(fp)) {
 213                 /* ferror doesn't set useful errno */
 214                 bb_error_msg_and_die("%s: I/O error", fn);
 215         }
 216 }
 217
 218 // Die with an error message if stdout has ferror set.
 219 void die_if_ferror_stdout(void)
 220 {
 221         die_if_ferror(stdout, bb_msg_standard_output);
 222 }
 223
 224 // Die with an error message if we have trouble flushing stdout.
 225 void xfflush_stdout(void)
 226 {
 227         if (fflush(stdout)) {
 228                 bb_perror_msg_and_die(bb_msg_standard_output);
 229         }
 230 }
 231
 232 void sig_block(int sig)
 233 {
 234         sigset_t ss;
 235         sigemptyset(&ss);
 236         sigaddset(&ss, sig);
 237         sigprocmask(SIG_BLOCK, &ss, NULL);
 238 }
 239
 240 void sig_unblock(int sig)
 241 {
 242         sigset_t ss;
 243         sigemptyset(&ss);
 244         sigaddset(&ss, sig);
 245         sigprocmask(SIG_UNBLOCK, &ss, NULL);
 246 }
 247
 248 #if 0
 249 void sig_blocknone(void)
 250 {
 251         sigset_t ss;
 252         sigemptyset(&ss);
 253         sigprocmask(SIG_SETMASK, &ss, NULL);
 254 }
 255 #endif
 256
 257 void sig_catch(int sig, void (*f)(int))
 258 {
 259         struct sigaction sa;
 260         sa.sa_handler = f;
 261         sa.sa_flags = 0;
 262         sigemptyset(&sa.sa_mask);
 263         sigaction(sig, &sa, NULL);
 264 }
 265
 266 void sig_pause(void)
 267 {
 268         sigset_t ss;
 269         sigemptyset(&ss);
 270         sigsuspend(&ss);
 271 }
 272
 273
 274 void xsetenv(const char *key, const char *value)
 275 {
 276         if (setenv(key, value, 1))
 277                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 278 }
 279
 280 // Converts unsigned long long value into compact 4-char
 281 // representation. Examples: "1234", "1.2k", " 27M", "123T"
 282 // Fifth char is always '\0'
 283 void smart_ulltoa5(unsigned long long ul, char buf[5])
 284 {
 285         const char *fmt;
 286         char c;
 287         unsigned v, u, idx = 0;
 288
 289         if (ul > 9999) { // do not scale if 9999 or less
 290                 ul *= 10;
 291                 do {
 292                         ul /= 1024;
 293                         idx++;
 294                 } while (ul >= 10000);
 295         }
 296         v = ul; // ullong divisions are expensive, avoid them
 297
 298         fmt = " 123456789";
 299         u = v / 10;
 300         v = v % 10;
 301         if (!idx) {
 302                 // 9999 or less: use "1234" format
 303                 // u is value/10, v is last digit
 304                 c = buf[0] = " 123456789"[u/100];
 305                 if (c != ' ') fmt = "0123456789";
 306                 c = buf[1] = fmt[u/10%10];
 307                 if (c != ' ') fmt = "0123456789";
 308                 buf[2] = fmt[u%10];
 309                 buf[3] = "0123456789"[v];
 310         } else {
 311                 // u is value, v is 1/10ths (allows for 9.2M format)
 312                 if (u >= 10) {
 313                         // value is >= 10: use "123M', " 12M" formats
 314                         c = buf[0] = " 123456789"[u/100];
 315                         if (c != ' ') fmt = "0123456789";
 316                         v = u % 10;
 317                         u = u / 10;
 318                         buf[1] = fmt[u%10];
 319                 } else {
 320                         // value is < 10: use "9.2M" format
 321                         buf[0] = "0123456789"[u];
 322                         buf[1] = '.';
 323                 }
 324                 buf[2] = "0123456789"[v];
 325                 // see http://en.wikipedia.org/wiki/Tera
 326                 buf[3] = " kMGTPEZY"[idx];
 327         }
 328         buf[4] = '\0';
 329 }
 330
 331 // Convert unsigned integer to ascii, writing into supplied buffer.
 332 // A truncated result contains the first few digits of the result ala strncpy.
 333 // Returns a pointer past last generated digit, does _not_ store NUL.
 334 void BUG_sizeof_unsigned_not_4(void);
 335 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen)
 336 {
 337         unsigned i, out, res;
 338         if (sizeof(unsigned) != 4)
 339                 BUG_sizeof_unsigned_not_4();
 340         if (buflen) {
 341                 out = 0;
 342                 for (i = 1000000000; i; i /= 10) {
 343                         res = n / i;
 344                         if (res || out || i == 1) {
 345                                 if (!--buflen) break;
 346                                 out++;
 347                                 n -= res*i;
 348                                 *buf++ = '0' + res;
 349                         }
 350                 }
 351         }
 352         return buf;
 353 }
 354
 355 // Convert signed integer to ascii, like utoa_to_buf()
 356 char *itoa_to_buf(int n, char *buf, unsigned buflen)
 357 {
 358         if (buflen && n<0) {
 359                 n = -n;
 360                 *buf++ = '-';
 361                 buflen--;
 362         }
 363         return utoa_to_buf((unsigned)n, buf, buflen);
 364 }
 365
 366 // The following two functions use a static buffer, so calling either one a
 367 // second time will overwrite previous results.
 368 //
 369 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
 370 // Int should always be 32 bits on any remotely Unix-like system, see
 371 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
 372
 373 static char local_buf[12];
 374
 375 // Convert unsigned integer to ascii using a static buffer (returned).
 376 char *utoa(unsigned n)
 377 {
 378         *(utoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
 379
 380         return local_buf;
 381 }
 382
 383 // Convert signed integer to ascii using a static buffer (returned).
 384 char *itoa(int n)
 385 {
 386         *(itoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
 387
 388         return local_buf;
 389 }
 390
 391 // Emit a string of hex representation of bytes
 392 char *bin2hex(char *p, const char *cp, int count)
 393 {
 394         while (count) {
 395                 unsigned char c = *cp++;
 396                 /* put lowercase hex digits */
 397                 *p++ = 0x20 | bb_hexdigits_upcase[c >> 4];
 398                 *p++ = 0x20 | bb_hexdigits_upcase[c & 0xf];
 399                 count--;
 400         }
 401         return p;
 402 }
 403
 404 // Die with an error message if we can't set gid.  (Because resource limits may
 405 // limit this user to a given number of processes, and if that fills up the
 406 // setgid() will fail and we'll _still_be_root_, which is bad.)
 407 void xsetgid(gid_t gid)
 408 {
 409         if (setgid(gid)) bb_perror_msg_and_die("setgid");
 410 }
 411
 412 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
 413 void xsetuid(uid_t uid)
 414 {
 415         if (setuid(uid)) bb_perror_msg_and_die("setuid");
 416 }
 417
 418 // Return how long the file at fd is, if there's any way to determine it.
 419 off_t fdlength(int fd)
 420 {
 421         off_t bottom = 0, top = 0, pos;
 422         long size;
 423
 424         // If the ioctl works for this, return it.
 425
 426         if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
 427
 428         // FIXME: explain why lseek(SEEK_END) is not used here!
 429
 430         // If not, do a binary search for the last location we can read.  (Some
 431         // block devices don't do BLKGETSIZE right.)
 432
 433         do {
 434                 char temp;
 435
 436                 pos = bottom + (top - bottom) / 2;
 437
 438                 // If we can read from the current location, it's bigger.
 439
 440                 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
 441                         if (bottom == top) bottom = top = (top+1) * 2;
 442                         else bottom = pos;
 443
 444                 // If we can't, it's smaller.
 445
 446                 } else {
 447                         if (bottom == top) {
 448                                 if (!top) return 0;
 449                                 bottom = top/2;
 450                         }
 451                         else top = pos;
 452                 }
 453         } while (bottom + 1 != top);
 454
 455         return pos + 1;
 456 }
 457
 458 // Die with an error message if we can't malloc() enough space and do an
 459 // sprintf() into that space.
 460 char *xasprintf(const char *format, ...)
 461 {
 462         va_list p;
 463         int r;
 464         char *string_ptr;
 465
 466 #if 1
 467         // GNU extension
 468         va_start(p, format);
 469         r = vasprintf(&string_ptr, format, p);
 470         va_end(p);
 471 #else
 472         // Bloat for systems that haven't got the GNU extension.
 473         va_start(p, format);
 474         r = vsnprintf(NULL, 0, format, p);
 475         va_end(p);
 476         string_ptr = xmalloc(r+1);
 477         va_start(p, format);
 478         r = vsnprintf(string_ptr, r+1, format, p);
 479         va_end(p);
 480 #endif
 481
 482         if (r < 0)
 483                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 484         return string_ptr;
 485 }
 486
 487 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
 488 int fdprintf(int fd, const char *format, ...)
 489 {
 490         va_list p;
 491         int r;
 492         char *string_ptr;
 493
 494 #if 1
 495         // GNU extension
 496         va_start(p, format);
 497         r = vasprintf(&string_ptr, format, p);
 498         va_end(p);
 499 #else
 500         // Bloat for systems that haven't got the GNU extension.
 501         va_start(p, format);
 502         r = vsnprintf(NULL, 0, format, p) + 1;
 503         va_end(p);
 504         string_ptr = malloc(r);
 505         if (string_ptr) {
 506                 va_start(p, format);
 507                 r = vsnprintf(string_ptr, r, format, p);
 508                 va_end(p);
 509         }
 510 #endif
 511
 512         if (r >= 0) {
 513                 full_write(fd, string_ptr, r);
 514                 free(string_ptr);
 515         }
 516         return r;
 517 }
 518 #endif
 519
 520 // Die with an error message if we can't copy an entire FILE * to stdout, then
 521 // close that file.
 522 void xprint_and_close_file(FILE *file)
 523 {
 524         fflush(stdout);
 525         // copyfd outputs error messages for us.
 526         if (bb_copyfd_eof(fileno(file), 1) == -1)
 527                 xfunc_die();
 528
 529         fclose(file);
 530 }
 531
 532 // Die if we can't chdir to a new path.
 533 void xchdir(const char *path)
 534 {
 535         if (chdir(path))
 536                 bb_perror_msg_and_die("chdir(%s)", path);
 537 }
 538
 539 // Print a warning message if opendir() fails, but don't die.
 540 DIR *warn_opendir(const char *path)
 541 {
 542         DIR *dp;
 543
 544         dp = opendir(path);
 545         if (!dp)
 546                 bb_perror_msg("can't open '%s'", path);
 547         return dp;
 548 }
 549
 550 // Die with an error message if opendir() fails.
 551 DIR *xopendir(const char *path)
 552 {
 553         DIR *dp;
 554
 555         dp = opendir(path);
 556         if (!dp)
 557                 bb_perror_msg_and_die("can't open '%s'", path);
 558         return dp;
 559 }
 560
 561 // Die with an error message if we can't open a new socket.
 562 int xsocket(int domain, int type, int protocol)
 563 {
 564         int r = socket(domain, type, protocol);
 565
 566         if (r < 0) {
 567                 /* Hijack vaguely related config option */
 568 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
 569                 const char *s = "INET";
 570                 if (domain == AF_PACKET) s = "PACKET";
 571                 if (domain == AF_NETLINK) s = "NETLINK";
 572 USE_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
 573                 bb_perror_msg_and_die("socket(AF_%s)", s);
 574 #else
 575                 bb_perror_msg_and_die("socket");
 576 #endif
 577         }
 578
 579         return r;
 580 }
 581
 582 // Die with an error message if we can't bind a socket to an address.
 583 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
 584 {
 585         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
 586 }
 587
 588 // Die with an error message if we can't listen for connections on a socket.
 589 void xlisten(int s, int backlog)
 590 {
 591         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
 592 }
 593
 594 /* Die with an error message if sendto failed.
 595  * Return bytes sent otherwise  */
 596 ssize_t xsendto(int s, const  void *buf, size_t len, const struct sockaddr *to,
 597                                 socklen_t tolen)
 598 {
 599         ssize_t ret = sendto(s, buf, len, 0, to, tolen);
 600         if (ret < 0) {
 601                 if (ENABLE_FEATURE_CLEAN_UP)
 602                         close(s);
 603                 bb_perror_msg_and_die("sendto");
 604         }
 605         return ret;
 606 }
 607
 608 // xstat() - a stat() which dies on failure with meaningful error message
 609 void xstat(const char *name, struct stat *stat_buf)
 610 {
 611         if (stat(name, stat_buf))
 612                 bb_perror_msg_and_die("can't stat '%s'", name);
 613 }
 614
 615 // selinux_or_die() - die if SELinux is disabled.
 616 void selinux_or_die(void)
 617 {
 618 #if ENABLE_SELINUX
 619         int rc = is_selinux_enabled();
 620         if (rc == 0) {
 621                 bb_error_msg_and_die("SELinux is disabled");
 622         } else if (rc < 0) {
 623                 bb_error_msg_and_die("is_selinux_enabled() failed");
 624         }
 625 #else
 626         bb_error_msg_and_die("SELinux support is disabled");
 627 #endif
 628 }
 629
 630 /* It is perfectly ok to pass in a NULL for either width or for
 631  * height, in which case that value will not be set.  */
 632 int get_terminal_width_height(int fd, int *width, int *height)
 633 {
 634         struct winsize win = { 0, 0, 0, 0 };
 635         int ret = ioctl(fd, TIOCGWINSZ, &win);
 636
 637         if (height) {
 638                 if (!win.ws_row) {
 639                         char *s = getenv("LINES");
 640                         if (s) win.ws_row = atoi(s);
 641                 }
 642                 if (win.ws_row <= 1 || win.ws_row >= 30000)
 643                         win.ws_row = 24;
 644                 *height = (int) win.ws_row;
 645         }
 646
 647         if (width) {
 648                 if (!win.ws_col) {
 649                         char *s = getenv("COLUMNS");
 650                         if (s) win.ws_col = atoi(s);
 651                 }
 652                 if (win.ws_col <= 1 || win.ws_col >= 30000)
 653                         win.ws_col = 80;
 654                 *width = (int) win.ws_col;
 655         }
 656
 657         return ret;
 658 }
 659
 660 void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...)
 661 {
 662         va_list p;
 663
 664         if (ioctl(fd, request, argp) < 0) {
 665                 va_start(p, fmt);
 666                 bb_verror_msg(fmt, p, strerror(errno));
 667                 /* xfunc_die can actually longjmp, so be nice */
 668                 va_end(p);
 669                 xfunc_die();
 670         }
 671 }
 672
 673 int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...)
 674 {
 675         va_list p;
 676         int ret = ioctl(fd, request, argp);
 677
 678         if (ret < 0) {
 679                 va_start(p, fmt);
 680                 bb_verror_msg(fmt, p, strerror(errno));
 681                 va_end(p);
 682         }
 683         return ret;
 684 }
 685
 686 #if ENABLE_IOCTL_HEX2STR_ERROR
 687 int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name)
 688 {
 689         int ret;
 690
 691         ret = ioctl(fd, request, argp);
 692         if (ret < 0)
 693                 bb_perror_msg("%s", ioctl_name);
 694         return ret;
 695 }
 696 void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name)
 697 {
 698         if (ioctl(fd, request, argp) < 0)
 699                 bb_perror_msg_and_die("%s", ioctl_name);
 700 }
 701 #else
 702 int bb_ioctl_or_warn(int fd, int request, void *argp)
 703 {
 704         int ret;
 705
 706         ret = ioctl(fd, request, argp);
 707         if (ret < 0)
 708                 bb_perror_msg("ioctl %#x failed", request);
 709         return ret;
 710 }
 711 void bb_xioctl(int fd, int request, void *argp)
 712 {
 713         if (ioctl(fd, request, argp) < 0)
 714                 bb_perror_msg_and_die("ioctl %#x failed", request);
 715 }
 716 #endif