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,0) | O_NONBLOCK);
 165 }
 166
 167 int ndelay_off(int fd)
 168 {
 169         return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL,0) & ~O_NONBLOCK);
 170 }
 171
 172 // "Renumber" opened fd
 173 void xmove_fd(int from, int to)
 174 {
 175         if (from == to)
 176                 return;
 177         if (dup2(from, to) != to)
 178                 bb_perror_msg_and_die("can't duplicate file descriptor");
 179         close(from);
 180 }
 181
 182 // Die with an error message if we can't write the entire buffer.
 183 void xwrite(int fd, const void *buf, size_t count)
 184 {
 185         if (count) {
 186                 ssize_t size = full_write(fd, buf, count);
 187                 if (size != count)
 188                         bb_error_msg_and_die("short write");
 189         }
 190 }
 191
 192 // Die with an error message if we can't lseek to the right spot.
 193 off_t xlseek(int fd, off_t offset, int whence)
 194 {
 195         off_t off = lseek(fd, offset, whence);
 196         if (off == (off_t)-1) {
 197                 if (whence == SEEK_SET)
 198                         bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
 199                 bb_perror_msg_and_die("lseek");
 200         }
 201         return off;
 202 }
 203
 204 // Die with supplied filename if this FILE * has ferror set.
 205 void die_if_ferror(FILE *fp, const char *fn)
 206 {
 207         if (ferror(fp)) {
 208                 /* ferror doesn't set useful errno */
 209                 bb_error_msg_and_die("%s: I/O error", fn);
 210         }
 211 }
 212
 213 // Die with an error message if stdout has ferror set.
 214 void die_if_ferror_stdout(void)
 215 {
 216         die_if_ferror(stdout, bb_msg_standard_output);
 217 }
 218
 219 // Die with an error message if we have trouble flushing stdout.
 220 void xfflush_stdout(void)
 221 {
 222         if (fflush(stdout)) {
 223                 bb_perror_msg_and_die(bb_msg_standard_output);
 224         }
 225 }
 226
 227 void sig_block(int sig)
 228 {
 229         sigset_t ss;
 230         sigemptyset(&ss);
 231         sigaddset(&ss, sig);
 232         sigprocmask(SIG_BLOCK, &ss, NULL);
 233 }
 234
 235 void sig_unblock(int sig)
 236 {
 237         sigset_t ss;
 238         sigemptyset(&ss);
 239         sigaddset(&ss, sig);
 240         sigprocmask(SIG_UNBLOCK, &ss, NULL);
 241 }
 242
 243 #if 0
 244 void sig_blocknone(void)
 245 {
 246         sigset_t ss;
 247         sigemptyset(&ss);
 248         sigprocmask(SIG_SETMASK, &ss, NULL);
 249 }
 250 #endif
 251
 252 void sig_catch(int sig, void (*f)(int))
 253 {
 254         struct sigaction sa;
 255         sa.sa_handler = f;
 256         sa.sa_flags = 0;
 257         sigemptyset(&sa.sa_mask);
 258         sigaction(sig, &sa, NULL);
 259 }
 260
 261 void sig_pause(void)
 262 {
 263         sigset_t ss;
 264         sigemptyset(&ss);
 265         sigsuspend(&ss);
 266 }
 267
 268
 269 void xsetenv(const char *key, const char *value)
 270 {
 271         if (setenv(key, value, 1))
 272                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 273 }
 274
 275 // Converts unsigned long long value into compact 4-char
 276 // representation. Examples: "1234", "1.2k", " 27M", "123T"
 277 // Fifth char is always '\0'
 278 void smart_ulltoa5(unsigned long long ul, char buf[5])
 279 {
 280         const char *fmt;
 281         char c;
 282         unsigned v,idx = 0;
 283         ul *= 10;
 284         if (ul > 9999*10) { // do not scale if 9999 or less
 285                 while (ul >= 10000) {
 286                         ul /= 1024;
 287                         idx++;
 288                 }
 289         }
 290         v = ul; // ullong divisions are expensive, avoid them
 291
 292         fmt = " 123456789";
 293         if (!idx) {             // 9999 or less: use 1234 format
 294                 c = buf[0] = " 123456789"[v/10000];
 295                 if (c != ' ') fmt = "0123456789";
 296                 c = buf[1] = fmt[v/1000%10];
 297                 if (c != ' ') fmt = "0123456789";
 298                 buf[2] = fmt[v/100%10];
 299                 buf[3] = "0123456789"[v/10%10];
 300         } else {
 301                 if (v >= 10*10) {       // scaled value is >=10: use 123M format
 302                         c = buf[0] = " 123456789"[v/1000];
 303                         if (c != ' ') fmt = "0123456789";
 304                         buf[1] = fmt[v/100%10];
 305                         buf[2] = "0123456789"[v/10%10];
 306                 } else {        // scaled value is <10: use 1.2M format
 307                         buf[0] = "0123456789"[v/10];
 308                         buf[1] = '.';
 309                         buf[2] = "0123456789"[v%10];
 310                 }
 311                 // see http://en.wikipedia.org/wiki/Tera
 312                 buf[3] = " kMGTPEZY"[idx];
 313         }
 314         buf[4] = '\0';
 315 }
 316
 317 // Convert unsigned integer to ascii, writing into supplied buffer.
 318 // A truncated result contains the first few digits of the result ala strncpy.
 319 // Returns a pointer past last generated digit, does _not_ store NUL.
 320 void BUG_sizeof_unsigned_not_4(void);
 321 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen)
 322 {
 323         unsigned i, out, res;
 324         if (sizeof(unsigned) != 4)
 325                 BUG_sizeof_unsigned_not_4();
 326         if (buflen) {
 327                 out = 0;
 328                 for (i = 1000000000; i; i /= 10) {
 329                         res = n / i;
 330                         if (res || out || i == 1) {
 331                                 if (!--buflen) break;
 332                                 out++;
 333                                 n -= res*i;
 334                                 *buf++ = '0' + res;
 335                         }
 336                 }
 337         }
 338         return buf;
 339 }
 340
 341 // Convert signed integer to ascii, like utoa_to_buf()
 342 char *itoa_to_buf(int n, char *buf, unsigned buflen)
 343 {
 344         if (buflen && n<0) {
 345                 n = -n;
 346                 *buf++ = '-';
 347                 buflen--;
 348         }
 349         return utoa_to_buf((unsigned)n, buf, buflen);
 350 }
 351
 352 // The following two functions use a static buffer, so calling either one a
 353 // second time will overwrite previous results.
 354 //
 355 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
 356 // Int should always be 32 bits on any remotely Unix-like system, see
 357 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
 358
 359 static char local_buf[12];
 360
 361 // Convert unsigned integer to ascii using a static buffer (returned).
 362 char *utoa(unsigned n)
 363 {
 364         *(utoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
 365
 366         return local_buf;
 367 }
 368
 369 // Convert signed integer to ascii using a static buffer (returned).
 370 char *itoa(int n)
 371 {
 372         *(itoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
 373
 374         return local_buf;
 375 }
 376
 377 // Emit a string of hex representation of bytes
 378 char *bin2hex(char *p, const char *cp, int count)
 379 {
 380         while (count) {
 381                 unsigned char c = *cp++;
 382                 /* put lowercase hex digits */
 383                 *p++ = 0x20 | bb_hexdigits_upcase[c >> 4];
 384                 *p++ = 0x20 | bb_hexdigits_upcase[c & 0xf];
 385                 count--;
 386         }
 387         return p;
 388 }
 389
 390 // Die with an error message if we can't set gid.  (Because resource limits may
 391 // limit this user to a given number of processes, and if that fills up the
 392 // setgid() will fail and we'll _still_be_root_, which is bad.)
 393 void xsetgid(gid_t gid)
 394 {
 395         if (setgid(gid)) bb_perror_msg_and_die("setgid");
 396 }
 397
 398 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
 399 void xsetuid(uid_t uid)
 400 {
 401         if (setuid(uid)) bb_perror_msg_and_die("setuid");
 402 }
 403
 404 // Return how long the file at fd is, if there's any way to determine it.
 405 off_t fdlength(int fd)
 406 {
 407         off_t bottom = 0, top = 0, pos;
 408         long size;
 409
 410         // If the ioctl works for this, return it.
 411
 412         if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
 413
 414         // FIXME: explain why lseek(SEEK_END) is not used here!
 415
 416         // If not, do a binary search for the last location we can read.  (Some
 417         // block devices don't do BLKGETSIZE right.)
 418
 419         do {
 420                 char temp;
 421
 422                 pos = bottom + (top - bottom) / 2;
 423
 424                 // If we can read from the current location, it's bigger.
 425
 426                 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
 427                         if (bottom == top) bottom = top = (top+1) * 2;
 428                         else bottom = pos;
 429
 430                 // If we can't, it's smaller.
 431
 432                 } else {
 433                         if (bottom == top) {
 434                                 if (!top) return 0;
 435                                 bottom = top/2;
 436                         }
 437                         else top = pos;
 438                 }
 439         } while (bottom + 1 != top);
 440
 441         return pos + 1;
 442 }
 443
 444 // Die with an error message if we can't malloc() enough space and do an
 445 // sprintf() into that space.
 446 char *xasprintf(const char *format, ...)
 447 {
 448         va_list p;
 449         int r;
 450         char *string_ptr;
 451
 452 #if 1
 453         // GNU extension
 454         va_start(p, format);
 455         r = vasprintf(&string_ptr, format, p);
 456         va_end(p);
 457 #else
 458         // Bloat for systems that haven't got the GNU extension.
 459         va_start(p, format);
 460         r = vsnprintf(NULL, 0, format, p);
 461         va_end(p);
 462         string_ptr = xmalloc(r+1);
 463         va_start(p, format);
 464         r = vsnprintf(string_ptr, r+1, format, p);
 465         va_end(p);
 466 #endif
 467
 468         if (r < 0) bb_error_msg_and_die(bb_msg_memory_exhausted);
 469         return string_ptr;
 470 }
 471
 472 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
 473 int fdprintf(int fd, const char *format, ...)
 474 {
 475         va_list p;
 476         int r;
 477         char *string_ptr;
 478
 479 #if 1
 480         // GNU extension
 481         va_start(p, format);
 482         r = vasprintf(&string_ptr, format, p);
 483         va_end(p);
 484 #else
 485         // Bloat for systems that haven't got the GNU extension.
 486         va_start(p, format);
 487         r = vsnprintf(NULL, 0, format, p) + 1;
 488         va_end(p);
 489         string_ptr = malloc(r);
 490         if (string_ptr) {
 491                 va_start(p, format);
 492                 r = vsnprintf(string_ptr, r, format, p);
 493                 va_end(p);
 494         }
 495 #endif
 496
 497         if (r >= 0) {
 498                 full_write(fd, string_ptr, r);
 499                 free(string_ptr);
 500         }
 501         return r;
 502 }
 503 #endif
 504
 505 // Die with an error message if we can't copy an entire FILE * to stdout, then
 506 // close that file.
 507 void xprint_and_close_file(FILE *file)
 508 {
 509         fflush(stdout);
 510         // copyfd outputs error messages for us.
 511         if (bb_copyfd_eof(fileno(file), 1) == -1)
 512                 xfunc_die();
 513
 514         fclose(file);
 515 }
 516
 517 // Die if we can't chdir to a new path.
 518 void xchdir(const char *path)
 519 {
 520         if (chdir(path))
 521                 bb_perror_msg_and_die("chdir(%s)", path);
 522 }
 523
 524 // Print a warning message if opendir() fails, but don't die.
 525 DIR *warn_opendir(const char *path)
 526 {
 527         DIR *dp;
 528
 529         dp = opendir(path);
 530         if (!dp)
 531                 bb_perror_msg("can't open '%s'", path);
 532         return dp;
 533 }
 534
 535 // Die with an error message if opendir() fails.
 536 DIR *xopendir(const char *path)
 537 {
 538         DIR *dp;
 539
 540         dp = opendir(path);
 541         if (!dp)
 542                 bb_perror_msg_and_die("can't open '%s'", path);
 543         return dp;
 544 }
 545
 546 // Die with an error message if we can't open a new socket.
 547 int xsocket(int domain, int type, int protocol)
 548 {
 549         int r = socket(domain, type, protocol);
 550
 551         if (r < 0) {
 552                 /* Hijack vaguely related config option */
 553 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
 554                 const char *s = "INET";
 555                 if (domain == AF_PACKET) s = "PACKET";
 556                 if (domain == AF_NETLINK) s = "NETLINK";
 557 USE_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
 558                 bb_perror_msg_and_die("socket(AF_%s)", s);
 559 #else
 560                 bb_perror_msg_and_die("socket");
 561 #endif
 562         }
 563
 564         return r;
 565 }
 566
 567 // Die with an error message if we can't bind a socket to an address.
 568 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
 569 {
 570         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
 571 }
 572
 573 // Die with an error message if we can't listen for connections on a socket.
 574 void xlisten(int s, int backlog)
 575 {
 576         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
 577 }
 578
 579 /* Die with an error message if sendto failed.
 580  * Return bytes sent otherwise  */
 581 ssize_t xsendto(int s, const  void *buf, size_t len, const struct sockaddr *to,
 582                                 socklen_t tolen)
 583 {
 584         ssize_t ret = sendto(s, buf, len, 0, to, tolen);
 585         if (ret < 0) {
 586                 if (ENABLE_FEATURE_CLEAN_UP)
 587                         close(s);
 588                 bb_perror_msg_and_die("sendto");
 589         }
 590         return ret;
 591 }
 592
 593 // xstat() - a stat() which dies on failure with meaningful error message
 594 void xstat(const char *name, struct stat *stat_buf)
 595 {
 596         if (stat(name, stat_buf))
 597                 bb_perror_msg_and_die("can't stat '%s'", name);
 598 }
 599
 600 // selinux_or_die() - die if SELinux is disabled.
 601 void selinux_or_die(void)
 602 {
 603 #if ENABLE_SELINUX
 604         int rc = is_selinux_enabled();
 605         if (rc == 0) {
 606                 bb_error_msg_and_die("SELinux is disabled");
 607         } else if (rc < 0) {
 608                 bb_error_msg_and_die("is_selinux_enabled() failed");
 609         }
 610 #else
 611         bb_error_msg_and_die("SELinux support is disabled");
 612 #endif
 613 }
 614
 615 /* It is perfectly ok to pass in a NULL for either width or for
 616  * height, in which case that value will not be set.  */
 617 int get_terminal_width_height(int fd, int *width, int *height)
 618 {
 619         struct winsize win = { 0, 0, 0, 0 };
 620         int ret = ioctl(fd, TIOCGWINSZ, &win);
 621
 622         if (height) {
 623                 if (!win.ws_row) {
 624                         char *s = getenv("LINES");
 625                         if (s) win.ws_row = atoi(s);
 626                 }
 627                 if (win.ws_row <= 1 || win.ws_row >= 30000)
 628                         win.ws_row = 24;
 629                 *height = (int) win.ws_row;
 630         }
 631
 632         if (width) {
 633                 if (!win.ws_col) {
 634                         char *s = getenv("COLUMNS");
 635                         if (s) win.ws_col = atoi(s);
 636                 }
 637                 if (win.ws_col <= 1 || win.ws_col >= 30000)
 638                         win.ws_col = 80;
 639                 *width = (int) win.ws_col;
 640         }
 641
 642         return ret;
 643 }
 644
 645 void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...)
 646 {
 647         va_list p;
 648
 649         if (ioctl(fd, request, argp) < 0) {
 650                 va_start(p, fmt);
 651                 bb_verror_msg(fmt, p, strerror(errno));
 652                 /* xfunc_die can actually longjmp, so be nice */
 653                 va_end(p);
 654                 xfunc_die();
 655         }
 656 }
 657
 658 int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...)
 659 {
 660         va_list p;
 661         int ret = ioctl(fd, request, argp);
 662
 663         if (ret < 0) {
 664                 va_start(p, fmt);
 665                 bb_verror_msg(fmt, p, strerror(errno));
 666                 va_end(p);
 667         }
 668         return ret;
 669 }
 670
 671 #if ENABLE_IOCTL_HEX2STR_ERROR
 672 int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name)
 673 {
 674         int ret;
 675
 676         ret = ioctl(fd, request, argp);
 677         if (ret < 0)
 678                 bb_perror_msg("%s", ioctl_name);
 679         return ret;
 680 }
 681 void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name)
 682 {
 683         if (ioctl(fd, request, argp) < 0)
 684                 bb_perror_msg_and_die("%s", ioctl_name);
 685 }
 686 #else
 687 int bb_ioctl_or_warn(int fd, int request, void *argp)
 688 {
 689         int ret;
 690
 691         ret = ioctl(fd, request, argp);
 692         if (ret < 0)
 693                 bb_perror_msg("ioctl %#x failed", request);
 694         return ret;
 695 }
 696 void bb_xioctl(int fd, int request, void *argp)
 697 {
 698         if (ioctl(fd, request, argp) < 0)
 699                 bb_perror_msg_and_die("ioctl %#x failed", request);
 700 }
 701 #endif