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