Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 1 | /*! \file osmo_io.c |
| 2 | * New osmocom async I/O API. |
| 3 | * |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 4 | * (C) 2022-2024 by Harald Welte <laforge@osmocom.org> |
| 5 | * (C) 2022-2024 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de> |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 6 | * Author: Daniel Willmann <dwillmann@sysmocom.de> |
| 7 | * |
| 8 | * All Rights Reserved. |
| 9 | * |
| 10 | * SPDX-License-Identifier: GPL-2.0+ |
| 11 | * |
| 12 | * This program is free software; you can redistribute it and/or modify |
| 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. |
| 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 | |
| 23 | #include "../config.h" |
| 24 | #if defined(__linux__) |
| 25 | |
| 26 | #include <fcntl.h> |
| 27 | #include <stdio.h> |
| 28 | #include <stdlib.h> |
| 29 | #include <talloc.h> |
| 30 | #include <unistd.h> |
| 31 | #include <string.h> |
| 32 | #include <stdbool.h> |
| 33 | #include <errno.h> |
| 34 | |
| 35 | #include <osmocom/core/osmo_io.h> |
| 36 | #include <osmocom/core/linuxlist.h> |
| 37 | #include <osmocom/core/logging.h> |
| 38 | #include <osmocom/core/msgb.h> |
| 39 | #include <osmocom/core/socket.h> |
| 40 | #include <osmocom/core/talloc.h> |
| 41 | #include <osmocom/core/utils.h> |
| 42 | |
| 43 | #include "osmo_io_internal.h" |
| 44 | |
| 45 | /*! This environment variable can be set to manually set the backend used in osmo_io */ |
| 46 | #define OSMO_IO_BACKEND_ENV "LIBOSMO_IO_BACKEND" |
| 47 | |
| 48 | const struct value_string osmo_io_backend_names[] = { |
| 49 | { OSMO_IO_BACKEND_POLL, "poll" }, |
Daniel Willmann | f91d2aa | 2023-01-04 18:20:55 +0100 | [diff] [blame] | 50 | { OSMO_IO_BACKEND_IO_URING, "io_uring" }, |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 51 | { 0, NULL } |
| 52 | }; |
| 53 | |
| 54 | static enum osmo_io_backend g_io_backend; |
| 55 | |
| 56 | /* Used by some tests, can't be static */ |
| 57 | struct iofd_backend_ops osmo_iofd_ops; |
| 58 | |
Daniel Willmann | f91d2aa | 2023-01-04 18:20:55 +0100 | [diff] [blame] | 59 | #if defined(HAVE_URING) |
| 60 | void osmo_iofd_uring_init(void); |
| 61 | #endif |
| 62 | |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 63 | /*! initialize osmo_io for the current thread */ |
| 64 | void osmo_iofd_init(void) |
| 65 | { |
| 66 | switch (g_io_backend) { |
| 67 | case OSMO_IO_BACKEND_POLL: |
| 68 | break; |
Daniel Willmann | f91d2aa | 2023-01-04 18:20:55 +0100 | [diff] [blame] | 69 | #if defined(HAVE_URING) |
| 70 | case OSMO_IO_BACKEND_IO_URING: |
| 71 | osmo_iofd_uring_init(); |
| 72 | break; |
| 73 | #endif |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 74 | default: |
| 75 | OSMO_ASSERT(0); |
| 76 | break; |
| 77 | } |
| 78 | } |
| 79 | |
| 80 | /* ensure main thread always has pre-initialized osmo_io |
| 81 | * priority 103: run after on_dso_load_select */ |
| 82 | static __attribute__((constructor(103))) void on_dso_load_osmo_io(void) |
| 83 | { |
| 84 | char *backend = getenv(OSMO_IO_BACKEND_ENV); |
| 85 | if (backend == NULL) |
| 86 | backend = OSMO_IO_BACKEND_DEFAULT; |
| 87 | |
| 88 | if (!strcmp("POLL", backend)) { |
| 89 | g_io_backend = OSMO_IO_BACKEND_POLL; |
| 90 | osmo_iofd_ops = iofd_poll_ops; |
Daniel Willmann | f91d2aa | 2023-01-04 18:20:55 +0100 | [diff] [blame] | 91 | #if defined(HAVE_URING) |
| 92 | } else if (!strcmp("IO_URING", backend)) { |
| 93 | g_io_backend = OSMO_IO_BACKEND_IO_URING; |
| 94 | osmo_iofd_ops = iofd_uring_ops; |
| 95 | #endif |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 96 | } else { |
| 97 | fprintf(stderr, "Invalid osmo_io backend requested: \"%s\"\nCheck the environment variable %s\n", backend, OSMO_IO_BACKEND_ENV); |
| 98 | exit(1); |
| 99 | } |
| 100 | |
| 101 | osmo_iofd_init(); |
| 102 | } |
| 103 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 104 | /*! Allocate the msghdr. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 105 | * \param[in] iofd the osmo_io file structure |
| 106 | * \param[in] action the action this msg(hdr) is for (read, write, ..) |
| 107 | * \param[in] msg the msg buffer to use. Will allocate a new one if NULL |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 108 | * \param[in] cmsg_size size (in bytes) of iofd_msghdr.cmsg buffer. Can be 0 if cmsg is not used. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 109 | * \returns the newly allocated msghdr or NULL in case of error */ |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 110 | struct iofd_msghdr *iofd_msghdr_alloc(struct osmo_io_fd *iofd, enum iofd_msg_action action, struct msgb *msg, |
| 111 | size_t cmsg_size) |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 112 | { |
Daniel Willmann | 012d904 | 2023-08-10 10:47:25 +0200 | [diff] [blame] | 113 | bool free_msg = false; |
| 114 | struct iofd_msghdr *hdr; |
| 115 | |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 116 | if (!msg) { |
| 117 | msg = iofd_msgb_alloc(iofd); |
Daniel Willmann | 012d904 | 2023-08-10 10:47:25 +0200 | [diff] [blame] | 118 | if (!msg) |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 119 | return NULL; |
Daniel Willmann | 012d904 | 2023-08-10 10:47:25 +0200 | [diff] [blame] | 120 | free_msg = true; |
Daniel Willmann | f083382 | 2023-07-27 18:00:32 +0200 | [diff] [blame] | 121 | } else { |
Daniel Willmann | 012d904 | 2023-08-10 10:47:25 +0200 | [diff] [blame] | 122 | talloc_steal(iofd, msg); |
| 123 | } |
| 124 | |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 125 | hdr = talloc_zero_size(iofd, sizeof(struct iofd_msghdr) + cmsg_size); |
Daniel Willmann | 012d904 | 2023-08-10 10:47:25 +0200 | [diff] [blame] | 126 | if (!hdr) { |
| 127 | if (free_msg) |
| 128 | talloc_free(msg); |
| 129 | return NULL; |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 130 | } |
| 131 | |
| 132 | hdr->action = action; |
| 133 | hdr->iofd = iofd; |
| 134 | hdr->msg = msg; |
| 135 | |
| 136 | return hdr; |
| 137 | } |
| 138 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 139 | /*! Free the msghdr. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 140 | * \param[in] msghdr the msghdr to free |
| 141 | */ |
| 142 | void iofd_msghdr_free(struct iofd_msghdr *msghdr) |
| 143 | { |
| 144 | /* msghdr->msg is never owned by msghdr, it will either be freed in the send path or |
| 145 | * or passed on to the read callback which takes ownership. */ |
| 146 | talloc_free(msghdr); |
| 147 | } |
| 148 | |
| 149 | /*! convenience wrapper to call msgb_alloc with parameters from osmo_io_fd */ |
| 150 | struct msgb *iofd_msgb_alloc(struct osmo_io_fd *iofd) |
| 151 | { |
| 152 | uint16_t headroom = iofd->msgb_alloc.headroom; |
| 153 | |
| 154 | OSMO_ASSERT(iofd->msgb_alloc.size < 0xffff - headroom); |
Daniel Willmann | 012d904 | 2023-08-10 10:47:25 +0200 | [diff] [blame] | 155 | return msgb_alloc_headroom_c(iofd, |
Pau Espin Pedrol | 63e45e6 | 2023-06-16 16:19:45 +0200 | [diff] [blame] | 156 | iofd->msgb_alloc.size + headroom, headroom, |
| 157 | iofd->name ? : "iofd_msgb"); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 158 | } |
| 159 | |
| 160 | /*! return the pending msgb in iofd or NULL if there is none*/ |
| 161 | struct msgb *iofd_msgb_pending(struct osmo_io_fd *iofd) |
| 162 | { |
| 163 | struct msgb *msg = NULL; |
| 164 | |
| 165 | msg = iofd->pending; |
| 166 | iofd->pending = NULL; |
| 167 | |
| 168 | return msg; |
| 169 | } |
| 170 | |
| 171 | /*! Return the pending msgb or allocate and return a new one */ |
| 172 | struct msgb *iofd_msgb_pending_or_alloc(struct osmo_io_fd *iofd) |
| 173 | { |
| 174 | struct msgb *msg = NULL; |
| 175 | |
| 176 | msg = iofd_msgb_pending(iofd); |
| 177 | if (!msg) |
| 178 | msg = iofd_msgb_alloc(iofd); |
| 179 | |
| 180 | return msg; |
| 181 | } |
| 182 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 183 | /*! Enqueue a message to be sent. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 184 | * |
| 185 | * Enqueues the message at the back of the queue provided there is enough space. |
| 186 | * \param[in] iofd the file descriptor |
| 187 | * \param[in] msghdr the message to enqueue |
| 188 | * \returns 0 if the message was enqueued succcessfully, |
| 189 | * -ENOSPC if the queue already contains the maximum number of messages |
| 190 | */ |
| 191 | int iofd_txqueue_enqueue(struct osmo_io_fd *iofd, struct iofd_msghdr *msghdr) |
| 192 | { |
| 193 | if (iofd->tx_queue.current_length >= iofd->tx_queue.max_length) |
| 194 | return -ENOSPC; |
| 195 | |
| 196 | llist_add_tail(&msghdr->list, &iofd->tx_queue.msg_queue); |
| 197 | iofd->tx_queue.current_length++; |
| 198 | |
Daniel Willmann | e4ecd99 | 2023-06-30 10:52:11 +0200 | [diff] [blame] | 199 | if (iofd->tx_queue.current_length == 1 && !IOFD_FLAG_ISSET(iofd, IOFD_FLAG_CLOSED)) |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 200 | osmo_iofd_ops.write_enable(iofd); |
| 201 | |
| 202 | return 0; |
| 203 | } |
| 204 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 205 | /*! Enqueue a message at the front. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 206 | * |
| 207 | * Used to enqueue a msgb from a partial send again. This function will always |
| 208 | * enqueue the message, even if the maximum number of messages is reached. |
| 209 | * \param[in] iofd the file descriptor |
| 210 | * \param[in] msghdr the message to enqueue |
| 211 | */ |
| 212 | void iofd_txqueue_enqueue_front(struct osmo_io_fd *iofd, struct iofd_msghdr *msghdr) |
| 213 | { |
| 214 | llist_add(&msghdr->list, &iofd->tx_queue.msg_queue); |
| 215 | iofd->tx_queue.current_length++; |
Daniel Willmann | e4ecd99 | 2023-06-30 10:52:11 +0200 | [diff] [blame] | 216 | |
| 217 | if (iofd->tx_queue.current_length == 1 && !IOFD_FLAG_ISSET(iofd, IOFD_FLAG_CLOSED)) |
| 218 | osmo_iofd_ops.write_enable(iofd); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 219 | } |
| 220 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 221 | /*! Dequeue a message from the front. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 222 | * |
| 223 | * \param[in] iofd the file descriptor |
| 224 | * \returns the msghdr from the front of the queue or NULL if the queue is empty |
| 225 | */ |
| 226 | struct iofd_msghdr *iofd_txqueue_dequeue(struct osmo_io_fd *iofd) |
| 227 | { |
| 228 | struct llist_head *lh; |
| 229 | |
| 230 | if (iofd->tx_queue.current_length == 0) |
| 231 | return NULL; |
| 232 | |
| 233 | lh = iofd->tx_queue.msg_queue.next; |
| 234 | |
| 235 | OSMO_ASSERT(lh); |
| 236 | iofd->tx_queue.current_length--; |
| 237 | llist_del(lh); |
| 238 | |
| 239 | if (iofd->tx_queue.current_length == 0) |
| 240 | osmo_iofd_ops.write_disable(iofd); |
| 241 | |
| 242 | return llist_entry(lh, struct iofd_msghdr, list); |
| 243 | } |
| 244 | |
| 245 | /*! Handle segmentation of the msg. If this function returns *_HANDLE_ONE or MORE then the data in msg will contain |
| 246 | * one complete message. |
| 247 | * If there are bytes left over, *pending_out will point to a msgb with the remaining data. |
| 248 | */ |
| 249 | static enum iofd_seg_act iofd_handle_segmentation(struct osmo_io_fd *iofd, struct msgb *msg, struct msgb **pending_out) |
| 250 | { |
arehbein | c0aa4bd | 2023-06-16 22:31:32 +0200 | [diff] [blame] | 251 | int extra_len, received_len; |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 252 | struct msgb *msg_pending; |
| 253 | |
Daniel Willmann | 7b59bab | 2023-07-07 11:17:59 +0200 | [diff] [blame] | 254 | /* Save the start of message before segmentation_cb (which could change it) */ |
| 255 | uint8_t *data = msg->data; |
| 256 | |
arehbein | c0aa4bd | 2023-06-16 22:31:32 +0200 | [diff] [blame] | 257 | received_len = msgb_length(msg); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 258 | |
| 259 | if (!iofd->io_ops.segmentation_cb) { |
| 260 | *pending_out = NULL; |
| 261 | return IOFD_SEG_ACT_HANDLE_ONE; |
| 262 | } |
| 263 | |
arehbein | c0aa4bd | 2023-06-16 22:31:32 +0200 | [diff] [blame] | 264 | int expected_len = iofd->io_ops.segmentation_cb(msg); |
| 265 | if (expected_len == -EAGAIN) { |
Daniel Willmann | d4d0370 | 2023-05-17 12:38:14 +0200 | [diff] [blame] | 266 | goto defer; |
arehbein | c0aa4bd | 2023-06-16 22:31:32 +0200 | [diff] [blame] | 267 | } else if (expected_len < 0) { |
Daniel Willmann | d4d0370 | 2023-05-17 12:38:14 +0200 | [diff] [blame] | 268 | /* Something is wrong, skip this msgb */ |
arehbein | c0aa4bd | 2023-06-16 22:31:32 +0200 | [diff] [blame] | 269 | LOGPIO(iofd, LOGL_ERROR, "segmentation_cb returned error (%d), skipping msg of size %d\n", |
| 270 | expected_len, received_len); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 271 | *pending_out = NULL; |
Daniel Willmann | d4d0370 | 2023-05-17 12:38:14 +0200 | [diff] [blame] | 272 | msgb_free(msg); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 273 | return IOFD_SEG_ACT_DEFER; |
| 274 | } |
| 275 | |
arehbein | c0aa4bd | 2023-06-16 22:31:32 +0200 | [diff] [blame] | 276 | extra_len = received_len - expected_len; |
Daniel Willmann | d4d0370 | 2023-05-17 12:38:14 +0200 | [diff] [blame] | 277 | /* No segmentation needed, return the whole msgb */ |
| 278 | if (extra_len == 0) { |
| 279 | *pending_out = NULL; |
| 280 | return IOFD_SEG_ACT_HANDLE_ONE; |
| 281 | /* segment is incomplete */ |
| 282 | } else if (extra_len < 0) { |
| 283 | goto defer; |
| 284 | } |
| 285 | |
| 286 | /* msgb contains more than one segment */ |
| 287 | /* Copy the trailing data over */ |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 288 | msg_pending = iofd_msgb_alloc(iofd); |
Daniel Willmann | 7b59bab | 2023-07-07 11:17:59 +0200 | [diff] [blame] | 289 | memcpy(msgb_data(msg_pending), data + expected_len, extra_len); |
Daniel Willmann | d4d0370 | 2023-05-17 12:38:14 +0200 | [diff] [blame] | 290 | msgb_put(msg_pending, extra_len); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 291 | *pending_out = msg_pending; |
| 292 | |
Daniel Willmann | 7b59bab | 2023-07-07 11:17:59 +0200 | [diff] [blame] | 293 | /* Trim the original msgb to size. Don't use msgb_trim because we need to reference |
| 294 | * msg->data from before it might have been modified by the segmentation_cb(). */ |
Daniel Willmann | 7b59bab | 2023-07-07 11:17:59 +0200 | [diff] [blame] | 295 | msg->tail = data + expected_len; |
Daniel Willmann | 97d2144 | 2023-07-18 09:46:27 +0200 | [diff] [blame] | 296 | msg->len = msg->tail - msg->data; |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 297 | return IOFD_SEG_ACT_HANDLE_MORE; |
Daniel Willmann | d4d0370 | 2023-05-17 12:38:14 +0200 | [diff] [blame] | 298 | |
| 299 | defer: |
| 300 | *pending_out = msg; |
| 301 | return IOFD_SEG_ACT_DEFER; |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 302 | } |
| 303 | |
| 304 | /*! Restore message boundaries on read() and pass individual messages to the read callback |
| 305 | */ |
| 306 | void iofd_handle_segmented_read(struct osmo_io_fd *iofd, struct msgb *msg, int rc) |
| 307 | { |
| 308 | int res; |
| 309 | struct msgb *pending = NULL; |
| 310 | |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 311 | OSMO_ASSERT(iofd->mode == OSMO_IO_FD_MODE_READ_WRITE); |
| 312 | |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 313 | if (rc <= 0) { |
| 314 | iofd->io_ops.read_cb(iofd, rc, msg); |
| 315 | return; |
| 316 | } |
| 317 | |
| 318 | do { |
| 319 | res = iofd_handle_segmentation(iofd, msg, &pending); |
| 320 | if (res != IOFD_SEG_ACT_DEFER || rc < 0) |
| 321 | iofd->io_ops.read_cb(iofd, rc, msg); |
| 322 | if (res == IOFD_SEG_ACT_HANDLE_MORE) |
| 323 | msg = pending; |
| 324 | } while (res == IOFD_SEG_ACT_HANDLE_MORE); |
| 325 | |
| 326 | OSMO_ASSERT(iofd->pending == NULL); |
| 327 | iofd->pending = pending; |
| 328 | } |
| 329 | |
Harald Welte | 987a86a | 2023-11-18 18:46:24 +0100 | [diff] [blame] | 330 | /*! completion handler: Called by osmo_io backend after a given I/O operation has completed |
| 331 | * \param[in] iofd I/O file-descriptor on which I/O has completed |
| 332 | * \param[in] msg message buffer containing data related to completed I/O |
| 333 | * \param[in] hdr serialized msghdr containing state of completed I/O */ |
Daniel Willmann | 2b34e92 | 2023-08-23 18:02:13 +0200 | [diff] [blame] | 334 | void iofd_handle_recv(struct osmo_io_fd *iofd, struct msgb *msg, int rc, struct iofd_msghdr *hdr) |
| 335 | { |
Daniel Willmann | 012d904 | 2023-08-10 10:47:25 +0200 | [diff] [blame] | 336 | talloc_steal(iofd->msgb_alloc.ctx, msg); |
Daniel Willmann | 2b34e92 | 2023-08-23 18:02:13 +0200 | [diff] [blame] | 337 | switch (iofd->mode) { |
| 338 | case OSMO_IO_FD_MODE_READ_WRITE: |
| 339 | iofd_handle_segmented_read(iofd, msg, rc); |
| 340 | break; |
| 341 | case OSMO_IO_FD_MODE_RECVFROM_SENDTO: |
| 342 | iofd->io_ops.recvfrom_cb(iofd, rc, msg, &hdr->osa); |
| 343 | break; |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 344 | case OSMO_IO_FD_MODE_RECVMSG_SENDMSG: |
| 345 | iofd->io_ops.recvmsg_cb(iofd, rc, msg, &hdr->hdr); |
| 346 | break; |
| 347 | default: |
Daniel Willmann | 2b34e92 | 2023-08-23 18:02:13 +0200 | [diff] [blame] | 348 | OSMO_ASSERT(false); |
| 349 | break; |
| 350 | } |
| 351 | } |
| 352 | |
Daniel Willmann | 8461188 | 2023-11-21 10:17:00 +0100 | [diff] [blame] | 353 | /*! completion handler: Calld by osmo_io backend after a given I/O operation has completed |
| 354 | * \param[in] iofd I/O file-descriptor on which I/O has completed |
| 355 | * \param[in] rc return value of the I/O operation |
| 356 | * \param[in] msghdr serialized msghdr containing state of completed I/O |
| 357 | */ |
| 358 | void iofd_handle_send_completion(struct osmo_io_fd *iofd, int rc, struct iofd_msghdr *msghdr) |
| 359 | { |
| 360 | struct msgb *msg = msghdr->msg; |
| 361 | |
| 362 | /* Incomplete write */ |
| 363 | if (rc > 0 && rc < msgb_length(msg)) { |
| 364 | /* Re-enqueue remaining data */ |
| 365 | msgb_pull(msg, rc); |
| 366 | msghdr->iov[0].iov_len = msgb_length(msg); |
| 367 | iofd_txqueue_enqueue_front(iofd, msghdr); |
| 368 | return; |
| 369 | } |
| 370 | |
| 371 | /* Reenqueue the complete msgb */ |
| 372 | if (rc == -EAGAIN) { |
| 373 | iofd_txqueue_enqueue_front(iofd, msghdr); |
| 374 | return; |
| 375 | } |
| 376 | |
| 377 | /* All other failure and success cases are handled here */ |
| 378 | switch (msghdr->action) { |
| 379 | case IOFD_ACT_WRITE: |
| 380 | iofd->io_ops.write_cb(iofd, rc, msg); |
| 381 | break; |
| 382 | case IOFD_ACT_SENDTO: |
| 383 | iofd->io_ops.sendto_cb(iofd, rc, msg, &msghdr->osa); |
| 384 | break; |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 385 | case IOFD_ACT_SENDMSG: |
| 386 | iofd->io_ops.sendmsg_cb(iofd, rc, msg); |
| 387 | break; |
Daniel Willmann | 8461188 | 2023-11-21 10:17:00 +0100 | [diff] [blame] | 388 | default: |
| 389 | OSMO_ASSERT(0); |
| 390 | } |
| 391 | |
| 392 | msgb_free(msghdr->msg); |
| 393 | iofd_msghdr_free(msghdr); |
| 394 | } |
| 395 | |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 396 | /* Public functions */ |
| 397 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 398 | /*! Send a message through a connected socket. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 399 | * |
| 400 | * Appends the message to the internal transmit queue. |
| 401 | * If the function returns success (0) it will take ownership of the msgb and |
| 402 | * internally call msgb_free() after the write request completes. |
| 403 | * In case of an error the msgb needs to be freed by the caller. |
| 404 | * \param[in] iofd file descriptor to write to |
| 405 | * \param[in] msg message buffer to write |
| 406 | * \returns 0 in case of success; a negative value in case of error |
| 407 | */ |
| 408 | int osmo_iofd_write_msgb(struct osmo_io_fd *iofd, struct msgb *msg) |
| 409 | { |
| 410 | int rc; |
Daniel Willmann | 2386e9a | 2023-09-28 15:28:13 +0200 | [diff] [blame] | 411 | |
Daniel Willmann | afdfc6a | 2023-11-21 10:10:37 +0100 | [diff] [blame] | 412 | OSMO_ASSERT(iofd->mode == OSMO_IO_FD_MODE_READ_WRITE); |
Daniel Willmann | 2386e9a | 2023-09-28 15:28:13 +0200 | [diff] [blame] | 413 | if (OSMO_UNLIKELY(!iofd->io_ops.write_cb)) { |
| 414 | LOGPIO(iofd, LOGL_ERROR, "write_cb not set, Rejecting msgb\n"); |
| 415 | return -EINVAL; |
| 416 | } |
| 417 | |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 418 | struct iofd_msghdr *msghdr = iofd_msghdr_alloc(iofd, IOFD_ACT_WRITE, msg, 0); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 419 | if (!msghdr) |
| 420 | return -ENOMEM; |
| 421 | |
Daniel Willmann | 92efac2 | 2023-08-01 09:55:13 +0200 | [diff] [blame] | 422 | msghdr->flags = MSG_NOSIGNAL; |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 423 | msghdr->iov[0].iov_base = msgb_data(msghdr->msg); |
| 424 | msghdr->iov[0].iov_len = msgb_length(msghdr->msg); |
| 425 | msghdr->hdr.msg_iov = &msghdr->iov[0]; |
| 426 | msghdr->hdr.msg_iovlen = 1; |
| 427 | |
| 428 | rc = iofd_txqueue_enqueue(iofd, msghdr); |
| 429 | if (rc < 0) { |
| 430 | iofd_msghdr_free(msghdr); |
| 431 | LOGPIO(iofd, LOGL_ERROR, "enqueueing message failed (%d). Rejecting msgb\n", rc); |
| 432 | return rc; |
| 433 | } |
| 434 | |
| 435 | return 0; |
| 436 | } |
| 437 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 438 | /*! Send a message through an unconnected socket. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 439 | * |
| 440 | * Appends the message to the internal transmit queue. |
| 441 | * If the function returns success (0), it will take ownership of the msgb and |
| 442 | * internally call msgb_free() after the write request completes. |
| 443 | * In case of an error the msgb needs to be freed by the caller. |
| 444 | * \param[in] iofd file descriptor to write to |
| 445 | * \param[in] msg message buffer to send |
| 446 | * \param[in] sendto_flags Flags to pass to the send call |
| 447 | * \param[in] dest destination address to send the message to |
| 448 | * \returns 0 in case of success; a negative value in case of error |
| 449 | */ |
| 450 | int osmo_iofd_sendto_msgb(struct osmo_io_fd *iofd, struct msgb *msg, int sendto_flags, const struct osmo_sockaddr *dest) |
| 451 | { |
| 452 | int rc; |
| 453 | |
| 454 | OSMO_ASSERT(iofd->mode == OSMO_IO_FD_MODE_RECVFROM_SENDTO); |
Daniel Willmann | 2386e9a | 2023-09-28 15:28:13 +0200 | [diff] [blame] | 455 | if (OSMO_UNLIKELY(!iofd->io_ops.sendto_cb)) { |
| 456 | LOGPIO(iofd, LOGL_ERROR, "sendto_cb not set, Rejecting msgb\n"); |
| 457 | return -EINVAL; |
| 458 | } |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 459 | |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 460 | struct iofd_msghdr *msghdr = iofd_msghdr_alloc(iofd, IOFD_ACT_SENDTO, msg, 0); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 461 | if (!msghdr) |
| 462 | return -ENOMEM; |
| 463 | |
| 464 | if (dest) { |
| 465 | msghdr->osa = *dest; |
| 466 | msghdr->hdr.msg_name = &msghdr->osa.u.sa; |
| 467 | msghdr->hdr.msg_namelen = osmo_sockaddr_size(&msghdr->osa); |
| 468 | } |
| 469 | msghdr->flags = sendto_flags; |
| 470 | msghdr->iov[0].iov_base = msgb_data(msghdr->msg); |
| 471 | msghdr->iov[0].iov_len = msgb_length(msghdr->msg); |
| 472 | msghdr->hdr.msg_iov = &msghdr->iov[0]; |
| 473 | msghdr->hdr.msg_iovlen = 1; |
| 474 | |
| 475 | rc = iofd_txqueue_enqueue(iofd, msghdr); |
| 476 | if (rc < 0) { |
| 477 | iofd_msghdr_free(msghdr); |
| 478 | LOGPIO(iofd, LOGL_ERROR, "enqueueing message failed (%d). Rejecting msgb\n", rc); |
| 479 | return rc; |
| 480 | } |
| 481 | |
| 482 | return 0; |
| 483 | } |
| 484 | |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 485 | /*! ismo_io equivalent of the sendmsg(2) socket API call |
| 486 | * |
| 487 | * Appends the message to the internal transmit queue. |
| 488 | * If the function returns success (0), it will take ownership of the msgb and |
| 489 | * internally call msgb_free() after the write request completes. |
| 490 | * In case of an error the msgb needs to be freed by the caller. |
| 491 | * \param[in] iofd file descriptor to write to |
| 492 | * \param[in] msg message buffer to send; is used to fill msgh->iov[] |
| 493 | * \param[in] sendmsg_flags Flags to pass to the send call |
| 494 | * \param[in] msgh 'struct msghdr' for name/control/flags. iov must be empty! |
| 495 | * \returns 0 in case of success; a negative value in case of error |
| 496 | */ |
| 497 | int osmo_iofd_sendmsg_msgb(struct osmo_io_fd *iofd, struct msgb *msg, int sendmsg_flags, const struct msghdr *msgh) |
| 498 | { |
| 499 | int rc; |
| 500 | struct iofd_msghdr *msghdr; |
| 501 | |
| 502 | OSMO_ASSERT(iofd->mode == OSMO_IO_FD_MODE_RECVMSG_SENDMSG); |
| 503 | if (OSMO_UNLIKELY(!iofd->io_ops.sendmsg_cb)) { |
| 504 | LOGPIO(iofd, LOGL_ERROR, "sendmsg_cb not set, Rejecting msgb\n"); |
| 505 | return -EINVAL; |
| 506 | } |
| 507 | |
| 508 | if (OSMO_UNLIKELY(msgh->msg_namelen > sizeof(msghdr->osa))) { |
| 509 | LOGPIO(iofd, LOGL_ERROR, "osmo_iofd_sendmsg msg_namelen (%u) > supported %zu bytes\n", |
| 510 | msgh->msg_namelen, sizeof(msghdr->osa)); |
| 511 | return -EINVAL; |
| 512 | } |
| 513 | |
| 514 | if (OSMO_UNLIKELY(msgh->msg_iovlen)) { |
| 515 | LOGPIO(iofd, LOGL_ERROR, "osmo_iofd_sendmsg must have all in 'struct msgb', not in 'msg_iov'\n"); |
| 516 | return -EINVAL; |
| 517 | } |
| 518 | |
| 519 | msghdr = iofd_msghdr_alloc(iofd, IOFD_ACT_SENDMSG, msg, msgh->msg_controllen); |
| 520 | if (!msghdr) |
| 521 | return -ENOMEM; |
| 522 | |
| 523 | /* copy over optional address */ |
| 524 | if (msgh->msg_name) { |
| 525 | memcpy(&msghdr->osa, msgh->msg_name, msgh->msg_namelen); |
| 526 | msghdr->hdr.msg_name = &msghdr->osa.u.sa; |
| 527 | msghdr->hdr.msg_namelen = msgh->msg_namelen; |
| 528 | } |
| 529 | |
| 530 | /* build iov from msgb */ |
| 531 | msghdr->iov[0].iov_base = msgb_data(msghdr->msg); |
| 532 | msghdr->iov[0].iov_len = msgb_length(msghdr->msg); |
| 533 | msghdr->hdr.msg_iov = &msghdr->iov[0]; |
| 534 | msghdr->hdr.msg_iovlen = 1; |
| 535 | |
| 536 | /* copy over the cmsg from the msghdr */ |
| 537 | if (msgh->msg_control && msgh->msg_controllen) { |
| 538 | msghdr->hdr.msg_control = msghdr->cmsg; |
| 539 | msghdr->hdr.msg_controllen = msgh->msg_controllen; |
| 540 | memcpy(msghdr->cmsg, msgh->msg_control, msgh->msg_controllen); |
| 541 | } |
| 542 | |
| 543 | /* copy over msg_flags */ |
| 544 | msghdr->hdr.msg_flags = sendmsg_flags; |
| 545 | |
| 546 | rc = iofd_txqueue_enqueue(iofd, msghdr); |
| 547 | if (rc < 0) { |
| 548 | iofd_msghdr_free(msghdr); |
| 549 | LOGPIO(iofd, LOGL_ERROR, "enqueueing message failed (%d). Rejecting msgb\n", rc); |
| 550 | return rc; |
| 551 | } |
| 552 | |
| 553 | return 0; |
| 554 | } |
| 555 | |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 556 | static int check_mode_callback_compat(enum osmo_io_fd_mode mode, const struct osmo_io_ops *ops) |
| 557 | { |
| 558 | switch (mode) { |
| 559 | case OSMO_IO_FD_MODE_READ_WRITE: |
| 560 | if (ops->recvfrom_cb || ops->sendto_cb) |
| 561 | return false; |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 562 | if (ops->recvmsg_cb || ops->sendmsg_cb) |
| 563 | return false; |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 564 | break; |
| 565 | case OSMO_IO_FD_MODE_RECVFROM_SENDTO: |
| 566 | if (ops->read_cb || ops->write_cb) |
| 567 | return false; |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 568 | if (ops->recvmsg_cb || ops->sendmsg_cb) |
| 569 | return false; |
| 570 | break; |
| 571 | case OSMO_IO_FD_MODE_RECVMSG_SENDMSG: |
| 572 | if (ops->recvfrom_cb || ops->sendto_cb) |
| 573 | return false; |
| 574 | if (ops->read_cb || ops->write_cb) |
| 575 | return false; |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 576 | break; |
| 577 | default: |
| 578 | break; |
| 579 | } |
| 580 | |
| 581 | return true; |
| 582 | } |
| 583 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 584 | /*! Allocate and setup a new iofd. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 585 | * \param[in] ctx the parent context from which to allocate |
| 586 | * \param[in] fd the underlying system file descriptor |
| 587 | * \param[in] name the name of the iofd |
| 588 | * \param[in] mode the mode of the iofd, whether it should use read()/write(), sendto()/recvfrom() |
| 589 | * \param[in] ioops structure with read/write/send/recv callbacks |
| 590 | * \param[in] data user data pointer accessible by the ioops callbacks |
| 591 | * \returns The newly allocated osmo_io_fd struct or NULL on failure |
| 592 | */ |
| 593 | struct osmo_io_fd *osmo_iofd_setup(const void *ctx, int fd, const char *name, enum osmo_io_fd_mode mode, |
| 594 | const struct osmo_io_ops *ioops, void *data) |
| 595 | { |
Harald Welte | c380f29 | 2023-11-18 19:54:46 +0100 | [diff] [blame] | 596 | struct osmo_io_fd *iofd; |
| 597 | |
| 598 | /* reject unsupported/unknown modes */ |
| 599 | switch (mode) { |
| 600 | case OSMO_IO_FD_MODE_READ_WRITE: |
| 601 | case OSMO_IO_FD_MODE_RECVFROM_SENDTO: |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 602 | case OSMO_IO_FD_MODE_RECVMSG_SENDMSG: |
Harald Welte | c380f29 | 2023-11-18 19:54:46 +0100 | [diff] [blame] | 603 | break; |
| 604 | default: |
| 605 | return NULL; |
| 606 | } |
| 607 | |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 608 | if (!check_mode_callback_compat(mode, ioops)) |
| 609 | return NULL; |
| 610 | |
Harald Welte | c380f29 | 2023-11-18 19:54:46 +0100 | [diff] [blame] | 611 | iofd = talloc_zero(ctx, struct osmo_io_fd); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 612 | if (!iofd) |
| 613 | return NULL; |
| 614 | |
| 615 | iofd->fd = fd; |
| 616 | iofd->mode = mode; |
Daniel Willmann | f89162f | 2023-06-26 19:24:46 +0200 | [diff] [blame] | 617 | IOFD_FLAG_SET(iofd, IOFD_FLAG_CLOSED); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 618 | |
Pau Espin Pedrol | 63e45e6 | 2023-06-16 16:19:45 +0200 | [diff] [blame] | 619 | if (name) |
| 620 | iofd->name = talloc_strdup(iofd, name); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 621 | |
| 622 | if (ioops) |
| 623 | iofd->io_ops = *ioops; |
| 624 | |
| 625 | iofd->pending = NULL; |
| 626 | |
| 627 | iofd->data = data; |
| 628 | |
| 629 | iofd->msgb_alloc.ctx = ctx; |
| 630 | iofd->msgb_alloc.size = OSMO_IO_DEFAULT_MSGB_SIZE; |
| 631 | iofd->msgb_alloc.headroom = OSMO_IO_DEFAULT_MSGB_HEADROOM; |
| 632 | |
| 633 | iofd->tx_queue.max_length = 32; |
| 634 | INIT_LLIST_HEAD(&iofd->tx_queue.msg_queue); |
| 635 | |
| 636 | return iofd; |
| 637 | } |
| 638 | |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 639 | /*! Set the size of the control message buffer allocated when submitting recvmsg */ |
| 640 | int osmo_iofd_set_cmsg_size(struct osmo_io_fd *iofd, size_t cmsg_size) |
| 641 | { |
| 642 | if (iofd->mode != OSMO_IO_FD_MODE_RECVMSG_SENDMSG) |
| 643 | return -EINVAL; |
| 644 | |
| 645 | iofd->cmsg_size = cmsg_size; |
| 646 | return 0; |
| 647 | } |
| 648 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 649 | /*! Register the fd with the underlying backend. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 650 | * |
| 651 | * \param[in] iofd the iofd file descriptor |
| 652 | * \param[in] fd the system fd number that will be registeres. If negative will use the one already set. |
| 653 | * \returns zero on success, a negative value on error |
| 654 | */ |
| 655 | int osmo_iofd_register(struct osmo_io_fd *iofd, int fd) |
| 656 | { |
Daniel Willmann | eb9edba | 2023-06-06 16:53:38 +0200 | [diff] [blame] | 657 | int rc = 0; |
| 658 | |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 659 | if (fd >= 0) |
| 660 | iofd->fd = fd; |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 661 | |
| 662 | if (osmo_iofd_ops.register_fd) |
Daniel Willmann | eb9edba | 2023-06-06 16:53:38 +0200 | [diff] [blame] | 663 | rc = osmo_iofd_ops.register_fd(iofd); |
Daniel Willmann | acb9776 | 2023-06-07 17:02:31 +0200 | [diff] [blame] | 664 | if (rc) |
| 665 | return rc; |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 666 | |
Daniel Willmann | f89162f | 2023-06-26 19:24:46 +0200 | [diff] [blame] | 667 | IOFD_FLAG_UNSET(iofd, IOFD_FLAG_CLOSED); |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 668 | if ((iofd->mode == OSMO_IO_FD_MODE_READ_WRITE && iofd->io_ops.read_cb) || |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 669 | (iofd->mode == OSMO_IO_FD_MODE_RECVFROM_SENDTO && iofd->io_ops.recvfrom_cb) || |
| 670 | (iofd->mode == OSMO_IO_FD_MODE_RECVMSG_SENDMSG && iofd->io_ops.recvmsg_cb)) { |
Daniel Willmann | 2386e9a | 2023-09-28 15:28:13 +0200 | [diff] [blame] | 671 | osmo_iofd_ops.read_enable(iofd); |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 672 | } |
Daniel Willmann | e2a8dc4 | 2023-06-30 10:51:53 +0200 | [diff] [blame] | 673 | |
| 674 | if (iofd->tx_queue.current_length > 0) |
| 675 | osmo_iofd_ops.write_enable(iofd); |
Daniel Willmann | eb9edba | 2023-06-06 16:53:38 +0200 | [diff] [blame] | 676 | |
| 677 | return rc; |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 678 | } |
| 679 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 680 | /*! Unregister the fd from the underlying backend. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 681 | * |
| 682 | * \param[in] iofd the file descriptor |
| 683 | * \returns zero on success, a negative value on error |
| 684 | */ |
| 685 | int osmo_iofd_unregister(struct osmo_io_fd *iofd) |
| 686 | { |
| 687 | if (osmo_iofd_ops.unregister_fd) |
| 688 | return osmo_iofd_ops.unregister_fd(iofd); |
Daniel Willmann | f89162f | 2023-06-26 19:24:46 +0200 | [diff] [blame] | 689 | IOFD_FLAG_SET(iofd, IOFD_FLAG_CLOSED); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 690 | |
| 691 | return 0; |
| 692 | } |
| 693 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 694 | /*! Get the number of messages in the tx queue. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 695 | * |
| 696 | * \param[in] iofd the file descriptor |
| 697 | */ |
| 698 | unsigned int osmo_iofd_txqueue_len(struct osmo_io_fd *iofd) |
| 699 | { |
| 700 | return iofd->tx_queue.current_length; |
| 701 | } |
| 702 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 703 | /*! Clear the transmit queue of the the iofd. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 704 | * |
| 705 | * This function frees all messages currently pending in the transmit queue |
| 706 | * \param[in] iofd the file descriptor |
| 707 | */ |
| 708 | void osmo_iofd_txqueue_clear(struct osmo_io_fd *iofd) |
| 709 | { |
| 710 | struct iofd_msghdr *hdr; |
| 711 | while ((hdr = iofd_txqueue_dequeue(iofd))) { |
| 712 | msgb_free(hdr->msg); |
| 713 | iofd_msghdr_free(hdr); |
| 714 | } |
| 715 | } |
| 716 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 717 | /*! Free the iofd. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 718 | * |
| 719 | * This function is safe to use in the read/write callbacks and will defer freeing it until safe to do so. |
| 720 | * The iofd will be closed before. |
| 721 | * \param[in] iofd the file descriptor |
| 722 | */ |
| 723 | void osmo_iofd_free(struct osmo_io_fd *iofd) |
| 724 | { |
| 725 | if (!iofd) |
| 726 | return; |
| 727 | |
| 728 | osmo_iofd_close(iofd); |
| 729 | |
Daniel Willmann | f89162f | 2023-06-26 19:24:46 +0200 | [diff] [blame] | 730 | if (!IOFD_FLAG_ISSET(iofd, IOFD_FLAG_IN_CALLBACK)) { |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 731 | talloc_free(iofd); |
| 732 | } else { |
| 733 | /* Prevent our parent context from freeing us prematurely */ |
| 734 | talloc_steal(NULL, iofd); |
Daniel Willmann | f89162f | 2023-06-26 19:24:46 +0200 | [diff] [blame] | 735 | IOFD_FLAG_SET(iofd, IOFD_FLAG_TO_FREE); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 736 | } |
| 737 | } |
| 738 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 739 | /*! Close the iofd. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 740 | * |
| 741 | * This function closes the underlying fd and clears any messages in the tx queue |
| 742 | * The iofd is not freed and can be assigned a new file descriptor with osmo_iofd_register() |
| 743 | * \param[in] iofd the file descriptor |
| 744 | * \ returns 0 on success, a negative value otherwise |
| 745 | */ |
| 746 | int osmo_iofd_close(struct osmo_io_fd *iofd) |
| 747 | { |
| 748 | int rc = 0; |
| 749 | |
Daniel Willmann | f89162f | 2023-06-26 19:24:46 +0200 | [diff] [blame] | 750 | if (IOFD_FLAG_ISSET(iofd, IOFD_FLAG_CLOSED)) |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 751 | return rc; |
| 752 | |
Daniel Willmann | f89162f | 2023-06-26 19:24:46 +0200 | [diff] [blame] | 753 | IOFD_FLAG_SET(iofd, IOFD_FLAG_CLOSED); |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 754 | |
| 755 | /* Free pending msgs in tx queue */ |
| 756 | osmo_iofd_txqueue_clear(iofd); |
| 757 | msgb_free(iofd->pending); |
| 758 | |
| 759 | iofd->pending = NULL; |
| 760 | |
| 761 | if (osmo_iofd_ops.close) |
| 762 | rc = osmo_iofd_ops.close(iofd); |
| 763 | iofd->fd = -1; |
| 764 | return rc; |
| 765 | } |
| 766 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 767 | /*! Set the size and headroom of the msgb allocated when receiving messages. |
Daniel Willmann | 4731e71 | 2023-07-07 11:21:15 +0200 | [diff] [blame] | 768 | * \param[in] iofd the file descriptor |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 769 | * \param[in] size the size of the msgb when receiving data |
| 770 | * \param[in] headroom the headroom of the msgb when receiving data |
| 771 | */ |
| 772 | void osmo_iofd_set_alloc_info(struct osmo_io_fd *iofd, unsigned int size, unsigned int headroom) |
| 773 | { |
| 774 | iofd->msgb_alloc.headroom = headroom; |
| 775 | iofd->msgb_alloc.size = size; |
| 776 | } |
| 777 | |
Daniel Willmann | a9303f3 | 2023-07-07 11:20:48 +0200 | [diff] [blame] | 778 | /*! Set the maximum number of messages enqueued for sending. |
| 779 | * \param[in] iofd the file descriptor |
| 780 | * \param[in] size the maximum size of the transmit queue |
| 781 | */ |
| 782 | void osmo_iofd_set_txqueue_max_length(struct osmo_io_fd *iofd, unsigned int max_length) |
| 783 | { |
| 784 | iofd->tx_queue.max_length = max_length; |
| 785 | } |
| 786 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 787 | /*! Get the associated user-data from an iofd. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 788 | * \param[in] iofd the file descriptor |
| 789 | * \returns the data that was previously set with \ref osmo_iofd_setup() |
| 790 | */ |
| 791 | void *osmo_iofd_get_data(const struct osmo_io_fd *iofd) |
| 792 | { |
| 793 | return iofd->data; |
| 794 | } |
| 795 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 796 | /*! Set the associated user-data from an iofd. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 797 | * \param[in] iofd the file descriptor |
| 798 | * \param[in] data the data to set |
| 799 | */ |
| 800 | void osmo_iofd_set_data(struct osmo_io_fd *iofd, void *data) |
| 801 | { |
| 802 | iofd->data = data; |
| 803 | } |
| 804 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 805 | /*! Get the private number from an iofd. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 806 | * \param[in] iofd the file descriptor |
| 807 | * \returns the private number that was previously set with \ref osmo_iofd_set_priv_nr() |
| 808 | */ |
| 809 | unsigned int osmo_iofd_get_priv_nr(const struct osmo_io_fd *iofd) |
| 810 | { |
| 811 | return iofd->priv_nr; |
| 812 | } |
| 813 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 814 | /*! Set the private number from an iofd. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 815 | * \param[in] iofd the file descriptor |
| 816 | * \param[in] priv_nr the private number to set |
| 817 | */ |
| 818 | void osmo_iofd_set_priv_nr(struct osmo_io_fd *iofd, unsigned int priv_nr) |
| 819 | { |
| 820 | iofd->priv_nr = priv_nr; |
| 821 | } |
| 822 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 823 | /*! Get the underlying file descriptor from an iofd. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 824 | * \param[in] iofd the file descriptor |
| 825 | * \returns the underlying file descriptor number */ |
| 826 | int osmo_iofd_get_fd(const struct osmo_io_fd *iofd) |
| 827 | { |
| 828 | return iofd->fd; |
| 829 | } |
| 830 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 831 | /*! Get the name of the file descriptor. |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 832 | * \param[in] iofd the file descriptor |
| 833 | * \returns the name of the iofd as given in \ref osmo_iofd_setup() */ |
| 834 | const char *osmo_iofd_get_name(const struct osmo_io_fd *iofd) |
| 835 | { |
| 836 | return iofd->name; |
| 837 | } |
| 838 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 839 | /*! Set the name of the file descriptor. |
Pau Espin Pedrol | 63e45e6 | 2023-06-16 16:19:45 +0200 | [diff] [blame] | 840 | * \param[in] iofd the file descriptor |
| 841 | * \param[in] name the name to set on the file descriptor */ |
| 842 | void osmo_iofd_set_name(struct osmo_io_fd *iofd, const char *name) |
| 843 | { |
| 844 | osmo_talloc_replace_string(iofd, &iofd->name, name); |
| 845 | } |
| 846 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 847 | /*! Set the osmo_io_ops for an iofd. |
arehbein | 0c374c6 | 2023-05-14 21:43:11 +0200 | [diff] [blame] | 848 | * \param[in] iofd Target iofd file descriptor |
| 849 | * \param[in] ioops osmo_io_ops structure to be set */ |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 850 | int osmo_iofd_set_ioops(struct osmo_io_fd *iofd, const struct osmo_io_ops *ioops) |
arehbein | 0c374c6 | 2023-05-14 21:43:11 +0200 | [diff] [blame] | 851 | { |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 852 | if (!check_mode_callback_compat(iofd->mode, ioops)) |
| 853 | return -EINVAL; |
| 854 | |
arehbein | 0c374c6 | 2023-05-14 21:43:11 +0200 | [diff] [blame] | 855 | iofd->io_ops = *ioops; |
Daniel Willmann | 2386e9a | 2023-09-28 15:28:13 +0200 | [diff] [blame] | 856 | |
| 857 | switch (iofd->mode) { |
| 858 | case OSMO_IO_FD_MODE_READ_WRITE: |
| 859 | if (iofd->io_ops.read_cb) |
| 860 | osmo_iofd_ops.read_enable(iofd); |
| 861 | else |
| 862 | osmo_iofd_ops.read_disable(iofd); |
| 863 | break; |
| 864 | case OSMO_IO_FD_MODE_RECVFROM_SENDTO: |
| 865 | if (iofd->io_ops.recvfrom_cb) |
| 866 | osmo_iofd_ops.read_enable(iofd); |
| 867 | else |
| 868 | osmo_iofd_ops.read_disable(iofd); |
| 869 | break; |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 870 | case OSMO_IO_FD_MODE_RECVMSG_SENDMSG: |
| 871 | if (iofd->io_ops.recvmsg_cb) |
| 872 | osmo_iofd_ops.read_enable(iofd); |
| 873 | else |
| 874 | osmo_iofd_ops.read_disable(iofd); |
| 875 | break; |
Daniel Willmann | 2386e9a | 2023-09-28 15:28:13 +0200 | [diff] [blame] | 876 | default: |
| 877 | OSMO_ASSERT(0); |
| 878 | } |
Harald Welte | b365b1d | 2024-02-23 16:08:49 +0100 | [diff] [blame] | 879 | |
| 880 | return 0; |
arehbein | 0c374c6 | 2023-05-14 21:43:11 +0200 | [diff] [blame] | 881 | } |
| 882 | |
Daniel Willmann | d0d9ecb | 2023-07-12 11:55:52 +0200 | [diff] [blame] | 883 | /*! Notify the user if/when the socket is connected. |
Daniel Willmann | e2a8dc4 | 2023-06-30 10:51:53 +0200 | [diff] [blame] | 884 | * When the socket is connected the write_cb will be called. |
| 885 | * \param[in] iofd the file descriptor */ |
| 886 | void osmo_iofd_notify_connected(struct osmo_io_fd *iofd) |
| 887 | { |
Harald Welte | 1047ed7 | 2023-11-18 18:51:58 +0100 | [diff] [blame^] | 888 | OSMO_ASSERT(iofd->mode == OSMO_IO_FD_MODE_READ_WRITE || |
| 889 | iofd->mode == OSMO_IO_FD_MODE_RECVMSG_SENDMSG); |
Andreas Eversberg | 848faf9 | 2024-02-09 12:38:17 +0100 | [diff] [blame] | 890 | OSMO_ASSERT(osmo_iofd_ops.notify_connected); |
| 891 | osmo_iofd_ops.notify_connected(iofd); |
Daniel Willmann | e2a8dc4 | 2023-06-30 10:51:53 +0200 | [diff] [blame] | 892 | } |
| 893 | |
| 894 | |
Harald Welte | 8857f3b | 2022-11-18 13:54:44 +0100 | [diff] [blame] | 895 | #endif /* defined(__linux__) */ |