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