2 * "Interpreter" that you can put in #! like this
3 * #!/usr/bin/prefork-interp [<options>] <interpreter>
6 * prefork-interp [<option> ..] <interpreter> [<script> [<args> ...]]
7 * prefork-interp [<option>,..],<interpreter> <script> [<args> ...]
8 * prefork-interp '[<option> ..] <interpreter>' <script> [<args> ...]
12 * client (C wrapper) connects to server
13 * (including reading ack byte)
15 * === acquire lock ===
16 * makes new listening socket
17 * makes first-instance socketpair
18 * forks setup (script, sock fds indicated in env)
19 * fd0, fd1, fd2: from-outer
20 * other fd: call(client-end)(fake)
21 * reaps setup (and reports error)
22 * (implicitly releases lock)
24 * setup (pre-exec) fd0: null,
25 * fd[12]: fd2-from-outer
26 * env fds: listener, call(server-end)(fake)
27 * env fds: orig-fd[01]
30 * setup (script) runs initialisation parts of the script
31 * at prefork establishment point:
32 * setup (pm) [1] opens syslog
36 # server (pm) [1] [fd0: null],
37 * [fd[12]: fd2-from-outer]
38 * right away, forks one fa-monitor
39 * [2] closes outer caller fds and call(fake)
40 * [server (pm)] fd[012]: null
41 * other fds: listener, syslog
42 * runs in loop accepting and forking,
43 * reaping and limiting children (incl fa-monitor)
44 * reports failures of monitors to syslog
46 * f-a monitor forks executor
48 * [fd[12]: fd2-from-outer]
49 * [other fds: call(server-end)(fake), syslog]
50 * runs as monitor, below
53 * [client (C wrapper)] if client connect succeeds:
54 * now fd: call(client-end)
55 * sends message with: cmdline, env
58 * [server (script)] accepts, forks monitor
60 * monitor [1] [fd[012]: null]
61 * other fds: syslog, call(server-end)
63 * receives args, env, fds
66 * executor sorts out fds:
67 * fd0, fd1, fd2: from-outer
68 * close fds: call(server-end)
69 * retained fds: syslog
72 * runs main part of script
75 * [monitor] [fd[012]: null]
76 * [other fds: call(server-end), syslog]
78 * reports status via socket
80 * [client (C wrapper)] [fd0, fd1, fd2: from-outer]
81 * [other fd: call(client-end)]
82 * receives status, exits appropriately
83 * (if was bad signal, reports to stderr, exits 127)
86 #include <arpa/inet.h>
90 const char our_name[] = "prefork-interp";
92 struct sockaddr_un sockaddr_sun;
96 static const char *const *executor_argv;
98 void fusagemessage(FILE *f) {
99 fprintf(f, "usage: #!/usr/bin/prefork-interp [<options>]\n");
102 const struct cmdinfo cmdinfos[]= {
107 static void propagate_exit_status(int status, const char *what) {
110 if (WIFEXITED(status)) {
114 if (WIFSIGNALED(status)) {
115 int sig = WTERMSIG(status);
116 const char *signame = strsignal(sig);
117 if (signame == 0) signame = "unknown signal";
119 if (! WCOREDUMP(status) &&
126 sa.sa_handler = SIG_DFL;
127 r = sigaction(sig, &sa, 0);
128 if (r) diee("failed to reset signal handler while propagating %s",
133 sigaddset(&sset, sig);
134 r = sigprocmask(SIG_UNBLOCK, &sset, 0);
135 if (r) diee("failed to reset signal block while propagating %s",
139 die("unexpectedly kept running after raising (to propagate) %s",
143 die("%s failed due to signal %d %s%s", what, sig, signame,
144 WCOREDUMP(status) ? " (core dumped)" : "");
147 die("%s failed with weird wait status %d 0x%x", what, status, status);
150 static __attribute((noreturn)) void die_data_overflow(void) {
151 die("cannot handle data with length >2^32");
154 static void prepare_data(size_t *len, char **buf,
155 const void *data, size_t dl) {
157 if (dl >= SIZE_MAX - *len)
162 memcpy(*buf, data, dl);
167 static void prepare_length(size_t *len, char **buf, size_t dl_sz) {
168 if (dl_sz > UINT32_MAX) die_data_overflow();
169 uint32_t dl = htonl(dl_sz);
170 prepare_data(len, buf, &dl, sizeof(dl));
173 static void prepare_string(size_t *len, char **buf, const char *s) {
174 size_t sl = strlen(s);
175 prepare_data(len, buf, s, sl+1);
178 static void prepare_message(size_t *len, char **buf) {
181 const char *const *p = (void*)environ;
184 prepare_string(len, buf, s);
187 prepare_string(len, buf, "");
191 prepare_string(len, buf, s);
194 static void send_fd(FILE *call_sock, int payload_fd) {
195 int via_fd = fileno(call_sock);
198 struct cmsghdr align;
199 char buf[CMSG_SPACE(sizeof(payload_fd))];
209 iov.iov_base = &dummy_byte;
215 msg.msg_control = cmsg_buf.buf;
216 msg.msg_controllen = sizeof(cmsg_buf.buf);
218 struct cmsghdr *cmsg = CMSG_FIRSTHDR(&msg);
219 cmsg->cmsg_level = SOL_SOCKET;
220 cmsg->cmsg_type = SCM_RIGHTS;
221 cmsg->cmsg_len = CMSG_LEN(sizeof(payload_fd));
222 *(int*)CMSG_DATA(cmsg) = payload_fd;
224 msg.msg_controllen = sizeof(cmsg_buf.buf);
227 ssize_t r = sendmsg(via_fd, &msg, 0);
229 if (errno == EINTR) continue;
237 static void send_request(FILE *call_sock) {
238 // Sending these first makes it easier for the script to
239 // use buffered IO for the message.
240 send_fd(call_sock, 0);
241 send_fd(call_sock, 1);
242 send_fd(call_sock, 2);
245 prepare_message(&len, 0);
246 char *m = malloc(len);
247 if (!m) diee("failed to allocate for message");
249 prepare_length(0, &p, len - 4);
250 prepare_message(0, &p);
251 assert(p == m + len);
253 ssize_t sr = fwrite(p, len, 1, call_sock);
254 if (sr != 1) diee("write request");
257 static FILE *call_sock_from_fd(int fd) {
260 FILE *call_sock = fdopen(fd, "r+");
261 if (!call_sock) diee("fdopen socket");
263 r = setvbuf(call_sock, 0, _IONBF, 0);
264 if (r) die("setvbuf socket");
269 static bool was_eof(FILE *call_sock) {
270 return feof(call_sock) || errno==ECONNRESET;
273 // Returns: call(client-end), or 0 to mean "is garbage"
274 // find_socket_path must have been called
275 static FILE *connect_existing(void) {
280 fd = socket(AF_UNIX, SOCK_STREAM, 0);
281 if (fd==-1) diee("socket() for client");
283 socklen_t salen = sizeof(sockaddr_sun);
284 r = connect(fd, (const struct sockaddr*)&sockaddr_sun, salen);
286 if (errno==ECONNREFUSED || errno==ENOENT) goto x_garbage;
287 diee("connect() %s", socket_path);
290 call_sock = call_sock_from_fd(fd);
294 size_t sr = fread(&ack, sizeof(ack), 1, call_sock);
296 if (was_eof(call_sock)) goto x_garbage;
297 diee("read() ack byte");
299 if (ack != '\n') die("got ack byte 0x%02x, not '\n'", ack);
301 // We're committed now, send the request (or bail out)
302 send_request(call_sock);
307 if (call_sock) fclose(call_sock);
308 if (fd >= 0) close(fd);
312 static __attribute__((noreturn))
313 void become_setup(int sfd, int fake_pair[2]) {
315 int call_fd = fake_pair[1];
317 int fd0_save = dup(0); if (fd0_save < 0) diee("dup stdin");
318 int fd1_save = dup(1); if (fd1_save < 0) diee("dup stdin");
320 int null_0 = open("/dev/null", O_RDONLY); if (null_0 < 0) diee("open null");
321 if (dup2(null_0, 0)) diee("dup2 /dev/null onto stdin");
322 if (dup2(2, 1) != 1) die("dup2 stderr onto stdout");
324 putenv(m_asprintf("PREFORK_INTERP=%d,%d,%d,%d,%s",
325 sfd, call_fd, fd0_save, fd1_save, socket_path));
327 execvp(executor_argv[0], (char**)executor_argv);
328 diee("execute %s", executor_argv[0]);
331 static FILE *connect_or_spawn(void) {
334 FILE *call_sock = connect_existing();
335 if (call_sock) return call_sock;
337 int lockfd = acquire_lock();
338 call_sock = connect_existing();
339 if (call_sock) { close(lockfd); return call_sock; }
341 // We must start a fresh one, and we hold the lock
343 r = unlink(socket_path);
344 if (r<0 && errno!=ENOENT)
345 diee("failed to remove stale socket %s", socket_path);
348 r = socketpair(AF_UNIX, SOCK_STREAM, 0, fake_pair);
349 if (r<0) diee("socketpair() for fake initial connection");
351 int sfd = socket(AF_UNIX, SOCK_STREAM, 0);
352 if (sfd<0) diee("socket() for new listener");
354 socklen_t salen = sizeof(sockaddr_sun);
355 r= bind(sfd, (const struct sockaddr*)&sockaddr_sun, salen);
356 if (r<0) diee("bind() on new listener");
358 // We never want callers to get ECONNREFUSED. But:
359 // There is a race here: from my RTFM they may get ECONNREFUSED
360 // if they try between our bind() and listen(). But if they do, they'll
361 // acquire the lock (serialising with us) and retry, and then it will work.
362 r = listen(sfd, INT_MAX);
363 if (r<0) diee("listen() for new listener");
365 pid_t setup_pid = fork();
366 if (setup_pid == (pid_t)-1) diee("fork for spawn setup");
367 if (!setup_pid) become_setup(sfd, fake_pair);
372 pid_t got = waitpid(setup_pid, &status, 0);
373 if (got == (pid_t)-1) diee("waitpid setup [%ld]", (long)setup_pid);
374 if (got != setup_pid) diee("waitpid setup [%ld] gave [%ld]!",
375 (long)setup_pid, (long)got);
376 if (status != 0) propagate_exit_status(status, "setup");
379 return call_sock_from_fd(fake_pair[0]);
382 static void make_executor_argv(const char *const *argv) {
384 #define EACH_NEW_ARG(EACH) { \
385 arg = interp; { EACH } \
386 if ((arg = script)) { EACH } \
387 const char *const *walk = argv; \
388 while ((arg = *walk++)) { EACH } \
392 EACH_NEW_ARG( (void)arg; count++; );
394 const char **out = calloc(count, sizeof(char*));
395 executor_argv = (const char* const*)out;
396 if (!executor_argv) diee("allocate for arguments");
398 EACH_NEW_ARG( *out++ = arg; );
402 int main(int argc_unused, const char *const *argv) {
409 // which ought to be passed on to the actual executor.
410 make_executor_argv(argv);
413 FILLZERO(sockaddr_sun);
414 sockaddr_sun.sun_family = AF_UNIX;
415 assert(strlen(socket_path) <= sizeof(sockaddr_sun.sun_path));
416 strncpy(sockaddr_sun.sun_path, socket_path, sizeof(sockaddr_sun.sun_path));
418 FILE *call_sock = connect_or_spawn();
420 ssize_t sr = fread(&status, sizeof(status), 1, call_sock);
422 if (was_eof(call_sock)) die("per-call server monitor process quit");
423 diee("read status from call socket");
426 status = ntohl(status);
427 if (status > INT_MAX) die("status 0x%lx does not fit in an int",
428 (unsigned long)status);
430 propagate_exit_status(status, "invocation");