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