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 GPL version 2, see file LICENSE in this tarball for details.
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 an existing 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 void FAST_FUNC xunlink(const char *pathname)
163 if (unlink(pathname))
164 bb_perror_msg_and_die("can't remove file '%s'", pathname);
167 void FAST_FUNC xrename(const char *oldpath, const char *newpath)
169 if (rename(oldpath, newpath))
170 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath, newpath);
173 int FAST_FUNC rename_or_warn(const char *oldpath, const char *newpath)
175 int n = rename(oldpath, newpath);
177 bb_perror_msg("can't move '%s' to '%s'", oldpath, newpath);
181 void FAST_FUNC xpipe(int filedes[2])
184 bb_perror_msg_and_die("can't create pipe");
187 void FAST_FUNC xdup2(int from, int to)
189 if (dup2(from, to) != to)
190 bb_perror_msg_and_die("can't duplicate file descriptor");
193 // "Renumber" opened fd
194 void FAST_FUNC xmove_fd(int from, int to)
202 // Die with an error message if we can't write the entire buffer.
203 void FAST_FUNC xwrite(int fd, const void *buf, size_t count)
206 ssize_t size = full_write(fd, buf, count);
207 if ((size_t)size != count)
208 bb_error_msg_and_die("short write");
212 // Die with an error message if we can't lseek to the right spot.
213 off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
215 off_t off = lseek(fd, offset, whence);
216 if (off == (off_t)-1) {
217 if (whence == SEEK_SET)
218 bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
219 bb_perror_msg_and_die("lseek");
224 // Die with supplied filename if this FILE* has ferror set.
225 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
228 /* ferror doesn't set useful errno */
229 bb_error_msg_and_die("%s: I/O error", fn);
233 // Die with an error message if stdout has ferror set.
234 void FAST_FUNC die_if_ferror_stdout(void)
236 die_if_ferror(stdout, bb_msg_standard_output);
239 // Die with an error message if we have trouble flushing stdout.
240 void FAST_FUNC xfflush_stdout(void)
242 if (fflush(stdout)) {
243 bb_perror_msg_and_die(bb_msg_standard_output);
248 int FAST_FUNC bb_putchar(int ch)
250 /* time.c needs putc(ch, stdout), not putchar(ch).
251 * it does "stdout = stderr;", but then glibc's putchar()
252 * doesn't work as expected. bad glibc, bad */
253 return putc(ch, stdout);
256 /* Die with an error message if we can't copy an entire FILE* to stdout,
257 * then close that file. */
258 void FAST_FUNC xprint_and_close_file(FILE *file)
261 // copyfd outputs error messages for us.
262 if (bb_copyfd_eof(fileno(file), 1) == -1)
268 // Die with an error message if we can't malloc() enough space and do an
269 // sprintf() into that space.
270 char* FAST_FUNC xasprintf(const char *format, ...)
279 r = vasprintf(&string_ptr, format, p);
282 // Bloat for systems that haven't got the GNU extension.
284 r = vsnprintf(NULL, 0, format, p);
286 string_ptr = xmalloc(r+1);
288 r = vsnprintf(string_ptr, r+1, format, p);
293 bb_error_msg_and_die(bb_msg_memory_exhausted);
297 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
298 int FAST_FUNC fdprintf(int fd, const char *format, ...)
307 r = vasprintf(&string_ptr, format, p);
310 // Bloat for systems that haven't got the GNU extension.
312 r = vsnprintf(NULL, 0, format, p) + 1;
314 string_ptr = malloc(r);
317 r = vsnprintf(string_ptr, r, format, p);
323 full_write(fd, string_ptr, r);
330 void FAST_FUNC xsetenv(const char *key, const char *value)
332 if (setenv(key, value, 1))
333 bb_error_msg_and_die(bb_msg_memory_exhausted);
336 /* Handles "VAR=VAL" strings, even those which are part of environ
339 void FAST_FUNC bb_unsetenv(const char *var)
341 char *tp = strchr(var, '=');
348 /* In case var was putenv'ed, we can't replace '='
349 * with NUL and unsetenv(var) - it won't work,
350 * env is modified by the replacement, unsetenv
351 * sees "VAR" instead of "VAR=VAL" and does not remove it!
353 tp = xstrndup(var, tp - var);
359 // Die with an error message if we can't set gid. (Because resource limits may
360 // limit this user to a given number of processes, and if that fills up the
361 // setgid() will fail and we'll _still_be_root_, which is bad.)
362 void FAST_FUNC xsetgid(gid_t gid)
364 if (setgid(gid)) bb_perror_msg_and_die("setgid");
367 // Die with an error message if we can't set uid. (See xsetgid() for why.)
368 void FAST_FUNC xsetuid(uid_t uid)
370 if (setuid(uid)) bb_perror_msg_and_die("setuid");
373 // Die if we can't chdir to a new path.
374 void FAST_FUNC xchdir(const char *path)
377 bb_perror_msg_and_die("chdir(%s)", path);
380 void FAST_FUNC xchroot(const char *path)
383 bb_perror_msg_and_die("can't change root directory to %s", path);
386 // Print a warning message if opendir() fails, but don't die.
387 DIR* FAST_FUNC warn_opendir(const char *path)
393 bb_perror_msg("can't open '%s'", path);
397 // Die with an error message if opendir() fails.
398 DIR* FAST_FUNC xopendir(const char *path)
404 bb_perror_msg_and_die("can't open '%s'", path);
408 // Die with an error message if we can't open a new socket.
409 int FAST_FUNC xsocket(int domain, int type, int protocol)
411 int r = socket(domain, type, protocol);
414 /* Hijack vaguely related config option */
415 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
416 const char *s = "INET";
417 if (domain == AF_PACKET) s = "PACKET";
418 if (domain == AF_NETLINK) s = "NETLINK";
419 USE_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
420 bb_perror_msg_and_die("socket(AF_%s)", s);
422 bb_perror_msg_and_die("socket");
429 // Die with an error message if we can't bind a socket to an address.
430 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
432 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
435 // Die with an error message if we can't listen for connections on a socket.
436 void FAST_FUNC xlisten(int s, int backlog)
438 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
441 /* Die with an error message if sendto failed.
442 * Return bytes sent otherwise */
443 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
446 ssize_t ret = sendto(s, buf, len, 0, to, tolen);
448 if (ENABLE_FEATURE_CLEAN_UP)
450 bb_perror_msg_and_die("sendto");
455 // xstat() - a stat() which dies on failure with meaningful error message
456 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
458 if (stat(name, stat_buf))
459 bb_perror_msg_and_die("can't stat '%s'", name);
462 // selinux_or_die() - die if SELinux is disabled.
463 void FAST_FUNC selinux_or_die(void)
466 int rc = is_selinux_enabled();
468 bb_error_msg_and_die("SELinux is disabled");
470 bb_error_msg_and_die("is_selinux_enabled() failed");
473 bb_error_msg_and_die("SELinux support is disabled");
477 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
482 ret = ioctl(fd, request, argp);
485 bb_verror_msg(fmt, p, strerror(errno));
486 /* xfunc_die can actually longjmp, so be nice */
493 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
496 int ret = ioctl(fd, request, argp);
500 bb_verror_msg(fmt, p, strerror(errno));
506 #if ENABLE_IOCTL_HEX2STR_ERROR
507 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
511 ret = ioctl(fd, request, argp);
513 bb_simple_perror_msg(ioctl_name);
516 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
520 ret = ioctl(fd, request, argp);
522 bb_simple_perror_msg_and_die(ioctl_name);
526 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
530 ret = ioctl(fd, request, argp);
532 bb_perror_msg("ioctl %#x failed", request);
535 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
539 ret = ioctl(fd, request, argp);
541 bb_perror_msg_and_die("ioctl %#x failed", request);