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 // Convert unsigned integer to ascii, writing into supplied buffer.  A
 205 // truncated result is always null terminated (unless buflen is 0), and
 206 // contains the first few digits of the result ala strncpy.
 207 void utoa_to_buf(unsigned n, char *buf, unsigned buflen)
 208 {
 209         int i, out = 0;
 210         if (buflen) {
 211                 for (i=1000000000; i; i/=10) {
 212                         int res = n/i;
 213
 214                         if ((res || out || i == 1) && --buflen>0) {
 215                                 out++;
 216                                 n -= res*i;
 217                                 *buf++ = '0' + res;
 218                         }
 219                 }
 220                 *buf = 0;
 221         }
 222 }
 223
 224 // Convert signed integer to ascii, like utoa_to_buf()
 225 void itoa_to_buf(int n, char *buf, unsigned buflen)
 226 {
 227         if (buflen && n<0) {
 228                 n = -n;
 229                 *buf++ = '-';
 230                 buflen--;
 231         }
 232         utoa_to_buf((unsigned)n, buf, buflen);
 233 }
 234
 235 // The following two functions use a static buffer, so calling either one a
 236 // second time will overwrite previous results.
 237 //
 238 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
 239 // Int should always be 32 bits on any remotely Unix-like system, see
 240 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
 241
 242 static char local_buf[12];
 243
 244 // Convert unsigned integer to ascii using a static buffer (returned).
 245 char *utoa(unsigned n)
 246 {
 247         utoa_to_buf(n, local_buf, sizeof(local_buf));
 248
 249         return local_buf;
 250 }
 251
 252 // Convert signed integer to ascii using a static buffer (returned).
 253 char *itoa(int n)
 254 {
 255         itoa_to_buf(n, local_buf, sizeof(local_buf));
 256
 257         return local_buf;
 258 }
 259
 260 // Die with an error message if we can't set gid.  (Because resource limits may
 261 // limit this user to a given number of processes, and if that fills up the
 262 // setgid() will fail and we'll _still_be_root_, which is bad.)
 263 void xsetgid(gid_t gid)
 264 {
 265         if (setgid(gid)) bb_error_msg_and_die("setgid");
 266 }
 267
 268 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
 269 void xsetuid(uid_t uid)
 270 {
 271         if (setuid(uid)) bb_error_msg_and_die("setuid");
 272 }
 273
 274 // Return how long the file at fd is, if there's any way to determine it.
 275 off_t fdlength(int fd)
 276 {
 277         off_t bottom = 0, top = 0, pos;
 278         long size;
 279
 280         // If the ioctl works for this, return it.
 281
 282         if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
 283
 284         // FIXME: explain why lseek(SEEK_END) is not used here!
 285
 286         // If not, do a binary search for the last location we can read.  (Some
 287         // block devices don't do BLKGETSIZE right.)
 288
 289         do {
 290                 char temp;
 291
 292                 pos = bottom + (top - bottom) / 2;
 293
 294                 // If we can read from the current location, it's bigger.
 295
 296                 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
 297                         if (bottom == top) bottom = top = (top+1) * 2;
 298                         else bottom = pos;
 299
 300                 // If we can't, it's smaller.
 301
 302                 } else {
 303                         if (bottom == top) {
 304                                 if (!top) return 0;
 305                                 bottom = top/2;
 306                         }
 307                         else top = pos;
 308                 }
 309         } while (bottom + 1 != top);
 310
 311         return pos + 1;
 312 }
 313
 314 // Die with an error message if we can't malloc() enough space and do an
 315 // sprintf() into that space.
 316 char *xasprintf(const char *format, ...)
 317 {
 318         va_list p;
 319         int r;
 320         char *string_ptr;
 321
 322 #if 1
 323         // GNU extension
 324         va_start(p, format);
 325         r = vasprintf(&string_ptr, format, p);
 326         va_end(p);
 327 #else
 328         // Bloat for systems that haven't got the GNU extension.
 329         va_start(p, format);
 330         r = vsnprintf(NULL, 0, format, p);
 331         va_end(p);
 332         string_ptr = xmalloc(r+1);
 333         va_start(p, format);
 334         r = vsnprintf(string_ptr, r+1, format, p);
 335         va_end(p);
 336 #endif
 337
 338         if (r < 0) bb_error_msg_and_die(bb_msg_memory_exhausted);
 339         return string_ptr;
 340 }
 341
 342 // Die with an error message if we can't copy an entire FILE * to stdout, then
 343 // close that file.
 344 void xprint_and_close_file(FILE *file)
 345 {
 346         fflush(stdout);
 347         // copyfd outputs error messages for us.
 348         if (bb_copyfd_eof(fileno(file), 1) == -1)
 349                 exit(xfunc_error_retval);
 350
 351         fclose(file);
 352 }
 353
 354 // Die if we can't chdir to a new path.
 355 void xchdir(const char *path)
 356 {
 357         if (chdir(path))
 358                 bb_perror_msg_and_die("chdir(%s)", path);
 359 }
 360
 361 // Print a warning message if opendir() fails, but don't die.
 362 DIR *warn_opendir(const char *path)
 363 {
 364         DIR *dp;
 365
 366         if ((dp = opendir(path)) == NULL) {
 367                 bb_perror_msg("unable to open `%s'", path);
 368                 return NULL;
 369         }
 370         return dp;
 371 }
 372
 373 // Die with an error message if opendir() fails.
 374 DIR *xopendir(const char *path)
 375 {
 376         DIR *dp;
 377
 378         if ((dp = opendir(path)) == NULL)
 379                 bb_perror_msg_and_die("unable to open `%s'", path);
 380         return dp;
 381 }
 382
 383 #ifndef BB_NOMMU
 384 // Die with an error message if we can't daemonize.
 385 void xdaemon(int nochdir, int noclose)
 386 {
 387         if (daemon(nochdir, noclose))
 388                 bb_perror_msg_and_die("daemon");
 389 }
 390 #endif
 391
 392 // Die with an error message if we can't open a new socket.
 393 int xsocket(int domain, int type, int protocol)
 394 {
 395         int r = socket(domain, type, protocol);
 396
 397         if (r < 0) bb_perror_msg_and_die("socket");
 398
 399         return r;
 400 }
 401
 402 // Die with an error message if we can't bind a socket to an address.
 403 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
 404 {
 405         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
 406 }
 407
 408 // Die with an error message if we can't listen for connections on a socket.
 409 void xlisten(int s, int backlog)
 410 {
 411         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
 412 }
 413
 414 // xstat() - a stat() which dies on failure with meaningful error message
 415 void xstat(char *name, struct stat *stat_buf)
 416 {
 417         if (stat(name, stat_buf))
 418                 bb_perror_msg_and_die("can't stat '%s'", name);
 419 }
 420
 421 /* It is perfectly ok to pass in a NULL for either width or for
 422  * height, in which case that value will not be set.  */
 423 int get_terminal_width_height(int fd, int *width, int *height)
 424 {
 425         struct winsize win = { 0, 0, 0, 0 };
 426         int ret = ioctl(fd, TIOCGWINSZ, &win);
 427
 428         if (height) {
 429                 if (!win.ws_row) {
 430                         char *s = getenv("LINES");
 431                         if (s) win.ws_row = atoi(s);
 432                 }
 433                 if (win.ws_row <= 1 || win.ws_row >= 30000)
 434                         win.ws_row = 24;
 435                 *height = (int) win.ws_row;
 436         }
 437
 438         if (width) {
 439                 if (!win.ws_col) {
 440                         char *s = getenv("COLUMNS");
 441                         if (s) win.ws_col = atoi(s);
 442                 }
 443                 if (win.ws_col <= 1 || win.ws_col >= 30000)
 444                         win.ws_col = 80;
 445                 *width = (int) win.ws_col;
 446         }
 447
 448         return ret;
 449 }