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