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 GPL version 2, see file LICENSE in this tarball for details.
  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 an existing 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 void FAST_FUNC xunlink(const char *pathname)
 162 {
 163         if (unlink(pathname))
 164                 bb_perror_msg_and_die("can't remove file '%s'", pathname);
 165 }
 166
 167 void FAST_FUNC xrename(const char *oldpath, const char *newpath)
 168 {
 169         if (rename(oldpath, newpath))
 170                 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath, newpath);
 171 }
 172
 173 int FAST_FUNC rename_or_warn(const char *oldpath, const char *newpath)
 174 {
 175         int n = rename(oldpath, newpath);
 176         if (n)
 177                 bb_perror_msg("can't move '%s' to '%s'", oldpath, newpath);
 178         return n;
 179 }
 180
 181 void FAST_FUNC xpipe(int filedes[2])
 182 {
 183         if (pipe(filedes))
 184                 bb_perror_msg_and_die("can't create pipe");
 185 }
 186
 187 void FAST_FUNC xdup2(int from, int to)
 188 {
 189         if (dup2(from, to) != to)
 190                 bb_perror_msg_and_die("can't duplicate file descriptor");
 191 }
 192
 193 // "Renumber" opened fd
 194 void FAST_FUNC xmove_fd(int from, int to)
 195 {
 196         if (from == to)
 197                 return;
 198         xdup2(from, to);
 199         close(from);
 200 }
 201
 202 // Die with an error message if we can't write the entire buffer.
 203 void FAST_FUNC xwrite(int fd, const void *buf, size_t count)
 204 {
 205         if (count) {
 206                 ssize_t size = full_write(fd, buf, count);
 207                 if ((size_t)size != count)
 208                         bb_error_msg_and_die("short write");
 209         }
 210 }
 211 void FAST_FUNC xwrite_str(int fd, const char *str)
 212 {
 213         xwrite(fd, str, strlen(str));
 214 }
 215
 216 void FAST_FUNC xclose(int fd)
 217 {
 218         if (close(fd))
 219                 bb_perror_msg_and_die("close failed");
 220 }
 221
 222 // Die with an error message if we can't lseek to the right spot.
 223 off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
 224 {
 225         off_t off = lseek(fd, offset, whence);
 226         if (off == (off_t)-1) {
 227                 if (whence == SEEK_SET)
 228                         bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
 229                 bb_perror_msg_and_die("lseek");
 230         }
 231         return off;
 232 }
 233
 234 // Die with supplied filename if this FILE* has ferror set.
 235 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
 236 {
 237         if (ferror(fp)) {
 238                 /* ferror doesn't set useful errno */
 239                 bb_error_msg_and_die("%s: I/O error", fn);
 240         }
 241 }
 242
 243 // Die with an error message if stdout has ferror set.
 244 void FAST_FUNC die_if_ferror_stdout(void)
 245 {
 246         die_if_ferror(stdout, bb_msg_standard_output);
 247 }
 248
 249 // Die with an error message if we have trouble flushing stdout.
 250 void FAST_FUNC xfflush_stdout(void)
 251 {
 252         if (fflush(stdout)) {
 253                 bb_perror_msg_and_die(bb_msg_standard_output);
 254         }
 255 }
 256
 257
 258 int FAST_FUNC bb_putchar(int ch)
 259 {
 260         /* time.c needs putc(ch, stdout), not putchar(ch).
 261          * it does "stdout = stderr;", but then glibc's putchar()
 262          * doesn't work as expected. bad glibc, bad */
 263         return putc(ch, stdout);
 264 }
 265
 266 /* Die with an error message if we can't copy an entire FILE* to stdout,
 267  * then close that file. */
 268 void FAST_FUNC xprint_and_close_file(FILE *file)
 269 {
 270         fflush(stdout);
 271         // copyfd outputs error messages for us.
 272         if (bb_copyfd_eof(fileno(file), 1) == -1)
 273                 xfunc_die();
 274
 275         fclose(file);
 276 }
 277
 278 // Die with an error message if we can't malloc() enough space and do an
 279 // sprintf() into that space.
 280 char* FAST_FUNC xasprintf(const char *format, ...)
 281 {
 282         va_list p;
 283         int r;
 284         char *string_ptr;
 285
 286 #if 1
 287         // GNU extension
 288         va_start(p, format);
 289         r = vasprintf(&string_ptr, format, p);
 290         va_end(p);
 291 #else
 292         // Bloat for systems that haven't got the GNU extension.
 293         va_start(p, format);
 294         r = vsnprintf(NULL, 0, format, p);
 295         va_end(p);
 296         string_ptr = xmalloc(r+1);
 297         va_start(p, format);
 298         r = vsnprintf(string_ptr, r+1, format, p);
 299         va_end(p);
 300 #endif
 301
 302         if (r < 0)
 303                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 304         return string_ptr;
 305 }
 306
 307 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
 308 int FAST_FUNC fdprintf(int fd, const char *format, ...)
 309 {
 310         va_list p;
 311         int r;
 312         char *string_ptr;
 313
 314 #if 1
 315         // GNU extension
 316         va_start(p, format);
 317         r = vasprintf(&string_ptr, format, p);
 318         va_end(p);
 319 #else
 320         // Bloat for systems that haven't got the GNU extension.
 321         va_start(p, format);
 322         r = vsnprintf(NULL, 0, format, p) + 1;
 323         va_end(p);
 324         string_ptr = malloc(r);
 325         if (string_ptr) {
 326                 va_start(p, format);
 327                 r = vsnprintf(string_ptr, r, format, p);
 328                 va_end(p);
 329         }
 330 #endif
 331
 332         if (r >= 0) {
 333                 full_write(fd, string_ptr, r);
 334                 free(string_ptr);
 335         }
 336         return r;
 337 }
 338 #endif
 339
 340 void FAST_FUNC xsetenv(const char *key, const char *value)
 341 {
 342         if (setenv(key, value, 1))
 343                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 344 }
 345
 346 /* Handles "VAR=VAL" strings, even those which are part of environ
 347  * _right now_
 348  */
 349 void FAST_FUNC bb_unsetenv(const char *var)
 350 {
 351         char *tp = strchr(var, '=');
 352
 353         if (!tp) {
 354                 unsetenv(var);
 355                 return;
 356         }
 357
 358         /* In case var was putenv'ed, we can't replace '='
 359          * with NUL and unsetenv(var) - it won't work,
 360          * env is modified by the replacement, unsetenv
 361          * sees "VAR" instead of "VAR=VAL" and does not remove it!
 362          * horror :( */
 363         tp = xstrndup(var, tp - var);
 364         unsetenv(tp);
 365         free(tp);
 366 }
 367
 368
 369 // Die with an error message if we can't set gid.  (Because resource limits may
 370 // limit this user to a given number of processes, and if that fills up the
 371 // setgid() will fail and we'll _still_be_root_, which is bad.)
 372 void FAST_FUNC xsetgid(gid_t gid)
 373 {
 374         if (setgid(gid)) bb_perror_msg_and_die("setgid");
 375 }
 376
 377 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
 378 void FAST_FUNC xsetuid(uid_t uid)
 379 {
 380         if (setuid(uid)) bb_perror_msg_and_die("setuid");
 381 }
 382
 383 // Die if we can't chdir to a new path.
 384 void FAST_FUNC xchdir(const char *path)
 385 {
 386         if (chdir(path))
 387                 bb_perror_msg_and_die("chdir(%s)", path);
 388 }
 389
 390 void FAST_FUNC xchroot(const char *path)
 391 {
 392         if (chroot(path))
 393                 bb_perror_msg_and_die("can't change root directory to %s", path);
 394 }
 395
 396 // Print a warning message if opendir() fails, but don't die.
 397 DIR* FAST_FUNC warn_opendir(const char *path)
 398 {
 399         DIR *dp;
 400
 401         dp = opendir(path);
 402         if (!dp)
 403                 bb_perror_msg("can't open '%s'", path);
 404         return dp;
 405 }
 406
 407 // Die with an error message if opendir() fails.
 408 DIR* FAST_FUNC xopendir(const char *path)
 409 {
 410         DIR *dp;
 411
 412         dp = opendir(path);
 413         if (!dp)
 414                 bb_perror_msg_and_die("can't open '%s'", path);
 415         return dp;
 416 }
 417
 418 // Die with an error message if we can't open a new socket.
 419 int FAST_FUNC xsocket(int domain, int type, int protocol)
 420 {
 421         int r = socket(domain, type, protocol);
 422
 423         if (r < 0) {
 424                 /* Hijack vaguely related config option */
 425 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
 426                 const char *s = "INET";
 427                 if (domain == AF_PACKET) s = "PACKET";
 428                 if (domain == AF_NETLINK) s = "NETLINK";
 429 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
 430                 bb_perror_msg_and_die("socket(AF_%s)", s);
 431 #else
 432                 bb_perror_msg_and_die("socket");
 433 #endif
 434         }
 435
 436         return r;
 437 }
 438
 439 // Die with an error message if we can't bind a socket to an address.
 440 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
 441 {
 442         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
 443 }
 444
 445 // Die with an error message if we can't listen for connections on a socket.
 446 void FAST_FUNC xlisten(int s, int backlog)
 447 {
 448         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
 449 }
 450
 451 /* Die with an error message if sendto failed.
 452  * Return bytes sent otherwise  */
 453 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
 454                                 socklen_t tolen)
 455 {
 456         ssize_t ret = sendto(s, buf, len, 0, to, tolen);
 457         if (ret < 0) {
 458                 if (ENABLE_FEATURE_CLEAN_UP)
 459                         close(s);
 460                 bb_perror_msg_and_die("sendto");
 461         }
 462         return ret;
 463 }
 464
 465 // xstat() - a stat() which dies on failure with meaningful error message
 466 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
 467 {
 468         if (stat(name, stat_buf))
 469                 bb_perror_msg_and_die("can't stat '%s'", name);
 470 }
 471
 472 // selinux_or_die() - die if SELinux is disabled.
 473 void FAST_FUNC selinux_or_die(void)
 474 {
 475 #if ENABLE_SELINUX
 476         int rc = is_selinux_enabled();
 477         if (rc == 0) {
 478                 bb_error_msg_and_die("SELinux is disabled");
 479         } else if (rc < 0) {
 480                 bb_error_msg_and_die("is_selinux_enabled() failed");
 481         }
 482 #else
 483         bb_error_msg_and_die("SELinux support is disabled");
 484 #endif
 485 }
 486
 487 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
 488 {
 489         int ret;
 490         va_list p;
 491
 492         ret = ioctl(fd, request, argp);
 493         if (ret < 0) {
 494                 va_start(p, fmt);
 495                 bb_verror_msg(fmt, p, strerror(errno));
 496                 /* xfunc_die can actually longjmp, so be nice */
 497                 va_end(p);
 498                 xfunc_die();
 499         }
 500         return ret;
 501 }
 502
 503 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
 504 {
 505         va_list p;
 506         int ret = ioctl(fd, request, argp);
 507
 508         if (ret < 0) {
 509                 va_start(p, fmt);
 510                 bb_verror_msg(fmt, p, strerror(errno));
 511                 va_end(p);
 512         }
 513         return ret;
 514 }
 515
 516 #if ENABLE_IOCTL_HEX2STR_ERROR
 517 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
 518 {
 519         int ret;
 520
 521         ret = ioctl(fd, request, argp);
 522         if (ret < 0)
 523                 bb_simple_perror_msg(ioctl_name);
 524         return ret;
 525 }
 526 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
 527 {
 528         int ret;
 529
 530         ret = ioctl(fd, request, argp);
 531         if (ret < 0)
 532                 bb_simple_perror_msg_and_die(ioctl_name);
 533         return ret;
 534 }
 535 #else
 536 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
 537 {
 538         int ret;
 539
 540         ret = ioctl(fd, request, argp);
 541         if (ret < 0)
 542                 bb_perror_msg("ioctl %#x failed", request);
 543         return ret;
 544 }
 545 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
 546 {
 547         int ret;
 548
 549         ret = ioctl(fd, request, argp);
 550         if (ret < 0)
 551                 bb_perror_msg_and_die("ioctl %#x failed", request);
 552         return ret;
 553 }
 554 #endif