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 Denis 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 xpipe(int filedes[2])
152 bb_perror_msg_and_die("can't create pipe");
155 void xunlink(const char *pathname)
157 if (unlink(pathname))
158 bb_perror_msg_and_die("can't remove file '%s'", pathname);
161 // Turn on nonblocking I/O on a fd
162 int ndelay_on(int fd)
164 return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL) | O_NONBLOCK);
167 int close_on_exec_on(int fd)
169 return fcntl(fd, F_SETFD, FD_CLOEXEC);
172 int ndelay_off(int fd)
174 return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL) & ~O_NONBLOCK);
177 void xdup2(int from, int to)
179 if (dup2(from, to) != to)
180 bb_perror_msg_and_die("can't duplicate file descriptor");
183 // "Renumber" opened fd
184 void xmove_fd(int from, int to)
192 // Die with an error message if we can't write the entire buffer.
193 void xwrite(int fd, const void *buf, size_t count)
196 ssize_t size = full_write(fd, buf, count);
198 bb_error_msg_and_die("short write");
202 // Die with an error message if we can't lseek to the right spot.
203 off_t xlseek(int fd, off_t offset, int whence)
205 off_t off = lseek(fd, offset, whence);
206 if (off == (off_t)-1) {
207 if (whence == SEEK_SET)
208 bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
209 bb_perror_msg_and_die("lseek");
214 // Die with supplied filename if this FILE * has ferror set.
215 void die_if_ferror(FILE *fp, const char *fn)
218 /* ferror doesn't set useful errno */
219 bb_error_msg_and_die("%s: I/O error", fn);
223 // Die with an error message if stdout has ferror set.
224 void die_if_ferror_stdout(void)
226 die_if_ferror(stdout, bb_msg_standard_output);
229 // Die with an error message if we have trouble flushing stdout.
230 void xfflush_stdout(void)
232 if (fflush(stdout)) {
233 bb_perror_msg_and_die(bb_msg_standard_output);
237 void xsetenv(const char *key, const char *value)
239 if (setenv(key, value, 1))
240 bb_error_msg_and_die(bb_msg_memory_exhausted);
243 /* Converts unsigned long long value into compact 4-char
244 * representation. Examples: "1234", "1.2k", " 27M", "123T"
245 * String is not terminated (buf[4] is untouched) */
246 void smart_ulltoa4(unsigned long long ul, char buf[5], const char *scale)
250 unsigned v, u, idx = 0;
252 if (ul > 9999) { // do not scale if 9999 or less
257 } while (ul >= 10000);
259 v = ul; // ullong divisions are expensive, avoid them
265 // 9999 or less: use "1234" format
266 // u is value/10, v is last digit
267 c = buf[0] = " 123456789"[u/100];
268 if (c != ' ') fmt = "0123456789";
269 c = buf[1] = fmt[u/10%10];
270 if (c != ' ') fmt = "0123456789";
272 buf[3] = "0123456789"[v];
274 // u is value, v is 1/10ths (allows for 9.2M format)
276 // value is >= 10: use "123M', " 12M" formats
277 c = buf[0] = " 123456789"[u/100];
278 if (c != ' ') fmt = "0123456789";
283 // value is < 10: use "9.2M" format
284 buf[0] = "0123456789"[u];
287 buf[2] = "0123456789"[v];
288 buf[3] = scale[idx]; /* typically scale = " kmgt..." */
292 /* Converts unsigned long long value into compact 5-char representation.
293 * String is not terminated (buf[5] is untouched) */
294 void smart_ulltoa5(unsigned long long ul, char buf[6], const char *scale)
298 unsigned v, u, idx = 0;
300 if (ul > 99999) { // do not scale if 99999 or less
305 } while (ul >= 100000);
307 v = ul; // ullong divisions are expensive, avoid them
313 // 99999 or less: use "12345" format
314 // u is value/10, v is last digit
315 c = buf[0] = " 123456789"[u/1000];
316 if (c != ' ') fmt = "0123456789";
317 c = buf[1] = fmt[u/100%10];
318 if (c != ' ') fmt = "0123456789";
319 c = buf[2] = fmt[u/10%10];
320 if (c != ' ') fmt = "0123456789";
322 buf[4] = "0123456789"[v];
324 // value has been scaled into 0..9999.9 range
325 // u is value, v is 1/10ths (allows for 92.1M format)
327 // value is >= 100: use "1234M', " 123M" formats
328 c = buf[0] = " 123456789"[u/1000];
329 if (c != ' ') fmt = "0123456789";
330 c = buf[1] = fmt[u/100%10];
331 if (c != ' ') fmt = "0123456789";
336 // value is < 100: use "92.1M" format
337 c = buf[0] = " 123456789"[u/10];
338 if (c != ' ') fmt = "0123456789";
342 buf[3] = "0123456789"[v];
343 buf[4] = scale[idx]; /* typically scale = " kmgt..." */
348 // Convert unsigned integer to ascii, writing into supplied buffer.
349 // A truncated result contains the first few digits of the result ala strncpy.
350 // Returns a pointer past last generated digit, does _not_ store NUL.
351 void BUG_sizeof_unsigned_not_4(void);
352 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen)
354 unsigned i, out, res;
355 if (sizeof(unsigned) != 4)
356 BUG_sizeof_unsigned_not_4();
359 for (i = 1000000000; i; i /= 10) {
361 if (res || out || i == 1) {
362 if (!--buflen) break;
372 // Convert signed integer to ascii, like utoa_to_buf()
373 char *itoa_to_buf(int n, char *buf, unsigned buflen)
380 return utoa_to_buf((unsigned)n, buf, buflen);
383 // The following two functions use a static buffer, so calling either one a
384 // second time will overwrite previous results.
386 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
387 // Int should always be 32 bits on any remotely Unix-like system, see
388 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
390 static char local_buf[12];
392 // Convert unsigned integer to ascii using a static buffer (returned).
393 char *utoa(unsigned n)
395 *(utoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
400 // Convert signed integer to ascii using a static buffer (returned).
403 *(itoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
408 // Emit a string of hex representation of bytes
409 char *bin2hex(char *p, const char *cp, int count)
412 unsigned char c = *cp++;
413 /* put lowercase hex digits */
414 *p++ = 0x20 | bb_hexdigits_upcase[c >> 4];
415 *p++ = 0x20 | bb_hexdigits_upcase[c & 0xf];
421 // Die with an error message if we can't set gid. (Because resource limits may
422 // limit this user to a given number of processes, and if that fills up the
423 // setgid() will fail and we'll _still_be_root_, which is bad.)
424 void xsetgid(gid_t gid)
426 if (setgid(gid)) bb_perror_msg_and_die("setgid");
429 // Die with an error message if we can't set uid. (See xsetgid() for why.)
430 void xsetuid(uid_t uid)
432 if (setuid(uid)) bb_perror_msg_and_die("setuid");
435 // Return how long the file at fd is, if there's any way to determine it.
437 off_t fdlength(int fd)
439 off_t bottom = 0, top = 0, pos;
442 // If the ioctl works for this, return it.
444 if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
446 // FIXME: explain why lseek(SEEK_END) is not used here!
448 // If not, do a binary search for the last location we can read. (Some
449 // block devices don't do BLKGETSIZE right.)
454 pos = bottom + (top - bottom) / 2;
456 // If we can read from the current location, it's bigger.
458 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
459 if (bottom == top) bottom = top = (top+1) * 2;
462 // If we can't, it's smaller.
471 } while (bottom + 1 != top);
477 int bb_putchar(int ch)
479 /* time.c needs putc(ch, stdout), not putchar(ch).
480 * it does "stdout = stderr;", but then glibc's putchar()
481 * doesn't work as expected. bad glibc, bad */
482 return putc(ch, stdout);
485 // Die with an error message if we can't malloc() enough space and do an
486 // sprintf() into that space.
487 char *xasprintf(const char *format, ...)
496 r = vasprintf(&string_ptr, format, p);
499 // Bloat for systems that haven't got the GNU extension.
501 r = vsnprintf(NULL, 0, format, p);
503 string_ptr = xmalloc(r+1);
505 r = vsnprintf(string_ptr, r+1, format, p);
510 bb_error_msg_and_die(bb_msg_memory_exhausted);
514 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
515 int fdprintf(int fd, const char *format, ...)
524 r = vasprintf(&string_ptr, format, p);
527 // Bloat for systems that haven't got the GNU extension.
529 r = vsnprintf(NULL, 0, format, p) + 1;
531 string_ptr = malloc(r);
534 r = vsnprintf(string_ptr, r, format, p);
540 full_write(fd, string_ptr, r);
547 // Die with an error message if we can't copy an entire FILE * to stdout, then
549 void xprint_and_close_file(FILE *file)
552 // copyfd outputs error messages for us.
553 if (bb_copyfd_eof(fileno(file), 1) == -1)
559 // Die if we can't chdir to a new path.
560 void xchdir(const char *path)
563 bb_perror_msg_and_die("chdir(%s)", path);
566 // Print a warning message if opendir() fails, but don't die.
567 DIR *warn_opendir(const char *path)
573 bb_perror_msg("can't open '%s'", path);
577 // Die with an error message if opendir() fails.
578 DIR *xopendir(const char *path)
584 bb_perror_msg_and_die("can't open '%s'", path);
588 // Die with an error message if we can't open a new socket.
589 int xsocket(int domain, int type, int protocol)
591 int r = socket(domain, type, protocol);
594 /* Hijack vaguely related config option */
595 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
596 const char *s = "INET";
597 if (domain == AF_PACKET) s = "PACKET";
598 if (domain == AF_NETLINK) s = "NETLINK";
599 USE_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
600 bb_perror_msg_and_die("socket(AF_%s)", s);
602 bb_perror_msg_and_die("socket");
609 // Die with an error message if we can't bind a socket to an address.
610 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
612 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
615 // Die with an error message if we can't listen for connections on a socket.
616 void xlisten(int s, int backlog)
618 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
621 /* Die with an error message if sendto failed.
622 * Return bytes sent otherwise */
623 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
626 ssize_t ret = sendto(s, buf, len, 0, to, tolen);
628 if (ENABLE_FEATURE_CLEAN_UP)
630 bb_perror_msg_and_die("sendto");
635 // xstat() - a stat() which dies on failure with meaningful error message
636 void xstat(const char *name, struct stat *stat_buf)
638 if (stat(name, stat_buf))
639 bb_perror_msg_and_die("can't stat '%s'", name);
642 // selinux_or_die() - die if SELinux is disabled.
643 void selinux_or_die(void)
646 int rc = is_selinux_enabled();
648 bb_error_msg_and_die("SELinux is disabled");
650 bb_error_msg_and_die("is_selinux_enabled() failed");
653 bb_error_msg_and_die("SELinux support is disabled");
657 /* It is perfectly ok to pass in a NULL for either width or for
658 * height, in which case that value will not be set. */
659 int get_terminal_width_height(int fd, int *width, int *height)
661 struct winsize win = { 0, 0, 0, 0 };
662 int ret = ioctl(fd, TIOCGWINSZ, &win);
666 char *s = getenv("LINES");
667 if (s) win.ws_row = atoi(s);
669 if (win.ws_row <= 1 || win.ws_row >= 30000)
671 *height = (int) win.ws_row;
676 char *s = getenv("COLUMNS");
677 if (s) win.ws_col = atoi(s);
679 if (win.ws_col <= 1 || win.ws_col >= 30000)
681 *width = (int) win.ws_col;
687 void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...)
691 if (ioctl(fd, request, argp) < 0) {
693 bb_verror_msg(fmt, p, strerror(errno));
694 /* xfunc_die can actually longjmp, so be nice */
700 int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...)
703 int ret = ioctl(fd, request, argp);
707 bb_verror_msg(fmt, p, strerror(errno));
713 #if ENABLE_IOCTL_HEX2STR_ERROR
714 int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name)
718 ret = ioctl(fd, request, argp);
720 bb_simple_perror_msg(ioctl_name);
723 void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name)
725 if (ioctl(fd, request, argp) < 0)
726 bb_simple_perror_msg_and_die(ioctl_name);
729 int bb_ioctl_or_warn(int fd, int request, void *argp)
733 ret = ioctl(fd, request, argp);
735 bb_perror_msg("ioctl %#x failed", request);
738 void bb_xioctl(int fd, int request, void *argp)
740 if (ioctl(fd, request, argp) < 0)
741 bb_perror_msg_and_die("ioctl %#x failed", request);