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         int m;
  73         char *t;
  74
  75         if (ENABLE_DEBUG && s == NULL)
  76                 bb_error_msg_and_die("xstrndup bug");
  77
  78         /* We can just xmalloc(n+1) and strncpy into it, */
  79         /* but think about xstrndup("abc", 10000) wastage! */
  80         m = n;
  81         t = (char*) s;
  82         while (m) {
  83                 if (!*t) break;
  84                 m--;
  85                 t++;
  86         }
  87         n -= m;
  88         t = xmalloc(n + 1);
  89         t[n] = '\0';
  90
  91         return memcpy(t, s, n);
  92 }
  93
  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 = fopen(path, mode);
  99         if (fp == NULL)
 100                 bb_perror_msg_and_die("%s", path);
 101         return fp;
 102 }
 103
 104 // Die if we can't open an existing file and return an fd.
 105 int xopen(const char *pathname, int flags)
 106 {
 107         //if (ENABLE_DEBUG && (flags & O_CREAT))
 108         //      bb_error_msg_and_die("xopen() with O_CREAT");
 109
 110         return xopen3(pathname, flags, 0666);
 111 }
 112
 113 // Die if we can't open a new file and return an fd.
 114 int xopen3(const char *pathname, int flags, int mode)
 115 {
 116         int ret;
 117
 118         ret = open(pathname, flags, mode);
 119         if (ret < 0) {
 120                 bb_perror_msg_and_die("%s", pathname);
 121         }
 122         return ret;
 123 }
 124
 125 void xunlink(const char *pathname)
 126 {
 127         if (unlink(pathname))
 128                 bb_perror_msg_and_die("cannot remove file '%s'", pathname);
 129 }
 130
 131 // Turn on nonblocking I/O on a fd
 132 int ndelay_on(int fd)
 133 {
 134         return fcntl(fd,F_SETFL,fcntl(fd,F_GETFL,0) | O_NONBLOCK);
 135 }
 136
 137 int ndelay_off(int fd)
 138 {
 139         return fcntl(fd,F_SETFL,fcntl(fd,F_GETFL,0) & ~O_NONBLOCK);
 140 }
 141
 142 // "Renumber" opened fd
 143 void xmove_fd(int from, int to)
 144 {
 145         if (from == to)
 146                 return;
 147         if (dup2(from, to) != to)
 148                 bb_perror_msg_and_die("cannot duplicate file descriptor");
 149         close(from);
 150 }
 151
 152 // Die with an error message if we can't write the entire buffer.
 153 void xwrite(int fd, const void *buf, size_t count)
 154 {
 155         if (count) {
 156                 ssize_t size = full_write(fd, buf, count);
 157                 if (size != count)
 158                         bb_error_msg_and_die("short write");
 159         }
 160 }
 161
 162 // Die with an error message if we can't lseek to the right spot.
 163 off_t xlseek(int fd, off_t offset, int whence)
 164 {
 165         off_t off = lseek(fd, offset, whence);
 166         if (off == (off_t)-1) {
 167                 if (whence == SEEK_SET)
 168                         bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
 169                 bb_perror_msg_and_die("lseek");
 170         }
 171         return off;
 172 }
 173
 174 // Die with supplied filename if this FILE * has ferror set.
 175 void die_if_ferror(FILE *fp, const char *fn)
 176 {
 177         if (ferror(fp)) {
 178                 bb_error_msg_and_die("%s: I/O error", fn);
 179         }
 180 }
 181
 182 // Die with an error message if stdout has ferror set.
 183 void die_if_ferror_stdout(void)
 184 {
 185         die_if_ferror(stdout, bb_msg_standard_output);
 186 }
 187
 188 // Die with an error message if we have trouble flushing stdout.
 189 void xfflush_stdout(void)
 190 {
 191         if (fflush(stdout)) {
 192                 bb_perror_msg_and_die(bb_msg_standard_output);
 193         }
 194 }
 195
 196 void sig_block(int sig)
 197 {
 198         sigset_t ss;
 199         sigemptyset(&ss);
 200         sigaddset(&ss, sig);
 201         sigprocmask(SIG_BLOCK, &ss, NULL);
 202 }
 203
 204 void sig_unblock(int sig)
 205 {
 206         sigset_t ss;
 207         sigemptyset(&ss);
 208         sigaddset(&ss, sig);
 209         sigprocmask(SIG_UNBLOCK, &ss, NULL);
 210 }
 211
 212 #if 0
 213 void sig_blocknone(void)
 214 {
 215         sigset_t ss;
 216         sigemptyset(&ss);
 217         sigprocmask(SIG_SETMASK, &ss, NULL);
 218 }
 219 #endif
 220
 221 void sig_catch(int sig, void (*f)(int))
 222 {
 223         struct sigaction sa;
 224         sa.sa_handler = f;
 225         sa.sa_flags = 0;
 226         sigemptyset(&sa.sa_mask);
 227         sigaction(sig, &sa, NULL);
 228 }
 229
 230 void sig_pause(void)
 231 {
 232         sigset_t ss;
 233         sigemptyset(&ss);
 234         sigsuspend(&ss);
 235 }
 236
 237
 238 void xsetenv(const char *key, const char *value)
 239 {
 240         if (setenv(key, value, 1))
 241                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 242 }
 243
 244 // Converts unsigned long long value into compact 4-char
 245 // representation. Examples: "1234", "1.2k", " 27M", "123T"
 246 // Fifth char is always '\0'
 247 void smart_ulltoa5(unsigned long long ul, char buf[5])
 248 {
 249         const char *fmt;
 250         char c;
 251         unsigned v,idx = 0;
 252         ul *= 10;
 253         if (ul > 9999*10) { // do not scale if 9999 or less
 254                 while (ul >= 10000) {
 255                         ul /= 1024;
 256                         idx++;
 257                 }
 258         }
 259         v = ul; // ullong divisions are expensive, avoid them
 260
 261         fmt = " 123456789";
 262         if (!idx) {             // 9999 or less: use 1234 format
 263                 c = buf[0] = " 123456789"[v/10000];
 264                 if (c != ' ') fmt = "0123456789";
 265                 c = buf[1] = fmt[v/1000%10];
 266                 if (c != ' ') fmt = "0123456789";
 267                 buf[2] = fmt[v/100%10];
 268                 buf[3] = "0123456789"[v/10%10];
 269         } else {
 270                 if (v >= 10*10) {       // scaled value is >=10: use 123M format
 271                         c = buf[0] = " 123456789"[v/1000];
 272                         if (c != ' ') fmt = "0123456789";
 273                         buf[1] = fmt[v/100%10];
 274                         buf[2] = "0123456789"[v/10%10];
 275                 } else {        // scaled value is <10: use 1.2M format
 276                         buf[0] = "0123456789"[v/10];
 277                         buf[1] = '.';
 278                         buf[2] = "0123456789"[v%10];
 279                 }
 280                 // see http://en.wikipedia.org/wiki/Tera
 281                 buf[3] = " kMGTPEZY"[idx];
 282         }
 283         buf[4] = '\0';
 284 }
 285
 286 // Convert unsigned integer to ascii, writing into supplied buffer.
 287 // A truncated result contains the first few digits of the result ala strncpy.
 288 // Returns a pointer past last generated digit, does _not_ store NUL.
 289 void BUG_sizeof_unsigned_not_4(void);
 290 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen)
 291 {
 292         unsigned i, out, res;
 293         if (sizeof(unsigned) != 4)
 294                 BUG_sizeof_unsigned_not_4();
 295         if (buflen) {
 296                 out = 0;
 297                 for (i = 1000000000; i; i /= 10) {
 298                         res = n / i;
 299                         if (res || out || i == 1) {
 300                                 if (!--buflen) break;
 301                                 out++;
 302                                 n -= res*i;
 303                                 *buf++ = '0' + res;
 304                         }
 305                 }
 306         }
 307         return buf;
 308 }
 309
 310 // Convert signed integer to ascii, like utoa_to_buf()
 311 char *itoa_to_buf(int n, char *buf, unsigned buflen)
 312 {
 313         if (buflen && n<0) {
 314                 n = -n;
 315                 *buf++ = '-';
 316                 buflen--;
 317         }
 318         return utoa_to_buf((unsigned)n, buf, buflen);
 319 }
 320
 321 // The following two functions use a static buffer, so calling either one a
 322 // second time will overwrite previous results.
 323 //
 324 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
 325 // Int should always be 32 bits on any remotely Unix-like system, see
 326 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
 327
 328 static char local_buf[12];
 329
 330 // Convert unsigned integer to ascii using a static buffer (returned).
 331 char *utoa(unsigned n)
 332 {
 333         *(utoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
 334
 335         return local_buf;
 336 }
 337
 338 // Convert signed integer to ascii using a static buffer (returned).
 339 char *itoa(int n)
 340 {
 341         *(itoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
 342
 343         return local_buf;
 344 }
 345
 346 // Emit a string of hex representation of bytes
 347 char *bin2hex(char *p, const char *cp, int count)
 348 {
 349         while (count) {
 350                 unsigned char c = *cp++;
 351                 /* put lowercase hex digits */
 352                 *p++ = 0x20 | bb_hexdigits_upcase[c >> 4];
 353                 *p++ = 0x20 | bb_hexdigits_upcase[c & 0xf];
 354                 count--;
 355         }
 356         return p;
 357 }
 358
 359 // Die with an error message if we can't set gid.  (Because resource limits may
 360 // limit this user to a given number of processes, and if that fills up the
 361 // setgid() will fail and we'll _still_be_root_, which is bad.)
 362 void xsetgid(gid_t gid)
 363 {
 364         if (setgid(gid)) bb_error_msg_and_die("setgid");
 365 }
 366
 367 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
 368 void xsetuid(uid_t uid)
 369 {
 370         if (setuid(uid)) bb_error_msg_and_die("setuid");
 371 }
 372
 373 // Return how long the file at fd is, if there's any way to determine it.
 374 off_t fdlength(int fd)
 375 {
 376         off_t bottom = 0, top = 0, pos;
 377         long size;
 378
 379         // If the ioctl works for this, return it.
 380
 381         if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
 382
 383         // FIXME: explain why lseek(SEEK_END) is not used here!
 384
 385         // If not, do a binary search for the last location we can read.  (Some
 386         // block devices don't do BLKGETSIZE right.)
 387
 388         do {
 389                 char temp;
 390
 391                 pos = bottom + (top - bottom) / 2;
 392
 393                 // If we can read from the current location, it's bigger.
 394
 395                 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
 396                         if (bottom == top) bottom = top = (top+1) * 2;
 397                         else bottom = pos;
 398
 399                 // If we can't, it's smaller.
 400
 401                 } else {
 402                         if (bottom == top) {
 403                                 if (!top) return 0;
 404                                 bottom = top/2;
 405                         }
 406                         else top = pos;
 407                 }
 408         } while (bottom + 1 != top);
 409
 410         return pos + 1;
 411 }
 412
 413 // Die with an error message if we can't malloc() enough space and do an
 414 // sprintf() into that space.
 415 char *xasprintf(const char *format, ...)
 416 {
 417         va_list p;
 418         int r;
 419         char *string_ptr;
 420
 421 #if 1
 422         // GNU extension
 423         va_start(p, format);
 424         r = vasprintf(&string_ptr, format, p);
 425         va_end(p);
 426 #else
 427         // Bloat for systems that haven't got the GNU extension.
 428         va_start(p, format);
 429         r = vsnprintf(NULL, 0, format, p);
 430         va_end(p);
 431         string_ptr = xmalloc(r+1);
 432         va_start(p, format);
 433         r = vsnprintf(string_ptr, r+1, format, p);
 434         va_end(p);
 435 #endif
 436
 437         if (r < 0) bb_error_msg_and_die(bb_msg_memory_exhausted);
 438         return string_ptr;
 439 }
 440
 441 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
 442 int fdprintf(int fd, const char *format, ...)
 443 {
 444         va_list p;
 445         int r;
 446         char *string_ptr;
 447
 448 #if 1
 449         // GNU extension
 450         va_start(p, format);
 451         r = vasprintf(&string_ptr, format, p);
 452         va_end(p);
 453 #else
 454         // Bloat for systems that haven't got the GNU extension.
 455         va_start(p, format);
 456         r = vsnprintf(NULL, 0, format, p);
 457         va_end(p);
 458         string_ptr = xmalloc(r+1);
 459         va_start(p, format);
 460         r = vsnprintf(string_ptr, r+1, format, p);
 461         va_end(p);
 462 #endif
 463
 464         if (r >= 0) {
 465                 full_write(fd, string_ptr, r);
 466                 free(string_ptr);
 467         }
 468         return r;
 469 }
 470 #endif
 471
 472 // Die with an error message if we can't copy an entire FILE * to stdout, then
 473 // close that file.
 474 void xprint_and_close_file(FILE *file)
 475 {
 476         fflush(stdout);
 477         // copyfd outputs error messages for us.
 478         if (bb_copyfd_eof(fileno(file), 1) == -1)
 479                 xfunc_die();
 480
 481         fclose(file);
 482 }
 483
 484 // Die if we can't chdir to a new path.
 485 void xchdir(const char *path)
 486 {
 487         if (chdir(path))
 488                 bb_perror_msg_and_die("chdir(%s)", path);
 489 }
 490
 491 // Print a warning message if opendir() fails, but don't die.
 492 DIR *warn_opendir(const char *path)
 493 {
 494         DIR *dp;
 495
 496         dp = opendir(path);
 497         if (!dp)
 498                 bb_perror_msg("cannot open '%s'", path);
 499         return dp;
 500 }
 501
 502 // Die with an error message if opendir() fails.
 503 DIR *xopendir(const char *path)
 504 {
 505         DIR *dp;
 506
 507         dp = opendir(path);
 508         if (!dp)
 509                 bb_perror_msg_and_die("cannot open '%s'", path);
 510         return dp;
 511 }
 512
 513 // Die with an error message if we can't open a new socket.
 514 int xsocket(int domain, int type, int protocol)
 515 {
 516         int r = socket(domain, type, protocol);
 517
 518         if (r < 0) bb_perror_msg_and_die("socket");
 519
 520         return r;
 521 }
 522
 523 // Die with an error message if we can't bind a socket to an address.
 524 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
 525 {
 526         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
 527 }
 528
 529 // Die with an error message if we can't listen for connections on a socket.
 530 void xlisten(int s, int backlog)
 531 {
 532         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
 533 }
 534
 535 // xstat() - a stat() which dies on failure with meaningful error message
 536 void xstat(const char *name, struct stat *stat_buf)
 537 {
 538         if (stat(name, stat_buf))
 539                 bb_perror_msg_and_die("can't stat '%s'", name);
 540 }
 541
 542 // selinux_or_die() - die if SELinux is disabled.
 543 void selinux_or_die(void)
 544 {
 545 #if ENABLE_SELINUX
 546         int rc = is_selinux_enabled();
 547         if (rc == 0) {
 548                 bb_error_msg_and_die("SELinux is disabled");
 549         } else if (rc < 0) {
 550                 bb_error_msg_and_die("is_selinux_enabled() failed");
 551         }
 552 #else
 553         bb_error_msg_and_die("SELinux support is disabled");
 554 #endif
 555 }
 556
 557 /* It is perfectly ok to pass in a NULL for either width or for
 558  * height, in which case that value will not be set.  */
 559 int get_terminal_width_height(const int fd, int *width, int *height)
 560 {
 561         struct winsize win = { 0, 0, 0, 0 };
 562         int ret = ioctl(fd, TIOCGWINSZ, &win);
 563
 564         if (height) {
 565                 if (!win.ws_row) {
 566                         char *s = getenv("LINES");
 567                         if (s) win.ws_row = atoi(s);
 568                 }
 569                 if (win.ws_row <= 1 || win.ws_row >= 30000)
 570                         win.ws_row = 24;
 571                 *height = (int) win.ws_row;
 572         }
 573
 574         if (width) {
 575                 if (!win.ws_col) {
 576                         char *s = getenv("COLUMNS");
 577                         if (s) win.ws_col = atoi(s);
 578                 }
 579                 if (win.ws_col <= 1 || win.ws_col >= 30000)
 580                         win.ws_col = 80;
 581                 *width = (int) win.ws_col;
 582         }
 583
 584         return ret;
 585 }