git.ozlabs.org Git - ccan/blob - ccan/io/io_plan.h

   1 /* Licensed under LGPLv2.1+ - see LICENSE file for details */
   2 #ifndef CCAN_IO_PLAN_H
   3 #define CCAN_IO_PLAN_H
   4 struct io_conn;
   5
   6 /**
   7  * struct io_plan - a plan of what I/O to do.
   8  * @pollflag: POLLIN or POLLOUT.
   9  * @io: function to call when fd is available for @pollflag.
  10  * @next: function to call after @io returns true.
  11  * @next_arg: argument to @next.
  12  * @u: scratch area for I/O.
  13  *
  14  * When the fd is POLLIN or POLLOUT (according to @pollflag), @io is
  15  * called.  If it returns -1, io_close() becomed the new plan (and errno
  16  * is saved).  If it returns 1, @next is called, otherwise @io is
  17  * called again when @pollflag is available.
  18  *
  19  * You can use this to write your own io_plan functions.
  20  */
  21 struct io_plan {
  22         int pollflag;
  23         /* Only NULL if idle. */
  24         int (*io)(int fd, struct io_plan *plan);
  25         /* Only NULL if closing. */
  26         struct io_plan (*next)(struct io_conn *, void *arg);
  27         void *next_arg;
  28
  29         union {
  30                 struct {
  31                         char *buf;
  32                         size_t len;
  33                 } read;
  34                 struct {
  35                         const char *buf;
  36                         size_t len;
  37                 } write;
  38                 struct {
  39                         char *buf;
  40                         size_t *lenp;
  41                 } readpart;
  42                 struct {
  43                         const char *buf;
  44                         size_t *lenp;
  45                 } writepart;
  46                 struct {
  47                         int saved_errno;
  48                 } close;
  49                 struct {
  50                         void *p;
  51                         size_t len;
  52                 } ptr_len;
  53                 struct {
  54                         void *p1;
  55                         void *p2;
  56                 } ptr_ptr;
  57                 struct {
  58                         size_t len1;
  59                         size_t len2;
  60                 } len_len;
  61         } u;
  62 };
  63
  64 #ifdef DEBUG
  65 /**
  66  * io_debug - routine to select connection(s) to debug.
  67  *
  68  * If this is set, the routine should return true if the connection is a
  69  * debugging candidate.  If so, the callchain for I/O operations on this
  70  * connection will be linear, for easier use of a debugger.
  71  */
  72 extern bool (*io_debug)(struct io_conn *conn);
  73
  74 /**
  75  * io_plan_other - mark the next plan not being for the current connection
  76  *
  77  * Most routines which take a plan are about to apply it to the current
  78  * connection.  We (ab)use this pattern for debugging: as soon as such a
  79  * plan is created, it is called, to create a linear call chain.
  80  *
  81  * Some routines, like io_break() and io_wake() take an io_plan, but they
  82  * must not be applied immediately to the current connection, so we call this
  83  * first.
  84  */
  85 #define io_plan_other() ((io_plan_for_other = true))
  86
  87 /**
  88  * io_plan_debug - hook for debugging a plan.
  89  *
  90  * After constructing a plan, call this.  If the current connection is being
  91  * debugged, then it will be immediately serviced with this plan.
  92  */
  93 void io_plan_debug(struct io_plan *plan);
  94 extern bool io_plan_for_other;
  95 #else
  96 #define io_plan_other() (void)0
  97 static inline void io_plan_debug(struct io_plan *plan) { }
  98 #endif
  99
 100 #endif /* CCAN_IO_PLAN_H */