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 // 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)
119 FILE *fp = fopen(path, mode);
121 bb_perror_msg_and_die("can't open '%s'", path);
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)
130 ret = open(pathname, flags, mode);
132 bb_perror_msg_and_die("can't open '%s'", pathname);
137 // Die if we can't open a file and return a fd.
138 int FAST_FUNC xopen(const char *pathname, int flags)
140 return xopen3(pathname, flags, 0666);
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)
148 ret = open(pathname, flags, mode);
150 bb_perror_msg("can't open '%s'", pathname);
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)
158 return open3_or_warn(pathname, flags, 0666);
161 /* Die if we can't open an existing file readonly with O_NONBLOCK
163 * Note that for ioctl O_RDONLY is sufficient.
165 int FAST_FUNC xopen_nonblocking(const char *pathname)
167 return xopen(pathname, O_RDONLY | O_NONBLOCK);
170 int FAST_FUNC xopen_as_uid_gid(const char *pathname, int flags, uid_t u, gid_t g)
173 uid_t old_euid = geteuid();
174 gid_t old_egid = getegid();
179 fd = xopen(pathname, flags);
187 void FAST_FUNC xunlink(const char *pathname)
189 if (unlink(pathname))
190 bb_perror_msg_and_die("can't remove file '%s'", pathname);
193 void FAST_FUNC xrename(const char *oldpath, const char *newpath)
195 if (rename(oldpath, newpath))
196 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath, newpath);
199 int FAST_FUNC rename_or_warn(const char *oldpath, const char *newpath)
201 int n = rename(oldpath, newpath);
203 bb_perror_msg("can't move '%s' to '%s'", oldpath, newpath);
207 void FAST_FUNC xpipe(int filedes[2])
210 bb_perror_msg_and_die("can't create pipe");
213 void FAST_FUNC xdup2(int from, int to)
215 if (dup2(from, to) != to)
216 bb_perror_msg_and_die("can't duplicate file descriptor");
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)
234 bb_error_msg_and_die("short write");
237 void FAST_FUNC xwrite_str(int fd, const char *str)
239 xwrite(fd, str, strlen(str));
242 void FAST_FUNC xclose(int fd)
245 bb_perror_msg_and_die("close failed");
248 // Die with an error message if we can't lseek to the right spot.
249 off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
251 off_t off = lseek(fd, offset, whence);
252 if (off == (off_t)-1) {
253 if (whence == SEEK_SET)
254 bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
255 bb_perror_msg_and_die("lseek");
260 int FAST_FUNC xmkstemp(char *template)
262 int fd = mkstemp(template);
264 bb_perror_msg_and_die("can't create temp file '%s'", template);
268 // Die with supplied filename if this FILE* has ferror set.
269 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
272 /* ferror doesn't set useful errno */
273 bb_error_msg_and_die("%s: I/O error", fn);
277 // Die with an error message if stdout has ferror set.
278 void FAST_FUNC die_if_ferror_stdout(void)
280 die_if_ferror(stdout, bb_msg_standard_output);
283 int FAST_FUNC fflush_all(void)
289 int FAST_FUNC bb_putchar(int ch)
294 /* Die with an error message if we can't copy an entire FILE* to stdout,
295 * then close that file. */
296 void FAST_FUNC xprint_and_close_file(FILE *file)
299 // copyfd outputs error messages for us.
300 if (bb_copyfd_eof(fileno(file), STDOUT_FILENO) == -1)
306 // Die with an error message if we can't malloc() enough space and do an
307 // sprintf() into that space.
308 char* FAST_FUNC xasprintf(const char *format, ...)
315 r = vasprintf(&string_ptr, format, p);
319 bb_error_msg_and_die(bb_msg_memory_exhausted);
323 void FAST_FUNC xsetenv(const char *key, const char *value)
325 if (setenv(key, value, 1))
326 bb_error_msg_and_die(bb_msg_memory_exhausted);
329 /* Handles "VAR=VAL" strings, even those which are part of environ
332 void FAST_FUNC bb_unsetenv(const char *var)
334 char *tp = strchr(var, '=');
341 /* In case var was putenv'ed, we can't replace '='
342 * with NUL and unsetenv(var) - it won't work,
343 * env is modified by the replacement, unsetenv
344 * sees "VAR" instead of "VAR=VAL" and does not remove it!
346 tp = xstrndup(var, tp - var);
351 void FAST_FUNC bb_unsetenv_and_free(char *var)
357 // Die with an error message if we can't set gid. (Because resource limits may
358 // limit this user to a given number of processes, and if that fills up the
359 // setgid() will fail and we'll _still_be_root_, which is bad.)
360 void FAST_FUNC xsetgid(gid_t gid)
362 if (setgid(gid)) bb_perror_msg_and_die("setgid");
365 // Die with an error message if we can't set uid. (See xsetgid() for why.)
366 void FAST_FUNC xsetuid(uid_t uid)
368 if (setuid(uid)) bb_perror_msg_and_die("setuid");
371 void FAST_FUNC xsetegid(gid_t egid)
373 if (setegid(egid)) bb_perror_msg_and_die("setegid");
376 void FAST_FUNC xseteuid(uid_t euid)
378 if (seteuid(euid)) bb_perror_msg_and_die("seteuid");
381 // Die if we can't chdir to a new path.
382 void FAST_FUNC xchdir(const char *path)
385 bb_perror_msg_and_die("can't change directory to '%s'", path);
388 void FAST_FUNC xchroot(const char *path)
391 bb_perror_msg_and_die("can't change root directory to '%s'", path);
395 // Print a warning message if opendir() fails, but don't die.
396 DIR* FAST_FUNC warn_opendir(const char *path)
402 bb_perror_msg("can't open '%s'", path);
406 // Die with an error message if opendir() fails.
407 DIR* FAST_FUNC xopendir(const char *path)
413 bb_perror_msg_and_die("can't open '%s'", path);
417 // Die with an error message if we can't open a new socket.
418 int FAST_FUNC xsocket(int domain, int type, int protocol)
420 int r = socket(domain, type, protocol);
423 /* Hijack vaguely related config option */
424 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
425 const char *s = "INET";
427 if (domain == AF_PACKET) s = "PACKET";
430 if (domain == AF_NETLINK) s = "NETLINK";
432 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
433 bb_perror_msg_and_die("socket(AF_%s,%d,%d)", s, type, protocol);
435 bb_perror_msg_and_die("socket");
442 // Die with an error message if we can't bind a socket to an address.
443 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
445 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
448 // Die with an error message if we can't listen for connections on a socket.
449 void FAST_FUNC xlisten(int s, int backlog)
451 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
454 /* Die with an error message if sendto failed.
455 * Return bytes sent otherwise */
456 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
459 ssize_t ret = sendto(s, buf, len, 0, to, tolen);
461 if (ENABLE_FEATURE_CLEAN_UP)
463 bb_perror_msg_and_die("sendto");
468 // xstat() - a stat() which dies on failure with meaningful error message
469 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
471 if (stat(name, stat_buf))
472 bb_perror_msg_and_die("can't stat '%s'", name);
475 void FAST_FUNC xfstat(int fd, struct stat *stat_buf, const char *errmsg)
477 /* errmsg is usually a file name, but not always:
478 * xfstat may be called in a spot where file name is no longer
479 * available, and caller may give e.g. "can't stat input file" string.
481 if (fstat(fd, stat_buf))
482 bb_simple_perror_msg_and_die(errmsg);
485 // selinux_or_die() - die if SELinux is disabled.
486 void FAST_FUNC selinux_or_die(void)
489 int rc = is_selinux_enabled();
491 bb_error_msg_and_die("SELinux is disabled");
493 bb_error_msg_and_die("is_selinux_enabled() failed");
496 bb_error_msg_and_die("SELinux support is disabled");
500 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
505 ret = ioctl(fd, request, argp);
508 bb_verror_msg(fmt, p, strerror(errno));
509 /* xfunc_die can actually longjmp, so be nice */
516 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
519 int ret = ioctl(fd, request, argp);
523 bb_verror_msg(fmt, p, strerror(errno));
529 #if ENABLE_IOCTL_HEX2STR_ERROR
530 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
534 ret = ioctl(fd, request, argp);
536 bb_simple_perror_msg(ioctl_name);
539 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
543 ret = ioctl(fd, request, argp);
545 bb_simple_perror_msg_and_die(ioctl_name);
549 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
553 ret = ioctl(fd, request, argp);
555 bb_perror_msg("ioctl %#x failed", request);
558 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
562 ret = ioctl(fd, request, argp);
564 bb_perror_msg_and_die("ioctl %#x failed", request);
569 char* FAST_FUNC xmalloc_ttyname(int fd)
572 int r = ttyname_r(fd, buf, sizeof(buf) - 1);
578 void FAST_FUNC generate_uuid(uint8_t *buf)
580 /* http://www.ietf.org/rfc/rfc4122.txt
581 * 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
582 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
584 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
585 * | time_mid | time_hi_and_version |
586 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
587 * |clk_seq_and_variant | node (0-1) |
588 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
590 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
591 * IOW, uuid has this layout:
592 * uint32_t time_low (big endian)
593 * uint16_t time_mid (big endian)
594 * uint16_t time_hi_and_version (big endian)
595 * version is a 4-bit field:
597 * 2 DCE Security, with embedded POSIX UIDs
599 * 4 Randomly generated
600 * 5 Name-based (SHA-1)
601 * uint16_t clk_seq_and_variant (big endian)
602 * variant is a 3-bit field:
603 * 0xx Reserved, NCS backward compatibility
604 * 10x The variant specified in rfc4122
605 * 110 Reserved, Microsoft backward compatibility
606 * 111 Reserved for future definition
609 * For version 4, these bits are set/cleared:
610 * time_hi_and_version & 0x0fff | 0x4000
611 * clk_seq_and_variant & 0x3fff | 0x8000
616 i = open("/dev/urandom", O_RDONLY);
621 /* Paranoia. /dev/urandom may be missing.
622 * rand() is guaranteed to generate at least [0, 2^15) range,
623 * but lowest bits in some libc are not so "random". */
624 srand(monotonic_us()); /* pulls in printf */
627 for (i = 0; i < 16; i++)
628 buf[i] ^= rand() >> 5;
636 buf[4 + 2 ] = (buf[4 + 2 ] & 0x0f) | 0x40;
638 buf[4 + 2 + 2] = (buf[4 + 2 + 2] & 0x3f) | 0x80;
642 pid_t FAST_FUNC xfork(void)
646 if (pid < 0) /* wtf? */
647 bb_perror_msg_and_die("vfork"+1);