4e076f3d037be1d5e11b0b68a24127e7a9b1225d
[fw/sdcc] / support / regression / fwk / lib / timeout.c
1 /*-------------------------------------------------------------------------
2   timeout.c - source file for running ucSim within the regression tests
3
4              Written By -  Bernhard Held . bernhard@bernhardheld.de (2001)
5
6    This program is free software; you can redistribute it and/or modify it
7    under the terms of the GNU General Public License as published by the
8    Free Software Foundation; either version 2, or (at your option) any
9    later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program; if not, write to the Free Software
18    Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19
20    In other words, you are welcome to use, share and improve this program.
21    You are forbidden to forbid anyone else to use, share and improve
22    what you give them.   Help stamp out software-hoarding!
23 -------------------------------------------------------------------------*/
24
25 #define PROGNAME "timeout"
26
27 #define USAGE PROGNAME " : 1.00\n" \
28               "Usage : " PROGNAME " timeout_in_seconds filename [arguments]\n" \
29               "  ´filename´ is executed, the arguments are passed to ´filename´.\n" \
30               "  When ´filename´exits before the timeout expires, the\n" \
31               "  exit-status of ´filename´ is returned.\n" \
32               "  When the timeout expires before ´filename´ exits, ´filename´\n" \
33               "  will be killed and an exit-status of 1 is returned.\n"
34
35 /* First the program tries to limit the maximum CPU-time to the timeout-value.
36    Then the child is run with execvp().
37
38    It's not possible to limit the CPU-time under Cygwin (V1.3.3). If setrlimit (RLIMIT_CPU, rlp)
39    fails, the program will fork() and run the child with execvp(). The fork/exec pair is slow on
40    Cygwin, but what else can we do? The parent sleeps until:
41    - a signal shows the child´s exitus
42         The exit status of the child is returned.
43    - the timeout elapses
44         The child will be killed.
45 */
46
47 #include <signal.h>
48 #include <stdio.h>
49 #include <sys/wait.h>
50 #include <sys/types.h>
51 #include <sys/time.h>
52 #include <sys/resource.h>
53 #include <unistd.h>
54
55 /* Get the status from all child processes that have terminated, without ever waiting.
56    This function is designed to be a handler for SIGCHLD, the signal that indicates
57    that at least one child process has terminated.
58    http://www.cs.utah.edu/dept/old/texinfo/glibc-manual-0.02/library_23.html#SEC401
59 */
60
61 #ifndef WAIT_ANY
62   #define WAIT_ANY -1
63 #endif
64
65 void
66 sigchld_handler (int signum)
67 {
68   int pid;
69   int status;
70   int exit_status = 0;
71
72   while (1)
73     {
74       pid = waitpid (WAIT_ANY, &status, WNOHANG);
75       if (WEXITSTATUS (status))
76         exit_status = 1; // WEXITSTATUS(status);
77       /* pid == -1: no children               */
78       /* pid ==  0: no children to be noticed */
79       if (pid <= 0)
80         break;
81     }
82   exit (exit_status);
83 }
84
85 int
86 main (int argc, char * const *argv)
87 {
88   /* if getrlimit() / setrlimit() succeed, then no fork is neeeded */
89   int flagNoFork = 0;
90   int old_stderr;
91   long timeout;
92   pid_t pid_child;
93   struct rlimit rl;
94
95   if (argc < 3)
96     {
97       fprintf (stderr, USAGE);
98       return 1;
99     }
100   timeout = atol (argv[1]);
101   if (timeout == 0)
102     {
103       fprintf (stderr, "Error parameter " PROGNAME ": must be a non-zero dezimal value\n");
104       return 1;
105     }
106
107   /* try to use getrlimit() / setrlimit() for RLIMIT_CPU */
108   /* to limit the CPU-time                               */
109   if (getrlimit (RLIMIT_CPU, &rl) == 0)
110     {
111       rl.rlim_cur = timeout;
112       if (setrlimit (RLIMIT_CPU, &rl) == 0)
113         flagNoFork = 1;
114     }
115
116   if (flagNoFork)
117     { /* the CPU-time is limited: simple execvp */
118
119       /* s51 prints warnings on stderr:                                  */
120       /* serial input/output interface connected to a non-terminal file. */
121       /* We'll redirect here stderr to stdout, which will be redirected  */
122       /* to /dev/null by the shell. The shell could also redirect stderr */
123       /* to /dev/null, but then this program doesn't have the chance to  */
124       /* output any real error. */
125       old_stderr = dup (STDERR_FILENO);
126       dup2 (STDOUT_FILENO, STDERR_FILENO);
127       /* shouldn't return */
128       execvp (argv[2], argv + 2);
129       /* restore stderr */
130       dup2 (old_stderr, STDERR_FILENO);
131       perror (argv[2]);
132       return 1; /* Error */
133     }
134   else
135     {
136       /* do it the hard way: fork/exec */
137       signal (SIGCHLD, sigchld_handler);
138       pid_child = fork();
139       if (pid_child == 0)
140         {
141            /* s51 prints warnings on stderr:                                  */
142            /* serial input/output interface connected to a non-terminal file. */
143            /* We'll redirect here stderr to stdout, which will be redirected  */
144            /* to /dev/null by the shell. The shell could also redirect stderr */
145            /* to /dev/null, but then this program doesn't have the chance to  */
146            /* output any real error. */
147            old_stderr = dup (STDERR_FILENO);
148            dup2 (STDOUT_FILENO, STDERR_FILENO);
149            /* shouldn't return */
150            execvp (argv[2], argv + 2);
151            /* restore stderr */
152            dup2 (old_stderr, STDERR_FILENO);
153            perror (argv[2]);
154            return 1; /* Error */
155         }
156       else
157         {
158           /* this timeout is hopefully aborted by a SIGCHLD */
159           sleep (timeout);
160           fprintf (stderr, PROGNAME ": timeout, killing child %s\n", argv[2]);
161           kill (pid_child, SIGTERM);
162           return 1; /* Error */
163         }
164     }
165 }