libbb: two new functions: wait_for_exitstatus(pid), xfchdir(fd)
[oweals/busybox.git] / libbb / xfuncs.c
index 7b95e49f1bb083593bac56c8f85f4c49f615eaa1..3f9a84ad4915ece662a02f337cfb4b36da14c476 100644 (file)
  *
  * Copyright (C) 1999-2004 by Erik Andersen <andersen@codepoet.org>
  * Copyright (C) 2006 Rob Landley
- * Copyright (C) 2006 Denis Vlasenko
+ * Copyright (C) 2006 Denys Vlasenko
  *
- * Licensed under GPL version 2, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2, see file LICENSE in this source tree.
  */
 
-#include "busybox.h"
-
-/* All the functions starting with "x" call bb_error_msg_and_die() if they
- * fail, so callers never need to check for errors.  If it returned, it
- * succeeded. */
-
-#ifndef DMALLOC
-/* dmalloc provides variants of these that do abort() on failure.
- * Since dmalloc's prototypes overwrite the impls here as they are
- * included after these prototypes in libbb.h, all is well.
+/* We need to have separate xfuncs.c and xfuncs_printf.c because
+ * with current linkers, even with section garbage collection,
+ * if *.o module references any of XXXprintf functions, you pull in
+ * entire printf machinery. Even if you do not use the function
+ * which uses XXXprintf.
+ *
+ * xfuncs.c contains functions (not necessarily xfuncs)
+ * which do not pull in printf, directly or indirectly.
+ * xfunc_printf.c contains those which do.
+ *
+ * TODO: move xmalloc() and xatonum() here.
  */
-#ifdef L_xmalloc
-// Die if we can't allocate size bytes of memory.
-void *xmalloc(size_t size)
-{
-       void *ptr = malloc(size);
-       if (ptr == NULL && size != 0)
-               bb_error_msg_and_die(bb_msg_memory_exhausted);
-       return ptr;
-}
-#endif
-
-#ifdef L_xrealloc
-// Die if we can't resize previously allocated memory.  (This returns a pointer
-// to the new memory, which may or may not be the same as the old memory.
-// It'll copy the contents to a new chunk and free the old one if necessary.)
-void *xrealloc(void *ptr, size_t size)
-{
-       ptr = realloc(ptr, size);
-       if (ptr == NULL && size != 0)
-               bb_error_msg_and_die(bb_msg_memory_exhausted);
-       return ptr;
-}
-#endif
-#endif /* DMALLOC */
-
-
-#ifdef L_xzalloc
-// Die if we can't allocate and zero size bytes of memory.
-void *xzalloc(size_t size)
-{
-       void *ptr = xmalloc(size);
-       memset(ptr, 0, size);
-       return ptr;
-}
-#endif
-
-#ifdef L_xstrdup
-// Die if we can't copy a string to freshly allocated memory.
-char * xstrdup(const char *s)
-{
-       char *t;
-
-       if (s == NULL)
-               return NULL;
-
-       t = strdup (s);
-
-       if (t == NULL)
-               bb_error_msg_and_die(bb_msg_memory_exhausted);
-
-       return t;
-}
-#endif
-
-#ifdef L_xstrndup
-// Die if we can't allocate n+1 bytes (space for the null terminator) and copy
-// the (possibly truncated to length n) string into it.
-char * xstrndup(const char *s, int n)
-{
-       char *t;
-
-       if (ENABLE_DEBUG && s == NULL)
-               bb_error_msg_and_die("xstrndup bug");
-
-       t = xmalloc(++n);
-
-       return safe_strncpy(t,s,n);
-}
-#endif
-
-#ifdef L_xfopen
-// Die if we can't open a file and return a FILE * to it.
-// Notice we haven't got xfread(), This is for use with fscanf() and friends.
-FILE *xfopen(const char *path, const char *mode)
-{
-       FILE *fp;
-       if ((fp = fopen(path, mode)) == NULL)
-               bb_perror_msg_and_die("%s", path);
-       return fp;
-}
-#endif
 
-#ifdef L_xopen
-// Die if we can't open an existing file and return an fd.
-int xopen(const char *pathname, int flags)
-{
-       if (ENABLE_DEBUG && (flags & O_CREAT))
-               bb_error_msg_and_die("xopen() with O_CREAT");
+#include "libbb.h"
 
-       return xopen3(pathname, flags, 0777);
-}
-#endif
-
-#ifdef L_xopen3
-// Die if we can't open a new file and return an fd.
-int xopen3(const char *pathname, int flags, int mode)
+/* Turn on nonblocking I/O on a fd */
+int FAST_FUNC ndelay_on(int fd)
 {
-       int ret;
-
-       ret = open(pathname, flags, mode);
-       if (ret < 0) {
-               bb_perror_msg_and_die("%s", pathname);
-       }
-       return ret;
+       int flags = fcntl(fd, F_GETFL);
+       if (flags & O_NONBLOCK)
+               return flags;
+       fcntl(fd, F_SETFL, flags | O_NONBLOCK);
+       return flags;
 }
-#endif
 
-#ifdef L_xread
-// Die with an error message if we can't read the entire buffer.
-void xread(int fd, void *buf, size_t count)
+int FAST_FUNC ndelay_off(int fd)
 {
-       while (count) {
-               ssize_t size;
-
-               if ((size = safe_read(fd, buf, count)) < 1)
-                       bb_error_msg_and_die("Short read");
-               count -= size;
-               buf = ((char *) buf) + size;
-       }
+       int flags = fcntl(fd, F_GETFL);
+       if (!(flags & O_NONBLOCK))
+               return flags;
+       fcntl(fd, F_SETFL, flags & ~O_NONBLOCK);
+       return flags;
 }
-#endif
 
-#ifdef L_xwrite
-// Die with an error message if we can't write the entire buffer.
-void xwrite(int fd, void *buf, size_t count)
+void FAST_FUNC close_on_exec_on(int fd)
 {
-       while (count) {
-               ssize_t size;
-
-               if ((size = safe_write(fd, buf, count)) < 1)
-                       bb_error_msg_and_die("Short write");
-               count -= size;
-               buf = ((char *) buf) + size;
-       }
+       fcntl(fd, F_SETFD, FD_CLOEXEC);
 }
-#endif
 
-#ifdef L_xlseek
-// Die with an error message if we can't lseek to the right spot.
-void xlseek(int fd, off_t offset, int whence)
+char* FAST_FUNC strncpy_IFNAMSIZ(char *dst, const char *src)
 {
-       if (offset != lseek(fd, offset, whence)) bb_error_msg_and_die("lseek");
-}
-#endif
-
-#ifdef L_xread_char
-// Die with an error message if we can't read one character.
-unsigned char xread_char(int fd)
-{
-       char tmp;
-
-       xread(fd, &tmp, 1);
-
-       return(tmp);
-}
+#ifndef IFNAMSIZ
+       enum { IFNAMSIZ = 16 };
 #endif
-
-#ifdef L_xferror
-// Die with supplied error message if this FILE * has ferror set.
-void xferror(FILE *fp, const char *fn)
-{
-       if (ferror(fp)) {
-               bb_error_msg_and_die("%s", fn);
-       }
+       return strncpy(dst, src, IFNAMSIZ);
 }
-#endif
 
-#ifdef L_xferror_stdout
-// Die with an error message if stdout has ferror set.
-void xferror_stdout(void)
-{
-       xferror(stdout, bb_msg_standard_output);
-}
-#endif
 
-#ifdef L_xfflush_stdout
-// Die with an error message if we have trouble flushing stdout.
-void xfflush_stdout(void)
-{
-       if (fflush(stdout)) {
-               bb_perror_msg_and_die(bb_msg_standard_output);
-       }
-}
-#endif
-
-#ifdef L_spawn
-// This does a fork/exec in one call, using vfork().  Return PID of new child,
-// -1 for failure.  Runs argv[0], searching path if that has no / in it.
-pid_t spawn(char **argv)
-{
-       static int failed;
-       pid_t pid;
-       void *app = ENABLE_FEATURE_SH_STANDALONE_SHELL ? find_applet_by_name(argv[0]) : 0;
-
-       // Be nice to nommu machines.
-       failed = 0;
-       pid = vfork();
-       if (pid < 0) return pid;
-       if (!pid) {
-               execvp(app ? CONFIG_BUSYBOX_EXEC_PATH : *argv, argv);
-
-               // We're sharing a stack with blocked parent, let parent know we failed
-               // and then exit to unblock parent (but don't run atexit() stuff, which
-               // would screw up parent.)
-
-               failed = -1;
-               _exit(0);
-       }
-       return failed ? failed : pid;
-}
-#endif
-
-#ifdef L_xspawn
-// Die with an error message if we can't spawn a child process.
-pid_t xspawn(char **argv)
-{
-       pid_t pid = spawn(argv);
-       if (pid < 0) bb_perror_msg_and_die("%s", *argv);
-       return pid;
-}
-#endif
-
-#ifdef L_wait4
-// Wait for the specified child PID to exit, returning child's error return.
-int wait4pid(int pid)
-{
-       int status;
-
-       if (pid == -1 || waitpid(pid, &status, 0) == -1) return -1;
-       if (WIFEXITED(status)) return WEXITSTATUS(status);
-       if (WIFSIGNALED(status)) return WTERMSIG(status);
-       return 0;
-}
-#endif
-
-#ifdef L_xsetenv
-void xsetenv(const char *key, const char *value)
+/* Convert unsigned integer to ascii, writing into supplied buffer.
+ * A truncated result contains the first few digits of the result ala strncpy.
+ * Returns a pointer past last generated digit, does _not_ store NUL.
+ */
+void BUG_sizeof(void);
+char* FAST_FUNC utoa_to_buf(unsigned n, char *buf, unsigned buflen)
 {
-       if(setenv(key, value, 1))
-               bb_error_msg_and_die(bb_msg_memory_exhausted);
-}
-#endif
+       unsigned i, out, res;
 
-#ifdef L_itoa
-// Convert unsigned integer to ascii, writing into supplied buffer.  A
-// truncated result is always null terminated (unless buflen is 0), and
-// contains the first few digits of the result ala strncpy.
-void utoa_to_buf(unsigned n, char *buf, unsigned buflen)
-{
-       int i, out = 0;
        if (buflen) {
-               for (i=1000000000; i; i/=10) {
-                       int res = n/i;
-
-                       if ((res || out || i == 1) && --buflen>0) {
+               out = 0;
+               if (sizeof(n) == 4)
+               // 2^32-1 = 4294967295
+                       i = 1000000000;
+#if UINT_MAX > 4294967295 /* prevents warning about "const too large" */
+               else
+               if (sizeof(n) == 8)
+               // 2^64-1 = 18446744073709551615
+                       i = 10000000000000000000;
+#endif
+               else
+                       BUG_sizeof();
+               for (; i; i /= 10) {
+                       res = n / i;
+                       n = n % i;
+                       if (res || out || i == 1) {
+                               if (--buflen == 0)
+                                       break;
                                out++;
-                               n -= res*i;
                                *buf++ = '0' + res;
                        }
                }
-               *buf = 0;
        }
+       return buf;
 }
 
-// Convert signed integer to ascii, like utoa_to_buf()
-void itoa_to_buf(int n, char *buf, unsigned buflen)
+/* Convert signed integer to ascii, like utoa_to_buf() */
+char* FAST_FUNC itoa_to_buf(int n, char *buf, unsigned buflen)
 {
-       if (buflen && n<0) {
+       if (!buflen)
+               return buf;
+       if (n < 0) {
                n = -n;
                *buf++ = '-';
                buflen--;
        }
-       utoa_to_buf((unsigned)n, buf, buflen);
+       return utoa_to_buf((unsigned)n, buf, buflen);
 }
 
 // The following two functions use a static buffer, so calling either one a
 // second time will overwrite previous results.
 //
-// The largest 32 bit integer is -2 billion plus null terminator, or 12 bytes.
-// Int should always be 32 bits on any remotely Unix-like system, see
-// http://www.unix.org/whitepapers/64bit.html for the reasons why.
+// The largest 32 bit integer is -2 billion plus NUL, or 1+10+1=12 bytes.
+// It so happens that sizeof(int) * 3 is enough for 32+ bit ints.
+// (sizeof(int) * 3 + 2 is correct for any width, even 8-bit)
 
-static char local_buf[12];
+static char local_buf[sizeof(int) * 3];
 
-// Convert unsigned integer to ascii using a static buffer (returned).
-char *utoa(unsigned n)
+/* Convert unsigned integer to ascii using a static buffer (returned). */
+char* FAST_FUNC utoa(unsigned n)
 {
-       utoa_to_buf(n, local_buf, sizeof(local_buf));
+       *(utoa_to_buf(n, local_buf, sizeof(local_buf) - 1)) = '\0';
 
        return local_buf;
 }
 
-// Convert signed integer to ascii using a static buffer (returned).
-char *itoa(int n)
+/* Convert signed integer to ascii using a static buffer (returned). */
+char* FAST_FUNC itoa(int n)
 {
-       itoa_to_buf(n, local_buf, sizeof(local_buf));
+       *(itoa_to_buf(n, local_buf, sizeof(local_buf) - 1)) = '\0';
 
        return local_buf;
 }
-#endif
-
-#ifdef L_setuid
-// Die with an error message if we can't set gid.  (Because resource limits may
-// limit this user to a given number of processes, and if that fills up the
-// setgid() will fail and we'll _still_be_root_, which is bad.)
-void xsetgid(gid_t gid)
-{
-       if (setgid(gid)) bb_error_msg_and_die("setgid");
-}
 
-// Die with an error message if we cant' set uid.  (See xsetgid() for why.)
-void xsetuid(uid_t uid)
+/* Emit a string of hex representation of bytes */
+char* FAST_FUNC bin2hex(char *p, const char *cp, int count)
 {
-       if (setuid(uid)) bb_error_msg_and_die("setuid");
+       while (count) {
+               unsigned char c = *cp++;
+               /* put lowercase hex digits */
+               *p++ = 0x20 | bb_hexdigits_upcase[c >> 4];
+               *p++ = 0x20 | bb_hexdigits_upcase[c & 0xf];
+               count--;
+       }
+       return p;
+}
+
+/* Convert "[x]x[:][x]x[:][x]x[:][x]x" hex string to binary, no more than COUNT bytes */
+char* FAST_FUNC hex2bin(char *dst, const char *str, int count)
+{
+       errno = EINVAL;
+       while (*str && count) {
+               uint8_t val;
+               uint8_t c = *str++;
+               if (isdigit(c))
+                       val = c - '0';
+               else if ((c|0x20) >= 'a' && (c|0x20) <= 'f')
+                       val = (c|0x20) - ('a' - 10);
+               else
+                       return NULL;
+               val <<= 4;
+               c = *str;
+               if (isdigit(c))
+                       val |= c - '0';
+               else if ((c|0x20) >= 'a' && (c|0x20) <= 'f')
+                       val |= (c|0x20) - ('a' - 10);
+               else if (c == ':' || c == '\0')
+                       val >>= 4;
+               else
+                       return NULL;
+
+               *dst++ = val;
+               if (c != '\0')
+                       str++;
+               if (*str == ':')
+                       str++;
+               count--;
+       }
+       errno = (*str ? ERANGE : 0);
+       return dst;
 }
-#endif
 
-#ifdef L_fdlength
-// Return how long the file at fd is, if there's any way to determine it.
-off_t fdlength(int fd)
+/* Return how long the file at fd is, if there's any way to determine it. */
+#ifdef UNUSED
+off_t FAST_FUNC fdlength(int fd)
 {
        off_t bottom = 0, top = 0, pos;
        long size;
@@ -348,6 +190,8 @@ off_t fdlength(int fd)
 
        if (ioctl(fd, BLKGETSIZE, &size) >= 0) return size*512;
 
+       // FIXME: explain why lseek(SEEK_END) is not used here!
+
        // If not, do a binary search for the last location we can read.  (Some
        // block devices don't do BLKGETSIZE right.)
 
@@ -358,12 +202,11 @@ off_t fdlength(int fd)
 
                // If we can read from the current location, it's bigger.
 
-               if (lseek(fd, pos, 0)>=0 && safe_read(fd, &temp, 1)==1) {
+               if (lseek(fd, pos, SEEK_SET)>=0 && safe_read(fd, &temp, 1)==1) {
                        if (bottom == top) bottom = top = (top+1) * 2;
                        else bottom = pos;
 
                // If we can't, it's smaller.
-
                } else {
                        if (bottom == top) {
                                if (!top) return 0;
@@ -377,151 +220,110 @@ off_t fdlength(int fd)
 }
 #endif
 
-#ifdef L_xasprintf
-// Die with an error message if we can't malloc() enough space and do an
-// sprintf() into that space.
-char *xasprintf(const char *format, ...)
+int FAST_FUNC bb_putchar_stderr(char ch)
 {
-       va_list p;
-       int r;
-       char *string_ptr;
-
-#if 1
-       // GNU extension
-       va_start(p, format);
-       r = vasprintf(&string_ptr, format, p);
-       va_end(p);
-#else
-       // Bloat for systems that haven't got the GNU extension.
-       va_start(p, format);
-       r = vsnprintf(NULL, 0, format, p);
-       va_end(p);
-       string_ptr = xmalloc(r+1);
-       va_start(p, format);
-       r = vsnprintf(string_ptr, r+1, format, p);
-       va_end(p);
-#endif
-
-       if (r < 0) bb_error_msg_and_die(bb_msg_memory_exhausted);
-       return string_ptr;
+       return write(STDERR_FILENO, &ch, 1);
 }
-#endif
 
-#ifdef L_xprint_and_close_file
-// Die with an error message if we can't copy an entire FILE * to stdout, then
-// close that file.
-void xprint_and_close_file(FILE *file)
+ssize_t FAST_FUNC full_write1_str(const char *str)
 {
-       // copyfd outputs error messages for us.
-       if (bb_copyfd_eof(fileno(file), 1) == -1)
-               exit(bb_default_error_retval);
-
-       fclose(file);
+       return full_write(STDOUT_FILENO, str, strlen(str));
 }
-#endif
 
-#ifdef L_xchdir
-// Die if we can't chdir to a new path.
-void xchdir(const char *path)
+ssize_t FAST_FUNC full_write2_str(const char *str)
 {
-       if (chdir(path))
-               bb_perror_msg_and_die("chdir(%s)", path);
+       return full_write(STDERR_FILENO, str, strlen(str));
 }
-#endif
 
-#ifdef L_warn_opendir
-// Print a warning message if opendir() fails, but don't die.
-DIR *warn_opendir(const char *path)
+static int wh_helper(int value, int def_val, const char *env_name, int *err)
 {
-       DIR *dp;
-
-       if ((dp = opendir(path)) == NULL) {
-               bb_perror_msg("unable to open `%s'", path);
-               return NULL;
+       if (value == 0) {
+               char *s = getenv(env_name);
+               if (s) {
+                       value = atoi(s);
+                       /* If LINES/COLUMNS are set, pretend that there is
+                        * no error getting w/h, this prevents some ugly
+                        * cursor tricks by our callers */
+                       *err = 0;
+               }
        }
-       return dp;
+       if (value <= 1 || value >= 30000)
+               value = def_val;
+       return value;
 }
-#endif
 
-#ifdef L_xopendir
-// Die with an error message if opendir() fails.
-DIR *xopendir(const char *path)
+/* It is perfectly ok to pass in a NULL for either width or for
+ * height, in which case that value will not be set.  */
+int FAST_FUNC get_terminal_width_height(int fd, unsigned *width, unsigned *height)
 {
-       DIR *dp;
+       struct winsize win;
+       int err;
 
-       if ((dp = opendir(path)) == NULL)
-               bb_perror_msg_and_die("unable to open `%s'", path);
-       return dp;
+       win.ws_row = 0;
+       win.ws_col = 0;
+       /* I've seen ioctl returning 0, but row/col is (still?) 0.
+        * We treat that as an error too.  */
+       err = ioctl(fd, TIOCGWINSZ, &win) != 0 || win.ws_row == 0;
+       if (height)
+               *height = wh_helper(win.ws_row, 24, "LINES", &err);
+       if (width)
+               *width = wh_helper(win.ws_col, 80, "COLUMNS", &err);
+       return err;
 }
-#endif
-
-#ifdef L_xdaemon
-#ifndef BB_NOMMU
-// Die with an error message if we can't daemonize.
-void xdaemon(int nochdir, int noclose)
+int FAST_FUNC get_terminal_width(int fd)
 {
-       if (daemon(nochdir, noclose)) bb_perror_msg_and_die("daemon");
+       unsigned width;
+       get_terminal_width_height(fd, &width, NULL);
+       return width;
 }
-#endif
-#endif
 
-#ifdef L_xsocket
-// Die with an error message if we can't open a new socket.
-int xsocket(int domain, int type, int protocol)
+int FAST_FUNC tcsetattr_stdin_TCSANOW(const struct termios *tp)
 {
-       int r = socket(domain, type, protocol);
+       return tcsetattr(STDIN_FILENO, TCSANOW, tp);
+}
 
-       if (r < 0) bb_perror_msg_and_die("socket");
+pid_t FAST_FUNC safe_waitpid(pid_t pid, int *wstat, int options)
+{
+       pid_t r;
 
+       do
+               r = waitpid(pid, wstat, options);
+       while ((r == -1) && (errno == EINTR));
        return r;
 }
-#endif
 
-#ifdef L_xbind
-// Die with an error message if we can't bind a socket to an address.
-void xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
+pid_t FAST_FUNC wait_any_nohang(int *wstat)
 {
-       if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
+       return safe_waitpid(-1, wstat, WNOHANG);
 }
-#endif
 
-#ifdef L_xlisten
-// Die with an error message if we can't listen for connections on a socket.
-void xlisten(int s, int backlog)
+// Wait for the specified child PID to exit, returning child's error return.
+int FAST_FUNC wait4pid(pid_t pid)
 {
-       if (listen(s, backlog)) bb_perror_msg_and_die("listen");
-}
-#endif
+       int status;
 
-#ifdef L_xstat
-// xstat() - a stat() which dies on failure with meaningful error message
-void xstat(char *name, struct stat *stat_buf)
-{
-       if (stat(name, stat_buf))
-               bb_perror_msg_and_die("Can't stat '%s'", name);
+       if (pid <= 0) {
+               /*errno = ECHILD; -- wrong. */
+               /* we expect errno to be already set from failed [v]fork/exec */
+               return -1;
+       }
+       if (safe_waitpid(pid, &status, 0) == -1)
+               return -1;
+       if (WIFEXITED(status))
+               return WEXITSTATUS(status);
+       if (WIFSIGNALED(status))
+               return WTERMSIG(status) + 0x180;
+       return 0;
 }
-#endif
 
-#ifdef L_get_terminal_width_height
-/* It is perfectly ok to pass in a NULL for either width or for
- *  * height, in which case that value will not be set.  */
-int get_terminal_width_height(int fd, int *width, int *height)
+// Useful when we do know that pid is valid, and we just want to wait
+// for it to exit. Not existing pid is fatal. waitpid() status is not returned.
+int FAST_FUNC wait_for_exitstatus(pid_t pid)
 {
-       struct winsize win = { 0, 0, 0, 0 };
-       int ret = ioctl(fd, TIOCGWINSZ, &win);
-       if (!win.ws_row) {
-               char *s = getenv("LINES");
-               if (s) win.ws_row = atoi(s);
-       }
-       if (win.ws_row <= 1) win.ws_row = 24;
-       if (!win.ws_col) {
-               char *s = getenv("COLUMNS");
-               if (s) win.ws_col = atoi(s);
-       }
-       if (win.ws_col <= 1) win.ws_col = 80;
-       if (height) *height = (int) win.ws_row;
-       if (width) *width = (int) win.ws_col;
+       int exit_status, n;
 
-       return ret;
+       n = safe_waitpid(pid, &exit_status, 0);
+       if (n < 0)
+               bb_perror_msg_and_die("waitpid");
+       return exit_status;
 }
-#endif