libosmocore
1.5.1
Osmocom core library
|
Files | |
file | select.h |
file | select.c |
Data Structures | |
struct | osmo_fd |
Structure representing a file dsecriptor. More... | |
struct | osmo_signalfd |
struct | poll_state |
Macros | |
#define | OSMO_FD_READ 0x0001 |
Indicate interest in reading from the file descriptor. More... | |
#define | OSMO_FD_WRITE 0x0002 |
Indicate interest in writing to the file descriptor. More... | |
#define | OSMO_FD_EXCEPT 0x0004 |
Indicate interest in exceptions from the file descriptor. More... | |
#define | OSMO_FD_MASK 0xFFFF |
Used as when_mask in osmo_fd_update_when() More... | |
#define | BSC_FD_READ OSMO_FD_READ |
#define | BSC_FD_WRITE OSMO_FD_WRITE |
#define | BSC_FD_EXCEPT OSMO_FD_EXCEPT |
Typedefs | |
typedef void | osmo_signalfd_cb(struct osmo_signalfd *osfd, const struct signalfd_siginfo *fdsi) |
Functions | |
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. More... | |
void | osmo_fd_update_when (struct osmo_fd *ofd, unsigned int when_mask, unsigned int when) |
Update the 'when' field of osmo_fd. More... | |
static void | osmo_fd_read_enable (struct osmo_fd *ofd) |
static void | osmo_fd_read_disable (struct osmo_fd *ofd) |
static void | osmo_fd_write_enable (struct osmo_fd *ofd) |
static void | osmo_fd_write_disable (struct osmo_fd *ofd) |
bool | osmo_fd_is_registered (struct osmo_fd *fd) |
Check if a file descriptor is already registered. More... | |
int | osmo_fd_register (struct osmo_fd *fd) |
Register a new file descriptor with select loop abstraction. More... | |
void | osmo_fd_unregister (struct osmo_fd *fd) |
Unregister a file descriptor from select loop abstraction. More... | |
void | osmo_fd_close (struct osmo_fd *fd) |
Close a file descriptor, mark it as closed + unregister from select loop abstraction. More... | |
int | osmo_select_main (int polling) |
select main loop integration More... | |
int | osmo_select_main_ctx (int polling) |
select main loop integration with temporary select-dispatch talloc context More... | |
void | osmo_select_init (void) |
initialize the osmocom select abstraction for the current thread More... | |
struct osmo_fd * | osmo_fd_get_by_fd (int fd) |
find an osmo_fd based on the integer fd More... | |
int | osmo_fd_fill_fds (void *_rset, void *_wset, void *_eset) |
Populate the fd_sets and return the highest fd number. More... | |
int | osmo_fd_disp_fds (void *readset, void *writeset, void *exceptset) |
int | osmo_timerfd_disable (struct osmo_fd *ofd) |
disable the osmocom-wrapped timerfd More... | |
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 More... | |
int | osmo_timerfd_setup (struct osmo_fd *ofd, int(*cb)(struct osmo_fd *, unsigned int), void *data) |
setup osmocom-wrapped timerfd More... | |
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. More... | |
static unsigned int | poll_fill_fds (void) |
static int | poll_disp_fds (int n_fd) |
static int | _osmo_select_main (int polling) |
static | __attribute__ ((constructor)) |
static int | signalfd_callback (struct osmo_fd *ofd, unsigned int what) |
Variables | |
static __thread int | maxfd = 0 |
static __thread struct llist_head | osmo_fds |
static __thread int | unregistered_count |
static __thread struct poll_state | g_poll |
select() loop abstraction
#define BSC_FD_EXCEPT OSMO_FD_EXCEPT |
#define BSC_FD_READ OSMO_FD_READ |
#define BSC_FD_WRITE OSMO_FD_WRITE |
#define OSMO_FD_EXCEPT 0x0004 |
Indicate interest in exceptions from the file descriptor.
#define OSMO_FD_MASK 0xFFFF |
Used as when_mask in osmo_fd_update_when()
#define OSMO_FD_READ 0x0001 |
Indicate interest in reading from the file descriptor.
#define OSMO_FD_WRITE 0x0002 |
Indicate interest in writing to the file descriptor.
typedef void osmo_signalfd_cb(struct osmo_signalfd *osfd, const struct signalfd_siginfo *fdsi) |
|
static |
References osmo_select_init().
|
static |
References g_poll, OSMO_ASSERT, osmo_ctx, osmo_timers_nearest_ms(), osmo_timers_prepare(), osmo_timers_update(), poll_state::poll, poll_disp_fds(), poll_fill_fds(), and osmo_talloc_contexts::select.
Referenced by osmo_select_main(), and osmo_select_main_ctx().
void osmo_fd_close | ( | struct osmo_fd * | fd | ) |
Close a file descriptor, mark it as closed + unregister from select loop abstraction.
[in] | fd | osmocom file descriptor to be unregistered + closed |
If fd is registered, we unregister it from the select() loop abstraction. We then close the fd and set it to -1, as well as unsetting any 'when' flags
References osmo_fd::fd, osmo_fd_is_registered(), osmo_fd_unregister(), and osmo_fd::when.
Referenced by osmo_it_q_alloc(), and osmo_it_q_destroy().
|
inline |
References osmo_fd::cb, osmo_fd::fd, flags, list, llist_for_each_entry_safe, log_reset_context(), OSMO_FD_EXCEPT, OSMO_FD_READ, OSMO_FD_WRITE, osmo_fds, and unregistered_count.
|
inline |
Populate the fd_sets and return the highest fd number.
[in] | _rset | The readfds to populate |
[in] | _wset | The wrtiefds to populate |
[in] | _eset | The errorfds to populate |
References osmo_fd::fd, list, llist_for_each_entry, OSMO_FD_EXCEPT, OSMO_FD_READ, OSMO_FD_WRITE, osmo_fds, and osmo_fd::when.
struct osmo_fd * osmo_fd_get_by_fd | ( | int | fd | ) |
find an osmo_fd based on the integer fd
[in] | fd | file descriptor to use as search key |
References osmo_fd::fd, list, llist_for_each_entry, and osmo_fds.
Referenced by poll_disp_fds().
bool osmo_fd_is_registered | ( | struct osmo_fd * | fd | ) |
Check if a file descriptor is already registered.
[in] | fd | osmocom file descriptor to be checked |
References osmo_fd::fd, list, llist_for_each_entry, and osmo_fds.
Referenced by osmo_fd_close(), and osmo_fd_register().
|
inlinestatic |
References OSMO_FD_READ, and osmo_fd_update_when().
|
inlinestatic |
References OSMO_FD_MASK, OSMO_FD_READ, and osmo_fd_update_when().
int osmo_fd_register | ( | struct osmo_fd * | fd | ) |
Register a new file descriptor with select loop abstraction.
[in] | fd | osmocom file descriptor to be registered |
References osmo_fd::fd, flags, g_poll, osmo_fd::list, llist_add_tail(), maxfd, poll_state::num_registered, osmo_fd_is_registered(), osmo_fds, OTC_GLOBAL, poll_state::poll, and poll_state::poll_size.
Referenced by gsmtap_source_add_sink(), osmo_fd_init_ofd(), osmo_mnl_init(), osmo_signalfd_setup(), and osmo_timerfd_setup().
void osmo_fd_setup | ( | struct osmo_fd * | ofd, |
int | fd, | ||
unsigned int | when, | ||
int(*)(struct osmo_fd *fd, unsigned int what) | cb, | ||
void * | data, | ||
unsigned int | priv_nr | ||
) |
Set up an osmo-fd.
Will not register it.
[in,out] | ofd | Osmo FD to be set-up |
[in] | fd | OS-level file descriptor number |
[in] | when | bit-mask of OSMO_FD_{READ,WRITE,EXECEPT} |
[in] | cb | Call-back function to be called |
[in] | data | Private context pointer |
[in] | priv_nr | Private number |
References osmo_fd::cb, data, osmo_fd::data, osmo_fd::fd, osmo_fd::priv_nr, and osmo_fd::when.
Referenced by osmo_it_q_alloc(), osmo_mnl_init(), and osmo_signalfd_setup().
void osmo_fd_unregister | ( | struct osmo_fd * | fd | ) |
Unregister a file descriptor from select loop abstraction.
[in] | fd | osmocom file descriptor to be unregistered |
References g_poll, osmo_fd::list, llist_del(), poll_state::num_registered, and unregistered_count.
Referenced by osmo_fd_close(), osmo_mnl_destroy(), osmo_timerfd_setup(), and signalfd_callback().
void osmo_fd_update_when | ( | struct osmo_fd * | ofd, |
unsigned int | when_mask, | ||
unsigned int | when | ||
) |
Update the 'when' field of osmo_fd.
"ofd->when = (ofd->when & when_mask) | when". Use this function instead of directly modifying ofd->when, as the latter will be removed soon.
References osmo_fd::when.
Referenced by osmo_fd_read_disable(), osmo_fd_read_enable(), osmo_fd_write_disable(), and osmo_fd_write_enable().
|
inlinestatic |
References osmo_fd_update_when(), and OSMO_FD_WRITE.
|
inlinestatic |
References OSMO_FD_MASK, osmo_fd_update_when(), and OSMO_FD_WRITE.
void osmo_select_init | ( | void | ) |
initialize the osmocom select abstraction for the current thread
References INIT_LLIST_HEAD, and osmo_fds.
Referenced by __attribute__().
int osmo_select_main | ( | int | polling | ) |
select main loop integration
[in] | polling | should we pollonly (1) or block on select (0) |
References _osmo_select_main(), osmo_ctx, osmo_panic(), and osmo_talloc_contexts::select.
int osmo_select_main_ctx | ( | int | polling | ) |
select main loop integration with temporary select-dispatch talloc context
[in] | polling | should we pollonly (1) or block on select (0) |
References _osmo_select_main(), osmo_ctx, and osmo_talloc_contexts::select.
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.
[in] | ctx | talloc context from which osmo_signalfd is to be allocated |
[in] | set | of signals to be accept via this file descriptor |
[in] | cb | call-back function to be called for each arriving signal |
[in] | data | opaque user-provided data to pass to callback |
References osmo_signalfd::cb, data, osmo_signalfd::data, osmo_signalfd::ofd, OSMO_FD_READ, osmo_fd_register(), osmo_fd_setup(), signalfd_callback(), and osmo_signalfd::sigset.
int osmo_timerfd_disable | ( | struct osmo_fd * | ofd | ) |
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
[in] | ofd | Osmocom wrapped timerfd |
[in] | first | Relative time at which the timer should first execute (NULL = interval) |
[in] | interval | Time interval at which subsequent timer shall fire |
References osmo_fd::fd.
Referenced by start_timer().
int osmo_timerfd_setup | ( | struct osmo_fd * | ofd, |
int(*)(struct osmo_fd *, unsigned int) | cb, | ||
void * | data | ||
) |
setup osmocom-wrapped timerfd
[in,out] | ofd | Osmocom-wrapped timerfd on which to operate |
[in] | cb | Call-back function called when timerfd becomes readable |
[in] | data | Opaque data to be passed on to call-back |
We simply initialize the data structures here, but do not yet schedule the timer.
References osmo_fd::cb, data, osmo_fd::data, osmo_fd::fd, OSMO_FD_READ, osmo_fd_register(), osmo_fd_unregister(), and osmo_fd::when.
Referenced by start_timer().
|
static |
References osmo_fd::cb, flags, g_poll, log_reset_context(), OSMO_FD_EXCEPT, osmo_fd_get_by_fd(), OSMO_FD_READ, OSMO_FD_WRITE, poll_state::poll, and osmo_fd::when.
Referenced by _osmo_select_main().
|
static |
References osmo_fd::fd, g_poll, list, llist_for_each_entry, OSMO_FD_EXCEPT, OSMO_FD_READ, OSMO_FD_WRITE, osmo_fds, poll_state::poll, and osmo_fd::when.
Referenced by _osmo_select_main().
|
static |
References osmo_signalfd::cb, osmo_fd::data, osmo_fd::fd, osmo_signalfd::ofd, and osmo_fd_unregister().
Referenced by osmo_signalfd_setup().
|
static |
Referenced by _osmo_select_main(), osmo_fd_register(), osmo_fd_unregister(), poll_disp_fds(), and poll_fill_fds().
|
static |
Referenced by osmo_fd_register().
|
static |
|
static |
Referenced by osmo_fd_disp_fds(), and osmo_fd_unregister().