ccan/io: flatten debug callchain.

[ccan] / ccan / io / io.c

diff --git a/ccan/io/io.c b/ccan/io/io.c
index 84be1758330e61481638ce31d72826799089f81b..a4489ee8855c5a67fce5d746672342b345c72dc5 100644 (file)
--- a/ccan/io/io.c
+++ b/ccan/io/io.c
@@ -12,10 +12,61 @@
 
 void *io_loop_return;
 
 
 void *io_loop_return;
 

+#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);
+/* Set when we wake up an connection we are debugging. */
+bool io_debug_wakeup;
+
+struct io_plan io_debug(struct io_plan plan)
+{
+       if (io_plan_nodebug) {
+               io_plan_nodebug = false;
+               return plan;
+       }
+
+       if (!io_debug_conn || !current)
+               return plan;
+
+       if (!io_debug_conn(current) && !io_debug_wakeup)
+               return plan;
+
+       io_debug_wakeup = false;
+       current->plan = plan;
+       backend_plan_changed(current);
+
+       /* Call back into the loop immediately. */
+       io_loop_return = io_loop();
+       return plan;
+}
+
+static void debug_io_wake(struct io_conn *conn)
+{
+       /* We want linear if we wake a debugged connection, too. */
+       if (io_debug_conn && io_debug_conn(conn))
+               io_debug_wakeup = true;
+}
+
+/* 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 debug_io_wake(struct io_conn *conn)
+{
+}
+static void io_plan_debug_again(void)
+{
+}
+#endif
+

 struct io_listener *io_new_listener_(int fd,
 struct io_listener *io_new_listener_(int fd,

-                                    struct io_plan *(*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));
                                     void *arg)
 {
        struct io_listener *l = malloc(sizeof(*l));


@@ -25,9 +76,8 @@ struct io_listener *io_new_listener_(int fd,
 
        l->fd.listener = true;
        l->fd.fd = fd;
 
        l->fd.listener = true;
        l->fd.fd = fd;

-       l->next = start;
-       l->finish = finish;
-       l->conn_arg = arg;
+       l->init = init;
+       l->arg = arg;

        if (!add_listener(l)) {
                free(l);
                return NULL;
        if (!add_listener(l)) {
                free(l);
                return NULL;


@@ -42,23 +92,20 @@ void io_close_listener(struct io_listener *l)
        free(l);
 }
 
        free(l);
 }
 

-struct io_conn *io_new_conn_(int fd,
-                            struct io_plan *(*start)(struct io_conn *, void *),
-                            void (*finish)(struct io_conn *, void *),
-                            void *arg)
+struct io_conn *io_new_conn_(int fd, struct io_plan plan)

 {
        struct io_conn *conn = malloc(sizeof(*conn));
 
 {
        struct io_conn *conn = malloc(sizeof(*conn));
 

+       io_plan_debug_again();
+

        if (!conn)
                return NULL;
 
        conn->fd.listener = false;
        conn->fd.fd = fd;
        if (!conn)
                return NULL;
 
        conn->fd.listener = false;
        conn->fd.fd = fd;

-       conn->next = start;
-       conn->finish = finish;
-       conn->finish_arg = conn->next_arg = arg;
-       conn->pollflag = 0;
-       conn->state = NEXT;
+       conn->plan = plan;
+       conn->finish = NULL;
+       conn->finish_arg = NULL;

        conn->duplex = NULL;
        conn->timeout = NULL;
        if (!add_conn(conn)) {
        conn->duplex = NULL;
        conn->timeout = NULL;
        if (!add_conn(conn)) {


@@ -68,13 +115,20 @@ struct io_conn *io_new_conn_(int fd,
        return conn;
 }
 
        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)
+{
+       conn->finish = finish;
+       conn->finish_arg = arg;
+}
+
+struct io_conn *io_duplex_(struct io_conn *old, struct io_plan plan)

 {
        struct io_conn *conn;
 
 {
        struct io_conn *conn;
 

+       io_plan_debug_again();
+

        assert(!old->duplex);
 
        conn = malloc(sizeof(*conn));
        assert(!old->duplex);
 
        conn = malloc(sizeof(*conn));


@@ -83,12 +137,10 @@ struct io_conn *io_duplex_(struct io_conn *old,
 
        conn->fd.listener = false;
        conn->fd.fd = old->fd.fd;
 
        conn->fd.listener = false;
        conn->fd.fd = old->fd.fd;

-       conn->next = start;
-       conn->finish = finish;
-       conn->finish_arg = conn->next_arg = arg;
-       conn->pollflag = 0;
-       conn->state = NEXT;
+       conn->plan = plan;

        conn->duplex = old;
        conn->duplex = old;

+       conn->finish = NULL;
+       conn->finish_arg = NULL;

        conn->timeout = NULL;
        if (!add_duplex(conn)) {
                free(conn);
        conn->timeout = NULL;
        if (!add_duplex(conn)) {
                free(conn);


@@ -98,14 +150,11 @@ struct io_conn *io_duplex_(struct io_conn *old,
        return conn;
 }
 
        return conn;
 }
 

-static inline struct io_plan *to_ioplan(enum io_state state)
-{
-       return (struct io_plan *)(long)state;
-}
-

 bool io_timeout_(struct io_conn *conn, struct timespec ts,
 bool io_timeout_(struct io_conn *conn, struct timespec ts,

-                struct io_plan *(*cb)(struct io_conn *, void *), void *arg)
+                struct io_plan (*cb)(struct io_conn *, void *), void *arg)

 {
 {

+       assert(cb);
+

        if (!conn->timeout) {
                conn->timeout = malloc(sizeof(*conn->timeout));
                if (!conn->timeout)
        if (!conn->timeout) {
                conn->timeout = malloc(sizeof(*conn->timeout));
                if (!conn->timeout)


@@ -119,166 +168,195 @@ bool io_timeout_(struct io_conn *conn, struct timespec ts,
        return true;
 }
 
        return true;
 }
 

-static enum io_result do_write(struct io_conn *conn)
+/* Returns true if we're finished. */
+static int do_write(int fd, struct io_plan *plan)

 {
 {

-       ssize_t ret = write(conn->fd.fd, conn->u.write.buf, conn->u.write.len);
+       ssize_t ret = write(fd, plan->u.write.buf, plan->u.write.len);

        if (ret < 0)
        if (ret < 0)

-               return RESULT_CLOSE;
-
-       conn->u.write.buf += ret;
-       conn->u.write.len -= ret;
-       if (conn->u.write.len == 0)
-               return RESULT_FINISHED;
-       else
-               return RESULT_AGAIN;
+               return -1;
+
+       plan->u.write.buf += ret;
+       plan->u.write.len -= ret;
+       return (plan->u.write.len == 0);

 }
 
 /* Queue some data to be written. */
 }
 
 /* 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 io_write_(const void *data, size_t len,
+                        struct io_plan (*cb)(struct io_conn *, void *),
+                        void *arg)

 {
 {

-       conn->u.write.buf = data;
-       conn->u.write.len = len;
-       conn->io = do_write;
-       conn->next = cb;
-       conn->next_arg = arg;
-       conn->pollflag = POLLOUT;
-       return to_ioplan(IO);
+       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 plan;

 }
 
 }
 

-static enum io_result do_read(struct io_conn *conn)
+static int do_read(int fd, struct io_plan *plan)

 {
 {

-       ssize_t ret = read(conn->fd.fd, conn->u.read.buf, conn->u.read.len);
+       ssize_t ret = read(fd, plan->u.read.buf, plan->u.read.len);

        if (ret <= 0)
        if (ret <= 0)

-               return RESULT_CLOSE;
-       conn->u.read.buf += ret;
-       conn->u.read.len -= ret;
-       if (conn->u.read.len == 0)
-               return RESULT_FINISHED;
-       else
-               return RESULT_AGAIN;
+               return -1;
+
+       plan->u.read.buf += ret;
+       plan->u.read.len -= ret;
+       return (plan->u.read.len == 0);

 }
 
 /* Queue a request to read into a buffer. */
 }
 
 /* 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_(void *data, size_t len,
+                       struct io_plan (*cb)(struct io_conn *, void *),
+                       void *arg)

 {
 {

-       conn->u.read.buf = data;
-       conn->u.read.len = len;
-       conn->io = do_read;
-       conn->next = cb;
-       conn->next_arg = arg;
-       conn->pollflag = POLLIN;
-       return to_ioplan(IO);
+       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;
+
+       return plan;

 }
 
 }
 

-static enum io_result do_read_partial(struct io_conn *conn)
+static int do_read_partial(int fd, struct io_plan *plan)

 {
 {

-       ssize_t ret = read(conn->fd.fd, conn->u.readpart.buf,
-                          *conn->u.readpart.lenp);
+       ssize_t ret = read(fd, plan->u.readpart.buf, *plan->u.readpart.lenp);

        if (ret <= 0)
        if (ret <= 0)

-               return RESULT_CLOSE;
-       *conn->u.readpart.lenp = ret;
-       return RESULT_FINISHED;
+               return -1;
+
+       *plan->u.readpart.lenp = ret;
+       return 1;

 }
 
 /* Queue a partial request to read into a buffer. */
 }
 
 /* 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_(void *data, size_t *len,
+                               struct io_plan (*cb)(struct io_conn *, void *),
+                               void *arg)

 {
 {

-       conn->u.readpart.buf = data;
-       conn->u.readpart.lenp = len;
-       conn->io = do_read_partial;
-       conn->next = cb;
-       conn->next_arg = arg;
-       conn->pollflag = POLLIN;
-       return to_ioplan(IO);
+       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;
+
+       return plan;

 }
 
 }
 

-static enum io_result do_write_partial(struct io_conn *conn)
+static int do_write_partial(int fd, struct io_plan *plan)

 {
 {

-       ssize_t ret = write(conn->fd.fd, conn->u.writepart.buf,
-                           *conn->u.writepart.lenp);
+       ssize_t ret = write(fd, plan->u.writepart.buf, *plan->u.writepart.lenp);

        if (ret < 0)
        if (ret < 0)

-               return RESULT_CLOSE;
-       *conn->u.writepart.lenp = ret;
-       return RESULT_FINISHED;
+               return -1;
+
+       *plan->u.writepart.lenp = ret;
+       return 1;

 }
 
 /* Queue a partial write request. */
 }
 
 /* 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)
+struct io_plan io_write_partial_(const void *data, size_t *len,
+                                struct io_plan (*cb)(struct io_conn*, void *),
+                                void *arg)

 {
 {

-       conn->u.writepart.buf = data;
-       conn->u.writepart.lenp = len;
-       conn->io = do_write_partial;
-       conn->next = cb;
-       conn->next_arg = arg;
-       conn->pollflag = POLLOUT;
-       return to_ioplan(IO);
+       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;
+
+       return plan;

 }
 
 }
 

-struct io_plan *io_idle(struct io_conn *conn)
+struct io_plan io_idle_(void)

 {
 {

-       conn->pollflag = 0;
-       return to_ioplan(IDLE);
+       struct io_plan plan;
+
+       plan.pollflag = 0;
+       plan.io = NULL;
+       /* Never called (overridden by io_wake), but NULL means closing */
+       plan.next = (void *)io_idle_;
+
+       return plan;

 }
 
 }
 

-void io_wake_(struct io_conn *conn,
-             struct io_plan *(*fn)(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)
+       io_plan_debug_again();
+
+       /* It might be closing, but we haven't called its finish() yet. */
+       if (!conn->plan.next)

                return;
                return;

-       assert(conn->state == IDLE);
-       conn->next = fn;
-       conn->next_arg = arg;
-       backend_set_state(conn, to_ioplan(NEXT));
-}
+       /* It was idle, right? */
+       assert(!conn->plan.io);
+       conn->plan = plan;
+       backend_plan_changed(conn);

 
 

-static struct io_plan *do_next(struct io_conn *conn)
-{
-       if (timeout_active(conn))
-               backend_del_timeout(conn);
-       return conn->next(conn, conn->next_arg);
+       debug_io_wake(conn);

 }
 
 }
 

-struct io_plan *do_ready(struct io_conn *conn)
+void io_ready(struct io_conn *conn)

 {
 {

-       assert(conn->state == IO);
-       switch (conn->io(conn)) {
-       case RESULT_CLOSE:
-               return io_close(conn, NULL);
-       case RESULT_FINISHED:
-               return do_next(conn);
-       case RESULT_AGAIN:
-               return to_ioplan(conn->state);
-       default:
-               abort();
+       switch (conn->plan.io(conn->fd.fd, &conn->plan)) {
+       case -1: /* Failure means a new plan: close up. */
+               set_current(conn);
+               conn->plan = io_close();
+               backend_plan_changed(conn);
+               set_current(NULL);
+               break;
+       case 0: /* Keep going with plan. */
+               break;
+       case 1: /* Done: get next 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. */
 /* Close the connection, we're done. */

-struct io_plan *io_close(struct io_conn *conn, void *arg)
+struct io_plan io_close_(void)

 {
 {

-       return to_ioplan(FINISHED);
+       struct io_plan plan;
+
+       plan.pollflag = 0;
+       /* This means we're closing. */
+       plan.next = NULL;
+       plan.u.close.saved_errno = errno;
+
+       return plan;
+}
+
+struct io_plan io_close_cb(struct io_conn *conn, void *arg)
+{
+       return io_close();

 }
 
 /* Exit the loop, returning this (non-NULL) arg. */
 }
 
 /* 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)
+struct io_plan io_break_(void *ret, struct io_plan plan)

 {
 {

+       io_plan_debug_again();
+
+       assert(ret);

        io_loop_return = ret;
        io_loop_return = ret;

-       conn->next = fn;
-       conn->next_arg = arg;

 
 

-       return to_ioplan(NEXT);
+       return plan;

 }
 }