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