git.ozlabs.org Git - ccan/blob - 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  * @data: the data buffer.
 131  * @len: the length to write.
 132  * @cb: function to call once it's done.
 133  * @arg: @cb argument
 134  *
 135  * This will queue the data buffer for writing.  Once it's all
 136  * written, the @cb function will be called: on an error, the finish
 137  * function is called instead.
 138  *
 139  * Note that the I/O may actually be done immediately.
 140  */
 141 #define io_write(data, len, cb, arg)                                    \
 142         io_write_((data), (len),                                        \
 143                   typesafe_cb_preargs(struct io_plan, void *,           \
 144                                       (cb), (arg), struct io_conn *),   \
 145                   (arg))
 146 struct io_plan io_write_(const void *data, size_t len,
 147                          struct io_plan (*cb)(struct io_conn *, void *),
 148                          void *arg);
 149
 150 /**
 151  * io_read - queue buffer to be read.
 152  * @data: the data buffer.
 153  * @len: the length to read.
 154  * @cb: function to call once it's done.
 155  * @arg: @cb argument
 156  *
 157  * This will queue the data buffer for reading.  Once it's all read,
 158  * the @cb function will be called: on an error, the finish function
 159  * is called instead.
 160  *
 161  * Note that the I/O may actually be done immediately.
 162  */
 163 #define io_read(data, len, cb, arg)                                     \
 164         io_read_((data), (len),                                         \
 165                  typesafe_cb_preargs(struct io_plan, void *,            \
 166                                      (cb), (arg), struct io_conn *),    \
 167                  (arg))
 168 struct io_plan io_read_(void *data, size_t len,
 169                         struct io_plan (*cb)(struct io_conn *, void *),
 170                         void *arg);
 171
 172
 173 /**
 174  * io_read_partial - queue buffer to be read (partial OK).
 175  * @data: the data buffer.
 176  * @len: the maximum length to read, set to the length actually read.
 177  * @cb: function to call once it's done.
 178  * @arg: @cb argument
 179  *
 180  * This will queue the data buffer for reading.  Once any data is
 181  * read, @len is updated and the @cb function will be called: on an
 182  * error, the finish function is called instead.
 183  *
 184  * Note that the I/O may actually be done immediately.
 185  */
 186 #define io_read_partial(data, len, cb, arg)                             \
 187         io_read_partial_((data), (len),                                 \
 188                          typesafe_cb_preargs(struct io_plan, void *,    \
 189                                              (cb), (arg), struct io_conn *), \
 190                          (arg))
 191 struct io_plan io_read_partial_(void *data, size_t *len,
 192                                 struct io_plan (*cb)(struct io_conn *, void *),
 193                                 void *arg);
 194
 195 /**
 196  * io_write_partial - queue data to be written (partial OK).
 197  * @data: the data buffer.
 198  * @len: the maximum length to write, set to the length actually written.
 199  * @cb: function to call once it's done.
 200  * @arg: @cb argument
 201  *
 202  * This will queue the data buffer for writing.  Once any data is
 203  * written, @len is updated and the @cb function will be called: on an
 204  * error, the finish function is called instead.
 205  *
 206  * Note that the I/O may actually be done immediately.
 207  */
 208 #define io_write_partial(data, len, cb, arg)                            \
 209         io_write_partial_((data), (len),                                \
 210                           typesafe_cb_preargs(struct io_plan, void *,   \
 211                                               (cb), (arg), struct io_conn *), \
 212                           (arg))
 213 struct io_plan io_write_partial_(const void *data, size_t *len,
 214                                  struct io_plan (*cb)(struct io_conn *, void*),
 215                                  void *arg);
 216
 217
 218 /**
 219  * io_idle - explicitly note that this connection will do nothing.
 220  *
 221  * This indicates the connection is idle: some other function will
 222  * later call io_read/io_write etc. (or io_close) on it, in which case
 223  * it will do that.
 224  */
 225 struct io_plan io_idle(void);
 226
 227 /**
 228  * io_timeout - set timeout function if the callback doesn't fire.
 229  * @conn: the current connection.
 230  * @ts: how long until the timeout should be called.
 231  * @cb to call.
 232  * @arg: argument to @cb.
 233  *
 234  * If the usual next callback is not called for this connection before @ts,
 235  * this function will be called.  If next callback is called, the timeout
 236  * is automatically removed.
 237  *
 238  * Returns false on allocation failure.  A connection can only have one
 239  * timeout.
 240  */
 241 #define io_timeout(conn, ts, fn, arg)                                   \
 242         io_timeout_((conn), (ts),                                       \
 243                     typesafe_cb_preargs(struct io_plan, void *,         \
 244                                         (fn), (arg),                    \
 245                                         struct io_conn *),              \
 246                     (arg))
 247 bool io_timeout_(struct io_conn *conn, struct timespec ts,
 248                  struct io_plan (*fn)(struct io_conn *, void *), void *arg);
 249
 250 /**
 251  * io_duplex - split an fd into two connections.
 252  * @conn: a connection.
 253  * @start: the first function to call.
 254  * @finish: the function to call when it's closed or fails.
 255  * @arg: the argument to both @start and @finish.
 256  *
 257  * Sometimes you want to be able to simultaneously read and write on a
 258  * single fd, but io forces a linear call sequence.  The solition is
 259  * to have two connections for the same fd, and use one for read
 260  * operations and one for write.
 261  *
 262  * You must io_close() both of them to close the fd.
 263  */
 264 #define io_duplex(conn, start, finish, arg)                             \
 265         io_duplex_((conn),                                              \
 266                    typesafe_cb_preargs(struct io_plan, void *,          \
 267                                        (start), (arg), struct io_conn *), \
 268                    typesafe_cb_preargs(void, void *, (finish), (arg),   \
 269                                        struct io_conn *),               \
 270                    (arg))
 271
 272 struct io_conn *io_duplex_(struct io_conn *conn,
 273                            struct io_plan (*start)(struct io_conn *, void *),
 274                            void (*finish)(struct io_conn *, void *),
 275                            void *arg);
 276
 277 /**
 278  * io_wake - wake up and idle connection.
 279  * @conn: an idle connection.
 280  * @fn: the next function to call once queued IO is complete.
 281  * @arg: the argument to @next.
 282  *
 283  * This makes @conn run its @next function the next time around the
 284  * io_loop().
 285  */
 286 #define io_wake(conn, fn, arg)                                          \
 287         io_wake_((conn),                                                \
 288                  typesafe_cb_preargs(struct io_plan, void *,            \
 289                                      (fn), (arg), struct io_conn *),    \
 290                  (arg))
 291 void io_wake_(struct io_conn *conn,
 292               struct io_plan (*fn)(struct io_conn *, void *), void *arg);
 293
 294 /**
 295  * io_break - return from io_loop()
 296  * @ret: non-NULL value to return from io_loop().
 297  * @cb: function to call once on return
 298  * @arg: @cb argument
 299  *
 300  * This breaks out of the io_loop.  As soon as the current @next
 301  * function returns, any io_closed()'d connections will have their
 302  * finish callbacks called, then io_loop() with return with @ret.
 303  *
 304  * If io_loop() is called again, then @cb will be called.
 305  */
 306 #define io_break(ret, fn, arg)                                          \
 307         io_break_((ret),                                                \
 308                   typesafe_cb_preargs(struct io_plan, void *,           \
 309                                       (fn), (arg), struct io_conn *),   \
 310                   (arg))
 311 struct io_plan io_break_(void *ret,
 312                          struct io_plan (*fn)(struct io_conn *, void *),
 313                          void *arg);
 314
 315 /* FIXME: io_recvfrom/io_sendto */
 316
 317 /**
 318  * io_close - terminate a connection.
 319  * @conn: any connection.
 320  *
 321  * The schedules a connection to be closed.  It can be done on any
 322  * connection, whether it has I/O queued or not (though that I/O may
 323  * be performed first).
 324  *
 325  * It's common to 'return io_close(...)' from a @next function, but
 326  * io_close can also be used as an argument to io_next().
 327  */
 328 struct io_plan io_close(struct io_conn *, void *unused);
 329
 330 /**
 331  * io_loop - process fds until all closed on io_break.
 332  *
 333  * This is the core loop; it exits with the io_break() arg, or NULL if
 334  * all connections and listeners are closed.
 335  */
 336 void *io_loop(void);
 337 #endif /* CCAN_IO_H */