Loading...
Searching...
No Matches
osmo_io.h
Go to the documentation of this file.
#pragma once
#include <sys/socket.h>
#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>
#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_backend {
OSMO_IO_BACKEND_POLL,
OSMO_IO_BACKEND_IO_URING,
};
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_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);
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);
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);
osmo_iofd_set_data
void osmo_iofd_set_data(struct osmo_io_fd *iofd, void *data)
Set the associated user-data from an osmo_io_fd.
Definition osmo_io.c:929
osmo_iofd_write_msgb
int osmo_iofd_write_msgb(struct osmo_io_fd *iofd, struct msgb *msg)
Write a message to a file descriptor / connected socket.
Definition osmo_io.c:453
osmo_io_fd_mode
osmo_io_fd_mode
The mode of an osmo_io_fd determines if read/write, recvfrom/sendmsg or recvmsg/sendmsg semantics are...
Definition osmo_io.h:64
osmo_iofd_get_ioops
void osmo_iofd_get_ioops(struct osmo_io_fd *iofd, struct osmo_io_ops *ioops)
Retrieve the osmo_io_ops for an iofd.
Definition osmo_io.c:1026
osmo_iofd_set_ioops
int osmo_iofd_set_ioops(struct osmo_io_fd *iofd, const struct osmo_io_ops *ioops)
Set the osmo_io_ops calbacks for an osmo_io_fd.
Definition osmo_io.c:987
osmo_iofd_mode_name
static const char * osmo_iofd_mode_name(enum osmo_io_fd_mode val)
return the string name of an osmo_io_mode
Definition osmo_io.h:89
osmo_iofd_unregister
int osmo_iofd_unregister(struct osmo_io_fd *iofd)
Unregister the given osmo_io_fd from osmo_io.
Definition osmo_io.c:797
osmo_io_backend_name
static const char * osmo_io_backend_name(enum osmo_io_backend val)
return the string name of an osmo_io_backend
Definition osmo_io.h:84
osmo_iofd_notify_connected
void osmo_iofd_notify_connected(struct osmo_io_fd *iofd)
Request notification of the user if/when a client socket is connected.
Definition osmo_io.c:1050
osmo_iofd_set_priv_nr
void osmo_iofd_set_priv_nr(struct osmo_io_fd *iofd, unsigned int priv_nr)
Set the private number of an osmo_io_fd.
Definition osmo_io.c:950
osmo_io_backend
osmo_io_backend
The back-end used by osmo_io.
Definition osmo_io.h:75
osmo_iofd_set_txqueue_max_length
void osmo_iofd_set_txqueue_max_length(struct osmo_io_fd *iofd, unsigned int size)
Set the maximum number of messages enqueued for sending.
Definition osmo_io.c:903
osmo_iofd_txqueue_clear
void osmo_iofd_txqueue_clear(struct osmo_io_fd *iofd)
Clear the transmit queue of the given osmo_io_fd.
Definition osmo_io.c:823
osmo_iofd_set_name
void osmo_iofd_set_name(struct osmo_io_fd *iofd, const char *name)
Set the human-readable name of the file descriptor.
Definition osmo_io.c:975
osmo_iofd_get_fd
int osmo_iofd_get_fd(const struct osmo_io_fd *iofd)
Retrieve the underlying file descriptor from an osmo_io_fd.
Definition osmo_io.c:958
osmo_iofd_free
void osmo_iofd_free(struct osmo_io_fd *iofd)
Free the given osmo_io_fd.
Definition osmo_io.c:841
osmo_io_backend_names
const struct value_string osmo_io_backend_names[]
Definition osmo_io.c:53
osmo_iofd_setup
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)
Allocate and setup a new iofd.
Definition osmo_io.c:669
osmo_iofd_register
int osmo_iofd_register(struct osmo_io_fd *iofd, int fd)
Register the osmo_io_fd for active I/O.
Definition osmo_io.c:748
osmo_iofd_sendmsg_msgb
int osmo_iofd_sendmsg_msgb(struct osmo_io_fd *iofd, struct msgb *msg, int sendmsg_flags, const struct msghdr *msgh)
osmo_io equivalent of the sendmsg(2) socket API call.
Definition osmo_io.c:551
osmo_iofd_txqueue_len
unsigned int osmo_iofd_txqueue_len(struct osmo_io_fd *iofd)
Retrieve the number of messages pending in the transmit queue.
Definition osmo_io.c:813
osmo_iofd_init
void osmo_iofd_init(void)
initialize osmo_io for the current thread
Definition osmo_io.c:76
osmo_iofd_mode_names
const struct value_string osmo_iofd_mode_names[]
Definition osmo_io.c:59
osmo_iofd_get_name
const char * osmo_iofd_get_name(const struct osmo_io_fd *iofd)
Retrieve the human-readable name of the given osmo_io_fd.
Definition osmo_io.c:966
osmo_iofd_set_alloc_info
void osmo_iofd_set_alloc_info(struct osmo_io_fd *iofd, unsigned int size, unsigned int headroom)
Set the size and headroom of the msgb allocated when receiving messages.
Definition osmo_io.c:893
osmo_iofd_get_data
void * osmo_iofd_get_data(const struct osmo_io_fd *iofd)
Retrieve the associated user-data from an osmo_io_fd.
Definition osmo_io.c:916
osmo_iofd_get_priv_nr
unsigned int osmo_iofd_get_priv_nr(const struct osmo_io_fd *iofd)
Retrieve the private number from an osmo_io_fd.
Definition osmo_io.c:939
osmo_iofd_close
int osmo_iofd_close(struct osmo_io_fd *iofd)
Close the given osmo_io_fd.
Definition osmo_io.c:864
osmo_iofd_sendto_msgb
int osmo_iofd_sendto_msgb(struct osmo_io_fd *iofd, struct msgb *msg, int sendto_flags, const struct osmo_sockaddr *dest)
Send a message through an unconnected socket.
Definition osmo_io.c:500
osmo_iofd_set_cmsg_size
int osmo_iofd_set_cmsg_size(struct osmo_io_fd *iofd, size_t cmsg_size)
Set the size of the control message buffer allocated when submitting recvmsg.
Definition osmo_io.c:723
OSMO_IO_FD_MODE_RECVFROM_SENDTO
@ OSMO_IO_FD_MODE_RECVFROM_SENDTO
use recvfrom() / sendto() semantics with recvfrom_cb/sendto_cb in osmo_io_ops
Definition osmo_io.h:68
OSMO_IO_FD_MODE_RECVMSG_SENDMSG
@ OSMO_IO_FD_MODE_RECVMSG_SENDMSG
emulate recvmsg() / sendmsg() semantics with recvmsg_cb/sendto_cb in osmo_io_ops
Definition osmo_io.h:70
OSMO_IO_FD_MODE_READ_WRITE
@ OSMO_IO_FD_MODE_READ_WRITE
use read() / write() semantics with read_cb/write_cb in osmo_io_ops
Definition osmo_io.h:66
OSMO_IO_BACKEND_POLL
@ OSMO_IO_BACKEND_POLL
classic back-end using poll(2) and direct read/write/recvfrom/sendto/recvmsg/sendmsg syscalls
Definition osmo_io.h:77
OSMO_IO_BACKEND_IO_URING
@ OSMO_IO_BACKEND_IO_URING
back-end using io_uring to perform efficient I/O and reduce syscall overhead
Definition osmo_io.h:79
get_value_string
const char * get_value_string(const struct value_string *vs, uint32_t val)
get human-readable string for given value
Definition utils.c:62
msg
uint8_t msg[0]
res
uint8_t res
reserved for future use (RFU)
Definition gsmtap.h:14
name
char name[32]
source file name
Definition gsmtap.h:11
linuxlist.h
Simple doubly linked list implementation.
logging.h
msgb.h
socket.h
Osmocom socket convenience functions.
msgb
Osmocom message buffer.
Definition msgb.h:31
osmo_io_fd
Definition osmo_io_internal.h:52
osmo_io_fd::mode
enum osmo_io_fd_mode mode
type of read/write mode to use
Definition osmo_io_internal.h:58
osmo_io_fd::cmsg_size
size_t cmsg_size
size of iofd_msghdr.cmsg[] when allocated in recvmsg path
Definition osmo_io_internal.h:77
osmo_io_fd::headroom
unsigned int headroom
headroom to allocate when allocating msgb's
Definition osmo_io_internal.h:85
osmo_io_fd::size
unsigned int size
size of msgb to allocate (excluding headroom)
Definition osmo_io_internal.h:83
osmo_io_fd::fd
int fd
actual operating-system level file decriptor
Definition osmo_io_internal.h:56
osmo_io_fd::ctx
const void * ctx
talloc context from which to allocate msgb when reading
Definition osmo_io_internal.h:81
osmo_io_fd::data
void * data
data pointer passed through to call-back function
Definition osmo_io_internal.h:72
osmo_io_fd::priv_nr
unsigned int priv_nr
private number, extending data
Definition osmo_io_internal.h:74
osmo_io_ops
I/O operations (call-back functions) related to an osmo_io_fd.
Definition osmo_io.h:93
osmo_io_ops::read_cb
void(* read_cb)(struct osmo_io_fd *iofd, int res, struct msgb *msg)
completion call-back function when something was read from fd.
Definition osmo_io.h:106
osmo_io_ops::segmentation_cb2
int(* segmentation_cb2)(struct osmo_io_fd *iofd, struct msgb *msg)
optional call-back function to segment the data at message boundaries.
Definition osmo_io.h:151
osmo_io_ops::write_cb
void(* write_cb)(struct osmo_io_fd *iofd, int res, struct msgb *msg)
completion call-back function when write issued via osmo_iofd_write_msgb() has completed on fd.
Definition osmo_io.h:114
osmo_io_ops::segmentation_cb
int(* segmentation_cb)(struct msgb *msg)
optional call-back function to segment the data at message boundaries.
Definition osmo_io.h:136
osmo_sockaddr
Definition socket.h:38
value_string
A mapping between human-readable string and numeric value.
Definition utils.h:51
utils.h