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 /* 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 // Die with supplied filename if this FILE* has ferror set.
244 void FAST_FUNC die_if_ferror(FILE *fp, const char *fn)
247 /* ferror doesn't set useful errno */
248 bb_error_msg_and_die("%s: I/O error", fn);
252 // Die with an error message if stdout has ferror set.
253 void FAST_FUNC die_if_ferror_stdout(void)
255 die_if_ferror(stdout, bb_msg_standard_output);
258 // Die with an error message if we have trouble flushing stdout.
259 void FAST_FUNC xfflush_stdout(void)
261 if (fflush(stdout)) {
262 bb_perror_msg_and_die(bb_msg_standard_output);
267 int FAST_FUNC bb_putchar(int ch)
269 /* time.c needs putc(ch, stdout), not putchar(ch).
270 * it does "stdout = stderr;", but then glibc's putchar()
271 * doesn't work as expected. bad glibc, bad */
272 return putc(ch, stdout);
275 /* Die with an error message if we can't copy an entire FILE* to stdout,
276 * then close that file. */
277 void FAST_FUNC xprint_and_close_file(FILE *file)
280 // copyfd outputs error messages for us.
281 if (bb_copyfd_eof(fileno(file), 1) == -1)
287 // Die with an error message if we can't malloc() enough space and do an
288 // sprintf() into that space.
289 char* FAST_FUNC xasprintf(const char *format, ...)
296 r = vasprintf(&string_ptr, format, p);
300 bb_error_msg_and_die(bb_msg_memory_exhausted);
304 void FAST_FUNC xsetenv(const char *key, const char *value)
306 if (setenv(key, value, 1))
307 bb_error_msg_and_die(bb_msg_memory_exhausted);
310 /* Handles "VAR=VAL" strings, even those which are part of environ
313 void FAST_FUNC bb_unsetenv(const char *var)
315 char *tp = strchr(var, '=');
322 /* In case var was putenv'ed, we can't replace '='
323 * with NUL and unsetenv(var) - it won't work,
324 * env is modified by the replacement, unsetenv
325 * sees "VAR" instead of "VAR=VAL" and does not remove it!
327 tp = xstrndup(var, tp - var);
333 // Die with an error message if we can't set gid. (Because resource limits may
334 // limit this user to a given number of processes, and if that fills up the
335 // setgid() will fail and we'll _still_be_root_, which is bad.)
336 void FAST_FUNC xsetgid(gid_t gid)
338 if (setgid(gid)) bb_perror_msg_and_die("setgid");
341 // Die with an error message if we can't set uid. (See xsetgid() for why.)
342 void FAST_FUNC xsetuid(uid_t uid)
344 if (setuid(uid)) bb_perror_msg_and_die("setuid");
347 // Die if we can't chdir to a new path.
348 void FAST_FUNC xchdir(const char *path)
351 bb_perror_msg_and_die("chdir(%s)", path);
354 void FAST_FUNC xchroot(const char *path)
357 bb_perror_msg_and_die("can't change root directory to %s", path);
360 // Print a warning message if opendir() fails, but don't die.
361 DIR* FAST_FUNC warn_opendir(const char *path)
367 bb_perror_msg("can't open '%s'", path);
371 // Die with an error message if opendir() fails.
372 DIR* FAST_FUNC xopendir(const char *path)
378 bb_perror_msg_and_die("can't open '%s'", path);
382 // Die with an error message if we can't open a new socket.
383 int FAST_FUNC xsocket(int domain, int type, int protocol)
385 int r = socket(domain, type, protocol);
388 /* Hijack vaguely related config option */
389 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
390 const char *s = "INET";
391 if (domain == AF_PACKET) s = "PACKET";
392 if (domain == AF_NETLINK) s = "NETLINK";
393 IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
394 bb_perror_msg_and_die("socket(AF_%s)", s);
396 bb_perror_msg_and_die("socket");
403 // Die with an error message if we can't bind a socket to an address.
404 void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
406 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
409 // Die with an error message if we can't listen for connections on a socket.
410 void FAST_FUNC xlisten(int s, int backlog)
412 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
415 /* Die with an error message if sendto failed.
416 * Return bytes sent otherwise */
417 ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
420 ssize_t ret = sendto(s, buf, len, 0, to, tolen);
422 if (ENABLE_FEATURE_CLEAN_UP)
424 bb_perror_msg_and_die("sendto");
429 // xstat() - a stat() which dies on failure with meaningful error message
430 void FAST_FUNC xstat(const char *name, struct stat *stat_buf)
432 if (stat(name, stat_buf))
433 bb_perror_msg_and_die("can't stat '%s'", name);
436 // selinux_or_die() - die if SELinux is disabled.
437 void FAST_FUNC selinux_or_die(void)
440 int rc = is_selinux_enabled();
442 bb_error_msg_and_die("SELinux is disabled");
444 bb_error_msg_and_die("is_selinux_enabled() failed");
447 bb_error_msg_and_die("SELinux support is disabled");
451 int FAST_FUNC ioctl_or_perror_and_die(int fd, unsigned request, void *argp, const char *fmt,...)
456 ret = ioctl(fd, request, argp);
459 bb_verror_msg(fmt, p, strerror(errno));
460 /* xfunc_die can actually longjmp, so be nice */
467 int FAST_FUNC ioctl_or_perror(int fd, unsigned request, void *argp, const char *fmt,...)
470 int ret = ioctl(fd, request, argp);
474 bb_verror_msg(fmt, p, strerror(errno));
480 #if ENABLE_IOCTL_HEX2STR_ERROR
481 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp, const char *ioctl_name)
485 ret = ioctl(fd, request, argp);
487 bb_simple_perror_msg(ioctl_name);
490 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp, const char *ioctl_name)
494 ret = ioctl(fd, request, argp);
496 bb_simple_perror_msg_and_die(ioctl_name);
500 int FAST_FUNC bb_ioctl_or_warn(int fd, unsigned request, void *argp)
504 ret = ioctl(fd, request, argp);
506 bb_perror_msg("ioctl %#x failed", request);
509 int FAST_FUNC bb_xioctl(int fd, unsigned request, void *argp)
513 ret = ioctl(fd, request, argp);
515 bb_perror_msg_and_die("ioctl %#x failed", request);