diff options
Diffstat (limited to 'shell_cmds/time')
-rwxr-xr-x | shell_cmds/time/tests/test_time.sh | 60 | ||||
-rw-r--r-- | shell_cmds/time/time.1 | 116 | ||||
-rw-r--r-- | shell_cmds/time/time.c | 245 |
3 files changed, 421 insertions, 0 deletions
diff --git a/shell_cmds/time/tests/test_time.sh b/shell_cmds/time/tests/test_time.sh new file mode 100755 index 0000000..6cf002d --- /dev/null +++ b/shell_cmds/time/tests/test_time.sh @@ -0,0 +1,60 @@ +#!/bin/sh + +set -o nounset + +TIME="${TIME-/usr/bin/time}" +echo "SUITE: time(1)" +what $TIME +echo + +EXIT=0 + +echo TEST: check real time + +TIME_SLEEP=`$TIME 2>&1 sleep 1 | sed -n -E 's/[ ]+([0-9]+).*/\1/p'` +TIME_STATUS=$? + +if [ "$TIME_STATUS" -ne "0" ]; then + echo FAIL: time failed with "$TIME_STATUS" + EXIT=1 +fi + +if [ "$TIME_SLEEP" -lt "0" ]; then + echo FAIL: time mis-timed sleep + EXIT=2 +fi + +MONOTONIC=`sysctl -n kern.monotonic.task_thread_counting` +if [ "$MONOTONIC" -ne "0" ]; then + echo TEST: check instructions retired + + TIME_INSTRS=`$TIME -l 2>&1 sleep 1 | sed -E -n '/instructions/p'` + if [ -z "$TIME_INSTRS" ]; then + echo FAIL: time is not showing instructions retired + EXIT=3 + fi +else + echo SKIP: check instructions retired +fi + +# NB: SIGINT and SIGQUIT work locally, but the automated test harnesses tries to +# handle those signals itself before the fork. + +echo TEST: check child SIGUSR1 + +TIME_USR1=`$TIME 2>&1 sh -c 'kill -USR1 $$ && sleep 5 && true'` +TIME_STATUS=$? +if [ "$TIME_STATUS" -eq "0" ]; then + echo FAIL: time should allow child to receive SIGUSR1 + EXIT=4 +fi + +echo TEST: check non-existent binary +TIME_NONEXIST=`$TIME 2>&1 ./this-wont-exist` +TIME_STATUS=$? +if [ "$TIME_STATUS" -ne "127" ]; then + echo FAIL: time should error when measuring a non-existent command + EXIT=5 +fi + +exit $EXIT diff --git a/shell_cmds/time/time.1 b/shell_cmds/time/time.1 new file mode 100644 index 0000000..b4e7017 --- /dev/null +++ b/shell_cmds/time/time.1 @@ -0,0 +1,116 @@ +.\" $NetBSD: time.1,v 1.7 1997/10/20 03:28:20 lukem Exp $ +.\" +.\" Copyright (c) 1980, 1991, 1993 +.\" The Regents of the University of California. All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)time.1 8.1 (Berkeley) 6/6/93 +.\" +.Dd June 6, 1993 +.Dt TIME 1 +.Os +.Sh NAME +.Nm time +.Nd time command execution +.Sh SYNOPSIS +.Nm +.Op Fl lp +.Ar utility +.Sh DESCRIPTION +The +.Nm +utility +executes and +times +.Ar utility . +After the +.Ar utility +finishes, +.Nm +writes the total time elapsed, +the time consumed by system overhead, +and the time used to execute +.Ar utility +to the standard error stream. +Times are reported in seconds. +.Pp +Available options: +.Bl -tag -width Ds +.It Fl l +The contents of the +.Em rusage +structure are printed. +.It Fl p +The output is formatted as specified by +.St -p1003.2-92 . +.El +.Pp +Some shells may provide a builtin +.Nm +command which is similar or identical to this utility. +Consult the +.Xr builtin 1 +manual page. +.Sh DIAGNOSTICS +The +.Nm +utility shall exit with one of the following values: +.Bl -tag -width indent +.It 1-125 +An error occurred in the +.Nm +utility. +.It 126 +The +.Ar utility +was found but could not be invoked. +.It 127 +The +.Ar utility +could not be found. +.El +.Pp +Otherwise, the exit status of +.Nm +shall be that of +.Ar utility . +.Sh SEE ALSO +.Xr builtin 1 , +.Xr csh 1 , +.Xr getrusage 2 +.Sh FILES +.Bl -tag -width /usr/include/sys/resource.h -compact +.It Pa /usr/include/sys/resource.h +.El +.Sh STANDARDS +The +.Nm +utility conforms to +.St -p1003.2-92 . diff --git a/shell_cmds/time/time.c b/shell_cmds/time/time.c new file mode 100644 index 0000000..afaaed0 --- /dev/null +++ b/shell_cmds/time/time.c @@ -0,0 +1,245 @@ +/* $NetBSD: time.c,v 1.9 1997/10/20 03:28:21 lukem Exp $ */ + +/* + * Copyright (c) 1987, 1988, 1993 + * The Regents of the University of California. All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * 1. Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * 2. Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * 3. All advertising materials mentioning features or use of this software + * must display the following acknowledgement: + * This product includes software developed by the University of + * California, Berkeley and its contributors. + * 4. Neither the name of the University nor the names of its contributors + * may be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND + * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE + * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE + * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL + * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS + * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY + * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF + * SUCH DAMAGE. + */ + +#include <errno.h> +#include <err.h> +#include <inttypes.h> +#include <langinfo.h> +#include <libproc.h> +#include <locale.h> +#include <sys/cdefs.h> +#include <sysexits.h> +#include <sys/types.h> +#include <sys/time.h> +#include <sys/resource.h> +#include <sys/wait.h> +#include <signal.h> +#include <stdbool.h> +#include <stdio.h> +#include <stdint.h> +#include <stdlib.h> +#include <time.h> +#include <unistd.h> + +int lflag; +int portableflag; +bool child_running = true; + +void +child_handler(int sig) +{ + child_running = false; +} + +int +main(int argc, char **argv) +{ + int pid; + int ch, status, rusage_ret = -1; + uint64_t before_ns, after_ns, duration_ns, duration_secs, duration_frac_ns; + struct rusage ru; + struct rusage_info_v4 ruinfo; + sigset_t sigmask, suspmask, origmask; + + lflag = 0; + while ((ch = getopt(argc, argv, "lp")) != -1) { + switch((char)ch) { + case 'p': + portableflag = 1; + break; + case 'l': + lflag = 1; + break; + case '?': + default: + fprintf(stderr, "usage: time [-lp] <command>\n"); + exit(1); + } + } + + if (!(argc -= optind)) { + exit(0); + } + argv += optind; + + sigemptyset(&sigmask); + /* + * Block SIGCHLD so that the check for `child_running` doesn't miss the + * handler before calling `sigsuspend` and blocking forever. + */ + sigaddset(&sigmask, SIGCHLD); + sigprocmask(SIG_BLOCK, &sigmask, &origmask); + + /* + * Ensure child signals are handled by the parent prior to fork; otherwise, + * they could be missed between the child forking and calling `sigsuspend`. + */ + (void)signal(SIGCHLD, child_handler); + + sigemptyset(&suspmask); + + before_ns = clock_gettime_nsec_np(CLOCK_UPTIME_RAW); + /* + * NB: Don't add anything between these two lines -- measurement is + * happening now. + */ + switch (pid = vfork()) { + case -1: /* error */ + err(EX_OSERR, "time"); + __builtin_unreachable(); + case 0: /* child */ + /* + * Allow the child to respond to signals by resetting to the original + * signal handling behavior. + */ + (void)sigprocmask(SIG_SETMASK, &origmask, NULL); + execvp(*argv, argv); + perror(*argv); + _exit((errno == ENOENT) ? 127 : 126); + __builtin_unreachable(); + default: /* parent */ + break; + } + + /* + * Let the child handle signals that normally exit. + */ + (void)signal(SIGINT, SIG_IGN); + (void)signal(SIGQUIT, SIG_IGN); + + while (child_running) { + /* + * This would be racy, but SIGCHLD is blocked above (as part of + * `sigmask`. + */ + sigsuspend(&suspmask); + } + /* + * NB: Minimize what's added between these statements to preserve the + * accuracy of the time measurement. + */ + after_ns = clock_gettime_nsec_np(CLOCK_UPTIME_RAW); + if (lflag) { + rusage_ret = proc_pid_rusage(pid, RUSAGE_INFO_V4, (void **)&ruinfo); + } + while (wait3(&status, 0, &ru) != pid) { + } + if (!WIFEXITED(status)) { + fprintf(stderr, "Command terminated abnormally.\n"); + } + duration_ns = after_ns - before_ns; + duration_secs = duration_ns / (1000 * 1000 * 1000); + duration_frac_ns = duration_ns - (duration_secs * 1000 * 1000 * 1000); + + if (portableflag) { + char *radix = NULL; + + setlocale(LC_ALL, ""); + + radix = nl_langinfo(RADIXCHAR); + if (!radix || radix[0] == '\0') { + radix = "."; + } + + fprintf(stderr, "real %9" PRIu64 "%s%02" PRIu64 "\n", + duration_secs, radix, duration_frac_ns / (10 * 1000 * 1000)); + fprintf(stderr, "user %9ld%s%02ld\n", + (long)ru.ru_utime.tv_sec, radix, (long)ru.ru_utime.tv_usec/10000); + fprintf(stderr, "sys %9ld%s%02ld\n", + (long)ru.ru_stime.tv_sec, radix, (long)ru.ru_stime.tv_usec/10000); + } else { + fprintf(stderr, "%9" PRIu64 ".%02" PRIu64 " real ", + duration_secs, duration_frac_ns / (10 * 1000 * 1000)); + fprintf(stderr, "%9ld.%02ld user ", + (long)ru.ru_utime.tv_sec, (long)ru.ru_utime.tv_usec/10000); + fprintf(stderr, "%9ld.%02ld sys\n", + (long)ru.ru_stime.tv_sec, (long)ru.ru_stime.tv_usec/10000); + } + + if (lflag) { + int hz = 100; /* XXX */ + long ticks; + + ticks = hz * (ru.ru_utime.tv_sec + ru.ru_stime.tv_sec) + + hz * (ru.ru_utime.tv_usec + ru.ru_stime.tv_usec) / 1000000; + + fprintf(stderr, "%20ld %s\n", + ru.ru_maxrss, "maximum resident set size"); + fprintf(stderr, "%20ld %s\n", ticks ? ru.ru_ixrss / ticks : 0, + "average shared memory size"); + fprintf(stderr, "%20ld %s\n", ticks ? ru.ru_idrss / ticks : 0, + "average unshared data size"); + fprintf(stderr, "%20ld %s\n", ticks ? ru.ru_isrss / ticks : 0, + "average unshared stack size"); + fprintf(stderr, "%20ld %s\n", + ru.ru_minflt, "page reclaims"); + fprintf(stderr, "%20ld %s\n", + ru.ru_majflt, "page faults"); + fprintf(stderr, "%20ld %s\n", + ru.ru_nswap, "swaps"); + fprintf(stderr, "%20ld %s\n", + ru.ru_inblock, "block input operations"); + fprintf(stderr, "%20ld %s\n", + ru.ru_oublock, "block output operations"); + fprintf(stderr, "%20ld %s\n", + ru.ru_msgsnd, "messages sent"); + fprintf(stderr, "%20ld %s\n", + ru.ru_msgrcv, "messages received"); + fprintf(stderr, "%20ld %s\n", + ru.ru_nsignals, "signals received"); + fprintf(stderr, "%20ld %s\n", + ru.ru_nvcsw, "voluntary context switches"); + fprintf(stderr, "%20ld %s\n", + ru.ru_nivcsw, "involuntary context switches"); + + if (rusage_ret >= 0) { + if (ruinfo.ri_instructions > 0) { + fprintf(stderr, "%20" PRIu64 " %s\n", ruinfo.ri_instructions, + "instructions retired"); + } + if (ruinfo.ri_cycles > 0) { + fprintf(stderr, "%20" PRIu64 " %s\n", ruinfo.ri_cycles, + "cycles elapsed"); + } + if (ruinfo.ri_lifetime_max_phys_footprint > 0) { + fprintf(stderr, "%20" PRIu64 " %s\n", + ruinfo.ri_lifetime_max_phys_footprint, + "peak memory footprint"); + } + } + } + + exit(WIFEXITED(status) ? WEXITSTATUS(status) : EXIT_FAILURE); +} |