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.
14 /* All the functions starting with "x" call bb_error_msg_and_die() if they
15 * fail, so callers never need to check for errors. If it returned, it
19 /* dmalloc provides variants of these that do abort() on failure.
20 * Since dmalloc's prototypes overwrite the impls here as they are
21 * included after these prototypes in libbb.h, all is well.
23 // Warn if we can't allocate size bytes of memory.
24 void *malloc_or_warn(size_t size)
26 void *ptr = malloc(size);
27 if (ptr == NULL && size != 0)
28 bb_error_msg(bb_msg_memory_exhausted);
32 // Die if we can't allocate size bytes of memory.
33 void *xmalloc(size_t size)
35 void *ptr = malloc(size);
36 if (ptr == NULL && size != 0)
37 bb_error_msg_and_die(bb_msg_memory_exhausted);
41 // Die if we can't resize previously allocated memory. (This returns a pointer
42 // to the new memory, which may or may not be the same as the old memory.
43 // It'll copy the contents to a new chunk and free the old one if necessary.)
44 void *xrealloc(void *ptr, size_t size)
46 ptr = realloc(ptr, size);
47 if (ptr == NULL && size != 0)
48 bb_error_msg_and_die(bb_msg_memory_exhausted);
53 // Die if we can't allocate and zero size bytes of memory.
54 void *xzalloc(size_t size)
56 void *ptr = xmalloc(size);
61 // Die if we can't copy a string to freshly allocated memory.
62 char * xstrdup(const char *s)
72 bb_error_msg_and_die(bb_msg_memory_exhausted);
77 // Die if we can't allocate n+1 bytes (space for the null terminator) and copy
78 // the (possibly truncated to length n) string into it.
79 char *xstrndup(const char *s, int n)
84 if (ENABLE_DEBUG && s == NULL)
85 bb_error_msg_and_die("xstrndup bug");
87 /* We can just xmalloc(n+1) and strncpy into it, */
88 /* but think about xstrndup("abc", 10000) wastage! */
100 return memcpy(t, s, n);
103 // Die if we can't open a file and return a FILE * to it.
104 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
105 FILE *xfopen(const char *path, const char *mode)
107 FILE *fp = fopen(path, mode);
109 bb_perror_msg_and_die("can't open '%s'", path);
113 // Die if we can't open a file and return a fd.
114 int xopen3(const char *pathname, int flags, int mode)
118 ret = open(pathname, flags, mode);
120 bb_perror_msg_and_die("can't open '%s'", pathname);
125 // Die if we can't open an existing file and return a fd.
126 int xopen(const char *pathname, int flags)
128 return xopen3(pathname, flags, 0666);
131 // Warn if we can't open a file and return a fd.
132 int open3_or_warn(const char *pathname, int flags, int mode)
136 ret = open(pathname, flags, mode);
138 bb_perror_msg("can't open '%s'", pathname);
143 // Warn if we can't open a file and return a fd.
144 int open_or_warn(const char *pathname, int flags)
146 return open3_or_warn(pathname, flags, 0666);
149 void xunlink(const char *pathname)
151 if (unlink(pathname))
152 bb_perror_msg_and_die("can't remove file '%s'", pathname);
155 void xrename(const char *oldpath, const char *newpath)
157 if (rename(oldpath, newpath))
158 bb_perror_msg_and_die("can't move '%s' to '%s'", oldpath, newpath);
161 int rename_or_warn(const char *oldpath, const char *newpath)
163 int n = rename(oldpath, newpath);
165 bb_perror_msg("can't move '%s' to '%s'", oldpath, newpath);
169 void xpipe(int filedes[2])
172 bb_perror_msg_and_die("can't create pipe");
175 // Turn on nonblocking I/O on a fd
176 int ndelay_on(int fd)
178 return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL) | O_NONBLOCK);
181 int close_on_exec_on(int fd)
183 return fcntl(fd, F_SETFD, FD_CLOEXEC);
186 int ndelay_off(int fd)
188 return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL) & ~O_NONBLOCK);
191 void xdup2(int from, int to)
193 if (dup2(from, to) != to)
194 bb_perror_msg_and_die("can't duplicate file descriptor");
197 // "Renumber" opened fd
198 void xmove_fd(int from, int to)
206 // Die with an error message if we can't write the entire buffer.
207 void xwrite(int fd, const void *buf, size_t count)
210 ssize_t size = full_write(fd, buf, count);
212 bb_error_msg_and_die("short write");
216 // Die with an error message if we can't lseek to the right spot.
217 off_t xlseek(int fd, off_t offset, int whence)
219 off_t off = lseek(fd, offset, whence);
220 if (off == (off_t)-1) {
221 if (whence == SEEK_SET)
222 bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
223 bb_perror_msg_and_die("lseek");
228 // Die with supplied filename if this FILE * has ferror set.
229 void die_if_ferror(FILE *fp, const char *fn)
232 /* ferror doesn't set useful errno */
233 bb_error_msg_and_die("%s: I/O error", fn);
237 // Die with an error message if stdout has ferror set.
238 void die_if_ferror_stdout(void)
240 die_if_ferror(stdout, bb_msg_standard_output);
243 // Die with an error message if we have trouble flushing stdout.
244 void xfflush_stdout(void)
246 if (fflush(stdout)) {
247 bb_perror_msg_and_die(bb_msg_standard_output);
251 void xsetenv(const char *key, const char *value)
253 if (setenv(key, value, 1))
254 bb_error_msg_and_die(bb_msg_memory_exhausted);
257 /* Converts unsigned long long value into compact 4-char
258 * representation. Examples: "1234", "1.2k", " 27M", "123T"
259 * String is not terminated (buf[4] is untouched) */
260 void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale)
264 unsigned v, u, idx = 0;
266 if (ul > 9999) { // do not scale if 9999 or less
271 } while (ul >= 10000);
273 v = ul; // ullong divisions are expensive, avoid them
279 // 9999 or less: use "1234" format
280 // u is value/10, v is last digit
281 c = buf[0] = " 123456789"[u/100];
282 if (c != ' ') fmt = "0123456789";
283 c = buf[1] = fmt[u/10%10];
284 if (c != ' ') fmt = "0123456789";
286 buf[3] = "0123456789"[v];
288 // u is value, v is 1/10ths (allows for 9.2M format)
290 // value is >= 10: use "123M', " 12M" formats
291 c = buf[0] = " 123456789"[u/100];
292 if (c != ' ') fmt = "0123456789";
297 // value is < 10: use "9.2M" format
298 buf[0] = "0123456789"[u];
301 buf[2] = "0123456789"[v];
302 buf[3] = scale[idx]; /* typically scale = " kmgt..." */
306 /* Converts unsigned long long value into compact 5-char representation.
307 * String is not terminated (buf[5] is untouched) */
308 void smart_ulltoa5(unsigned long long ul, char buf[6], const char *scale)
312 unsigned v, u, idx = 0;
314 if (ul > 99999) { // do not scale if 99999 or less
319 } while (ul >= 100000);
321 v = ul; // ullong divisions are expensive, avoid them
327 // 99999 or less: use "12345" format
328 // u is value/10, v is last digit
329 c = buf[0] = " 123456789"[u/1000];
330 if (c != ' ') fmt = "0123456789";
331 c = buf[1] = fmt[u/100%10];
332 if (c != ' ') fmt = "0123456789";
333 c = buf[2] = fmt[u/10%10];
334 if (c != ' ') fmt = "0123456789";
336 buf[4] = "0123456789"[v];
338 // value has been scaled into 0..9999.9 range
339 // u is value, v is 1/10ths (allows for 92.1M format)
341 // value is >= 100: use "1234M', " 123M" formats
342 c = buf[0] = " 123456789"[u/1000];
343 if (c != ' ') fmt = "0123456789";
344 c = buf[1] = fmt[u/100%10];
345 if (c != ' ') fmt = "0123456789";
350 // value is < 100: use "92.1M" format
351 c = buf[0] = " 123456789"[u/10];
352 if (c != ' ') fmt = "0123456789";
356 buf[3] = "0123456789"[v];
357 buf[4] = scale[idx]; /* typically scale = " kmgt..." */
362 // Convert unsigned integer to ascii, writing into supplied buffer.
363 // A truncated result contains the first few digits of the result ala strncpy.
364 // Returns a pointer past last generated digit, does _not_ store NUL.
365 void BUG_sizeof_unsigned_not_4(void);
366 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen)
368 unsigned i, out, res;
369 if (sizeof(unsigned) != 4)
370 BUG_sizeof_unsigned_not_4();
373 for (i = 1000000000; i; i /= 10) {
375 if (res || out || i == 1) {
376 if (!--buflen) break;
386 // Convert signed integer to ascii, like utoa_to_buf()
387 char *itoa_to_buf(int n, char *buf, unsigned buflen)
394 return utoa_to_buf((unsigned)n, buf, buflen);
397 // The following two functions use a static buffer, so calling either one a
398 // second time will overwrite previous results.
400 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
401 // Int should always be 32 bits on any remotely Unix-like system, see
402 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
404 static char local_buf[12];
406 // Convert unsigned integer to ascii using a static buffer (returned).
407 char *utoa(unsigned n)
409 *(utoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
414 // Convert signed integer to ascii using a static buffer (returned).
417 *(itoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
422 // Emit a string of hex representation of bytes
423 char *bin2hex(char *p, const char *cp, int count)
426 unsigned char c = *cp++;
427 /* put lowercase hex digits */
428 *p++ = 0x20 | bb_hexdigits_upcase[c >> 4];
429 *p++ = 0x20 | bb_hexdigits_upcase[c & 0xf];
435 // Die with an error message if we can't set gid. (Because resource limits may
436 // limit this user to a given number of processes, and if that fills up the
437 // setgid() will fail and we'll _still_be_root_, which is bad.)
438 void xsetgid(gid_t gid)
440 if (setgid(gid)) bb_perror_msg_and_die("setgid");
443 // Die with an error message if we can't set uid. (See xsetgid() for why.)
444 void xsetuid(uid_t uid)
446 if (setuid(uid)) bb_perror_msg_and_die("setuid");
449 // Return how long the file at fd is, if there's any way to determine it.
451 off_t fdlength(int fd)
453 off_t bottom = 0, top = 0, pos;
456 // If the ioctl works for this, return it.
458 if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
460 // FIXME: explain why lseek(SEEK_END) is not used here!
462 // If not, do a binary search for the last location we can read. (Some
463 // block devices don't do BLKGETSIZE right.)
468 pos = bottom + (top - bottom) / 2;
470 // If we can read from the current location, it's bigger.
472 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
473 if (bottom == top) bottom = top = (top+1) * 2;
476 // If we can't, it's smaller.
485 } while (bottom + 1 != top);
491 int bb_putchar(int ch)
493 /* time.c needs putc(ch, stdout), not putchar(ch).
494 * it does "stdout = stderr;", but then glibc's putchar()
495 * doesn't work as expected. bad glibc, bad */
496 return putc(ch, stdout);
499 // Die with an error message if we can't malloc() enough space and do an
500 // sprintf() into that space.
501 char *xasprintf(const char *format, ...)
510 r = vasprintf(&string_ptr, format, p);
513 // Bloat for systems that haven't got the GNU extension.
515 r = vsnprintf(NULL, 0, format, p);
517 string_ptr = xmalloc(r+1);
519 r = vsnprintf(string_ptr, r+1, format, p);
524 bb_error_msg_and_die(bb_msg_memory_exhausted);
528 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
529 int fdprintf(int fd, const char *format, ...)
538 r = vasprintf(&string_ptr, format, p);
541 // Bloat for systems that haven't got the GNU extension.
543 r = vsnprintf(NULL, 0, format, p) + 1;
545 string_ptr = malloc(r);
548 r = vsnprintf(string_ptr, r, format, p);
554 full_write(fd, string_ptr, r);
561 // Die with an error message if we can't copy an entire FILE * to stdout, then
563 void xprint_and_close_file(FILE *file)
566 // copyfd outputs error messages for us.
567 if (bb_copyfd_eof(fileno(file), 1) == -1)
573 // Die if we can't chdir to a new path.
574 void xchdir(const char *path)
577 bb_perror_msg_and_die("chdir(%s)", path);
580 void xchroot(const char *path)
583 bb_perror_msg_and_die("can't change root directory to %s", path);
586 // Print a warning message if opendir() fails, but don't die.
587 DIR *warn_opendir(const char *path)
593 bb_perror_msg("can't open '%s'", path);
597 // Die with an error message if opendir() fails.
598 DIR *xopendir(const char *path)
604 bb_perror_msg_and_die("can't open '%s'", path);
608 // Die with an error message if we can't open a new socket.
609 int xsocket(int domain, int type, int protocol)
611 int r = socket(domain, type, protocol);
614 /* Hijack vaguely related config option */
615 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
616 const char *s = "INET";
617 if (domain == AF_PACKET) s = "PACKET";
618 if (domain == AF_NETLINK) s = "NETLINK";
619 USE_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
620 bb_perror_msg_and_die("socket(AF_%s)", s);
622 bb_perror_msg_and_die("socket");
629 // Die with an error message if we can't bind a socket to an address.
630 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
632 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
635 // Die with an error message if we can't listen for connections on a socket.
636 void xlisten(int s, int backlog)
638 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
641 /* Die with an error message if sendto failed.
642 * Return bytes sent otherwise */
643 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
646 ssize_t ret = sendto(s, buf, len, 0, to, tolen);
648 if (ENABLE_FEATURE_CLEAN_UP)
650 bb_perror_msg_and_die("sendto");
655 // xstat() - a stat() which dies on failure with meaningful error message
656 void xstat(const char *name, struct stat *stat_buf)
658 if (stat(name, stat_buf))
659 bb_perror_msg_and_die("can't stat '%s'", name);
662 // selinux_or_die() - die if SELinux is disabled.
663 void selinux_or_die(void)
666 int rc = is_selinux_enabled();
668 bb_error_msg_and_die("SELinux is disabled");
670 bb_error_msg_and_die("is_selinux_enabled() failed");
673 bb_error_msg_and_die("SELinux support is disabled");
677 /* It is perfectly ok to pass in a NULL for either width or for
678 * height, in which case that value will not be set. */
679 int get_terminal_width_height(int fd, int *width, int *height)
681 struct winsize win = { 0, 0, 0, 0 };
682 int ret = ioctl(fd, TIOCGWINSZ, &win);
686 char *s = getenv("LINES");
687 if (s) win.ws_row = atoi(s);
689 if (win.ws_row <= 1 || win.ws_row >= 30000)
691 *height = (int) win.ws_row;
696 char *s = getenv("COLUMNS");
697 if (s) win.ws_col = atoi(s);
699 if (win.ws_col <= 1 || win.ws_col >= 30000)
701 *width = (int) win.ws_col;
707 void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...)
711 if (ioctl(fd, request, argp) < 0) {
713 bb_verror_msg(fmt, p, strerror(errno));
714 /* xfunc_die can actually longjmp, so be nice */
720 int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...)
723 int ret = ioctl(fd, request, argp);
727 bb_verror_msg(fmt, p, strerror(errno));
733 #if ENABLE_IOCTL_HEX2STR_ERROR
734 int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name)
738 ret = ioctl(fd, request, argp);
740 bb_simple_perror_msg(ioctl_name);
743 void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name)
745 if (ioctl(fd, request, argp) < 0)
746 bb_simple_perror_msg_and_die(ioctl_name);
749 int bb_ioctl_or_warn(int fd, int request, void *argp)
753 ret = ioctl(fd, request, argp);
755 bb_perror_msg("ioctl %#x failed", request);
758 void bb_xioctl(int fd, int request, void *argp)
760 if (ioctl(fd, request, argp) < 0)
761 bb_perror_msg_and_die("ioctl %#x failed", request);