Introduce FEATURE_EXEC_PREFER_APPLETS = "re-execute our own
[oweals/busybox.git] / libbb / xfuncs.c
index efc919491c78f16ba200f8a4e897d59a3621e6ba..4252e7646bd7c29e8ee10d9c67c53e908fe0d175 100644 (file)
@@ -57,7 +57,7 @@ char * xstrdup(const char *s)
        if (s == NULL)
                return NULL;
 
-       t = strdup (s);
+       t = strdup(s);
 
        if (t == NULL)
                bb_error_msg_and_die(bb_msg_memory_exhausted);
@@ -69,22 +69,33 @@ char * xstrdup(const char *s)
 // the (possibly truncated to length n) string into it.
 char * xstrndup(const char *s, int n)
 {
+       int m;
        char *t;
 
        if (ENABLE_DEBUG && s == NULL)
                bb_error_msg_and_die("xstrndup bug");
 
-       t = xmalloc(++n);
+       /* We can just xmalloc(n+1) and strncpy into it, */
+       /* but think about xstrndup("abc", 10000) wastage! */
+       m = n;
+       t = (char*) s;
+       while (m) {
+               if (!*t) break;
+               m--; t++;
+       }
+       n = n - m;
+       t = xmalloc(n + 1);
+       t[n] = '\0';
 
-       return safe_strncpy(t,s,n);
+       return memcpy(t,s,n);
 }
 
 // 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)
+       FILE *fp = fopen(path, mode);
+       if (fp == NULL)
                bb_perror_msg_and_die("%s", path);
        return fp;
 }
@@ -92,10 +103,10 @@ FILE *xfopen(const char *path, const char *mode)
 // 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");
+       //if (ENABLE_DEBUG && (flags & O_CREAT))
+       //      bb_error_msg_and_die("xopen() with O_CREAT");
 
-       return xopen3(pathname, flags, 0777);
+       return xopen3(pathname, flags, 0666);
 }
 
 // Die if we can't open a new file and return an fd.
@@ -110,18 +121,19 @@ int xopen3(const char *pathname, int flags, int mode)
        return ret;
 }
 
-// Die with an error message if we can't read the entire buffer.
-void xread(int fd, void *buf, size_t count)
+// Turn on nonblocking I/O on a fd
+int ndelay_on(int fd)
 {
-       if (count) {
-               ssize_t size = full_read(fd, buf, count);
-               if (size != count)
-                       bb_error_msg_and_die("short read");
-       }
+       return fcntl(fd,F_SETFL,fcntl(fd,F_GETFL,0) | O_NONBLOCK);
+}
+
+int ndelay_off(int fd)
+{
+       return fcntl(fd,F_SETFL,fcntl(fd,F_GETFL,0) & ~O_NONBLOCK);
 }
 
 // Die with an error message if we can't write the entire buffer.
-void xwrite(int fd, void *buf, size_t count)
+void xwrite(int fd, const void *buf, size_t count)
 {
        if (count) {
                ssize_t size = full_write(fd, buf, count);
@@ -131,34 +143,29 @@ void xwrite(int fd, void *buf, size_t count)
 }
 
 // Die with an error message if we can't lseek to the right spot.
-void xlseek(int fd, off_t offset, int whence)
+off_t xlseek(int fd, off_t offset, int whence)
 {
-       if (offset != lseek(fd, offset, whence))
-               bb_error_msg_and_die("lseek");
-}
-
-// 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;
+       off_t off = lseek(fd, offset, whence);
+       if (off == (off_t)-1) {
+               if (whence == SEEK_SET)
+                       bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
+               bb_perror_msg_and_die("lseek");
+       }
+       return off;
 }
 
-// Die with supplied error message if this FILE * has ferror set.
-void xferror(FILE *fp, const char *fn)
+// Die with supplied filename if this FILE * has ferror set.
+void die_if_ferror(FILE *fp, const char *fn)
 {
        if (ferror(fp)) {
-               bb_error_msg_and_die("%s", fn);
+               bb_error_msg_and_die("%s: I/O error", fn);
        }
 }
 
 // Die with an error message if stdout has ferror set.
-void xferror_stdout(void)
+void die_if_ferror_stdout(void)
 {
-       xferror(stdout, bb_msg_standard_output);
+       die_if_ferror(stdout, bb_msg_standard_output);
 }
 
 // Die with an error message if we have trouble flushing stdout.
@@ -173,25 +180,33 @@ void xfflush_stdout(void)
 // -1 for failure.  Runs argv[0], searching path if that has no / in it.
 pid_t spawn(char **argv)
 {
+       /* Why static? */
        static int failed;
        pid_t pid;
-       void *app = ENABLE_FEATURE_SH_STANDALONE_SHELL ? find_applet_by_name(argv[0]) : 0;
+       char *prog;
 
        // Be nice to nommu machines.
        failed = 0;
        pid = vfork();
        if (pid < 0) return pid;
        if (!pid) {
-               execvp(app ? CONFIG_BUSYBOX_EXEC_PATH : *argv, argv);
+               prog = argv[0];
+               if (ENABLE_FEATURE_EXEC_PREFER_APPLETS && find_applet_by_name(prog))
+                       prog = CONFIG_BUSYBOX_EXEC_PATH;
+               execvp(prog, 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;
+               failed = errno;
                _exit(0);
        }
-       return failed ? failed : pid;
+       if (failed) {
+               errno = failed;
+               return -1;
+       }
+       return pid;
 }
 
 // Die with an error message if we can't spawn a child process.
@@ -219,23 +234,69 @@ void xsetenv(const char *key, const char *value)
                bb_error_msg_and_die(bb_msg_memory_exhausted);
 }
 
+// Converts unsigned long long value into compact 4-char
+// representation. Examples: "1234", "1.2k", " 27M", "123T"
+// Fifth char is always '\0'
+void smart_ulltoa5(unsigned long long ul, char buf[5])
+{
+       char *fmt;
+       char c;
+       unsigned v,idx = 0;
+       ul *= 10;
+       if (ul > 9999*10) { // do not scale if 9999 or less
+               while (ul >= 10000) {
+                       ul /= 1024;
+                       idx++;
+               }
+       }
+       v = ul; // ullong divisions are expensive, avoid them
+
+       fmt = " 123456789";
+       if (!idx) {             // 9999 or less: use 1234 format
+               c = buf[0] = " 123456789"[v/10000];
+               if (c!=' ') fmt = "0123456789";
+               c = buf[1] = fmt[v/1000%10];
+               if (c!=' ') fmt = "0123456789";
+               buf[2] = fmt[v/100%10];
+               buf[3] = "0123456789"[v/10%10];
+       } else {
+               if (v>=10*10) { // scaled value is >=10: use 123M format
+                       c = buf[0] = " 123456789"[v/1000];
+                       if (c!=' ') fmt = "0123456789";
+                       buf[1] = fmt[v/100%10];
+                       buf[2] = "0123456789"[v/10%10];
+               } else {        // scaled value is <10: use 1.2M format
+                       buf[0] = "0123456789"[v/10];
+                       buf[1] = '.';
+                       buf[2] = "0123456789"[v%10];
+               }
+               // see http://en.wikipedia.org/wiki/Tera
+               buf[3] = " kMGTPEZY"[idx];
+       }
+       buf[4] = '\0';
+}
+
 // 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 BUG_sizeof_unsigned_not_4(void);
 void utoa_to_buf(unsigned n, char *buf, unsigned buflen)
 {
-       int i, out = 0;
+       unsigned i, out, res;
+       if (sizeof(unsigned) != 4)
+               BUG_sizeof_unsigned_not_4();
        if (buflen) {
-               for (i=1000000000; i; i/=10) {
-                       int res = n/i;
-
-                       if ((res || out || i == 1) && --buflen>0) {
+               out = 0;
+               for (i = 1000000000; i; i /= 10) {
+                       res = n / i;
+                       if (res || out || i == 1) {
+                               if (!--buflen) break;
                                out++;
                                n -= res*i;
                                *buf++ = '0' + res;
                        }
                }
-               *buf = 0;
+               *buf = '\0';
        }
 }
 
@@ -275,6 +336,19 @@ char *itoa(int n)
        return local_buf;
 }
 
+// Emit a string of hex representation of bytes
+char *bin2hex(char *p, const char *cp, int count)
+{
+       while (count) {
+               unsigned char c = *cp++;
+               /* put lowercase hex digits */
+               *p++ = 0x10 | bb_hexdigits_upcase[c >> 4];
+               *p++ = 0x10 | bb_hexdigits_upcase[c & 0xf];
+               count--;
+       }
+       return p;
+}
+
 // 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.)
@@ -283,7 +357,7 @@ 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.)
+// Die with an error message if we can't set uid.  (See xsetgid() for why.)
 void xsetuid(uid_t uid)
 {
        if (setuid(uid)) bb_error_msg_and_die("setuid");
@@ -299,6 +373,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.)
 
@@ -309,7 +385,7 @@ 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;
 
@@ -355,10 +431,42 @@ char *xasprintf(const char *format, ...)
        return string_ptr;
 }
 
+#if 0 /* If we will ever meet a libc which hasn't [f]dprintf... */
+int fdprintf(int fd, const char *format, ...)
+{
+       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) {
+               full_write(fd, string_ptr, r);
+               free(string_ptr);
+       }
+       return r;
+}
+#endif
+
 // 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)
 {
+       fflush(stdout);
        // copyfd outputs error messages for us.
        if (bb_copyfd_eof(fileno(file), 1) == -1)
                exit(xfunc_error_retval);
@@ -379,7 +487,7 @@ DIR *warn_opendir(const char *path)
        DIR *dp;
 
        if ((dp = opendir(path)) == NULL) {
-               bb_perror_msg("unable to open `%s'", path);
+               bb_perror_msg("cannot open '%s'", path);
                return NULL;
        }
        return dp;
@@ -391,7 +499,7 @@ DIR *xopendir(const char *path)
        DIR *dp;
 
        if ((dp = opendir(path)) == NULL)
-               bb_perror_msg_and_die("unable to open `%s'", path);
+               bb_perror_msg_and_die("cannot open '%s'", path);
        return dp;
 }
 
@@ -399,10 +507,43 @@ DIR *xopendir(const char *path)
 // Die with an error message if we can't daemonize.
 void xdaemon(int nochdir, int noclose)
 {
-       if (daemon(nochdir, noclose)) bb_perror_msg_and_die("daemon");
+       if (daemon(nochdir, noclose))
+               bb_perror_msg_and_die("daemon");
 }
 #endif
 
+void bb_sanitize_stdio_maybe_daemonize(int daemonize)
+{
+       int fd;
+       /* Mega-paranoid */
+       fd = xopen(bb_dev_null, O_RDWR);
+       while (fd < 2)
+               fd = dup(fd); /* have 0,1,2 open at least to /dev/null */
+       if (daemonize) {
+               pid_t pid = fork();
+               if (pid < 0) /* wtf? */
+                       bb_perror_msg_and_die("fork");
+               if (pid) /* parent */
+                       exit(0);
+               /* child */
+               /* if daemonizing, make sure we detach from stdio */
+               setsid();
+               dup2(fd, 0);
+               dup2(fd, 1);
+               dup2(fd, 2);
+       }
+       while (fd > 2)
+               close(fd--); /* close everything after fd#2 */
+}
+void bb_sanitize_stdio(void)
+{
+       bb_sanitize_stdio_maybe_daemonize(0);
+}
+void bb_daemonize(void)
+{
+       bb_sanitize_stdio_maybe_daemonize(1);
+}
+
 // Die with an error message if we can't open a new socket.
 int xsocket(int domain, int type, int protocol)
 {
@@ -433,23 +574,31 @@ void xstat(char *name, struct stat *stat_buf)
 }
 
 /* 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)
+ * height, in which case that value will not be set.  */
+int get_terminal_width_height(const int fd, int *width, int *height)
 {
        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 (height) {
+               if (!win.ws_row) {
+                       char *s = getenv("LINES");
+                       if (s) win.ws_row = atoi(s);
+               }
+               if (win.ws_row <= 1 || win.ws_row >= 30000)
+                       win.ws_row = 24;
+               *height = (int) win.ws_row;
        }
-       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 (width) {
+               if (!win.ws_col) {
+                       char *s = getenv("COLUMNS");
+                       if (s) win.ws_col = atoi(s);
+               }
+               if (win.ws_col <= 1 || win.ws_col >= 30000)
+                       win.ws_col = 80;
+               *width = (int) win.ws_col;
        }
-       if (win.ws_col <= 1) win.ws_col = 80;
-       if (height) *height = (int) win.ws_row;
-       if (width) *width = (int) win.ws_col;
 
        return ret;
 }