Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file select.c |
| 2 | * select filedescriptor handling. |
| 3 | * Taken from: |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 4 | * userspace logging daemon for the iptables ULOG target |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 5 | * of the linux 2.4 netfilter subsystem. */ |
| 6 | /* |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 7 | * (C) 2000-2009 by Harald Welte <laforge@gnumonks.org> |
Harald Welte | e08da97 | 2017-11-13 01:00:26 +0900 | [diff] [blame] | 8 | * All Rights Reserverd. |
| 9 | * |
| 10 | * SPDX-License-Identifier: GPL-2.0+ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 11 | * |
| 12 | * This program is free software; you can redistribute it and/or modify |
Harald Welte | 9d92f0e | 2010-10-31 13:56:45 +0100 | [diff] [blame] | 13 | * it under the terms of the GNU General Public License as published by |
| 14 | * the Free Software Foundation; either version 2 of the License, or |
| 15 | * (at your option) any later version. |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 16 | * |
| 17 | * This program is distributed in the hope that it will be useful, |
| 18 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 20 | * GNU General Public License for more details. |
| 21 | * |
| 22 | * You should have received a copy of the GNU General Public License |
| 23 | * along with this program; if not, write to the Free Software |
Jaroslav Škarvada | 2b82c1c | 2015-11-11 16:02:54 +0100 | [diff] [blame] | 24 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, |
| 25 | * MA 02110-1301, USA. |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 26 | */ |
| 27 | |
| 28 | #include <fcntl.h> |
Holger Hans Peter Freyther | 4355831 | 2010-08-06 06:48:43 +0800 | [diff] [blame] | 29 | #include <stdio.h> |
Harald Welte | ea91a51 | 2017-07-13 14:28:30 +0200 | [diff] [blame] | 30 | #include <unistd.h> |
Harald Welte | 9e166e8 | 2014-03-10 17:28:33 +0100 | [diff] [blame] | 31 | #include <string.h> |
Philipp Maier | b288853 | 2016-12-09 14:07:18 +0100 | [diff] [blame] | 32 | #include <stdbool.h> |
Harald Welte | ea4d893 | 2017-12-03 16:13:39 +0100 | [diff] [blame] | 33 | #include <errno.h> |
Holger Hans Peter Freyther | 4355831 | 2010-08-06 06:48:43 +0800 | [diff] [blame] | 34 | |
Pablo Neira Ayuso | 8341934 | 2011-03-22 16:36:13 +0100 | [diff] [blame] | 35 | #include <osmocom/core/select.h> |
| 36 | #include <osmocom/core/linuxlist.h> |
| 37 | #include <osmocom/core/timer.h> |
Harald Welte | 52a8375 | 2019-02-21 16:37:10 +0100 | [diff] [blame] | 38 | #include <osmocom/core/logging.h> |
Harald Welte | 2d90611 | 2019-03-18 17:17:43 +0100 | [diff] [blame] | 39 | #include <osmocom/core/talloc.h> |
| 40 | #include <osmocom/core/utils.h> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 41 | |
Harald Welte | 5484480 | 2010-02-20 22:23:08 +0100 | [diff] [blame] | 42 | #include "../config.h" |
| 43 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 44 | #ifdef HAVE_SYS_SELECT_H |
Harald Welte | 1d604d8 | 2017-05-17 15:32:35 +0100 | [diff] [blame] | 45 | #include <sys/select.h> |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 46 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 47 | /*! \addtogroup select |
| 48 | * @{ |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 49 | * select() loop abstraction |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 50 | * |
| 51 | * \file select.c */ |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 52 | |
Harald Welte | 7a010b1 | 2019-04-06 13:46:40 +0200 | [diff] [blame] | 53 | /* keep a set of file descriptors per-thread, so that each thread can have its own |
| 54 | * distinct set of file descriptors to interact with */ |
| 55 | static __thread int maxfd = 0; |
| 56 | static __thread struct llist_head osmo_fds; /* TLS cannot use LLIST_HEAD() */ |
| 57 | static __thread int unregistered_count; |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 58 | |
Harald Welte | 6c0a0e6 | 2017-08-12 11:43:14 +0200 | [diff] [blame] | 59 | /*! Set up an osmo-fd. Will not register it. |
| 60 | * \param[inout] ofd Osmo FD to be set-up |
| 61 | * \param[in] fd OS-level file descriptor number |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 62 | * \param[in] when bit-mask of OSMO_FD_{READ,WRITE,EXECEPT} |
Harald Welte | 6c0a0e6 | 2017-08-12 11:43:14 +0200 | [diff] [blame] | 63 | * \param[in] cb Call-back function to be called |
| 64 | * \param[in] data Private context pointer |
| 65 | * \param[in] priv_nr Private number |
| 66 | */ |
| 67 | void osmo_fd_setup(struct osmo_fd *ofd, int fd, unsigned int when, |
| 68 | int (*cb)(struct osmo_fd *fd, unsigned int what), |
| 69 | void *data, unsigned int priv_nr) |
| 70 | { |
| 71 | ofd->fd = fd; |
| 72 | ofd->when = when; |
| 73 | ofd->cb = cb; |
| 74 | ofd->data = data; |
| 75 | ofd->priv_nr = priv_nr; |
| 76 | } |
Philipp Maier | b288853 | 2016-12-09 14:07:18 +0100 | [diff] [blame] | 77 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 78 | /*! Check if a file descriptor is already registered |
Philipp Maier | b288853 | 2016-12-09 14:07:18 +0100 | [diff] [blame] | 79 | * \param[in] fd osmocom file descriptor to be checked |
| 80 | * \returns true if registered; otherwise false |
| 81 | */ |
| 82 | bool osmo_fd_is_registered(struct osmo_fd *fd) |
| 83 | { |
| 84 | struct osmo_fd *entry; |
| 85 | llist_for_each_entry(entry, &osmo_fds, list) { |
| 86 | if (entry == fd) { |
| 87 | return true; |
| 88 | } |
| 89 | } |
| 90 | |
| 91 | return false; |
| 92 | } |
| 93 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 94 | /*! Register a new file descriptor with select loop abstraction |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 95 | * \param[in] fd osmocom file descriptor to be registered |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 96 | * \returns 0 on success; negative in case of error |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 97 | */ |
Pablo Neira Ayuso | f7f89d0 | 2011-05-07 12:42:40 +0200 | [diff] [blame] | 98 | int osmo_fd_register(struct osmo_fd *fd) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 99 | { |
| 100 | int flags; |
| 101 | |
| 102 | /* make FD nonblocking */ |
| 103 | flags = fcntl(fd->fd, F_GETFL); |
| 104 | if (flags < 0) |
| 105 | return flags; |
| 106 | flags |= O_NONBLOCK; |
| 107 | flags = fcntl(fd->fd, F_SETFL, flags); |
| 108 | if (flags < 0) |
| 109 | return flags; |
| 110 | |
Harald Welte | 32e1f23 | 2011-06-26 13:07:18 +0200 | [diff] [blame] | 111 | /* set close-on-exec flag */ |
| 112 | flags = fcntl(fd->fd, F_GETFD); |
| 113 | if (flags < 0) |
| 114 | return flags; |
| 115 | flags |= FD_CLOEXEC; |
| 116 | flags = fcntl(fd->fd, F_SETFD, flags); |
| 117 | if (flags < 0) |
| 118 | return flags; |
| 119 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 120 | /* Register FD */ |
| 121 | if (fd->fd > maxfd) |
| 122 | maxfd = fd->fd; |
| 123 | |
Holger Hans Peter Freyther | 4355831 | 2010-08-06 06:48:43 +0800 | [diff] [blame] | 124 | #ifdef BSC_FD_CHECK |
Philipp Maier | b288853 | 2016-12-09 14:07:18 +0100 | [diff] [blame] | 125 | if (osmo_fd_is_registered(fd)) { |
| 126 | fprintf(stderr, "Adding a osmo_fd that is already in the list.\n"); |
| 127 | return 0; |
Holger Hans Peter Freyther | 4355831 | 2010-08-06 06:48:43 +0800 | [diff] [blame] | 128 | } |
| 129 | #endif |
| 130 | |
Pablo Neira Ayuso | f7f89d0 | 2011-05-07 12:42:40 +0200 | [diff] [blame] | 131 | llist_add_tail(&fd->list, &osmo_fds); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 132 | |
| 133 | return 0; |
| 134 | } |
| 135 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 136 | /*! Unregister a file descriptor from select loop abstraction |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 137 | * \param[in] fd osmocom file descriptor to be unregistered |
| 138 | */ |
Pablo Neira Ayuso | f7f89d0 | 2011-05-07 12:42:40 +0200 | [diff] [blame] | 139 | void osmo_fd_unregister(struct osmo_fd *fd) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 140 | { |
Philipp Maier | b288853 | 2016-12-09 14:07:18 +0100 | [diff] [blame] | 141 | /* Note: when fd is inside the osmo_fds list (not registered before) |
| 142 | * this function will crash! If in doubt, check file descriptor with |
| 143 | * osmo_fd_is_registered() */ |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 144 | unregistered_count++; |
| 145 | llist_del(&fd->list); |
| 146 | } |
| 147 | |
Harald Welte | ea91a51 | 2017-07-13 14:28:30 +0200 | [diff] [blame] | 148 | /*! Close a file descriptor, mark it as closed + unregister from select loop abstraction |
| 149 | * \param[in] fd osmocom file descriptor to be unregistered + closed |
| 150 | * |
| 151 | * If \a fd is registered, we unregister it from the select() loop |
| 152 | * abstraction. We then close the fd and set it to -1, as well as |
| 153 | * unsetting any 'when' flags */ |
| 154 | void osmo_fd_close(struct osmo_fd *fd) |
| 155 | { |
| 156 | if (osmo_fd_is_registered(fd)) |
| 157 | osmo_fd_unregister(fd); |
| 158 | if (fd->fd != -1) |
| 159 | close(fd->fd); |
| 160 | fd->fd = -1; |
| 161 | fd->when = 0; |
| 162 | } |
| 163 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 164 | /*! Populate the fd_sets and return the highest fd number |
Holger Hans Peter Freyther | ff20641 | 2017-03-07 14:28:38 +0100 | [diff] [blame] | 165 | * \param[in] _rset The readfds to populate |
| 166 | * \param[in] _wset The wrtiefds to populate |
| 167 | * \param[in] _eset The errorfds to populate |
| 168 | * |
| 169 | * \returns The highest file descriptor seen or 0 on an empty list |
| 170 | */ |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 171 | inline int osmo_fd_fill_fds(void *_rset, void *_wset, void *_eset) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 172 | { |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 173 | fd_set *readset = _rset, *writeset = _wset, *exceptset = _eset; |
| 174 | struct osmo_fd *ufd; |
Holger Hans Peter Freyther | ff20641 | 2017-03-07 14:28:38 +0100 | [diff] [blame] | 175 | int highfd = 0; |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 176 | |
Pablo Neira Ayuso | f7f89d0 | 2011-05-07 12:42:40 +0200 | [diff] [blame] | 177 | llist_for_each_entry(ufd, &osmo_fds, list) { |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 178 | if (ufd->when & OSMO_FD_READ) |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 179 | FD_SET(ufd->fd, readset); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 180 | |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 181 | if (ufd->when & OSMO_FD_WRITE) |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 182 | FD_SET(ufd->fd, writeset); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 183 | |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 184 | if (ufd->when & OSMO_FD_EXCEPT) |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 185 | FD_SET(ufd->fd, exceptset); |
Holger Hans Peter Freyther | ff20641 | 2017-03-07 14:28:38 +0100 | [diff] [blame] | 186 | |
| 187 | if (ufd->fd > highfd) |
| 188 | highfd = ufd->fd; |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 189 | } |
| 190 | |
Holger Hans Peter Freyther | ff20641 | 2017-03-07 14:28:38 +0100 | [diff] [blame] | 191 | return highfd; |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 192 | } |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 193 | |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 194 | inline int osmo_fd_disp_fds(void *_rset, void *_wset, void *_eset) |
| 195 | { |
| 196 | struct osmo_fd *ufd, *tmp; |
| 197 | int work = 0; |
| 198 | fd_set *readset = _rset, *writeset = _wset, *exceptset = _eset; |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 199 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 200 | restart: |
| 201 | unregistered_count = 0; |
Pablo Neira Ayuso | f7f89d0 | 2011-05-07 12:42:40 +0200 | [diff] [blame] | 202 | llist_for_each_entry_safe(ufd, tmp, &osmo_fds, list) { |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 203 | int flags = 0; |
| 204 | |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 205 | if (FD_ISSET(ufd->fd, readset)) { |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 206 | flags |= OSMO_FD_READ; |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 207 | FD_CLR(ufd->fd, readset); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 208 | } |
| 209 | |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 210 | if (FD_ISSET(ufd->fd, writeset)) { |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 211 | flags |= OSMO_FD_WRITE; |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 212 | FD_CLR(ufd->fd, writeset); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 213 | } |
| 214 | |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 215 | if (FD_ISSET(ufd->fd, exceptset)) { |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 216 | flags |= OSMO_FD_EXCEPT; |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 217 | FD_CLR(ufd->fd, exceptset); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 218 | } |
| 219 | |
| 220 | if (flags) { |
| 221 | work = 1; |
Harald Welte | 52a8375 | 2019-02-21 16:37:10 +0100 | [diff] [blame] | 222 | /* make sure to clear any log context before processing the next incoming message |
| 223 | * as part of some file descriptor callback. This effectively prevents "context |
| 224 | * leaking" from processing of one message into processing of the next message as part |
| 225 | * of one iteration through the list of file descriptors here. See OS#3813 */ |
| 226 | log_reset_context(); |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 227 | ufd->cb(ufd, flags); |
| 228 | } |
Holger Hans Peter Freyther | 92e1e70 | 2014-04-09 17:24:00 +0200 | [diff] [blame] | 229 | /* ugly, ugly hack. If more than one filedescriptor was |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 230 | * unregistered, they might have been consecutive and |
| 231 | * llist_for_each_entry_safe() is no longer safe */ |
Holger Hans Peter Freyther | 23ba474 | 2010-04-11 17:33:19 +0200 | [diff] [blame] | 232 | /* this seems to happen with the last element of the list as well */ |
| 233 | if (unregistered_count >= 1) |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 234 | goto restart; |
| 235 | } |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 236 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 237 | return work; |
| 238 | } |
| 239 | |
Harald Welte | 2d90611 | 2019-03-18 17:17:43 +0100 | [diff] [blame] | 240 | static int _osmo_select_main(int polling) |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 241 | { |
| 242 | fd_set readset, writeset, exceptset; |
| 243 | int rc; |
| 244 | struct timeval no_time = {0, 0}; |
| 245 | |
| 246 | FD_ZERO(&readset); |
| 247 | FD_ZERO(&writeset); |
| 248 | FD_ZERO(&exceptset); |
| 249 | |
| 250 | /* prepare read and write fdsets */ |
| 251 | osmo_fd_fill_fds(&readset, &writeset, &exceptset); |
| 252 | |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 253 | if (!polling) |
| 254 | osmo_timers_prepare(); |
| 255 | rc = select(maxfd+1, &readset, &writeset, &exceptset, polling ? &no_time : osmo_timers_nearest()); |
| 256 | if (rc < 0) |
| 257 | return 0; |
| 258 | |
| 259 | /* fire timers */ |
| 260 | osmo_timers_update(); |
| 261 | |
Harald Welte | 2d90611 | 2019-03-18 17:17:43 +0100 | [diff] [blame] | 262 | OSMO_ASSERT(osmo_ctx->select); |
| 263 | |
Holger Hans Peter Freyther | 61f2888 | 2016-03-21 09:55:05 +0100 | [diff] [blame] | 264 | /* call registered callback functions */ |
| 265 | return osmo_fd_disp_fds(&readset, &writeset, &exceptset); |
| 266 | } |
| 267 | |
Harald Welte | 2d90611 | 2019-03-18 17:17:43 +0100 | [diff] [blame] | 268 | /*! select main loop integration |
| 269 | * \param[in] polling should we pollonly (1) or block on select (0) |
| 270 | * \returns 0 if no fd handled; 1 if fd handled; negative in case of error |
| 271 | */ |
| 272 | int osmo_select_main(int polling) |
| 273 | { |
| 274 | int rc = _osmo_select_main(polling); |
| 275 | #ifndef EMBEDDED |
| 276 | if (talloc_total_size(osmo_ctx->select) != 0) { |
| 277 | osmo_panic("You cannot use the 'select' volatile " |
| 278 | "context if you don't use osmo_select_main_ctx()!\n"); |
| 279 | } |
| 280 | #endif |
| 281 | return rc; |
| 282 | } |
| 283 | |
| 284 | #ifndef EMBEDDED |
| 285 | /*! select main loop integration with temporary select-dispatch talloc context |
| 286 | * \param[in] polling should we pollonly (1) or block on select (0) |
| 287 | * \returns 0 if no fd handled; 1 if fd handled; negative in case of error |
| 288 | */ |
| 289 | int osmo_select_main_ctx(int polling) |
| 290 | { |
| 291 | int rc = _osmo_select_main(polling); |
| 292 | /* free all the children of the volatile 'select' scope context */ |
| 293 | talloc_free_children(osmo_ctx->select); |
| 294 | return rc; |
| 295 | } |
| 296 | #endif |
| 297 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 298 | /*! find an osmo_fd based on the integer fd |
Harald Welte | 2d2e2cc | 2016-04-25 12:11:20 +0200 | [diff] [blame] | 299 | * \param[in] fd file descriptor to use as search key |
| 300 | * \returns \ref osmo_fd for \ref fd; NULL in case it doesn't exist */ |
Harald Welte | 6c33ae2 | 2016-03-19 21:17:58 +0100 | [diff] [blame] | 301 | struct osmo_fd *osmo_fd_get_by_fd(int fd) |
| 302 | { |
| 303 | struct osmo_fd *ofd; |
| 304 | |
| 305 | llist_for_each_entry(ofd, &osmo_fds, list) { |
| 306 | if (ofd->fd == fd) |
| 307 | return ofd; |
| 308 | } |
| 309 | return NULL; |
| 310 | } |
| 311 | |
Harald Welte | 7a010b1 | 2019-04-06 13:46:40 +0200 | [diff] [blame] | 312 | /*! initialize the osmocom select abstraction for the current thread */ |
| 313 | void osmo_select_init(void) |
| 314 | { |
| 315 | INIT_LLIST_HEAD(&osmo_fds); |
| 316 | } |
| 317 | |
| 318 | /* ensure main thread always has pre-initialized osmo_fds */ |
| 319 | static __attribute__((constructor)) void on_dso_load_select(void) |
| 320 | { |
| 321 | osmo_select_init(); |
| 322 | } |
| 323 | |
Harald Welte | ea4d893 | 2017-12-03 16:13:39 +0100 | [diff] [blame] | 324 | #ifdef HAVE_SYS_TIMERFD_H |
| 325 | #include <sys/timerfd.h> |
| 326 | |
| 327 | /*! disable the osmocom-wrapped timerfd */ |
| 328 | int osmo_timerfd_disable(struct osmo_fd *ofd) |
| 329 | { |
| 330 | const struct itimerspec its_null = { |
| 331 | .it_value = { 0, 0 }, |
| 332 | .it_interval = { 0, 0 }, |
| 333 | }; |
| 334 | return timerfd_settime(ofd->fd, 0, &its_null, NULL); |
| 335 | } |
| 336 | |
| 337 | /*! schedule the osmcoom-wrapped timerfd to occur first at \a first, then periodically at \a interval |
| 338 | * \param[in] ofd Osmocom wrapped timerfd |
| 339 | * \param[in] first Relative time at which the timer should first execute (NULL = \a interval) |
| 340 | * \param[in] interval Time interval at which subsequent timer shall fire |
| 341 | * \returns 0 on success; negative on error */ |
| 342 | int osmo_timerfd_schedule(struct osmo_fd *ofd, const struct timespec *first, |
| 343 | const struct timespec *interval) |
| 344 | { |
| 345 | struct itimerspec its; |
| 346 | |
| 347 | if (ofd->fd < 0) |
| 348 | return -EINVAL; |
| 349 | |
| 350 | /* first expiration */ |
| 351 | if (first) |
| 352 | its.it_value = *first; |
| 353 | else |
| 354 | its.it_value = *interval; |
| 355 | /* repeating interval */ |
| 356 | its.it_interval = *interval; |
| 357 | |
| 358 | return timerfd_settime(ofd->fd, 0, &its, NULL); |
| 359 | } |
| 360 | |
| 361 | /*! setup osmocom-wrapped timerfd |
| 362 | * \param[inout] ofd Osmocom-wrapped timerfd on which to operate |
| 363 | * \param[in] cb Call-back function called when timerfd becomes readable |
| 364 | * \param[in] data Opaque data to be passed on to call-back |
| 365 | * \returns 0 on success; negative on error |
| 366 | * |
| 367 | * We simply initialize the data structures here, but do not yet |
| 368 | * schedule the timer. |
| 369 | */ |
| 370 | int osmo_timerfd_setup(struct osmo_fd *ofd, int (*cb)(struct osmo_fd *, unsigned int), void *data) |
| 371 | { |
| 372 | ofd->cb = cb; |
| 373 | ofd->data = data; |
Harald Welte | 1688699 | 2019-03-20 10:26:39 +0100 | [diff] [blame] | 374 | ofd->when = OSMO_FD_READ; |
Harald Welte | ea4d893 | 2017-12-03 16:13:39 +0100 | [diff] [blame] | 375 | |
| 376 | if (ofd->fd < 0) { |
Harald Welte | 37608f9 | 2018-10-21 12:32:55 +0200 | [diff] [blame] | 377 | int rc; |
| 378 | |
Harald Welte | ea4d893 | 2017-12-03 16:13:39 +0100 | [diff] [blame] | 379 | ofd->fd = timerfd_create(CLOCK_MONOTONIC, TFD_NONBLOCK); |
| 380 | if (ofd->fd < 0) |
| 381 | return ofd->fd; |
| 382 | |
Harald Welte | 37608f9 | 2018-10-21 12:32:55 +0200 | [diff] [blame] | 383 | rc = osmo_fd_register(ofd); |
| 384 | if (rc < 0) { |
| 385 | close(ofd->fd); |
| 386 | ofd->fd = -1; |
| 387 | return rc; |
| 388 | } |
Harald Welte | ea4d893 | 2017-12-03 16:13:39 +0100 | [diff] [blame] | 389 | } |
| 390 | return 0; |
| 391 | } |
| 392 | |
| 393 | #endif /* HAVE_SYS_TIMERFD_H */ |
| 394 | |
| 395 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 396 | /*! @} */ |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 397 | |
Harald Welte | ec8b450 | 2010-02-20 20:34:29 +0100 | [diff] [blame] | 398 | #endif /* _HAVE_SYS_SELECT_H */ |