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 #ifdef L_xmalloc
  24 // Die if we can't allocate size bytes of memory.
  25 void *xmalloc(size_t size)
  26 {
  27         void *ptr = malloc(size);
  28         if (ptr == NULL && size != 0)
  29                 bb_error_msg_and_die(bb_msg_memory_exhausted);
  30         return ptr;
  31 }
  32 #endif
  33
  34 #ifdef L_xrealloc
  35 // Die if we can't resize previously allocated memory.  (This returns a pointer
  36 // to the new memory, which may or may not be the same as the old memory.
  37 // It'll copy the contents to a new chunk and free the old one if necessary.)
  38 void *xrealloc(void *ptr, size_t size)
  39 {
  40         ptr = realloc(ptr, size);
  41         if (ptr == NULL && size != 0)
  42                 bb_error_msg_and_die(bb_msg_memory_exhausted);
  43         return ptr;
  44 }
  45 #endif
  46 #endif /* DMALLOC */
  47
  48
  49 #ifdef L_xzalloc
  50 // Die if we can't allocate and zero size bytes of memory.
  51 void *xzalloc(size_t size)
  52 {
  53         void *ptr = xmalloc(size);
  54         memset(ptr, 0, size);
  55         return ptr;
  56 }
  57 #endif
  58
  59 #ifdef L_xstrdup
  60 // Die if we can't copy a string to freshly allocated memory.
  61 char * xstrdup(const char *s)
  62 {
  63         char *t;
  64
  65         if (s == NULL)
  66                 return NULL;
  67
  68         t = strdup (s);
  69
  70         if (t == NULL)
  71                 bb_error_msg_and_die(bb_msg_memory_exhausted);
  72
  73         return t;
  74 }
  75 #endif
  76
  77 #ifdef L_xstrndup
  78 // Die if we can't allocate n+1 bytes (space for the null terminator) and copy
  79 // the (possibly truncated to length n) string into it.
  80 char * xstrndup(const char *s, int n)
  81 {
  82         char *t;
  83
  84         if (ENABLE_DEBUG && s == NULL)
  85                 bb_error_msg_and_die("xstrndup bug");
  86
  87         t = xmalloc(++n);
  88
  89         return safe_strncpy(t,s,n);
  90 }
  91 #endif
  92
  93 #ifdef L_xfopen
  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;
  99         if ((fp = fopen(path, mode)) == NULL)
 100                 bb_perror_msg_and_die("%s", path);
 101         return fp;
 102 }
 103 #endif
 104
 105 #ifdef L_xopen
 106 // Die if we can't open an existing file and return an fd.
 107 int xopen(const char *pathname, int flags)
 108 {
 109         if (ENABLE_DEBUG && (flags & O_CREAT))
 110                 bb_error_msg_and_die("xopen() with O_CREAT");
 111
 112         return xopen3(pathname, flags, 0777);
 113 }
 114 #endif
 115
 116 #ifdef L_xopen3
 117 // Die if we can't open a new file and return an fd.
 118 int xopen3(const char *pathname, int flags, int mode)
 119 {
 120         int ret;
 121
 122         ret = open(pathname, flags, mode);
 123         if (ret < 0) {
 124                 bb_perror_msg_and_die("%s", pathname);
 125         }
 126         return ret;
 127 }
 128 #endif
 129
 130 #ifdef L_xread
 131 // Die with an error message if we can't read the entire buffer.
 132 void xread(int fd, void *buf, size_t count)
 133 {
 134         while (count) {
 135                 ssize_t size;
 136
 137                 if ((size = safe_read(fd, buf, count)) < 1)
 138                         bb_error_msg_and_die("Short read");
 139                 count -= size;
 140                 buf = ((char *) buf) + size;
 141         }
 142 }
 143 #endif
 144
 145 #ifdef L_xwrite
 146 // Die with an error message if we can't write the entire buffer.
 147 void xwrite(int fd, void *buf, size_t count)
 148 {
 149         while (count) {
 150                 ssize_t size;
 151
 152                 if ((size = safe_write(fd, buf, count)) < 1)
 153                         bb_error_msg_and_die("Short write");
 154                 count -= size;
 155                 buf = ((char *) buf) + size;
 156         }
 157 }
 158 #endif
 159
 160 #ifdef L_xlseek
 161 // Die with an error message if we can't lseek to the right spot.
 162 void xlseek(int fd, off_t offset, int whence)
 163 {
 164         if (offset != lseek(fd, offset, whence)) bb_error_msg_and_die("lseek");
 165 }
 166 #endif
 167
 168 #ifdef L_xread_char
 169 // Die with an error message if we can't read one character.
 170 unsigned char xread_char(int fd)
 171 {
 172         char tmp;
 173
 174         xread(fd, &tmp, 1);
 175
 176         return(tmp);
 177 }
 178 #endif
 179
 180 #ifdef L_xferror
 181 // Die with supplied error message if this FILE * has ferror set.
 182 void xferror(FILE *fp, const char *fn)
 183 {
 184         if (ferror(fp)) {
 185                 bb_error_msg_and_die("%s", fn);
 186         }
 187 }
 188 #endif
 189
 190 #ifdef L_xferror_stdout
 191 // Die with an error message if stdout has ferror set.
 192 void xferror_stdout(void)
 193 {
 194         xferror(stdout, bb_msg_standard_output);
 195 }
 196 #endif
 197
 198 #ifdef L_xfflush_stdout
 199 // Die with an error message if we have trouble flushing stdout.
 200 void xfflush_stdout(void)
 201 {
 202         if (fflush(stdout)) {
 203                 bb_perror_msg_and_die(bb_msg_standard_output);
 204         }
 205 }
 206 #endif
 207
 208 #ifdef L_spawn
 209 // This does a fork/exec in one call, using vfork().  Return PID of new child,
 210 // -1 for failure.  Runs argv[0], searching path if that has no / in it.
 211 pid_t spawn(char **argv)
 212 {
 213         static int failed;
 214         pid_t pid;
 215         void *app = ENABLE_FEATURE_SH_STANDALONE_SHELL ? find_applet_by_name(argv[0]) : 0;
 216
 217         // Be nice to nommu machines.
 218         failed = 0;
 219         pid = vfork();
 220         if (pid < 0) return pid;
 221         if (!pid) {
 222                 execvp(app ? CONFIG_BUSYBOX_EXEC_PATH : *argv, argv);
 223
 224                 // We're sharing a stack with blocked parent, let parent know we failed
 225                 // and then exit to unblock parent (but don't run atexit() stuff, which
 226                 // would screw up parent.)
 227
 228                 failed = -1;
 229                 _exit(0);
 230         }
 231         return failed ? failed : pid;
 232 }
 233 #endif
 234
 235 #ifdef L_xspawn
 236 // Die with an error message if we can't spawn a child process.
 237 pid_t xspawn(char **argv)
 238 {
 239         pid_t pid = spawn(argv);
 240         if (pid < 0) bb_perror_msg_and_die("%s", *argv);
 241         return pid;
 242 }
 243 #endif
 244
 245 #ifdef L_wait4
 246 // Wait for the specified child PID to exit, returning child's error return.
 247 int wait4pid(int pid)
 248 {
 249         int status;
 250
 251         if (pid == -1 || waitpid(pid, &status, 0) == -1) return -1;
 252         if (WIFEXITED(status)) return WEXITSTATUS(status);
 253         if (WIFSIGNALED(status)) return WTERMSIG(status);
 254         return 0;
 255 }
 256 #endif
 257
 258 #ifdef L_itoa
 259 // Convert unsigned integer to ascii, writing into supplied buffer.  A
 260 // truncated result is always null terminated (unless buflen is 0), and
 261 // contains the first few digits of the result ala strncpy.
 262 void utoa_to_buf(unsigned n, char *buf, unsigned buflen)
 263 {
 264         int i, out = 0;
 265         if (buflen) {
 266                 for (i=1000000000; i; i/=10) {
 267                         int res = n/i;
 268
 269                         if ((res || out || i == 1) && --buflen>0) {
 270                                 out++;
 271                                 n -= res*i;
 272                                 *buf++ = '0' + res;
 273                         }
 274                 }
 275                 *buf = 0;
 276         }
 277 }
 278
 279 // Convert signed integer to ascii, like utoa_to_buf()
 280 void itoa_to_buf(int n, char *buf, unsigned buflen)
 281 {
 282         if (buflen && n<0) {
 283                 n = -n;
 284                 *buf++ = '-';
 285                 buflen--;
 286         }
 287         utoa_to_buf((unsigned)n, buf, buflen);
 288 }
 289
 290 // The following two functions use a static buffer, so calling either one a
 291 // second time will overwrite previous results.
 292 //
 293 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
 294 // Int should always be 32 bits on any remotely Unix-like system, see
 295 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
 296
 297 static char local_buf[12];
 298
 299 // Convert unsigned integer to ascii using a static buffer (returned).
 300 char *utoa(unsigned n)
 301 {
 302         utoa_to_buf(n, local_buf, sizeof(local_buf));
 303
 304         return local_buf;
 305 }
 306
 307 // Convert signed integer to ascii using a static buffer (returned).
 308 char *itoa(int n)
 309 {
 310         itoa_to_buf(n, local_buf, sizeof(local_buf));
 311
 312         return local_buf;
 313 }
 314 #endif
 315
 316 #ifdef L_setuid
 317 // Die with an error message if we can't set gid.  (Because resource limits may
 318 // limit this user to a given number of processes, and if that fills up the
 319 // setgid() will fail and we'll _still_be_root_, which is bad.)
 320 void xsetgid(gid_t gid)
 321 {
 322         if (setgid(gid)) bb_error_msg_and_die("setgid");
 323 }
 324
 325 // Die with an error message if we cant' set uid.  (See xsetgid() for why.)
 326 void xsetuid(uid_t uid)
 327 {
 328         if (setuid(uid)) bb_error_msg_and_die("setuid");
 329 }
 330 #endif
 331
 332 #ifdef L_fdlength
 333 // Return how long the file at fd is, if there's any way to determine it.
 334 off_t fdlength(int fd)
 335 {
 336         off_t bottom = 0, top = 0, pos;
 337         long size;
 338
 339         // If the ioctl works for this, return it.
 340
 341         if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
 342
 343         // If not, do a binary search for the last location we can read.  (Some
 344         // block devices don't do BLKGETSIZE right.)
 345
 346         do {
 347                 char temp;
 348
 349                 pos = bottom + (top - bottom) / 2;
 350
 351                 // If we can read from the current location, it's bigger.
 352
 353                 if (lseek(fd, pos, 0)>=0 && safe_read(fd, &temp, 1)==1) {
 354                         if (bottom == top) bottom = top = (top+1) * 2;
 355                         else bottom = pos;
 356
 357                 // If we can't, it's smaller.
 358
 359                 } else {
 360                         if (bottom == top) {
 361                                 if (!top) return 0;
 362                                 bottom = top/2;
 363                         }
 364                         else top = pos;
 365                 }
 366         } while (bottom + 1 != top);
 367
 368         return pos + 1;
 369 }
 370 #endif
 371
 372 #ifdef L_xasprintf
 373 // Die with an error message if we can't malloc() enough space and do an
 374 // sprintf() into that space.
 375 char *xasprintf(const char *format, ...)
 376 {
 377         va_list p;
 378         int r;
 379         char *string_ptr;
 380
 381 #if 1
 382         // GNU extension
 383         va_start(p, format);
 384         r = vasprintf(&string_ptr, format, p);
 385         va_end(p);
 386 #else
 387         // Bloat for systems that haven't got the GNU extension.
 388         va_start(p, format);
 389         r = vsnprintf(NULL, 0, format, p);
 390         va_end(p);
 391         string_ptr = xmalloc(r+1);
 392         va_start(p, format);
 393         r = vsnprintf(string_ptr, r+1, format, p);
 394         va_end(p);
 395 #endif
 396
 397         if (r < 0) bb_error_msg_and_die(bb_msg_memory_exhausted);
 398         return string_ptr;
 399 }
 400 #endif
 401
 402 #ifdef L_xprint_and_close_file
 403 // Die with an error message if we can't copy an entire FILE * to stdout, then
 404 // close that file.
 405 void xprint_and_close_file(FILE *file)
 406 {
 407         // copyfd outputs error messages for us.
 408         if (bb_copyfd_eof(fileno(file), 1) == -1)
 409                 exit(bb_default_error_retval);
 410
 411         fclose(file);
 412 }
 413 #endif
 414
 415 #ifdef L_xchdir
 416 // Die if we can't chdir to a new path.
 417 void xchdir(const char *path)
 418 {
 419         if (chdir(path))
 420                 bb_perror_msg_and_die("chdir(%s)", path);
 421 }
 422 #endif
 423
 424 #ifdef L_warn_opendir
 425 // Print a warning message if opendir() fails, but don't die.
 426 DIR *warn_opendir(const char *path)
 427 {
 428         DIR *dp;
 429
 430         if ((dp = opendir(path)) == NULL) {
 431                 bb_perror_msg("unable to open `%s'", path);
 432                 return NULL;
 433         }
 434         return dp;
 435 }
 436 #endif
 437
 438 #ifdef L_xopendir
 439 // Die with an error message if opendir() fails.
 440 DIR *xopendir(const char *path)
 441 {
 442         DIR *dp;
 443
 444         if ((dp = opendir(path)) == NULL)
 445                 bb_perror_msg_and_die("unable to open `%s'", path);
 446         return dp;
 447 }
 448 #endif
 449
 450 #ifdef L_xdaemon
 451 #ifndef BB_NOMMU
 452 // Die with an error message if we can't daemonize.
 453 void xdaemon(int nochdir, int noclose)
 454 {
 455         if (daemon(nochdir, noclose)) bb_perror_msg_and_die("daemon");
 456 }
 457 #endif
 458 #endif
 459
 460 #ifdef L_xsocket
 461 // Die with an error message if we can't open a new socket.
 462 int xsocket(int domain, int type, int protocol)
 463 {
 464         int r = socket(domain, type, protocol);
 465
 466         if (r < 0) bb_perror_msg_and_die("socket");
 467
 468         return r;
 469 }
 470 #endif
 471
 472 #ifdef L_xbind
 473 // Die with an error message if we can't bind a socket to an address.
 474 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
 475 {
 476         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
 477 }
 478 #endif
 479
 480 #ifdef L_xlisten
 481 // Die with an error message if we can't listen for connections on a socket.
 482 void xlisten(int s, int backlog)
 483 {
 484         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
 485 }
 486 #endif
 487
 488 #ifdef L_xstat
 489 // xstat() - a stat() which dies on failure with meaningful error message
 490 void xstat(char *name, struct stat *stat_buf)
 491 {
 492         if (stat(name, stat_buf))
 493                 bb_perror_msg_and_die("Can't stat '%s'", name);
 494 }
 495 #endif
 496
 497 #ifdef L_get_terminal_width_height
 498 /* It is perfectly ok to pass in a NULL for either width or for
 499  *  * height, in which case that value will not be set.  */
 500 int get_terminal_width_height(int fd, int *width, int *height)
 501 {
 502         struct winsize win = { 0, 0, 0, 0 };
 503         int ret = ioctl(fd, TIOCGWINSZ, &win);
 504         if (!win.ws_row) {
 505                 char *s = getenv("LINES");
 506                 if (s) win.ws_row = atoi(s);
 507         }
 508         if (win.ws_row <= 1) win.ws_row = 24;
 509         if (!win.ws_col) {
 510                 char *s = getenv("COLUMNS");
 511                 if (s) win.ws_col = atoi(s);
 512         }
 513         if (win.ws_col <= 1) win.ws_col = 80;
 514         if (height) *height = (int) win.ws_row;
 515         if (width) *width = (int) win.ws_col;
 516
 517         return ret;
 518 }
 519 #endif