ccanlint: optimize the timeout case
[ccan] / tools / tools.c
1 #include <ccan/talloc/talloc.h>
2 #include <ccan/grab_file/grab_file.h>
3 #include <ccan/noerr/noerr.h>
4 #include <ccan/read_write_all/read_write_all.h>
5 #include <ccan/noerr/noerr.h>
6 #include <sys/stat.h>
7 #include <sys/types.h>
8 #include <sys/time.h>
9 #include <sys/wait.h>
10 #include <fcntl.h>
11 #include <string.h>
12 #include <unistd.h>
13 #include <stdarg.h>
14 #include <errno.h>
15 #include <err.h>
16 #include <unistd.h>
17 #include "tools.h"
18
19 static char *tmpdir = NULL;
20 static unsigned int count;
21
22 /* Ten minutes. */
23 const unsigned int default_timeout_ms = 10 * 60 * 1000;
24
25 char *talloc_basename(const void *ctx, const char *dir)
26 {
27         char *p = strrchr(dir, '/');
28
29         if (!p)
30                 return (char *)dir;
31         return talloc_strdup(ctx, p+1);
32 }
33
34 char *talloc_dirname(const void *ctx, const char *dir)
35 {
36         char *p = strrchr(dir, '/');
37
38         if (!p)
39                 return talloc_strdup(ctx, ".");
40         return talloc_strndup(ctx, dir, p - dir);
41 }
42
43 char *talloc_getcwd(const void *ctx)
44 {
45         unsigned int len;
46         char *cwd;
47
48         /* *This* is why people hate C. */
49         len = 32;
50         cwd = talloc_array(ctx, char, len);
51         while (!getcwd(cwd, len)) {
52                 if (errno != ERANGE) {
53                         talloc_free(cwd);
54                         return NULL;
55                 }
56                 cwd = talloc_realloc(ctx, cwd, char, len *= 2);
57         }
58         return cwd;
59 }
60
61 static void killme(int sig)
62 {
63         kill(-getpid(), SIGKILL);
64 }
65
66 static char *run_with_timeout(const void *ctx,
67                               const char *cmd,
68                               bool *ok,
69                               unsigned *timeout_ms)
70 {
71         pid_t pid;
72         int p[2];
73         char *ret;
74         int status, ms;
75         struct timeval start, end;
76
77         *ok = false;
78         if (pipe(p) != 0)
79                 return talloc_asprintf(ctx, "Failed to create pipe: %s",
80                                        strerror(errno));
81
82         gettimeofday(&start, NULL);
83         pid = fork();
84         if (pid == -1) {
85                 close_noerr(p[0]);
86                 close_noerr(p[1]);
87                 return talloc_asprintf(ctx, "Failed to fork: %s",
88                                        strerror(errno));
89                 return NULL;
90         }
91
92         if (pid == 0) {
93                 struct itimerval itim;
94
95                 if (dup2(p[1], STDOUT_FILENO) != STDOUT_FILENO
96                     || dup2(p[1], STDERR_FILENO) != STDERR_FILENO
97                     || close(p[0]) != 0
98                     || close(STDIN_FILENO) != 0
99                     || open("/dev/null", O_RDONLY) != STDIN_FILENO)
100                         exit(128);
101
102                 setpgid(0, 0);
103                 signal(SIGALRM, killme);
104                 itim.it_interval.tv_sec = itim.it_interval.tv_usec = 0;
105                 itim.it_value.tv_sec = *timeout_ms / 1000;
106                 itim.it_value.tv_usec = (*timeout_ms % 1000) * 1000;
107                 setitimer(ITIMER_REAL, &itim, NULL);
108
109                 status = system(cmd);
110                 if (WIFEXITED(status))
111                         exit(WEXITSTATUS(status));
112                 /* Here's a hint... */
113                 exit(128 + WTERMSIG(status));
114         }
115
116         close(p[1]);
117         ret = grab_fd(ctx, p[0], NULL);
118         /* This shouldn't fail... */
119         if (waitpid(pid, &status, 0) != pid)
120                 err(1, "Failed to wait for child");
121
122         gettimeofday(&end, NULL);
123         if (end.tv_usec < start.tv_usec) {
124                 end.tv_usec += 1000000;
125                 end.tv_sec--;
126         }
127         ms = (end.tv_sec - start.tv_sec) * 1000
128                 + (end.tv_usec - start.tv_usec) / 1000;
129         if (ms > *timeout_ms)
130                 *timeout_ms = 0;
131         else
132                 *timeout_ms -= ms;
133
134         *ok = (WIFEXITED(status) && WEXITSTATUS(status) == 0);
135         return ret;
136 }
137
138 /* Returns output if command fails. */
139 char *run_command(const void *ctx, unsigned int *time_ms, const char *fmt, ...)
140 {
141         va_list ap;
142         char *cmd, *contents;
143         bool ok;
144         unsigned int default_time = default_timeout_ms;
145
146         if (!time_ms)
147                 time_ms = &default_time;
148         else if (*time_ms == 0)
149                 return talloc_strdup(ctx, "\n== TIMED OUT ==\n");
150
151         va_start(ap, fmt);
152         cmd = talloc_vasprintf(ctx, fmt, ap);
153         va_end(ap);
154
155         contents = run_with_timeout(ctx, cmd, &ok, time_ms);
156         if (ok) {
157                 talloc_free(contents);
158                 return NULL;
159         }
160
161         if (!contents)
162                 err(1, "Problem running child");
163         if (*time_ms == 0)
164                 contents = talloc_asprintf_append(contents,
165                                                   "\n== TIMED OUT ==\n");
166         return contents;
167 }
168
169 static int unlink_all(char *dir)
170 {
171         char cmd[strlen(dir) + sizeof("rm -rf ")];
172         sprintf(cmd, "rm -rf %s", dir);
173         if (system(cmd) != 0)
174                 warn("Could not remove temporary work in %s", dir);
175         return 0;
176 }
177
178 char *temp_file(const void *ctx, const char *extension)
179 {
180         /* For first call, create dir. */
181         while (!tmpdir) {
182                 tmpdir = getenv("TMPDIR");
183                 if (!tmpdir)
184                         tmpdir = "/tmp";
185                 tmpdir = talloc_asprintf(talloc_autofree_context(),
186                                          "%s/ccanlint-%u.%lu",
187                                          tmpdir, getpid(), random());
188                 if (mkdir(tmpdir, 0700) != 0) {
189                         if (errno == EEXIST) {
190                                 talloc_free(tmpdir);
191                                 tmpdir = NULL;
192                                 continue;
193                         }
194                         err(1, "mkdir %s failed", tmpdir);
195                 }
196                 talloc_set_destructor(tmpdir, unlink_all);
197         }
198
199         return talloc_asprintf(ctx, "%s/%u%s", tmpdir, count++, extension);
200 }
201
202 bool move_file(const char *oldname, const char *newname)
203 {
204         char *contents;
205         size_t size;
206         int fd;
207         bool ret;
208
209         /* Simple case: rename works. */
210         if (rename(oldname, newname) == 0)
211                 return true;
212
213         /* Try copy and delete: not atomic! */
214         contents = grab_file(NULL, oldname, &size);
215         if (!contents)
216                 return false;
217
218         fd = open(newname, O_WRONLY|O_CREAT|O_TRUNC, 0666);
219         if (fd < 0) {
220                 ret = false;
221                 goto free;
222         }
223
224         ret = write_all(fd, contents, size);
225         if (close(fd) != 0)
226                 ret = false;
227
228         if (ret)
229                 unlink(oldname);
230         else
231                 unlink(newname);
232
233 free:
234         talloc_free(contents);
235         return ret;
236 }