osmo_io_internal.h

Go to the documentation of this file.

 
#pragma once
 
#include "../config.h"
 
#include <unistd.h>
#include <stdbool.h>
 
#include <osmocom/core/osmo_io.h>
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/msgb.h>
#include <osmocom/core/select.h>
#include <osmocom/core/socket.h>
 
#define OSMO_IO_DEFAULT_MSGB_SIZE 1024
#define OSMO_IO_DEFAULT_MSGB_HEADROOM 128
 
extern const struct iofd_backend_ops iofd_poll_ops;
#define OSMO_IO_BACKEND_DEFAULT "POLL"
 
#if defined(HAVE_URING)
extern const struct iofd_backend_ops iofd_uring_ops;
void osmo_iofd_uring_constructor(void);
void osmo_iofd_uring_init(void);
#endif
 
struct iofd_backend_ops {
        int (*setup)(struct osmo_io_fd *iofd);
        int (*register_fd)(struct osmo_io_fd *iofd);
        int (*unregister_fd)(struct osmo_io_fd *iofd);
        int (*close)(struct osmo_io_fd *iofd);
        void (*write_enable)(struct osmo_io_fd *iofd);
        void (*write_disable)(struct osmo_io_fd *iofd);
        void (*read_enable)(struct osmo_io_fd *iofd);
        void (*read_disable)(struct osmo_io_fd *iofd);
        void (*notify_connected)(struct osmo_io_fd *iofd);
};
 
#define IOFD_FLAG_CLOSED (1<<0)
#define IOFD_FLAG_IN_CALLBACK (1<<1)
#define IOFD_FLAG_TO_FREE (1<<2)
#define IOFD_FLAG_NOTIFY_CONNECTED (1<<3)
#define IOFD_FLAG_FD_REGISTERED (1<<4)
 
#define IOFD_FLAG_SET(iofd, flag) \
        (iofd)->flags |= (flag)
 
#define IOFD_FLAG_UNSET(iofd, flag) \
        (iofd)->flags &= ~(flag)
 
#define IOFD_FLAG_ISSET(iofd, flag) ((iofd)->flags & (flag))
 
#define IOFD_MSGHDR_MAX_READ_SQES       32
 
struct osmo_io_fd {
        struct llist_head list;
        int fd;
        enum osmo_io_fd_mode mode;

        uint32_t flags;

        char *name;

        struct osmo_io_ops io_ops;
        struct msgb *pending;

        void *data;
        unsigned int priv_nr;

        size_t cmsg_size;

        uint8_t io_read_buffers;

        uint8_t io_write_buffers;
 
        struct {
                const void *ctx;
                unsigned int size;
                unsigned int headroom;
        } msgb_alloc;
 
        struct {
                unsigned int max_length;
                unsigned int current_length;
                struct llist_head msg_queue;
        } tx_queue;
 
        union {
                struct {
                        struct osmo_fd ofd;
                } poll;
                struct {
                        struct {
                                bool enabled;
                                uint8_t num_sqes;
                                void *msghdr[IOFD_MSGHDR_MAX_READ_SQES];
                                struct io_uring *ring;
                                uint8_t sqes_submitted;
                        } read;
                        struct {
                                bool enabled;
                                void *msghdr;
                                struct io_uring *ring;
                        } write;
                        /* TODO: index into array of registered fd's? */
                        /* osmo_fd for non-blocking connect handling */
                        struct osmo_fd connect_ofd;
                } uring;
        } u;
};
 
enum iofd_msg_action {
        IOFD_ACT_READ,
        IOFD_ACT_WRITE,
        IOFD_ACT_RECVFROM,
        IOFD_ACT_SENDTO,
        IOFD_ACT_RECVMSG,
        IOFD_ACT_SENDMSG,
};
 
#define IOFD_MSGHDR_IO_BUFFERS  8

struct iofd_msghdr {
        struct llist_head list;
        enum iofd_msg_action action;
        struct msghdr hdr;
        struct osmo_sockaddr osa;
        struct iovec iov[IOFD_MSGHDR_IO_BUFFERS];
        int flags;

        uint8_t io_len;
        struct msgb *msg[IOFD_MSGHDR_IO_BUFFERS];
        struct osmo_io_fd *iofd;

        bool in_cancel_queue;

        char _Alignas(struct cmsghdr) cmsg[0];
};
 
enum iofd_seg_act {
        IOFD_SEG_ACT_HANDLE_ONE,
        IOFD_SEG_ACT_HANDLE_MORE,
        IOFD_SEG_ACT_DEFER,
};
 
struct iofd_msghdr *iofd_msghdr_alloc(struct osmo_io_fd *iofd, enum iofd_msg_action action, struct msgb *msg, size_t cmsg_size);
void iofd_msghdr_free(struct iofd_msghdr *msghdr);
 
struct msgb *iofd_msgb_alloc2(struct osmo_io_fd *iofd, size_t size);
struct msgb *iofd_msgb_alloc(struct osmo_io_fd *iofd);
 
void iofd_handle_recv(struct osmo_io_fd *iofd, struct msgb *msg, int rc, struct iofd_msghdr *msghdr);
void iofd_handle_send_completion(struct osmo_io_fd *iofd, int rc, struct iofd_msghdr *msghdr);
 
int iofd_txqueue_enqueue(struct osmo_io_fd *iofd, struct iofd_msghdr *msghdr);
void iofd_txqueue_enqueue_front(struct osmo_io_fd *iofd, struct iofd_msghdr *msghdr);
struct iofd_msghdr *iofd_txqueue_dequeue(struct osmo_io_fd *iofd);