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 // Die if we can't allocate size bytes of memory.
24 void *xmalloc(size_t size)
26 void *ptr = malloc(size);
27 if (ptr == NULL && size != 0)
28 bb_error_msg_and_die(bb_msg_memory_exhausted);
32 // Die if we can't resize previously allocated memory. (This returns a pointer
33 // to the new memory, which may or may not be the same as the old memory.
34 // It'll copy the contents to a new chunk and free the old one if necessary.)
35 void *xrealloc(void *ptr, size_t size)
37 ptr = realloc(ptr, size);
38 if (ptr == NULL && size != 0)
39 bb_error_msg_and_die(bb_msg_memory_exhausted);
44 // Die if we can't allocate and zero size bytes of memory.
45 void *xzalloc(size_t size)
47 void *ptr = xmalloc(size);
52 // Die if we can't copy a string to freshly allocated memory.
53 char * xstrdup(const char *s)
63 bb_error_msg_and_die(bb_msg_memory_exhausted);
68 // Die if we can't allocate n+1 bytes (space for the null terminator) and copy
69 // the (possibly truncated to length n) string into it.
70 char * xstrndup(const char *s, int n)
75 if (ENABLE_DEBUG && s == NULL)
76 bb_error_msg_and_die("xstrndup bug");
78 /* We can just xmalloc(n+1) and strncpy into it, */
79 /* but think about xstrndup("abc", 10000) wastage! */
91 return memcpy(t, s, n);
94 // Die if we can't open a file and return a FILE * to it.
95 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
96 FILE *xfopen(const char *path, const char *mode)
98 FILE *fp = fopen(path, mode);
100 bb_perror_msg_and_die("%s", path);
104 // Die if we can't open an existing file and return an fd.
105 int xopen(const char *pathname, int flags)
107 //if (ENABLE_DEBUG && (flags & O_CREAT))
108 // bb_error_msg_and_die("xopen() with O_CREAT");
110 return xopen3(pathname, flags, 0666);
113 // Die if we can't open a new file and return an fd.
114 int xopen3(const char *pathname, int flags, int mode)
118 ret = open(pathname, flags, mode);
120 bb_perror_msg_and_die("%s", pathname);
125 // Turn on nonblocking I/O on a fd
126 int ndelay_on(int fd)
128 return fcntl(fd,F_SETFL,fcntl(fd,F_GETFL,0) | O_NONBLOCK);
131 int ndelay_off(int fd)
133 return fcntl(fd,F_SETFL,fcntl(fd,F_GETFL,0) & ~O_NONBLOCK);
136 // "Renumber" opened fd
137 void xmove_fd(int from, int to)
141 if (dup2(from, to) != to)
142 bb_perror_msg_and_die("cannot duplicate file descriptor");
146 // Die with an error message if we can't write the entire buffer.
147 void xwrite(int fd, const void *buf, size_t count)
150 ssize_t size = full_write(fd, buf, count);
152 bb_error_msg_and_die("short write");
156 // Die with an error message if we can't lseek to the right spot.
157 off_t xlseek(int fd, off_t offset, int whence)
159 off_t off = lseek(fd, offset, whence);
160 if (off == (off_t)-1) {
161 if (whence == SEEK_SET)
162 bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
163 bb_perror_msg_and_die("lseek");
168 // Die with supplied filename if this FILE * has ferror set.
169 void die_if_ferror(FILE *fp, const char *fn)
172 bb_error_msg_and_die("%s: I/O error", fn);
176 // Die with an error message if stdout has ferror set.
177 void die_if_ferror_stdout(void)
179 die_if_ferror(stdout, bb_msg_standard_output);
182 // Die with an error message if we have trouble flushing stdout.
183 void xfflush_stdout(void)
185 if (fflush(stdout)) {
186 bb_perror_msg_and_die(bb_msg_standard_output);
190 // Wait for the specified child PID to exit, returning child's error return.
191 int wait4pid(int pid)
195 if (pid == -1 || waitpid(pid, &status, 0) == -1) return -1;
196 if (WIFEXITED(status)) return WEXITSTATUS(status);
197 if (WIFSIGNALED(status)) return WTERMSIG(status);
201 void xsetenv(const char *key, const char *value)
203 if (setenv(key, value, 1))
204 bb_error_msg_and_die(bb_msg_memory_exhausted);
207 // Converts unsigned long long value into compact 4-char
208 // representation. Examples: "1234", "1.2k", " 27M", "123T"
209 // Fifth char is always '\0'
210 void smart_ulltoa5(unsigned long long ul, char buf[5])
216 if (ul > 9999*10) { // do not scale if 9999 or less
217 while (ul >= 10000) {
222 v = ul; // ullong divisions are expensive, avoid them
225 if (!idx) { // 9999 or less: use 1234 format
226 c = buf[0] = " 123456789"[v/10000];
227 if (c != ' ') fmt = "0123456789";
228 c = buf[1] = fmt[v/1000%10];
229 if (c != ' ') fmt = "0123456789";
230 buf[2] = fmt[v/100%10];
231 buf[3] = "0123456789"[v/10%10];
233 if (v >= 10*10) { // scaled value is >=10: use 123M format
234 c = buf[0] = " 123456789"[v/1000];
235 if (c != ' ') fmt = "0123456789";
236 buf[1] = fmt[v/100%10];
237 buf[2] = "0123456789"[v/10%10];
238 } else { // scaled value is <10: use 1.2M format
239 buf[0] = "0123456789"[v/10];
241 buf[2] = "0123456789"[v%10];
243 // see http://en.wikipedia.org/wiki/Tera
244 buf[3] = " kMGTPEZY"[idx];
249 // Convert unsigned integer to ascii, writing into supplied buffer. A
250 // truncated result is always null terminated (unless buflen is 0), and
251 // contains the first few digits of the result ala strncpy.
252 void BUG_sizeof_unsigned_not_4(void);
253 void utoa_to_buf(unsigned n, char *buf, unsigned buflen)
255 unsigned i, out, res;
256 if (sizeof(unsigned) != 4)
257 BUG_sizeof_unsigned_not_4();
260 for (i = 1000000000; i; i /= 10) {
262 if (res || out || i == 1) {
263 if (!--buflen) break;
273 // Convert signed integer to ascii, like utoa_to_buf()
274 void itoa_to_buf(int n, char *buf, unsigned buflen)
281 utoa_to_buf((unsigned)n, buf, buflen);
284 // The following two functions use a static buffer, so calling either one a
285 // second time will overwrite previous results.
287 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
288 // Int should always be 32 bits on any remotely Unix-like system, see
289 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
291 static char local_buf[12];
293 // Convert unsigned integer to ascii using a static buffer (returned).
294 char *utoa(unsigned n)
296 utoa_to_buf(n, local_buf, sizeof(local_buf));
301 // Convert signed integer to ascii using a static buffer (returned).
304 itoa_to_buf(n, local_buf, sizeof(local_buf));
309 // Emit a string of hex representation of bytes
310 char *bin2hex(char *p, const char *cp, int count)
313 unsigned char c = *cp++;
314 /* put lowercase hex digits */
315 *p++ = 0x20 | bb_hexdigits_upcase[c >> 4];
316 *p++ = 0x20 | bb_hexdigits_upcase[c & 0xf];
322 // Die with an error message if we can't set gid. (Because resource limits may
323 // limit this user to a given number of processes, and if that fills up the
324 // setgid() will fail and we'll _still_be_root_, which is bad.)
325 void xsetgid(gid_t gid)
327 if (setgid(gid)) bb_error_msg_and_die("setgid");
330 // Die with an error message if we can't set uid. (See xsetgid() for why.)
331 void xsetuid(uid_t uid)
333 if (setuid(uid)) bb_error_msg_and_die("setuid");
336 // Return how long the file at fd is, if there's any way to determine it.
337 off_t fdlength(int fd)
339 off_t bottom = 0, top = 0, pos;
342 // If the ioctl works for this, return it.
344 if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
346 // FIXME: explain why lseek(SEEK_END) is not used here!
348 // If not, do a binary search for the last location we can read. (Some
349 // block devices don't do BLKGETSIZE right.)
354 pos = bottom + (top - bottom) / 2;
356 // If we can read from the current location, it's bigger.
358 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
359 if (bottom == top) bottom = top = (top+1) * 2;
362 // If we can't, it's smaller.
371 } while (bottom + 1 != top);
376 // Die with an error message if we can't malloc() enough space and do an
377 // sprintf() into that space.
378 char *xasprintf(const char *format, ...)
387 r = vasprintf(&string_ptr, format, p);
390 // Bloat for systems that haven't got the GNU extension.
392 r = vsnprintf(NULL, 0, format, p);
394 string_ptr = xmalloc(r+1);
396 r = vsnprintf(string_ptr, r+1, format, p);
400 if (r < 0) bb_error_msg_and_die(bb_msg_memory_exhausted);
404 #if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
405 int fdprintf(int fd, const char *format, ...)
414 r = vasprintf(&string_ptr, format, p);
417 // Bloat for systems that haven't got the GNU extension.
419 r = vsnprintf(NULL, 0, format, p);
421 string_ptr = xmalloc(r+1);
423 r = vsnprintf(string_ptr, r+1, format, p);
428 full_write(fd, string_ptr, r);
435 // Die with an error message if we can't copy an entire FILE * to stdout, then
437 void xprint_and_close_file(FILE *file)
440 // copyfd outputs error messages for us.
441 if (bb_copyfd_eof(fileno(file), 1) == -1)
442 exit(xfunc_error_retval);
447 // Die if we can't chdir to a new path.
448 void xchdir(const char *path)
451 bb_perror_msg_and_die("chdir(%s)", path);
454 // Print a warning message if opendir() fails, but don't die.
455 DIR *warn_opendir(const char *path)
461 bb_perror_msg("cannot open '%s'", path);
465 // Die with an error message if opendir() fails.
466 DIR *xopendir(const char *path)
472 bb_perror_msg_and_die("cannot open '%s'", path);
476 // Die with an error message if we can't open a new socket.
477 int xsocket(int domain, int type, int protocol)
479 int r = socket(domain, type, protocol);
481 if (r < 0) bb_perror_msg_and_die("socket");
486 // Die with an error message if we can't bind a socket to an address.
487 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
489 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
492 // Die with an error message if we can't listen for connections on a socket.
493 void xlisten(int s, int backlog)
495 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
498 // xstat() - a stat() which dies on failure with meaningful error message
499 void xstat(const char *name, struct stat *stat_buf)
501 if (stat(name, stat_buf))
502 bb_perror_msg_and_die("can't stat '%s'", name);
505 // selinux_or_die() - die if SELinux is disabled.
506 void selinux_or_die(void)
509 int rc = is_selinux_enabled();
511 bb_error_msg_and_die("SELinux is disabled");
513 bb_error_msg_and_die("is_selinux_enabled() failed");
516 bb_error_msg_and_die("SELinux support is disabled");
520 /* It is perfectly ok to pass in a NULL for either width or for
521 * height, in which case that value will not be set. */
522 int get_terminal_width_height(const int fd, int *width, int *height)
524 struct winsize win = { 0, 0, 0, 0 };
525 int ret = ioctl(fd, TIOCGWINSZ, &win);
529 char *s = getenv("LINES");
530 if (s) win.ws_row = atoi(s);
532 if (win.ws_row <= 1 || win.ws_row >= 30000)
534 *height = (int) win.ws_row;
539 char *s = getenv("COLUMNS");
540 if (s) win.ws_col = atoi(s);
542 if (win.ws_col <= 1 || win.ws_col >= 30000)
544 *width = (int) win.ws_col;