libosmocore 1.13.1.1-afb4 Osmocom core library

select.h
Go to the documentation of this file.
1
5#pragma once
6
7#include <osmocom/core/linuxlist.h>
8#include <stdbool.h>
9#include <time.h>
10#include <signal.h>
11
17#define OSMO_FD_READ 0x0001
19#define OSMO_FD_WRITE 0x0002
21#define OSMO_FD_EXCEPT 0x0004
23#define OSMO_FD_MASK 0xFFFF
24
25/* legacy naming dating back to early OpenBSC / bsc_hack of 2008 */
26#define BSC_FD_READ OSMO_FD_READ
27#define BSC_FD_WRITE OSMO_FD_WRITE
28#define BSC_FD_EXCEPT OSMO_FD_EXCEPT
29
31 struct osmo_fd {
33 struct llist_head list;
35 int fd;
38 unsigned int when;
41 int (*cb)(struct osmo_fd *fd, unsigned int what);
43 void *data;
45 unsigned int priv_nr;
46};
47
48 void osmo_fd_setup(struct osmo_fd *ofd, int fd, unsigned int when,
49 int (*cb)(struct osmo_fd *fd, unsigned int what),
50 void *data, unsigned int priv_nr);
51
52 void osmo_fd_update_when(struct osmo_fd *ofd, unsigned int when_mask, unsigned int when);
53
54 static inline void osmo_fd_read_enable(struct osmo_fd *ofd) {
55 osmo_fd_update_when(ofd, OSMO_FD_MASK, OSMO_FD_READ);
56}
57
58 static inline void osmo_fd_read_disable(struct osmo_fd *ofd) {
59 osmo_fd_update_when(ofd, ~OSMO_FD_READ, 0);
60}
61
62 static inline void osmo_fd_write_enable(struct osmo_fd *ofd) {
63 osmo_fd_update_when(ofd, OSMO_FD_MASK, OSMO_FD_WRITE);
64}
65
66 static inline void osmo_fd_write_disable(struct osmo_fd *ofd) {
67 osmo_fd_update_when(ofd, ~OSMO_FD_WRITE, 0);
68}
69
70 bool osmo_fd_is_registered(struct osmo_fd *fd);
71 int osmo_fd_register(struct osmo_fd *fd);
72 void osmo_fd_unregister(struct osmo_fd *fd);
73 void osmo_fd_close(struct osmo_fd *fd);
74 int osmo_select_main(int polling);
75 int osmo_select_main_ctx(int polling);
76 void osmo_select_init(void);
77
78 struct osmo_fd *osmo_fd_get_by_fd(int fd);
79
80/*
81 * foreign event loop integration
82 */
83 int osmo_fd_fill_fds(void *readset, void *writeset, void *exceptset);
84 int osmo_fd_disp_fds(void *readset, void *writeset, void *exceptset);
85
86/* timerfd integration */
87 int osmo_timerfd_disable(struct osmo_fd *ofd);
88 int osmo_timerfd_schedule(struct osmo_fd *ofd, const struct timespec *first,
89 const struct timespec *interval);
90 int osmo_timerfd_setup(struct osmo_fd *ofd, int (*cb)(struct osmo_fd *, unsigned int), void *data);
91
92/* signalfd integration */
93 struct osmo_signalfd;
94 struct signalfd_siginfo;
95
96 typedef void osmo_signalfd_cb(struct osmo_signalfd *osfd, const struct signalfd_siginfo *fdsi);
97
98 struct osmo_signalfd {
99 struct osmo_fd ofd;
100 sigset_t sigset;
101 osmo_signalfd_cb *cb;
102 void *data;
103};
104
105 struct osmo_signalfd *
106 osmo_signalfd_setup(void *ctx, sigset_t set, osmo_signalfd_cb *cb, void *data);
107
108 void osmo_select_shutdown_request(void);
109 int osmo_select_shutdown_requested(void);
110 bool osmo_select_shutdown_done(void);
111
data
uint8_t data[0]
osmo_signalfd_cb
void osmo_signalfd_cb(struct osmo_signalfd *osfd, const struct signalfd_siginfo *fdsi)
Definition: select.h:96
OSMO_FD_READ
#define OSMO_FD_READ
Indicate interest in reading from the file descriptor.
Definition: select.h:17
osmo_select_init
void osmo_select_init(void)
osmo_select_shutdown_request
void osmo_select_shutdown_request(void)
osmo_fd_setup
void osmo_fd_setup(struct osmo_fd *ofd, int fd, unsigned int when, int(*cb)(struct osmo_fd *fd, unsigned int what), void *data, unsigned int priv_nr)
OSMO_FD_WRITE
#define OSMO_FD_WRITE
Indicate interest in writing to the file descriptor.
Definition: select.h:19
osmo_fd_disp_fds
int osmo_fd_disp_fds(void *readset, void *writeset, void *exceptset)
osmo_fd_fill_fds
int osmo_fd_fill_fds(void *readset, void *writeset, void *exceptset)
osmo_timerfd_setup
int osmo_timerfd_setup(struct osmo_fd *ofd, int(*cb)(struct osmo_fd *, unsigned int), void *data)
osmo_select_main_ctx
int osmo_select_main_ctx(int polling)
osmo_select_shutdown_requested
int osmo_select_shutdown_requested(void)
osmo_fd_close
void osmo_fd_close(struct osmo_fd *fd)
osmo_signalfd_setup
struct osmo_signalfd * osmo_signalfd_setup(void *ctx, sigset_t set, osmo_signalfd_cb *cb, void *data)
osmo_fd_update_when
void osmo_fd_update_when(struct osmo_fd *ofd, unsigned int when_mask, unsigned int when)
osmo_fd_is_registered
bool osmo_fd_is_registered(struct osmo_fd *fd)
osmo_fd_read_enable
static void osmo_fd_read_enable(struct osmo_fd *ofd)
Definition: select.h:54
osmo_timerfd_schedule
int osmo_timerfd_schedule(struct osmo_fd *ofd, const struct timespec *first, const struct timespec *interval)
osmo_select_main
int osmo_select_main(int polling)
osmo_fd_register
int osmo_fd_register(struct osmo_fd *fd)
osmo_fd_get_by_fd
struct osmo_fd * osmo_fd_get_by_fd(int fd)
osmo_fd_write_enable
static void osmo_fd_write_enable(struct osmo_fd *ofd)
Definition: select.h:62
osmo_fd_read_disable
static void osmo_fd_read_disable(struct osmo_fd *ofd)
Definition: select.h:58
osmo_fd_write_disable
static void osmo_fd_write_disable(struct osmo_fd *ofd)
Definition: select.h:66
OSMO_FD_MASK
#define OSMO_FD_MASK
Used as when_mask in osmo_fd_update_when()
Definition: select.h:23
osmo_select_shutdown_done
bool osmo_select_shutdown_done(void)
osmo_fd_unregister
void osmo_fd_unregister(struct osmo_fd *fd)
osmo_timerfd_disable
int osmo_timerfd_disable(struct osmo_fd *ofd)
linuxlist.h
Simple doubly linked list implementation.
signal.h
llist_head
(double) linked list header structure
Definition: linuxlist.h:46
osmo_fd
Structure representing a file dsecriptor.
Definition: select.h:31
osmo_fd::fd
int fd
actual operating-system level file decriptor
Definition: select.h:35
osmo_fd::list
struct llist_head list
linked list for internal management
Definition: select.h:33
osmo_fd::cb
int(* cb)(struct osmo_fd *fd, unsigned int what)
call-back function to be called once file descriptor becomes available
Definition: select.h:41
osmo_fd::when
unsigned int when
bit-mask or of OSMO_FD_READ, OSMO_FD_WRITE and/or OSMO_FD_EXCEPT
Definition: select.h:38
osmo_fd::priv_nr
unsigned int priv_nr
private number, extending data
Definition: select.h:45
osmo_fd::data
void * data
data pointer passed through to call-back function
Definition: select.h:43
osmo_signalfd
Definition: select.h:98
osmo_signalfd::data
void * data
Definition: select.h:102
osmo_signalfd::sigset
sigset_t sigset
Definition: select.h:100
osmo_signalfd::cb
osmo_signalfd_cb * cb
Definition: select.h:101
osmo_signalfd::ofd
struct osmo_fd ofd
Definition: select.h:99