1 /* Licensed under LGPLv2.1+ - see LICENSE file for details */
5 #include <sys/socket.h>
13 #include <ccan/container_of/container_of.h>
17 struct io_plan io_conn_freed;
19 struct io_listener *io_new_listener_(const tal_t *ctx, int fd,
20 struct io_plan *(*init)(struct io_conn *,
24 struct io_listener *l = tal(ctx, struct io_listener);
28 l->fd.listener = true;
38 void io_close_listener(struct io_listener *l)
43 static struct io_plan *io_never_called(struct io_conn *conn, void *arg)
48 /* Returns false if conn was freed. */
49 static bool next_plan(struct io_conn *conn, struct io_plan *plan)
51 struct io_plan *(*next)(struct io_conn *, void *arg);
55 plan->status = IO_UNSET;
57 plan->next = io_never_called;
59 plan = next(conn, plan->next_arg);
61 if (plan == &io_conn_freed)
64 /* It should have set a plan inside this conn (or duplex) */
65 assert(plan == &conn->plan[IO_IN]
66 || plan == &conn->plan[IO_OUT]
67 || plan == &conn->plan[2]);
68 assert(conn->plan[IO_IN].status != IO_UNSET
69 || conn->plan[IO_OUT].status != IO_UNSET);
71 backend_new_plan(conn);
75 static void set_blocking(int fd, bool block)
77 int flags = fcntl(fd, F_GETFL);
84 fcntl(fd, F_SETFL, flags);
87 struct io_conn *io_new_conn_(const tal_t *ctx, int fd,
88 struct io_plan *(*init)(struct io_conn *, void *),
91 struct io_conn *conn = tal(ctx, struct io_conn);
96 conn->fd.listener = false;
99 conn->finish_arg = NULL;
100 list_node_init(&conn->always);
103 return tal_free(conn);
105 /* Keep our I/O async. */
106 set_blocking(fd, false);
108 /* We start with out doing nothing, and in doing our init. */
109 conn->plan[IO_OUT].status = IO_UNSET;
111 conn->plan[IO_IN].next = init;
112 conn->plan[IO_IN].next_arg = arg;
113 if (!next_plan(conn, &conn->plan[IO_IN]))
119 void io_set_finish_(struct io_conn *conn,
120 void (*finish)(struct io_conn *, void *),
123 conn->finish = finish;
124 conn->finish_arg = arg;
127 struct io_plan_arg *io_plan_arg(struct io_conn *conn, enum io_direction dir)
129 assert(conn->plan[dir].status == IO_UNSET);
131 conn->plan[dir].status = IO_POLLING;
132 return &conn->plan[dir].arg;
135 static struct io_plan *set_always(struct io_conn *conn,
136 enum io_direction dir,
137 struct io_plan *(*next)(struct io_conn *,
141 struct io_plan *plan = &conn->plan[dir];
143 plan->status = IO_ALWAYS;
144 backend_new_always(conn);
145 return io_set_plan(conn, dir, NULL, next, arg);
148 static struct io_plan *io_always_dir(struct io_conn *conn,
149 enum io_direction dir,
150 struct io_plan *(*next)(struct io_conn *,
154 return set_always(conn, dir, next, arg);
157 struct io_plan *io_always_(struct io_conn *conn,
158 struct io_plan *(*next)(struct io_conn *, void *),
161 return io_always_dir(conn, IO_IN, next, arg);
164 struct io_plan *io_out_always_(struct io_conn *conn,
165 struct io_plan *(*next)(struct io_conn *,
169 return io_always_dir(conn, IO_OUT, next, arg);
172 static int do_write(int fd, struct io_plan_arg *arg)
174 ssize_t ret = write(fd, arg->u1.cp, arg->u2.s);
180 return arg->u2.s == 0;
183 /* Queue some data to be written. */
184 struct io_plan *io_write_(struct io_conn *conn, const void *data, size_t len,
185 struct io_plan *(*next)(struct io_conn *, void *),
188 struct io_plan_arg *arg = io_plan_arg(conn, IO_OUT);
191 return set_always(conn, IO_OUT, next, next_arg);
193 arg->u1.const_vp = data;
196 return io_set_plan(conn, IO_OUT, do_write, next, next_arg);
199 static int do_read(int fd, struct io_plan_arg *arg)
201 ssize_t ret = read(fd, arg->u1.cp, arg->u2.s);
207 return arg->u2.s == 0;
210 /* Queue a request to read into a buffer. */
211 struct io_plan *io_read_(struct io_conn *conn,
212 void *data, size_t len,
213 struct io_plan *(*next)(struct io_conn *, void *),
216 struct io_plan_arg *arg = io_plan_arg(conn, IO_IN);
219 return set_always(conn, IO_IN, next, next_arg);
224 return io_set_plan(conn, IO_IN, do_read, next, next_arg);
227 static int do_read_partial(int fd, struct io_plan_arg *arg)
229 ssize_t ret = read(fd, arg->u1.cp, *(size_t *)arg->u2.vp);
233 *(size_t *)arg->u2.vp = ret;
237 /* Queue a partial request to read into a buffer. */
238 struct io_plan *io_read_partial_(struct io_conn *conn,
239 void *data, size_t maxlen, size_t *len,
240 struct io_plan *(*next)(struct io_conn *,
244 struct io_plan_arg *arg = io_plan_arg(conn, IO_IN);
247 return set_always(conn, IO_IN, next, next_arg);
250 /* We store the max len in here temporarily. */
254 return io_set_plan(conn, IO_IN, do_read_partial, next, next_arg);
257 static int do_write_partial(int fd, struct io_plan_arg *arg)
259 ssize_t ret = write(fd, arg->u1.cp, *(size_t *)arg->u2.vp);
263 *(size_t *)arg->u2.vp = ret;
267 /* Queue a partial write request. */
268 struct io_plan *io_write_partial_(struct io_conn *conn,
269 const void *data, size_t maxlen, size_t *len,
270 struct io_plan *(*next)(struct io_conn *,
274 struct io_plan_arg *arg = io_plan_arg(conn, IO_OUT);
277 return set_always(conn, IO_OUT, next, next_arg);
279 arg->u1.const_vp = data;
280 /* We store the max len in here temporarily. */
284 return io_set_plan(conn, IO_OUT, do_write_partial, next, next_arg);
287 static int do_connect(int fd, struct io_plan_arg *arg)
290 socklen_t len = sizeof(err);
292 /* Has async connect finished? */
293 ret = getsockopt(fd, SOL_SOCKET, SO_ERROR, &err, &len);
299 } else if (err == EINPROGRESS)
306 struct io_plan *io_connect_(struct io_conn *conn, const struct addrinfo *addr,
307 struct io_plan *(*next)(struct io_conn *, void *),
310 int fd = io_conn_fd(conn);
312 /* We don't actually need the arg, but we need it polling. */
313 io_plan_arg(conn, IO_OUT);
315 /* Note that io_new_conn() will make fd O_NONBLOCK */
317 /* Immediate connect can happen. */
318 if (connect(fd, addr->ai_addr, addr->ai_addrlen) == 0)
319 return set_always(conn, IO_OUT, next, next_arg);
321 if (errno != EINPROGRESS)
322 return io_close(conn);
324 return io_set_plan(conn, IO_OUT, do_connect, next, next_arg);
327 static struct io_plan *io_wait_dir(struct io_conn *conn,
329 enum io_direction dir,
330 struct io_plan *(*next)(struct io_conn *,
334 struct io_plan_arg *arg = io_plan_arg(conn, dir);
335 arg->u1.const_vp = wait;
337 conn->plan[dir].status = IO_WAITING;
339 return io_set_plan(conn, dir, NULL, next, next_arg);
342 struct io_plan *io_wait_(struct io_conn *conn,
344 struct io_plan *(*next)(struct io_conn *, void *),
347 return io_wait_dir(conn, wait, IO_IN, next, next_arg);
350 struct io_plan *io_out_wait_(struct io_conn *conn,
352 struct io_plan *(*next)(struct io_conn *, void *),
355 return io_wait_dir(conn, wait, IO_OUT, next, next_arg);
358 void io_wake(const void *wait)
363 /* Returns false if this has been freed. */
364 static bool do_plan(struct io_conn *conn, struct io_plan *plan)
366 /* We shouldn't have polled for this event if this wasn't true! */
367 assert(plan->status == IO_POLLING);
369 switch (plan->io(conn->fd.fd, &plan->arg)) {
376 return next_plan(conn, plan);
378 /* IO should only return -1, 0 or 1 */
383 void io_ready(struct io_conn *conn, int pollflags)
385 if (pollflags & POLLIN)
386 if (!do_plan(conn, &conn->plan[IO_IN]))
389 if (pollflags & POLLOUT)
390 do_plan(conn, &conn->plan[IO_OUT]);
393 void io_do_always(struct io_conn *conn)
395 if (conn->plan[IO_IN].status == IO_ALWAYS)
396 if (!next_plan(conn, &conn->plan[IO_IN]))
399 if (conn->plan[IO_OUT].status == IO_ALWAYS)
400 next_plan(conn, &conn->plan[IO_OUT]);
403 void io_do_wakeup(struct io_conn *conn, enum io_direction dir)
405 struct io_plan *plan = &conn->plan[dir];
407 assert(plan->status == IO_WAITING);
409 set_always(conn, dir, plan->next, plan->next_arg);
412 /* Close the connection, we're done. */
413 struct io_plan *io_close(struct io_conn *conn)
416 return &io_conn_freed;
419 struct io_plan *io_close_cb(struct io_conn *conn, void *next_arg)
421 return io_close(conn);
424 struct io_plan *io_close_taken_fd(struct io_conn *conn)
426 set_blocking(conn->fd.fd, true);
428 cleanup_conn_without_close(conn);
429 return io_close(conn);
432 /* Exit the loop, returning this (non-NULL) arg. */
433 void io_break(const void *ret)
436 io_loop_return = (void *)ret;
439 struct io_plan *io_never(struct io_conn *conn, void *unused)
441 return io_always(conn, io_never_called, NULL);
444 int io_conn_fd(const struct io_conn *conn)
449 struct io_plan *io_duplex(struct io_conn *conn,
450 struct io_plan *in_plan, struct io_plan *out_plan)
452 assert(conn == container_of(in_plan, struct io_conn, plan[IO_IN]));
453 /* in_plan must be conn->plan[IO_IN], out_plan must be [IO_OUT] */
454 assert(out_plan == in_plan + 1);
458 struct io_plan *io_halfclose(struct io_conn *conn)
460 /* Both unset? OK. */
461 if (conn->plan[IO_IN].status == IO_UNSET
462 && conn->plan[IO_OUT].status == IO_UNSET)
463 return io_close(conn);
465 /* We leave this unset then. */
466 if (conn->plan[IO_IN].status == IO_UNSET)
467 return &conn->plan[IO_IN];
469 return &conn->plan[IO_OUT];
472 struct io_plan *io_set_plan(struct io_conn *conn, enum io_direction dir,
473 int (*io)(int fd, struct io_plan_arg *arg),
474 struct io_plan *(*next)(struct io_conn *, void *),
477 struct io_plan *plan = &conn->plan[dir];
481 plan->next_arg = next_arg;
482 assert(next != NULL);
487 bool io_flush_sync(struct io_conn *conn)
489 struct io_plan *plan = &conn->plan[IO_OUT];
492 /* Not writing? Nothing to do. */
493 if (plan->status != IO_POLLING)
496 /* Synchronous please. */
497 set_blocking(io_conn_fd(conn), true);
500 switch (plan->io(conn->fd.fd, &plan->arg)) {
504 /* Incomplete, try again. */
509 /* In case they come back. */
510 set_always(conn, IO_OUT, plan->next, plan->next_arg);
513 /* IO should only return -1, 0 or 1 */
517 set_blocking(io_conn_fd(conn), false);