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_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_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)
99 if (ENABLE_DEBUG && s == NULL)
100 bb_error_msg_and_die("xstrndup bug");
102 /* We can just xmalloc(n+1) and strncpy into it, */
103 /* but think about xstrndup("abc", 10000) wastage! */
115 return memcpy(t, s, n);
118 void* FAST_FUNC xmemdup(const void *s, int n)
120 return memcpy(xmalloc(n), s, n);
123 // Die if we can't open a file and return a FILE* to it.
124 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
125 FILE* FAST_FUNC xfopen(const char *path, const char *mode)
127 FILE *fp = fopen(path, mode);
129 bb_perror_msg_and_die("can't open '%s'", path);
133 // Die if we can't open a file and return a fd.
134 int FAST_FUNC xopen3(const char *pathname, int flags, int mode)
138 ret = open(pathname, flags, mode);
140 bb_perror_msg_and_die("can't open '%s'", pathname);
145 // Die if we can't open a file and return a fd.
146 int FAST_FUNC xopen(const char *pathname, int flags)
148 return xopen3(pathname, flags, 0666);
151 // Warn if we can't open a file and return a fd.
152 int FAST_FUNC open3_or_warn(const char *pathname, int flags, int mode)
156 ret = open(pathname, flags, mode);
158 bb_perror_msg("can't open '%s'", pathname);
163 // Warn if we can't open a file and return a fd.
164 int FAST_FUNC open_or_warn(const char *pathname, int flags)
166 return open3_or_warn(pathname, flags, 0666);
169 /* Die if we can't open an existing file readonly with O_NONBLOCK
171 * Note that for ioctl O_RDONLY is sufficient.
173 int FAST_FUNC xopen_nonblocking(const char *pathname)
175 return xopen(pathname, O_RDONLY | O_NONBLOCK);
178 int FAST_FUNC xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g)
181 uid_t old_euid = geteuid();
182 gid_t old_egid = getegid();
187 fd = xopen(pathname, flags);
195 void FAST_FUNC xunlink(const char *pathname)
197 if (unlink(pathname))
198 bb_perror_msg_and_die("can't remove file '%s'", pathname);
201 void FAST_FUNC xrename(const char *oldpath, const char *newpath)
203 if (rename(oldpath, newpath))
204 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath, newpath);
207 int FAST_FUNC rename_or_warn(const char *oldpath, const char *newpath)
209 int n = rename(oldpath, newpath);
211 bb_perror_msg("can't move '%s' to '%s'", oldpath, newpath);
215 void FAST_FUNC xpipe(int filedes[2])
218 bb_perror_msg_and_die("can't create pipe");
221 void FAST_FUNC xdup2(int from, int to)
223 if (dup2(from, to) != to)
224 bb_perror_msg_and_die("can't duplicate file descriptor");
225 // " %d to %d", from, to);
228 // "Renumber" opened fd
229 void FAST_FUNC xmove_fd(int from, int to)
237 // Die with an error message if we can't write the entire buffer.
238 void FAST_FUNC xwrite(int fd, const void *buf, size_t count)
241 ssize_t size = full_write(fd, buf, count);
242 if ((size_t)size != count) {
244 * Two cases: write error immediately;
245 * or some writes succeeded, then we hit an error.
246 * In either case, errno is set.
248 bb_perror_msg_and_die(
249 size >= 0 ? "short write" : "write error"
254 void FAST_FUNC xwrite_str(int fd, const char *str)
256 xwrite(fd, str, strlen(str));
259 void FAST_FUNC xclose(int fd)
262 bb_perror_msg_and_die("close failed");
265 // Die with an error message if we can't lseek to the right spot.
266 off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
268 off_t off = lseek(fd, offset, whence);
269 if (off == (off_t)-1) {
270 if (whence == SEEK_SET)
271 bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
272 bb_perror_msg_and_die("lseek");
277 int FAST_FUNC xmkstemp(char *template)
279 int fd = mkstemp(template);
281 bb_perror_msg_and_die("can't create temp file '%s'", template);
285 // Die with supplied filename if this FILE* has ferror set.
286 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
289 /* ferror doesn't set useful errno */
290 bb_error_msg_and_die("%s: I/O error", fn);
294 // Die with an error message if stdout has ferror set.
295 void FAST_FUNC die_if_ferror_stdout(void)
297 die_if_ferror(stdout, bb_msg_standard_output);
300 int FAST_FUNC fflush_all(void)
306 int FAST_FUNC bb_putchar(int ch)
311 /* Die with an error message if we can't copy an entire FILE* to stdout,
312 * then close that file. */
313 void FAST_FUNC xprint_and_close_file(FILE *file)
316 // copyfd outputs error messages for us.
317 if (bb_copyfd_eof(fileno(file), STDOUT_FILENO) == -1)
323 // Die with an error message if we can't malloc() enough space and do an
324 // sprintf() into that space.
325 char* FAST_FUNC xasprintf(const char *format, ...)
332 r = vasprintf(&string_ptr, format, p);
336 bb_die_memory_exhausted();
340 void FAST_FUNC xsetenv(const char *key, const char *value)
342 if (setenv(key, value, 1))
343 bb_die_memory_exhausted();
346 /* Handles "VAR=VAL" strings, even those which are part of environ
349 void FAST_FUNC bb_unsetenv(const char *var)
351 char onstack[128 - 16]; /* smaller stack setup code on x86 */
354 tp = strchr(var, '=');
356 /* In case var was putenv'ed, we can't replace '='
357 * with NUL and unsetenv(var) - it won't work,
358 * env is modified by the replacement, unsetenv
359 * sees "VAR" instead of "VAR=VAL" and does not remove it!
362 unsigned sz = tp - var;
363 if (sz < sizeof(onstack)) {
364 ((char*)mempcpy(onstack, var, sz))[0] = '\0';
368 /* unlikely: very long var name */
369 var = tp = xstrndup(var, sz);
376 void FAST_FUNC bb_unsetenv_and_free(char *var)
382 // Die with an error message if we can't set gid. (Because resource limits may
383 // limit this user to a given number of processes, and if that fills up the
384 // setgid() will fail and we'll _still_be_root_, which is bad.)
385 void FAST_FUNC xsetgid(gid_t gid)
387 if (setgid(gid)) bb_perror_msg_and_die("setgid");
390 // Die with an error message if we can't set uid. (See xsetgid() for why.)
391 void FAST_FUNC xsetuid(uid_t uid)
393 if (setuid(uid)) bb_perror_msg_and_die("setuid");
396 void FAST_FUNC xsetegid(gid_t egid)
398 if (setegid(egid)) bb_perror_msg_and_die("setegid");
401 void FAST_FUNC xseteuid(uid_t euid)
403 if (seteuid(euid)) bb_perror_msg_and_die("seteuid");
406 // Die if we can't chdir to a new path.
407 void FAST_FUNC xchdir(const char *path)
410 bb_perror_msg_and_die("can't change directory to '%s'", path);
413 void FAST_FUNC xfchdir(int fd)
416 bb_perror_msg_and_die("fchdir");
419 void FAST_FUNC xchroot(const char *path)
422 bb_perror_msg_and_die("can't change root directory to '%s'", path);
426 // Print a warning message if opendir() fails, but don't die.
427 DIR* FAST_FUNC warn_opendir(const char *path)
433 bb_perror_msg("can't open '%s'", path);
437 // Die with an error message if opendir() fails.
438 DIR* FAST_FUNC xopendir(const char *path)
444 bb_perror_msg_and_die("can't open '%s'", path);
448 // Die with an error message if we can't open a new socket.
449 int FAST_FUNC xsocket(int domain, int type, int protocol)
451 int r = socket(domain, type, protocol);
454 /* Hijack vaguely related config option */
455 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
456 const char *s = "INET";
458 if (domain == AF_PACKET) s = "PACKET";
461 if (domain == AF_NETLINK) s = "NETLINK";
463 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
464 bb_perror_msg_and_die("socket(AF_%s,%d,%d)", s, type, protocol);
466 bb_perror_msg_and_die("socket");
473 // Die with an error message if we can't bind a socket to an address.
474 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
476 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
479 // Die with an error message if we can't listen for connections on a socket.
480 void FAST_FUNC xlisten(int s, int backlog)
482 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
485 /* Die with an error message if sendto failed.
486 * Return bytes sent otherwise */
487 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
490 ssize_t ret = sendto(s, buf, len, 0, to, tolen);
492 if (ENABLE_FEATURE_CLEAN_UP)
494 bb_perror_msg_and_die("sendto");
499 // xstat() - a stat() which dies on failure with meaningful error message
500 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
502 if (stat(name, stat_buf))
503 bb_perror_msg_and_die("can't stat '%s'", name);
506 void FAST_FUNC xfstat(int fd, struct stat *stat_buf, const char *errmsg)
508 /* errmsg is usually a file name, but not always:
509 * xfstat may be called in a spot where file name is no longer
510 * available, and caller may give e.g. "can't stat input file" string.
512 if (fstat(fd, stat_buf))
513 bb_simple_perror_msg_and_die(errmsg);
516 // selinux_or_die() - die if SELinux is disabled.
517 void FAST_FUNC selinux_or_die(void)
520 int rc = is_selinux_enabled();
522 bb_error_msg_and_die("SELinux is disabled");
524 bb_error_msg_and_die("is_selinux_enabled() failed");
527 bb_error_msg_and_die("SELinux support is disabled");
531 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
536 ret = ioctl(fd, request, argp);
539 bb_verror_msg(fmt, p, strerror(errno));
540 /* xfunc_die can actually longjmp, so be nice */
547 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
550 int ret = ioctl(fd, request, argp);
554 bb_verror_msg(fmt, p, strerror(errno));
560 #if ENABLE_IOCTL_HEX2STR_ERROR
561 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
565 ret = ioctl(fd, request, argp);
567 bb_simple_perror_msg(ioctl_name);
570 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
574 ret = ioctl(fd, request, argp);
576 bb_simple_perror_msg_and_die(ioctl_name);
580 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
584 ret = ioctl(fd, request, argp);
586 bb_perror_msg("ioctl %#x failed", request);
589 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
593 ret = ioctl(fd, request, argp);
595 bb_perror_msg_and_die("ioctl %#x failed", request);
600 char* FAST_FUNC xmalloc_ttyname(int fd)
603 int r = ttyname_r(fd, buf, sizeof(buf) - 1);
609 void FAST_FUNC generate_uuid(uint8_t *buf)
611 /* http://www.ietf.org/rfc/rfc4122.txt
612 * 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
613 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
615 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
616 * | time_mid | time_hi_and_version |
617 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
618 * |clk_seq_and_variant | node (0-1) |
619 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
621 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
622 * IOW, uuid has this layout:
623 * uint32_t time_low (big endian)
624 * uint16_t time_mid (big endian)
625 * uint16_t time_hi_and_version (big endian)
626 * version is a 4-bit field:
628 * 2 DCE Security, with embedded POSIX UIDs
630 * 4 Randomly generated
631 * 5 Name-based (SHA-1)
632 * uint16_t clk_seq_and_variant (big endian)
633 * variant is a 3-bit field:
634 * 0xx Reserved, NCS backward compatibility
635 * 10x The variant specified in rfc4122
636 * 110 Reserved, Microsoft backward compatibility
637 * 111 Reserved for future definition
640 * For version 4, these bits are set/cleared:
641 * time_hi_and_version & 0x0fff | 0x4000
642 * clk_seq_and_variant & 0x3fff | 0x8000
647 i = open("/dev/urandom", O_RDONLY);
652 /* Paranoia. /dev/urandom may be missing.
653 * rand() is guaranteed to generate at least [0, 2^15) range,
654 * but lowest bits in some libc are not so "random". */
655 srand(monotonic_us()); /* pulls in printf */
658 for (i = 0; i < 16; i++)
659 buf[i] ^= rand() >> 5;
667 buf[4 + 2 ] = (buf[4 + 2 ] & 0x0f) | 0x40;
669 buf[4 + 2 + 2] = (buf[4 + 2 + 2] & 0x3f) | 0x80;
673 pid_t FAST_FUNC xfork(void)
677 if (pid < 0) /* wtf? */
678 bb_perror_msg_and_die("vfork"+1);
683 void FAST_FUNC xvfork_parent_waits_and_exits(void)
691 int exit_status = wait_for_exitstatus(pid);
692 if (WIFSIGNALED(exit_status))
693 kill_myself_with_sig(WTERMSIG(exit_status));
694 _exit(WEXITSTATUS(exit_status));
696 /* Child continues */