ccan/io: pass struct io_plan explicitly.
[ccan] / ccan / io / io.h
1 /* Licensed under LGPLv2.1+ - see LICENSE file for details */
2 #ifndef CCAN_IO_H
3 #define CCAN_IO_H
4 #include <ccan/typesafe_cb/typesafe_cb.h>
5 #include <ccan/time/time.h>
6 #include <stdbool.h>
7 #include <unistd.h>
8
9 struct io_conn;
10
11 struct io_state_read {
12         char *buf;
13         size_t len;
14 };
15
16 struct io_state_write {
17         const char *buf;
18         size_t len;
19 };
20
21 struct io_state_readpart {
22         char *buf;
23         size_t *lenp;
24 };
25
26 struct io_state_writepart {
27         const char *buf;
28         size_t *lenp;
29 };
30
31 enum io_result {
32         RESULT_AGAIN,
33         RESULT_FINISHED,
34         RESULT_CLOSE
35 };
36
37 enum io_state {
38         IO_IO,
39         IO_NEXT, /* eg starting, woken from idle, return from io_break. */
40         IO_IDLE,
41         IO_FINISHED
42 };
43
44 /**
45  * struct io_plan - returned from a setup function.
46  *
47  * A plan of what IO to do, when.
48  */
49 struct io_plan {
50         int pollflag;
51         enum io_state state;
52         enum io_result (*io)(struct io_conn *conn);
53         struct io_plan (*next)(struct io_conn *, void *arg);
54         void *next_arg;
55
56         union {
57                 struct io_state_read read;
58                 struct io_state_write write;
59                 struct io_state_readpart readpart;
60                 struct io_state_writepart writepart;
61         } u;
62 };
63
64 /**
65  * io_new_conn - create a new connection.
66  * @fd: the file descriptor.
67  * @start: the first function to call.
68  * @finish: the function to call when it's closed or fails.
69  * @arg: the argument to both @start and @finish.
70  *
71  * This creates a connection which owns @fd.  @start will be called on the
72  * next return to io_loop(), and @finish will be called when an I/O operation
73  * fails, or you call io_close() on the connection.
74  *
75  * The @start function must call one of the io queueing functions
76  * (eg. io_read, io_write) and return the next function to call once
77  * that is done using io_next().  The alternative is to call io_close().
78  *
79  * Returns NULL on error (and sets errno).
80  */
81 #define io_new_conn(fd, start, finish, arg)                             \
82         io_new_conn_((fd),                                              \
83                      typesafe_cb_preargs(struct io_plan, void *,        \
84                                          (start), (arg), struct io_conn *), \
85                      typesafe_cb_preargs(void, void *, (finish), (arg), \
86                                          struct io_conn *),             \
87                      (arg))
88 struct io_conn *io_new_conn_(int fd,
89                              struct io_plan (*start)(struct io_conn *, void *),
90                              void (*finish)(struct io_conn *, void *),
91                              void *arg);
92
93 /**
94  * io_new_listener - create a new accepting listener.
95  * @fd: the file descriptor.
96  * @start: the first function to call on new connections.
97  * @finish: the function to call when the connection is closed or fails.
98  * @arg: the argument to both @start and @finish.
99  *
100  * When @fd becomes readable, we accept() and turn that fd into a new
101  * connection.
102  *
103  * Returns NULL on error (and sets errno).
104  */
105 #define io_new_listener(fd, start, finish, arg)                         \
106         io_new_listener_((fd),                                          \
107                          typesafe_cb_preargs(struct io_plan, void *,    \
108                                              (start), (arg),            \
109                                              struct io_conn *),         \
110                          typesafe_cb_preargs(void, void *, (finish),    \
111                                              (arg), struct io_conn *),  \
112                          (arg))
113 struct io_listener *io_new_listener_(int fd,
114                                      struct io_plan (*start)(struct io_conn *,
115                                                               void *arg),
116                                      void (*finish)(struct io_conn *,
117                                                     void *arg),
118                                      void *arg);
119
120 /**
121  * io_close_listener - delete a listener.
122  * @listener: the listener returned from io_new_listener.
123  *
124  * This closes the fd and frees @listener.
125  */
126 void io_close_listener(struct io_listener *listener);
127
128 /**
129  * io_write - queue data to be written.
130  * @conn: the current connection.
131  * @data: the data buffer.
132  * @len: the length to write.
133  * @cb: function to call once it's done.
134  * @arg: @cb argument
135  *
136  * This will queue the data buffer for writing.  Once it's all
137  * written, the @cb function will be called: on an error, the finish
138  * function is called instead.
139  *
140  * Note that the I/O may actually be done immediately.
141  */
142 #define io_write(conn, data, len, cb, arg)                              \
143         io_write_((conn), (data), (len),                                \
144                   typesafe_cb_preargs(struct io_plan, void *,           \
145                                       (cb), (arg), struct io_conn *),   \
146                   (arg))
147 struct io_plan io_write_(struct io_conn *conn, const void *data, size_t len,
148                          struct io_plan (*cb)(struct io_conn *, void *),
149                          void *arg);
150
151 /**
152  * io_read - queue buffer to be read.
153  * @conn: the current connection.
154  * @data: the data buffer.
155  * @len: the length to read.
156  * @cb: function to call once it's done.
157  * @arg: @cb argument
158  *
159  * This will queue the data buffer for reading.  Once it's all read,
160  * the @cb function will be called: on an error, the finish function
161  * is called instead.
162  *
163  * Note that the I/O may actually be done immediately.
164  */
165 #define io_read(conn, data, len, cb, arg)                               \
166         io_read_((conn), (data), (len),                                 \
167                  typesafe_cb_preargs(struct io_plan, void *,            \
168                                      (cb), (arg), struct io_conn *),    \
169                  (arg))
170 struct io_plan io_read_(struct io_conn *conn, void *data, size_t len,
171                         struct io_plan (*cb)(struct io_conn *, void *),
172                         void *arg);
173
174
175 /**
176  * io_read_partial - queue buffer to be read (partial OK).
177  * @conn: the current connection.
178  * @data: the data buffer.
179  * @len: the maximum length to read, set to the length actually read.
180  * @cb: function to call once it's done.
181  * @arg: @cb argument
182  *
183  * This will queue the data buffer for reading.  Once any data is
184  * read, @len is updated and the @cb function will be called: on an
185  * error, the finish function is called instead.
186  *
187  * Note that the I/O may actually be done immediately.
188  */
189 #define io_read_partial(conn, data, len, cb, arg)                       \
190         io_read_partial_((conn), (data), (len),                         \
191                          typesafe_cb_preargs(struct io_plan, void *,    \
192                                              (cb), (arg), struct io_conn *), \
193                          (arg))
194 struct io_plan io_read_partial_(struct io_conn *conn, void *data, size_t *len,
195                                 struct io_plan (*cb)(struct io_conn *, void *),
196                                 void *arg);
197
198 /**
199  * io_write_partial - queue data to be written (partial OK).
200  * @conn: the current connection.
201  * @data: the data buffer.
202  * @len: the maximum length to write, set to the length actually written.
203  * @cb: function to call once it's done.
204  * @arg: @cb argument
205  *
206  * This will queue the data buffer for writing.  Once any data is
207  * written, @len is updated and the @cb function will be called: on an
208  * error, the finish function is called instead.
209  *
210  * Note that the I/O may actually be done immediately.
211  */
212 #define io_write_partial(conn, data, len, cb, arg)                      \
213         io_write_partial_((conn), (data), (len),                        \
214                           typesafe_cb_preargs(struct io_plan, void *,   \
215                                               (cb), (arg), struct io_conn *), \
216                           (arg))
217 struct io_plan io_write_partial_(struct io_conn *conn,
218                                  const void *data, size_t *len,
219                                  struct io_plan (*cb)(struct io_conn *, void*),
220                                  void *arg);
221
222
223 /**
224  * io_idle - explicitly note that this connection will do nothing.
225  * @conn: the current connection.
226  *
227  * This indicates the connection is idle: some other function will
228  * later call io_read/io_write etc. (or io_close) on it, in which case
229  * it will do that.
230  */
231 struct io_plan io_idle(struct io_conn *conn);
232
233 /**
234  * io_timeout - set timeout function if the callback doesn't fire.
235  * @conn: the current connection.
236  * @ts: how long until the timeout should be called.
237  * @cb to call.
238  * @arg: argument to @cb.
239  *
240  * If the usual next callback is not called for this connection before @ts,
241  * this function will be called.  If next callback is called, the timeout
242  * is automatically removed.
243  *
244  * Returns false on allocation failure.  A connection can only have one
245  * timeout.
246  */
247 #define io_timeout(conn, ts, fn, arg)                                   \
248         io_timeout_((conn), (ts),                                       \
249                     typesafe_cb_preargs(struct io_plan, void *,         \
250                                         (fn), (arg),                    \
251                                         struct io_conn *),              \
252                     (arg))
253 bool io_timeout_(struct io_conn *conn, struct timespec ts,
254                  struct io_plan (*fn)(struct io_conn *, void *), void *arg);
255
256 /**
257  * io_duplex - split an fd into two connections.
258  * @conn: a connection.
259  * @start: the first function to call.
260  * @finish: the function to call when it's closed or fails.
261  * @arg: the argument to both @start and @finish.
262  *
263  * Sometimes you want to be able to simultaneously read and write on a
264  * single fd, but io forces a linear call sequence.  The solition is
265  * to have two connections for the same fd, and use one for read
266  * operations and one for write.
267  *
268  * You must io_close() both of them to close the fd.
269  */
270 #define io_duplex(conn, start, finish, arg)                             \
271         io_duplex_((conn),                                              \
272                    typesafe_cb_preargs(struct io_plan, void *,          \
273                                        (start), (arg), struct io_conn *), \
274                    typesafe_cb_preargs(void, void *, (finish), (arg),   \
275                                        struct io_conn *),               \
276                    (arg))
277
278 struct io_conn *io_duplex_(struct io_conn *conn,
279                            struct io_plan (*start)(struct io_conn *, void *),
280                            void (*finish)(struct io_conn *, void *),
281                            void *arg);
282
283 /**
284  * io_wake - wake up and idle connection.
285  * @conn: an idle connection.
286  * @fn: the next function to call once queued IO is complete.
287  * @arg: the argument to @next.
288  *
289  * This makes @conn run its @next function the next time around the
290  * io_loop().
291  */
292 #define io_wake(conn, fn, arg)                                          \
293         io_wake_((conn),                                                \
294                  typesafe_cb_preargs(struct io_plan, void *,            \
295                                      (fn), (arg), struct io_conn *),    \
296                  (arg))
297 void io_wake_(struct io_conn *conn,
298               struct io_plan (*fn)(struct io_conn *, void *), void *arg);
299
300 /**
301  * io_break - return from io_loop()
302  * @conn: the current connection.
303  * @ret: non-NULL value to return from io_loop().
304  * @cb: function to call once on return
305  * @arg: @cb argument
306  *
307  * This breaks out of the io_loop.  As soon as the current @next
308  * function returns, any io_closed()'d connections will have their
309  * finish callbacks called, then io_loop() with return with @ret.
310  *
311  * If io_loop() is called again, then @cb will be called.
312  */
313 #define io_break(conn, ret, fn, arg)                                    \
314         io_break_((conn), (ret),                                        \
315                   typesafe_cb_preargs(struct io_plan, void *,           \
316                                       (fn), (arg), struct io_conn *),   \
317                   (arg))
318 struct io_plan io_break_(struct io_conn *conn, void *ret,
319                          struct io_plan (*fn)(struct io_conn *, void *),
320                          void *arg);
321
322 /* FIXME: io_recvfrom/io_sendto */
323
324 /**
325  * io_close - terminate a connection.
326  * @conn: any connection.
327  *
328  * The schedules a connection to be closed.  It can be done on any
329  * connection, whether it has I/O queued or not (though that I/O may
330  * be performed first).
331  *
332  * It's common to 'return io_close(...)' from a @next function, but
333  * io_close can also be used as an argument to io_next().
334  */
335 struct io_plan io_close(struct io_conn *, void *unused);
336
337 /**
338  * io_loop - process fds until all closed on io_break.
339  *
340  * This is the core loop; it exits with the io_break() arg, or NULL if
341  * all connections and listeners are closed.
342  */
343 void *io_loop(void);
344 #endif /* CCAN_IO_H */