libbb/xfuncs_printf.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 Denys Vlasenko
   8  *
   9  * Licensed under GPLv2, see file LICENSE in this source tree.
  10  */
  11
  12 /* We need to have separate xfuncs.c and xfuncs_printf.c because
  13  * with current linkers, even with section garbage collection,
  14  * if *.o module references any of XXXprintf functions, you pull in
  15  * entire printf machinery. Even if you do not use the function
  16  * which uses XXXprintf.
  17  *
  18  * xfuncs.c contains functions (not necessarily xfuncs)
  19  * which do not pull in printf, directly or indirectly.
  20  * xfunc_printf.c contains those which do.
  21  */
  22
  23 #include "libbb.h"
  24
  25
  26 /* All the functions starting with "x" call bb_error_msg_and_die() if they
  27  * fail, so callers never need to check for errors.  If it returned, it
  28  * succeeded. */
  29
  30 #ifndef DMALLOC
  31 /* dmalloc provides variants of these that do abort() on failure.
  32  * Since dmalloc's prototypes overwrite the impls here as they are
  33  * included after these prototypes in libbb.h, all is well.
  34  */
  35 // Warn if we can't allocate size bytes of memory.
  36 void* FAST_FUNC malloc_or_warn(size_t size)
  37 {
  38         void *ptr = malloc(size);
  39         if (ptr == NULL && size != 0)
  40                 bb_error_msg(bb_msg_memory_exhausted);
  41         return ptr;
  42 }
  43
  44 // Die if we can't allocate size bytes of memory.
  45 void* FAST_FUNC xmalloc(size_t size)
  46 {
  47         void *ptr = malloc(size);
  48         if (ptr == NULL && size != 0)
  49                 bb_error_msg_and_die(bb_msg_memory_exhausted);
  50         return ptr;
  51 }
  52
  53 // Die if we can't resize previously allocated memory.  (This returns a pointer
  54 // to the new memory, which may or may not be the same as the old memory.
  55 // It'll copy the contents to a new chunk and free the old one if necessary.)
  56 void* FAST_FUNC xrealloc(void *ptr, size_t size)
  57 {
  58         ptr = realloc(ptr, size);
  59         if (ptr == NULL && size != 0)
  60                 bb_error_msg_and_die(bb_msg_memory_exhausted);
  61         return ptr;
  62 }
  63 #endif /* DMALLOC */
  64
  65 // Die if we can't allocate and zero size bytes of memory.
  66 void* FAST_FUNC xzalloc(size_t size)
  67 {
  68         void *ptr = xmalloc(size);
  69         memset(ptr, 0, size);
  70         return ptr;
  71 }
  72
  73 // Die if we can't copy a string to freshly allocated memory.
  74 char* FAST_FUNC xstrdup(const char *s)
  75 {
  76         char *t;
  77
  78         if (s == NULL)
  79                 return NULL;
  80
  81         t = strdup(s);
  82
  83         if (t == NULL)
  84                 bb_error_msg_and_die(bb_msg_memory_exhausted);
  85
  86         return t;
  87 }
  88
  89 // Die if we can't allocate n+1 bytes (space for the null terminator) and copy
  90 // the (possibly truncated to length n) string into it.
  91 char* FAST_FUNC xstrndup(const char *s, int n)
  92 {
  93         int m;
  94         char *t;
  95
  96         if (ENABLE_DEBUG && s == NULL)
  97                 bb_error_msg_and_die("xstrndup bug");
  98
  99         /* We can just xmalloc(n+1) and strncpy into it, */
 100         /* but think about xstrndup("abc", 10000) wastage! */
 101         m = n;
 102         t = (char*) s;
 103         while (m) {
 104                 if (!*t) break;
 105                 m--;
 106                 t++;
 107         }
 108         n -= m;
 109         t = xmalloc(n + 1);
 110         t[n] = '\0';
 111
 112         return memcpy(t, s, n);
 113 }
 114
 115 // Die if we can't open a file and return a FILE* to it.
 116 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
 117 FILE* FAST_FUNC xfopen(const char *path, const char *mode)
 118 {
 119         FILE *fp = fopen(path, mode);
 120         if (fp == NULL)
 121                 bb_perror_msg_and_die("can't open '%s'", path);
 122         return fp;
 123 }
 124
 125 // Die if we can't open a file and return a fd.
 126 int FAST_FUNC xopen3(const char *pathname, int flags, int mode)
 127 {
 128         int ret;
 129
 130         ret = open(pathname, flags, mode);
 131         if (ret < 0) {
 132                 bb_perror_msg_and_die("can't open '%s'", pathname);
 133         }
 134         return ret;
 135 }
 136
 137 // Die if we can't open a file and return a fd.
 138 int FAST_FUNC xopen(const char *pathname, int flags)
 139 {
 140         return xopen3(pathname, flags, 0666);
 141 }
 142
 143 // Warn if we can't open a file and return a fd.
 144 int FAST_FUNC open3_or_warn(const char *pathname, int flags, int mode)
 145 {
 146         int ret;
 147
 148         ret = open(pathname, flags, mode);
 149         if (ret < 0) {
 150                 bb_perror_msg("can't open '%s'", pathname);
 151         }
 152         return ret;
 153 }
 154
 155 // Warn if we can't open a file and return a fd.
 156 int FAST_FUNC open_or_warn(const char *pathname, int flags)
 157 {
 158         return open3_or_warn(pathname, flags, 0666);
 159 }
 160
 161 /* Die if we can't open an existing file readonly with O_NONBLOCK
 162  * and return the fd.
 163  * Note that for ioctl O_RDONLY is sufficient.
 164  */
 165 int FAST_FUNC xopen_nonblocking(const char *pathname)
 166 {
 167         return xopen(pathname, O_RDONLY | O_NONBLOCK);
 168 }
 169
 170 int FAST_FUNC xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g)
 171 {
 172         int fd;
 173         uid_t old_euid = geteuid();
 174         gid_t old_egid = getegid();
 175
 176         xsetegid(g);
 177         xseteuid(u);
 178
 179         fd = xopen(pathname, flags);
 180
 181         xseteuid(old_euid);
 182         xsetegid(old_egid);
 183
 184         return fd;
 185 }
 186
 187 void FAST_FUNC xunlink(const char *pathname)
 188 {
 189         if (unlink(pathname))
 190                 bb_perror_msg_and_die("can't remove file '%s'", pathname);
 191 }
 192
 193 void FAST_FUNC xrename(const char *oldpath, const char *newpath)
 194 {
 195         if (rename(oldpath, newpath))
 196                 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath, newpath);
 197 }
 198
 199 int FAST_FUNC rename_or_warn(const char *oldpath, const char *newpath)
 200 {
 201         int n = rename(oldpath, newpath);
 202         if (n)
 203                 bb_perror_msg("can't move '%s' to '%s'", oldpath, newpath);
 204         return n;
 205 }
 206
 207 void FAST_FUNC xpipe(int filedes[2])
 208 {
 209         if (pipe(filedes))
 210                 bb_perror_msg_and_die("can't create pipe");
 211 }
 212
 213 void FAST_FUNC xdup2(int from, int to)
 214 {
 215         if (dup2(from, to) != to)
 216                 bb_perror_msg_and_die("can't duplicate file descriptor");
 217 }
 218
 219 // "Renumber" opened fd
 220 void FAST_FUNC xmove_fd(int from, int to)
 221 {
 222         if (from == to)
 223                 return;
 224         xdup2(from, to);
 225         close(from);
 226 }
 227
 228 // Die with an error message if we can't write the entire buffer.
 229 void FAST_FUNC xwrite(int fd, const void *buf, size_t count)
 230 {
 231         if (count) {
 232                 ssize_t size = full_write(fd, buf, count);
 233                 if ((size_t)size != count)
 234                         bb_error_msg_and_die("short write");
 235         }
 236 }
 237 void FAST_FUNC xwrite_str(int fd, const char *str)
 238 {
 239         xwrite(fd, str, strlen(str));
 240 }
 241
 242 void FAST_FUNC xclose(int fd)
 243 {
 244         if (close(fd))
 245                 bb_perror_msg_and_die("close failed");
 246 }
 247
 248 // Die with an error message if we can't lseek to the right spot.
 249 off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
 250 {
 251         off_t off = lseek(fd, offset, whence);
 252         if (off == (off_t)-1) {
 253                 if (whence == SEEK_SET)
 254                         bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
 255                 bb_perror_msg_and_die("lseek");
 256         }
 257         return off;
 258 }
 259
 260 int FAST_FUNC xmkstemp(char *template)
 261 {
 262         int fd = mkstemp(template);
 263         if (fd < 0)
 264                 bb_perror_msg_and_die("can't create temp file '%s'", template);
 265         return fd;
 266 }
 267
 268 // Die with supplied filename if this FILE* has ferror set.
 269 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
 270 {
 271         if (ferror(fp)) {
 272                 /* ferror doesn't set useful errno */
 273                 bb_error_msg_and_die("%s: I/O error", fn);
 274         }
 275 }
 276
 277 // Die with an error message if stdout has ferror set.
 278 void FAST_FUNC die_if_ferror_stdout(void)
 279 {
 280         die_if_ferror(stdout, bb_msg_standard_output);
 281 }
 282
 283 int FAST_FUNC fflush_all(void)
 284 {
 285         return fflush(NULL);
 286 }
 287
 288
 289 int FAST_FUNC bb_putchar(int ch)
 290 {
 291         return putchar(ch);
 292 }
 293
 294 /* Die with an error message if we can't copy an entire FILE* to stdout,
 295  * then close that file. */
 296 void FAST_FUNC xprint_and_close_file(FILE *file)
 297 {
 298         fflush_all();
 299         // copyfd outputs error messages for us.
 300         if (bb_copyfd_eof(fileno(file), STDOUT_FILENO) == -1)
 301                 xfunc_die();
 302
 303         fclose(file);
 304 }
 305
 306 // Die with an error message if we can't malloc() enough space and do an
 307 // sprintf() into that space.
 308 char* FAST_FUNC xasprintf(const char *format, ...)
 309 {
 310         va_list p;
 311         int r;
 312         char *string_ptr;
 313
 314         va_start(p, format);
 315         r = vasprintf(&string_ptr, format, p);
 316         va_end(p);
 317
 318         if (r < 0)
 319                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 320         return string_ptr;
 321 }
 322
 323 void FAST_FUNC xsetenv(const char *key, const char *value)
 324 {
 325         if (setenv(key, value, 1))
 326                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 327 }
 328
 329 /* Handles "VAR=VAL" strings, even those which are part of environ
 330  * _right now_
 331  */
 332 void FAST_FUNC bb_unsetenv(const char *var)
 333 {
 334         char *tp = strchr(var, '=');
 335
 336         if (!tp) {
 337                 unsetenv(var);
 338                 return;
 339         }
 340
 341         /* In case var was putenv'ed, we can't replace '='
 342          * with NUL and unsetenv(var) - it won't work,
 343          * env is modified by the replacement, unsetenv
 344          * sees "VAR" instead of "VAR=VAL" and does not remove it!
 345          * horror :( */
 346         tp = xstrndup(var, tp - var);
 347         unsetenv(tp);
 348         free(tp);
 349 }
 350
 351 void FAST_FUNC bb_unsetenv_and_free(char *var)
 352 {
 353         bb_unsetenv(var);
 354         free(var);
 355 }
 356
 357 // Die with an error message if we can't set gid.  (Because resource limits may
 358 // limit this user to a given number of processes, and if that fills up the
 359 // setgid() will fail and we'll _still_be_root_, which is bad.)
 360 void FAST_FUNC xsetgid(gid_t gid)
 361 {
 362         if (setgid(gid)) bb_perror_msg_and_die("setgid");
 363 }
 364
 365 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
 366 void FAST_FUNC xsetuid(uid_t uid)
 367 {
 368         if (setuid(uid)) bb_perror_msg_and_die("setuid");
 369 }
 370
 371 void FAST_FUNC xsetegid(gid_t egid)
 372 {
 373         if (setegid(egid)) bb_perror_msg_and_die("setegid");
 374 }
 375
 376 void FAST_FUNC xseteuid(uid_t euid)
 377 {
 378         if (seteuid(euid)) bb_perror_msg_and_die("seteuid");
 379 }
 380
 381 // Die if we can't chdir to a new path.
 382 void FAST_FUNC xchdir(const char *path)
 383 {
 384         if (chdir(path))
 385                 bb_perror_msg_and_die("can't change directory to '%s'", path);
 386 }
 387
 388 void FAST_FUNC xchroot(const char *path)
 389 {
 390         if (chroot(path))
 391                 bb_perror_msg_and_die("can't change root directory to '%s'", path);
 392         xchdir("/");
 393 }
 394
 395 // Print a warning message if opendir() fails, but don't die.
 396 DIR* FAST_FUNC warn_opendir(const char *path)
 397 {
 398         DIR *dp;
 399
 400         dp = opendir(path);
 401         if (!dp)
 402                 bb_perror_msg("can't open '%s'", path);
 403         return dp;
 404 }
 405
 406 // Die with an error message if opendir() fails.
 407 DIR* FAST_FUNC xopendir(const char *path)
 408 {
 409         DIR *dp;
 410
 411         dp = opendir(path);
 412         if (!dp)
 413                 bb_perror_msg_and_die("can't open '%s'", path);
 414         return dp;
 415 }
 416
 417 // Die with an error message if we can't open a new socket.
 418 int FAST_FUNC xsocket(int domain, int type, int protocol)
 419 {
 420         int r = socket(domain, type, protocol);
 421
 422         if (r < 0) {
 423                 /* Hijack vaguely related config option */
 424 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
 425                 const char *s = "INET";
 426 # ifdef AF_PACKET
 427                 if (domain == AF_PACKET) s = "PACKET";
 428 # endif
 429 # ifdef AF_NETLINK
 430                 if (domain == AF_NETLINK) s = "NETLINK";
 431 # endif
 432 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
 433                 bb_perror_msg_and_die("socket(AF_%s,%d,%d)", s, type, protocol);
 434 #else
 435                 bb_perror_msg_and_die("socket");
 436 #endif
 437         }
 438
 439         return r;
 440 }
 441
 442 // Die with an error message if we can't bind a socket to an address.
 443 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
 444 {
 445         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
 446 }
 447
 448 // Die with an error message if we can't listen for connections on a socket.
 449 void FAST_FUNC xlisten(int s, int backlog)
 450 {
 451         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
 452 }
 453
 454 /* Die with an error message if sendto failed.
 455  * Return bytes sent otherwise  */
 456 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
 457                                 socklen_t tolen)
 458 {
 459         ssize_t ret = sendto(s, buf, len, 0, to, tolen);
 460         if (ret < 0) {
 461                 if (ENABLE_FEATURE_CLEAN_UP)
 462                         close(s);
 463                 bb_perror_msg_and_die("sendto");
 464         }
 465         return ret;
 466 }
 467
 468 // xstat() - a stat() which dies on failure with meaningful error message
 469 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
 470 {
 471         if (stat(name, stat_buf))
 472                 bb_perror_msg_and_die("can't stat '%s'", name);
 473 }
 474
 475 void FAST_FUNC xfstat(int fd, struct stat *stat_buf, const char *errmsg)
 476 {
 477         /* errmsg is usually a file name, but not always:
 478          * xfstat may be called in a spot where file name is no longer
 479          * available, and caller may give e.g. "can't stat input file" string.
 480          */
 481         if (fstat(fd, stat_buf))
 482                 bb_simple_perror_msg_and_die(errmsg);
 483 }
 484
 485 // selinux_or_die() - die if SELinux is disabled.
 486 void FAST_FUNC selinux_or_die(void)
 487 {
 488 #if ENABLE_SELINUX
 489         int rc = is_selinux_enabled();
 490         if (rc == 0) {
 491                 bb_error_msg_and_die("SELinux is disabled");
 492         } else if (rc < 0) {
 493                 bb_error_msg_and_die("is_selinux_enabled() failed");
 494         }
 495 #else
 496         bb_error_msg_and_die("SELinux support is disabled");
 497 #endif
 498 }
 499
 500 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
 501 {
 502         int ret;
 503         va_list p;
 504
 505         ret = ioctl(fd, request, argp);
 506         if (ret < 0) {
 507                 va_start(p, fmt);
 508                 bb_verror_msg(fmt, p, strerror(errno));
 509                 /* xfunc_die can actually longjmp, so be nice */
 510                 va_end(p);
 511                 xfunc_die();
 512         }
 513         return ret;
 514 }
 515
 516 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
 517 {
 518         va_list p;
 519         int ret = ioctl(fd, request, argp);
 520
 521         if (ret < 0) {
 522                 va_start(p, fmt);
 523                 bb_verror_msg(fmt, p, strerror(errno));
 524                 va_end(p);
 525         }
 526         return ret;
 527 }
 528
 529 #if ENABLE_IOCTL_HEX2STR_ERROR
 530 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
 531 {
 532         int ret;
 533
 534         ret = ioctl(fd, request, argp);
 535         if (ret < 0)
 536                 bb_simple_perror_msg(ioctl_name);
 537         return ret;
 538 }
 539 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
 540 {
 541         int ret;
 542
 543         ret = ioctl(fd, request, argp);
 544         if (ret < 0)
 545                 bb_simple_perror_msg_and_die(ioctl_name);
 546         return ret;
 547 }
 548 #else
 549 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
 550 {
 551         int ret;
 552
 553         ret = ioctl(fd, request, argp);
 554         if (ret < 0)
 555                 bb_perror_msg("ioctl %#x failed", request);
 556         return ret;
 557 }
 558 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
 559 {
 560         int ret;
 561
 562         ret = ioctl(fd, request, argp);
 563         if (ret < 0)
 564                 bb_perror_msg_and_die("ioctl %#x failed", request);
 565         return ret;
 566 }
 567 #endif
 568
 569 char* FAST_FUNC xmalloc_ttyname(int fd)
 570 {
 571         char buf[128];
 572         int r = ttyname_r(fd, buf, sizeof(buf) - 1);
 573         if (r)
 574                 return NULL;
 575         return xstrdup(buf);
 576 }
 577
 578 void FAST_FUNC generate_uuid(uint8_t *buf)
 579 {
 580         /* http://www.ietf.org/rfc/rfc4122.txt
 581          *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 582          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 583          * |                          time_low                             |
 584          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 585          * |       time_mid                |         time_hi_and_version   |
 586          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 587          * |clk_seq_and_variant            |         node (0-1)            |
 588          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 589          * |                         node (2-5)                            |
 590          * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 591          * IOW, uuid has this layout:
 592          * uint32_t time_low (big endian)
 593          * uint16_t time_mid (big endian)
 594          * uint16_t time_hi_and_version (big endian)
 595          *  version is a 4-bit field:
 596          *   1 Time-based
 597          *   2 DCE Security, with embedded POSIX UIDs
 598          *   3 Name-based (MD5)
 599          *   4 Randomly generated
 600          *   5 Name-based (SHA-1)
 601          * uint16_t clk_seq_and_variant (big endian)
 602          *  variant is a 3-bit field:
 603          *   0xx Reserved, NCS backward compatibility
 604          *   10x The variant specified in rfc4122
 605          *   110 Reserved, Microsoft backward compatibility
 606          *   111 Reserved for future definition
 607          * uint8_t node[6]
 608          *
 609          * For version 4, these bits are set/cleared:
 610          * time_hi_and_version & 0x0fff | 0x4000
 611          * clk_seq_and_variant & 0x3fff | 0x8000
 612          */
 613         pid_t pid;
 614         int i;
 615
 616         i = open("/dev/urandom", O_RDONLY);
 617         if (i >= 0) {
 618                 read(i, buf, 16);
 619                 close(i);
 620         }
 621         /* Paranoia. /dev/urandom may be missing.
 622          * rand() is guaranteed to generate at least [0, 2^15) range,
 623          * but lowest bits in some libc are not so "random".  */
 624         srand(monotonic_us()); /* pulls in printf */
 625         pid = getpid();
 626         while (1) {
 627                 for (i = 0; i < 16; i++)
 628                         buf[i] ^= rand() >> 5;
 629                 if (pid == 0)
 630                         break;
 631                 srand(pid);
 632                 pid = 0;
 633         }
 634
 635         /* version = 4 */
 636         buf[4 + 2    ] = (buf[4 + 2    ] & 0x0f) | 0x40;
 637         /* variant = 10x */
 638         buf[4 + 2 + 2] = (buf[4 + 2 + 2] & 0x3f) | 0x80;
 639 }
 640
 641 #if BB_MMU
 642 pid_t FAST_FUNC xfork(void)
 643 {
 644         pid_t pid;
 645         pid = fork();
 646         if (pid < 0) /* wtf? */
 647                 bb_perror_msg_and_die("vfork"+1);
 648         return pid;
 649 }
 650 #endif