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,0) | O_NONBLOCK);
167 int ndelay_off(int fd)
169 return fcntl(fd, F_SETFL, fcntl(fd,F_GETFL,0) & ~O_NONBLOCK);
172 void xdup2(int from, int to)
174 if (dup2(from, to) != to)
175 bb_perror_msg_and_die("can't duplicate file descriptor");
178 // "Renumber" opened fd
179 void xmove_fd(int from, int to)
187 // Die with an error message if we can't write the entire buffer.
188 void xwrite(int fd, const void *buf, size_t count)
191 ssize_t size = full_write(fd, buf, count);
193 bb_error_msg_and_die("short write");
197 // Die with an error message if we can't lseek to the right spot.
198 off_t xlseek(int fd, off_t offset, int whence)
200 off_t off = lseek(fd, offset, whence);
201 if (off == (off_t)-1) {
202 if (whence == SEEK_SET)
203 bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
204 bb_perror_msg_and_die("lseek");
209 // Die with supplied filename if this FILE * has ferror set.
210 void die_if_ferror(FILE *fp, const char *fn)
213 /* ferror doesn't set useful errno */
214 bb_error_msg_and_die("%s: I/O error", fn);
218 // Die with an error message if stdout has ferror set.
219 void die_if_ferror_stdout(void)
221 die_if_ferror(stdout, bb_msg_standard_output);
224 // Die with an error message if we have trouble flushing stdout.
225 void xfflush_stdout(void)
227 if (fflush(stdout)) {
228 bb_perror_msg_and_die(bb_msg_standard_output);
232 void sig_block(int sig)
237 sigprocmask(SIG_BLOCK, &ss, NULL);
240 void sig_unblock(int sig)
245 sigprocmask(SIG_UNBLOCK, &ss, NULL);
249 void sig_blocknone(void)
253 sigprocmask(SIG_SETMASK, &ss, NULL);
257 void sig_catch(int sig, void (*f)(int))
262 sigemptyset(&sa.sa_mask);
263 sigaction(sig, &sa, NULL);
274 void xsetenv(const char *key, const char *value)
276 if (setenv(key, value, 1))
277 bb_error_msg_and_die(bb_msg_memory_exhausted);
280 // Converts unsigned long long value into compact 4-char
281 // representation. Examples: "1234", "1.2k", " 27M", "123T"
282 // Fifth char is always '\0'
283 void smart_ulltoa5(unsigned long long ul, char buf[5])
289 if (ul > 9999*10) { // do not scale if 9999 or less
290 while (ul >= 10000) {
295 v = ul; // ullong divisions are expensive, avoid them
298 if (!idx) { // 9999 or less: use 1234 format
299 c = buf[0] = " 123456789"[v/10000];
300 if (c != ' ') fmt = "0123456789";
301 c = buf[1] = fmt[v/1000%10];
302 if (c != ' ') fmt = "0123456789";
303 buf[2] = fmt[v/100%10];
304 buf[3] = "0123456789"[v/10%10];
306 if (v >= 10*10) { // scaled value is >=10: use 123M format
307 c = buf[0] = " 123456789"[v/1000];
308 if (c != ' ') fmt = "0123456789";
309 buf[1] = fmt[v/100%10];
310 buf[2] = "0123456789"[v/10%10];
311 } else { // scaled value is <10: use 1.2M format
312 buf[0] = "0123456789"[v/10];
314 buf[2] = "0123456789"[v%10];
316 // see http://en.wikipedia.org/wiki/Tera
317 buf[3] = " kMGTPEZY"[idx];
322 // Convert unsigned integer to ascii, writing into supplied buffer.
323 // A truncated result contains the first few digits of the result ala strncpy.
324 // Returns a pointer past last generated digit, does _not_ store NUL.
325 void BUG_sizeof_unsigned_not_4(void);
326 char *utoa_to_buf(unsigned n, char *buf, unsigned buflen)
328 unsigned i, out, res;
329 if (sizeof(unsigned) != 4)
330 BUG_sizeof_unsigned_not_4();
333 for (i = 1000000000; i; i /= 10) {
335 if (res || out || i == 1) {
336 if (!--buflen) break;
346 // Convert signed integer to ascii, like utoa_to_buf()
347 char *itoa_to_buf(int n, char *buf, unsigned buflen)
354 return utoa_to_buf((unsigned)n, buf, buflen);
357 // The following two functions use a static buffer, so calling either one a
358 // second time will overwrite previous results.
360 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
361 // Int should always be 32 bits on any remotely Unix-like system, see
362 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
364 static char local_buf[12];
366 // Convert unsigned integer to ascii using a static buffer (returned).
367 char *utoa(unsigned n)
369 *(utoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
374 // Convert signed integer to ascii using a static buffer (returned).
377 *(itoa_to_buf(n, local_buf, sizeof(local_buf))) = '\0';
382 // Emit a string of hex representation of bytes
383 char *bin2hex(char *p, const char *cp, int count)
386 unsigned char c = *cp++;
387 /* put lowercase hex digits */
388 *p++ = 0x20 | bb_hexdigits_upcase[c >> 4];
389 *p++ = 0x20 | bb_hexdigits_upcase[c & 0xf];
395 // Die with an error message if we can't set gid. (Because resource limits may
396 // limit this user to a given number of processes, and if that fills up the
397 // setgid() will fail and we'll _still_be_root_, which is bad.)
398 void xsetgid(gid_t gid)
400 if (setgid(gid)) bb_perror_msg_and_die("setgid");
403 // Die with an error message if we can't set uid. (See xsetgid() for why.)
404 void xsetuid(uid_t uid)
406 if (setuid(uid)) bb_perror_msg_and_die("setuid");
409 // Return how long the file at fd is, if there's any way to determine it.
410 off_t fdlength(int fd)
412 off_t bottom = 0, top = 0, pos;
415 // If the ioctl works for this, return it.
417 if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
419 // FIXME: explain why lseek(SEEK_END) is not used here!
421 // If not, do a binary search for the last location we can read. (Some
422 // block devices don't do BLKGETSIZE right.)
427 pos = bottom + (top - bottom) / 2;
429 // If we can read from the current location, it's bigger.
431 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
432 if (bottom == top) bottom = top = (top+1) * 2;
435 // If we can't, it's smaller.
444 } while (bottom + 1 != top);
449 // Die with an error message if we can't malloc() enough space and do an
450 // sprintf() into that space.
451 char *xasprintf(const char *format, ...)
460 r = vasprintf(&string_ptr, format, p);
463 // Bloat for systems that haven't got the GNU extension.
465 r = vsnprintf(NULL, 0, format, p);
467 string_ptr = xmalloc(r+1);
469 r = vsnprintf(string_ptr, r+1, format, p);
473 if (r < 0) bb_error_msg_and_die(bb_msg_memory_exhausted);
477 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
478 int fdprintf(int fd, const char *format, ...)
487 r = vasprintf(&string_ptr, format, p);
490 // Bloat for systems that haven't got the GNU extension.
492 r = vsnprintf(NULL, 0, format, p) + 1;
494 string_ptr = malloc(r);
497 r = vsnprintf(string_ptr, r, format, p);
503 full_write(fd, string_ptr, r);
510 // Die with an error message if we can't copy an entire FILE * to stdout, then
512 void xprint_and_close_file(FILE *file)
515 // copyfd outputs error messages for us.
516 if (bb_copyfd_eof(fileno(file), 1) == -1)
522 // Die if we can't chdir to a new path.
523 void xchdir(const char *path)
526 bb_perror_msg_and_die("chdir(%s)", path);
529 // Print a warning message if opendir() fails, but don't die.
530 DIR *warn_opendir(const char *path)
536 bb_perror_msg("can't open '%s'", path);
540 // Die with an error message if opendir() fails.
541 DIR *xopendir(const char *path)
547 bb_perror_msg_and_die("can't open '%s'", path);
551 // Die with an error message if we can't open a new socket.
552 int xsocket(int domain, int type, int protocol)
554 int r = socket(domain, type, protocol);
557 /* Hijack vaguely related config option */
558 #if ENABLE_VERBOSE_RESOLUTION_ERRORS
559 const char *s = "INET";
560 if (domain == AF_PACKET) s = "PACKET";
561 if (domain == AF_NETLINK) s = "NETLINK";
562 USE_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
563 bb_perror_msg_and_die("socket(AF_%s)", s);
565 bb_perror_msg_and_die("socket");
572 // Die with an error message if we can't bind a socket to an address.
573 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
575 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
578 // Die with an error message if we can't listen for connections on a socket.
579 void xlisten(int s, int backlog)
581 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
584 /* Die with an error message if sendto failed.
585 * Return bytes sent otherwise */
586 ssize_t xsendto(int s, const void *buf, size_t len, const struct sockaddr *to,
589 ssize_t ret = sendto(s, buf, len, 0, to, tolen);
591 if (ENABLE_FEATURE_CLEAN_UP)
593 bb_perror_msg_and_die("sendto");
598 // xstat() - a stat() which dies on failure with meaningful error message
599 void xstat(const char *name, struct stat *stat_buf)
601 if (stat(name, stat_buf))
602 bb_perror_msg_and_die("can't stat '%s'", name);
605 // selinux_or_die() - die if SELinux is disabled.
606 void selinux_or_die(void)
609 int rc = is_selinux_enabled();
611 bb_error_msg_and_die("SELinux is disabled");
613 bb_error_msg_and_die("is_selinux_enabled() failed");
616 bb_error_msg_and_die("SELinux support is disabled");
620 /* It is perfectly ok to pass in a NULL for either width or for
621 * height, in which case that value will not be set. */
622 int get_terminal_width_height(int fd, int *width, int *height)
624 struct winsize win = { 0, 0, 0, 0 };
625 int ret = ioctl(fd, TIOCGWINSZ, &win);
629 char *s = getenv("LINES");
630 if (s) win.ws_row = atoi(s);
632 if (win.ws_row <= 1 || win.ws_row >= 30000)
634 *height = (int) win.ws_row;
639 char *s = getenv("COLUMNS");
640 if (s) win.ws_col = atoi(s);
642 if (win.ws_col <= 1 || win.ws_col >= 30000)
644 *width = (int) win.ws_col;
650 void ioctl_or_perror_and_die(int fd, int request, void *argp, const char *fmt,...)
654 if (ioctl(fd, request, argp) < 0) {
656 bb_verror_msg(fmt, p, strerror(errno));
657 /* xfunc_die can actually longjmp, so be nice */
663 int ioctl_or_perror(int fd, int request, void *argp, const char *fmt,...)
666 int ret = ioctl(fd, request, argp);
670 bb_verror_msg(fmt, p, strerror(errno));
676 #if ENABLE_IOCTL_HEX2STR_ERROR
677 int bb_ioctl_or_warn(int fd, int request, void *argp, const char *ioctl_name)
681 ret = ioctl(fd, request, argp);
683 bb_perror_msg("%s", ioctl_name);
686 void bb_xioctl(int fd, int request, void *argp, const char *ioctl_name)
688 if (ioctl(fd, request, argp) < 0)
689 bb_perror_msg_and_die("%s", ioctl_name);
692 int bb_ioctl_or_warn(int fd, int request, void *argp)
696 ret = ioctl(fd, request, argp);
698 bb_perror_msg("ioctl %#x failed", request);
701 void bb_xioctl(int fd, int request, void *argp)
703 if (ioctl(fd, request, argp) < 0)
704 bb_perror_msg_and_die("ioctl %#x failed", request);