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