d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

MFC: r268745,r268746,r268747,r268748,r268749,r268861,r268750,r268751,r268763

Browse Source 
r273769,r273771,r276771,r278810

New BSDL timeout(1) utility compatible with GNU timeout

Relnotes:	yes
This commit is contained in:
bapt 2015-09-02 05:45:47 +00:00
parent 49c820db70
commit 326626fa22
7 changed files with 727 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
etc/mtree/BSD.tests.dist
View File

@ -323,6 +323,8 @@
..
..
..
timeout
..
variables
modifier_M
..

1
usr.bin/Makefile
View File

@ -157,6 +157,7 @@ SUBDIR= alias \
tee \
${_tests} \
time \
timeout \
tip \
top \
touch \

11
usr.bin/timeout/Makefile Normal file
View File

@ -0,0 +1,11 @@
# $FreeBSD$
.include <bsd.own.mk>
PROG= timeout
.if ${MK_TESTS} != "no"
SUBDIR+= tests
.endif
.include <bsd.prog.mk>

7
usr.bin/timeout/tests/Makefile Normal file
View File

@ -0,0 +1,7 @@
# $FreeBSD$
TESTSDIR= ${TESTSBASE}/usr.bin/timeout
ATF_TESTS_SH= timeout
.include <bsd.test.mk>

215
usr.bin/timeout/tests/timeout.sh Normal file
View File

@ -0,0 +1,215 @@
# $FreeBSD$
atf_test_case nominal
nominal_head()
{
atf_set "descr" "Basic tests on timeout(1) utility"
}
nominal_body()
{
atf_check \
-o empty \
-e empty \
-s exit:0 \
-x timeout 5 true
}
atf_test_case time_unit
time_unit_head()
{
atf_set "descr" "Test parsing the default time unit"
}
time_unit_body()
{
atf_check \
-o empty \
-e empty \
-s exit:0 \
-x timeout 1d true
atf_check \
-o empty \
-e empty \
-s exit:0 \
-x timeout 1h true
atf_check \
-o empty \
-e empty \
-s exit:0 \
-x timeout 1m true
atf_check \
-o empty \
-e empty \
-s exit:0 \
-x timeout 1s true
}
atf_test_case no_timeout
no_timeout_head()
{
atf_set "descr" "Test disabled timeout"
}
no_timeout_body()
{
atf_check \
-o empty \
-e empty \
-s exit:0 \
-x timeout 0 true
}
atf_test_case exit_numbers
exit_numbers_head()
{
atf_set "descr" "Test exit numbers"
}
exit_numbers_body()
{
atf_check \
-o empty \
-e empty \
-s exit:2 \
-x timeout 5 sh -c \'exit 2\'
atf_check \
-o empty \
-e empty \
-s exit:124 \
-x timeout .1 sleep 1
# With preserv status exit shoudl be 128 + TERM aka 143
atf_check \
-o empty \
-e empty \
-s exit:143 \
-x timeout --preserve-status .1 sleep 10
atf_check \
-o empty \
-e empty \
-s exit:124 \
-x timeout -s1 -k1 .1 sleep 10
atf_check \
-o empty \
-e empty \
-s exit:0 \
-x sh -c 'trap "" CHLD; exec timeout 10 true'
}
atf_test_case with_a_child
with_a_child_head()
{
atf_set "descr" "When starting with a child (coreutils bug#9098)"
}
with_a_child_body()
{
out=$(sleep .1 & exec timeout .5 sh -c 'sleep 2; echo foo')
status=$?
test "$out" = "" && test $status = 124 || atf_fail
}
atf_test_case invalid_timeout
invalid_timeout_head()
{
atf_set "descr" "Invalid timeout"
}
invalid_timeout_body()
{
atf_check \
-o empty \
-e inline:"timeout: invalid duration\n" \
-s exit:125 \
-x timeout invalid sleep 0
atf_check \
-o empty \
-e inline:"timeout: invalid duration\n" \
-s exit:125 \
-x timeout --kill-after=invalid 1 sleep 0
atf_check \
-o empty \
-e inline:"timeout: invalid duration\n" \
-s exit:125 \
-x timeout 42D sleep 0
atf_check \
-o empty \
-e inline:"timeout: invalid duration\n" \
-s exit:125 \
-x timeout 999999999999999999999999999999999999999999999999999999999999d sleep 0
atf_check \
-o empty \
-e inline:"timeout: invalid duration\n" \
-s exit:125 \
-x timeout 2.34e+5d sleep 0
}
atf_test_case invalid_signal
invalid_signal_head()
{
atf_set "descr" "Invalid signal"
}
invalid_signal_body()
{
atf_check \
-o empty \
-e inline:"timeout: invalid signal\n" \
-s exit:125 \
-x timeout --signal=invalid 1 sleep 0
}
atf_test_case invalid_command
invalid_command_head()
{
atf_set "descr" "Invalid command"
}
invalid_command_body()
{
atf_check \
-o empty \
-e inline:"timeout: exec(.): Permission denied\n" \
-s exit:126 \
-x timeout 10 .
}
atf_test_case no_such_command
no_such_command_head()
{
atf_set "descr" "No such command"
}
no_such_command_body()
{
atf_check \
-o empty \
-e inline:"timeout: exec(enoexists): No such file or directory\n" \
-s exit:127 \
-x timeout 10 enoexists
}
atf_init_test_cases()
{
atf_add_test_case nominal
atf_add_test_case time_unit
atf_add_test_case no_timeout
atf_add_test_case exit_numbers
atf_add_test_case with_a_child
atf_add_test_case invalid_timeout
atf_add_test_case invalid_signal
atf_add_test_case invalid_command
atf_add_test_case no_such_command
}

129
usr.bin/timeout/timeout.1 Normal file
View File

@ -0,0 +1,129 @@
.\" Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
.\" 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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
.\"
.\" $FreeBSD$
.\"
.Dd Oct 28, 2014
.Dt TIMEOUT 1
.Os
.Sh NAME
.Nm timeout
.Nd run a command with a time limit
.Sh SYNOPSIS
.Nm
.Op Fl -signal Ar sig | Fl s Ar sig
.Op Fl -preserve-status
.Op Fl -kill-after Ar time | Fl k Ar time
.Op Fl -foreground
.Ao Ar duration Ac
.Ao Ar command Ac
.Ao Ar args ... Ac
.Sh DESCRIPTION
.Nm
starts the
.Ar command
with its
.Ar args.
If
.Ar command
is still running after
.Ar duration ,
it is killed.
By default,
.Ar SIGTERM.
is sent.
.Bl -tag -width "-k time, --kill-after time"
.It Fl -preserve-status
Always exits with the same status as
.Ar command
even if it times out.
.It Fl -foreground
Do not propagate timeout to the
.Ar command
children.
.It Fl s Ar sig , Fl -signal Ar sig
Specify the signal to send on timeout.
By default,
.Ar SIGTERM .
is sent.
.It Fl k Ar time , Fl -kill-after Ar time
Send a second kill signal if
.Ar command
is still running after
.Ar time
after the first signal was sent.
.El
.Sh DURATION FORMAT
.Ar duration
and
.Ar time
can be integer or decimal numbers.
Values without unit symbols are interpreted as seconds.
.Pp
Supported unit symbols are:
.Bl -tag -width indent -compact
.It s
seconds
.It m
minutes
.It h
hours
.It d
days
.El
.Sh EXIT STATUS
If the timeout was not reached, the exit status of
.Ar command
is returned.
.Pp
If the timeout was reached and
.Fl -preserve-status
is set, the exit status of
.Ar command
is returned.
If
.Fl -preserve-status
is not set, an exit status of 124 is returned.
.Pp
If
.Ar command
exits after receiving a signal, the exit status returned is the signal number
plus 128.
.Pp
If
.Ar command
is an invalid command, the exit status returned is 126.
.Pp
If
.Ar command
is a non existing command, the exit status returned is 127.
.Pp
If an invalid parameter is passed to
.Fl s
or
.Fl k ,
the exit status return is 125.
.Sh SEE ALSO
.Xr kill 1 ,
.Xr signal 3

362
usr.bin/timeout/timeout.c Normal file
View File

@ -0,0 +1,362 @@
/*-
* Copyright (c) 2014 Baptiste Daroussin <bapt@FreeBSD.org>
* Copyright (c) 2014 Vsevolod Stakhov <vsevolod@FreeBSD.org>
* 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
* in this position and unchanged.
* 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.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``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 AUTHOR(S) 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 <sys/cdefs.h>
__FBSDID("$FreeBSD$");
#include <sys/procctl.h>
#include <sys/time.h>
#include <sys/wait.h>
#include <err.h>
#include <errno.h>
#include <getopt.h>
#include <signal.h>
#include <stdbool.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sysexits.h>
#include <unistd.h>
#define EXIT_TIMEOUT 124
static sig_atomic_t sig_chld = 0;
static sig_atomic_t sig_term = 0;
static sig_atomic_t sig_alrm = 0;
static sig_atomic_t sig_ign = 0;
static void
usage(void)
{
fprintf(stderr, "Usage: %s [--signal sig | -s sig] [--preserve-status]"
" [--kill-after time | -k time] [--foreground] <duration> <command>"
" <arg ...>\n", getprogname());
exit(EX_USAGE);
}
static double
parse_duration(const char *duration)
{
double ret;
char *end;
ret = strtod(duration, &end);
if (ret == 0 && end == duration)
errx(125, "invalid duration");
if (end == NULL || *end == '\0')
return (ret);
if (end != NULL && *(end + 1) != '\0')
errx(EX_USAGE, "invalid duration");
switch (*end) {
case 's':
break;
case 'm':
ret *= 60;
break;
case 'h':
ret *= 60 * 60;
break;
case 'd':
ret *= 60 * 60 * 24;
break;
default:
errx(125, "invalid duration");
}
if (ret < 0 || ret >= 100000000UL)
errx(125, "invalid duration");
return (ret);
}
static int
parse_signal(const char *str)
{
int sig, i;
const char *errstr;
sig = strtonum(str, 0, sys_nsig, &errstr);
if (errstr == NULL)
return (sig);
if (strncasecmp(str, "SIG", 3) == 0)
str += 3;
for (i = 1; i < sys_nsig; i++) {
if (strcasecmp(str, sys_signame[i]) == 0)
return (i);
}
errx(125, "invalid signal");
}
static void
sig_handler(int signo)
{
if (sig_ign != 0 && signo == sig_ign) {
sig_ign = 0;
return;
}
switch(signo) {
case 0:
case SIGINT:
case SIGHUP:
case SIGQUIT:
case SIGTERM:
sig_term = signo;
break;
case SIGCHLD:
sig_chld = 1;
break;
case SIGALRM:
sig_alrm = 1;
break;
}
}
static void
set_interval(double iv)
{
struct itimerval tim;
memset(&tim, 0, sizeof(tim));
tim.it_value.tv_sec = (time_t)iv;
iv -= (time_t)iv;
tim.it_value.tv_usec = (suseconds_t)(iv * 1000000UL);
if (setitimer(ITIMER_REAL, &tim, NULL) == -1)
err(EX_OSERR, "setitimer()");
}
int
main(int argc, char **argv)
{
int ch;
unsigned long i;
int foreground, preserve;
int error, pstat, status;
int killsig = SIGTERM;
pid_t pid, cpid;
double first_kill;
double second_kill;
bool timedout = false;
bool do_second_kill = false;
bool child_done = false;
struct sigaction signals;
struct procctl_reaper_status info;
struct procctl_reaper_kill killemall;
int signums[] = {
-1,
SIGTERM,
SIGINT,
SIGHUP,
SIGCHLD,
SIGALRM,
SIGQUIT,
};
foreground = preserve = 0;
second_kill = 0;
const struct option longopts[] = {
{ "preserve-status", no_argument, &preserve, 1 },
{ "foreground", no_argument, &foreground, 1 },
{ "kill-after", required_argument, NULL, 'k'},
{ "signal", required_argument, NULL, 's'},
{ "help", no_argument, NULL, 'h'},
{ NULL, 0, NULL, 0 }
};
while ((ch = getopt_long(argc, argv, "+k:s:h", longopts, NULL)) != -1) {
switch (ch) {
case 'k':
do_second_kill = true;
second_kill = parse_duration(optarg);
break;
case 's':
killsig = parse_signal(optarg);
break;
case 0:
break;
case 'h':
default:
usage();
break;
}
}
argc -= optind;
argv += optind;
if (argc < 2)
usage();
first_kill = parse_duration(argv[0]);
argc--;
argv++;
if (!foreground) {
/* Aquire a reaper */
if (procctl(P_PID, getpid(), PROC_REAP_ACQUIRE, NULL) == -1)
err(EX_OSERR, "Fail to acquire the reaper");
}
memset(&signals, 0, sizeof(signals));
sigemptyset(&signals.sa_mask);
if (killsig != SIGKILL && killsig != SIGSTOP)
signums[0] = killsig;
for (i = 0; i < sizeof(signums) / sizeof(signums[0]); i ++)
sigaddset(&signals.sa_mask, signums[i]);
signals.sa_handler = sig_handler;
signals.sa_flags = SA_RESTART;
for (i = 0; i < sizeof(signums) / sizeof(signums[0]); i ++)
if (signums[i] != -1 && signums[i] != 0 &&
sigaction(signums[i], &signals, NULL) == -1)
err(EX_OSERR, "sigaction()");
signal(SIGTTIN, SIG_IGN);
signal(SIGTTOU, SIG_IGN);
pid = fork();
if (pid == -1)
err(EX_OSERR, "fork()");
else if (pid == 0) {
/* child process */
signal(SIGTTIN, SIG_DFL);
signal(SIGTTOU, SIG_DFL);
error = execvp(argv[0], argv);
if (error == -1) {
if (errno == ENOENT)
err(127, "exec(%s)", argv[0]);
else
err(126, "exec(%s)", argv[0]);
}
}
if (sigprocmask(SIG_BLOCK, &signals.sa_mask, NULL) == -1)
err(EX_OSERR, "sigprocmask()");
/* parent continues here */
set_interval(first_kill);
for (;;) {
sigemptyset(&signals.sa_mask);
sigsuspend(&signals.sa_mask);
if (sig_chld) {
sig_chld = 0;
while ((cpid = waitpid(-1, &status, WNOHANG)) != 0) {
if (cpid < 0) {
if (errno == EINTR)
continue;
else
break;
} else if (cpid == pid) {
pstat = status;
child_done = true;
}
}
if (child_done) {
if (foreground) {
break;
} else {
procctl(P_PID, getpid(),
PROC_REAP_STATUS, &info);
if (info.rs_children == 0)
break;
}
}
} else if (sig_alrm) {
sig_alrm = 0;
timedout = true;
if (!foreground) {
killemall.rk_sig = killsig;
killemall.rk_flags = 0;
procctl(P_PID, getpid(), PROC_REAP_KILL,
&killemall);
} else
kill(pid, killsig);
if (do_second_kill) {
set_interval(second_kill);
second_kill = 0;
sig_ign = killsig;
killsig = SIGKILL;
} else
break;
} else if (sig_term) {
if (!foreground) {
killemall.rk_sig = sig_term;
killemall.rk_flags = 0;
procctl(P_PID, getpid(), PROC_REAP_KILL,
&killemall);
} else
kill(pid, sig_term);
if (do_second_kill) {
set_interval(second_kill);
second_kill = 0;
sig_ign = killsig;
killsig = SIGKILL;
} else
break;
}
}
while (!child_done && wait(&pstat) == -1) {
if (errno != EINTR)
err(EX_OSERR, "waitpid()");
}
if (!foreground)
procctl(P_PID, getpid(), PROC_REAP_RELEASE, NULL);
if (WEXITSTATUS(pstat))
pstat = WEXITSTATUS(pstat);
else if(WIFSIGNALED(pstat))
pstat = 128 + WTERMSIG(pstat);
if (timedout && !preserve)
pstat = EXIT_TIMEOUT;
return (pstat);
}