1 /* vi: set sw=4 ts=4: */
2 /* `time' utility to display resource usage of processes.
3 Copyright (C) 1990, 91, 92, 93, 96 Free Software Foundation, Inc.
5 Licensed under GPL version 2, see file LICENSE in this tarball for details.
7 /* Originally written by David Keppel <pardo@cs.washington.edu>.
8 Heavily modified by David MacKenzie <djm@gnu.ai.mit.edu>.
9 Heavily modified for busybox by Erik Andersen <andersen@codepoet.org>
14 /* Information on the resources used by a child process. */
18 unsigned elapsed_ms; /* Wallclock time of process. */
21 /* msec = milliseconds = 1/1,000 (1*10e-3) second.
22 usec = microseconds = 1/1,000,000 (1*10e-6) second. */
24 #define UL unsigned long
26 static const char default_format[] ALIGN1 = "real\t%E\nuser\t%u\nsys\t%T";
28 /* The output format for the -p option .*/
29 static const char posix_format[] ALIGN1 = "real %e\nuser %U\nsys %S";
32 /* Format string for printing all statistics verbosely.
33 Keep this output to 24 lines so users on terminals can see it all.*/
34 static const char long_format[] ALIGN1 =
35 "\tCommand being timed: \"%C\"\n"
36 "\tUser time (seconds): %U\n"
37 "\tSystem time (seconds): %S\n"
38 "\tPercent of CPU this job got: %P\n"
39 "\tElapsed (wall clock) time (h:mm:ss or m:ss): %E\n"
40 "\tAverage shared text size (kbytes): %X\n"
41 "\tAverage unshared data size (kbytes): %D\n"
42 "\tAverage stack size (kbytes): %p\n"
43 "\tAverage total size (kbytes): %K\n"
44 "\tMaximum resident set size (kbytes): %M\n"
45 "\tAverage resident set size (kbytes): %t\n"
46 "\tMajor (requiring I/O) page faults: %F\n"
47 "\tMinor (reclaiming a frame) page faults: %R\n"
48 "\tVoluntary context switches: %w\n"
49 "\tInvoluntary context switches: %c\n"
51 "\tFile system inputs: %I\n"
52 "\tFile system outputs: %O\n"
53 "\tSocket messages sent: %s\n"
54 "\tSocket messages received: %r\n"
55 "\tSignals delivered: %k\n"
56 "\tPage size (bytes): %Z\n"
60 /* Wait for and fill in data on child process PID.
61 Return 0 on error, 1 if ok. */
63 /* pid_t is short on BSDI, so don't try to promote it. */
64 static int resuse_end(pid_t pid, resource_t *resp)
69 /* Ignore signals, but don't ignore the children. When wait3
70 returns the child process, set the time the command finished. */
71 while ((caught = wait3(&status, 0, &resp->ru)) != pid) {
72 if (caught == -1 && errno != EINTR)
75 resp->elapsed_ms = (monotonic_us() / 1000) - resp->elapsed_ms;
76 resp->waitstatus = status;
80 /* Print ARGV, with each entry in ARGV separated by FILLER. */
81 static void printargv(char *const *argv, const char *filler)
85 fputs(filler, stdout);
90 /* Return the number of kilobytes corresponding to a number of pages PAGES.
91 (Actually, we use it to convert pages*ticks into kilobytes*ticks.)
93 Try to do arithmetic so that the risk of overflow errors is minimized.
94 This is funky since the pagesize could be less than 1K.
95 Note: Some machines express getrusage statistics in terms of K,
96 others in terms of pages. */
98 static unsigned long ptok(unsigned long pages)
100 static unsigned long ps;
103 /* Initialization. */
108 if (pages > (LONG_MAX / ps)) { /* Could overflow. */
109 tmp = pages / 1024; /* Smaller first, */
110 return tmp * ps; /* then larger. */
112 /* Could underflow. */
113 tmp = pages * ps; /* Larger first, */
114 return tmp / 1024; /* then smaller. */
117 /* summarize: Report on the system use of a command.
119 Print the FMT argument except that `%' sequences
120 have special meaning, and `\n' and `\t' are translated into
121 newline and tab, respectively, and `\\' is translated into `\'.
123 The character following a `%' can be:
124 (* means the tcsh time builtin also recognizes it)
126 C == command name and arguments
127 * D == average unshared data size in K (ru_idrss+ru_isrss)
128 * E == elapsed real (wall clock) time in [hour:]min:sec
129 * F == major page faults (required physical I/O) (ru_majflt)
130 * I == file system inputs (ru_inblock)
131 * K == average total mem usage (ru_idrss+ru_isrss+ru_ixrss)
132 * M == maximum resident set size in K (ru_maxrss)
133 * O == file system outputs (ru_oublock)
134 * P == percent of CPU this job got (total cpu time / elapsed time)
135 * R == minor page faults (reclaims; no physical I/O involved) (ru_minflt)
136 * S == system (kernel) time (seconds) (ru_stime)
137 * T == system time in [hour:]min:sec
138 * U == user time (seconds) (ru_utime)
139 * u == user time in [hour:]min:sec
140 * W == times swapped out (ru_nswap)
141 * X == average amount of shared text in K (ru_ixrss)
143 * c == involuntary context switches (ru_nivcsw)
144 e == elapsed real time in seconds
145 * k == signals delivered (ru_nsignals)
146 p == average unshared stack size in K (ru_isrss)
147 * r == socket messages received (ru_msgrcv)
148 * s == socket messages sent (ru_msgsnd)
149 t == average resident set size in K (ru_idrss)
150 * w == voluntary context switches (ru_nvcsw)
151 x == exit status of command
153 Various memory usages are found by converting from page-seconds
154 to kbytes by multiplying by the page size, dividing by 1024,
155 and dividing by elapsed real time.
157 FMT is the format string, interpreted as described above.
158 COMMAND is the command and args that are being summarized.
159 RESP is resource information on the command. */
161 #ifndef TICKS_PER_SEC
162 #define TICKS_PER_SEC 100
165 static void summarize(const char *fmt, char **command, resource_t * resp)
167 unsigned vv_ms; /* Elapsed virtual (CPU) milliseconds */
168 unsigned cpu_ticks; /* Same, in "CPU ticks" */
170 if (WIFSTOPPED(resp->waitstatus))
171 printf("Command stopped by signal %u\n",
172 WSTOPSIG(resp->waitstatus));
173 else if (WIFSIGNALED(resp->waitstatus))
174 printf("Command terminated by signal %u\n",
175 WTERMSIG(resp->waitstatus));
176 else if (WIFEXITED(resp->waitstatus) && WEXITSTATUS(resp->waitstatus))
177 printf("Command exited with non-zero status %u\n",
178 WEXITSTATUS(resp->waitstatus));
180 vv_ms = (resp->ru.ru_utime.tv_sec + resp->ru.ru_stime.tv_sec) * 1000
181 + (resp->ru.ru_utime.tv_usec + resp->ru.ru_stime.tv_usec) / 1000;
183 #if (1000 / TICKS_PER_SEC) * TICKS_PER_SEC == 1000
184 /* 1000 is exactly divisible by TICKS_PER_SEC */
185 cpu_ticks = vv_ms / (1000 / TICKS_PER_SEC);
187 cpu_ticks = vv_ms * (unsigned long long)TICKS_PER_SEC / 1000;
189 if (!cpu_ticks) cpu_ticks = 1; /* we divide by it, must be nonzero */
192 /* Handle leading literal part */
193 int n = strcspn(fmt, "%\\");
195 printf("%.*s", n, fmt);
202 /* Handle literal char */
203 /* Usually we optimize for size, but there is a limit
204 * for everything. With this we do a lot of 1-byte writes */
212 #ifdef NOT_NEEDED_YET
213 /* Our format strings do not have these */
214 /* and we do not take format str from user */
223 case 'C': /* The command that got timed. */
224 printargv(command, " ");
226 case 'D': /* Average unshared data size. */
228 ptok((UL) resp->ru.ru_idrss) / cpu_ticks +
229 ptok((UL) resp->ru.ru_isrss) / cpu_ticks);
231 case 'E': { /* Elapsed real (wall clock) time. */
232 unsigned seconds = resp->elapsed_ms / 1000;
233 if (seconds >= 3600) /* One hour -> h:m:s. */
234 printf("%uh %um %02us",
236 (seconds % 3600) / 60,
239 printf("%um %u.%02us", /* -> m:s. */
242 (unsigned)(resp->elapsed_ms / 10) % 100);
245 case 'F': /* Major page faults. */
246 printf("%lu", resp->ru.ru_majflt);
248 case 'I': /* Inputs. */
249 printf("%lu", resp->ru.ru_inblock);
251 case 'K': /* Average mem usage == data+stack+text. */
253 ptok((UL) resp->ru.ru_idrss) / cpu_ticks +
254 ptok((UL) resp->ru.ru_isrss) / cpu_ticks +
255 ptok((UL) resp->ru.ru_ixrss) / cpu_ticks);
257 case 'M': /* Maximum resident set size. */
258 printf("%lu", ptok((UL) resp->ru.ru_maxrss));
260 case 'O': /* Outputs. */
261 printf("%lu", resp->ru.ru_oublock);
263 case 'P': /* Percent of CPU this job got. */
264 /* % cpu is (total cpu time)/(elapsed time). */
265 if (resp->elapsed_ms > 0)
266 printf("%u%%", (unsigned)(vv_ms * 100 / resp->elapsed_ms));
270 case 'R': /* Minor page faults (reclaims). */
271 printf("%lu", resp->ru.ru_minflt);
273 case 'S': /* System time. */
275 (unsigned)resp->ru.ru_stime.tv_sec,
276 (unsigned)(resp->ru.ru_stime.tv_usec / 10000));
278 case 'T': /* System time. */
279 if (resp->ru.ru_stime.tv_sec >= 3600) /* One hour -> h:m:s. */
280 printf("%uh %um %02us",
281 (unsigned)(resp->ru.ru_stime.tv_sec / 3600),
282 (unsigned)(resp->ru.ru_stime.tv_sec % 3600) / 60,
283 (unsigned)(resp->ru.ru_stime.tv_sec % 60));
285 printf("%um %u.%02us", /* -> m:s. */
286 (unsigned)(resp->ru.ru_stime.tv_sec / 60),
287 (unsigned)(resp->ru.ru_stime.tv_sec % 60),
288 (unsigned)(resp->ru.ru_stime.tv_usec / 10000));
290 case 'U': /* User time. */
292 (unsigned)resp->ru.ru_utime.tv_sec,
293 (unsigned)(resp->ru.ru_utime.tv_usec / 10000));
295 case 'u': /* User time. */
296 if (resp->ru.ru_utime.tv_sec >= 3600) /* One hour -> h:m:s. */
297 printf("%uh %um %02us",
298 (unsigned)(resp->ru.ru_utime.tv_sec / 3600),
299 (unsigned)(resp->ru.ru_utime.tv_sec % 3600) / 60,
300 (unsigned)(resp->ru.ru_utime.tv_sec % 60));
302 printf("%um %u.%02us", /* -> m:s. */
303 (unsigned)(resp->ru.ru_utime.tv_sec / 60),
304 (unsigned)(resp->ru.ru_utime.tv_sec % 60),
305 (unsigned)(resp->ru.ru_utime.tv_usec / 10000));
307 case 'W': /* Times swapped out. */
308 printf("%lu", resp->ru.ru_nswap);
310 case 'X': /* Average shared text size. */
311 printf("%lu", ptok((UL) resp->ru.ru_ixrss) / cpu_ticks);
313 case 'Z': /* Page size. */
314 printf("%u", getpagesize());
316 case 'c': /* Involuntary context switches. */
317 printf("%lu", resp->ru.ru_nivcsw);
319 case 'e': /* Elapsed real time in seconds. */
321 (unsigned)resp->elapsed_ms / 1000,
322 (unsigned)(resp->elapsed_ms / 10) % 100);
324 case 'k': /* Signals delivered. */
325 printf("%lu", resp->ru.ru_nsignals);
327 case 'p': /* Average stack segment. */
328 printf("%lu", ptok((UL) resp->ru.ru_isrss) / cpu_ticks);
330 case 'r': /* Incoming socket messages received. */
331 printf("%lu", resp->ru.ru_msgrcv);
333 case 's': /* Outgoing socket messages sent. */
334 printf("%lu", resp->ru.ru_msgsnd);
336 case 't': /* Average resident set size. */
337 printf("%lu", ptok((UL) resp->ru.ru_idrss) / cpu_ticks);
339 case 'w': /* Voluntary context switches. */
340 printf("%lu", resp->ru.ru_nvcsw);
342 case 'x': /* Exit status. */
343 printf("%u", WEXITSTATUS(resp->waitstatus));
348 #ifdef NOT_NEEDED_YET
349 case '\\': /* Format escape. */
374 /* Run command CMD and return statistics on it.
375 Put the statistics in *RESP. */
376 static void run_command(char *const *cmd, resource_t *resp)
378 pid_t pid; /* Pid of child. */
379 void (*interrupt_signal)(int);
380 void (*quit_signal)(int);
382 resp->elapsed_ms = monotonic_us() / 1000;
383 pid = vfork(); /* Run CMD as child process. */
385 bb_error_msg_and_die("cannot fork");
386 if (pid == 0) { /* If child. */
387 /* Don't cast execvp arguments; that causes errors on some systems,
388 versus merely warnings if the cast is left off. */
389 BB_EXECVP(cmd[0], cmd);
390 xfunc_error_retval = (errno == ENOENT ? 127 : 126);
391 bb_error_msg_and_die("cannot run %s", cmd[0]);
394 /* Have signals kill the child but not self (if possible). */
395 //TODO: just block all sigs? and reenable them in the very end in main?
396 interrupt_signal = signal(SIGINT, SIG_IGN);
397 quit_signal = signal(SIGQUIT, SIG_IGN);
399 if (resuse_end(pid, resp) == 0)
400 bb_error_msg("error waiting for child process");
402 /* Re-enable signals. */
403 signal(SIGINT, interrupt_signal);
404 signal(SIGQUIT, quit_signal);
407 int time_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
408 int time_main(int argc, char **argv)
411 const char *output_format = default_format;
415 /* Parse any options -- don't use getopt() here so we don't
416 * consume the args of our client application... */
417 while (argc > 0 && argv[0][0] == '-') {
418 while ((c = *++*argv)) {
421 output_format = long_format;
424 output_format = posix_format;
437 run_command(argv, &res);
439 /* Cheat. printf's are shorter :) */
440 /* (but see bb_putchar() body for additional wrinkle!) */
442 dup2(2, 1); /* just in case libc does something silly :( */
443 summarize(output_format, argv, &res);
445 if (WIFSTOPPED(res.waitstatus))
446 return WSTOPSIG(res.waitstatus);
447 if (WIFSIGNALED(res.waitstatus))
448 return WTERMSIG(res.waitstatus);
449 if (WIFEXITED(res.waitstatus))
450 return WEXITSTATUS(res.waitstatus);
451 fflush_stdout_and_exit(0);