From 538d2c53d90074267e7a70a90c773baa03d6ec04 Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Mon, 28 Jan 2019 03:51:35 +0100 Subject: [PATCH] move MGW endpoint FSM from osmo-bsc to here Move mgw_endpoint_fsm from osmo-bsc here as osmo_mgcpc_ep_fsm. Apply various renames for consistency. Use osmo_tdef from libosmocore instead of osmo-bsc's (so far) local T_defs API. Change T23042 to T2427001, which is a slightly less arbitrary number and slightly more extendable in the future (2427 corresponds to the default MGCP port at osmo-mgw, 001 is the first MGCP timer and so far the only one). Change-Id: I9a3effd38e72841529df6c135c077116981dea36 --- include/Makefile.am | 1 + .../mgcp_client/mgcp_client_endpoint_fsm.h | 47 ++ include/osmocom/mgcp_client/mgcp_client_fsm.h | 2 + src/libosmo-mgcp-client/Makefile.am | 1 + .../mgcp_client_endpoint_fsm.c | 793 ++++++++++++++++++ src/libosmo-mgcp-client/mgcp_client_fsm.c | 22 + 6 files changed, 866 insertions(+) create mode 100644 include/osmocom/mgcp_client/mgcp_client_endpoint_fsm.h create mode 100644 src/libosmo-mgcp-client/mgcp_client_endpoint_fsm.c diff --git a/include/Makefile.am b/include/Makefile.am index c34553ac1..2daaf2087 100644 --- a/include/Makefile.am +++ b/include/Makefile.am @@ -4,6 +4,7 @@ SUBDIRS = \ nobase_include_HEADERS = \ osmocom/mgcp_client/mgcp_client.h \ + osmocom/mgcp_client/mgcp_client_endpoint_fsm.h \ osmocom/mgcp_client/mgcp_client_fsm.h \ osmocom/mgcp_client/mgcp_common.h \ osmocom/mgcp/mgcp.h \ diff --git a/include/osmocom/mgcp_client/mgcp_client_endpoint_fsm.h b/include/osmocom/mgcp_client/mgcp_client_endpoint_fsm.h new file mode 100644 index 000000000..73de29292 --- /dev/null +++ b/include/osmocom/mgcp_client/mgcp_client_endpoint_fsm.h @@ -0,0 +1,47 @@ +/* FSM to manage multiple connections of an MGW endpoint */ +#pragma once + +#include + +#define LOG_MGCPC_EP(ep, level, fmt, args...) do { \ + LOGPFSML(ep->fi, level, "%s " fmt, \ + osmo_mgcpc_ep_name(ep), ## args); \ + } while(0) + +struct osmo_mgcpc_ep; +struct osmo_mgcpc_ep_ci; +struct osmo_tdef; + +struct osmo_mgcpc_ep *osmo_mgcpc_ep_alloc(struct osmo_fsm_inst *parent, uint32_t parent_term_event, + struct mgcp_client *mgcp_client, + const struct osmo_tdef *T_defs, + const char *fsm_id, + const char *endpoint_str_fmt, ...); + +struct osmo_mgcpc_ep_ci *osmo_mgcpc_ep_ci_add(struct osmo_mgcpc_ep *ep, const char *label_fmt, ...); +const struct mgcp_conn_peer *osmo_mgcpc_ep_ci_get_rtp_info(const struct osmo_mgcpc_ep_ci *ci); +bool osmo_mgcpc_ep_ci_get_crcx_info_to_sockaddr(const struct osmo_mgcpc_ep_ci *ci, struct sockaddr_storage *dest); + +void osmo_mgcpc_ep_ci_request(struct osmo_mgcpc_ep_ci *ci, + enum mgcp_verb verb, const struct mgcp_conn_peer *verb_info, + struct osmo_fsm_inst *notify, + uint32_t event_success, uint32_t event_failure, + void *notify_data); + +/*! Dispatch a DLCX for the given connection. + * \param ci Connection identifier as obtained from osmo_mgcpc_ep_ci_add(). + */ +static inline void osmo_mgcpc_ep_ci_dlcx(struct osmo_mgcpc_ep_ci *ci) +{ + osmo_mgcpc_ep_ci_request(ci, MGCP_VERB_DLCX, NULL, NULL, 0, 0, NULL); +} + +void osmo_mgcpc_ep_clear(struct osmo_mgcpc_ep *ep); + +const char *osmo_mgcpc_ep_name(const struct osmo_mgcpc_ep *ep); +const char *osmo_mgcpc_ep_ci_name(const struct osmo_mgcpc_ep_ci *ci); +const char *osmo_mgcpc_ep_ci_id(const struct osmo_mgcpc_ep_ci *ci); + +extern const struct value_string osmo_mgcp_verb_names[]; +static inline const char *osmo_mgcp_verb_name(enum mgcp_verb val) +{ return get_value_string(osmo_mgcp_verb_names, val); } diff --git a/include/osmocom/mgcp_client/mgcp_client_fsm.h b/include/osmocom/mgcp_client/mgcp_client_fsm.h index dabfccac8..e170a255f 100644 --- a/include/osmocom/mgcp_client/mgcp_client_fsm.h +++ b/include/osmocom/mgcp_client/mgcp_client_fsm.h @@ -64,3 +64,5 @@ int mgcp_conn_modify(struct osmo_fsm_inst *fi, uint32_t parent_evt, struct mgcp_ void mgcp_conn_delete(struct osmo_fsm_inst *fi); const char *mgcp_conn_get_ci(struct osmo_fsm_inst *fi); + +const char *osmo_mgcpc_conn_peer_name(const struct mgcp_conn_peer *info); diff --git a/src/libosmo-mgcp-client/Makefile.am b/src/libosmo-mgcp-client/Makefile.am index e59da2ff3..15298535f 100644 --- a/src/libosmo-mgcp-client/Makefile.am +++ b/src/libosmo-mgcp-client/Makefile.am @@ -30,6 +30,7 @@ libosmo_mgcp_client_la_SOURCES = \ mgcp_client.c \ mgcp_client_vty.c \ mgcp_client_fsm.c \ + mgcp_client_endpoint_fsm.c \ $(NULL) libosmo_mgcp_client_la_LDFLAGS = $(AM_LDFLAGS) -version-info $(MGCP_CLIENT_LIBVERSION) diff --git a/src/libosmo-mgcp-client/mgcp_client_endpoint_fsm.c b/src/libosmo-mgcp-client/mgcp_client_endpoint_fsm.c new file mode 100644 index 000000000..76552fbb8 --- /dev/null +++ b/src/libosmo-mgcp-client/mgcp_client_endpoint_fsm.c @@ -0,0 +1,793 @@ +/* FSM to manage multiple connections of an MGW endpoint + * + * (C) 2018-2019 by sysmocom - s.f.m.c. GmbH + * All Rights Reserved + * + * Author: Neels Hofmeyr + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see . + * + */ + +#include +#include +#include + +#include +#include +#include + +#include + +#define LOG_CI(ci, level, fmt, args...) do { \ + if (!ci || !ci->ep) \ + LOGP(DLGLOBAL, level, "(unknown MGW endpoint) " fmt, ## args); \ + else \ + LOG_MGCPC_EP(ci->ep, level, "CI[%d] %s%s%s: " fmt, \ + (int)(ci - ci->ep->ci), \ + ci->label ? : "-", \ + ci->mgcp_ci_str[0] ? " CI=" : "", \ + ci->mgcp_ci_str[0] ? ci->mgcp_ci_str : "", \ + ## args); \ + } while(0) + +#define LOG_CI_VERB(ci, level, fmt, args...) do { \ + if (ci->verb_info.addr[0]) \ + LOG_CI(ci, level, "%s %s:%u: " fmt, \ + osmo_mgcp_verb_name(ci->verb), ci->verb_info.addr, ci->verb_info.port, \ + ## args); \ + else \ + LOG_CI(ci, level, "%s: " fmt, \ + osmo_mgcp_verb_name(ci->verb), \ + ## args); \ + } while(0) + +enum osmo_mgcpc_ep_fsm_state { + OSMO_MGCPC_EP_ST_UNUSED = 0, + OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE, + OSMO_MGCPC_EP_ST_IN_USE, +}; + +enum osmo_mgcpc_ep_fsm_event { + _OSMO_MGCPC_EP_EV_LAST = 0, + /* and MGW response events are allocated dynamically */ +}; + +#define FIRST_CI_EVENT (_OSMO_MGCPC_EP_EV_LAST + (_OSMO_MGCPC_EP_EV_LAST & 1)) /* rounded up to even nr */ +#define USABLE_CI ((32 - FIRST_CI_EVENT)/2) +#define EV_TO_CI_IDX(event) ((event - FIRST_CI_EVENT) / 2) + +#define CI_EV_SUCCESS(ci) (FIRST_CI_EVENT + (((ci) - ci->ep->ci) * 2)) +#define CI_EV_FAILURE(ci) (CI_EV_SUCCESS(ci) + 1) + +static struct osmo_fsm osmo_mgcpc_ep_fsm; + +/*! One connection on an endpoint, corresponding to a connection identifier (CI) as returned by the MGW. + * An endpoint has a fixed number of slots of these, which may or may not be in use. + */ +struct osmo_mgcpc_ep_ci { + struct osmo_mgcpc_ep *ep; + + bool occupied; + char label[64]; + struct osmo_fsm_inst *mgcp_client_fi; + + bool pending; + bool sent; + enum mgcp_verb verb; + struct mgcp_conn_peer verb_info; + struct osmo_fsm_inst *notify; + uint32_t notify_success; + uint32_t notify_failure; + void *notify_data; + + bool got_port_info; + struct mgcp_conn_peer rtp_info; + char mgcp_ci_str[MGCP_CONN_ID_LENGTH]; +}; + +/*! An MGW endpoint with N connections, like "rtpbridge/23@mgw". */ +struct osmo_mgcpc_ep { + /*! MGCP client connection to the MGW. */ + struct mgcp_client *mgcp_client; + struct osmo_fsm_inst *fi; + + /*! Endpoint string; at first this might be a wildcard, and upon the first CRCX OK response, this will reflect + * the endpoint name returned by the MGW. */ + char endpoint[MGCP_ENDPOINT_MAXLEN]; + + /*! Timeout definitions used for this endpoint, see osmo_mgcpc_ep_fsm_timeouts. */ + const struct osmo_tdef *T_defs; + + /*! Endpoint connection slots. Note that each connection has its own set of FSM event numbers to signal success + * and failure, depending on its index within this array. See CI_EV_SUCCESS and CI_EV_FAILURE. */ + struct osmo_mgcpc_ep_ci ci[USABLE_CI]; +}; + +const struct value_string osmo_mgcp_verb_names[] = { + { MGCP_VERB_CRCX, "CRCX" }, + { MGCP_VERB_MDCX, "MDCX" }, + { MGCP_VERB_DLCX, "DLCX" }, + { MGCP_VERB_AUEP, "AUEP" }, + { MGCP_VERB_RSIP, "RSIP" }, + {} +}; + +static struct osmo_mgcpc_ep_ci *osmo_mgcpc_ep_check_ci(struct osmo_mgcpc_ep_ci *ci) +{ + if (!ci) + return NULL; + if (!ci->ep) + return NULL; + if (ci < ci->ep->ci || ci >= &ci->ep->ci[USABLE_CI]) + return NULL; + return ci; +} + +static struct osmo_mgcpc_ep_ci *osmo_mgcpc_ep_ci_for_event(struct osmo_mgcpc_ep *ep, uint32_t event) +{ + int idx; + if (event < FIRST_CI_EVENT) + return NULL; + idx = EV_TO_CI_IDX(event); + if (idx >= sizeof(ep->ci)) + return NULL; + return osmo_mgcpc_ep_check_ci(&ep->ci[idx]); +} + +const char *osmo_mgcpc_ep_name(const struct osmo_mgcpc_ep *ep) +{ + if (!ep) + return "NULL"; + if (ep->endpoint[0]) + return ep->endpoint; + return osmo_fsm_inst_name(ep->fi); +} + +const char *mgcp_conn_peer_name(const struct mgcp_conn_peer *info) +{ + /* I'd be fine with a smaller buffer and accept truncation, but gcc possibly refuses to build if + * this buffer is too small. */ + static char buf[1024]; + + if (!info) + return "NULL"; + + if (info->endpoint[0] + && info->addr[0]) + snprintf(buf, sizeof(buf), "%s:%s:%u", + info->endpoint, info->addr, info->port); + else if (info->endpoint[0]) + snprintf(buf, sizeof(buf), "%s", info->endpoint); + else if (info->addr[0]) + snprintf(buf, sizeof(buf), "%s:%u", info->addr, info->port); + else + return "empty"; + return buf; +} + +const char *osmo_mgcpc_ep_ci_name(const struct osmo_mgcpc_ep_ci *ci) +{ + const struct mgcp_conn_peer *rtp_info; + + if (!ci) + return "NULL"; + + rtp_info = osmo_mgcpc_ep_ci_get_rtp_info(ci); + + if (rtp_info) + return mgcp_conn_peer_name(rtp_info); + return osmo_mgcpc_ep_name(ci->ep); +} + +const char *osmo_mgcpc_ep_ci_id(const struct osmo_mgcpc_ep_ci *ci) +{ + if (!ci || !ci->mgcp_ci_str[0]) + return NULL; + return ci->mgcp_ci_str; +} + +static struct value_string osmo_mgcpc_ep_fsm_event_names[33] = {}; + +static char osmo_mgcpc_ep_fsm_event_name_bufs[32][32] = {}; + +static void fill_event_names() +{ + int i; + for (i = 0; i < (ARRAY_SIZE(osmo_mgcpc_ep_fsm_event_names) - 1); i++) { + if (i < _OSMO_MGCPC_EP_EV_LAST) + continue; + if (i < FIRST_CI_EVENT || EV_TO_CI_IDX(i) > USABLE_CI) { + osmo_mgcpc_ep_fsm_event_names[i] = (struct value_string){i, "Unused"}; + continue; + } + snprintf(osmo_mgcpc_ep_fsm_event_name_bufs[i], sizeof(osmo_mgcpc_ep_fsm_event_name_bufs[i]), + "MGW Response for CI #%d", EV_TO_CI_IDX(i)); + osmo_mgcpc_ep_fsm_event_names[i] = (struct value_string){i, osmo_mgcpc_ep_fsm_event_name_bufs[i]}; + } +} + +/* T_defs is used to obtain an (Osmocom specific) T2427001: timeout for an MGCP response (note, 2427 corresponds to the + * default MGCP port in osmo-mgw). */ +static __attribute__((constructor)) void osmo_mgcpc_ep_fsm_init() +{ + OSMO_ASSERT(osmo_fsm_register(&osmo_mgcpc_ep_fsm) == 0); + fill_event_names(); +} + +struct osmo_mgcpc_ep *osmo_mgcpc_ep_fi_mgwep(struct osmo_fsm_inst *fi) +{ + OSMO_ASSERT(fi); + OSMO_ASSERT(fi->fsm == &osmo_mgcpc_ep_fsm); + OSMO_ASSERT(fi->priv); + return fi->priv; +} + +/*! Allocate an osmo_mgcpc_ep FSM. + * MGCP messages to set up the endpoint will be sent on the given mgcp_client, as soon as the first + * osmo_mgcpc_ep_ci_request() is invoked. + * + * A typical sequence of events would be: + * + * ep = osmo_mgcpc_ep_alloc(..., mgcp_client_rtpbridge_wildcard(client)); + * ci_to_ran = osmo_mgcpc_ep_ci_add(ep); + * osmo_mgcpc_ep_ci_request(ci_to_ran, MGCP_VERB_CRCX, verb_info, + * my_call_fsm, MY_EVENT_MGCP_OK, MY_EVENT_MGCP_FAIL); + * ci_to_cn = osmo_mgcpc_ep_ci_add(ep); + * osmo_mgcpc_ep_ci_request(ci_to_cn, MGCP_VERB_CRCX, verb_info, + * my_call_fsm, MY_EVENT_MGCP_OK, MY_EVENT_MGCP_FAIL); + * ... + * osmo_mgcpc_ep_ci_request(ci_to_ran, MGCP_VERB_MDCX, ...); + * ... + * osmo_mgcpc_ep_clear(ep); + * ep = NULL; + * + * \param parent Parent FSM. + * \param parent_term_event Event to dispatch to the parent on termination of this FSM instance. + * \param mgcp_client Connection to the MGW. + * \param T_defs Timeout definitions to be used for FSM states, see osmo_mgcpc_ep_fsm_timeouts. + * \param fsm_id FSM instance ID. + * \param endpoint_str_fmt The endpoint string format to send to the MGW upon the first CRCX. + * See mgcp_client_rtpbridge_wildcard() for "rtpbridge" endpoints. + */ +struct osmo_mgcpc_ep *osmo_mgcpc_ep_alloc(struct osmo_fsm_inst *parent, uint32_t parent_term_event, + struct mgcp_client *mgcp_client, + const struct osmo_tdef *T_defs, + const char *fsm_id, + const char *endpoint_str_fmt, ...) +{ + va_list ap; + struct osmo_fsm_inst *fi; + struct osmo_mgcpc_ep *ep; + int rc; + + if (!mgcp_client) + return NULL; + + fi = osmo_fsm_inst_alloc_child(&osmo_mgcpc_ep_fsm, parent, parent_term_event); + OSMO_ASSERT(fi); + + osmo_fsm_inst_update_id(fi, fsm_id); + + ep = talloc_zero(fi, struct osmo_mgcpc_ep); + OSMO_ASSERT(ep); + + *ep = (struct osmo_mgcpc_ep){ + .mgcp_client = mgcp_client, + .fi = fi, + .T_defs = T_defs, + }; + fi->priv = ep; + + va_start(ap, endpoint_str_fmt); + rc = vsnprintf(ep->endpoint, sizeof(ep->endpoint), endpoint_str_fmt ? : "", ap); + va_end(ap); + + if (rc <= 0 || rc >= sizeof(ep->endpoint)) { + LOG_MGCPC_EP(ep, LOGL_ERROR, "Endpoint name too long or too short: %s\n", + ep->endpoint); + osmo_fsm_inst_term(ep->fi, OSMO_FSM_TERM_ERROR, 0); + return NULL; + } + + return ep; +} + +/*! Add a connection to an endpoint. + * Allocate a connection identifier slot in the osmo_mgcpc_ep instance, do not yet dispatch a CRCX. + * The CRCX is dispatched only upon the first osmo_mgcpc_ep_ci_request(). + * \param ep Parent endpoint instance. + * \param label_fmt Label for logging. + */ +struct osmo_mgcpc_ep_ci *osmo_mgcpc_ep_ci_add(struct osmo_mgcpc_ep *ep, + const char *label_fmt, ...) +{ + va_list ap; + int i; + struct osmo_mgcpc_ep_ci *ci; + + for (i = 0; i < USABLE_CI; i++) { + ci = &ep->ci[i]; + + if (ci->occupied || ci->mgcp_client_fi) + continue; + + *ci = (struct osmo_mgcpc_ep_ci){ + .ep = ep, + .occupied = true, + }; + if (label_fmt) { + va_start(ap, label_fmt); + vsnprintf(ci->label, sizeof(ci->label), label_fmt, ap); + va_end(ap); + } + return ci; + } + + LOG_MGCPC_EP(ep, LOGL_ERROR, + "Cannot allocate another endpoint, all " + OSMO_STRINGIFY_VAL(USABLE_CI) " are in use\n"); + + return NULL; +} + +static bool osmo_mgcpc_ep_fsm_check_state_chg_after_response(struct osmo_fsm_inst *fi); + +static void on_failure(struct osmo_mgcpc_ep_ci *ci) +{ + struct osmo_fsm_inst *notify = ci->notify; + uint32_t notify_failure = ci->notify_failure; + void *notify_data = ci->notify_data; + + if (!ci->occupied) + return; + + *ci = (struct osmo_mgcpc_ep_ci){ + .ep = ci->ep, + }; + + /* If this check has terminated the FSM instance, don't fire any more events to prevent use-after-free problems. + * The endpoint FSM does dispatch a term event to its parent, and everything should be cleaned like that. */ + if (!osmo_mgcpc_ep_fsm_check_state_chg_after_response(ci->ep->fi)) + return; + + if (notify) + osmo_fsm_inst_dispatch(notify, notify_failure, notify_data); +} + +static void on_success(struct osmo_mgcpc_ep_ci *ci, void *data) +{ + struct mgcp_conn_peer *rtp_info; + + if (!ci->occupied) + return; + + ci->pending = false; + + switch (ci->verb) { + case MGCP_VERB_CRCX: + /* If we sent a wildcarded endpoint name on CRCX, we need to store the resulting endpoint + * name here. Also, we receive the MGW's RTP port information. */ + rtp_info = data; + OSMO_ASSERT(rtp_info); + ci->got_port_info = true; + ci->rtp_info = *rtp_info; + osmo_strlcpy(ci->mgcp_ci_str, mgcp_conn_get_ci(ci->mgcp_client_fi), + sizeof(ci->mgcp_ci_str)); + if (rtp_info->endpoint[0]) { + int rc; + rc = osmo_strlcpy(ci->ep->endpoint, rtp_info->endpoint, + sizeof(ci->ep->endpoint)); + if (rc <= 0 || rc >= sizeof(ci->ep->endpoint)) { + LOG_CI(ci, LOGL_ERROR, "Unable to copy endpoint name '%s'\n", + rtp_info->endpoint); + osmo_mgcpc_ep_ci_dlcx(ci); + on_failure(ci); + return; + } + } + break; + + default: + break; + } + + LOG_CI(ci, LOGL_DEBUG, "received successful response to %s: RTP=%s%s\n", + osmo_mgcp_verb_name(ci->verb), + mgcp_conn_peer_name(ci->got_port_info? &ci->rtp_info : NULL), + ci->notify ? "" : " (not sending a notification)"); + + if (ci->notify) + osmo_fsm_inst_dispatch(ci->notify, ci->notify_success, ci->notify_data); + + osmo_mgcpc_ep_fsm_check_state_chg_after_response(ci->ep->fi); +} + +/*! Return the MGW's RTP port information for this connection, as returned by the last CRCX/MDCX OK message. */ +const struct mgcp_conn_peer *osmo_mgcpc_ep_ci_get_rtp_info(const struct osmo_mgcpc_ep_ci *ci) +{ + ci = osmo_mgcpc_ep_check_ci((struct osmo_mgcpc_ep_ci*)ci); + if (!ci) + return NULL; + if (!ci->got_port_info) + return NULL; + return &ci->rtp_info; +} + +/*! Return the MGW's RTP port information for this connection, as returned by the last CRCX/MDCX OK message. */ +bool osmo_mgcpc_ep_ci_get_crcx_info_to_sockaddr(const struct osmo_mgcpc_ep_ci *ci, struct sockaddr_storage *dest) +{ + const struct mgcp_conn_peer *rtp_info; + struct sockaddr_in *sin; + + rtp_info = osmo_mgcpc_ep_ci_get_rtp_info(ci); + if (!rtp_info) + return false; + + sin = (struct sockaddr_in *)dest; + + sin->sin_family = AF_INET; + sin->sin_addr.s_addr = inet_addr(rtp_info->addr); + sin->sin_port = osmo_ntohs(rtp_info->port); + return true; +} + + +static const struct osmo_tdef_state_timeout osmo_mgcpc_ep_fsm_timeouts[32] = { + [OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE] = { .T=2427001 }, +}; + +/* Transition to a state, using the T timer defined in assignment_fsm_timeouts. + * The actual timeout value is in turn obtained from osmo_mgcpc_ep.T_defs. + * Assumes local variable fi exists. */ +#define osmo_mgcpc_ep_fsm_state_chg(state) \ + osmo_tdef_fsm_inst_state_chg(fi, state, osmo_mgcpc_ep_fsm_timeouts, \ + ((struct osmo_mgcpc_ep*)fi->priv)->T_defs, 5) + +/*! Dispatch an actual CRCX/MDCX/DLCX message for this connection. + * \param ci Connection identifier as obtained from osmo_mgcpc_ep_ci_add(). + * \param verb MGCP operation to dispatch. + * \param verb_info Parameters for the MGCP operation. + * \param notify Peer FSM instance to notify of completed/failed operation. + * \param event_success Which event to dispatch to 'notify' upon OK response. + * \param event_failure Which event to dispatch to 'notify' upon failure response. + * \param notify_data Data pointer to pass to the event dispatch for both success and failure. + */ +void osmo_mgcpc_ep_ci_request(struct osmo_mgcpc_ep_ci *ci, + enum mgcp_verb verb, const struct mgcp_conn_peer *verb_info, + struct osmo_fsm_inst *notify, + uint32_t event_success, uint32_t event_failure, + void *notify_data) +{ + struct osmo_mgcpc_ep *ep; + struct osmo_fsm_inst *fi; + struct osmo_mgcpc_ep_ci cleared_ci; + ci = osmo_mgcpc_ep_check_ci(ci); + + if (!ci) { + LOGP(DLGLOBAL, LOGL_ERROR, "Invalid MGW endpoint request: no ci\n"); + goto dispatch_error; + } + if (!verb_info && verb != MGCP_VERB_DLCX) { + LOG_CI(ci, LOGL_ERROR, "Invalid MGW endpoint request: missing verb details for %s\n", + osmo_mgcp_verb_name(verb)); + goto dispatch_error; + } + if ((verb < 0) || (verb > MGCP_VERB_RSIP)) { + LOG_CI(ci, LOGL_ERROR, "Invalid MGW endpoint request: unknown verb: %s\n", + osmo_mgcp_verb_name(verb)); + goto dispatch_error; + } + + ep = ci->ep; + fi = ep->fi; + + /* Clear volatile state by explicitly keeping those that should remain. Because we can't assign + * the char[] directly, dance through cleared_ci and copy back. */ + cleared_ci = (struct osmo_mgcpc_ep_ci){ + .ep = ep, + .mgcp_client_fi = ci->mgcp_client_fi, + .got_port_info = ci->got_port_info, + .rtp_info = ci->rtp_info, + + .occupied = true, + /* .pending = true follows below */ + .verb = verb, + .notify = notify, + .notify_success = event_success, + .notify_failure = event_failure, + .notify_data = notify_data, + }; + osmo_strlcpy(cleared_ci.label, ci->label, sizeof(cleared_ci.label)); + osmo_strlcpy(cleared_ci.mgcp_ci_str, ci->mgcp_ci_str, sizeof(cleared_ci.mgcp_ci_str)); + *ci = cleared_ci; + + LOG_CI_VERB(ci, LOGL_DEBUG, "notify=%s\n", osmo_fsm_inst_name(ci->notify)); + + if (verb_info) + ci->verb_info = *verb_info; + + if (ep->endpoint[0]) { + if (ci->verb_info.endpoint[0] && strcmp(ci->verb_info.endpoint, ep->endpoint)) + LOG_CI(ci, LOGL_ERROR, + "Warning: Requested %s on endpoint %s, but this CI is on endpoint %s." + " Using the proper endpoint instead.\n", + osmo_mgcp_verb_name(verb), ci->verb_info.endpoint, ep->endpoint); + osmo_strlcpy(ci->verb_info.endpoint, ep->endpoint, sizeof(ci->verb_info.endpoint)); + } + + switch (ci->verb) { + case MGCP_VERB_CRCX: + if (ci->mgcp_client_fi) { + LOG_CI(ci, LOGL_ERROR, "CRCX can be called only once per MGW endpoint CI\n"); + on_failure(ci); + return; + } + break; + + case MGCP_VERB_MDCX: + if (!ci->mgcp_client_fi) { + LOG_CI_VERB(ci, LOGL_ERROR, "The first verb on an unused MGW endpoint CI must be CRCX, not %s\n", + osmo_mgcp_verb_name(ci->verb)); + on_failure(ci); + return; + } + break; + + case MGCP_VERB_DLCX: + if (!ci->mgcp_client_fi) { + LOG_CI_VERB(ci, LOGL_DEBUG, "Ignoring DLCX on unused MGW endpoint CI\n"); + return; + } + break; + + default: + LOG_CI(ci, LOGL_ERROR, "This verb is not supported: %s\n", osmo_mgcp_verb_name(ci->verb)); + on_failure(ci); + return; + } + + ci->pending = true; + + LOG_CI_VERB(ci, LOGL_DEBUG, "Scheduling\n"); + + if (ep->fi->state != OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE) + osmo_mgcpc_ep_fsm_state_chg(OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE); + + return; +dispatch_error: + if (notify) + osmo_fsm_inst_dispatch(notify, event_failure, notify_data); +} + +static int send_verb(struct osmo_mgcpc_ep_ci *ci) +{ + int rc; + struct osmo_mgcpc_ep *ep = ci->ep; + + if (!ci->occupied || !ci->pending || ci->sent) + return 0; + + switch (ci->verb) { + + case MGCP_VERB_CRCX: + OSMO_ASSERT(!ci->mgcp_client_fi); + LOG_CI_VERB(ci, LOGL_DEBUG, "Sending\n"); + ci->mgcp_client_fi = mgcp_conn_create(ep->mgcp_client, ep->fi, + CI_EV_FAILURE(ci), CI_EV_SUCCESS(ci), + &ci->verb_info); + ci->sent = true; + if (!ci->mgcp_client_fi){ + LOG_CI_VERB(ci, LOGL_ERROR, "Cannot send\n"); + on_failure(ci); + } + osmo_fsm_inst_update_id(ci->mgcp_client_fi, ci->label); + break; + + case MGCP_VERB_MDCX: + OSMO_ASSERT(ci->mgcp_client_fi); + LOG_CI_VERB(ci, LOGL_DEBUG, "Sending\n"); + rc = mgcp_conn_modify(ci->mgcp_client_fi, CI_EV_SUCCESS(ci), &ci->verb_info); + ci->sent = true; + if (rc) { + LOG_CI_VERB(ci, LOGL_ERROR, "Cannot send (rc=%d %s)\n", rc, strerror(-rc)); + on_failure(ci); + } + break; + + case MGCP_VERB_DLCX: + LOG_CI(ci, LOGL_DEBUG, "Sending MGCP: %s %s\n", + osmo_mgcp_verb_name(ci->verb), ci->mgcp_ci_str); + /* The way this is designed, we actually need to forget all about the ci right away. */ + mgcp_conn_delete(ci->mgcp_client_fi); + if (ci->notify) + osmo_fsm_inst_dispatch(ci->notify, ci->notify_success, ci->notify_data); + *ci = (struct osmo_mgcpc_ep_ci){ + .ep = ep, + }; + break; + + default: + OSMO_ASSERT(false); + } + + return 1; +} + +/*! DLCX all connections, terminate the endpoint FSM and free. */ +void osmo_mgcpc_ep_clear(struct osmo_mgcpc_ep *ep) +{ + if (!ep) + return; + osmo_fsm_inst_term(ep->fi, OSMO_FSM_TERM_REGULAR, 0); +} + +static void osmo_mgcpc_ep_count(struct osmo_mgcpc_ep *ep, int *occupied, int *pending_not_sent, + int *waiting_for_response) +{ + int i; + + if (occupied) + *occupied = 0; + + if (pending_not_sent) + *pending_not_sent = 0; + + if (waiting_for_response) + *waiting_for_response = 0; + + for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { + struct osmo_mgcpc_ep_ci *ci = &ep->ci[i]; + if (ci->occupied) { + if (occupied) + (*occupied)++; + } else + continue; + + if (ci->pending) + LOG_CI_VERB(ci, LOGL_DEBUG, "%s\n", + ci->sent ? "waiting for response" : "waiting to be sent"); + else + LOG_CI_VERB(ci, LOGL_DEBUG, "done (%s)\n", mgcp_conn_peer_name(osmo_mgcpc_ep_ci_get_rtp_info(ci))); + + if (ci->pending && ci->sent) + if (waiting_for_response) + (*waiting_for_response)++; + if (ci->pending && !ci->sent) + if (pending_not_sent) + (*pending_not_sent)++; + } +} + +static bool osmo_mgcpc_ep_fsm_check_state_chg_after_response(struct osmo_fsm_inst *fi) +{ + int waiting_for_response; + int occupied; + struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); + + osmo_mgcpc_ep_count(ep, &occupied, NULL, &waiting_for_response); + LOG_MGCPC_EP(ep, LOGL_DEBUG, "CI in use: %d, waiting for response: %d\n", occupied, waiting_for_response); + + if (!occupied) { + /* All CI have been released. The endpoint no longer exists. Notify the parent FSM, by + * terminating. */ + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, 0); + return false; + } + + if (!waiting_for_response) { + if (fi->state != OSMO_MGCPC_EP_ST_IN_USE) + osmo_mgcpc_ep_fsm_state_chg(OSMO_MGCPC_EP_ST_IN_USE); + } + + return true; +} + +static void osmo_mgcpc_ep_fsm_wait_mgw_response_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + int count = 0; + int i; + struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); + + for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { + count += send_verb(&ep->ci[i]); + } + + LOG_MGCPC_EP(ep, LOGL_DEBUG, "Sent messages: %d\n", count); + osmo_mgcpc_ep_fsm_check_state_chg_after_response(fi); +} + +static void osmo_mgcpc_ep_fsm_handle_ci_events(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct osmo_mgcpc_ep_ci *ci; + struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); + ci = osmo_mgcpc_ep_ci_for_event(ep, event); + if (ci) { + if (event == CI_EV_SUCCESS(ci)) + on_success(ci, data); + else + on_failure(ci); + } +} + +static void osmo_mgcpc_ep_fsm_in_use_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state) +{ + int pending_not_sent; + struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); + + osmo_mgcpc_ep_count(ep, NULL, &pending_not_sent, NULL); + if (pending_not_sent) + osmo_mgcpc_ep_fsm_state_chg(OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE); +} + +#define S(x) (1 << (x)) + +static const struct osmo_fsm_state osmo_mgcpc_ep_fsm_states[] = { + [OSMO_MGCPC_EP_ST_UNUSED] = { + .name = "UNUSED", + .in_event_mask = 0, + .out_state_mask = 0 + | S(OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE) + , + }, + [OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE] = { + .name = "WAIT_MGW_RESPONSE", + .onenter = osmo_mgcpc_ep_fsm_wait_mgw_response_onenter, + .action = osmo_mgcpc_ep_fsm_handle_ci_events, + .in_event_mask = 0xffffffff, + .out_state_mask = 0 + | S(OSMO_MGCPC_EP_ST_IN_USE) + , + }, + [OSMO_MGCPC_EP_ST_IN_USE] = { + .name = "IN_USE", + .onenter = osmo_mgcpc_ep_fsm_in_use_onenter, + .action = osmo_mgcpc_ep_fsm_handle_ci_events, + .in_event_mask = 0xffffffff, /* mgcp_client_fsm may send parent term anytime */ + .out_state_mask = 0 + | S(OSMO_MGCPC_EP_ST_WAIT_MGW_RESPONSE) + , + }, +}; + +static int osmo_mgcpc_ep_fsm_timer_cb(struct osmo_fsm_inst *fi) +{ + int i; + struct osmo_mgcpc_ep *ep = osmo_mgcpc_ep_fi_mgwep(fi); + + switch (fi->T) { + default: + for (i = 0; i < ARRAY_SIZE(ep->ci); i++) { + struct osmo_mgcpc_ep_ci *ci = &ep->ci[i]; + if (!ci->occupied) + continue; + if (!(ci->pending && ci->sent)) + continue; + on_failure(ci); + } + return 0; + } + + return 0; +} + +static struct osmo_fsm osmo_mgcpc_ep_fsm = { + .name = "mgw-endpoint", + .states = osmo_mgcpc_ep_fsm_states, + .num_states = ARRAY_SIZE(osmo_mgcpc_ep_fsm_states), + .log_subsys = DLMGCP, + .event_names = osmo_mgcpc_ep_fsm_event_names, + .timer_cb = osmo_mgcpc_ep_fsm_timer_cb, + /* The FSM termination will automatically trigger any mgcp_client_fsm instances to DLCX. */ +}; diff --git a/src/libosmo-mgcp-client/mgcp_client_fsm.c b/src/libosmo-mgcp-client/mgcp_client_fsm.c index 71f431024..75d583bbe 100644 --- a/src/libosmo-mgcp-client/mgcp_client_fsm.c +++ b/src/libosmo-mgcp-client/mgcp_client_fsm.c @@ -700,3 +700,25 @@ void mgcp_conn_delete(struct osmo_fsm_inst *fi) } osmo_fsm_inst_dispatch(fi, EV_DLCX, mgcp_ctx); } + +const char *osmo_mgcpc_conn_peer_name(const struct mgcp_conn_peer *info) +{ + /* I'd be fine with a smaller buffer and accept truncation, but gcc possibly refuses to build if + * this buffer is too small. */ + static char buf[1024]; + + if (!info) + return "NULL"; + + if (info->endpoint[0] + && info->addr[0]) + snprintf(buf, sizeof(buf), "%s:%s:%u", + info->endpoint, info->addr, info->port); + else if (info->endpoint[0]) + snprintf(buf, sizeof(buf), "%s", info->endpoint); + else if (info->addr[0]) + snprintf(buf, sizeof(buf), "%s:%u", info->addr, info->port); + else + return "empty"; + return buf; +}