hexedit: new applet
[oweals/busybox.git] / miscutils / time.c
index cce7d5b3ebe2704df21b0285520cb42021f45216..65dbcdcf31ae0edc835a614441b061649430ed22 100644 (file)
@@ -2,14 +2,36 @@
 /* 'time' utility to display resource usage of processes.
    Copyright (C) 1990, 91, 92, 93, 96 Free Software Foundation, Inc.
 
-   Licensed under GPL version 2, see file LICENSE in this tarball for details.
+   Licensed under GPLv2, see file LICENSE in this source tree.
 */
 /* Originally written by David Keppel <pardo@cs.washington.edu>.
    Heavily modified by David MacKenzie <djm@gnu.ai.mit.edu>.
    Heavily modified for busybox by Erik Andersen <andersen@codepoet.org>
 */
+//config:config TIME
+//config:      bool "time (7 kb)"
+//config:      default y
+//config:      help
+//config:      The time command runs the specified program with the given arguments.
+//config:      When the command finishes, time writes a message to standard output
+//config:      giving timing statistics about this program run.
+
+//applet:IF_TIME(APPLET(time, BB_DIR_USR_BIN, BB_SUID_DROP))
+
+//kbuild:lib-$(CONFIG_TIME) += time.o
+
+//usage:#define time_trivial_usage
+//usage:       "[-vpa] [-o FILE] PROG ARGS"
+//usage:#define time_full_usage "\n\n"
+//usage:       "Run PROG, display resource usage when it exits\n"
+//usage:     "\n       -v      Verbose"
+//usage:     "\n       -p      POSIX output format"
+//usage:     "\n       -f FMT  Custom format"
+//usage:     "\n       -o FILE Write result to FILE"
+//usage:     "\n       -a      Append (else overwrite)"
 
 #include "libbb.h"
+#include <sys/resource.h> /* getrusage */
 
 /* Information on the resources used by a child process.  */
 typedef struct {
@@ -63,14 +85,14 @@ static void resuse_end(pid_t pid, resource_t *resp)
        pid_t caught;
 
        /* Ignore signals, but don't ignore the children.  When wait3
-          returns the child process, set the time the command finished. */
+        * returns the child process, set the time the command finished. */
        while ((caught = wait3(&resp->waitstatus, 0, &resp->ru)) != pid) {
                if (caught == -1 && errno != EINTR) {
                        bb_perror_msg("wait");
                        return;
                }
        }
-       resp->elapsed_ms = (monotonic_us() / 1000) - resp->elapsed_ms;
+       resp->elapsed_ms = monotonic_ms() - resp->elapsed_ms;
 }
 
 static void printargv(char *const *argv)
@@ -89,7 +111,7 @@ static void printargv(char *const *argv)
    This is funky since the pagesize could be less than 1K.
    Note: Some machines express getrusage statistics in terms of K,
    others in terms of pages.  */
-static unsigned long ptok(unsigned pagesize, unsigned long pages)
+static unsigned long ptok(const unsigned pagesize, const unsigned long pages)
 {
        unsigned long tmp;
 
@@ -105,13 +127,13 @@ static unsigned long ptok(unsigned pagesize, unsigned long pages)
 
 /* summarize: Report on the system use of a command.
 
-   Print the FMT argument except that `%' sequences
-   have special meaning, and `\n' and `\t' are translated into
-   newline and tab, respectively, and `\\' is translated into `\'.
+   Print the FMT argument except that '%' sequences
+   have special meaning, and '\n' and '\t' are translated into
+   newline and tab, respectively, and '\\' is translated into '\'.
 
-   The character following a `%' can be:
+   The character following a '%' can be:
    (* means the tcsh time builtin also recognizes it)
-   % == a literal `%'
+   % == a literal '%'
    C == command name and arguments
 *  D == average unshared data size in K (ru_idrss+ru_isrss)
 *  E == elapsed real (wall clock) time in [hour:]min:sec
@@ -303,7 +325,7 @@ static void summarize(const char *fmt, char **command, resource_t *resp)
                                printf("%lu", ptok(pagesize, (UL) resp->ru.ru_ixrss) / cpu_ticks);
                                break;
                        case 'Z':       /* Page size.  */
-                               printf("%u", getpagesize());
+                               printf("%u", pagesize);
                                break;
                        case 'c':       /* Involuntary context switches.  */
                                printf("%lu", resp->ru.ru_nivcsw);
@@ -367,24 +389,19 @@ static void summarize(const char *fmt, char **command, resource_t *resp)
    Put the statistics in *RESP.  */
 static void run_command(char *const *cmd, resource_t *resp)
 {
-       pid_t pid;                      /* Pid of child.  */
+       pid_t pid;
        void (*interrupt_signal)(int);
        void (*quit_signal)(int);
 
-       resp->elapsed_ms = monotonic_us() / 1000;
-       pid = vfork();          /* Run CMD as child process.  */
-       if (pid < 0)
-               bb_perror_msg_and_die("fork");
-       if (pid == 0) { /* If child.  */
-               /* Don't cast execvp arguments; that causes errors on some systems,
-                  versus merely warnings if the cast is left off.  */
-               BB_EXECVP(cmd[0], cmd);
-               xfunc_error_retval = (errno == ENOENT ? 127 : 126);
-               bb_error_msg_and_die("cannot run %s", cmd[0]);
+       resp->elapsed_ms = monotonic_ms();
+       pid = xvfork();
+       if (pid == 0) {
+               /* Child */
+               BB_EXECVP_or_die((char**)cmd);
        }
 
        /* Have signals kill the child but not self (if possible).  */
-//TODO: just block all sigs? and reenable them in the very end in main?
+//TODO: just block all sigs? and re-enable them in the very end in main?
        interrupt_signal = signal(SIGINT, SIG_IGN);
        quit_signal = signal(SIGQUIT, SIG_IGN);
 
@@ -396,33 +413,54 @@ static void run_command(char *const *cmd, resource_t *resp)
 }
 
 int time_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
-int time_main(int argc ATTRIBUTE_UNUSED, char **argv)
+int time_main(int argc UNUSED_PARAM, char **argv)
 {
        resource_t res;
-       const char *output_format = default_format;
+       /* $TIME has lowest prio (-v,-p,-f FMT overrride it) */
+       const char *output_format = getenv("TIME") ? : default_format;
+       char *output_filename;
+       int output_fd;
        int opt;
+       int ex;
+       enum {
+               OPT_v = (1 << 0),
+               OPT_p = (1 << 1),
+               OPT_a = (1 << 2),
+               OPT_o = (1 << 3),
+               OPT_f = (1 << 4),
+       };
 
        /* "+": stop on first non-option */
-       opt = getopt32(argv, "+vp");
+       opt = getopt32(argv, "^+" "vpao:f:" "\0" "-1"/*at least one arg*/,
+                               &output_filename, &output_format
+       );
        argv += optind;
-       if (opt & 1)
+       if (opt & OPT_v)
                output_format = long_format;
-       if (opt & 2)
+       if (opt & OPT_p)
                output_format = posix_format;
+       output_fd = STDERR_FILENO;
+       if (opt & OPT_o) {
+               output_fd = xopen(output_filename,
+                       (opt & OPT_a) /* append? */
+                       ? (O_CREAT | O_WRONLY | O_CLOEXEC | O_APPEND)
+                       : (O_CREAT | O_WRONLY | O_CLOEXEC | O_TRUNC)
+               );
+       }
 
        run_command(argv, &res);
 
        /* Cheat. printf's are shorter :) */
-       /* (but see bb_putchar() body for additional wrinkle!) */
-       xdup2(2, 1); /* just in case libc does something silly :( */
-       stdout = stderr;
+       xdup2(output_fd, STDOUT_FILENO);
        summarize(output_format, argv, &res);
 
+       ex = WEXITSTATUS(res.waitstatus);
+       /* Impossible: we do not use WUNTRACED flag in wait()...
        if (WIFSTOPPED(res.waitstatus))
-               return WSTOPSIG(res.waitstatus);
+               ex = WSTOPSIG(res.waitstatus);
+       */
        if (WIFSIGNALED(res.waitstatus))
-               return WTERMSIG(res.waitstatus);
-       if (WIFEXITED(res.waitstatus))
-               return WEXITSTATUS(res.waitstatus);
-       fflush_stdout_and_exit(EXIT_SUCCESS);
+               ex = WTERMSIG(res.waitstatus);
+
+       fflush_stdout_and_exit(ex);
 }