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