1 /* vi: set sw=4 ts=4: */
5 * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
6 * Copyright (C) 2006 Rob Landley
7 * Copyright (C) 2006 Denys Vlasenko
9 * Licensed under GPLv2, see file LICENSE in this source tree.
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.
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.
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
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.
35 // Warn if we can't allocate size bytes of memory.
36 void* FAST_FUNC malloc_or_warn(size_t size)
38 void *ptr = malloc(size);
39 if (ptr == NULL && size != 0)
40 bb_error_msg(bb_msg_memory_exhausted);
44 // Die if we can't allocate size bytes of memory.
45 void* FAST_FUNC xmalloc(size_t size)
47 void *ptr = malloc(size);
48 if (ptr == NULL && size != 0)
49 bb_error_msg_and_die(bb_msg_memory_exhausted);
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)
58 ptr = realloc(ptr, size);
59 if (ptr == NULL && size != 0)
60 bb_error_msg_and_die(bb_msg_memory_exhausted);
65 // Die if we can't allocate and zero size bytes of memory.
66 void* FAST_FUNC xzalloc(size_t size)
68 void *ptr = xmalloc(size);
73 // Die if we can't copy a string to freshly allocated memory.
74 char* FAST_FUNC xstrdup(const char *s)
84 bb_error_msg_and_die(bb_msg_memory_exhausted);
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)
96 if (ENABLE_DEBUG && s == NULL)
97 bb_error_msg_and_die("xstrndup bug");
99 /* We can just xmalloc(n+1) and strncpy into it, */
100 /* but think about xstrndup("abc", 10000) wastage! */
112 return memcpy(t, s, n);
115 void* FAST_FUNC xmemdup(const void *s, int n)
117 return memcpy(xmalloc(n), s, n);
120 // Die if we can't open a file and return a FILE* to it.
121 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
122 FILE* FAST_FUNC xfopen(const char *path, const char *mode)
124 FILE *fp = fopen(path, mode);
126 bb_perror_msg_and_die("can't open '%s'", path);
130 // Die if we can't open a file and return a fd.
131 int FAST_FUNC xopen3(const char *pathname, int flags, int mode)
135 ret = open(pathname, flags, mode);
137 bb_perror_msg_and_die("can't open '%s'", pathname);
142 // Die if we can't open a file and return a fd.
143 int FAST_FUNC xopen(const char *pathname, int flags)
145 return xopen3(pathname, flags, 0666);
148 // Warn if we can't open a file and return a fd.
149 int FAST_FUNC open3_or_warn(const char *pathname, int flags, int mode)
153 ret = open(pathname, flags, mode);
155 bb_perror_msg("can't open '%s'", pathname);
160 // Warn if we can't open a file and return a fd.
161 int FAST_FUNC open_or_warn(const char *pathname, int flags)
163 return open3_or_warn(pathname, flags, 0666);
166 /* Die if we can't open an existing file readonly with O_NONBLOCK
168 * Note that for ioctl O_RDONLY is sufficient.
170 int FAST_FUNC xopen_nonblocking(const char *pathname)
172 return xopen(pathname, O_RDONLY | O_NONBLOCK);
175 int FAST_FUNC xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g)
178 uid_t old_euid = geteuid();
179 gid_t old_egid = getegid();
184 fd = xopen(pathname, flags);
192 void FAST_FUNC xunlink(const char *pathname)
194 if (unlink(pathname))
195 bb_perror_msg_and_die("can't remove file '%s'", pathname);
198 void FAST_FUNC xrename(const char *oldpath, const char *newpath)
200 if (rename(oldpath, newpath))
201 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath, newpath);
204 int FAST_FUNC rename_or_warn(const char *oldpath, const char *newpath)
206 int n = rename(oldpath, newpath);
208 bb_perror_msg("can't move '%s' to '%s'", oldpath, newpath);
212 void FAST_FUNC xpipe(int filedes[2])
215 bb_perror_msg_and_die("can't create pipe");
218 void FAST_FUNC xdup2(int from, int to)
220 if (dup2(from, to) != to)
221 bb_perror_msg_and_die("can't duplicate file descriptor");
224 // "Renumber" opened fd
225 void FAST_FUNC xmove_fd(int from, int to)
233 // Die with an error message if we can't write the entire buffer.
234 void FAST_FUNC xwrite(int fd, const void *buf, size_t count)
237 ssize_t size = full_write(fd, buf, count);
238 if ((size_t)size != count)
239 bb_error_msg_and_die("short write");
242 void FAST_FUNC xwrite_str(int fd, const char *str)
244 xwrite(fd, str, strlen(str));
247 void FAST_FUNC xclose(int fd)
250 bb_perror_msg_and_die("close failed");
253 // Die with an error message if we can't lseek to the right spot.
254 off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
256 off_t off = lseek(fd, offset, whence);
257 if (off == (off_t)-1) {
258 if (whence == SEEK_SET)
259 bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
260 bb_perror_msg_and_die("lseek");
265 int FAST_FUNC xmkstemp(char *template)
267 int fd = mkstemp(template);
269 bb_perror_msg_and_die("can't create temp file '%s'", template);
273 // Die with supplied filename if this FILE* has ferror set.
274 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
277 /* ferror doesn't set useful errno */
278 bb_error_msg_and_die("%s: I/O error", fn);
282 // Die with an error message if stdout has ferror set.
283 void FAST_FUNC die_if_ferror_stdout(void)
285 die_if_ferror(stdout, bb_msg_standard_output);
288 int FAST_FUNC fflush_all(void)
294 int FAST_FUNC bb_putchar(int ch)
299 /* Die with an error message if we can't copy an entire FILE* to stdout,
300 * then close that file. */
301 void FAST_FUNC xprint_and_close_file(FILE *file)
304 // copyfd outputs error messages for us.
305 if (bb_copyfd_eof(fileno(file), STDOUT_FILENO) == -1)
311 // Die with an error message if we can't malloc() enough space and do an
312 // sprintf() into that space.
313 char* FAST_FUNC xasprintf(const char *format, ...)
320 r = vasprintf(&string_ptr, format, p);
324 bb_error_msg_and_die(bb_msg_memory_exhausted);
328 void FAST_FUNC xsetenv(const char *key, const char *value)
330 if (setenv(key, value, 1))
331 bb_error_msg_and_die(bb_msg_memory_exhausted);
334 /* Handles "VAR=VAL" strings, even those which are part of environ
337 void FAST_FUNC bb_unsetenv(const char *var)
339 char *tp = strchr(var, '=');
346 /* In case var was putenv'ed, we can't replace '='
347 * with NUL and unsetenv(var) - it won't work,
348 * env is modified by the replacement, unsetenv
349 * sees "VAR" instead of "VAR=VAL" and does not remove it!
351 tp = xstrndup(var, tp - var);
356 void FAST_FUNC bb_unsetenv_and_free(char *var)
362 // Die with an error message if we can't set gid. (Because resource limits may
363 // limit this user to a given number of processes, and if that fills up the
364 // setgid() will fail and we'll _still_be_root_, which is bad.)
365 void FAST_FUNC xsetgid(gid_t gid)
367 if (setgid(gid)) bb_perror_msg_and_die("setgid");
370 // Die with an error message if we can't set uid. (See xsetgid() for why.)
371 void FAST_FUNC xsetuid(uid_t uid)
373 if (setuid(uid)) bb_perror_msg_and_die("setuid");
376 void FAST_FUNC xsetegid(gid_t egid)
378 if (setegid(egid)) bb_perror_msg_and_die("setegid");
381 void FAST_FUNC xseteuid(uid_t euid)
383 if (seteuid(euid)) bb_perror_msg_and_die("seteuid");
386 // Die if we can't chdir to a new path.
387 void FAST_FUNC xchdir(const char *path)
390 bb_perror_msg_and_die("can't change directory to '%s'", path);
393 void FAST_FUNC xfchdir(int fd)
396 bb_perror_msg_and_die("fchdir");
399 void FAST_FUNC xchroot(const char *path)
402 bb_perror_msg_and_die("can't change root directory to '%s'", path);
406 // Print a warning message if opendir() fails, but don't die.
407 DIR* FAST_FUNC warn_opendir(const char *path)
413 bb_perror_msg("can't open '%s'", path);
417 // Die with an error message if opendir() fails.
418 DIR* FAST_FUNC xopendir(const char *path)
424 bb_perror_msg_and_die("can't open '%s'", path);
428 // Die with an error message if we can't open a new socket.
429 int FAST_FUNC xsocket(int domain, int type, int protocol)
431 int r = socket(domain, type, protocol);
434 /* Hijack vaguely related config option */
435 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
436 const char *s = "INET";
438 if (domain == AF_PACKET) s = "PACKET";
441 if (domain == AF_NETLINK) s = "NETLINK";
443 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
444 bb_perror_msg_and_die("socket(AF_%s,%d,%d)", s, type, protocol);
446 bb_perror_msg_and_die("socket");
453 // Die with an error message if we can't bind a socket to an address.
454 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
456 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
459 // Die with an error message if we can't listen for connections on a socket.
460 void FAST_FUNC xlisten(int s, int backlog)
462 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
465 /* Die with an error message if sendto failed.
466 * Return bytes sent otherwise */
467 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
470 ssize_t ret = sendto(s, buf, len, 0, to, tolen);
472 if (ENABLE_FEATURE_CLEAN_UP)
474 bb_perror_msg_and_die("sendto");
479 // xstat() - a stat() which dies on failure with meaningful error message
480 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
482 if (stat(name, stat_buf))
483 bb_perror_msg_and_die("can't stat '%s'", name);
486 void FAST_FUNC xfstat(int fd, struct stat *stat_buf, const char *errmsg)
488 /* errmsg is usually a file name, but not always:
489 * xfstat may be called in a spot where file name is no longer
490 * available, and caller may give e.g. "can't stat input file" string.
492 if (fstat(fd, stat_buf))
493 bb_simple_perror_msg_and_die(errmsg);
496 // selinux_or_die() - die if SELinux is disabled.
497 void FAST_FUNC selinux_or_die(void)
500 int rc = is_selinux_enabled();
502 bb_error_msg_and_die("SELinux is disabled");
504 bb_error_msg_and_die("is_selinux_enabled() failed");
507 bb_error_msg_and_die("SELinux support is disabled");
511 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
516 ret = ioctl(fd, request, argp);
519 bb_verror_msg(fmt, p, strerror(errno));
520 /* xfunc_die can actually longjmp, so be nice */
527 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
530 int ret = ioctl(fd, request, argp);
534 bb_verror_msg(fmt, p, strerror(errno));
540 #if ENABLE_IOCTL_HEX2STR_ERROR
541 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
545 ret = ioctl(fd, request, argp);
547 bb_simple_perror_msg(ioctl_name);
550 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
554 ret = ioctl(fd, request, argp);
556 bb_simple_perror_msg_and_die(ioctl_name);
560 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
564 ret = ioctl(fd, request, argp);
566 bb_perror_msg("ioctl %#x failed", request);
569 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
573 ret = ioctl(fd, request, argp);
575 bb_perror_msg_and_die("ioctl %#x failed", request);
580 char* FAST_FUNC xmalloc_ttyname(int fd)
583 int r = ttyname_r(fd, buf, sizeof(buf) - 1);
589 void FAST_FUNC generate_uuid(uint8_t *buf)
591 /* http://www.ietf.org/rfc/rfc4122.txt
592 * 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
593 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
595 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
596 * | time_mid | time_hi_and_version |
597 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
598 * |clk_seq_and_variant | node (0-1) |
599 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
601 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
602 * IOW, uuid has this layout:
603 * uint32_t time_low (big endian)
604 * uint16_t time_mid (big endian)
605 * uint16_t time_hi_and_version (big endian)
606 * version is a 4-bit field:
608 * 2 DCE Security, with embedded POSIX UIDs
610 * 4 Randomly generated
611 * 5 Name-based (SHA-1)
612 * uint16_t clk_seq_and_variant (big endian)
613 * variant is a 3-bit field:
614 * 0xx Reserved, NCS backward compatibility
615 * 10x The variant specified in rfc4122
616 * 110 Reserved, Microsoft backward compatibility
617 * 111 Reserved for future definition
620 * For version 4, these bits are set/cleared:
621 * time_hi_and_version & 0x0fff | 0x4000
622 * clk_seq_and_variant & 0x3fff | 0x8000
627 i = open("/dev/urandom", O_RDONLY);
632 /* Paranoia. /dev/urandom may be missing.
633 * rand() is guaranteed to generate at least [0, 2^15) range,
634 * but lowest bits in some libc are not so "random". */
635 srand(monotonic_us()); /* pulls in printf */
638 for (i = 0; i < 16; i++)
639 buf[i] ^= rand() >> 5;
647 buf[4 + 2 ] = (buf[4 + 2 ] & 0x0f) | 0x40;
649 buf[4 + 2 + 2] = (buf[4 + 2 + 2] & 0x3f) | 0x80;
653 pid_t FAST_FUNC xfork(void)
657 if (pid < 0) /* wtf? */
658 bb_perror_msg_and_die("vfork"+1);
663 void FAST_FUNC xvfork_parent_waits_and_exits(void)
671 int exit_status = wait_for_exitstatus(pid);
672 if (WIFSIGNALED(exit_status))
673 kill_myself_with_sig(WTERMSIG(exit_status));
674 _exit(WEXITSTATUS(exit_status));
676 /* Child continues */