X-Git-Url: http://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Fio%2Fio.h;h=72f805244c91ad89c4404703f4b276608339142f;hp=a027fe714aa5dc5c26432c44f327c486ec0e9831;hb=e2ce04eac30ec613c858bd4cd2ca12e1c464edb8;hpb=625bae8f5720d3ad3253ea9b26ad68abcd81bde5 diff --git a/ccan/io/io.h b/ccan/io/io.h index a027fe71..72f80524 100644 --- a/ccan/io/io.h +++ b/ccan/io/io.h @@ -8,39 +8,6 @@ struct io_conn; -struct io_state_read { - char *buf; - size_t len; -}; - -struct io_state_write { - const char *buf; - size_t len; -}; - -struct io_state_readpart { - char *buf; - size_t *lenp; -}; - -struct io_state_writepart { - const char *buf; - size_t *lenp; -}; - -enum io_result { - RESULT_AGAIN, - RESULT_FINISHED, - RESULT_CLOSE -}; - -enum io_state { - IO_IO, - IO_NEXT, /* eg starting, woken from idle, return from io_break. */ - IO_IDLE, - IO_FINISHED -}; - /** * struct io_plan - returned from a setup function. * @@ -48,73 +15,96 @@ enum io_state { */ struct io_plan { int pollflag; - enum io_state state; - enum io_result (*io)(struct io_conn *conn); + /* Only NULL if idle. */ + bool (*io)(int fd, struct io_plan *plan); + /* Only NULL if closing. */ struct io_plan (*next)(struct io_conn *, void *arg); void *next_arg; union { - struct io_state_read read; - struct io_state_write write; - struct io_state_readpart readpart; - struct io_state_writepart writepart; + struct { + char *buf; + size_t len; + } read; + struct { + const char *buf; + size_t len; + } write; + struct { + char *buf; + size_t *lenp; + } readpart; + struct { + const char *buf; + size_t *lenp; + } writepart; + struct { + void *p; + size_t len; + } ptr_len; + struct { + void *p1; + void *p2; + } ptr_ptr; + struct { + size_t len1; + size_t len2; + } len_len; } u; }; +#ifdef DEBUG +extern bool io_plan_for_other; +extern bool (*io_debug)(struct io_conn *conn); +#define io_plan_other() ((io_plan_for_other = true)) +void io_plan_debug(struct io_plan *plan); +#else +#define io_plan_other() (void)0 +static inline void io_plan_debug(struct io_plan *plan) { } +#endif + /** * io_new_conn - create a new connection. * @fd: the file descriptor. - * @start: the first function to call. + * @plan: the first I/O function. * @finish: the function to call when it's closed or fails. - * @arg: the argument to both @start and @finish. + * @arg: the argument to @finish. * - * This creates a connection which owns @fd. @start will be called on the - * next return to io_loop(), and @finish will be called when an I/O operation + * This creates a connection which owns @fd. @plan will be called on the + * next io_loop(), and @finish will be called when an I/O operation * fails, or you call io_close() on the connection. * - * The @start function must call one of the io queueing functions - * (eg. io_read, io_write) and return the next function to call once - * that is done using io_next(). The alternative is to call io_close(). - * * Returns NULL on error (and sets errno). */ -#define io_new_conn(fd, start, finish, arg) \ - io_new_conn_((fd), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (start), (arg), struct io_conn *), \ - typesafe_cb_preargs(void, void *, (finish), (arg), \ - struct io_conn *), \ - (arg)) +#define io_new_conn(fd, plan, finish, arg) \ + (io_plan_other(), io_new_conn_((fd), (plan), \ + typesafe_cb_preargs(void, void *, \ + (finish), (arg), \ + struct io_conn *), \ + (arg))) struct io_conn *io_new_conn_(int fd, - struct io_plan (*start)(struct io_conn *, void *), + struct io_plan plan, void (*finish)(struct io_conn *, void *), void *arg); /** * io_new_listener - create a new accepting listener. * @fd: the file descriptor. - * @start: the first function to call on new connections. - * @finish: the function to call when the connection is closed or fails. - * @arg: the argument to both @start and @finish. + * @init: the function to call for a new connection + * @arg: the argument to @init. * - * When @fd becomes readable, we accept() and turn that fd into a new - * connection. + * When @fd becomes readable, we accept() and pass that fd to init(). * * Returns NULL on error (and sets errno). */ -#define io_new_listener(fd, start, finish, arg) \ +#define io_new_listener(fd, init, arg) \ io_new_listener_((fd), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (start), (arg), \ - struct io_conn *), \ - typesafe_cb_preargs(void, void *, (finish), \ - (arg), struct io_conn *), \ + typesafe_cb_preargs(void, void *, \ + (init), (arg), \ + int fd), \ (arg)) struct io_listener *io_new_listener_(int fd, - struct io_plan (*start)(struct io_conn *, - void *arg), - void (*finish)(struct io_conn *, - void *arg), + void (*init)(int fd, void *arg), void *arg); /** @@ -127,7 +117,6 @@ void io_close_listener(struct io_listener *listener); /** * io_write - queue data to be written. - * @conn: the current connection. * @data: the data buffer. * @len: the length to write. * @cb: function to call once it's done. @@ -139,18 +128,17 @@ void io_close_listener(struct io_listener *listener); * * Note that the I/O may actually be done immediately. */ -#define io_write(conn, data, len, cb, arg) \ - io_write_((conn), (data), (len), \ +#define io_write(data, len, cb, arg) \ + io_write_((data), (len), \ typesafe_cb_preargs(struct io_plan, void *, \ (cb), (arg), struct io_conn *), \ (arg)) -struct io_plan io_write_(struct io_conn *conn, const void *data, size_t len, +struct io_plan io_write_(const void *data, size_t len, struct io_plan (*cb)(struct io_conn *, void *), void *arg); /** * io_read - queue buffer to be read. - * @conn: the current connection. * @data: the data buffer. * @len: the length to read. * @cb: function to call once it's done. @@ -162,19 +150,18 @@ struct io_plan io_write_(struct io_conn *conn, const void *data, size_t len, * * Note that the I/O may actually be done immediately. */ -#define io_read(conn, data, len, cb, arg) \ - io_read_((conn), (data), (len), \ +#define io_read(data, len, cb, arg) \ + io_read_((data), (len), \ typesafe_cb_preargs(struct io_plan, void *, \ (cb), (arg), struct io_conn *), \ (arg)) -struct io_plan io_read_(struct io_conn *conn, void *data, size_t len, +struct io_plan io_read_(void *data, size_t len, struct io_plan (*cb)(struct io_conn *, void *), void *arg); /** * io_read_partial - queue buffer to be read (partial OK). - * @conn: the current connection. * @data: the data buffer. * @len: the maximum length to read, set to the length actually read. * @cb: function to call once it's done. @@ -186,18 +173,17 @@ struct io_plan io_read_(struct io_conn *conn, void *data, size_t len, * * Note that the I/O may actually be done immediately. */ -#define io_read_partial(conn, data, len, cb, arg) \ - io_read_partial_((conn), (data), (len), \ +#define io_read_partial(data, len, cb, arg) \ + io_read_partial_((data), (len), \ typesafe_cb_preargs(struct io_plan, void *, \ (cb), (arg), struct io_conn *), \ (arg)) -struct io_plan io_read_partial_(struct io_conn *conn, void *data, size_t *len, +struct io_plan io_read_partial_(void *data, size_t *len, struct io_plan (*cb)(struct io_conn *, void *), void *arg); /** * io_write_partial - queue data to be written (partial OK). - * @conn: the current connection. * @data: the data buffer. * @len: the maximum length to write, set to the length actually written. * @cb: function to call once it's done. @@ -209,26 +195,24 @@ struct io_plan io_read_partial_(struct io_conn *conn, void *data, size_t *len, * * Note that the I/O may actually be done immediately. */ -#define io_write_partial(conn, data, len, cb, arg) \ - io_write_partial_((conn), (data), (len), \ +#define io_write_partial(data, len, cb, arg) \ + io_write_partial_((data), (len), \ typesafe_cb_preargs(struct io_plan, void *, \ (cb), (arg), struct io_conn *), \ (arg)) -struct io_plan io_write_partial_(struct io_conn *conn, - const void *data, size_t *len, +struct io_plan io_write_partial_(const void *data, size_t *len, struct io_plan (*cb)(struct io_conn *, void*), void *arg); /** * io_idle - explicitly note that this connection will do nothing. - * @conn: the current connection. * * This indicates the connection is idle: some other function will * later call io_read/io_write etc. (or io_close) on it, in which case * it will do that. */ -struct io_plan io_idle(struct io_conn *conn); +struct io_plan io_idle(void); /** * io_timeout - set timeout function if the callback doesn't fire. @@ -256,9 +240,9 @@ bool io_timeout_(struct io_conn *conn, struct timespec ts, /** * io_duplex - split an fd into two connections. * @conn: a connection. - * @start: the first function to call. + * @plan: the first I/O function to call. * @finish: the function to call when it's closed or fails. - * @arg: the argument to both @start and @finish. + * @arg: the argument to @finish. * * Sometimes you want to be able to simultaneously read and write on a * single fd, but io forces a linear call sequence. The solition is @@ -267,57 +251,41 @@ bool io_timeout_(struct io_conn *conn, struct timespec ts, * * You must io_close() both of them to close the fd. */ -#define io_duplex(conn, start, finish, arg) \ - io_duplex_((conn), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (start), (arg), struct io_conn *), \ - typesafe_cb_preargs(void, void *, (finish), (arg), \ - struct io_conn *), \ - (arg)) +#define io_duplex(conn, plan, finish, arg) \ + (io_plan_other(), io_duplex_((conn), (plan), \ + typesafe_cb_preargs(void, void *, \ + (finish), (arg), \ + struct io_conn *), \ + (arg))) struct io_conn *io_duplex_(struct io_conn *conn, - struct io_plan (*start)(struct io_conn *, void *), + struct io_plan plan, void (*finish)(struct io_conn *, void *), void *arg); /** - * io_wake - wake up and idle connection. + * io_wake - wake up an idle connection. * @conn: an idle connection. - * @fn: the next function to call once queued IO is complete. - * @arg: the argument to @next. + * @plan: the next I/O function for @conn. * - * This makes @conn run its @next function the next time around the - * io_loop(). + * This makes @conn do I/O the next time around the io_loop(). */ -#define io_wake(conn, fn, arg) \ - io_wake_((conn), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (fn), (arg), struct io_conn *), \ - (arg)) -void io_wake_(struct io_conn *conn, - struct io_plan (*fn)(struct io_conn *, void *), void *arg); +#define io_wake(conn, plan) (io_plan_other(), io_wake_((conn), (plan))) +void io_wake_(struct io_conn *conn, struct io_plan plan); /** * io_break - return from io_loop() - * @conn: the current connection. * @ret: non-NULL value to return from io_loop(). - * @cb: function to call once on return - * @arg: @cb argument + * @plan: I/O to perform on return (if any) * * This breaks out of the io_loop. As soon as the current @next * function returns, any io_closed()'d connections will have their * finish callbacks called, then io_loop() with return with @ret. * - * If io_loop() is called again, then @cb will be called. + * If io_loop() is called again, then @plan will be carried out. */ -#define io_break(conn, ret, fn, arg) \ - io_break_((conn), (ret), \ - typesafe_cb_preargs(struct io_plan, void *, \ - (fn), (arg), struct io_conn *), \ - (arg)) -struct io_plan io_break_(struct io_conn *conn, void *ret, - struct io_plan (*fn)(struct io_conn *, void *), - void *arg); +#define io_break(ret, plan) (io_plan_other(), io_break_((ret), (plan))) +struct io_plan io_break_(void *ret, struct io_plan plan); /* FIXME: io_recvfrom/io_sendto */