osmo_io.h

Go to the documentation of this file.

 
#pragma once
 
#include <osmocom/core/linuxlist.h>
#include <osmocom/core/logging.h>
#include <osmocom/core/msgb.h>
#include <osmocom/core/socket.h>
#include <osmocom/core/utils.h>
 
/* struct msghdr is defined in sys/socket.h but that header may not be available.
 * We only really need a forward declaration here: */
struct msghdr;
 
#define LOGPIO(iofd, level, fmt, args...) \
        LOGP(DLIO, level, "iofd(%s) " fmt, iofd->name, ## args)
 
struct osmo_io_fd;
 
enum osmo_io_fd_mode {
        OSMO_IO_FD_MODE_READ_WRITE,
        OSMO_IO_FD_MODE_RECVFROM_SENDTO,
        OSMO_IO_FD_MODE_RECVMSG_SENDMSG,
};
 
enum osmo_io_op {
        OSMO_IO_OP_READ,
        OSMO_IO_OP_WRITE,
};
 
enum osmo_io_backend {
        OSMO_IO_BACKEND_POLL,
        OSMO_IO_BACKEND_IO_URING,
};
 
enum osmo_io_backend osmo_io_get_backend(void);
 
extern const struct value_string osmo_io_backend_names[];
static inline const char *osmo_io_backend_name(enum osmo_io_backend val)
{ return get_value_string(osmo_io_backend_names, val); }
 
extern const struct value_string osmo_iofd_mode_names[];
static inline const char *osmo_iofd_mode_name(enum osmo_io_fd_mode val)
{ return get_value_string(osmo_iofd_mode_names, val); }
 
struct osmo_io_ops {
        /* mode OSMO_IO_FD_MODE_READ_WRITE: */
        struct {
                void (*read_cb)(struct osmo_io_fd *iofd, int res, struct msgb *msg);
 
                void (*write_cb)(struct osmo_io_fd *iofd, int res,
                                 struct msgb *msg);
 
                int (*segmentation_cb)(struct msgb *msg);
 
                int (*segmentation_cb2)(struct osmo_io_fd *iofd, struct msgb *msg);
        };
 
        /* mode OSMO_IO_FD_MODE_RECVFROM_SENDTO: */
        struct {
                void (*recvfrom_cb)(struct osmo_io_fd *iofd, int res,
                                    struct msgb *msg,
                                    const struct osmo_sockaddr *saddr);
                void (*sendto_cb)(struct osmo_io_fd *iofd, int res,
                                  struct msgb *msg,
                                  const struct osmo_sockaddr *daddr);
        };
 
        /* mode OSMO_IO_FD_MODE_RECVMSG_SENDMSG: */
        struct {
                void (*recvmsg_cb)(struct osmo_io_fd *iofd, int res,
                                   struct msgb *msg, const struct msghdr *msgh);
                void (*sendmsg_cb)(struct osmo_io_fd *iofd, int res, struct msgb *msg);
        };
};
 
void osmo_iofd_init(void);
 
struct osmo_io_fd *osmo_iofd_setup(const void *ctx, int fd, const char *name,
                  enum osmo_io_fd_mode mode, const struct osmo_io_ops *ioops, void *data);
int osmo_iofd_set_cmsg_size(struct osmo_io_fd *iofd, size_t cmsg_size);
int osmo_iofd_set_io_buffers(struct osmo_io_fd *iofd, enum osmo_io_op op, uint8_t buffers);
int osmo_iofd_set_sqes(struct osmo_io_fd *iofd, enum osmo_io_op op, uint8_t sqes);
int osmo_iofd_register(struct osmo_io_fd *iofd, int fd);
int osmo_iofd_unregister(struct osmo_io_fd *iofd);
unsigned int osmo_iofd_txqueue_len(struct osmo_io_fd *iofd);
void osmo_iofd_txqueue_clear(struct osmo_io_fd *iofd);
int osmo_iofd_close(struct osmo_io_fd *iofd);
void osmo_iofd_free(struct osmo_io_fd *iofd);
 
void osmo_iofd_notify_connected(struct osmo_io_fd *iofd);
 
int osmo_iofd_write_msgb(struct osmo_io_fd *iofd, struct msgb *msg);
int osmo_iofd_sendto_msgb(struct osmo_io_fd *iofd, struct msgb *msg, int sendto_flags,
                          const struct osmo_sockaddr *dest);
int osmo_iofd_sendmsg_msgb(struct osmo_io_fd *iofd, struct msgb *msg, int sendmsg_flags,
                           const struct msghdr *msgh);
 
void osmo_iofd_set_alloc_info(struct osmo_io_fd *iofd, unsigned int size, unsigned int headroom);
void osmo_iofd_set_txqueue_max_length(struct osmo_io_fd *iofd, unsigned int size);
unsigned int osmo_iofd_get_txqueue_max_length(const struct osmo_io_fd *iofd);
void *osmo_iofd_get_data(const struct osmo_io_fd *iofd);
void osmo_iofd_set_data(struct osmo_io_fd *iofd, void *data);
 
unsigned int osmo_iofd_get_priv_nr(const struct osmo_io_fd *iofd);
void osmo_iofd_set_priv_nr(struct osmo_io_fd *iofd, unsigned int priv_nr);
 
int osmo_iofd_get_fd(const struct osmo_io_fd *iofd);
const char *osmo_iofd_get_name(const struct osmo_io_fd *iofd);
void osmo_iofd_set_name(struct osmo_io_fd *iofd, const char *name);
void osmo_iofd_set_name_f(struct osmo_io_fd *iofd, const char *fmt, ...);
 
int osmo_iofd_set_ioops(struct osmo_io_fd *iofd, const struct osmo_io_ops *ioops);
void osmo_iofd_get_ioops(struct osmo_io_fd *iofd, struct osmo_io_ops *ioops);