]> git.ozlabs.org Git - ccan/blobdiff - ccan/io/io.c
ccan/io: rewrite.
[ccan] / ccan / io / io.c
index 8e2695292bb158a15130c0754dbbee94ac2bfb71..52f4368ca11533f739fea3bf480571a80d09af90 100644 (file)
 
 void *io_loop_return;
 
-struct io_alloc io_alloc = {
-       malloc, realloc, free
-};
-
-#ifdef DEBUG
-/* Set to skip the next plan. */
-bool io_plan_nodebug;
-/* The current connection to apply plan to. */
-struct io_conn *current;
-/* User-defined function to select which connection(s) to debug. */
-bool (*io_debug_conn)(struct io_conn *conn);
-
-struct io_plan io_debug(struct io_plan plan)
-{
-       struct io_conn *ready = NULL;
-
-       if (io_plan_nodebug) {
-               io_plan_nodebug = false;
-               return plan;
-       }
-
-       if (!current || !doing_debug_on(current))
-               return plan;
-
-       current->plan = plan;
-       backend_plan_changed(current);
-
-       /* Call back into the loop immediately. */
-       io_loop_return = do_io_loop(&ready);
-
-       if (ready) {
-               set_current(ready);
-               if (!ready->plan.next) {
-                       /* Call finish function immediately. */
-                       if (ready->finish) {
-                               errno = ready->plan.u1.s;
-                               ready->finish(ready, ready->finish_arg);
-                               ready->finish = NULL;
-                       }
-                       backend_del_conn(ready);
-               } else {
-                       /* Calls back in itself, via io_debug_io(). */
-                       if (ready->plan.io(ready->fd.fd, &ready->plan) != 2)
-                               abort();
-               }
-               set_current(NULL);
-       }
-
-       /* Return a do-nothing plan, so backend_plan_changed in
-        * io_ready doesn't do anything (it's already been called). */
-       return io_wait_(NULL, (void *)1, NULL);
-}
-
-int io_debug_io(int ret)
-{
-       /* Cache it for debugging; current changes. */
-       struct io_conn *conn = current;
-       int saved_errno = errno;
-
-       if (!doing_debug_on(conn))
-               return ret;
-
-       /* These will all go linearly through the io_debug() path above. */
-       switch (ret) {
-       case -1:
-               /* This will call io_debug above. */
-               errno = saved_errno;
-               io_close();
-               break;
-       case 0: /* Keep going with plan. */
-               io_debug(conn->plan);
-               break;
-       case 1: /* Done: get next plan. */
-               if (timeout_active(conn))
-                       backend_del_timeout(conn);
-               /* In case they call io_duplex, clear our poll flags so
-                * both sides don't seem to be both doing read or write
-                * (See assert(!mask || pfd->events != mask) in poll.c) */
-               conn->plan.pollflag = 0;
-               conn->plan.next(conn, conn->plan.next_arg);
-               break;
-       default:
-               abort();
-       }
-
-       /* Normally-invalid value, used for sanity check. */
-       return 2;
-}
-
-/* Counterpart to io_plan_no_debug(), called in macros in io.h */
-static void io_plan_debug_again(void)
-{
-       io_plan_nodebug = false;
-}
-#else
-static void io_plan_debug_again(void)
-{
-}
-#endif
-
-struct io_listener *io_new_listener_(int fd,
-                                    void (*init)(int fd, void *arg),
+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 = io_alloc.alloc(sizeof(*l));
-
+       struct io_listener *l = tal(ctx, struct io_listener);
        if (!l)
                return NULL;
 
@@ -126,10 +26,9 @@ struct io_listener *io_new_listener_(int fd,
        l->fd.fd = fd;
        l->init = init;
        l->arg = arg;
-       if (!add_listener(l)) {
-               io_alloc.free(l);
-               return NULL;
-       }
+       l->ctx = ctx;
+       if (!add_listener(l))
+               return tal_free(l);
        return l;
 }
 
@@ -137,29 +36,60 @@ void io_close_listener(struct io_listener *l)
 {
        close(l->fd.fd);
        del_listener(l);
-       io_alloc.free(l);
+       tal_free(l);
 }
 
-struct io_conn *io_new_conn_(int fd, struct io_plan plan)
+static struct io_plan *io_never_called(struct io_conn *conn, void *arg)
 {
-       struct io_conn *conn = io_alloc.alloc(sizeof(*conn));
+       abort();
+}
+
+static void next_plan(struct io_conn *conn, struct io_plan *plan)
+{
+       struct io_plan *(*next)(struct io_conn *, void *arg);
+
+       next = plan->next;
 
-       io_plan_debug_again();
+       plan->status = IO_UNSET;
+       plan->io = NULL;
+       plan->next = io_never_called;
+
+       plan = next(conn, plan->next_arg);
+
+       /* It should have set a plan inside this conn. */
+       assert(plan == &conn->plan[IO_IN]
+              || plan == &conn->plan[IO_OUT]);
+       assert(conn->plan[IO_IN].status != IO_UNSET
+              || conn->plan[IO_OUT].status != IO_UNSET);
+
+       backend_new_plan(conn);
+}
+
+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 = tal(ctx, struct io_conn);
 
        if (!conn)
                return NULL;
 
        conn->fd.listener = false;
        conn->fd.fd = fd;
-       conn->plan = plan;
        conn->finish = NULL;
        conn->finish_arg = NULL;
-       conn->duplex = NULL;
-       conn->timeout = NULL;
-       if (!add_conn(conn)) {
-               io_alloc.free(conn);
-               return NULL;
-       }
+       conn->list = NULL;
+
+       if (!add_conn(conn))
+               return tal_free(conn);
+
+       /* 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;
+       next_plan(conn, &conn->plan[IO_IN]);
+
        return conn;
 }
 
@@ -171,101 +101,69 @@ void io_set_finish_(struct io_conn *conn,
        conn->finish_arg = arg;
 }
 
-struct io_conn *io_duplex_(struct io_conn *old, struct io_plan plan)
+struct io_plan *io_get_plan(struct io_conn *conn, enum io_direction dir)
 {
-       struct io_conn *conn;
-
-       io_plan_debug_again();
+       assert(conn->plan[dir].status == IO_UNSET);
 
-       assert(!old->duplex);
-
-       conn = io_alloc.alloc(sizeof(*conn));
-       if (!conn)
-               return NULL;
-
-       conn->fd.listener = false;
-       conn->fd.fd = old->fd.fd;
-       conn->plan = plan;
-       conn->duplex = old;
-       conn->finish = NULL;
-       conn->finish_arg = NULL;
-       conn->timeout = NULL;
-       if (!add_duplex(conn)) {
-               io_alloc.free(conn);
-               return NULL;
-       }
-       old->duplex = conn;
-       return conn;
+       conn->plan[dir].status = IO_POLLING;
+       return &conn->plan[dir];
 }
 
-bool io_timeout_(struct io_conn *conn, struct timerel t,
-                struct io_plan (*cb)(struct io_conn *, void *), void *arg)
+static struct io_plan *set_always(struct io_conn *conn,
+                                 struct io_plan *plan,
+                                 struct io_plan *(*next)(struct io_conn *,
+                                                         void *),
+                                 void *arg)
 {
-       assert(cb);
-
-       if (!conn->timeout) {
-               conn->timeout = io_alloc.alloc(sizeof(*conn->timeout));
-               if (!conn->timeout)
-                       return false;
-       } else
-               assert(!timeout_active(conn));
-
-       conn->timeout->next = cb;
-       conn->timeout->next_arg = arg;
-       backend_add_timeout(conn, t);
-       return true;
-}
+       plan->next = next;
+       plan->next_arg = arg;
+       plan->status = IO_ALWAYS;
 
-/* Always done: call the next thing. */
-static int do_always(int fd, struct io_plan *plan)
-{
-       return 1;
+       backend_new_always(conn);
+       return plan;
 }
 
-struct io_plan io_always_(struct io_plan (*cb)(struct io_conn *, void *),
-                         void *arg)
+struct io_plan *io_always_(struct io_conn *conn,
+                          enum io_direction dir,
+                          struct io_plan *(*next)(struct io_conn *, void *),
+                          void *arg)
 {
-       struct io_plan plan;
+       struct io_plan *plan = io_get_plan(conn, dir);
 
-       assert(cb);
-       plan.io = do_always;
-       plan.next = cb;
-       plan.next_arg = arg;
-       plan.pollflag = POLLALWAYS;
+       assert(next);
+       set_always(conn, plan, next, arg);
 
        return plan;
 }
 
-/* Returns true if we're finished. */
 static int do_write(int fd, struct io_plan *plan)
 {
        ssize_t ret = write(fd, plan->u1.cp, plan->u2.s);
        if (ret < 0)
-               return io_debug_io(-1);
+               return -1;
 
        plan->u1.cp += ret;
        plan->u2.s -= ret;
-       return io_debug_io(plan->u2.s == 0);
+       return plan->u2.s == 0;
 }
 
 /* Queue some data to be written. */
-struct io_plan io_write_(const void *data, size_t len,
-                        struct io_plan (*cb)(struct io_conn *, void *),
-                        void *arg)
+struct io_plan *io_write_(struct io_conn *conn, const void *data, size_t len,
+                         struct io_plan *(*next)(struct io_conn *, void *),
+                         void *arg)
 {
-       struct io_plan plan;
+       struct io_plan *plan = io_get_plan(conn, IO_OUT);
 
-       assert(cb);
+       assert(next);
 
        if (len == 0)
-               return io_always_(cb, arg);
+               return set_always(conn, plan, next, arg);
 
-       plan.u1.const_vp = data;
-       plan.u2.s = len;
-       plan.io = do_write;
-       plan.next = cb;
-       plan.next_arg = arg;
-       plan.pollflag = POLLOUT;
+       plan->u1.const_vp = data;
+       plan->u2.s = len;
+       plan->io = do_write;
+       plan->next = next;
+       plan->next_arg = arg;
 
        return plan;
 }
@@ -274,32 +172,31 @@ static int do_read(int fd, struct io_plan *plan)
 {
        ssize_t ret = read(fd, plan->u1.cp, plan->u2.s);
        if (ret <= 0)
-               return io_debug_io(-1);
+               return -1;
 
        plan->u1.cp += ret;
        plan->u2.s -= ret;
-       return io_debug_io(plan->u2.s == 0);
+       return plan->u2.s == 0;
 }
 
 /* Queue a request to read into a buffer. */
-struct io_plan io_read_(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 *arg)
 {
-       struct io_plan plan;
+       struct io_plan *plan = io_get_plan(conn, IO_IN);
 
-       assert(cb);
+       assert(next);
 
        if (len == 0)
-               return io_always_(cb, arg);
-
-       plan.u1.cp = data;
-       plan.u2.s = len;
-       plan.io = do_read;
-       plan.next = cb;
-       plan.next_arg = arg;
+               return set_always(conn, plan, next, arg);
 
-       plan.pollflag = POLLIN;
+       plan->u1.cp = data;
+       plan->u2.s = len;
+       plan->io = do_read;
+       plan->next = next;
+       plan->next_arg = arg;
 
        return plan;
 }
@@ -308,30 +205,33 @@ static int do_read_partial(int fd, struct io_plan *plan)
 {
        ssize_t ret = read(fd, plan->u1.cp, *(size_t *)plan->u2.vp);
        if (ret <= 0)
-               return io_debug_io(-1);
+               return -1;
 
        *(size_t *)plan->u2.vp = ret;
-       return io_debug_io(1);
+       return 1;
 }
 
 /* Queue a partial request to read into a buffer. */
-struct io_plan io_read_partial_(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 *arg)
 {
-       struct io_plan plan;
+       struct io_plan *plan = io_get_plan(conn, IO_IN);
 
-       assert(cb);
+       assert(next);
 
-       if (*len == 0)
-               return io_always_(cb, arg);
+       if (maxlen == 0)
+               return set_always(conn, plan, next, arg);
 
-       plan.u1.cp = data;
-       plan.u2.vp = len;
-       plan.io = do_read_partial;
-       plan.next = cb;
-       plan.next_arg = arg;
-       plan.pollflag = POLLIN;
+       plan->u1.cp = data;
+       /* We store the max len in here temporarily. */
+       *len = maxlen;
+       plan->u2.vp = len;
+       plan->io = do_read_partial;
+       plan->next = next;
+       plan->next_arg = arg;
 
        return plan;
 }
@@ -340,39 +240,37 @@ static int do_write_partial(int fd, struct io_plan *plan)
 {
        ssize_t ret = write(fd, plan->u1.cp, *(size_t *)plan->u2.vp);
        if (ret < 0)
-               return io_debug_io(-1);
+               return -1;
 
        *(size_t *)plan->u2.vp = ret;
-       return io_debug_io(1);
+       return 1;
 }
 
 /* Queue a partial write request. */
-struct io_plan io_write_partial_(const void *data, size_t *len,
-                                struct io_plan (*cb)(struct io_conn*, void *),
-                                void *arg)
+struct io_plan *io_write_partial_(struct io_conn *conn,
+                                 const void *data, size_t maxlen, size_t *len,
+                                 struct io_plan *(*next)(struct io_conn *,
+                                                         void*),
+                                 void *arg)
 {
-       struct io_plan plan;
+       struct io_plan *plan = io_get_plan(conn, IO_OUT);
 
-       assert(cb);
+       assert(next);
 
-       if (*len == 0)
-               return io_always_(cb, arg);
+       if (maxlen == 0)
+               return set_always(conn, plan, next, arg);
 
-       plan.u1.const_vp = data;
-       plan.u2.vp = len;
-       plan.io = do_write_partial;
-       plan.next = cb;
-       plan.next_arg = arg;
-       plan.pollflag = POLLOUT;
+       plan->u1.const_vp = data;
+       /* We store the max len in here temporarily. */
+       *len = maxlen;
+       plan->u2.vp = len;
+       plan->io = do_write_partial;
+       plan->next = next;
+       plan->next_arg = arg;
 
        return plan;
 }
 
-static int already_connected(int fd, struct io_plan *plan)
-{
-       return io_debug_io(1);
-}
-
 static int do_connect(int fd, struct io_plan *plan)
 {
        int err, ret;
@@ -394,143 +292,135 @@ static int do_connect(int fd, struct io_plan *plan)
        return -1;
 }
 
-struct io_plan io_connect_(int fd, const struct addrinfo *addr,
-                          struct io_plan (*cb)(struct io_conn*, void *),
-                          void *arg)
+struct io_plan *io_connect_(struct io_conn *conn, const struct addrinfo *addr,
+                           struct io_plan *(*next)(struct io_conn *, void *),
+                           void *arg)
 {
-       struct io_plan plan;
-
-       assert(cb);
+       struct io_plan *plan = io_get_plan(conn, IO_IN);
+       int fd = io_conn_fd(conn);
 
-       plan.next = cb;
-       plan.next_arg = arg;
+       assert(next);
 
        /* Save old flags, set nonblock if not already. */
-       plan.u1.s = fcntl(fd, F_GETFL);
-       fcntl(fd, F_SETFL, plan.u1.s | O_NONBLOCK);
+       plan->u1.s = fcntl(fd, F_GETFL);
+       fcntl(fd, F_SETFL, plan->u1.s | O_NONBLOCK);
 
        /* Immediate connect can happen. */
-       if (connect(fd, addr->ai_addr, addr->ai_addrlen) == 0) {
-               /* Dummy will be called immediately. */
-               plan.pollflag = POLLOUT;
-               plan.io = already_connected;
-       } else {
-               if (errno != EINPROGRESS)
-                       return io_close_();
-
-               plan.pollflag = POLLIN;
-               plan.io = do_connect;
-       }
+       if (connect(fd, addr->ai_addr, addr->ai_addrlen) == 0)
+               return set_always(conn, plan, next, arg);
+
+       if (errno != EINPROGRESS)
+               return io_close(conn);
+
+       plan->next = next;
+       plan->next_arg = arg;
+       plan->io = do_connect;
+
        return plan;
 }
 
-struct io_plan io_wait_(const void *wait,
-                       struct io_plan (*cb)(struct io_conn *, void*),
-                       void *arg)
+struct io_plan *io_wait_(struct io_conn *conn,
+                        const void *wait, enum io_direction dir,
+                        struct io_plan *(*next)(struct io_conn *, void *),
+                        void *arg)
 {
-       struct io_plan plan;
+       struct io_plan *plan = io_get_plan(conn, dir);
 
-       assert(cb);
-       plan.pollflag = 0;
-       plan.io = NULL;
-       plan.next = cb;
-       plan.next_arg = arg;
+       assert(next);
 
-       plan.u1.const_vp = wait;
+       plan->next = next;
+       plan->next_arg = arg;
+       plan->u1.const_vp = wait;
+       plan->status = IO_WAITING;
 
        return plan;
 }
 
 void io_wake(const void *wait)
 {
-       backend_wait_changed(wait);
+       backend_wake(wait);
 }
 
-void io_ready(struct io_conn *conn)
+static void do_plan(struct io_conn *conn, struct io_plan *plan)
 {
-       /* Beware io_close_other! */
-       if (!conn->plan.next)
+       /* Someone else might have called io_close() on us. */
+       if (plan->status == IO_CLOSING)
                return;
 
-       set_current(conn);
-       switch (conn->plan.io(conn->fd.fd, &conn->plan)) {
-       case -1: /* Failure means a new plan: close up. */
-               conn->plan = io_close();
-               backend_plan_changed(conn);
+       /* 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)) {
+       case -1:
+               io_close(conn);
                break;
-       case 0: /* Keep going with plan. */
+       case 0:
                break;
-       case 1: /* Done: get next plan. */
-               if (timeout_active(conn))
-                       backend_del_timeout(conn);
-               /* In case they call io_duplex, clear our poll flags so
-                * both sides don't seem to be both doing read or write
-                * (See assert(!mask || pfd->events != mask) in poll.c) */
-               conn->plan.pollflag = 0;
-               conn->plan = conn->plan.next(conn, conn->plan.next_arg);
-               backend_plan_changed(conn);
+       case 1:
+               next_plan(conn, plan);
+               break;
+       default:
+               /* IO should only return -1, 0 or 1 */
+               abort();
        }
-       set_current(NULL);
 }
 
-/* Close the connection, we're done. */
-struct io_plan io_close_(void)
+void io_ready(struct io_conn *conn, int pollflags)
 {
-       struct io_plan plan;
-
-       plan.pollflag = 0;
-       /* This means we're closing. */
-       plan.next = NULL;
-       plan.u1.s = errno;
+       if (pollflags & POLLIN)
+               do_plan(conn, &conn->plan[IO_IN]);
 
-       return plan;
+       if (pollflags & POLLOUT)
+               do_plan(conn, &conn->plan[IO_OUT]);
 }
 
-struct io_plan io_close_cb(struct io_conn *conn, void *arg)
+void io_do_always(struct io_conn *conn)
 {
-       return io_close();
+       if (conn->plan[IO_IN].status == IO_ALWAYS)
+               next_plan(conn, &conn->plan[IO_IN]);
+
+       if (conn->plan[IO_OUT].status == IO_ALWAYS)
+               next_plan(conn, &conn->plan[IO_OUT]);
 }
 
-void io_close_other(struct io_conn *conn)
+void io_do_wakeup(struct io_conn *conn, struct io_plan *plan)
 {
-       /* Don't close if already closing! */
-       if (conn->plan.next) {
-               conn->plan = io_close_();
-               backend_plan_changed(conn);
-       }
+       assert(plan->status == IO_WAITING);
+       next_plan(conn, plan);
 }
 
-/* Exit the loop, returning this (non-NULL) arg. */
-struct io_plan io_break_(void *ret, struct io_plan plan)
+/* Close the connection, we're done. */
+struct io_plan *io_close(struct io_conn *conn)
 {
-       io_plan_debug_again();
+       /* Already closing?  Don't close twice. */
+       if (conn->plan[IO_IN].status == IO_CLOSING)
+               return &conn->plan[IO_IN];
 
-       assert(ret);
-       io_loop_return = ret;
+       conn->plan[IO_IN].status = conn->plan[IO_OUT].status = IO_CLOSING;
+       conn->plan[IO_IN].u1.s = errno;
+       backend_new_closing(conn);
 
-       return plan;
+       return &conn->plan[IO_IN];
 }
 
-static struct io_plan io_never_called(struct io_conn *conn, void *arg)
+struct io_plan *io_close_cb(struct io_conn *conn, void *arg)
 {
-       abort();
+       return io_close(conn);
 }
 
-struct io_plan io_never(void)
+/* Exit the loop, returning this (non-NULL) arg. */
+void io_break(const void *ret)
 {
-       return io_always_(io_never_called, NULL);
+       assert(ret);
+       io_loop_return = (void *)ret;
 }
 
-int io_conn_fd(const struct io_conn *conn)
+struct io_plan *io_never(struct io_conn *conn)
 {
-       return conn->fd.fd;
+       return io_always(conn, IO_IN, io_never_called, NULL);
 }
 
-void io_set_alloc(void *(*allocfn)(size_t size),
-                 void *(*reallocfn)(void *ptr, size_t size),
-                 void (*freefn)(void *ptr))
+int io_conn_fd(const struct io_conn *conn)
 {
-       io_alloc.alloc = allocfn;
-       io_alloc.realloc = reallocfn;
-       io_alloc.free = freefn;
+       return conn->fd.fd;
 }