io.h

Go to the documentation of this file.

/* -*- C -*-
 * Serene programming language
 * Copyright (C) 2019-2026 Sameer Rahmani <[email protected]>
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
/** @file
 The fiber facing IO API: blocking looking calls a fiber uses to do IO.
 
 Each call builds a request, suspends the calling fiber, and hands the request to the reactor; the
fiber resumes with the result once the operation completes. The calling worker is never blocked --
it runs other fibers while this one is parked. These are the fiber world replacements for the raw
`read`/`write` and other similar IO related syscalls.
 
 Each call returns a small per-op result which is a fallible value (see errors.h): `maybe_error` is
null on success and carries the failure otherwise, so the success fields are meaningful only when
there is no error. Calls with no value to report (connect, sleep) return `srn_error_t *` directly --
null on success.
 
 Constraints: a suspending call must run on a fiber that is on a worker (it suspends the fiber, so
there must be one). A pollable, non-blocking descriptor (socket, pipe, ...) goes through the
reactor; a regular file is served by a synchronous syscall on the worker, since a readiness backend
cannot poll it.
 
 Backpressure: a channel admits at most one ring's worth of operations in flight, and a suspending
call past that cap fails with the transient CHANNEL_BUSY error. `SRN_WITH_RETRY` wraps a block in
the retry loop (yielding between attempts through `srn_fiber_io_retry`):
 
     srn_io_size_result_t r;
     SRN_WITH_RETRY(r.maybe_error, {
       r = srn_fiber_read(fd, buf, len, -1);
     });
 
 At the end of this file there are a set of convenient non-suspending helpers (socket, bind, listen,
 close, shutdown, getsockopt, setsockopt, open), thin wrappers over the plain syscalls that share
the same fallible result convention. They do not touch the reactor and may be called from any
context. `socket` and `open` force `O_NONBLOCK`/`O_CLOEXEC` so a descriptor handed to the
suspending calls above is always safe for the reactor.
*/
 
#include <stddef.h>
#include <stdint.h>
#include <sys/socket.h>
#include <sys/types.h>
 
#include "serene/rt/errors.h"
 
/**
 * The result of an op that yields a descriptor (srn_fiber_socket, srn_fiber_open).
 * On success `fd` is the descriptor; on failure `maybe_error` is set.
 */
typedef struct srn_io_fd_result_t {
  ERROR_HEADER;
  int fd;
} srn_io_fd_result_t;
 
/**
 * The result of a byte transfer op (read/write/sendto/recvmsg/sendmsg). On
 * success `count` is the number of bytes moved, on failure `maybe_error` is set
 * and `count` is unspecified.
 */
typedef struct srn_io_size_result_t {
  ERROR_HEADER;
  size_t count;
} srn_io_size_result_t;
 
/**
 * The result of srn_fiber_accept. On success `fd` is the accepted descriptor
 * and, when an address buffer was given, `addrlen` is the length of the peer
 * address written into it.
 */
typedef struct srn_io_accept_result_t {
  ERROR_HEADER;
  int fd;
  socklen_t addrlen;
} srn_io_accept_result_t;
 
/**
 * The result of srn_fiber_recvfrom. On success `count` is the number of bytes
 * received and, when an address buffer was given, `addrlen` is the length of
 * the sender address written into it.
 */
typedef struct srn_io_recvfrom_result_t {
  ERROR_HEADER;
  size_t count;
  socklen_t addrlen;
} srn_io_recvfrom_result_t;
 
/**
 * Whether a suspending IO call should be retried, true exactly when `e` is
 * the transient CHANNEL_BUSY error, in which case the calling fiber yields
 * first so its worker can consume completions (which is what reopens the
 * channel's admission window) and run other fibers before the retry. Any
 * other error, and success, return false, so a do/while over this helper
 * (see the file docs) retries precisely the backpressure case and hands
 * every real outcome through. A retrying fiber with no runnable peers and
 * no due completions degenerates to a paced busy loop; if that shows up in
 * practice the upgrade is suspending on the channel until a slot frees,
 * instead of polling.
 */
bool srn_fiber_io_retry(srn_error_t *e);
 
/**
 * Run `block` and retry it (yielding between attempts through
 * srn_fiber_io_retry) while `err` holds the transient CHANNEL_BUSY error.
 * `err` is the error lvalue the block assigns, `r.maybe_error` for a
 * fallible result struct, the variable itself for a plain `srn_error_t *`.
 * Variadic so commas inside the block do not split the arguments.
 *
 *     srn_io_size_result_t r;
 *     SRN_WITH_RETRY(r.maybe_error, {
 *       r = srn_fiber_read(fd, buf, len, -1);
 *     });
 *
 *     srn_error_t *e;
 *     SRN_WITH_RETRY(e, { e = srn_fiber_sleep(duration); });
 */
#define SRN_WITH_RETRY(err, ...) \
  do                             \
    __VA_ARGS__                  \
  while (srn_fiber_io_retry(err))
 
/**
 * Read up to `len` bytes from `fd` into `buf`, suspending the calling fiber
 * until the operation completes rather than blocking its worker. `offset` is
 * the file offset, or -1 to read at the descriptor's current position. On
 * success `count` is the number of bytes read (0 at end of file).
 */
srn_io_size_result_t srn_fiber_read(int fd, void *buf, size_t len, int64_t offset);
 
/**
 * Write `len` bytes from `buf` to `fd`, suspending the calling fiber until the
 * operation completes rather than blocking its worker. `offset` is the file
 * offset, or -1 to write at the descriptor's current position. On success
 * `count` is the number of bytes written.
 */
srn_io_size_result_t srn_fiber_write(int fd, const void *buf, size_t len, int64_t offset);
 
/**
 * Suspend the calling fiber for at least `duration_ns` nanoseconds, letting its
 * worker run other fibers meanwhile. Returns null on a normal wake, or the
 * CANCELED error if the sleep was cut short by a scheduler wind down.
 */
srn_error_t *srn_fiber_sleep_ns(uint64_t duration_ns);
 
/**
 * Suspend the calling fiber for at least `duration_us` microseconds, letting its
 * worker run other fibers meanwhile. Returns null on a normal wake, or the
 * CANCELED error if the sleep was cut short by a scheduler wind down.
 */
srn_error_t *srn_fiber_sleep_us(uint64_t duration_us);
 
/**
 * Suspend the calling fiber for at least `duration_ms` miliseconds, letting its
 * worker run other fibers meanwhile. Returns null on a normal wake, or the
 * CANCELED error if the sleep was cut short by a scheduler wind down.
 */
srn_error_t *srn_fiber_sleep_ms(uint64_t duration_ms);
 
/**
 * Suspend the calling fiber for at least `duration` seconds, letting its
 * worker run other fibers meanwhile. Returns null on a normal wake, or the
 * CANCELED error if the sleep was cut short by a scheduler wind down.
 */
srn_error_t *srn_fiber_sleep(uint64_t duration);
 
/**
 * Accept a pending connection on the listening socket `fd`, suspending the
 * calling fiber until one arrives. When `addr` is non-null the peer address is
 * written into it, up to `addr_cap` bytes, and the result's `addrlen` reports
 * how many were written. The accepted socket is created non-blocking and
 * close on exec, so it is ready for further fiber IO. On success the result's
 * `fd` is the accepted descriptor. Must run on a fiber that is on a worker.
 */
srn_io_accept_result_t srn_fiber_accept(int fd, struct sockaddr *addr, socklen_t addr_cap);
 
/**
 * Connect the socket `fd` to `addr`/`addrlen`, suspending the calling fiber
 * until the connection completes rather than blocking its worker. Returns null
 * on success, or the error (such as CONNECTION_REFUSED). Must run on a fiber
 * that is on a worker.
 */
srn_error_t *srn_fiber_connect(int fd, const struct sockaddr *addr, socklen_t addrlen);
 
/**
 * Receive a datagram from `fd` into `buf`/`len` with `flags` (the `MSG_*`
 * flags), suspending the calling fiber until one arrives. When `addr` is
 * non-null the sender address is written into it, up to `addr_cap` bytes, and
 * the result's `addrlen` reports how many. On success `count` is the number of
 * bytes received. Must run on a fiber that is on a worker.
 */
srn_io_recvfrom_result_t srn_fiber_recvfrom(
  int fd, void *buf, size_t len, int flags, struct sockaddr *addr, socklen_t addr_cap
);
 
/**
 * Send `buf`/`len` on `fd` to `addr`/`addrlen` with `flags` (the `MSG_*`
 * flags), suspending the calling fiber until the send completes rather than
 * blocking its worker. On success `count` is the number of bytes sent. Must run
 * on a fiber that is on a worker.
 */
srn_io_size_result_t srn_fiber_sendto(
  int fd, const void *buf, size_t len, int flags, const struct sockaddr *addr, socklen_t addrlen
);
 
/**
 * Receive into the `struct msghdr` `msg` on `fd` with `flags`, suspending the
 * calling fiber until data arrives. Scatters across `msg`'s iovecs and fills
 * its `msg_name`/`msg_control` as requested. On success `count` is the number
 * of bytes received. Must run on a fiber that is on a worker.
 */
srn_io_size_result_t srn_fiber_recvmsg(int fd, struct msghdr *msg, int flags);
 
/**
 * Send the `struct msghdr` `msg` on `fd` with `flags`, suspending the calling
 * fiber until the send completes. Gathers from `msg`'s iovecs. On success
 * `count` is the number of bytes sent. Must run on a fiber that is on a worker.
 */
srn_io_size_result_t srn_fiber_sendmsg(int fd, const struct msghdr *msg, int flags);
 
// ---------------------------------------------------------------------------
// Non-suspending helpers
// ---------------------------------------------------------------------------
/**
 * Create a socket, like `socket(2)`, additionally forcing `SOCK_NONBLOCK` and
 * `SOCK_CLOEXEC` so the descriptor is safe to hand to the suspending calls (a
 * blocking socket would stall the reactor thread). On success `fd` is the new
 * descriptor.
 */
srn_io_fd_result_t srn_fiber_socket(int domain, int type, int protocol);
 
/**
 * Bind `fd` to `addr`/`addrlen`, like `bind(2)`. Returns null on success, or the
 * error.
 */
srn_error_t *srn_fiber_bind(int fd, const struct sockaddr *addr, socklen_t addrlen);
 
/**
 * Mark `fd` as a listening socket with the given `backlog`, like `listen(2)`.
 * Returns null on success, or the error.
 */
srn_error_t *srn_fiber_listen(int fd, int backlog);
 
/**
 * Close `fd`, like `close(2)`. Returns null on success, or the error.
 */
srn_error_t *srn_fiber_close(int fd);
 
/**
 * Shut down part or all of the connection on `fd` (`how` is `SHUT_RD`/`SHUT_WR`/
 * `SHUT_RDWR`), like `shutdown(2)`. Returns null on success, or the error.
 */
srn_error_t *srn_fiber_shutdown(int fd, int how);
 
/**
 * Read a socket option into `optval`/`optlen`, like `getsockopt(2)`. Returns
 * null on success, or the error.
 */
srn_error_t *srn_fiber_getsockopt(int fd, int level, int optname, void *optval, socklen_t *optlen);
 
/**
 * Set a socket option from `optval`/`optlen`, like `setsockopt(2)`. Returns null
 * on success, or the error.
 */
srn_error_t *
srn_fiber_setsockopt(int fd, int level, int optname, const void *optval, socklen_t optlen);
 
/**
 * Open `path`, like `open(2)`, additionally forcing `O_NONBLOCK` and
 * `O_CLOEXEC` so the descriptor is always safe to hand to the suspending
 * calls above. `mode` applies only when `flags` includes `O_CREAT`. The open
 * runs synchronously on the calling thread. On success `fd` is the new
 * descriptor. Regular files ignore `O_NONBLOCK` (they are served on the
 * worker, not the reactor). FIFOs follow the open(2) O_NONBLOCK semantics:
 * a read end opens at once with no writer present, and a write end with no
 * reader fails instead of blocking until one appears.
 */
srn_io_fd_result_t srn_fiber_open(const char *path, int flags, mode_t mode);