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