* prefork-interp [<option> ..] <interpreter> [<script> [<args> ...]]
* prefork-interp [<option>,..],<interpreter> <script> [<args> ...]
* prefork-interp '[<option> ..] <interpreter>' <script> [<args> ...]
+ *
+ * Options must specify argument laundering mode.
+ * Currently the only mode supported is:
+ * -U unlaundered: setup and executor both get all arguments and env vars
+ * ident covers only env vars specified with -E
+ * ident covers only arguments interpreter and (if present) script
*/
/*
* Process structure:
* client (C wrapper) connects to server
* (including reading ack byte)
* if fails or garbage
- * === acquire lock ===
- * makes new listening socket
- * makes first-instance socketpair
+ * === acquires lock ===
+ * makes new listening socket
+ * makes watcher pipes
+ * forks watcher and awaits
+ * makes first-instance socketpair
* forks setup (script, sock fds indicated in env)
- * fd0, fd1, fd2: from-outer-caller
+ * fd0, fd1, fd2: from-outer
* other fd: call(client-end)(fake)
* reaps setup (and reports error)
* (implicitly releases lock)
*
+ * watcher fd[012]: watcher pipes
+ * starts watch on socket path
+ * sets stderr to line buffered
+ * sets stdin to nonblocking
+ * daemonises (one fork, becomes session leader)
+ * when socket stat changes, quit
+ *
* setup (pre-exec) fd0: null,
- * fd[12: fd2-from-outer-caller
- * env fds: listener, call(server-end)(fake)
- * env fds: orig-fd[01]
+ * fd[12]: fd2-from-outer
+ * env fds: listener, call(server-end)(fake),
+ * watcher read, watcher write
* close fd: lockfile
+ * possibly clean env, argv
*
* setup (script) runs initialisation parts of the script
* at prefork establishment point:
* forks for server
* [2] exits
*
- # server (pm) [1] [fd0: null],
- * [fd[12: fd2-from-outer-caller]
- * right away, forks one fa-monitor
+ * server (pm) [1] [fd0: null],
+ * [fd[12]: fd2-from-outer]
+ * setsid
+ * right away, forks init monitor
* [2] closes outer caller fds and call(fake)
* [server (pm)] fd[012]: null
* other fds: listener, syslog
* runs in loop accepting and forking,
- * reaping and limiting children (incl fa-monitor)
+ * reaping and limiting children (incl init monitor)
* reports failures of monitors to syslog
*
- * f-a monitor forks executor
- * closes fd: listener
- * [fd[12: fd2-from-outer-caller]
- * [other fds: call(server-end)(fake), syslog]
- * runs as monitor, below
- *
- *
* [client (C wrapper)] if client connect succeeds:
* now fd: call(client-end)
* sends message with: cmdline, env
* sends fds
*
- * [server (script)] accepts, forks monitor
+ * [server (script)] accepts, forks subseq monitor
*
- * monitor [1] [fd[012]: null]
- * other fds: syslog, call(server-end)
+ * monitor [1] [fd0: null]
+ * (init [fd[12]: init: fd2-from-outer; subseq: null]
+ * or errors: init: fd2; subseq: syslog
+ * subseq) other fds: syslog, call(server-end)
* sends ack byte
* receives args, env, fds
* forks executor
*
* executor sorts out fds:
- * fd0, fd1, fd2: from-outer-caller
+ * fd0, fd1, fd2: from-outer
* close fds: call(server-end)
* retained fds: syslog
*
* exits normally
*
* [monitor] [fd[012]: null]
- * [other fds: call(server-end), syslog]
+ * [fd[12]: init: fd2-from-outer; subseq: null]
+ * [errors: init: fd2; subseq: syslog]
* reaps executor
* reports status via socket
*
- * [client (C wrapper)] [fd0, fd1, fd2: from-outer-caller]
+ * [client (C wrapper)] [fd0, fd1, fd2: from-outer]
* [other fd: call(client-end)]
* receives status, exits appropriately
* (if was bad signal, reports to stderr, exits 127)
#include <arpa/inet.h>
+#include <uv.h>
+
#include "prefork.h"
-struct sockaddr_un sun;
+const char our_name[] = "prefork-interp";
+
+static struct sockaddr_un sockaddr_sun;
+static FILE *call_sock;
#define ACK_BYTE '\n'
-static struct sockaddr_unix socket_sun;
static const char *const *executor_argv;
+static const char header_magic[4] = "PFI\n";
+
+void fusagemessage(FILE *f) {
+ fprintf(f, "usage: #!/usr/bin/prefork-interp [<options>]\n");
+}
+
+static int laundering;
+static struct stat initial_stab;
+
+const struct cmdinfo cmdinfos[]= {
+ PREFORK_CMDINFOS
+ { 0, 'U', 0, .iassignto= &laundering, .arg= 'U' },
+ { 0 }
+};
+
+void ident_addinit(void) {
+ char ident_magic[1] = { 0 };
+ sha256_update(&identsc, sizeof(ident_magic), ident_magic);
+}
+
static void propagate_exit_status(int status, const char *what) {
int r;
signame);
}
- die("setup failed due to signal %d %s%s", sig, signame,
+ die("%s failed due to signal %d %s%s", what, sig, signame,
WCOREDUMP(status) ? " (core dumped)" : "");
}
- die("setup failed with weird wait status %d 0x%x", status, status);
+ die("%s failed with weird wait status %d 0x%x", what, status, status);
}
static __attribute((noreturn)) void die_data_overflow(void) {
prepare_string(len, buf, s);
}
-static void send_fd(int via_fd, int payload_fd) {
+static void send_fd(int payload_fd) {
+ int via_fd = fileno(call_sock);
+
union {
struct cmsghdr align;
char buf[CMSG_SPACE(sizeof(payload_fd))];
}
}
-static void send_request(int call_fd) {
+static void send_request(void) {
// Sending these first makes it easier for the script to
// use buffered IO for the message.
- send_fd(call_fd, 0);
- send_fd(call_fd, 1);
- send_fd(call_fd, 2);
+ send_fd(0);
+ send_fd(1);
+ send_fd(2);
- size_t len = 4;
+ size_t len = 0;
prepare_message(&len, 0);
- char *m = malloc(len);
- if (!m) diee("failed to allocate for message");
+
+ size_t tlen = len + 4;
+ char *m = xmalloc(tlen);
char *p = m;
- prepare_length(0, &p, len - 4);
+ prepare_length(0, &p, len);
prepare_message(0, &p);
- assert(p == m + len);
+ assert(p == m + tlen);
- p = m;
- while (len) {
- ssize_t r = write(call_fd, p, len);
- if (r==-1) {
- if (errno == EINTR) continue;
- diee("write request");
- }
- assert(r <= len);
- assert(r > 0);
- len -= r;
- p += r;
+ ssize_t sr = fwrite(m, tlen, 1, call_sock);
+ if (sr != 1) diee("write request (buffer)");
+
+ if (fflush(call_sock)) diee("write request");
+}
+
+static FILE *call_sock_from_fd(int fd) {
+ int r;
+
+ FILE *call_sock = fdopen(fd, "r+");
+ if (!call_sock) diee("fdopen socket");
+
+ r = setvbuf(call_sock, 0, _IONBF, 0);
+ if (r) die("setvbuf socket");
+
+ return call_sock;
+}
+
+static bool was_eof(FILE *call_sock) {
+ return feof(call_sock) || errno==ECONNRESET;
+}
+
+// Returns -1 on EOF
+static int protocol_read_maybe(void *data, size_t sz) {
+ if (!sz) return 0;
+ size_t sr = fread(data, sz, 1, call_sock);
+ if (sr != 1) {
+ if (was_eof(call_sock)) return -1;
+ diee("read() on monitor call socket (%zd)", sz);
}
+ return 0;
}
-// Returns: call(client-end) fd, or -1 to mean "is garbage"
+static void protocol_read(void *data, size_t sz) {
+ if (protocol_read_maybe(data, sz) < 0)
+ die("monitor process quit unexpectedly");
+}
+
+// Returns 0 if OK, error msg if peer was garbage.
+static const char *read_greeting(void) {
+ char got_magic[sizeof(header_magic)];
+
+ if (protocol_read_maybe(&got_magic, sizeof(got_magic)) < 0)
+ return "initial monitor process quit";
+
+ if (memcmp(got_magic, header_magic, sizeof(header_magic)))
+ die("got unexpected protocol magic 0x%02x%02x%02x%02x",
+ got_magic[0], got_magic[1], got_magic[2], got_magic[3]);
+
+ uint32_t xdata_len;
+ protocol_read(&xdata_len, sizeof(xdata_len));
+ void *xdata = xmalloc(xdata_len);
+ protocol_read(xdata, xdata_len);
+
+ return 0;
+}
+
+// Returns: call(client-end), or 0 to mean "is garbage"
// find_socket_path must have been called
-static int connect_existing(void) {
+static FILE *connect_existing(void) {
int r;
int fd = -1;
fd = socket(AF_UNIX, SOCK_STREAM, 0);
if (fd==-1) diee("socket() for client");
- socklen_t salen = sizeof(sun);
- r = connect(client, (const struct sockaddr*)&socket_sun, salen);
+ socklen_t salen = sizeof(sockaddr_sun);
+ r = connect(fd, (const struct sockaddr*)&sockaddr_sun, salen);
if (r==-1) {
- if (errno==ECONNREFUSED || errno==ENOENT) goto x_garbgae;
+ if (errno==ECONNREFUSED || errno==ENOENT) goto x_garbage;
diee("connect() %s", socket_path);
}
+ call_sock = call_sock_from_fd(fd);
+ fd = -1;
+
+ if (read_greeting())
+ goto x_garbage;
+
+ return call_sock;
+
+ x_garbage:
+ if (call_sock) { fclose(call_sock); call_sock=0; }
+ if (fd >= 0) close(fd);
+ return 0;
+}
+
+static void watcher_cb_stdin(uv_poll_t *handle, int status, int events) {
+ char c;
+ int r;
+
+ if ((errno = -status)) diee("watcher: poll stdin");
+ for (;;) {
+ r= read(0, &c, 1);
+ if (r!=-1) _exit(0);
+ if (!(errno==EINTR || errno==EWOULDBLOCK || errno==EAGAIN))
+ diee("watcher: read sentinel stdin");
+ }
+}
+
+static void watcher_cb_sockpath(uv_fs_event_t *handle, const char *filename,
+ int events, int status) {
+ int r;
+ struct stat now_stab;
+
+ if ((errno = -status)) diee("watcher: poll stdin");
for (;;) {
- char ack;
- sr = read(fd, &ack, 1);
- if (sr == -1) {
- if (errno==ECONNRESET) goto x_garbage;
+ r= stat(socket_path, &now_stab);
+ if (r==-1) {
+ if (errno==ENOENT) _exit(0);
if (errno==EINTR) continue;
- diee("read() ack byte");
+ diee("stat socket: %s", socket_path);
}
- if (sr == 0) { goto x_garbage; }
- if (ack != '\n') die("got ack byte 0x%02x, not '\n'", ack);
- break;
+ if (!stabs_same_inode(&now_stab, &initial_stab))
+ _exit(0);
}
+}
- // We're committed now, send the request (or bail out)
- send_request(call, argv);
+// On entry, stderr is still inherited, but 0 and 1 are the pipes
+static __attribute__((noreturn))
+void become_watcher(void) {
+ uv_loop_t loop;
+ uv_poll_t uvhandle_stdin;
+ uv_fs_event_t uvhandle_sockpath;
+ int r;
- return fd;
+ nonblock(0);
- x_garbage:
- if (fd >= 0) close(fd);
- return -1;
+ errno= -uv_loop_init(&loop);
+ if (errno) diee("watcher: uv_loop_init");
+
+ errno= -uv_poll_init(&loop, &uvhandle_stdin, 0);
+ if (errno) diee("watcher: uv_poll_init");
+ errno= -uv_poll_start(&uvhandle_stdin,
+ UV_READABLE | UV_WRITABLE | UV_DISCONNECT,
+ watcher_cb_stdin);
+ if (errno) diee("watcher: uv_poll_start");
+
+ errno= -uv_fs_event_init(&loop, &uvhandle_sockpath);
+ if (errno) diee("watcher: uv_fs_event_init");
+
+ errno= -uv_fs_event_start(&uvhandle_sockpath, watcher_cb_sockpath,
+ socket_path, 0);
+ if (errno) diee("watcher: uv_fs_event_start");
+
+ // OK everything is set up, let us daemonise
+ if (dup2(1,2) != 2) diee("watcher: set daemonised stderr");
+ r= setvbuf(stderr, 0, _IOLBF, BUFSIZ);
+ if (r) diee("watcher: setvbuf stderr");
+
+ pid_t child = fork();
+ if (child == (pid_t)-1) diee("watcher: fork");
+ if (child) _exit(0);
+
+ if (setsid() == (pid_t)-1) diee("watcher: setsid");
+
+ r= uv_run(&loop, UV_RUN_DEFAULT);
+ die("uv_run returned (%d)", r);
}
-static void become_setup(int sfd, int fake_pair[2])
- __attribute__((noreturn))
-{
+static __attribute__((noreturn))
+void become_setup(int sfd, int fake_pair[2],
+ int watcher_stdin, int watcher_stderr) {
close(fake_pair[0]);
int call_fd = fake_pair[1];
- int fd0_save = dup(0); if (fd0_save < 0) diee("dup stdin");
- int fd1_save = dup(1); if (fd1_save < 0) diee("dup stdin");
-
int null_0 = open("/dev/null", O_RDONLY); if (null_0 < 0) diee("open null");
if (dup2(null_0, 0)) diee("dup2 /dev/null onto stdin");
+ close(null_0);
if (dup2(2, 1) != 1) die("dup2 stderr onto stdout");
- putenv(asprintf("PREFORK_INTERP=%d,%d,%d,%d,%s",
- sfd, call_fd, fd0_save, fd1_save, socket_path));
+ nonblock(sfd);
- execvp(executor_argv[0], executor_argv);
+ // Extension could work like this:
+ //
+ // We advertise a new protocol (perhaps one which is nearly entirely
+ // different after the connect) by putting a name for it comma-separated
+ // next to "v1". Simple extension can be done by having the script
+ // side say something about it in the ack xdata, which we currently ignore.
+ putenv(m_asprintf("PREFORK_INTERP=v1 %d,%d,%d,%d",
+ sfd, call_fd, watcher_stdin, watcher_stderr));
+
+ execvp(executor_argv[0], (char**)executor_argv);
diee("execute %s", executor_argv[0]);
}
-static int connect_or_spawn(void) {
- int fd = connect_existing();
- if (fd >= 0) return fd;
+static void connect_or_spawn(void) {
+ int r;
+
+ call_sock = connect_existing();
+ if (call_sock) return;
int lockfd = acquire_lock();
- fd = connect_existing();
- if (fd >= 0) { close(lockfd); return fd; }
+ call_sock = connect_existing();
+ if (call_sock) { close(lockfd); return; }
// We must start a fresh one, and we hold the lock
- r = unlink(socketpath);
- if (r<0) diee("failed to remove stale socket %s", socketpath);
-
- int fake_pair[2];
- r = socketpair(AF_UNIX, SOCK_STREAM, 0, fake_pair);
- if (r<0) diee("socketpair() for fake initial connection");
+ r = unlink(socket_path);
+ if (r<0 && errno!=ENOENT)
+ diee("failed to remove stale socket %s", socket_path);
int sfd = socket(AF_UNIX, SOCK_STREAM, 0);
if (sfd<0) diee("socket() for new listener");
- salen_t salen = sizeof(sun);
- r= bind(sfd, (const struct sockaddr*)&socket_sun, saledn);
+ socklen_t salen = sizeof(sockaddr_sun);
+ r= bind(sfd, (const struct sockaddr*)&sockaddr_sun, salen);
if (r<0) diee("bind() on new listener");
- // We never want callers to get ECONNREFUSED!.
+ r= stat(socket_path, &initial_stab);
+ if (r<0) diee("stat() fresh socket");
+
+ // We never want callers to get ECONNREFUSED. But:
// There is a race here: from my RTFM they may get ECONNREFUSED
- // if they tr between our bind() and listen(). But if they do, they'll
+ // if they try between our bind() and listen(). But if they do, they'll
// acquire the lock (serialising with us) and retry, and then it will work.
r = listen(sfd, INT_MAX);
if (r<0) diee("listen() for new listener");
+ // Fork watcher
+
+ int watcher_stdin[2];
+ int watcher_stderr[2];
+ if (pipe(watcher_stdin) || pipe(watcher_stderr))
+ diee("pipe() for socket inode watcher");
+
+ pid_t watcher = fork();
+ if (watcher == (pid_t)-1) diee("fork for watcher");
+ if (!watcher) {
+ close(sfd);
+ close(lockfd);
+ close(watcher_stdin[1]);
+ close(watcher_stderr[0]);
+ if (dup2(watcher_stdin[0], 0) != 0 ||
+ dup2(watcher_stderr[1], 1) != 1)
+ diee("initial dup2() for watcher");
+ close(watcher_stdin[0]);
+ close(watcher_stderr[1]);
+ become_watcher();
+ }
+
+ close(watcher_stdin[0]);
+ close(watcher_stderr[1]);
+ nonblock(watcher_stderr[0]);
+
+ // Fork setup
+
+ int fake_pair[2];
+ r = socketpair(AF_UNIX, SOCK_STREAM, 0, fake_pair);
+ if (r<0) diee("socketpair() for fake initial connection");
+
pid_t setup_pid = fork();
if (setup_pid == (pid_t)-1) diee("fork for spawn setup");
- if (!setup_pid) become_setup(sfd, fake_pair);
+ if (!setup_pid) become_setup(sfd, fake_pair,
+ watcher_stdin[1], watcher_stderr[0]);
close(fake_pair[1]);
close(sfd);
+ call_sock = call_sock_from_fd(fake_pair[0]);
+
int status;
pid_t got = waitpid(setup_pid, &status, 0);
if (got == (pid_t)-1) diee("waitpid setup [%ld]", (long)setup_pid);
if (got != setup_pid) diee("waitpid setup [%ld] gave [%ld]!",
(long)setup_pid, (long)got);
- if (status != 0) propagate_exit_status(status);
+ if (status != 0) propagate_exit_status(status, "setup");
+
+ const char *emsg = read_greeting();
+ if (emsg) die("setup failed: %s", emsg);
close(lockfd);
- return fake_pair[0];
+ return;
}
static void make_executor_argv(const char *const *argv) {
- #define EACH_NEW_ARGV(EACH) { \
+ switch (laundering) {
+ case 'U': break;
+ default: die("need -U (specifying unlaundered argument handling)");
+ }
+
+ const char *arg;
+ #define EACH_NEW_ARG(EACH) { \
arg = interp; { EACH } \
if ((arg = script)) { EACH } \
const char *const *walk = argv; \
}
size_t count = 1;
- MAKE_NEW_ARGV( (void)arg; count++; );
+ EACH_NEW_ARG( (void)arg; count++; );
- executor_argv = calloc(count, sizeof(char*));
+ const char **out = calloc(count, sizeof(char*));
+ executor_argv = (const char* const*)out;
if (!executor_argv) diee("allocate for arguments");
- char **out = executor_argv;
- MAKE_NEW_ARGV( *out++ = arg; );
+ EACH_NEW_ARG( *out++ = arg; );
*out++ = 0;
}
make_executor_argv(argv);
find_socket_path();
- FILLZERO(sun);
- sun.sun_family = AF_UNIX;
- assert(strlen(socket_path) <= sizeof(sun.sun_path));
- strncpy(sun.sun_path, socket_path, sizeof(sun.sun_path));
+ FILLZERO(sockaddr_sun);
+ sockaddr_sun.sun_family = AF_UNIX;
+ assert(strlen(socket_path) <= sizeof(sockaddr_sun.sun_path));
+ strncpy(sockaddr_sun.sun_path, socket_path, sizeof(sockaddr_sun.sun_path));
+
+ connect_or_spawn();
+
+ // We're committed now, send the request (or bail out)
+ send_request();
+
+ uint32_t status;
+ protocol_read(&status, sizeof(status));
+
+ status = ntohl(status);
+ if (status > INT_MAX) die("status 0x%lx does not fit in an int",
+ (unsigned long)status);
- int call_fd = connect_or_spawn();
+ propagate_exit_status(status, "invocation");
}
~ian / chiark-utils.git / blobdiff