]> git.ozlabs.org Git - ccan/blobdiff - ccan/io/io.c
io: fix nasty io_wake corner case.
[ccan] / ccan / io / io.c
index 2ce5d6ae3224b1ac8cd5c51b5e354871a46f8e2c..12b2489023d94077d5562db876ab9004caae3dd4 100644 (file)
 #include <errno.h>
 #include <stdlib.h>
 #include <assert.h>
-#include <poll.h>
+#include <unistd.h>
+#include <fcntl.h>
+#include <ccan/container_of/container_of.h>
 
 void *io_loop_return;
 
-struct io_listener *io_new_listener_(int fd,
-                                    struct io_plan *(*start)(struct io_conn *,
-                                                             void *arg),
-                                    void (*finish)(struct io_conn *, void *),
+struct io_plan io_conn_freed;
+
+struct io_listener *io_new_listener_(const tal_t *ctx, int fd,
+                                    struct io_plan *(*init)(struct io_conn *,
+                                                            void *),
                                     void *arg)
 {
-       struct io_listener *l = malloc(sizeof(*l));
-
+       struct io_listener *l = tal(ctx, struct io_listener);
        if (!l)
                return NULL;
 
        l->fd.listener = true;
        l->fd.fd = fd;
-       l->fd.next = start;
-       l->fd.finish = finish;
-       l->fd.finish_arg = l->fd.next_arg = arg;
-       if (!add_listener(l)) {
-               free(l);
-               return NULL;
-       }
+       l->init = init;
+       l->arg = arg;
+       l->ctx = ctx;
+       if (!add_listener(l))
+               return tal_free(l);
        return l;
 }
 
 void io_close_listener(struct io_listener *l)
 {
-       close(l->fd.fd);
-       del_listener(l);
-       free(l);
+       tal_free(l);
+}
+
+static struct io_plan *io_never_called(struct io_conn *conn, void *arg)
+{
+       abort();
 }
 
-struct io_conn *io_new_conn_(int fd,
-                            struct io_plan *(*start)(struct io_conn *, void *),
-                            void (*finish)(struct io_conn *, void *),
+/* Returns false if conn was freed. */
+static bool next_plan(struct io_conn *conn, struct io_plan *plan)
+{
+       struct io_plan *(*next)(struct io_conn *, void *arg);
+
+       next = plan->next;
+
+       plan->status = IO_UNSET;
+       plan->io = NULL;
+       plan->next = io_never_called;
+
+       plan = next(conn, plan->next_arg);
+
+       if (plan == &io_conn_freed)
+               return false;
+
+       /* It should have set a plan inside this conn (or duplex) */
+       assert(plan == &conn->plan[IO_IN]
+              || plan == &conn->plan[IO_OUT]
+              || plan == &conn->plan[2]);
+       assert(conn->plan[IO_IN].status != IO_UNSET
+              || conn->plan[IO_OUT].status != IO_UNSET);
+
+       backend_new_plan(conn);
+       return true;
+}
+
+static void set_blocking(int fd, bool block)
+{
+       int flags = fcntl(fd, F_GETFL);
+
+       if (block)
+               flags &= ~O_NONBLOCK;
+       else
+               flags |= O_NONBLOCK;
+
+       fcntl(fd, F_SETFL, flags);
+}
+
+struct io_conn *io_new_conn_(const tal_t *ctx, int fd,
+                            struct io_plan *(*init)(struct io_conn *, void *),
                             void *arg)
 {
-       struct io_conn *conn = malloc(sizeof(*conn));
+       struct io_conn *conn = tal(ctx, struct io_conn);
 
        if (!conn)
                return NULL;
 
        conn->fd.listener = false;
        conn->fd.fd = fd;
-       conn->fd.next = start;
-       conn->fd.finish = finish;
-       conn->fd.finish_arg = conn->fd.next_arg = arg;
-       conn->pollflag = 0;
-       conn->state = NEXT;
-       conn->duplex = NULL;
-       conn->timeout = NULL;
-       if (!add_conn(conn)) {
-               free(conn);
+       conn->finish = NULL;
+       conn->finish_arg = NULL;
+       list_node_init(&conn->always);
+
+       if (!add_conn(conn))
+               return tal_free(conn);
+
+       /* Keep our I/O async. */
+       set_blocking(fd, false);
+
+       /* We start with out doing nothing, and in doing our init. */
+       conn->plan[IO_OUT].status = IO_UNSET;
+
+       conn->plan[IO_IN].next = init;
+       conn->plan[IO_IN].next_arg = arg;
+       if (!next_plan(conn, &conn->plan[IO_IN]))
                return NULL;
-       }
+
        return conn;
 }
 
-struct io_conn *io_duplex_(struct io_conn *old,
-                            struct io_plan *(*start)(struct io_conn *, void *),
-                            void (*finish)(struct io_conn *, void *),
-                            void *arg)
+void io_set_finish_(struct io_conn *conn,
+                   void (*finish)(struct io_conn *, void *),
+                   void *arg)
 {
-       struct io_conn *conn;
+       conn->finish = finish;
+       conn->finish_arg = arg;
+}
 
-       assert(!old->duplex);
+struct io_plan_arg *io_plan_arg(struct io_conn *conn, enum io_direction dir)
+{
+       assert(conn->plan[dir].status == IO_UNSET);
 
-       conn = malloc(sizeof(*conn));
-       if (!conn)
-               return NULL;
+       conn->plan[dir].status = IO_POLLING;
+       return &conn->plan[dir].arg;
+}
 
-       conn->fd.listener = false;
-       conn->fd.fd = old->fd.fd;
-       conn->fd.next = start;
-       conn->fd.finish = finish;
-       conn->fd.finish_arg = conn->fd.next_arg = arg;
-       conn->pollflag = 0;
-       conn->state = NEXT;
-       conn->duplex = old;
-       conn->timeout = NULL;
-       if (!add_duplex(conn)) {
-               free(conn);
-               return NULL;
-       }
-       old->duplex = conn;
-       return conn;
+static struct io_plan *set_always(struct io_conn *conn,
+                                 enum io_direction dir,
+                                 struct io_plan *(*next)(struct io_conn *,
+                                                         void *),
+                                 void *arg)
+{
+       struct io_plan *plan = &conn->plan[dir];
+
+       plan->status = IO_ALWAYS;
+       backend_new_always(conn);
+       return io_set_plan(conn, dir, NULL, next, arg);
 }
 
-static inline struct io_plan *to_ioplan(enum io_state state)
+static struct io_plan *io_always_dir(struct io_conn *conn,
+                                    enum io_direction dir,
+                                    struct io_plan *(*next)(struct io_conn *,
+                                                            void *),
+                                    void *arg)
 {
-       return (struct io_plan *)(long)state;
+       return set_always(conn, dir, next, arg);
 }
 
-bool io_timeout_(struct io_conn *conn, struct timespec ts,
-                struct io_plan *(*cb)(struct io_conn *, void *), void *arg)
+struct io_plan *io_always_(struct io_conn *conn,
+                          struct io_plan *(*next)(struct io_conn *, void *),
+                          void *arg)
 {
-       if (!conn->timeout) {
-               conn->timeout = malloc(sizeof(*conn->timeout));
-               if (!conn->timeout)
-                       return false;
-       } else
-               assert(!timeout_active(conn));
+       return io_always_dir(conn, IO_IN, next, arg);
+}
 
-       conn->timeout->next = cb;
-       conn->timeout->next_arg = arg;
-       backend_add_timeout(conn, ts);
-       return true;
+struct io_plan *io_out_always_(struct io_conn *conn,
+                              struct io_plan *(*next)(struct io_conn *,
+                                                      void *),
+                              void *arg)
+{
+       return io_always_dir(conn, IO_OUT, next, arg);
+}
+
+static int do_write(int fd, struct io_plan_arg *arg)
+{
+       ssize_t ret = write(fd, arg->u1.cp, arg->u2.s);
+       if (ret < 0)
+               return -1;
+
+       arg->u1.cp += ret;
+       arg->u2.s -= ret;
+       return arg->u2.s == 0;
 }
 
 /* Queue some data to be written. */
 struct io_plan *io_write_(struct io_conn *conn, const void *data, size_t len,
-                         struct io_plan *(*cb)(struct io_conn *, void *),
-                         void *arg)
+                         struct io_plan *(*next)(struct io_conn *, void *),
+                         void *next_arg)
+{
+       struct io_plan_arg *arg = io_plan_arg(conn, IO_OUT);
+
+       if (len == 0)
+               return set_always(conn, IO_OUT, next, next_arg);
+
+       arg->u1.const_vp = data;
+       arg->u2.s = len;
+
+       return io_set_plan(conn, IO_OUT, do_write, next, next_arg);
+}
+
+static int do_read(int fd, struct io_plan_arg *arg)
 {
-       conn->u.write.buf = data;
-       conn->u.write.len = len;
-       conn->fd.next = cb;
-       conn->fd.next_arg = arg;
-       conn->pollflag = POLLOUT;
-       return to_ioplan(WRITE);
+       ssize_t ret = read(fd, arg->u1.cp, arg->u2.s);
+       if (ret <= 0)
+               return -1;
+
+       arg->u1.cp += ret;
+       arg->u2.s -= ret;
+       return arg->u2.s == 0;
 }
 
 /* Queue a request to read into a buffer. */
-struct io_plan *io_read_(struct io_conn *conn, void *data, size_t len,
-                        struct io_plan *(*cb)(struct io_conn *, void *),
-                        void *arg)
+struct io_plan *io_read_(struct io_conn *conn,
+                        void *data, size_t len,
+                        struct io_plan *(*next)(struct io_conn *, void *),
+                        void *next_arg)
 {
-       conn->u.read.buf = data;
-       conn->u.read.len = len;
-       conn->fd.next = cb;
-       conn->fd.next_arg = arg;
-       conn->pollflag = POLLIN;
-       return to_ioplan(READ);
+       struct io_plan_arg *arg = io_plan_arg(conn, IO_IN);
+
+       if (len == 0)
+               return set_always(conn, IO_IN, next, next_arg);
+
+       arg->u1.cp = data;
+       arg->u2.s = len;
+
+       return io_set_plan(conn, IO_IN, do_read, next, next_arg);
+}
+
+static int do_read_partial(int fd, struct io_plan_arg *arg)
+{
+       ssize_t ret = read(fd, arg->u1.cp, *(size_t *)arg->u2.vp);
+       if (ret <= 0)
+               return -1;
+
+       *(size_t *)arg->u2.vp = ret;
+       return 1;
 }
 
 /* Queue a partial request to read into a buffer. */
-struct io_plan *io_read_partial_(struct io_conn *conn, void *data, size_t *len,
-                                struct io_plan *(*cb)(struct io_conn *, void *),
-                                void *arg)
+struct io_plan *io_read_partial_(struct io_conn *conn,
+                                void *data, size_t maxlen, size_t *len,
+                                struct io_plan *(*next)(struct io_conn *,
+                                                        void *),
+                                void *next_arg)
+{
+       struct io_plan_arg *arg = io_plan_arg(conn, IO_IN);
+
+       if (maxlen == 0)
+               return set_always(conn, IO_IN, next, next_arg);
+
+       arg->u1.cp = data;
+       /* We store the max len in here temporarily. */
+       *len = maxlen;
+       arg->u2.vp = len;
+
+       return io_set_plan(conn, IO_IN, do_read_partial, next, next_arg);
+}
+
+static int do_write_partial(int fd, struct io_plan_arg *arg)
 {
-       conn->u.readpart.buf = data;
-       conn->u.readpart.lenp = len;
-       conn->fd.next = cb;
-       conn->fd.next_arg = arg;
-       conn->pollflag = POLLIN;
-       return to_ioplan(READPART);
+       ssize_t ret = write(fd, arg->u1.cp, *(size_t *)arg->u2.vp);
+       if (ret < 0)
+               return -1;
+
+       *(size_t *)arg->u2.vp = ret;
+       return 1;
 }
 
 /* Queue a partial write request. */
 struct io_plan *io_write_partial_(struct io_conn *conn,
-                                 const void *data, size_t *len,
-                                 struct io_plan *(*cb)(struct io_conn*, void *),
-                                 void *arg)
+                                 const void *data, size_t maxlen, size_t *len,
+                                 struct io_plan *(*next)(struct io_conn *,
+                                                         void*),
+                                 void *next_arg)
+{
+       struct io_plan_arg *arg = io_plan_arg(conn, IO_OUT);
+
+       if (maxlen == 0)
+               return set_always(conn, IO_OUT, next, next_arg);
+
+       arg->u1.const_vp = data;
+       /* We store the max len in here temporarily. */
+       *len = maxlen;
+       arg->u2.vp = len;
+
+       return io_set_plan(conn, IO_OUT, do_write_partial, next, next_arg);
+}
+
+static int do_connect(int fd, struct io_plan_arg *arg)
 {
-       conn->u.writepart.buf = data;
-       conn->u.writepart.lenp = len;
-       conn->fd.next = cb;
-       conn->fd.next_arg = arg;
-       conn->pollflag = POLLOUT;
-       return to_ioplan(WRITEPART);
+       int err, ret;
+       socklen_t len = sizeof(err);
+
+       /* Has async connect finished? */
+       ret = getsockopt(fd, SOL_SOCKET, SO_ERROR, &err, &len);
+       if (ret < 0)
+               return -1;
+
+       if (err == 0) {
+               return 1;
+       } else if (err == EINPROGRESS)
+               return 0;
+
+       errno = err;
+       return -1;
 }
 
-struct io_plan *io_idle(struct io_conn *conn)
+struct io_plan *io_connect_(struct io_conn *conn, const struct addrinfo *addr,
+                           struct io_plan *(*next)(struct io_conn *, void *),
+                           void *next_arg)
 {
-       conn->pollflag = 0;
-       return to_ioplan(IDLE);
+       int fd = io_conn_fd(conn);
+
+       /* We don't actually need the arg, but we need it polling. */
+       io_plan_arg(conn, IO_OUT);
+
+       /* Note that io_new_conn() will make fd O_NONBLOCK */
+
+       /* Immediate connect can happen. */
+       if (connect(fd, addr->ai_addr, addr->ai_addrlen) == 0)
+               return set_always(conn, IO_OUT, next, next_arg);
+
+       if (errno != EINPROGRESS)
+               return io_close(conn);
+
+       return io_set_plan(conn, IO_OUT, do_connect, next, next_arg);
 }
 
-void io_wake_(struct io_conn *conn,
-             struct io_plan *(*fn)(struct io_conn *, void *), void *arg)
+static struct io_plan *io_wait_dir(struct io_conn *conn,
+                                  const void *wait,
+                                  enum io_direction dir,
+                                  struct io_plan *(*next)(struct io_conn *,
+                                                          void *),
+                                  void *next_arg)
+{
+       struct io_plan_arg *arg = io_plan_arg(conn, dir);
+       arg->u1.const_vp = wait;
 
+       conn->plan[dir].status = IO_WAITING;
+
+       return io_set_plan(conn, dir, NULL, next, next_arg);
+}
+
+struct io_plan *io_wait_(struct io_conn *conn,
+                        const void *wait,
+                        struct io_plan *(*next)(struct io_conn *, void *),
+                        void *next_arg)
 {
-       /* It might have finished, but we haven't called its finish() yet. */
-       if (conn->state == FINISHED)
-               return;
-       assert(conn->state == IDLE);
-       conn->fd.next = fn;
-       conn->fd.next_arg = arg;
-       backend_set_state(conn, to_ioplan(NEXT));
+       return io_wait_dir(conn, wait, IO_IN, next, next_arg);
 }
 
-static struct io_plan *do_next(struct io_conn *conn)
+struct io_plan *io_out_wait_(struct io_conn *conn,
+                            const void *wait,
+                            struct io_plan *(*next)(struct io_conn *, void *),
+                            void *next_arg)
 {
-       if (timeout_active(conn))
-               backend_del_timeout(conn);
-       return conn->fd.next(conn, conn->fd.next_arg);
+       return io_wait_dir(conn, wait, IO_OUT, next, next_arg);
 }
 
-struct io_plan *do_ready(struct io_conn *conn)
+void io_wake(const void *wait)
 {
-       ssize_t ret;
-       bool finished;
+       backend_wake(wait);
+}
 
-       switch (conn->state) {
-       case WRITE:
-               ret = write(conn->fd.fd, conn->u.write.buf, conn->u.write.len);
-               if (ret < 0)
-                       return io_close(conn, NULL);
-               conn->u.write.buf += ret;
-               conn->u.write.len -= ret;
-               finished = (conn->u.write.len == 0);
-               break;
-       case WRITEPART:
-               ret = write(conn->fd.fd, conn->u.writepart.buf,
-                           *conn->u.writepart.lenp);
-               if (ret < 0)
-                       return io_close(conn, NULL);
-               *conn->u.writepart.lenp = ret;
-               finished = true;
-               break;
-       case READ:
-               ret = read(conn->fd.fd, conn->u.read.buf, conn->u.read.len);
-               if (ret <= 0)
-                       return io_close(conn, NULL);
-               conn->u.read.buf += ret;
-               conn->u.read.len -= ret;
-               finished = (conn->u.read.len == 0);
-               break;
-       case READPART:
-               ret = read(conn->fd.fd, conn->u.readpart.buf,
-                           *conn->u.readpart.lenp);
-               if (ret <= 0)
-                       return io_close(conn, NULL);
-               *conn->u.readpart.lenp = ret;
-               finished = true;
-               break;
+/* Returns false if this has been freed. */
+static bool do_plan(struct io_conn *conn, struct io_plan *plan)
+{
+       /* We shouldn't have polled for this event if this wasn't true! */
+       assert(plan->status == IO_POLLING);
+
+       switch (plan->io(conn->fd.fd, &plan->arg)) {
+       case -1:
+               io_close(conn);
+               return false;
+       case 0:
+               return true;
+       case 1:
+               return next_plan(conn, plan);
        default:
-               /* Shouldn't happen. */
+               /* IO should only return -1, 0 or 1 */
                abort();
        }
+}
+
+void io_ready(struct io_conn *conn, int pollflags)
+{
+       if (pollflags & POLLIN)
+               if (!do_plan(conn, &conn->plan[IO_IN]))
+                       return;
+
+       if (pollflags & POLLOUT)
+               do_plan(conn, &conn->plan[IO_OUT]);
+}
+
+void io_do_always(struct io_conn *conn)
+{
+       /* There's a corner case where the in next_plan wakes up the
+        * out, placing it in IO_ALWAYS and we end up processing it immediately,
+        * only to leave it in the always list.
+        *
+        * Yet we can't just process one, in case they are both supposed
+        * to be done, so grab state beforehand.
+        */
+       bool always_out = (conn->plan[IO_OUT].status == IO_ALWAYS);
+
+       if (conn->plan[IO_IN].status == IO_ALWAYS)
+               if (!next_plan(conn, &conn->plan[IO_IN]))
+                       return;
+
+       if (always_out) {
+               /* You can't *unalways* a conn (except by freeing, in which
+                * case next_plan() returned false */
+               assert(conn->plan[IO_OUT].status == IO_ALWAYS);
+               next_plan(conn, &conn->plan[IO_OUT]);
+       }
+}
+
+void io_do_wakeup(struct io_conn *conn, enum io_direction dir)
+{
+       struct io_plan *plan = &conn->plan[dir];
+
+       assert(plan->status == IO_WAITING);
 
-       if (finished)
-               return do_next(conn);
-       return to_ioplan(conn->state);
+       set_always(conn, dir, plan->next, plan->next_arg);
 }
 
-/* Useful next functions. */
 /* Close the connection, we're done. */
-struct io_plan *io_close(struct io_conn *conn, void *arg)
+struct io_plan *io_close(struct io_conn *conn)
 {
-       return to_ioplan(FINISHED);
+       tal_free(conn);
+       return &io_conn_freed;
+}
+
+struct io_plan *io_close_cb(struct io_conn *conn, void *next_arg)
+{
+       return io_close(conn);
+}
+
+struct io_plan *io_close_taken_fd(struct io_conn *conn)
+{
+       set_blocking(conn->fd.fd, true);
+
+       cleanup_conn_without_close(conn);
+       return io_close(conn);
 }
 
 /* Exit the loop, returning this (non-NULL) arg. */
-struct io_plan *io_break_(struct io_conn *conn, void *ret,
-                         struct io_plan *(*fn)(struct io_conn *, void *),
-                         void *arg)
+void io_break(const void *ret)
+{
+       assert(ret);
+       io_loop_return = (void *)ret;
+}
+
+struct io_plan *io_never(struct io_conn *conn, void *unused)
+{
+       return io_always(conn, io_never_called, NULL);
+}
+
+int io_conn_fd(const struct io_conn *conn)
+{
+       return conn->fd.fd;
+}
+
+struct io_plan *io_duplex(struct io_conn *conn,
+                         struct io_plan *in_plan, struct io_plan *out_plan)
+{
+       assert(conn == container_of(in_plan, struct io_conn, plan[IO_IN]));
+       /* in_plan must be conn->plan[IO_IN], out_plan must be [IO_OUT] */
+       assert(out_plan == in_plan + 1);
+       return out_plan + 1;
+}
+
+struct io_plan *io_halfclose(struct io_conn *conn)
+{
+       /* Both unset?  OK. */
+       if (conn->plan[IO_IN].status == IO_UNSET
+           && conn->plan[IO_OUT].status == IO_UNSET)
+               return io_close(conn);
+
+       /* We leave this unset then. */
+       if (conn->plan[IO_IN].status == IO_UNSET)
+               return &conn->plan[IO_IN];
+       else
+               return &conn->plan[IO_OUT];
+}
+
+struct io_plan *io_set_plan(struct io_conn *conn, enum io_direction dir,
+                           int (*io)(int fd, struct io_plan_arg *arg),
+                           struct io_plan *(*next)(struct io_conn *, void *),
+                           void *next_arg)
+{
+       struct io_plan *plan = &conn->plan[dir];
+
+       plan->io = io;
+       plan->next = next;
+       plan->next_arg = next_arg;
+       assert(next != NULL);
+
+       return plan;
+}
+
+bool io_flush_sync(struct io_conn *conn)
 {
-       io_loop_return = ret;
-       conn->fd.next = fn;
-       conn->fd.next_arg = arg;
+       struct io_plan *plan = &conn->plan[IO_OUT];
+       bool ok;
+
+       /* Not writing?  Nothing to do. */
+       if (plan->status != IO_POLLING)
+               return true;
+
+       /* Synchronous please. */
+       set_blocking(io_conn_fd(conn), true);
+
+again:
+       switch (plan->io(conn->fd.fd, &plan->arg)) {
+       case -1:
+               ok = false;
+               break;
+       /* Incomplete, try again. */
+       case 0:
+               goto again;
+       case 1:
+               ok = true;
+               /* In case they come back. */
+               set_always(conn, IO_OUT, plan->next, plan->next_arg);
+               break;
+       default:
+               /* IO should only return -1, 0 or 1 */
+               abort();
+       }
 
-       return to_ioplan(NEXT);
+       set_blocking(io_conn_fd(conn), false);
+       return ok;
 }