ccan/io: test custom io functions.
[ccan] / ccan / io / io.c
index 325db7872153952895b60d5b6dc4c99f1cb9fe0a..b3c4c760eb445f4ed6c188de08dd7bbad4cd2b22 100644 (file)
@@ -1,4 +1,4 @@
-/* Licensed under BSD-MIT - see LICENSE file for details */
+/* Licensed under LGPLv2.1+ - see LICENSE file for details */
 #include "io.h"
 #include "backend.h"
 #include <sys/types.h>
@@ -8,13 +8,51 @@
 #include <errno.h>
 #include <stdlib.h>
 #include <assert.h>
+#include <poll.h>
 
 void *io_loop_return;
 
+#ifdef DEBUG
+bool io_plan_for_other;
+struct io_conn *current;
+bool (*io_debug)(struct io_conn *conn);
+bool io_debug_wakeup;
+
+void io_plan_debug(struct io_plan *plan)
+{
+       if (io_plan_for_other) {
+               io_plan_for_other = false;
+               return;
+       }
+
+       if (!io_debug || !current)
+               return;
+
+       if (!io_debug(current) && !io_debug_wakeup)
+               return;
+
+       io_debug_wakeup = false;
+       current->plan = *plan;
+       backend_plan_changed(current);
+
+       /* Call back into the loop immediately. */
+       io_loop_return = io_loop();
+}
+
+static void debug_io_wake(struct io_conn *conn)
+{
+       /* We want linear if we wake a debugged connection, too. */
+       if (io_debug && io_debug(conn))
+               io_debug_wakeup = true;
+}
+#else
+static void debug_io_wake(struct io_conn *conn)
+{
+}
+#endif
+
 struct io_listener *io_new_listener_(int fd,
-                                    struct io_op *(*start)(struct io_conn *,
-                                                           void *arg),
-                                    void (*finish)(struct io_conn *, void *),
+                                    void (*init)(int fd, void *arg),
                                     void *arg)
 {
        struct io_listener *l = malloc(sizeof(*l));
@@ -24,9 +62,8 @@ struct io_listener *io_new_listener_(int fd,
 
        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;
+       l->init = init;
+       l->arg = arg;
        if (!add_listener(l)) {
                free(l);
                return NULL;
@@ -42,7 +79,7 @@ void io_close_listener(struct io_listener *l)
 }
 
 struct io_conn *io_new_conn_(int fd,
-                            struct io_op *(*start)(struct io_conn *, void *),
+                            struct io_plan plan,
                             void (*finish)(struct io_conn *, void *),
                             void *arg)
 {
@@ -53,10 +90,11 @@ struct io_conn *io_new_conn_(int fd,
 
        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->state = NEXT;
+       conn->plan = plan;
+       conn->finish = finish;
+       conn->finish_arg = arg;
+       conn->duplex = NULL;
+       conn->timeout = NULL;
        if (!add_conn(conn)) {
                free(conn);
                return NULL;
@@ -64,166 +102,241 @@ struct io_conn *io_new_conn_(int fd,
        return conn;
 }
 
-/* Convenient token which only we can produce. */
-static inline struct io_next *to_ionext(struct io_conn *conn)
+struct io_conn *io_duplex_(struct io_conn *old,
+                          struct io_plan plan,
+                          void (*finish)(struct io_conn *, void *),
+                          void *arg)
 {
-       return (struct io_next *)conn;
+       struct io_conn *conn;
+
+       assert(!old->duplex);
+
+       conn = malloc(sizeof(*conn));
+       if (!conn)
+               return NULL;
+
+       conn->fd.listener = false;
+       conn->fd.fd = old->fd.fd;
+       conn->plan = plan;
+       conn->duplex = old;
+       conn->finish = finish;
+       conn->finish_arg = arg;
+       conn->timeout = NULL;
+       if (!add_duplex(conn)) {
+               free(conn);
+               return NULL;
+       }
+       old->duplex = conn;
+       return conn;
 }
 
-static inline struct io_op *to_ioop(enum io_state state)
+bool io_timeout_(struct io_conn *conn, struct timespec ts,
+                struct io_plan (*cb)(struct io_conn *, void *), void *arg)
 {
-       return (struct io_op *)(long)state;
+       assert(cb);
+
+       if (!conn->timeout) {
+               conn->timeout = malloc(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, ts);
+       return true;
 }
 
-static inline struct io_conn *from_ionext(struct io_next *next)
+/* Returns true if we're finished. */
+static bool do_write(int fd, struct io_plan *plan)
 {
-       return (struct io_conn *)next;
+       ssize_t ret = write(fd, plan->u.write.buf, plan->u.write.len);
+       if (ret < 0) {
+               /* Override next function to close us. */
+               plan->next = io_close;
+               return true;
+       }
+
+       plan->u.write.buf += ret;
+       plan->u.write.len -= ret;
+       return (plan->u.write.len == 0);
 }
 
-struct io_next *io_next_(struct io_conn *conn,
-                        struct io_op *(*next)(struct io_conn *, void *),
+/* 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)
 {
-       conn->fd.next = next;
-       conn->fd.next_arg = arg;
+       struct io_plan plan;
+
+       assert(cb);
+       plan.u.write.buf = data;
+       plan.u.write.len = len;
+       plan.io = do_write;
+       plan.next = cb;
+       plan.next_arg = arg;
+       plan.pollflag = POLLOUT;
 
-       return to_ionext(conn);
+       io_plan_debug(&plan);
+       return plan;
 }
 
-/* Queue some data to be written. */
-struct io_op *io_write(const void *data, size_t len, struct io_next *next)
+static bool do_read(int fd, struct io_plan *plan)
 {
-       struct io_conn *conn = from_ionext(next);
-       conn->u.write.buf = data;
-       conn->u.write.len = len;
-       return to_ioop(WRITE);
+       ssize_t ret = read(fd, plan->u.read.buf, plan->u.read.len);
+       if (ret <= 0) {
+               /* Override next function to close us. */
+               plan->next = io_close;
+               return true;
+       }
+
+       plan->u.read.buf += ret;
+       plan->u.read.len -= ret;
+       return (plan->u.read.len == 0);
 }
 
 /* Queue a request to read into a buffer. */
-struct io_op *io_read(void *data, size_t len, struct io_next *next)
+struct io_plan io_read_(void *data, size_t len,
+                       struct io_plan (*cb)(struct io_conn *, void *),
+                       void *arg)
 {
-       struct io_conn *conn = from_ionext(next);
-       conn->u.read.buf = data;
-       conn->u.read.len = len;
-       return to_ioop(READ);
+       struct io_plan plan;
+
+       assert(cb);
+       plan.u.read.buf = data;
+       plan.u.read.len = len;
+       plan.io = do_read;
+       plan.next = cb;
+       plan.next_arg = arg;
+       plan.pollflag = POLLIN;
+
+       io_plan_debug(&plan);
+       return plan;
+}
+
+static bool do_read_partial(int fd, struct io_plan *plan)
+{
+       ssize_t ret = read(fd, plan->u.readpart.buf, *plan->u.readpart.lenp);
+       if (ret <= 0) {
+               /* Override next function to close us. */
+               plan->next = io_close;
+               return true;
+       }
+
+       *plan->u.readpart.lenp = ret;
+       return true;
 }
 
 /* Queue a partial request to read into a buffer. */
-struct io_op *io_read_partial(void *data, size_t *len, struct io_next *next)
+struct io_plan io_read_partial_(void *data, size_t *len,
+                               struct io_plan (*cb)(struct io_conn *, void *),
+                               void *arg)
+{
+       struct io_plan plan;
+
+       assert(cb);
+       plan.u.readpart.buf = data;
+       plan.u.readpart.lenp = len;
+       plan.io = do_read_partial;
+       plan.next = cb;
+       plan.next_arg = arg;
+       plan.pollflag = POLLIN;
+
+       io_plan_debug(&plan);
+       return plan;
+}
+
+static bool do_write_partial(int fd, struct io_plan *plan)
 {
-       struct io_conn *conn = from_ionext(next);
-       conn->u.readpart.buf = data;
-       conn->u.readpart.lenp = len;
-       return to_ioop(READPART);
+       ssize_t ret = write(fd, plan->u.writepart.buf, *plan->u.writepart.lenp);
+       if (ret < 0) {
+               /* Override next function to close us. */
+               plan->next = io_close;
+               return true;
+       }
+
+       *plan->u.writepart.lenp = ret;
+       return true;
 }
 
 /* Queue a partial write request. */
-struct io_op *io_write_partial(const void *data, size_t *len, struct io_next *next)
+struct io_plan io_write_partial_(const void *data, size_t *len,
+                                struct io_plan (*cb)(struct io_conn*, void *),
+                                void *arg)
 {
-       struct io_conn *conn = from_ionext(next);
-       conn->u.writepart.buf = data;
-       conn->u.writepart.lenp = len;
-       return to_ioop(WRITEPART);
+       struct io_plan plan;
+
+       assert(cb);
+       plan.u.writepart.buf = data;
+       plan.u.writepart.lenp = len;
+       plan.io = do_write_partial;
+       plan.next = cb;
+       plan.next_arg = arg;
+       plan.pollflag = POLLOUT;
+
+       io_plan_debug(&plan);
+       return plan;
 }
 
-struct io_op *io_idle(struct io_conn *conn)
+struct io_plan io_idle(void)
 {
-       return to_ioop(IDLE);
+       struct io_plan plan;
+
+       plan.pollflag = 0;
+       plan.io = NULL;
+       /* Never called (overridded by io_wake), but NULL means closing */
+       plan.next = io_close;
+
+       io_plan_debug(&plan);
+       return plan;
 }
 
-void io_wake_(struct io_conn *conn,
-             struct io_op *(*next)(struct io_conn *, void *), void *arg)
+void io_wake_(struct io_conn *conn, struct io_plan plan)
 
 {
-       /* It might have finished, but we haven't called its finish() yet. */
-       if (conn->state == FINISHED)
+       /* It might be closing, but we haven't called its finish() yet. */
+       if (!conn->plan.next)
                return;
-       assert(conn->state == IDLE);
-       conn->fd.next = next;
-       conn->fd.next_arg = arg;
-       backend_set_state(conn, to_ioop(NEXT));
-}
-
-static struct io_op *do_next(struct io_conn *conn)
-{
-       return conn->fd.next(conn, conn->fd.next_arg);
-}
-
-struct io_op *do_writeable(struct io_conn *conn)
-{
-       ssize_t ret;
-       bool finished;
-
-       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;
-       default:
-               /* Shouldn't happen. */
-               abort();
-       }
+       /* It was idle, right? */
+       assert(!conn->plan.io);
+       conn->plan = plan;
+       backend_plan_changed(conn);
 
-       if (finished)
-               return do_next(conn);
-       return to_ioop(conn->state);
-}
-
-struct io_op *do_readable(struct io_conn *conn)
-{
-       ssize_t ret;
-       bool finished;
-
-       switch (conn->state) {
-       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;
-       default:
-               /* Shouldn't happen. */
-               abort();
-       }
+       debug_io_wake(conn);
+}
 
-       if (finished)
-               return do_next(conn);
-       return to_ioop(conn->state);
+void io_ready(struct io_conn *conn)
+{
+       if (conn->plan.io(conn->fd.fd, &conn->plan)) {
+               set_current(conn);
+               if (timeout_active(conn))
+                       backend_del_timeout(conn);
+               conn->plan = conn->plan.next(conn, conn->plan.next_arg);
+               backend_plan_changed(conn);
+               set_current(NULL);
+       }
 }
 
 /* Useful next functions. */
 /* Close the connection, we're done. */
-struct io_op *io_close(struct io_conn *conn, void *arg)
+struct io_plan io_close(struct io_conn *conn, void *arg)
 {
-       return to_ioop(FINISHED);
+       struct io_plan plan;
+
+       plan.pollflag = 0;
+       /* This means we're closing. */
+       plan.next = NULL;
+
+       io_plan_debug(&plan);
+       return plan;
 }
 
 /* Exit the loop, returning this (non-NULL) arg. */
-struct io_op *io_break(void *arg, struct io_next *next)
+struct io_plan io_break_(void *ret, struct io_plan plan)
 {
-       io_loop_return = arg;
+       assert(ret);
+       io_loop_return = ret;
 
-       return to_ioop(NEXT);
+       return plan;
 }