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 /* Die if we can't open an existing file readonly with O_NONBLOCK
145 * Note that for ioctl O_RDONLY is sufficient.
147 int FAST_FUNC
xopen_nonblocking(const char *pathname
)
149 return xopen(pathname
, O_RDONLY
| O_NONBLOCK
);
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
)
157 ret
= open(pathname
, flags
, mode
);
159 bb_perror_msg("can't open '%s'", pathname
);
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
)
167 return open3_or_warn(pathname
, flags
, 0666);
170 void FAST_FUNC
xunlink(const char *pathname
)
172 if (unlink(pathname
))
173 bb_perror_msg_and_die("can't remove file '%s'", pathname
);
176 void FAST_FUNC
xrename(const char *oldpath
, const char *newpath
)
178 if (rename(oldpath
, newpath
))
179 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath
, newpath
);
182 int FAST_FUNC
rename_or_warn(const char *oldpath
, const char *newpath
)
184 int n
= rename(oldpath
, newpath
);
186 bb_perror_msg("can't move '%s' to '%s'", oldpath
, newpath
);
190 void FAST_FUNC
xpipe(int filedes
[2])
193 bb_perror_msg_and_die("can't create pipe");
196 void FAST_FUNC
xdup2(int from
, int to
)
198 if (dup2(from
, to
) != to
)
199 bb_perror_msg_and_die("can't duplicate file descriptor");
202 // "Renumber" opened fd
203 void FAST_FUNC
xmove_fd(int from
, int to
)
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
)
215 ssize_t size
= full_write(fd
, buf
, count
);
216 if ((size_t)size
!= count
)
217 bb_error_msg_and_die("short write");
220 void FAST_FUNC
xwrite_str(int fd
, const char *str
)
222 xwrite(fd
, str
, strlen(str
));
225 void FAST_FUNC
xclose(int fd
)
228 bb_perror_msg_and_die("close failed");
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
)
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");
243 int FAST_FUNC
xmkstemp(char *template)
245 int fd
= mkstemp(template);
247 bb_perror_msg_and_die("can't create temp file '%s'", template);
251 // Die with supplied filename if this FILE* has ferror set.
252 void FAST_FUNC
die_if_ferror(FILE *fp
, const char *fn
)
255 /* ferror doesn't set useful errno */
256 bb_error_msg_and_die("%s: I/O error", fn
);
260 // Die with an error message if stdout has ferror set.
261 void FAST_FUNC
die_if_ferror_stdout(void)
263 die_if_ferror(stdout
, bb_msg_standard_output
);
266 int FAST_FUNC
fflush_all(void)
272 int FAST_FUNC
bb_putchar(int ch
)
277 /* Die with an error message if we can't copy an entire FILE* to stdout,
278 * then close that file. */
279 void FAST_FUNC
xprint_and_close_file(FILE *file
)
282 // copyfd outputs error messages for us.
283 if (bb_copyfd_eof(fileno(file
), STDOUT_FILENO
) == -1)
289 // Die with an error message if we can't malloc() enough space and do an
290 // sprintf() into that space.
291 char* FAST_FUNC
xasprintf(const char *format
, ...)
298 r
= vasprintf(&string_ptr
, format
, p
);
302 bb_error_msg_and_die(bb_msg_memory_exhausted
);
306 void FAST_FUNC
xsetenv(const char *key
, const char *value
)
308 if (setenv(key
, value
, 1))
309 bb_error_msg_and_die(bb_msg_memory_exhausted
);
312 /* Handles "VAR=VAL" strings, even those which are part of environ
315 void FAST_FUNC
bb_unsetenv(const char *var
)
317 char *tp
= strchr(var
, '=');
324 /* In case var was putenv'ed, we can't replace '='
325 * with NUL and unsetenv(var) - it won't work,
326 * env is modified by the replacement, unsetenv
327 * sees "VAR" instead of "VAR=VAL" and does not remove it!
329 tp
= xstrndup(var
, tp
- var
);
334 void FAST_FUNC
bb_unsetenv_and_free(char *var
)
340 // Die with an error message if we can't set gid. (Because resource limits may
341 // limit this user to a given number of processes, and if that fills up the
342 // setgid() will fail and we'll _still_be_root_, which is bad.)
343 void FAST_FUNC
xsetgid(gid_t gid
)
345 if (setgid(gid
)) bb_perror_msg_and_die("setgid");
348 // Die with an error message if we can't set uid. (See xsetgid() for why.)
349 void FAST_FUNC
xsetuid(uid_t uid
)
351 if (setuid(uid
)) bb_perror_msg_and_die("setuid");
354 // Die if we can't chdir to a new path.
355 void FAST_FUNC
xchdir(const char *path
)
358 bb_perror_msg_and_die("chdir(%s)", path
);
361 void FAST_FUNC
xchroot(const char *path
)
364 bb_perror_msg_and_die("can't change root directory to %s", path
);
368 // Print a warning message if opendir() fails, but don't die.
369 DIR* FAST_FUNC
warn_opendir(const char *path
)
375 bb_perror_msg("can't open '%s'", path
);
379 // Die with an error message if opendir() fails.
380 DIR* FAST_FUNC
xopendir(const char *path
)
386 bb_perror_msg_and_die("can't open '%s'", path
);
390 // Die with an error message if we can't open a new socket.
391 int FAST_FUNC
xsocket(int domain
, int type
, int protocol
)
393 int r
= socket(domain
, type
, protocol
);
396 /* Hijack vaguely related config option */
397 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
398 const char *s
= "INET";
400 if (domain
== AF_PACKET
) s
= "PACKET";
403 if (domain
== AF_NETLINK
) s
= "NETLINK";
405 IF_FEATURE_IPV6(if (domain
== AF_INET6
) s
= "INET6";)
406 bb_perror_msg_and_die("socket(AF_%s,%d,%d)", s
, type
, protocol
);
408 bb_perror_msg_and_die("socket");
415 // Die with an error message if we can't bind a socket to an address.
416 void FAST_FUNC
xbind(int sockfd
, struct sockaddr
*my_addr
, socklen_t addrlen
)
418 if (bind(sockfd
, my_addr
, addrlen
)) bb_perror_msg_and_die("bind");
421 // Die with an error message if we can't listen for connections on a socket.
422 void FAST_FUNC
xlisten(int s
, int backlog
)
424 if (listen(s
, backlog
)) bb_perror_msg_and_die("listen");
427 /* Die with an error message if sendto failed.
428 * Return bytes sent otherwise */
429 ssize_t FAST_FUNC
xsendto(int s
, const void *buf
, size_t len
, const struct sockaddr
*to
,
432 ssize_t ret
= sendto(s
, buf
, len
, 0, to
, tolen
);
434 if (ENABLE_FEATURE_CLEAN_UP
)
436 bb_perror_msg_and_die("sendto");
441 // xstat() - a stat() which dies on failure with meaningful error message
442 void FAST_FUNC
xstat(const char *name
, struct stat
*stat_buf
)
444 if (stat(name
, stat_buf
))
445 bb_perror_msg_and_die("can't stat '%s'", name
);
448 void FAST_FUNC
xfstat(int fd
, struct stat
*stat_buf
, const char *errmsg
)
450 /* errmsg is usually a file name, but not always:
451 * xfstat may be called in a spot where file name is no longer
452 * available, and caller may give e.g. "can't stat input file" string.
454 if (fstat(fd
, stat_buf
))
455 bb_simple_perror_msg_and_die(errmsg
);
458 // selinux_or_die() - die if SELinux is disabled.
459 void FAST_FUNC
selinux_or_die(void)
462 int rc
= is_selinux_enabled();
464 bb_error_msg_and_die("SELinux is disabled");
466 bb_error_msg_and_die("is_selinux_enabled() failed");
469 bb_error_msg_and_die("SELinux support is disabled");
473 int FAST_FUNC
ioctl_or_perror_and_die(int fd
, unsigned request
, void *argp
, const char *fmt
,...)
478 ret
= ioctl(fd
, request
, argp
);
481 bb_verror_msg(fmt
, p
, strerror(errno
));
482 /* xfunc_die can actually longjmp, so be nice */
489 int FAST_FUNC
ioctl_or_perror(int fd
, unsigned request
, void *argp
, const char *fmt
,...)
492 int ret
= ioctl(fd
, request
, argp
);
496 bb_verror_msg(fmt
, p
, strerror(errno
));
502 #if ENABLE_IOCTL_HEX2STR_ERROR
503 int FAST_FUNC
bb_ioctl_or_warn(int fd
, unsigned request
, void *argp
, const char *ioctl_name
)
507 ret
= ioctl(fd
, request
, argp
);
509 bb_simple_perror_msg(ioctl_name
);
512 int FAST_FUNC
bb_xioctl(int fd
, unsigned request
, void *argp
, const char *ioctl_name
)
516 ret
= ioctl(fd
, request
, argp
);
518 bb_simple_perror_msg_and_die(ioctl_name
);
522 int FAST_FUNC
bb_ioctl_or_warn(int fd
, unsigned request
, void *argp
)
526 ret
= ioctl(fd
, request
, argp
);
528 bb_perror_msg("ioctl %#x failed", request
);
531 int FAST_FUNC
bb_xioctl(int fd
, unsigned request
, void *argp
)
535 ret
= ioctl(fd
, request
, argp
);
537 bb_perror_msg_and_die("ioctl %#x failed", request
);
542 char* FAST_FUNC
xmalloc_ttyname(int fd
)
544 char *buf
= xzalloc(128);
545 int r
= ttyname_r(fd
, buf
, 127);
553 void FAST_FUNC
generate_uuid(uint8_t *buf
)
555 /* http://www.ietf.org/rfc/rfc4122.txt
556 * 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
557 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
559 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
560 * | time_mid | time_hi_and_version |
561 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
562 * |clk_seq_and_variant | node (0-1) |
563 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
565 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
566 * IOW, uuid has this layout:
567 * uint32_t time_low (big endian)
568 * uint16_t time_mid (big endian)
569 * uint16_t time_hi_and_version (big endian)
570 * version is a 4-bit field:
572 * 2 DCE Security, with embedded POSIX UIDs
574 * 4 Randomly generated
575 * 5 Name-based (SHA-1)
576 * uint16_t clk_seq_and_variant (big endian)
577 * variant is a 3-bit field:
578 * 0xx Reserved, NCS backward compatibility
579 * 10x The variant specified in rfc4122
580 * 110 Reserved, Microsoft backward compatibility
581 * 111 Reserved for future definition
584 * For version 4, these bits are set/cleared:
585 * time_hi_and_version & 0x0fff | 0x4000
586 * clk_seq_and_variant & 0x3fff | 0x8000
591 i
= open("/dev/urandom", O_RDONLY
);
596 /* Paranoia. /dev/urandom may be missing.
597 * rand() is guaranteed to generate at least [0, 2^15) range,
598 * but lowest bits in some libc are not so "random". */
599 srand(monotonic_us()); /* pulls in printf */
602 for (i
= 0; i
< 16; i
++)
603 buf
[i
] ^= rand() >> 5;
611 buf
[4 + 2 ] = (buf
[4 + 2 ] & 0x0f) | 0x40;
613 buf
[4 + 2 + 2] = (buf
[4 + 2 + 2] & 0x3f) | 0x80;
617 pid_t FAST_FUNC
xfork(void)
621 if (pid
< 0) /* wtf? */
622 bb_perror_msg_and_die("vfork"+1);