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         va_start(p, format);
 287         r = vasprintf(&string_ptr, format, p);
 288         va_end(p);
 289
 290         if (r < 0)
 291                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 292         return string_ptr;
 293 }
 294
 295 void FAST_FUNC xsetenv(const char *key, const char *value)
 296 {
 297         if (setenv(key, value, 1))
 298                 bb_error_msg_and_die(bb_msg_memory_exhausted);
 299 }
 300
 301 /* Handles "VAR=VAL" strings, even those which are part of environ
 302  * _right now_
 303  */
 304 void FAST_FUNC bb_unsetenv(const char *var)
 305 {
 306         char *tp = strchr(var, '=');
 307
 308         if (!tp) {
 309                 unsetenv(var);
 310                 return;
 311         }
 312
 313         /* In case var was putenv'ed, we can't replace '='
 314          * with NUL and unsetenv(var) - it won't work,
 315          * env is modified by the replacement, unsetenv
 316          * sees "VAR" instead of "VAR=VAL" and does not remove it!
 317          * horror :( */
 318         tp = xstrndup(var, tp - var);
 319         unsetenv(tp);
 320         free(tp);
 321 }
 322
 323
 324 // Die with an error message if we can't set gid.  (Because resource limits may
 325 // limit this user to a given number of processes, and if that fills up the
 326 // setgid() will fail and we'll _still_be_root_, which is bad.)
 327 void FAST_FUNC xsetgid(gid_t gid)
 328 {
 329         if (setgid(gid)) bb_perror_msg_and_die("setgid");
 330 }
 331
 332 // Die with an error message if we can't set uid.  (See xsetgid() for why.)
 333 void FAST_FUNC xsetuid(uid_t uid)
 334 {
 335         if (setuid(uid)) bb_perror_msg_and_die("setuid");
 336 }
 337
 338 // Die if we can't chdir to a new path.
 339 void FAST_FUNC xchdir(const char *path)
 340 {
 341         if (chdir(path))
 342                 bb_perror_msg_and_die("chdir(%s)", path);
 343 }
 344
 345 void FAST_FUNC xchroot(const char *path)
 346 {
 347         if (chroot(path))
 348                 bb_perror_msg_and_die("can't change root directory to %s", path);
 349 }
 350
 351 // Print a warning message if opendir() fails, but don't die.
 352 DIR* FAST_FUNC warn_opendir(const char *path)
 353 {
 354         DIR *dp;
 355
 356         dp = opendir(path);
 357         if (!dp)
 358                 bb_perror_msg("can't open '%s'", path);
 359         return dp;
 360 }
 361
 362 // Die with an error message if opendir() fails.
 363 DIR* FAST_FUNC xopendir(const char *path)
 364 {
 365         DIR *dp;
 366
 367         dp = opendir(path);
 368         if (!dp)
 369                 bb_perror_msg_and_die("can't open '%s'", path);
 370         return dp;
 371 }
 372
 373 // Die with an error message if we can't open a new socket.
 374 int FAST_FUNC xsocket(int domain, int type, int protocol)
 375 {
 376         int r = socket(domain, type, protocol);
 377
 378         if (r < 0) {
 379                 /* Hijack vaguely related config option */
 380 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
 381                 const char *s = "INET";
 382                 if (domain == AF_PACKET) s = "PACKET";
 383                 if (domain == AF_NETLINK) s = "NETLINK";
 384 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
 385                 bb_perror_msg_and_die("socket(AF_%s)", s);
 386 #else
 387                 bb_perror_msg_and_die("socket");
 388 #endif
 389         }
 390
 391         return r;
 392 }
 393
 394 // Die with an error message if we can't bind a socket to an address.
 395 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
 396 {
 397         if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
 398 }
 399
 400 // Die with an error message if we can't listen for connections on a socket.
 401 void FAST_FUNC xlisten(int s, int backlog)
 402 {
 403         if (listen(s, backlog)) bb_perror_msg_and_die("listen");
 404 }
 405
 406 /* Die with an error message if sendto failed.
 407  * Return bytes sent otherwise  */
 408 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
 409                                 socklen_t tolen)
 410 {
 411         ssize_t ret = sendto(s, buf, len, 0, to, tolen);
 412         if (ret < 0) {
 413                 if (ENABLE_FEATURE_CLEAN_UP)
 414                         close(s);
 415                 bb_perror_msg_and_die("sendto");
 416         }
 417         return ret;
 418 }
 419
 420 // xstat() - a stat() which dies on failure with meaningful error message
 421 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
 422 {
 423         if (stat(name, stat_buf))
 424                 bb_perror_msg_and_die("can't stat '%s'", name);
 425 }
 426
 427 // selinux_or_die() - die if SELinux is disabled.
 428 void FAST_FUNC selinux_or_die(void)
 429 {
 430 #if ENABLE_SELINUX
 431         int rc = is_selinux_enabled();
 432         if (rc == 0) {
 433                 bb_error_msg_and_die("SELinux is disabled");
 434         } else if (rc < 0) {
 435                 bb_error_msg_and_die("is_selinux_enabled() failed");
 436         }
 437 #else
 438         bb_error_msg_and_die("SELinux support is disabled");
 439 #endif
 440 }
 441
 442 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
 443 {
 444         int ret;
 445         va_list p;
 446
 447         ret = ioctl(fd, request, argp);
 448         if (ret < 0) {
 449                 va_start(p, fmt);
 450                 bb_verror_msg(fmt, p, strerror(errno));
 451                 /* xfunc_die can actually longjmp, so be nice */
 452                 va_end(p);
 453                 xfunc_die();
 454         }
 455         return ret;
 456 }
 457
 458 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
 459 {
 460         va_list p;
 461         int ret = ioctl(fd, request, argp);
 462
 463         if (ret < 0) {
 464                 va_start(p, fmt);
 465                 bb_verror_msg(fmt, p, strerror(errno));
 466                 va_end(p);
 467         }
 468         return ret;
 469 }
 470
 471 #if ENABLE_IOCTL_HEX2STR_ERROR
 472 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
 473 {
 474         int ret;
 475
 476         ret = ioctl(fd, request, argp);
 477         if (ret < 0)
 478                 bb_simple_perror_msg(ioctl_name);
 479         return ret;
 480 }
 481 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
 482 {
 483         int ret;
 484
 485         ret = ioctl(fd, request, argp);
 486         if (ret < 0)
 487                 bb_simple_perror_msg_and_die(ioctl_name);
 488         return ret;
 489 }
 490 #else
 491 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
 492 {
 493         int ret;
 494
 495         ret = ioctl(fd, request, argp);
 496         if (ret < 0)
 497                 bb_perror_msg("ioctl %#x failed", request);
 498         return ret;
 499 }
 500 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
 501 {
 502         int ret;
 503
 504         ret = ioctl(fd, request, argp);
 505         if (ret < 0)
 506                 bb_perror_msg_and_die("ioctl %#x failed", request);
 507         return ret;
 508 }
 509 #endif