libosmocore  1.4.0
Osmocom core library
select.h
Go to the documentation of this file.
1 
5 #pragma once
6 
8 #include <stdbool.h>
9 #include <time.h>
10 #include <signal.h>
11 
17 #define OSMO_FD_READ 0x0001
18 
19 #define OSMO_FD_WRITE 0x0002
20 
21 #define OSMO_FD_EXCEPT 0x0004
22 
23 /* legacy naming dating back to early OpenBSC / bsc_hack of 2008 */
24 #define BSC_FD_READ OSMO_FD_READ
25 #define BSC_FD_WRITE OSMO_FD_WRITE
26 #define BSC_FD_EXCEPT OSMO_FD_EXCEPT
27 
29 struct osmo_fd {
31  struct llist_head list;
33  int fd;
36  unsigned int when;
39  int (*cb)(struct osmo_fd *fd, unsigned int what);
41  void *data;
43  unsigned int priv_nr;
44 };
45 
46 void osmo_fd_setup(struct osmo_fd *ofd, int fd, unsigned int when,
47  int (*cb)(struct osmo_fd *fd, unsigned int what),
48  void *data, unsigned int priv_nr);
49 
50 bool osmo_fd_is_registered(struct osmo_fd *fd);
51 int osmo_fd_register(struct osmo_fd *fd);
52 void osmo_fd_unregister(struct osmo_fd *fd);
53 void osmo_fd_close(struct osmo_fd *fd);
54 int osmo_select_main(int polling);
55 int osmo_select_main_ctx(int polling);
56 void osmo_select_init(void);
57 
58 struct osmo_fd *osmo_fd_get_by_fd(int fd);
59 
60 /*
61  * foreign event loop integration
62  */
63 int osmo_fd_fill_fds(void *readset, void *writeset, void *exceptset);
64 int osmo_fd_disp_fds(void *readset, void *writeset, void *exceptset);
65 
66 /* timerfd integration */
67 int osmo_timerfd_disable(struct osmo_fd *ofd);
68 int osmo_timerfd_schedule(struct osmo_fd *ofd, const struct timespec *first,
69  const struct timespec *interval);
70 int osmo_timerfd_setup(struct osmo_fd *ofd, int (*cb)(struct osmo_fd *, unsigned int), void *data);
71 
72 /* signalfd integration */
73 struct osmo_signalfd;
74 struct signalfd_siginfo;
75 
76 typedef void osmo_signalfd_cb(struct osmo_signalfd *osfd, const struct signalfd_siginfo *fdsi);
77 
78 struct osmo_signalfd {
79  struct osmo_fd ofd;
80  sigset_t sigset;
82  void *data;
83 };
84 
85 struct osmo_signalfd *
86 osmo_signalfd_setup(void *ctx, sigset_t set, osmo_signalfd_cb *cb, void *data);
87 
88 
osmo_select_init
void osmo_select_init(void)
initialize the osmocom select abstraction for the current thread
Definition: select.c:313
osmo_fd_disp_fds
int osmo_fd_disp_fds(void *readset, void *writeset, void *exceptset)
Definition: select.c:194
osmo_fd::priv_nr
unsigned int priv_nr
private number, extending data
Definition: select.h:43
osmo_signalfd
Definition: select.h:78
osmo_fd_register
int osmo_fd_register(struct osmo_fd *fd)
Register a new file descriptor with select loop abstraction.
Definition: select.c:98
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:39
osmo_signalfd::sigset
sigset_t sigset
Definition: select.h:80
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)
Set up an osmo-fd.
Definition: select.c:67
osmo_fd_unregister
void osmo_fd_unregister(struct osmo_fd *fd)
Unregister a file descriptor from select loop abstraction.
Definition: select.c:139
osmo_fd_is_registered
bool osmo_fd_is_registered(struct osmo_fd *fd)
Check if a file descriptor is already registered.
Definition: select.c:82
osmo_signalfd::data
void * data
Definition: select.h:82
data
uint8_t data[0]
osmo_fd::list
struct llist_head list
linked list for internal management
Definition: select.h:31
osmo_fd_close
void osmo_fd_close(struct osmo_fd *fd)
Close a file descriptor, mark it as closed + unregister from select loop abstraction.
Definition: select.c:154
osmo_select_main_ctx
int osmo_select_main_ctx(int polling)
select main loop integration with temporary select-dispatch talloc context
Definition: select.c:289
osmo_fd::when
unsigned int when
bit-mask or of OSMO_FD_READ, OSMO_FD_WRITE and/or OSMO_FD_EXCEPT
Definition: select.h:36
osmo_timerfd_disable
int osmo_timerfd_disable(struct osmo_fd *ofd)
disable the osmocom-wrapped timerfd
Definition: select.c:328
llist_head
(double) linked list header structure
Definition: linuxlist.h:45
signal.h
osmo_timerfd_setup
int osmo_timerfd_setup(struct osmo_fd *ofd, int(*cb)(struct osmo_fd *, unsigned int), void *data)
setup osmocom-wrapped timerfd
Definition: select.c:370
osmo_fd_fill_fds
int osmo_fd_fill_fds(void *readset, void *writeset, void *exceptset)
Populate the fd_sets and return the highest fd number.
Definition: select.c:171
osmo_signalfd::ofd
struct osmo_fd ofd
Definition: select.h:79
osmo_signalfd::cb
osmo_signalfd_cb * cb
Definition: select.h:81
osmo_signalfd_setup
struct osmo_signalfd * osmo_signalfd_setup(void *ctx, sigset_t set, osmo_signalfd_cb *cb, void *data)
create a signalfd and register it with osmocom select loop.
Definition: select.c:425
osmo_timerfd_schedule
int osmo_timerfd_schedule(struct osmo_fd *ofd, const struct timespec *first, const struct timespec *interval)
schedule the osmocom-wrapped timerfd to occur first at first, then periodically at interval
Definition: select.c:342
osmo_signalfd_cb
void osmo_signalfd_cb(struct osmo_signalfd *osfd, const struct signalfd_siginfo *fdsi)
Definition: select.h:76
osmo_fd
Structure representing a file dsecriptor.
Definition: select.h:29
osmo_fd_get_by_fd
struct osmo_fd * osmo_fd_get_by_fd(int fd)
find an osmo_fd based on the integer fd
Definition: select.c:301
linuxlist.h
Simple doubly linked list implementation.
osmo_fd::fd
int fd
actual operating-system level file decriptor
Definition: select.h:33
osmo_fd::data
void * data
data pointer passed through to call-back function
Definition: select.h:41
osmo_select_main
int osmo_select_main(int polling)
select main loop integration
Definition: select.c:272