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