Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 1 | /* FSM to manage multiple connections of an MGW endpoint |
| 2 | * |
| 3 | * (C) 2018-2019 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de> |
| 4 | * All Rights Reserved |
| 5 | * |
| 6 | * Author: Neels Hofmeyr <neels@hofmeyr.de> |
| 7 | * |
| 8 | * This program is free software; you can redistribute it and/or modify |
| 9 | * it under the terms of the GNU Affero General Public License as published by |
| 10 | * the Free Software Foundation; either version 3 of the License, or |
| 11 | * (at your option) any later version. |
| 12 | * |
| 13 | * This program is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU Affero General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU Affero General Public License |
| 19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 20 | * |
| 21 | */ |
| 22 | |
| 23 | #include <sys/socket.h> |
| 24 | #include <netinet/in.h> |
| 25 | #include <arpa/inet.h> |
| 26 | |
| 27 | #include <osmocom/core/fsm.h> |
| 28 | #include <osmocom/core/byteswap.h> |
| 29 | #include <osmocom/core/tdef.h> |
Pau Espin Pedrol | 729bf3e | 2020-08-28 19:28:07 +0200 | [diff] [blame] | 30 | #include <osmocom/core/sockaddr_str.h> |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 31 | |
| 32 | #include <osmocom/mgcp_client/mgcp_client_endpoint_fsm.h> |
| 33 | |
| 34 | #define LOG_CI(ci, level, fmt, args...) do { \ |
| 35 | if (!ci || !ci->ep) \ |
Pau Espin Pedrol | 6a5e5ac | 2021-07-08 18:13:46 +0200 | [diff] [blame] | 36 | LOGP(DLMGCP, level, "(unknown MGW endpoint) " fmt, ## args); \ |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 37 | else \ |
| 38 | LOG_MGCPC_EP(ci->ep, level, "CI[%d] %s%s%s: " fmt, \ |
| 39 | (int)(ci - ci->ep->ci), \ |
| 40 | ci->label ? : "-", \ |
| 41 | ci->mgcp_ci_str[0] ? " CI=" : "", \ |
| 42 | ci->mgcp_ci_str[0] ? ci->mgcp_ci_str : "", \ |
| 43 | ## args); \ |
| 44 | } while(0) |
| 45 | |
| 46 | #define LOG_CI_VERB(ci, level, fmt, args...) do { \ |
| 47 | if (ci->verb_info.addr[0]) \ |
| 48 | LOG_CI(ci, level, "%s %s:%u: " fmt, \ |
| 49 | osmo_mgcp_verb_name(ci->verb), ci->verb_info.addr, ci->verb_info.port, \ |
| 50 | ## args); \ |
| 51 | else \ |
| 52 | LOG_CI(ci, level, "%s: " fmt, \ |
| 53 | osmo_mgcp_verb_name(ci->verb), \ |
| 54 | ## args); \ |
| 55 | } while(0) |
| 56 | |
| 57 | enum osmo_mgcpc_ep_fsm_state { |
| 58 | OSMO_MGCPC_EP_ST_UNUSED = 0, |
| 59 | OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE, |
| 60 | OSMO_MGCPC_EP_ST_IN_USE, |
| 61 | }; |
| 62 | |
| 63 | enum osmo_mgcpc_ep_fsm_event { |
| 64 | _OSMO_MGCPC_EP_EV_LAST = 0, |
| 65 | /* and MGW response events are allocated dynamically */ |
| 66 | }; |
| 67 | |
| 68 | #define FIRST_CI_EVENT (_OSMO_MGCPC_EP_EV_LAST + (_OSMO_MGCPC_EP_EV_LAST & 1)) /* rounded up to even nr */ |
| 69 | #define USABLE_CI ((32 - FIRST_CI_EVENT)/2) |
| 70 | #define EV_TO_CI_IDX(event) ((event - FIRST_CI_EVENT) / 2) |
| 71 | |
| 72 | #define CI_EV_SUCCESS(ci) (FIRST_CI_EVENT + (((ci) - ci->ep->ci) * 2)) |
| 73 | #define CI_EV_FAILURE(ci) (CI_EV_SUCCESS(ci) + 1) |
| 74 | |
| 75 | static struct osmo_fsm osmo_mgcpc_ep_fsm; |
| 76 | |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 77 | struct fsm_notify { |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 78 | struct llist_head entry; |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 79 | struct osmo_fsm_inst *fi; |
| 80 | uint32_t success; |
| 81 | uint32_t failure; |
| 82 | void *data; |
| 83 | }; |
| 84 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 85 | /*! One connection on an endpoint, corresponding to a connection identifier (CI) as returned by the MGW. |
| 86 | * An endpoint has a fixed number of slots of these, which may or may not be in use. |
| 87 | */ |
| 88 | struct osmo_mgcpc_ep_ci { |
| 89 | struct osmo_mgcpc_ep *ep; |
| 90 | |
| 91 | bool occupied; |
| 92 | char label[64]; |
| 93 | struct osmo_fsm_inst *mgcp_client_fi; |
| 94 | |
| 95 | bool pending; |
| 96 | bool sent; |
| 97 | enum mgcp_verb verb; |
| 98 | struct mgcp_conn_peer verb_info; |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 99 | struct fsm_notify notify; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 100 | |
| 101 | bool got_port_info; |
| 102 | struct mgcp_conn_peer rtp_info; |
| 103 | char mgcp_ci_str[MGCP_CONN_ID_LENGTH]; |
| 104 | }; |
| 105 | |
| 106 | /*! An MGW endpoint with N connections, like "rtpbridge/23@mgw". */ |
| 107 | struct osmo_mgcpc_ep { |
| 108 | /*! MGCP client connection to the MGW. */ |
| 109 | struct mgcp_client *mgcp_client; |
| 110 | struct osmo_fsm_inst *fi; |
| 111 | |
| 112 | /*! Endpoint string; at first this might be a wildcard, and upon the first CRCX OK response, this will reflect |
| 113 | * the endpoint name returned by the MGW. */ |
| 114 | char endpoint[MGCP_ENDPOINT_MAXLEN]; |
| 115 | |
| 116 | /*! Timeout definitions used for this endpoint, see osmo_mgcpc_ep_fsm_timeouts. */ |
| 117 | const struct osmo_tdef *T_defs; |
| 118 | |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 119 | /*! True as soon as the first CRCX OK is received. The endpoint name may be determined by the first CRCX |
| 120 | * response, so to dispatch any other messages, the FSM instance *must* wait for the first CRCX OK to arrive |
| 121 | * first. Once the endpoint name is pinpointed, any amount of operations may be dispatched concurrently. */ |
| 122 | bool first_crcx_complete; |
| 123 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 124 | /*! Endpoint connection slots. Note that each connection has its own set of FSM event numbers to signal success |
| 125 | * and failure, depending on its index within this array. See CI_EV_SUCCESS and CI_EV_FAILURE. */ |
| 126 | struct osmo_mgcpc_ep_ci ci[USABLE_CI]; |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 127 | |
| 128 | /*! Internal use: if a function keeps an fsm_notify for later dispatch while already clearing or re-using the |
| 129 | * ci[], the fsm_notify should be kept here to also get canceled by osmo_mgcpc_ep_cancel_notify(). */ |
| 130 | struct llist_head background_notify; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 131 | }; |
| 132 | |
| 133 | const struct value_string osmo_mgcp_verb_names[] = { |
| 134 | { MGCP_VERB_CRCX, "CRCX" }, |
| 135 | { MGCP_VERB_MDCX, "MDCX" }, |
| 136 | { MGCP_VERB_DLCX, "DLCX" }, |
| 137 | { MGCP_VERB_AUEP, "AUEP" }, |
| 138 | { MGCP_VERB_RSIP, "RSIP" }, |
| 139 | {} |
| 140 | }; |
| 141 | |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 142 | static void osmo_mgcpc_ep_count(struct osmo_mgcpc_ep *ep, int *occupied, int *pending_not_sent, |
| 143 | int *waiting_for_response); |
| 144 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 145 | static struct osmo_mgcpc_ep_ci *osmo_mgcpc_ep_check_ci(struct osmo_mgcpc_ep_ci *ci) |
| 146 | { |
| 147 | if (!ci) |
| 148 | return NULL; |
| 149 | if (!ci->ep) |
| 150 | return NULL; |
| 151 | if (ci < ci->ep->ci || ci >= &ci->ep->ci[USABLE_CI]) |
| 152 | return NULL; |
| 153 | return ci; |
| 154 | } |
| 155 | |
| 156 | static struct osmo_mgcpc_ep_ci *osmo_mgcpc_ep_ci_for_event(struct osmo_mgcpc_ep *ep, uint32_t event) |
| 157 | { |
| 158 | int idx; |
| 159 | if (event < FIRST_CI_EVENT) |
| 160 | return NULL; |
| 161 | idx = EV_TO_CI_IDX(event); |
| 162 | if (idx >= sizeof(ep->ci)) |
| 163 | return NULL; |
| 164 | return osmo_mgcpc_ep_check_ci(&ep->ci[idx]); |
| 165 | } |
| 166 | |
| 167 | const char *osmo_mgcpc_ep_name(const struct osmo_mgcpc_ep *ep) |
| 168 | { |
| 169 | if (!ep) |
| 170 | return "NULL"; |
| 171 | if (ep->endpoint[0]) |
| 172 | return ep->endpoint; |
| 173 | return osmo_fsm_inst_name(ep->fi); |
| 174 | } |
| 175 | |
| 176 | const char *mgcp_conn_peer_name(const struct mgcp_conn_peer *info) |
| 177 | { |
| 178 | /* I'd be fine with a smaller buffer and accept truncation, but gcc possibly refuses to build if |
| 179 | * this buffer is too small. */ |
| 180 | static char buf[1024]; |
| 181 | |
| 182 | if (!info) |
| 183 | return "NULL"; |
| 184 | |
| 185 | if (info->endpoint[0] |
| 186 | && info->addr[0]) |
| 187 | snprintf(buf, sizeof(buf), "%s:%s:%u", |
| 188 | info->endpoint, info->addr, info->port); |
| 189 | else if (info->endpoint[0]) |
| 190 | snprintf(buf, sizeof(buf), "%s", info->endpoint); |
| 191 | else if (info->addr[0]) |
| 192 | snprintf(buf, sizeof(buf), "%s:%u", info->addr, info->port); |
| 193 | else |
| 194 | return "empty"; |
| 195 | return buf; |
| 196 | } |
| 197 | |
| 198 | const char *osmo_mgcpc_ep_ci_name(const struct osmo_mgcpc_ep_ci *ci) |
| 199 | { |
| 200 | const struct mgcp_conn_peer *rtp_info; |
| 201 | |
| 202 | if (!ci) |
| 203 | return "NULL"; |
| 204 | |
| 205 | rtp_info = osmo_mgcpc_ep_ci_get_rtp_info(ci); |
| 206 | |
| 207 | if (rtp_info) |
| 208 | return mgcp_conn_peer_name(rtp_info); |
| 209 | return osmo_mgcpc_ep_name(ci->ep); |
| 210 | } |
| 211 | |
| 212 | const char *osmo_mgcpc_ep_ci_id(const struct osmo_mgcpc_ep_ci *ci) |
| 213 | { |
| 214 | if (!ci || !ci->mgcp_ci_str[0]) |
| 215 | return NULL; |
| 216 | return ci->mgcp_ci_str; |
| 217 | } |
| 218 | |
Philipp Maier | 3f4a4cb | 2021-07-26 13:20:05 +0200 | [diff] [blame] | 219 | struct mgcp_client *osmo_mgcpc_ep_client(const struct osmo_mgcpc_ep *ep) |
| 220 | { |
| 221 | if (!ep) |
| 222 | return NULL; |
| 223 | return ep->mgcp_client; |
| 224 | } |
| 225 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 226 | static struct value_string osmo_mgcpc_ep_fsm_event_names[33] = {}; |
| 227 | |
| 228 | static char osmo_mgcpc_ep_fsm_event_name_bufs[32][32] = {}; |
| 229 | |
| 230 | static void fill_event_names() |
| 231 | { |
| 232 | int i; |
| 233 | for (i = 0; i < (ARRAY_SIZE(osmo_mgcpc_ep_fsm_event_names) - 1); i++) { |
| 234 | if (i < _OSMO_MGCPC_EP_EV_LAST) |
| 235 | continue; |
| 236 | if (i < FIRST_CI_EVENT || EV_TO_CI_IDX(i) > USABLE_CI) { |
| 237 | osmo_mgcpc_ep_fsm_event_names[i] = (struct value_string){i, "Unused"}; |
| 238 | continue; |
| 239 | } |
| 240 | snprintf(osmo_mgcpc_ep_fsm_event_name_bufs[i], sizeof(osmo_mgcpc_ep_fsm_event_name_bufs[i]), |
| 241 | "MGW Response for CI #%d", EV_TO_CI_IDX(i)); |
| 242 | osmo_mgcpc_ep_fsm_event_names[i] = (struct value_string){i, osmo_mgcpc_ep_fsm_event_name_bufs[i]}; |
| 243 | } |
| 244 | } |
| 245 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 246 | static __attribute__((constructor)) void osmo_mgcpc_ep_fsm_init() |
| 247 | { |
| 248 | OSMO_ASSERT(osmo_fsm_register(&osmo_mgcpc_ep_fsm) == 0); |
| 249 | fill_event_names(); |
| 250 | } |
| 251 | |
| 252 | struct osmo_mgcpc_ep *osmo_mgcpc_ep_fi_mgwep(struct osmo_fsm_inst *fi) |
| 253 | { |
| 254 | OSMO_ASSERT(fi); |
| 255 | OSMO_ASSERT(fi->fsm == &osmo_mgcpc_ep_fsm); |
| 256 | OSMO_ASSERT(fi->priv); |
| 257 | return fi->priv; |
| 258 | } |
| 259 | |
| 260 | /*! Allocate an osmo_mgcpc_ep FSM. |
| 261 | * MGCP messages to set up the endpoint will be sent on the given mgcp_client, as soon as the first |
| 262 | * osmo_mgcpc_ep_ci_request() is invoked. |
| 263 | * |
Neels Hofmeyr | ca2aec0 | 2019-10-04 22:47:31 +0200 | [diff] [blame] | 264 | * IMPORTANT: To avoid use-after-free problems, using this FSM requires use of deferred FSM deallocation using |
| 265 | * osmo_fsm_set_dealloc_ctx(), e.g. using osmo_select_main_ctx(OTC_SELECT) with osmo_select_main_ctx() as main loop. |
| 266 | * |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 267 | * A typical sequence of events would be: |
| 268 | * |
| 269 | * ep = osmo_mgcpc_ep_alloc(..., mgcp_client_rtpbridge_wildcard(client)); |
| 270 | * ci_to_ran = osmo_mgcpc_ep_ci_add(ep); |
| 271 | * osmo_mgcpc_ep_ci_request(ci_to_ran, MGCP_VERB_CRCX, verb_info, |
| 272 | * my_call_fsm, MY_EVENT_MGCP_OK, MY_EVENT_MGCP_FAIL); |
| 273 | * ci_to_cn = osmo_mgcpc_ep_ci_add(ep); |
| 274 | * osmo_mgcpc_ep_ci_request(ci_to_cn, MGCP_VERB_CRCX, verb_info, |
| 275 | * my_call_fsm, MY_EVENT_MGCP_OK, MY_EVENT_MGCP_FAIL); |
| 276 | * ... |
| 277 | * osmo_mgcpc_ep_ci_request(ci_to_ran, MGCP_VERB_MDCX, ...); |
| 278 | * ... |
| 279 | * osmo_mgcpc_ep_clear(ep); |
| 280 | * ep = NULL; |
| 281 | * |
| 282 | * \param parent Parent FSM. |
| 283 | * \param parent_term_event Event to dispatch to the parent on termination of this FSM instance. |
| 284 | * \param mgcp_client Connection to the MGW. |
| 285 | * \param T_defs Timeout definitions to be used for FSM states, see osmo_mgcpc_ep_fsm_timeouts. |
| 286 | * \param fsm_id FSM instance ID. |
| 287 | * \param endpoint_str_fmt The endpoint string format to send to the MGW upon the first CRCX. |
| 288 | * See mgcp_client_rtpbridge_wildcard() for "rtpbridge" endpoints. |
| 289 | */ |
| 290 | struct osmo_mgcpc_ep *osmo_mgcpc_ep_alloc(struct osmo_fsm_inst *parent, uint32_t parent_term_event, |
| 291 | struct mgcp_client *mgcp_client, |
| 292 | const struct osmo_tdef *T_defs, |
| 293 | const char *fsm_id, |
| 294 | const char *endpoint_str_fmt, ...) |
| 295 | { |
| 296 | va_list ap; |
| 297 | struct osmo_fsm_inst *fi; |
| 298 | struct osmo_mgcpc_ep *ep; |
| 299 | int rc; |
| 300 | |
| 301 | if (!mgcp_client) |
| 302 | return NULL; |
| 303 | |
| 304 | fi = osmo_fsm_inst_alloc_child(&osmo_mgcpc_ep_fsm, parent, parent_term_event); |
| 305 | OSMO_ASSERT(fi); |
| 306 | |
| 307 | osmo_fsm_inst_update_id(fi, fsm_id); |
| 308 | |
| 309 | ep = talloc_zero(fi, struct osmo_mgcpc_ep); |
| 310 | OSMO_ASSERT(ep); |
| 311 | |
| 312 | *ep = (struct osmo_mgcpc_ep){ |
| 313 | .mgcp_client = mgcp_client, |
| 314 | .fi = fi, |
| 315 | .T_defs = T_defs, |
| 316 | }; |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 317 | INIT_LLIST_HEAD(&ep->background_notify); |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 318 | fi->priv = ep; |
| 319 | |
| 320 | va_start(ap, endpoint_str_fmt); |
| 321 | rc = vsnprintf(ep->endpoint, sizeof(ep->endpoint), endpoint_str_fmt ? : "", ap); |
| 322 | va_end(ap); |
| 323 | |
| 324 | if (rc <= 0 || rc >= sizeof(ep->endpoint)) { |
| 325 | LOG_MGCPC_EP(ep, LOGL_ERROR, "Endpoint name too long or too short: %s\n", |
| 326 | ep->endpoint); |
| 327 | osmo_fsm_inst_term(ep->fi, OSMO_FSM_TERM_ERROR, 0); |
| 328 | return NULL; |
| 329 | } |
| 330 | |
| 331 | return ep; |
| 332 | } |
| 333 | |
| 334 | /*! Add a connection to an endpoint. |
| 335 | * Allocate a connection identifier slot in the osmo_mgcpc_ep instance, do not yet dispatch a CRCX. |
| 336 | * The CRCX is dispatched only upon the first osmo_mgcpc_ep_ci_request(). |
| 337 | * \param ep Parent endpoint instance. |
| 338 | * \param label_fmt Label for logging. |
| 339 | */ |
| 340 | struct osmo_mgcpc_ep_ci *osmo_mgcpc_ep_ci_add(struct osmo_mgcpc_ep *ep, |
| 341 | const char *label_fmt, ...) |
| 342 | { |
| 343 | va_list ap; |
| 344 | int i; |
| 345 | struct osmo_mgcpc_ep_ci *ci; |
| 346 | |
| 347 | for (i = 0; i < USABLE_CI; i++) { |
| 348 | ci = &ep->ci[i]; |
| 349 | |
| 350 | if (ci->occupied || ci->mgcp_client_fi) |
| 351 | continue; |
| 352 | |
| 353 | *ci = (struct osmo_mgcpc_ep_ci){ |
| 354 | .ep = ep, |
| 355 | .occupied = true, |
| 356 | }; |
| 357 | if (label_fmt) { |
| 358 | va_start(ap, label_fmt); |
| 359 | vsnprintf(ci->label, sizeof(ci->label), label_fmt, ap); |
| 360 | va_end(ap); |
| 361 | } |
| 362 | return ci; |
| 363 | } |
| 364 | |
| 365 | LOG_MGCPC_EP(ep, LOGL_ERROR, |
| 366 | "Cannot allocate another endpoint, all " |
| 367 | OSMO_STRINGIFY_VAL(USABLE_CI) " are in use\n"); |
| 368 | |
| 369 | return NULL; |
| 370 | } |
| 371 | |
| 372 | static bool osmo_mgcpc_ep_fsm_check_state_chg_after_response(struct osmo_fsm_inst *fi); |
| 373 | |
| 374 | static void on_failure(struct osmo_mgcpc_ep_ci *ci) |
| 375 | { |
Neels Hofmeyr | cc0b97e | 2019-10-01 19:44:10 +0200 | [diff] [blame] | 376 | struct osmo_mgcpc_ep *ep = ci->ep; |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 377 | struct fsm_notify notify; |
Neels Hofmeyr | cc0b97e | 2019-10-01 19:44:10 +0200 | [diff] [blame] | 378 | int i; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 379 | |
| 380 | if (!ci->occupied) |
| 381 | return; |
| 382 | |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 383 | /* When dispatching an event for this CI, the user may decide to trigger the next request for this conn right |
| 384 | * away. So we must be ready with a cleared *ci. Store the notify separately and clear before dispatching. */ |
| 385 | notify = ci->notify; |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 386 | /* Register the planned notification in ep->background_notify so we also catch any osmo_mgcpc_ep_cancel_notify() |
| 387 | * that might be triggered between clearing the ci and actually dispatching the event. */ |
| 388 | llist_add(¬ify.entry, &ep->background_notify); |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 389 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 390 | *ci = (struct osmo_mgcpc_ep_ci){ |
| 391 | .ep = ci->ep, |
| 392 | }; |
| 393 | |
Neels Hofmeyr | cc0b97e | 2019-10-01 19:44:10 +0200 | [diff] [blame] | 394 | /* An MGCP failure typically means the endpoint becomes unusable, cancel all pending request (except DLCX). |
| 395 | * Particularly, if two CRCX were scheduled and the first fails, we must no longer dispatch the second CRCX. */ |
| 396 | for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { |
| 397 | struct osmo_mgcpc_ep_ci *other_ci = &ep->ci[i]; |
| 398 | if (other_ci == ci) |
| 399 | continue; |
| 400 | if (!other_ci->occupied) |
| 401 | continue; |
| 402 | if (!other_ci->pending) |
| 403 | continue; |
| 404 | if (other_ci->sent) |
| 405 | continue; |
| 406 | if (other_ci->verb == MGCP_VERB_DLCX) |
| 407 | continue; |
| 408 | /* Just clear the pending request, don't fire more events than below. */ |
| 409 | other_ci->pending = false; |
| 410 | } |
| 411 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 412 | /* If this check has terminated the FSM instance, don't fire any more events to prevent use-after-free problems. |
| 413 | * The endpoint FSM does dispatch a term event to its parent, and everything should be cleaned like that. */ |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 414 | if (!osmo_mgcpc_ep_fsm_check_state_chg_after_response(ep->fi)) { |
| 415 | /* The ep has deallocated, no need to llist_del(¬ify.entry) here. */ |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 416 | return; |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 417 | } |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 418 | |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 419 | if (notify.fi) |
| 420 | osmo_fsm_inst_dispatch(notify.fi, notify.failure, notify.data); |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 421 | |
| 422 | llist_del(¬ify.entry); |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 423 | } |
| 424 | |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 425 | static int update_endpoint_name(struct osmo_mgcpc_ep_ci *ci, const char *new_endpoint_name) |
| 426 | { |
| 427 | struct osmo_mgcpc_ep *ep = ci->ep; |
| 428 | int rc; |
| 429 | int i; |
| 430 | |
| 431 | if (!strcmp(ep->endpoint, new_endpoint_name)) { |
| 432 | /* Same endpoint name, nothing to do. */ |
| 433 | return 0; |
| 434 | } |
| 435 | |
| 436 | /* The endpoint name should only change on the very first CRCX response. */ |
| 437 | if (ep->first_crcx_complete) { |
| 438 | LOG_CI(ci, LOGL_ERROR, "Reponse returned mismatching endpoint name." |
| 439 | " This is endpoint %s, instead received %s\n", |
| 440 | ep->endpoint, new_endpoint_name); |
| 441 | on_failure(ci); |
| 442 | return -EINVAL; |
| 443 | } |
| 444 | |
| 445 | /* This is the first CRCX response, update endpoint name. */ |
| 446 | rc = OSMO_STRLCPY_ARRAY(ep->endpoint, new_endpoint_name); |
| 447 | if (rc <= 0 || rc >= sizeof(ep->endpoint)) { |
| 448 | LOG_CI(ci, LOGL_ERROR, "Unable to copy endpoint name %s\n", osmo_quote_str(new_endpoint_name, -1)); |
| 449 | osmo_mgcpc_ep_ci_dlcx(ci); |
| 450 | on_failure(ci); |
| 451 | return -ENOSPC; |
| 452 | } |
| 453 | |
| 454 | /* Make sure already pending requests use this updated endpoint name. */ |
| 455 | for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { |
| 456 | struct osmo_mgcpc_ep_ci *other_ci = &ep->ci[i]; |
| 457 | if (!other_ci->occupied) |
| 458 | continue; |
| 459 | if (!other_ci->pending) |
| 460 | continue; |
| 461 | if (other_ci->sent) |
| 462 | continue; |
| 463 | OSMO_STRLCPY_ARRAY(other_ci->verb_info.endpoint, ep->endpoint); |
| 464 | } |
| 465 | return 0; |
| 466 | } |
| 467 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 468 | static void on_success(struct osmo_mgcpc_ep_ci *ci, void *data) |
| 469 | { |
| 470 | struct mgcp_conn_peer *rtp_info; |
| 471 | |
| 472 | if (!ci->occupied) |
| 473 | return; |
| 474 | |
| 475 | ci->pending = false; |
| 476 | |
Pau Espin Pedrol | 2741d6b | 2020-09-02 19:31:17 +0200 | [diff] [blame] | 477 | rtp_info = data; |
| 478 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 479 | switch (ci->verb) { |
| 480 | case MGCP_VERB_CRCX: |
| 481 | /* If we sent a wildcarded endpoint name on CRCX, we need to store the resulting endpoint |
| 482 | * name here. Also, we receive the MGW's RTP port information. */ |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 483 | osmo_strlcpy(ci->mgcp_ci_str, mgcp_conn_get_ci(ci->mgcp_client_fi), |
| 484 | sizeof(ci->mgcp_ci_str)); |
| 485 | if (rtp_info->endpoint[0]) { |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 486 | /* On errors, this instance might already be deallocated. Make sure to not access anything after |
| 487 | * error. */ |
| 488 | if (update_endpoint_name(ci, rtp_info->endpoint)) |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 489 | return; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 490 | } |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 491 | ci->ep->first_crcx_complete = true; |
Pau Espin Pedrol | 2741d6b | 2020-09-02 19:31:17 +0200 | [diff] [blame] | 492 | OSMO_ASSERT(rtp_info); |
| 493 | /* fall through */ |
| 494 | case MGCP_VERB_MDCX: |
| 495 | /* Always update the received RTP ip/port information, since MGW |
| 496 | * may provide new one after remote end params changed */ |
| 497 | if (rtp_info) { |
| 498 | ci->got_port_info = true; |
| 499 | ci->rtp_info = *rtp_info; |
| 500 | } |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 501 | break; |
| 502 | |
| 503 | default: |
| 504 | break; |
| 505 | } |
| 506 | |
| 507 | LOG_CI(ci, LOGL_DEBUG, "received successful response to %s: RTP=%s%s\n", |
| 508 | osmo_mgcp_verb_name(ci->verb), |
| 509 | mgcp_conn_peer_name(ci->got_port_info? &ci->rtp_info : NULL), |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 510 | ci->notify.fi ? "" : " (not sending a notification)"); |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 511 | |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 512 | if (ci->notify.fi) |
| 513 | osmo_fsm_inst_dispatch(ci->notify.fi, ci->notify.success, ci->notify.data); |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 514 | |
| 515 | osmo_mgcpc_ep_fsm_check_state_chg_after_response(ci->ep->fi); |
| 516 | } |
| 517 | |
Neels Hofmeyr | 59e7cf4 | 2021-05-01 02:31:01 +0000 | [diff] [blame] | 518 | /*! Return the MGW's local RTP port information for this connection, i.e. the local port that MGW is receiving on, as |
| 519 | * returned by the last CRCX-OK / MDCX-OK message. */ |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 520 | const struct mgcp_conn_peer *osmo_mgcpc_ep_ci_get_rtp_info(const struct osmo_mgcpc_ep_ci *ci) |
| 521 | { |
| 522 | ci = osmo_mgcpc_ep_check_ci((struct osmo_mgcpc_ep_ci*)ci); |
| 523 | if (!ci) |
| 524 | return NULL; |
| 525 | if (!ci->got_port_info) |
| 526 | return NULL; |
| 527 | return &ci->rtp_info; |
| 528 | } |
| 529 | |
Neels Hofmeyr | 59e7cf4 | 2021-05-01 02:31:01 +0000 | [diff] [blame] | 530 | /*! Return the MGW's remote RTP port information for this connection, i.e. the remote RTP port that the MGW is sending |
| 531 | * to, as sent to the MGW by the last CRCX / MDCX message. */ |
| 532 | const struct mgcp_conn_peer *osmo_mgcpc_ep_ci_get_remote_rtp_info(const struct osmo_mgcpc_ep_ci *ci) |
| 533 | { |
| 534 | ci = osmo_mgcpc_ep_check_ci((struct osmo_mgcpc_ep_ci*)ci); |
| 535 | if (!ci) |
| 536 | return NULL; |
| 537 | return &ci->verb_info; |
| 538 | } |
| 539 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 540 | /*! Return the MGW's RTP port information for this connection, as returned by the last CRCX/MDCX OK message. */ |
| 541 | bool osmo_mgcpc_ep_ci_get_crcx_info_to_sockaddr(const struct osmo_mgcpc_ep_ci *ci, struct sockaddr_storage *dest) |
| 542 | { |
| 543 | const struct mgcp_conn_peer *rtp_info; |
Pau Espin Pedrol | 729bf3e | 2020-08-28 19:28:07 +0200 | [diff] [blame] | 544 | int family; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 545 | struct sockaddr_in *sin; |
Pau Espin Pedrol | 729bf3e | 2020-08-28 19:28:07 +0200 | [diff] [blame] | 546 | struct sockaddr_in6 *sin6; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 547 | |
| 548 | rtp_info = osmo_mgcpc_ep_ci_get_rtp_info(ci); |
| 549 | if (!rtp_info) |
| 550 | return false; |
| 551 | |
Pau Espin Pedrol | 729bf3e | 2020-08-28 19:28:07 +0200 | [diff] [blame] | 552 | family = osmo_ip_str_type(rtp_info->addr); |
| 553 | switch (family) { |
| 554 | case AF_INET: |
| 555 | sin = (struct sockaddr_in *)dest; |
| 556 | sin->sin_family = AF_INET; |
| 557 | sin->sin_port = osmo_ntohs(rtp_info->port); |
| 558 | if (inet_pton(AF_INET, rtp_info->addr, &sin->sin_addr) != 1) |
| 559 | return false; |
| 560 | break; |
| 561 | case AF_INET6: |
| 562 | sin6 = (struct sockaddr_in6 *)dest; |
| 563 | sin6->sin6_family = AF_INET6; |
| 564 | sin6->sin6_port = osmo_ntohs(rtp_info->port); |
| 565 | if (inet_pton(AF_INET6, rtp_info->addr, &sin6->sin6_addr) != 1) |
| 566 | return false; |
| 567 | break; |
| 568 | default: |
| 569 | return false; |
| 570 | } |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 571 | return true; |
| 572 | } |
| 573 | |
Pau Espin Pedrol | 30907dc | 2019-05-06 11:54:17 +0200 | [diff] [blame] | 574 | bool osmo_mgcpc_ep_ci_get_crcx_info_to_osmux_cid(const struct osmo_mgcpc_ep_ci *ci, uint8_t* cid) |
| 575 | { |
| 576 | const struct mgcp_conn_peer *rtp_info; |
| 577 | |
| 578 | rtp_info = osmo_mgcpc_ep_ci_get_rtp_info(ci); |
| 579 | if (!rtp_info) |
| 580 | return false; |
| 581 | |
| 582 | if (!rtp_info->x_osmo_osmux_use) |
| 583 | return false; |
| 584 | |
| 585 | *cid = rtp_info->x_osmo_osmux_cid; |
| 586 | return true; |
| 587 | } |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 588 | |
| 589 | static const struct osmo_tdef_state_timeout osmo_mgcpc_ep_fsm_timeouts[32] = { |
Neels Hofmeyr | fbf07f3 | 2020-09-15 23:59:23 +0200 | [diff] [blame] | 590 | [OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE] = { .T=-2427 }, |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 591 | }; |
| 592 | |
| 593 | /* Transition to a state, using the T timer defined in assignment_fsm_timeouts. |
| 594 | * The actual timeout value is in turn obtained from osmo_mgcpc_ep.T_defs. |
| 595 | * Assumes local variable fi exists. */ |
| 596 | #define osmo_mgcpc_ep_fsm_state_chg(state) \ |
| 597 | osmo_tdef_fsm_inst_state_chg(fi, state, osmo_mgcpc_ep_fsm_timeouts, \ |
| 598 | ((struct osmo_mgcpc_ep*)fi->priv)->T_defs, 5) |
| 599 | |
| 600 | /*! Dispatch an actual CRCX/MDCX/DLCX message for this connection. |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 601 | * |
| 602 | * If the 'notify' instance deallocates before it received a notification of event_success or event_failure, |
| 603 | * osmo_mgcpc_ep_ci_cancel_notify() or osmo_mgcpc_ep_cancel_notify() must be called. It is not harmful to cancel |
| 604 | * notification after an event has been received. |
| 605 | * |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 606 | * \param ci Connection identifier as obtained from osmo_mgcpc_ep_ci_add(). |
| 607 | * \param verb MGCP operation to dispatch. |
| 608 | * \param verb_info Parameters for the MGCP operation. |
| 609 | * \param notify Peer FSM instance to notify of completed/failed operation. |
| 610 | * \param event_success Which event to dispatch to 'notify' upon OK response. |
| 611 | * \param event_failure Which event to dispatch to 'notify' upon failure response. |
| 612 | * \param notify_data Data pointer to pass to the event dispatch for both success and failure. |
| 613 | */ |
| 614 | void osmo_mgcpc_ep_ci_request(struct osmo_mgcpc_ep_ci *ci, |
| 615 | enum mgcp_verb verb, const struct mgcp_conn_peer *verb_info, |
| 616 | struct osmo_fsm_inst *notify, |
| 617 | uint32_t event_success, uint32_t event_failure, |
| 618 | void *notify_data) |
| 619 | { |
| 620 | struct osmo_mgcpc_ep *ep; |
| 621 | struct osmo_fsm_inst *fi; |
| 622 | struct osmo_mgcpc_ep_ci cleared_ci; |
| 623 | ci = osmo_mgcpc_ep_check_ci(ci); |
| 624 | |
| 625 | if (!ci) { |
Pau Espin Pedrol | 6a5e5ac | 2021-07-08 18:13:46 +0200 | [diff] [blame] | 626 | LOGP(DLMGCP, LOGL_ERROR, "Invalid MGW endpoint request: no ci\n"); |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 627 | goto dispatch_error; |
| 628 | } |
| 629 | if (!verb_info && verb != MGCP_VERB_DLCX) { |
| 630 | LOG_CI(ci, LOGL_ERROR, "Invalid MGW endpoint request: missing verb details for %s\n", |
| 631 | osmo_mgcp_verb_name(verb)); |
| 632 | goto dispatch_error; |
| 633 | } |
| 634 | if ((verb < 0) || (verb > MGCP_VERB_RSIP)) { |
| 635 | LOG_CI(ci, LOGL_ERROR, "Invalid MGW endpoint request: unknown verb: %s\n", |
| 636 | osmo_mgcp_verb_name(verb)); |
| 637 | goto dispatch_error; |
| 638 | } |
| 639 | |
| 640 | ep = ci->ep; |
| 641 | fi = ep->fi; |
| 642 | |
| 643 | /* Clear volatile state by explicitly keeping those that should remain. Because we can't assign |
| 644 | * the char[] directly, dance through cleared_ci and copy back. */ |
| 645 | cleared_ci = (struct osmo_mgcpc_ep_ci){ |
| 646 | .ep = ep, |
| 647 | .mgcp_client_fi = ci->mgcp_client_fi, |
| 648 | .got_port_info = ci->got_port_info, |
| 649 | .rtp_info = ci->rtp_info, |
| 650 | |
| 651 | .occupied = true, |
| 652 | /* .pending = true follows below */ |
| 653 | .verb = verb, |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 654 | .notify = { |
| 655 | .fi = notify, |
| 656 | .success = event_success, |
| 657 | .failure = event_failure, |
| 658 | .data = notify_data, |
| 659 | } |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 660 | }; |
| 661 | osmo_strlcpy(cleared_ci.label, ci->label, sizeof(cleared_ci.label)); |
| 662 | osmo_strlcpy(cleared_ci.mgcp_ci_str, ci->mgcp_ci_str, sizeof(cleared_ci.mgcp_ci_str)); |
| 663 | *ci = cleared_ci; |
| 664 | |
Neels Hofmeyr | 3ff7128 | 2019-10-29 17:41:20 +0100 | [diff] [blame] | 665 | LOG_CI_VERB(ci, LOGL_DEBUG, "notify=%s\n", osmo_fsm_inst_name(ci->notify.fi)); |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 666 | |
| 667 | if (verb_info) |
| 668 | ci->verb_info = *verb_info; |
| 669 | |
| 670 | if (ep->endpoint[0]) { |
| 671 | if (ci->verb_info.endpoint[0] && strcmp(ci->verb_info.endpoint, ep->endpoint)) |
| 672 | LOG_CI(ci, LOGL_ERROR, |
| 673 | "Warning: Requested %s on endpoint %s, but this CI is on endpoint %s." |
| 674 | " Using the proper endpoint instead.\n", |
| 675 | osmo_mgcp_verb_name(verb), ci->verb_info.endpoint, ep->endpoint); |
| 676 | osmo_strlcpy(ci->verb_info.endpoint, ep->endpoint, sizeof(ci->verb_info.endpoint)); |
| 677 | } |
| 678 | |
| 679 | switch (ci->verb) { |
| 680 | case MGCP_VERB_CRCX: |
| 681 | if (ci->mgcp_client_fi) { |
| 682 | LOG_CI(ci, LOGL_ERROR, "CRCX can be called only once per MGW endpoint CI\n"); |
| 683 | on_failure(ci); |
| 684 | return; |
| 685 | } |
| 686 | break; |
| 687 | |
| 688 | case MGCP_VERB_MDCX: |
| 689 | if (!ci->mgcp_client_fi) { |
| 690 | LOG_CI_VERB(ci, LOGL_ERROR, "The first verb on an unused MGW endpoint CI must be CRCX, not %s\n", |
| 691 | osmo_mgcp_verb_name(ci->verb)); |
| 692 | on_failure(ci); |
| 693 | return; |
| 694 | } |
| 695 | break; |
| 696 | |
| 697 | case MGCP_VERB_DLCX: |
| 698 | if (!ci->mgcp_client_fi) { |
| 699 | LOG_CI_VERB(ci, LOGL_DEBUG, "Ignoring DLCX on unused MGW endpoint CI\n"); |
| 700 | return; |
| 701 | } |
| 702 | break; |
| 703 | |
| 704 | default: |
| 705 | LOG_CI(ci, LOGL_ERROR, "This verb is not supported: %s\n", osmo_mgcp_verb_name(ci->verb)); |
| 706 | on_failure(ci); |
| 707 | return; |
| 708 | } |
| 709 | |
| 710 | ci->pending = true; |
| 711 | |
| 712 | LOG_CI_VERB(ci, LOGL_DEBUG, "Scheduling\n"); |
| 713 | |
| 714 | if (ep->fi->state != OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE) |
| 715 | osmo_mgcpc_ep_fsm_state_chg(OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE); |
| 716 | |
| 717 | return; |
| 718 | dispatch_error: |
| 719 | if (notify) |
| 720 | osmo_fsm_inst_dispatch(notify, event_failure, notify_data); |
| 721 | } |
| 722 | |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 723 | /*! No longer notify for any state changes for any conns of this endpoint. |
| 724 | * Useful if the notify instance passed to osmo_mgcpc_ep_ci_request() is about to deallocate. |
| 725 | * \param ep The endpoint FSM instance. |
| 726 | * \param notify Which target to cancel notification for, if NULL cancel all notifications. */ |
| 727 | void osmo_mgcpc_ep_cancel_notify(struct osmo_mgcpc_ep *ep, struct osmo_fsm_inst *notify) |
| 728 | { |
| 729 | struct fsm_notify *n; |
| 730 | int i; |
| 731 | for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { |
| 732 | struct osmo_mgcpc_ep_ci *ci = &ep->ci[i]; |
| 733 | if (!notify || ci->notify.fi == notify) |
| 734 | ci->notify.fi = NULL; |
| 735 | } |
| 736 | llist_for_each_entry(n, &ep->background_notify, entry) { |
| 737 | if (!notify || n->fi == notify) |
| 738 | n->fi = NULL; |
| 739 | } |
| 740 | |
| 741 | } |
| 742 | |
Neels Hofmeyr | 923d60b | 2019-10-29 17:40:08 +0100 | [diff] [blame] | 743 | /* Return the osmo_mgcpc_ep that this conn belongs to. */ |
| 744 | struct osmo_mgcpc_ep *osmo_mgcpc_ep_ci_ep(struct osmo_mgcpc_ep_ci *conn) |
| 745 | { |
| 746 | if (!conn) |
| 747 | return NULL; |
| 748 | return conn->ep; |
| 749 | } |
| 750 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 751 | static int send_verb(struct osmo_mgcpc_ep_ci *ci) |
| 752 | { |
| 753 | int rc; |
| 754 | struct osmo_mgcpc_ep *ep = ci->ep; |
Neels Hofmeyr | 055ded7 | 2019-10-29 17:46:30 +0100 | [diff] [blame] | 755 | struct fsm_notify notify; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 756 | |
| 757 | if (!ci->occupied || !ci->pending || ci->sent) |
| 758 | return 0; |
| 759 | |
| 760 | switch (ci->verb) { |
| 761 | |
| 762 | case MGCP_VERB_CRCX: |
| 763 | OSMO_ASSERT(!ci->mgcp_client_fi); |
| 764 | LOG_CI_VERB(ci, LOGL_DEBUG, "Sending\n"); |
| 765 | ci->mgcp_client_fi = mgcp_conn_create(ep->mgcp_client, ep->fi, |
| 766 | CI_EV_FAILURE(ci), CI_EV_SUCCESS(ci), |
| 767 | &ci->verb_info); |
| 768 | ci->sent = true; |
| 769 | if (!ci->mgcp_client_fi){ |
| 770 | LOG_CI_VERB(ci, LOGL_ERROR, "Cannot send\n"); |
| 771 | on_failure(ci); |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 772 | return -EINVAL; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 773 | } |
| 774 | osmo_fsm_inst_update_id(ci->mgcp_client_fi, ci->label); |
| 775 | break; |
| 776 | |
| 777 | case MGCP_VERB_MDCX: |
| 778 | OSMO_ASSERT(ci->mgcp_client_fi); |
| 779 | LOG_CI_VERB(ci, LOGL_DEBUG, "Sending\n"); |
| 780 | rc = mgcp_conn_modify(ci->mgcp_client_fi, CI_EV_SUCCESS(ci), &ci->verb_info); |
| 781 | ci->sent = true; |
| 782 | if (rc) { |
| 783 | LOG_CI_VERB(ci, LOGL_ERROR, "Cannot send (rc=%d %s)\n", rc, strerror(-rc)); |
| 784 | on_failure(ci); |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 785 | return -EINVAL; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 786 | } |
| 787 | break; |
| 788 | |
| 789 | case MGCP_VERB_DLCX: |
| 790 | LOG_CI(ci, LOGL_DEBUG, "Sending MGCP: %s %s\n", |
| 791 | osmo_mgcp_verb_name(ci->verb), ci->mgcp_ci_str); |
| 792 | /* The way this is designed, we actually need to forget all about the ci right away. */ |
| 793 | mgcp_conn_delete(ci->mgcp_client_fi); |
Neels Hofmeyr | 055ded7 | 2019-10-29 17:46:30 +0100 | [diff] [blame] | 794 | notify = ci->notify; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 795 | *ci = (struct osmo_mgcpc_ep_ci){ |
| 796 | .ep = ep, |
| 797 | }; |
Neels Hofmeyr | 055ded7 | 2019-10-29 17:46:30 +0100 | [diff] [blame] | 798 | /* When dispatching an event for this CI, the user may decide to trigger the next request for this conn |
| 799 | * right away. So we must be ready with a cleared *ci. */ |
| 800 | if (notify.fi) |
| 801 | osmo_fsm_inst_dispatch(notify.fi, notify.success, notify.data); |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 802 | break; |
| 803 | |
| 804 | default: |
| 805 | OSMO_ASSERT(false); |
| 806 | } |
| 807 | |
| 808 | return 1; |
| 809 | } |
| 810 | |
| 811 | /*! DLCX all connections, terminate the endpoint FSM and free. */ |
| 812 | void osmo_mgcpc_ep_clear(struct osmo_mgcpc_ep *ep) |
| 813 | { |
| 814 | if (!ep) |
| 815 | return; |
Neels Hofmeyr | f2bf8dc | 2019-10-29 17:39:56 +0100 | [diff] [blame] | 816 | osmo_mgcpc_ep_cancel_notify(ep, NULL); |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 817 | osmo_fsm_inst_term(ep->fi, OSMO_FSM_TERM_REGULAR, 0); |
| 818 | } |
| 819 | |
| 820 | static void osmo_mgcpc_ep_count(struct osmo_mgcpc_ep *ep, int *occupied, int *pending_not_sent, |
| 821 | int *waiting_for_response) |
| 822 | { |
| 823 | int i; |
| 824 | |
| 825 | if (occupied) |
| 826 | *occupied = 0; |
| 827 | |
| 828 | if (pending_not_sent) |
| 829 | *pending_not_sent = 0; |
| 830 | |
| 831 | if (waiting_for_response) |
| 832 | *waiting_for_response = 0; |
| 833 | |
| 834 | for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { |
| 835 | struct osmo_mgcpc_ep_ci *ci = &ep->ci[i]; |
| 836 | if (ci->occupied) { |
| 837 | if (occupied) |
| 838 | (*occupied)++; |
| 839 | } else |
| 840 | continue; |
| 841 | |
| 842 | if (ci->pending) |
| 843 | LOG_CI_VERB(ci, LOGL_DEBUG, "%s\n", |
| 844 | ci->sent ? "waiting for response" : "waiting to be sent"); |
| 845 | else |
| 846 | LOG_CI_VERB(ci, LOGL_DEBUG, "done (%s)\n", mgcp_conn_peer_name(osmo_mgcpc_ep_ci_get_rtp_info(ci))); |
| 847 | |
| 848 | if (ci->pending && ci->sent) |
| 849 | if (waiting_for_response) |
| 850 | (*waiting_for_response)++; |
| 851 | if (ci->pending && !ci->sent) |
| 852 | if (pending_not_sent) |
| 853 | (*pending_not_sent)++; |
| 854 | } |
| 855 | } |
| 856 | |
| 857 | static bool osmo_mgcpc_ep_fsm_check_state_chg_after_response(struct osmo_fsm_inst *fi) |
| 858 | { |
| 859 | int waiting_for_response; |
| 860 | int occupied; |
| 861 | struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); |
| 862 | |
| 863 | osmo_mgcpc_ep_count(ep, &occupied, NULL, &waiting_for_response); |
| 864 | LOG_MGCPC_EP(ep, LOGL_DEBUG, "CI in use: %d, waiting for response: %d\n", occupied, waiting_for_response); |
| 865 | |
| 866 | if (!occupied) { |
| 867 | /* All CI have been released. The endpoint no longer exists. Notify the parent FSM, by |
| 868 | * terminating. */ |
| 869 | osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, 0); |
| 870 | return false; |
| 871 | } |
| 872 | |
| 873 | if (!waiting_for_response) { |
| 874 | if (fi->state != OSMO_MGCPC_EP_ST_IN_USE) |
| 875 | osmo_mgcpc_ep_fsm_state_chg(OSMO_MGCPC_EP_ST_IN_USE); |
| 876 | } |
| 877 | |
| 878 | return true; |
| 879 | } |
| 880 | |
| 881 | static void osmo_mgcpc_ep_fsm_wait_mgw_response_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) |
| 882 | { |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 883 | static int re_enter = 0; |
| 884 | int rc; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 885 | int count = 0; |
| 886 | int i; |
| 887 | struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); |
| 888 | |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 889 | re_enter++; |
| 890 | OSMO_ASSERT(re_enter < 10); |
| 891 | |
| 892 | /* The first CRCX gives us the endpoint name in the CRCX response. So we must wait for the first CRCX endpoint |
| 893 | * response to come in before sending any other MGCP requests -- otherwise we might end up creating new |
| 894 | * endpoints instead of acting on the same. This FSM always sends out N requests and waits for all of them to |
| 895 | * complete before sending out new requests. Hence we're safe when the very first time at most one request is |
| 896 | * sent (which needs to be a CRCX). */ |
| 897 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 898 | for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 899 | struct osmo_mgcpc_ep_ci *ci = &ep->ci[i]; |
| 900 | |
| 901 | /* Make sure that only CRCX get dispatched if no CRCX were sent yet. */ |
| 902 | if (!ep->first_crcx_complete) { |
| 903 | if (ci->occupied && ci->verb != MGCP_VERB_CRCX) |
| 904 | continue; |
| 905 | } |
| 906 | |
| 907 | rc = send_verb(&ep->ci[i]); |
| 908 | /* Need to be careful not to access the instance after failure. Event chains may already have |
| 909 | * deallocated this memory. */ |
| 910 | if (rc < 0) |
| 911 | return; |
| 912 | if (!rc) |
| 913 | continue; |
| 914 | count++; |
| 915 | /* Make sure that we wait for the first CRCX response before dispatching more requests. */ |
| 916 | if (!ep->first_crcx_complete) |
| 917 | break; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 918 | } |
| 919 | |
| 920 | LOG_MGCPC_EP(ep, LOGL_DEBUG, "Sent messages: %d\n", count); |
Neels Hofmeyr | c5479fe | 2019-04-05 01:36:06 +0200 | [diff] [blame] | 921 | if (ep->first_crcx_complete) |
| 922 | osmo_mgcpc_ep_fsm_check_state_chg_after_response(fi); |
| 923 | re_enter--; |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 924 | } |
| 925 | |
| 926 | static void osmo_mgcpc_ep_fsm_handle_ci_events(struct osmo_fsm_inst *fi, uint32_t event, void *data) |
| 927 | { |
| 928 | struct osmo_mgcpc_ep_ci *ci; |
| 929 | struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); |
| 930 | ci = osmo_mgcpc_ep_ci_for_event(ep, event); |
| 931 | if (ci) { |
| 932 | if (event == CI_EV_SUCCESS(ci)) |
| 933 | on_success(ci, data); |
| 934 | else |
| 935 | on_failure(ci); |
| 936 | } |
| 937 | } |
| 938 | |
| 939 | static void osmo_mgcpc_ep_fsm_in_use_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) |
| 940 | { |
| 941 | int pending_not_sent; |
| 942 | struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); |
| 943 | |
| 944 | osmo_mgcpc_ep_count(ep, NULL, &pending_not_sent, NULL); |
| 945 | if (pending_not_sent) |
| 946 | osmo_mgcpc_ep_fsm_state_chg(OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE); |
| 947 | } |
| 948 | |
| 949 | #define S(x) (1 << (x)) |
| 950 | |
| 951 | static const struct osmo_fsm_state osmo_mgcpc_ep_fsm_states[] = { |
| 952 | [OSMO_MGCPC_EP_ST_UNUSED] = { |
| 953 | .name = "UNUSED", |
| 954 | .in_event_mask = 0, |
| 955 | .out_state_mask = 0 |
| 956 | | S(OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE) |
| 957 | , |
| 958 | }, |
| 959 | [OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE] = { |
| 960 | .name = "WAIT_MGW_RESPONSE", |
| 961 | .onenter = osmo_mgcpc_ep_fsm_wait_mgw_response_onenter, |
| 962 | .action = osmo_mgcpc_ep_fsm_handle_ci_events, |
| 963 | .in_event_mask = 0xffffffff, |
| 964 | .out_state_mask = 0 |
| 965 | | S(OSMO_MGCPC_EP_ST_IN_USE) |
| 966 | , |
| 967 | }, |
| 968 | [OSMO_MGCPC_EP_ST_IN_USE] = { |
| 969 | .name = "IN_USE", |
| 970 | .onenter = osmo_mgcpc_ep_fsm_in_use_onenter, |
| 971 | .action = osmo_mgcpc_ep_fsm_handle_ci_events, |
| 972 | .in_event_mask = 0xffffffff, /* mgcp_client_fsm may send parent term anytime */ |
| 973 | .out_state_mask = 0 |
| 974 | | S(OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE) |
| 975 | , |
| 976 | }, |
| 977 | }; |
| 978 | |
| 979 | static int osmo_mgcpc_ep_fsm_timer_cb(struct osmo_fsm_inst *fi) |
| 980 | { |
| 981 | int i; |
| 982 | struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); |
| 983 | |
| 984 | switch (fi->T) { |
| 985 | default: |
| 986 | for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { |
| 987 | struct osmo_mgcpc_ep_ci *ci = &ep->ci[i]; |
| 988 | if (!ci->occupied) |
| 989 | continue; |
| 990 | if (!(ci->pending && ci->sent)) |
| 991 | continue; |
| 992 | on_failure(ci); |
| 993 | } |
| 994 | return 0; |
| 995 | } |
| 996 | |
| 997 | return 0; |
| 998 | } |
| 999 | |
Neels Hofmeyr | 03fcc91 | 2021-07-15 02:09:42 +0200 | [diff] [blame] | 1000 | void osmo_mgcpc_ep_fsm_pre_term(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause) |
| 1001 | { |
| 1002 | int i; |
| 1003 | struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); |
| 1004 | |
| 1005 | /* We want the mgcp_client_fsm to still stick around until it received the DLCX "OK" responses from the MGW. So |
| 1006 | * it should not dealloc along with this ep_fsm instance. Instead, signal DLCX for each conn on the endpoint, |
| 1007 | * and detach the mgcp_client_fsm from being a child-fsm. |
| 1008 | * |
| 1009 | * After mgcp_conn_delete(), an mgcp_client_fsm instance goes into ST_DLCX_RESP, which waits up to 4 seconds for |
| 1010 | * a DLCX OK. If none is received in that time, the instance terminates. So cleanup of the instance is |
| 1011 | * guaranteed. */ |
| 1012 | |
| 1013 | for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { |
| 1014 | struct osmo_mgcpc_ep_ci *ci = &ep->ci[i]; |
| 1015 | |
| 1016 | if (!ci->occupied || !ci->mgcp_client_fi) |
| 1017 | continue; |
| 1018 | |
| 1019 | /* mgcp_conn_delete() unlinks itself from this parent FSM implicitly and waits for the DLCX OK. */ |
| 1020 | mgcp_conn_delete(ci->mgcp_client_fi); |
| 1021 | /* Forget all about this ci */ |
| 1022 | *ci = (struct osmo_mgcpc_ep_ci){ |
| 1023 | .ep = ep, |
| 1024 | }; |
| 1025 | } |
| 1026 | } |
| 1027 | |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 1028 | static struct osmo_fsm osmo_mgcpc_ep_fsm = { |
Pau Espin Pedrol | 182ca3b | 2019-05-08 14:01:20 +0200 | [diff] [blame] | 1029 | .name = "mgw-endp", |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 1030 | .states = osmo_mgcpc_ep_fsm_states, |
| 1031 | .num_states = ARRAY_SIZE(osmo_mgcpc_ep_fsm_states), |
| 1032 | .log_subsys = DLMGCP, |
| 1033 | .event_names = osmo_mgcpc_ep_fsm_event_names, |
| 1034 | .timer_cb = osmo_mgcpc_ep_fsm_timer_cb, |
Neels Hofmeyr | 03fcc91 | 2021-07-15 02:09:42 +0200 | [diff] [blame] | 1035 | .pre_term = osmo_mgcpc_ep_fsm_pre_term, |
Neels Hofmeyr | 538d2c5 | 2019-01-28 03:51:35 +0100 | [diff] [blame] | 1036 | }; |