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