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)
74 if (ENABLE_DEBUG && s == NULL)
75 bb_error_msg_and_die("xstrndup bug");
79 return safe_strncpy(t,s,n);
82 // Die if we can't open a file and return a FILE * to it.
83 // Notice we haven't got xfread(), This is for use with fscanf() and friends.
84 FILE *xfopen(const char *path, const char *mode)
87 if ((fp = fopen(path, mode)) == NULL)
88 bb_perror_msg_and_die("%s", path);
92 // Die if we can't open an existing file and return an fd.
93 int xopen(const char *pathname, int flags)
95 if (ENABLE_DEBUG && (flags & O_CREAT))
96 bb_error_msg_and_die("xopen() with O_CREAT");
98 return xopen3(pathname, flags, 0666);
101 // Die if we can't open a new file and return an fd.
102 int xopen3(const char *pathname, int flags, int mode)
106 ret = open(pathname, flags, mode);
108 bb_perror_msg_and_die("%s", pathname);
114 int ndelay_off(int fd)
116 return fcntl(fd,F_SETFL,fcntl(fd,F_GETFL,0) & ~O_NONBLOCK);
119 // Turn on nonblocking I/O on a fd
120 int ndelay_on(int fd)
122 return fcntl(fd,F_SETFL,fcntl(fd,F_GETFL,0) | O_NONBLOCK);
125 // Die with an error message if we can't write the entire buffer.
126 void xwrite(int fd, void *buf, size_t count)
129 ssize_t size = full_write(fd, buf, count);
131 bb_error_msg_and_die("short write");
135 // Die with an error message if we can't lseek to the right spot.
136 off_t xlseek(int fd, off_t offset, int whence)
138 off_t off = lseek(fd, offset, whence);
139 if (off == (off_t)-1)
140 bb_perror_msg_and_die("lseek");
144 // Die with supplied error message if this FILE * has ferror set.
145 void die_if_ferror(FILE *fp, const char *fn)
148 bb_error_msg_and_die("%s", fn);
152 // Die with an error message if stdout has ferror set.
153 void die_if_ferror_stdout(void)
155 die_if_ferror(stdout, bb_msg_standard_output);
158 // Die with an error message if we have trouble flushing stdout.
159 void xfflush_stdout(void)
161 if (fflush(stdout)) {
162 bb_perror_msg_and_die(bb_msg_standard_output);
166 // This does a fork/exec in one call, using vfork(). Return PID of new child,
167 // -1 for failure. Runs argv[0], searching path if that has no / in it.
168 pid_t spawn(char **argv)
172 void *app = ENABLE_FEATURE_SH_STANDALONE_SHELL ? find_applet_by_name(argv[0]) : 0;
174 // Be nice to nommu machines.
177 if (pid < 0) return pid;
179 execvp(app ? CONFIG_BUSYBOX_EXEC_PATH : *argv, argv);
181 // We're sharing a stack with blocked parent, let parent know we failed
182 // and then exit to unblock parent (but don't run atexit() stuff, which
183 // would screw up parent.)
188 return failed ? failed : pid;
191 // Die with an error message if we can't spawn a child process.
192 pid_t xspawn(char **argv)
194 pid_t pid = spawn(argv);
195 if (pid < 0) bb_perror_msg_and_die("%s", *argv);
199 // Wait for the specified child PID to exit, returning child's error return.
200 int wait4pid(int pid)
204 if (pid == -1 || waitpid(pid, &status, 0) == -1) return -1;
205 if (WIFEXITED(status)) return WEXITSTATUS(status);
206 if (WIFSIGNALED(status)) return WTERMSIG(status);
210 void xsetenv(const char *key, const char *value)
212 if (setenv(key, value, 1))
213 bb_error_msg_and_die(bb_msg_memory_exhausted);
217 // Converts unsigned long long value into compact 4-char
218 // representation. Examples: "1234", "1.2k", " 27M", "123T"
219 // Fifth char is always '\0'
220 void smart_ulltoa5(unsigned long long ul, char buf[5])
226 if (ul > 9999*10) { // do not scale if 9999 or less
227 while (ul >= 10000) {
232 v = ul; // ullong divisions are expensive, avoid them
235 if (!idx) { // 9999 or less: use 1234 format
236 c = buf[0] = " 123456789"[v/10000];
237 if (c!=' ') fmt = "0123456789";
238 c = buf[1] = fmt[v/1000%10];
239 if (c!=' ') fmt = "0123456789";
240 buf[2] = fmt[v/100%10];
241 buf[3] = "0123456789"[v/10%10];
243 if (v>=10*10) { // scaled value is >=10: use 123M format
244 c = buf[0] = " 123456789"[v/1000];
245 if (c!=' ') fmt = "0123456789";
246 buf[1] = fmt[v/100%10];
247 buf[2] = "0123456789"[v/10%10];
248 } else { // scaled value is <10: use 1.2M format
249 buf[0] = "0123456789"[v/10];
251 buf[2] = "0123456789"[v%10];
253 // see http://en.wikipedia.org/wiki/Tera
254 buf[3] = " kMGTPEZY"[idx];
260 // Convert unsigned integer to ascii, writing into supplied buffer. A
261 // truncated result is always null terminated (unless buflen is 0), and
262 // contains the first few digits of the result ala strncpy.
263 void BUG_sizeof_unsigned_not_4(void);
264 void utoa_to_buf(unsigned n, char *buf, unsigned buflen)
266 unsigned i, out, res;
267 if (sizeof(unsigned) != 4)
268 BUG_sizeof_unsigned_not_4();
271 for (i = 1000000000; i; i /= 10) {
273 if (res || out || i == 1) {
274 if (!--buflen) break;
284 // Convert signed integer to ascii, like utoa_to_buf()
285 void itoa_to_buf(int n, char *buf, unsigned buflen)
292 utoa_to_buf((unsigned)n, buf, buflen);
295 // The following two functions use a static buffer, so calling either one a
296 // second time will overwrite previous results.
298 // The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
299 // Int should always be 32 bits on any remotely Unix-like system, see
300 // http://www.unix.org/whitepapers/64bit.html for the reasons why.
302 static char local_buf[12];
304 // Convert unsigned integer to ascii using a static buffer (returned).
305 char *utoa(unsigned n)
307 utoa_to_buf(n, local_buf, sizeof(local_buf));
312 // Convert signed integer to ascii using a static buffer (returned).
315 itoa_to_buf(n, local_buf, sizeof(local_buf));
320 // Die with an error message if we can't set gid. (Because resource limits may
321 // limit this user to a given number of processes, and if that fills up the
322 // setgid() will fail and we'll _still_be_root_, which is bad.)
323 void xsetgid(gid_t gid)
325 if (setgid(gid)) bb_error_msg_and_die("setgid");
328 // Die with an error message if we can't set uid. (See xsetgid() for why.)
329 void xsetuid(uid_t uid)
331 if (setuid(uid)) bb_error_msg_and_die("setuid");
334 // Return how long the file at fd is, if there's any way to determine it.
335 off_t fdlength(int fd)
337 off_t bottom = 0, top = 0, pos;
340 // If the ioctl works for this, return it.
342 if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
344 // FIXME: explain why lseek(SEEK_END) is not used here!
346 // If not, do a binary search for the last location we can read. (Some
347 // block devices don't do BLKGETSIZE right.)
352 pos = bottom + (top - bottom) / 2;
354 // If we can read from the current location, it's bigger.
356 if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
357 if (bottom == top) bottom = top = (top+1) * 2;
360 // If we can't, it's smaller.
369 } while (bottom + 1 != top);
374 // Die with an error message if we can't malloc() enough space and do an
375 // sprintf() into that space.
376 char *xasprintf(const char *format, ...)
385 r = vasprintf(&string_ptr, format, p);
388 // Bloat for systems that haven't got the GNU extension.
390 r = vsnprintf(NULL, 0, format, p);
392 string_ptr = xmalloc(r+1);
394 r = vsnprintf(string_ptr, r+1, format, p);
398 if (r < 0) bb_error_msg_and_die(bb_msg_memory_exhausted);
402 // Die with an error message if we can't copy an entire FILE * to stdout, then
404 void xprint_and_close_file(FILE *file)
407 // copyfd outputs error messages for us.
408 if (bb_copyfd_eof(fileno(file), 1) == -1)
409 exit(xfunc_error_retval);
414 // Die if we can't chdir to a new path.
415 void xchdir(const char *path)
418 bb_perror_msg_and_die("chdir(%s)", path);
421 // Print a warning message if opendir() fails, but don't die.
422 DIR *warn_opendir(const char *path)
426 if ((dp = opendir(path)) == NULL) {
427 bb_perror_msg("cannot open '%s'", path);
433 // Die with an error message if opendir() fails.
434 DIR *xopendir(const char *path)
438 if ((dp = opendir(path)) == NULL)
439 bb_perror_msg_and_die("cannot open '%s'", path);
444 // Die with an error message if we can't daemonize.
445 void xdaemon(int nochdir, int noclose)
447 if (daemon(nochdir, noclose))
448 bb_perror_msg_and_die("daemon");
452 // Die with an error message if we can't open a new socket.
453 int xsocket(int domain, int type, int protocol)
455 int r = socket(domain, type, protocol);
457 if (r < 0) bb_perror_msg_and_die("socket");
462 // Die with an error message if we can't bind a socket to an address.
463 void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
465 if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
468 // Die with an error message if we can't listen for connections on a socket.
469 void xlisten(int s, int backlog)
471 if (listen(s, backlog)) bb_perror_msg_and_die("listen");
474 // xstat() - a stat() which dies on failure with meaningful error message
475 void xstat(char *name, struct stat *stat_buf)
477 if (stat(name, stat_buf))
478 bb_perror_msg_and_die("can't stat '%s'", name);
481 /* It is perfectly ok to pass in a NULL for either width or for
482 * height, in which case that value will not be set. */
483 int get_terminal_width_height(int fd, int *width, int *height)
485 struct winsize win = { 0, 0, 0, 0 };
486 int ret = ioctl(fd, TIOCGWINSZ, &win);
490 char *s = getenv("LINES");
491 if (s) win.ws_row = atoi(s);
493 if (win.ws_row <= 1 || win.ws_row >= 30000)
495 *height = (int) win.ws_row;
500 char *s = getenv("COLUMNS");
501 if (s) win.ws_col = atoi(s);
503 if (win.ws_col <= 1 || win.ws_col >= 30000)
505 *width = (int) win.ws_col;