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