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.
11 /* We need to have separate xfuncs.c and xfuncs_printf.c because
12 * with current linkers, even with section garbage collection,
13 * if *.o module references any of XXXprintf functions, you pull in
14 * entire printf machinery. Even if you do not use the function
15 * which uses XXXprintf.
17 * xfuncs.c contains functions (not necessarily xfuncs)
18 * which do not pull in printf, directly or indirectly.
19 * xfunc_printf.c contains those which do.
24 /* All the functions starting with "x" call bb_error_msg_and_die() if they
25 * fail, so callers never need to check for errors. If it returned, it
28 void FAST_FUNC bb_die_memory_exhausted(void)
30 bb_simple_error_msg_and_die(bb_msg_memory_exhausted);
34 /* dmalloc provides variants of these that do abort() on failure.
35 * Since dmalloc's prototypes overwrite the impls here as they are
36 * included after these prototypes in libbb.h, all is well.
38 // Warn if we can't allocate size bytes of memory.
39 void* FAST_FUNC malloc_or_warn(size_t size)
41 void *ptr = malloc(size);
42 if (ptr == NULL && size != 0)
43 bb_simple_error_msg(bb_msg_memory_exhausted);
47 // Die if we can't allocate size bytes of memory.
48 void* FAST_FUNC xmalloc(size_t size)
50 void *ptr = malloc(size);
51 if (ptr == NULL && size != 0)
52 bb_die_memory_exhausted();
56 // Die if we can't resize previously allocated memory. (This returns a pointer
57 // to the new memory, which may or may not be the same as the old memory.
58 // It'll copy the contents to a new chunk and free the old one if necessary.)
59 void* FAST_FUNC xrealloc(void *ptr, size_t size)
61 ptr = realloc(ptr, size);
62 if (ptr == NULL && size != 0)
63 bb_die_memory_exhausted();
68 // Die if we can't allocate and zero size bytes of memory.
69 void* FAST_FUNC xzalloc(size_t size)
71 void *ptr = xmalloc(size);
76 // Die if we can't copy a string to freshly allocated memory.
77 char* FAST_FUNC xstrdup(const char *s)
87 bb_die_memory_exhausted();
92 // Die if we can't allocate n+1 bytes (space for the null terminator) and copy
93 // the (possibly truncated to length n) string into it.
94 char* FAST_FUNC xstrndup(const char *s, int n)
98 if (ENABLE_DEBUG && s == NULL)
99 bb_simple_error_msg_and_die("xstrndup bug");
104 bb_die_memory_exhausted();
109 void* FAST_FUNC xmemdup(const void *s, int n)
111 return memcpy(xmalloc(n), s, n);
114 // Die if we can't open a file and return a FILE* to it.
115 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
116 FILE* FAST_FUNC xfopen(const char *path, const char *mode)
118 FILE *fp = fopen(path, mode);
120 bb_perror_msg_and_die("can't open '%s'", path);
124 // Die if we can't open a file and return a fd.
125 int FAST_FUNC xopen3(const char *pathname, int flags, int mode)
129 ret = open(pathname, flags, mode);
131 bb_perror_msg_and_die("can't open '%s'", pathname);
136 // Die if we can't open a file and return a fd.
137 int FAST_FUNC xopen(const char *pathname, int flags)
139 return xopen3(pathname, flags, 0666);
142 // Warn if we can't open a file and return a fd.
143 int FAST_FUNC open3_or_warn(const char *pathname, int flags, int mode)
147 ret = open(pathname, flags, mode);
149 bb_perror_msg("can't open '%s'", pathname);
154 // Warn if we can't open a file and return a fd.
155 int FAST_FUNC open_or_warn(const char *pathname, int flags)
157 return open3_or_warn(pathname, flags, 0666);
160 /* Die if we can't open an existing file readonly with O_NONBLOCK
162 * Note that for ioctl O_RDONLY is sufficient.
164 int FAST_FUNC xopen_nonblocking(const char *pathname)
166 return xopen(pathname, O_RDONLY | O_NONBLOCK);
169 int FAST_FUNC xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g)
172 uid_t old_euid = geteuid();
173 gid_t old_egid = getegid();
178 fd = xopen(pathname, flags);
186 void FAST_FUNC xunlink(const char *pathname)
188 if (unlink(pathname))
189 bb_perror_msg_and_die("can't remove file '%s'", pathname);
192 void FAST_FUNC xrename(const char *oldpath, const char *newpath)
194 if (rename(oldpath, newpath))
195 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath, newpath);
198 int FAST_FUNC rename_or_warn(const char *oldpath, const char *newpath)
200 int n = rename(oldpath, newpath);
202 bb_perror_msg("can't move '%s' to '%s'", oldpath, newpath);
206 void FAST_FUNC xpipe(int filedes[2])
209 bb_simple_perror_msg_and_die("can't create pipe");
212 void FAST_FUNC xdup2(int from, int to)
214 if (dup2(from, to) != to)
215 bb_simple_perror_msg_and_die("can't duplicate file descriptor");
216 // " %d to %d", from, to);
219 // "Renumber" opened fd
220 void FAST_FUNC xmove_fd(int from, int to)
228 // Die with an error message if we can't write the entire buffer.
229 void FAST_FUNC xwrite(int fd, const void *buf, size_t count)
232 ssize_t size = full_write(fd, buf, count);
233 if ((size_t)size != count) {
235 * Two cases: write error immediately;
236 * or some writes succeeded, then we hit an error.
237 * In either case, errno is set.
239 bb_simple_perror_msg_and_die(
240 size >= 0 ? "short write" : "write error"
245 void FAST_FUNC xwrite_str(int fd, const char *str)
247 xwrite(fd, str, strlen(str));
250 void FAST_FUNC xclose(int fd)
253 bb_simple_perror_msg_and_die("close failed");
256 // Die with an error message if we can't lseek to the right spot.
257 off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
259 off_t off = lseek(fd, offset, whence);
260 if (off == (off_t)-1) {
261 bb_perror_msg_and_die("lseek(%"OFF_FMT"u, %d)", offset, whence);
266 int FAST_FUNC xmkstemp(char *template)
268 int fd = mkstemp(template);
270 bb_perror_msg_and_die("can't create temp file '%s'", template);
274 // Die with supplied filename if this FILE* has ferror set.
275 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
278 /* ferror doesn't set useful errno */
279 bb_error_msg_and_die("%s: I/O error", fn);
283 // Die with an error message if stdout has ferror set.
284 void FAST_FUNC die_if_ferror_stdout(void)
286 die_if_ferror(stdout, bb_msg_standard_output);
289 int FAST_FUNC fflush_all(void)
295 int FAST_FUNC bb_putchar(int ch)
300 /* Die with an error message if we can't copy an entire FILE* to stdout,
301 * then close that file. */
302 void FAST_FUNC xprint_and_close_file(FILE *file)
305 // copyfd outputs error messages for us.
306 if (bb_copyfd_eof(fileno(file), STDOUT_FILENO) == -1)
312 // Die with an error message if we can't malloc() enough space and do an
313 // sprintf() into that space.
314 char* FAST_FUNC xasprintf(const char *format, ...)
321 r = vasprintf(&string_ptr, format, p);
325 bb_die_memory_exhausted();
329 void FAST_FUNC xsetenv(const char *key, const char *value)
331 if (setenv(key, value, 1))
332 bb_die_memory_exhausted();
335 /* Handles "VAR=VAL" strings, even those which are part of environ
338 void FAST_FUNC bb_unsetenv(const char *var)
340 char onstack[128 - 16]; /* smaller stack setup code on x86 */
343 tp = strchr(var, '=');
345 /* In case var was putenv'ed, we can't replace '='
346 * with NUL and unsetenv(var) - it won't work,
347 * env is modified by the replacement, unsetenv
348 * sees "VAR" instead of "VAR=VAL" and does not remove it!
351 unsigned sz = tp - var;
352 if (sz < sizeof(onstack)) {
353 ((char*)mempcpy(onstack, var, sz))[0] = '\0';
357 /* unlikely: very long var name */
358 var = tp = xstrndup(var, sz);
365 void FAST_FUNC bb_unsetenv_and_free(char *var)
371 // Die with an error message if we can't set gid. (Because resource limits may
372 // limit this user to a given number of processes, and if that fills up the
373 // setgid() will fail and we'll _still_be_root_, which is bad.)
374 void FAST_FUNC xsetgid(gid_t gid)
376 if (setgid(gid)) bb_simple_perror_msg_and_die("setgid");
379 // Die with an error message if we can't set uid. (See xsetgid() for why.)
380 void FAST_FUNC xsetuid(uid_t uid)
382 if (setuid(uid)) bb_simple_perror_msg_and_die("setuid");
385 void FAST_FUNC xsetegid(gid_t egid)
387 if (setegid(egid)) bb_simple_perror_msg_and_die("setegid");
390 void FAST_FUNC xseteuid(uid_t euid)
392 if (seteuid(euid)) bb_simple_perror_msg_and_die("seteuid");
395 // Die if we can't chdir to a new path.
396 void FAST_FUNC xchdir(const char *path)
399 bb_perror_msg_and_die("can't change directory to '%s'", path);
402 void FAST_FUNC xfchdir(int fd)
405 bb_simple_perror_msg_and_die("fchdir");
408 void FAST_FUNC xchroot(const char *path)
411 bb_perror_msg_and_die("can't change root directory to '%s'", path);
415 // Print a warning message if opendir() fails, but don't die.
416 DIR* FAST_FUNC warn_opendir(const char *path)
422 bb_perror_msg("can't open '%s'", path);
426 // Die with an error message if opendir() fails.
427 DIR* FAST_FUNC xopendir(const char *path)
433 bb_perror_msg_and_die("can't open '%s'", path);
437 // Die with an error message if we can't open a new socket.
438 int FAST_FUNC xsocket(int domain, int type, int protocol)
440 int r = socket(domain, type, protocol);
443 /* Hijack vaguely related config option */
444 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
445 const char *s = "INET";
447 if (domain == AF_PACKET) s = "PACKET";
450 if (domain == AF_NETLINK) s = "NETLINK";
452 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
453 bb_perror_msg_and_die("socket(AF_%s,%d,%d)", s, type, protocol);
455 bb_simple_perror_msg_and_die("socket");
462 // Die with an error message if we can't bind a socket to an address.
463 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
465 if (bind(sockfd, my_addr, addrlen)) bb_simple_perror_msg_and_die("bind");
468 // Die with an error message if we can't listen for connections on a socket.
469 void FAST_FUNC xlisten(int s, int backlog)
471 if (listen(s, backlog)) bb_simple_perror_msg_and_die("listen");
474 /* Die with an error message if sendto failed.
475 * Return bytes sent otherwise */
476 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
479 ssize_t ret = sendto(s, buf, len, 0, to, tolen);
481 if (ENABLE_FEATURE_CLEAN_UP)
483 bb_simple_perror_msg_and_die("sendto");
488 // xstat() - a stat() which dies on failure with meaningful error message
489 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
491 if (stat(name, stat_buf))
492 bb_perror_msg_and_die("can't stat '%s'", name);
495 void FAST_FUNC xfstat(int fd, struct stat *stat_buf, const char *errmsg)
497 /* errmsg is usually a file name, but not always:
498 * xfstat may be called in a spot where file name is no longer
499 * available, and caller may give e.g. "can't stat input file" string.
501 if (fstat(fd, stat_buf))
502 bb_simple_perror_msg_and_die(errmsg);
505 // selinux_or_die() - die if SELinux is disabled.
506 void FAST_FUNC selinux_or_die(void)
509 int rc = is_selinux_enabled();
511 bb_simple_error_msg_and_die("SELinux is disabled");
513 bb_simple_error_msg_and_die("is_selinux_enabled() failed");
516 bb_simple_error_msg_and_die("SELinux support is disabled");
520 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
525 ret = ioctl(fd, request, argp);
528 bb_verror_msg(fmt, p, strerror(errno));
529 /* xfunc_die can actually longjmp, so be nice */
536 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
539 int ret = ioctl(fd, request, argp);
543 bb_verror_msg(fmt, p, strerror(errno));
549 #if ENABLE_IOCTL_HEX2STR_ERROR
550 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
554 ret = ioctl(fd, request, argp);
556 bb_simple_perror_msg(ioctl_name);
559 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
563 ret = ioctl(fd, request, argp);
565 bb_simple_perror_msg_and_die(ioctl_name);
569 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
573 ret = ioctl(fd, request, argp);
575 bb_perror_msg("ioctl %#x failed", request);
578 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
582 ret = ioctl(fd, request, argp);
584 bb_perror_msg_and_die("ioctl %#x failed", request);
589 char* FAST_FUNC xmalloc_ttyname(int fd)
592 int r = ttyname_r(fd, buf, sizeof(buf) - 1);
598 void FAST_FUNC generate_uuid(uint8_t *buf)
600 /* http://www.ietf.org/rfc/rfc4122.txt
601 * 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
602 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
604 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
605 * | time_mid | time_hi_and_version |
606 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
607 * |clk_seq_and_variant | node (0-1) |
608 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
610 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
611 * IOW, uuid has this layout:
612 * uint32_t time_low (big endian)
613 * uint16_t time_mid (big endian)
614 * uint16_t time_hi_and_version (big endian)
615 * version is a 4-bit field:
617 * 2 DCE Security, with embedded POSIX UIDs
619 * 4 Randomly generated
620 * 5 Name-based (SHA-1)
621 * uint16_t clk_seq_and_variant (big endian)
622 * variant is a 3-bit field:
623 * 0xx Reserved, NCS backward compatibility
624 * 10x The variant specified in rfc4122
625 * 110 Reserved, Microsoft backward compatibility
626 * 111 Reserved for future definition
629 * For version 4, these bits are set/cleared:
630 * time_hi_and_version & 0x0fff | 0x4000
631 * clk_seq_and_variant & 0x3fff | 0x8000
636 i = open("/dev/urandom", O_RDONLY);
641 /* Paranoia. /dev/urandom may be missing.
642 * rand() is guaranteed to generate at least [0, 2^15) range,
643 * but lowest bits in some libc are not so "random". */
644 srand(monotonic_us()); /* pulls in printf */
647 for (i = 0; i < 16; i++)
648 buf[i] ^= rand() >> 5;
656 buf[4 + 2 ] = (buf[4 + 2 ] & 0x0f) | 0x40;
658 buf[4 + 2 + 2] = (buf[4 + 2 + 2] & 0x3f) | 0x80;
662 pid_t FAST_FUNC xfork(void)
666 if (pid < 0) /* wtf? */
667 bb_simple_perror_msg_and_die("vfork"+1);
672 void FAST_FUNC xvfork_parent_waits_and_exits(void)
680 int exit_status = wait_for_exitstatus(pid);
681 if (WIFSIGNALED(exit_status))
682 kill_myself_with_sig(WTERMSIG(exit_status));
683 _exit(WEXITSTATUS(exit_status));
685 /* Child continues */