Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1 | /* mgcp_utils - common functions to setup an MGCP connection |
| 2 | */ |
| 3 | /* (C) 2016 by sysmocom s.f.m.c. GmbH <info@sysmocom.de> |
| 4 | * All Rights Reserved |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
Harald Welte | 220f487 | 2018-02-04 09:04:16 +0100 | [diff] [blame] | 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
Harald Welte | 220f487 | 2018-02-04 09:04:16 +0100 | [diff] [blame] | 14 | * GNU General Public License for more details. |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 15 | * |
Harald Welte | 220f487 | 2018-02-04 09:04:16 +0100 | [diff] [blame] | 16 | * You should have received a copy of the GNU General Public License |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 17 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 18 | * |
| 19 | */ |
| 20 | |
| 21 | #include <osmocom/core/linuxlist.h> |
| 22 | #include <osmocom/core/select.h> |
| 23 | #include <osmocom/core/write_queue.h> |
| 24 | #include <osmocom/core/msgb.h> |
| 25 | #include <osmocom/core/logging.h> |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 26 | #include <osmocom/core/byteswap.h> |
Harald Welte | 8890dfa | 2017-11-17 15:09:30 +0100 | [diff] [blame] | 27 | #include <osmocom/core/socket.h> |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 28 | #include <osmocom/core/sockaddr_str.h> |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 29 | |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 30 | #include <osmocom/mgcp_client/mgcp_client.h> |
| 31 | #include <osmocom/mgcp_client/mgcp_client_internal.h> |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 32 | |
Philipp Maier | 92a73cd | 2020-11-26 22:21:11 +0100 | [diff] [blame] | 33 | #include <osmocom/abis/e1_input.h> |
| 34 | |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 35 | #include <netinet/in.h> |
| 36 | #include <arpa/inet.h> |
| 37 | |
| 38 | #include <errno.h> |
| 39 | #include <unistd.h> |
| 40 | #include <string.h> |
Pau Espin Pedrol | 166077e | 2019-06-26 12:21:38 +0200 | [diff] [blame] | 41 | #include <ctype.h> |
Pau Espin Pedrol | c5c1430 | 2019-07-23 16:19:41 +0200 | [diff] [blame] | 42 | #include <stdlib.h> |
| 43 | #include <limits.h> |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 44 | |
Pau Espin Pedrol | 1b1d7ed | 2019-05-23 16:48:24 +0200 | [diff] [blame] | 45 | #ifndef OSMUX_CID_MAX |
| 46 | #define OSMUX_CID_MAX 255 /* FIXME: use OSMUX_CID_MAX from libosmo-netif? */ |
| 47 | #endif |
| 48 | |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 49 | #define LOGPMGW(mgcp, level, fmt, args...) \ |
| 50 | LOGP(DLMGCP, level, "MGW(%s) " fmt, mgcp_client_name(mgcp), ## args) |
| 51 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 52 | /* Codec descripton for dynamic payload types (SDP) */ |
Neels Hofmeyr | 47642f2 | 2019-02-27 05:56:53 +0100 | [diff] [blame] | 53 | const struct value_string osmo_mgcpc_codec_names[] = { |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 54 | { CODEC_PCMU_8000_1, "PCMU/8000/1" }, |
| 55 | { CODEC_GSM_8000_1, "GSM/8000/1" }, |
| 56 | { CODEC_PCMA_8000_1, "PCMA/8000/1" }, |
| 57 | { CODEC_G729_8000_1, "G729/8000/1" }, |
| 58 | { CODEC_GSMEFR_8000_1, "GSM-EFR/8000/1" }, |
| 59 | { CODEC_GSMHR_8000_1, "GSM-HR-08/8000/1" }, |
| 60 | { CODEC_AMR_8000_1, "AMR/8000/1" }, |
| 61 | { CODEC_AMRWB_16000_1, "AMR-WB/16000/1" }, |
Philipp Maier | 1de5ed6 | 2021-12-21 14:38:14 +0100 | [diff] [blame] | 62 | { CODEC_IUFP, "VND.3GPP.IUFP/16000" }, |
Oliver Smith | 26d6b2b | 2023-01-24 13:04:47 +0100 | [diff] [blame] | 63 | { CODEC_CLEARMODE, "CLEARMODE/8000" }, |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 64 | { 0, NULL }, |
| 65 | }; |
| 66 | |
| 67 | /* Get encoding name from a full codec string e,g. |
| 68 | * ("CODEC/8000/2" => returns "CODEC") */ |
| 69 | static char *extract_codec_name(const char *str) |
| 70 | { |
| 71 | static char buf[64]; |
Neels Hofmeyr | c364f4a | 2023-06-30 05:09:53 +0200 | [diff] [blame] | 72 | char *pos; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 73 | |
| 74 | if (!str) |
| 75 | return NULL; |
| 76 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 77 | osmo_strlcpy(buf, str, sizeof(buf)); |
| 78 | |
Neels Hofmeyr | c364f4a | 2023-06-30 05:09:53 +0200 | [diff] [blame] | 79 | pos = strchr(buf, '/'); |
| 80 | if (pos) |
| 81 | *pos = '\0'; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 82 | |
| 83 | return buf; |
| 84 | } |
| 85 | |
| 86 | /*! Map a string to a codec. |
| 87 | * \ptmap[in] str input string (e.g "GSM/8000/1", "GSM/8000" or "GSM") |
| 88 | * \returns codec that corresponds to the given string representation. */ |
| 89 | enum mgcp_codecs map_str_to_codec(const char *str) |
| 90 | { |
| 91 | unsigned int i; |
| 92 | char *codec_name; |
| 93 | char str_buf[64]; |
| 94 | |
| 95 | osmo_strlcpy(str_buf, extract_codec_name(str), sizeof(str_buf)); |
| 96 | |
Neels Hofmeyr | 47642f2 | 2019-02-27 05:56:53 +0100 | [diff] [blame] | 97 | for (i = 0; i < ARRAY_SIZE(osmo_mgcpc_codec_names); i++) { |
| 98 | codec_name = extract_codec_name(osmo_mgcpc_codec_names[i].str); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 99 | if (!codec_name) |
| 100 | continue; |
| 101 | if (strcmp(codec_name, str_buf) == 0) |
Neels Hofmeyr | 47642f2 | 2019-02-27 05:56:53 +0100 | [diff] [blame] | 102 | return osmo_mgcpc_codec_names[i].value; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 103 | } |
| 104 | |
| 105 | return -1; |
| 106 | } |
| 107 | |
| 108 | /* Check the ptmap for illegal mappings */ |
Neels Hofmeyr | 84274e4 | 2019-04-27 19:08:36 +0200 | [diff] [blame] | 109 | static int check_ptmap(const struct ptmap *ptmap) |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 110 | { |
| 111 | /* Check if there are mappings that leave the IANA assigned dynamic |
| 112 | * payload type range. Under normal conditions such mappings should |
| 113 | * not occur */ |
| 114 | |
| 115 | /* Its ok to have a 1:1 mapping in the statically defined |
| 116 | * range, this won't hurt */ |
| 117 | if (ptmap->codec == ptmap->pt) |
| 118 | return 0; |
| 119 | |
| 120 | if (ptmap->codec < 96 || ptmap->codec > 127) |
| 121 | goto error; |
| 122 | if (ptmap->pt < 96 || ptmap->pt > 127) |
| 123 | goto error; |
| 124 | |
| 125 | return 0; |
| 126 | error: |
| 127 | LOGP(DLMGCP, LOGL_ERROR, |
| 128 | "ptmap contains illegal mapping: codec=%u maps to pt=%u\n", |
| 129 | ptmap->codec, ptmap->pt); |
| 130 | return -1; |
| 131 | } |
| 132 | |
| 133 | /*! Map a codec to a payload type. |
| 134 | * \ptmap[in] payload pointer to payload type map with specified payload types. |
| 135 | * \ptmap[in] ptmap_len length of the payload type map. |
| 136 | * \ptmap[in] codec the codec for which the payload type should be looked up. |
| 137 | * \returns assigned payload type */ |
Neels Hofmeyr | 84274e4 | 2019-04-27 19:08:36 +0200 | [diff] [blame] | 138 | unsigned int map_codec_to_pt(const struct ptmap *ptmap, unsigned int ptmap_len, |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 139 | enum mgcp_codecs codec) |
| 140 | { |
| 141 | unsigned int i; |
| 142 | |
| 143 | /*! Note: If the payload type map is empty or the codec is not found |
| 144 | * in the map, then a 1:1 mapping is performed. If the codec falls |
| 145 | * into the statically defined range or if the mapping table isself |
| 146 | * tries to map to the statically defined range, then the mapping |
| 147 | * is also ignored and a 1:1 mapping is performed instead. */ |
| 148 | |
| 149 | /* we may return the codec directly since enum mgcp_codecs directly |
Oliver Smith | 292ba1b | 2023-06-28 10:30:25 +0200 | [diff] [blame] | 150 | * corresponds to the statically assigned payload types */ |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 151 | if (codec < 96 || codec > 127) |
| 152 | return codec; |
| 153 | |
| 154 | for (i = 0; i < ptmap_len; i++) { |
| 155 | /* Skip illegal map entries */ |
| 156 | if (check_ptmap(ptmap) == 0 && ptmap->codec == codec) |
| 157 | return ptmap->pt; |
| 158 | ptmap++; |
| 159 | } |
| 160 | |
| 161 | /* If nothing is found, do not perform any mapping */ |
| 162 | return codec; |
| 163 | } |
| 164 | |
| 165 | /*! Map a payload type to a codec. |
| 166 | * \ptmap[in] payload pointer to payload type map with specified payload types. |
| 167 | * \ptmap[in] ptmap_len length of the payload type map. |
| 168 | * \ptmap[in] payload type for which the codec should be looked up. |
| 169 | * \returns codec that corresponds to the specified payload type */ |
| 170 | enum mgcp_codecs map_pt_to_codec(struct ptmap *ptmap, unsigned int ptmap_len, |
| 171 | unsigned int pt) |
| 172 | { |
| 173 | unsigned int i; |
| 174 | |
| 175 | /*! Note: If the payload type map is empty or the payload type is not |
| 176 | * found in the map, then a 1:1 mapping is performed. If the payload |
| 177 | * type falls into the statically defined range or if the mapping |
| 178 | * table isself tries to map to the statically defined range, then |
| 179 | * the mapping is also ignored and a 1:1 mapping is performed |
| 180 | * instead. */ |
| 181 | |
| 182 | /* See also note in map_codec_to_pt() */ |
| 183 | if (pt < 96 || pt > 127) |
| 184 | return pt; |
| 185 | |
| 186 | for (i = 0; i < ptmap_len; i++) { |
| 187 | if (check_ptmap(ptmap) == 0 && ptmap->pt == pt) |
| 188 | return ptmap->codec; |
| 189 | ptmap++; |
| 190 | } |
| 191 | |
| 192 | /* If nothing is found, do not perform any mapping */ |
| 193 | return pt; |
| 194 | } |
| 195 | |
Pau Espin Pedrol | 8e8d59f | 2023-06-13 19:41:44 +0200 | [diff] [blame] | 196 | static void _mgcp_client_conf_init(struct mgcp_client_conf *conf) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 197 | { |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 198 | /* NULL and -1 default to MGCP_CLIENT_*_DEFAULT values */ |
| 199 | *conf = (struct mgcp_client_conf){ |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 200 | .local_addr = NULL, |
| 201 | .local_port = -1, |
| 202 | .remote_addr = NULL, |
| 203 | .remote_port = -1, |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 204 | .keepalive = { |
| 205 | .timeout_sec = 0, /* disabled */ |
| 206 | .req_interval_sec = 0, /* disabled */ |
| 207 | .req_endpoint_name = MGCP_CLIENT_KEEPALIVE_DEFAULT_ENDP, |
| 208 | }, |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 209 | }; |
Philipp Maier | 3f2c15f | 2021-07-22 11:53:07 +0200 | [diff] [blame] | 210 | |
| 211 | INIT_LLIST_HEAD(&conf->reset_epnames); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 212 | } |
| 213 | |
Pau Espin Pedrol | 8e8d59f | 2023-06-13 19:41:44 +0200 | [diff] [blame] | 214 | /*! Allocate and initialize MGCP client configuration struct with default values. |
| 215 | * \param[in] ctx talloc context to use as a parent during allocation. |
| 216 | * |
| 217 | * The returned struct can be freed using talloc_free(). |
| 218 | */ |
| 219 | struct mgcp_client_conf *mgcp_client_conf_alloc(void *ctx) |
| 220 | { |
| 221 | struct mgcp_client_conf *conf = talloc(ctx, struct mgcp_client_conf); |
| 222 | _mgcp_client_conf_init(conf); |
| 223 | return conf; |
| 224 | } |
| 225 | |
| 226 | /*! Initialize MGCP client configuration struct with default values. |
| 227 | * \param[out] conf Client configuration. |
| 228 | * |
| 229 | * This function is deprecated and should not be used, as it may break if size |
| 230 | * of struct mgcp_client_conf changes in the future! |
| 231 | */ |
| 232 | void mgcp_client_conf_init(struct mgcp_client_conf *conf) |
| 233 | { |
| 234 | _mgcp_client_conf_init(conf); |
| 235 | } |
| 236 | |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 237 | static void mgcp_client_handle_response(struct mgcp_client *mgcp, |
| 238 | struct mgcp_response_pending *pending, |
| 239 | struct mgcp_response *response) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 240 | { |
| 241 | if (!pending) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 242 | LOGPMGW(mgcp, LOGL_ERROR, "Cannot handle NULL response\n"); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 243 | return; |
| 244 | } |
| 245 | if (pending->response_cb) |
| 246 | pending->response_cb(response, pending->priv); |
| 247 | else |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 248 | LOGPMGW(mgcp, LOGL_DEBUG, "MGCP response ignored (NULL cb)\n"); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 249 | talloc_free(pending); |
| 250 | } |
| 251 | |
| 252 | static int mgcp_response_parse_head(struct mgcp_response *r, struct msgb *msg) |
| 253 | { |
| 254 | int comment_pos; |
| 255 | char *end; |
| 256 | |
| 257 | if (mgcp_msg_terminate_nul(msg)) |
| 258 | goto response_parse_failure; |
| 259 | |
| 260 | r->body = (char *)msg->data; |
| 261 | |
Harald Welte | 9bf7c53 | 2017-11-17 14:14:31 +0100 | [diff] [blame] | 262 | if (sscanf(r->body, "%3d %u %n", |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 263 | &r->head.response_code, &r->head.trans_id, |
| 264 | &comment_pos) != 2) |
| 265 | goto response_parse_failure; |
| 266 | |
Philipp Maier | abe8c89 | 2018-01-20 00:15:12 +0100 | [diff] [blame] | 267 | osmo_strlcpy(r->head.comment, r->body + comment_pos, sizeof(r->head.comment)); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 268 | end = strchr(r->head.comment, '\r'); |
| 269 | if (!end) |
| 270 | goto response_parse_failure; |
| 271 | /* Mark the end of the comment */ |
| 272 | *end = '\0'; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 273 | return 0; |
| 274 | |
| 275 | response_parse_failure: |
| 276 | LOGP(DLMGCP, LOGL_ERROR, |
| 277 | "Failed to parse MGCP response header\n"); |
| 278 | return -EINVAL; |
| 279 | } |
| 280 | |
| 281 | /* TODO undup against mgcp_protocol.c:mgcp_check_param() */ |
| 282 | static bool mgcp_line_is_valid(const char *line) |
| 283 | { |
| 284 | const size_t line_len = strlen(line); |
| 285 | if (line[0] == '\0') |
| 286 | return true; |
| 287 | |
| 288 | if (line_len < 2 |
| 289 | || line[1] != '=') { |
| 290 | LOGP(DLMGCP, LOGL_ERROR, |
| 291 | "Wrong MGCP option format: '%s'\n", |
| 292 | line); |
| 293 | return false; |
| 294 | } |
| 295 | |
| 296 | return true; |
| 297 | } |
| 298 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 299 | /* Parse a line like "m=audio 16002 RTP/AVP 98", extract port and payload types */ |
| 300 | static int mgcp_parse_audio_port_pt(struct mgcp_response *r, char *line) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 301 | { |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 302 | char *pt_str; |
Pau Espin Pedrol | c5c1430 | 2019-07-23 16:19:41 +0200 | [diff] [blame] | 303 | char *pt_end; |
Pau Espin Pedrol | a2b1c5e | 2019-07-26 14:13:14 +0200 | [diff] [blame] | 304 | unsigned long int pt; |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 305 | unsigned int ptmap_len; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 306 | unsigned int i; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 307 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 308 | /* Extract port information */ |
| 309 | if (sscanf(line, "m=audio %hu", &r->audio_port) != 1) |
| 310 | goto response_parse_failure_port; |
Philipp Maier | 10f32db | 2017-12-13 12:34:34 +0100 | [diff] [blame] | 311 | if (r->audio_port == 0) |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 312 | goto response_parse_failure_port; |
Philipp Maier | 10f32db | 2017-12-13 12:34:34 +0100 | [diff] [blame] | 313 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 314 | /* Extract payload types */ |
| 315 | line = strstr(line, "RTP/AVP "); |
| 316 | if (!line) |
| 317 | goto exit; |
| 318 | |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 319 | /* Clear any previous entries before writing over r->ptmap */ |
| 320 | r->ptmap_len = 0; |
| 321 | /* Keep a local ptmap_len to show only the full list after parsing succeeded in whole. */ |
| 322 | ptmap_len = 0; |
| 323 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 324 | pt_str = strtok(line, " "); |
| 325 | while (1) { |
| 326 | /* Do not allow excessive payload types */ |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 327 | if (ptmap_len >= ARRAY_SIZE(r->ptmap)) |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 328 | goto response_parse_failure_pt; |
| 329 | |
| 330 | pt_str = strtok(NULL, " "); |
| 331 | if (!pt_str) |
| 332 | break; |
Pau Espin Pedrol | c5c1430 | 2019-07-23 16:19:41 +0200 | [diff] [blame] | 333 | errno = 0; |
| 334 | pt = strtoul(pt_str, &pt_end, 0); |
| 335 | if ((errno == ERANGE && pt == ULONG_MAX) || (errno && !pt) || |
| 336 | pt_str == pt_end) |
| 337 | goto response_parse_failure_pt; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 338 | |
Pau Espin Pedrol | a2b1c5e | 2019-07-26 14:13:14 +0200 | [diff] [blame] | 339 | if (pt >> 7) /* PT is 7 bit field, higher values not allowed */ |
| 340 | goto response_parse_failure_pt; |
| 341 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 342 | /* Do not allow duplicate payload types */ |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 343 | for (i = 0; i < ptmap_len; i++) |
| 344 | if (r->ptmap[i].pt == pt) |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 345 | goto response_parse_failure_pt; |
| 346 | |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 347 | /* Some payload type numbers imply a specific codec. For those, using the PT number as enum mgcp_codecs |
| 348 | * yields the correct result. If no more specific information on the codec follows in "a=rtpmap:N" |
| 349 | * lines, then this default number takes over. This only applies for PT below the dynamic range (<96). */ |
| 350 | if (pt < 96) |
| 351 | r->ptmap[ptmap_len].codec = pt; |
| 352 | else |
| 353 | r->ptmap[ptmap_len].codec = -1; |
| 354 | r->ptmap[ptmap_len].pt = pt; |
| 355 | ptmap_len++; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 356 | } |
| 357 | |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 358 | /* Parsing succeeded, publish all entries. */ |
| 359 | r->ptmap_len = ptmap_len; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 360 | |
| 361 | exit: |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 362 | return 0; |
| 363 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 364 | response_parse_failure_port: |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 365 | LOGP(DLMGCP, LOGL_ERROR, |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 366 | "Failed to parse SDP parameter port (%s)\n", line); |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 367 | return -EINVAL; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 368 | |
| 369 | response_parse_failure_pt: |
| 370 | LOGP(DLMGCP, LOGL_ERROR, |
| 371 | "Failed to parse SDP parameter payload types (%s)\n", line); |
| 372 | return -EINVAL; |
| 373 | } |
| 374 | |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 375 | /* Parse an 'a=...' parameter */ |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 376 | static int mgcp_parse_audio_ptime_rtpmap(struct mgcp_response *r, const char *line) |
| 377 | { |
| 378 | unsigned int pt; |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 379 | unsigned int i; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 380 | char codec_resp[64]; |
Oliver Smith | 9423817 | 2023-06-28 13:28:57 +0200 | [diff] [blame] | 381 | int rc; |
Pau Espin Pedrol | c12bfb7 | 2019-04-16 17:23:09 +0200 | [diff] [blame] | 382 | |
Neels Hofmeyr | 23f4048 | 2019-08-08 04:03:42 +0200 | [diff] [blame] | 383 | #define A_PTIME "a=ptime:" |
| 384 | #define A_RTPMAP "a=rtpmap:" |
Pau Espin Pedrol | c12bfb7 | 2019-04-16 17:23:09 +0200 | [diff] [blame] | 385 | |
Neels Hofmeyr | 23f4048 | 2019-08-08 04:03:42 +0200 | [diff] [blame] | 386 | if (osmo_str_startswith(line, A_PTIME)) { |
| 387 | if (sscanf(line, A_PTIME "%u", &r->ptime) != 1) { |
| 388 | LOGP(DLMGCP, LOGL_ERROR, |
| 389 | "Failed to parse SDP parameter, invalid ptime (%s)\n", line); |
| 390 | return -EINVAL; |
| 391 | } |
| 392 | } else if (osmo_str_startswith(line, A_RTPMAP)) { |
| 393 | if (sscanf(line, A_RTPMAP "%d %63s", &pt, codec_resp) != 2) { |
| 394 | LOGP(DLMGCP, LOGL_ERROR, |
| 395 | "Failed to parse SDP parameter, invalid rtpmap: %s\n", osmo_quote_str(line, -1)); |
| 396 | return -EINVAL; |
| 397 | } |
Oliver Smith | 9423817 | 2023-06-28 13:28:57 +0200 | [diff] [blame] | 398 | rc = map_str_to_codec(codec_resp); |
| 399 | if (rc < 0) { |
| 400 | LOGP(DLMGCP, LOGL_ERROR, |
| 401 | "Failed to parse SDP parameter, can't parse codec in rtpmap: %s\n", osmo_quote_str(line, -1)); |
| 402 | return -EINVAL; |
| 403 | } |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 404 | |
| 405 | /* Earlier, a line like "m=audio 16002 RTP/AVP 98 112 3" established the desired order of payloads, now |
| 406 | * enrich it with actual codec information provided by "a=rtpmap:..." entries. |
| 407 | * For each, find the entry with the right pt number and add the info there. */ |
| 408 | |
| 409 | for (i = 0; i < r->ptmap_len; i++) { |
| 410 | if (r->ptmap[i].pt != pt) |
| 411 | continue; |
| 412 | r->ptmap[i].codec = rc; |
| 413 | return 0; |
| 414 | } |
| 415 | |
| 416 | /* No entry was found. This is an error in the MGCP protocol, but let's just add another entry |
| 417 | * anyway, to not make it look like it was never there. */ |
| 418 | LOGP(DLMGCP, LOGL_ERROR, |
| 419 | "error in MGCP message: 'a=rtpmap:%u' has no matching entry in 'm=audio ... %u'\n", |
| 420 | pt, pt); |
| 421 | if (r->ptmap_len >= ARRAY_SIZE(r->ptmap)) { |
| 422 | LOGP(DLMGCP, LOGL_ERROR, |
| 423 | "cannot parse all codecs: can only store up to %zu rtpmap entries.\n", |
| 424 | ARRAY_SIZE(r->ptmap)); |
| 425 | return -ENOSPC; |
| 426 | } |
| 427 | r->ptmap[r->ptmap_len] = (struct ptmap){ |
| 428 | .pt = pt, |
| 429 | .codec = rc, |
| 430 | }; |
Neels Hofmeyr | 3ab8ca4 | 2019-08-08 04:03:42 +0200 | [diff] [blame] | 431 | r->ptmap_len++; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 432 | } |
Pau Espin Pedrol | c12bfb7 | 2019-04-16 17:23:09 +0200 | [diff] [blame] | 433 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 434 | return 0; |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 435 | } |
| 436 | |
| 437 | /* Parse a line like "c=IN IP4 10.11.12.13" */ |
| 438 | static int mgcp_parse_audio_ip(struct mgcp_response *r, const char *line) |
| 439 | { |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 440 | struct in6_addr ip_test; |
| 441 | bool is_ipv6; |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 442 | |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 443 | if (strncmp("c=IN IP", line, 7) != 0) |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 444 | goto response_parse_failure; |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 445 | line += 7; |
| 446 | if (*line == '6') |
| 447 | is_ipv6 = true; |
| 448 | else if (*line == '4') |
| 449 | is_ipv6 = false; |
| 450 | else |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 451 | goto response_parse_failure; |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 452 | line++; |
| 453 | if (*line != ' ') |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 454 | goto response_parse_failure; |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 455 | line++; |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 456 | |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 457 | /* Extract and check IP-Address */ |
| 458 | if (is_ipv6) { |
| 459 | /* 45 = INET6_ADDRSTRLEN -1 */ |
| 460 | if (sscanf(line, "%45s", r->audio_ip) != 1) |
| 461 | goto response_parse_failure; |
| 462 | if (inet_pton(AF_INET6, r->audio_ip, &ip_test) != 1) |
| 463 | goto response_parse_failure; |
| 464 | } else { |
| 465 | /* 15 = INET_ADDRSTRLEN -1 */ |
| 466 | if (sscanf(line, "%15s", r->audio_ip) != 1) |
| 467 | goto response_parse_failure; |
| 468 | if (inet_pton(AF_INET, r->audio_ip, &ip_test) != 1) |
| 469 | goto response_parse_failure; |
| 470 | } |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 471 | return 0; |
| 472 | |
| 473 | response_parse_failure: |
| 474 | LOGP(DLMGCP, LOGL_ERROR, |
| 475 | "Failed to parse MGCP response header (audio ip)\n"); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 476 | return -EINVAL; |
| 477 | } |
| 478 | |
Pau Espin Pedrol | 91088c3 | 2019-04-24 21:02:40 +0200 | [diff] [blame] | 479 | /*! Extract OSMUX CID from an MGCP parameter line (string). |
| 480 | * \param[in] line single parameter line from the MGCP message |
| 481 | * \returns OSMUX CID, -1 wildcard, -2 on error |
| 482 | * FIXME: This is a copy of function in mgcp_msg.c. Have some common.c file between both libs? |
| 483 | */ |
| 484 | static int mgcp_parse_osmux_cid(const char *line) |
| 485 | { |
| 486 | int osmux_cid; |
| 487 | |
| 488 | |
Pau Espin Pedrol | c1bf469 | 2019-05-14 16:23:24 +0200 | [diff] [blame] | 489 | if (strcasecmp(line + 2, "Osmux: *") == 0) { |
Pau Espin Pedrol | 91088c3 | 2019-04-24 21:02:40 +0200 | [diff] [blame] | 490 | LOGP(DLMGCP, LOGL_DEBUG, "Parsed wilcard Osmux CID\n"); |
| 491 | return -1; |
| 492 | } |
| 493 | |
Pau Espin Pedrol | c1bf469 | 2019-05-14 16:23:24 +0200 | [diff] [blame] | 494 | if (sscanf(line + 2 + 7, "%u", &osmux_cid) != 1) { |
Pau Espin Pedrol | 91088c3 | 2019-04-24 21:02:40 +0200 | [diff] [blame] | 495 | LOGP(DLMGCP, LOGL_ERROR, "Failed parsing Osmux in MGCP msg line: %s\n", |
| 496 | line); |
| 497 | return -2; |
| 498 | } |
| 499 | |
Pau Espin Pedrol | 91088c3 | 2019-04-24 21:02:40 +0200 | [diff] [blame] | 500 | if (osmux_cid > OSMUX_CID_MAX) { /* OSMUX_CID_MAX from libosmo-netif */ |
| 501 | LOGP(DLMGCP, LOGL_ERROR, "Osmux ID too large: %u > %u\n", |
| 502 | osmux_cid, OSMUX_CID_MAX); |
| 503 | return -2; |
| 504 | } |
Pau Espin Pedrol | c7c8e64 | 2022-10-06 18:24:21 +0200 | [diff] [blame] | 505 | LOGP(DLMGCP, LOGL_DEBUG, "MGW offered Osmux CID %u\n", osmux_cid); |
Pau Espin Pedrol | 91088c3 | 2019-04-24 21:02:40 +0200 | [diff] [blame] | 506 | |
| 507 | return osmux_cid; |
| 508 | } |
| 509 | |
Philipp Maier | 3b12e1b | 2018-01-18 15:16:13 +0100 | [diff] [blame] | 510 | /* A new section is marked by a double line break, check a few more |
| 511 | * patterns as there may be variants */ |
| 512 | static char *mgcp_find_section_end(char *string) |
| 513 | { |
| 514 | char *rc; |
| 515 | |
| 516 | rc = strstr(string, "\n\n"); |
| 517 | if (rc) |
Neels Hofmeyr | ce356ee | 2023-03-30 16:51:40 +0200 | [diff] [blame] | 518 | return rc + 2; |
Philipp Maier | 3b12e1b | 2018-01-18 15:16:13 +0100 | [diff] [blame] | 519 | |
| 520 | rc = strstr(string, "\n\r\n\r"); |
| 521 | if (rc) |
Neels Hofmeyr | ce356ee | 2023-03-30 16:51:40 +0200 | [diff] [blame] | 522 | return rc + 4; |
Philipp Maier | 3b12e1b | 2018-01-18 15:16:13 +0100 | [diff] [blame] | 523 | |
| 524 | rc = strstr(string, "\r\n\r\n"); |
| 525 | if (rc) |
Neels Hofmeyr | ce356ee | 2023-03-30 16:51:40 +0200 | [diff] [blame] | 526 | return rc + 4; |
Philipp Maier | 3b12e1b | 2018-01-18 15:16:13 +0100 | [diff] [blame] | 527 | |
| 528 | return NULL; |
| 529 | } |
| 530 | |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 531 | /*! Parse body (SDP) parameters of the MGCP response |
| 532 | * \param[in,out] r Response data |
| 533 | * \returns 0 on success, -EINVAL on error. */ |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 534 | int mgcp_response_parse_params(struct mgcp_response *r) |
| 535 | { |
| 536 | char *line; |
| 537 | int rc; |
Neels Hofmeyr | 0793d2f | 2018-02-21 14:55:34 +0100 | [diff] [blame] | 538 | char *data; |
Philipp Maier | e9d645b | 2018-01-19 23:54:08 +0100 | [diff] [blame] | 539 | char *data_ptr; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 540 | |
Philipp Maier | e9d645b | 2018-01-19 23:54:08 +0100 | [diff] [blame] | 541 | /* Since this functions performs a destructive parsing, we create a |
| 542 | * local copy of the body data */ |
Neels Hofmeyr | 0793d2f | 2018-02-21 14:55:34 +0100 | [diff] [blame] | 543 | OSMO_ASSERT(r->body); |
| 544 | data = talloc_strdup(r, r->body); |
Philipp Maier | e9d645b | 2018-01-19 23:54:08 +0100 | [diff] [blame] | 545 | OSMO_ASSERT(data); |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 546 | |
Philipp Maier | e9d645b | 2018-01-19 23:54:08 +0100 | [diff] [blame] | 547 | /* Find beginning of the parameter (SDP) section */ |
| 548 | data_ptr = mgcp_find_section_end(data); |
Neels Hofmeyr | 1083533 | 2018-02-21 14:55:34 +0100 | [diff] [blame] | 549 | if (!data_ptr) { |
Neels Hofmeyr | e827831 | 2019-09-19 03:06:46 +0200 | [diff] [blame] | 550 | LOGP(DLMGCP, LOGL_DEBUG, "MGCP response contains no SDP parameters\n"); |
| 551 | rc = 0; |
Philipp Maier | e9d645b | 2018-01-19 23:54:08 +0100 | [diff] [blame] | 552 | goto exit; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 553 | } |
| 554 | |
Neels Hofmeyr | 0793d2f | 2018-02-21 14:55:34 +0100 | [diff] [blame] | 555 | /* data_ptr now points to the beginning of the section-end-marker; for_each_non_empty_line() |
| 556 | * skips any \r and \n characters for free, so we don't need to skip the marker. */ |
| 557 | |
Philipp Maier | e9d645b | 2018-01-19 23:54:08 +0100 | [diff] [blame] | 558 | for_each_non_empty_line(line, data_ptr) { |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 559 | if (!mgcp_line_is_valid(line)) |
| 560 | return -EINVAL; |
| 561 | |
| 562 | switch (line[0]) { |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 563 | case 'a': |
| 564 | rc = mgcp_parse_audio_ptime_rtpmap(r, line); |
| 565 | if (rc) |
| 566 | goto exit; |
| 567 | break; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 568 | case 'm': |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 569 | rc = mgcp_parse_audio_port_pt(r, line); |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 570 | if (rc) |
Philipp Maier | e9d645b | 2018-01-19 23:54:08 +0100 | [diff] [blame] | 571 | goto exit; |
Philipp Maier | 06da85e | 2017-10-05 18:49:24 +0200 | [diff] [blame] | 572 | break; |
| 573 | case 'c': |
| 574 | rc = mgcp_parse_audio_ip(r, line); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 575 | if (rc) |
Philipp Maier | e9d645b | 2018-01-19 23:54:08 +0100 | [diff] [blame] | 576 | goto exit; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 577 | break; |
| 578 | default: |
| 579 | /* skip unhandled parameters */ |
| 580 | break; |
| 581 | } |
| 582 | } |
Philipp Maier | e9d645b | 2018-01-19 23:54:08 +0100 | [diff] [blame] | 583 | |
| 584 | rc = 0; |
| 585 | exit: |
| 586 | talloc_free(data); |
| 587 | return rc; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 588 | } |
| 589 | |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 590 | /* Parse a line like "X: something" */ |
| 591 | static int mgcp_parse_head_param(char *result, unsigned int result_len, |
| 592 | char label, const char *line) |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 593 | { |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 594 | char label_string[4]; |
Neels Hofmeyr | 23e7bf1 | 2018-09-03 21:26:22 +0200 | [diff] [blame] | 595 | size_t rc; |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 596 | |
| 597 | /* Detect empty parameters */ |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 598 | if (strlen(line) < 4) |
| 599 | goto response_parse_failure; |
| 600 | |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 601 | /* Check if the label matches */ |
| 602 | snprintf(label_string, sizeof(label_string), "%c: ", label); |
| 603 | if (memcmp(label_string, line, 3) != 0) |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 604 | goto response_parse_failure; |
| 605 | |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 606 | /* Copy payload part of the string to destinations (the label string |
| 607 | * is always 3 chars long) */ |
Neels Hofmeyr | 23e7bf1 | 2018-09-03 21:26:22 +0200 | [diff] [blame] | 608 | rc = osmo_strlcpy(result, line + 3, result_len); |
| 609 | if (rc >= result_len) { |
| 610 | LOGP(DLMGCP, LOGL_ERROR, |
| 611 | "Failed to parse MGCP response (parameter label: %c):" |
| 612 | " the received conn ID is too long: %zu, maximum is %u characters\n", |
| 613 | label, rc, result_len - 1); |
| 614 | return -ENOSPC; |
| 615 | } |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 616 | return 0; |
| 617 | |
| 618 | response_parse_failure: |
| 619 | LOGP(DLMGCP, LOGL_ERROR, |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 620 | "Failed to parse MGCP response (parameter label: %c)\n", label); |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 621 | return -EINVAL; |
| 622 | } |
| 623 | |
| 624 | /* Parse MGCP parameters of the response */ |
| 625 | static int parse_head_params(struct mgcp_response *r) |
| 626 | { |
| 627 | char *line; |
| 628 | int rc = 0; |
| 629 | OSMO_ASSERT(r->body); |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 630 | char *data; |
| 631 | char *data_ptr; |
| 632 | char *data_end; |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 633 | |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 634 | /* Since this functions performs a destructive parsing, we create a |
| 635 | * local copy of the body data */ |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 636 | data = talloc_zero_size(r, strlen(r->body)+1); |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 637 | OSMO_ASSERT(data); |
| 638 | data_ptr = data; |
| 639 | osmo_strlcpy(data, r->body, strlen(r->body)); |
| 640 | |
| 641 | /* If there is an SDP body attached, prevent for_each_non_empty_line() |
| 642 | * into running in there, we are not yet interested in the parameters |
| 643 | * stored there. */ |
Pau Espin Pedrol | c12bfb7 | 2019-04-16 17:23:09 +0200 | [diff] [blame] | 644 | data_end = mgcp_find_section_end(data); |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 645 | if (data_end) |
| 646 | *data_end = '\0'; |
| 647 | |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 648 | for_each_non_empty_line(line, data_ptr) { |
Pau Espin Pedrol | 166077e | 2019-06-26 12:21:38 +0200 | [diff] [blame] | 649 | switch (toupper(line[0])) { |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 650 | case 'Z': |
| 651 | rc = mgcp_parse_head_param(r->head.endpoint, |
| 652 | sizeof(r->head.endpoint), |
| 653 | 'Z', line); |
| 654 | if (rc) |
| 655 | goto exit; |
Philipp Maier | 771b26a | 2018-01-31 13:53:11 +0100 | [diff] [blame] | 656 | |
| 657 | /* A specific endpoint identifier returned by the MGW |
| 658 | * must not contain any wildcard characters */ |
| 659 | if (strstr(r->head.endpoint, "*") != NULL) { |
| 660 | rc = -EINVAL; |
| 661 | goto exit; |
| 662 | } |
Philipp Maier | 3261dc7 | 2018-01-31 14:03:13 +0100 | [diff] [blame] | 663 | |
| 664 | /* A specific endpoint identifier returned by the MGW |
| 665 | * must contain an @ character */ |
| 666 | if (strstr(r->head.endpoint, "@") == NULL) { |
| 667 | rc = -EINVAL; |
| 668 | goto exit; |
| 669 | } |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 670 | break; |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 671 | case 'I': |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 672 | rc = mgcp_parse_head_param(r->head.conn_id, |
| 673 | sizeof(r->head.conn_id), |
| 674 | 'I', line); |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 675 | if (rc) |
| 676 | goto exit; |
| 677 | break; |
Pau Espin Pedrol | 91088c3 | 2019-04-24 21:02:40 +0200 | [diff] [blame] | 678 | case 'X': |
Pau Espin Pedrol | c1bf469 | 2019-05-14 16:23:24 +0200 | [diff] [blame] | 679 | if (strncasecmp("Osmux: ", line + 2, strlen("Osmux: ")) == 0) { |
Pau Espin Pedrol | 91088c3 | 2019-04-24 21:02:40 +0200 | [diff] [blame] | 680 | rc = mgcp_parse_osmux_cid(line); |
| 681 | if (rc < 0) { |
| 682 | /* -1: we don't want wildcards in response. -2: error */ |
| 683 | rc = -EINVAL; |
| 684 | goto exit; |
| 685 | } |
| 686 | r->head.x_osmo_osmux_use = true; |
| 687 | r->head.x_osmo_osmux_cid = (uint8_t) rc; |
| 688 | rc = 0; |
| 689 | break; |
| 690 | } |
| 691 | /* Ignore unknown X-headers */ |
| 692 | break; |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 693 | default: |
| 694 | /* skip unhandled parameters */ |
| 695 | break; |
| 696 | } |
| 697 | } |
| 698 | exit: |
Philipp Maier | 55295f7 | 2018-01-15 14:00:28 +0100 | [diff] [blame] | 699 | talloc_free(data); |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 700 | return rc; |
| 701 | } |
| 702 | |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 703 | static struct mgcp_response_pending *mgcp_client_response_pending_get( |
| 704 | struct mgcp_client *mgcp, |
Neels Hofmeyr | c8f37cb | 2017-11-30 13:43:11 +0100 | [diff] [blame] | 705 | mgcp_trans_id_t trans_id) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 706 | { |
| 707 | struct mgcp_response_pending *pending; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 708 | llist_for_each_entry(pending, &mgcp->responses_pending, entry) { |
Neels Hofmeyr | c8f37cb | 2017-11-30 13:43:11 +0100 | [diff] [blame] | 709 | if (pending->trans_id == trans_id) { |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 710 | llist_del(&pending->entry); |
| 711 | return pending; |
| 712 | } |
| 713 | } |
| 714 | return NULL; |
| 715 | } |
| 716 | |
| 717 | /* Feed an MGCP message into the receive processing. |
| 718 | * Parse the head and call any callback registered for the transaction id found |
| 719 | * in the MGCP message. This is normally called directly from the internal |
| 720 | * mgcp_do_read that reads from the socket connected to the MGCP gateway. This |
| 721 | * function is published mainly to be able to feed data from the test suite. |
| 722 | */ |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 723 | int mgcp_client_rx(struct mgcp_client *mgcp, struct msgb *msg) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 724 | { |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 725 | struct mgcp_response *r; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 726 | struct mgcp_response_pending *pending; |
| 727 | int rc; |
| 728 | |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 729 | r = talloc_zero(mgcp, struct mgcp_response); |
| 730 | OSMO_ASSERT(r); |
| 731 | |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 732 | /* Re-arm keepalive timer if enabled */ |
| 733 | if (OSMO_UNLIKELY(mgcp->conn_up == false)) { |
| 734 | LOGPMGW(mgcp, LOGL_NOTICE, "MGCP link to MGW now considered UP\n"); |
| 735 | mgcp->conn_up = true; |
| 736 | } |
| 737 | if (mgcp->actual.keepalive.timeout_sec > 0) |
| 738 | osmo_timer_schedule(&mgcp->keepalive_rx_timer, mgcp->actual.keepalive.timeout_sec, 0); |
| 739 | |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 740 | rc = mgcp_response_parse_head(r, msg); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 741 | if (rc) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 742 | LOGPMGW(mgcp, LOGL_ERROR, "Cannot parse MGCP response (head)\n"); |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 743 | rc = 1; |
| 744 | goto error; |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 745 | } |
| 746 | |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 747 | LOGPMGW(mgcp, LOGL_DEBUG, "MGCP client: Rx %d %u %s\n", |
Neels Hofmeyr | d573107 | 2021-07-15 01:36:47 +0200 | [diff] [blame] | 748 | r->head.response_code, r->head.trans_id, r->head.comment); |
| 749 | |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 750 | rc = parse_head_params(r); |
Philipp Maier | ffd75e4 | 2017-11-22 11:44:50 +0100 | [diff] [blame] | 751 | if (rc) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 752 | LOGPMGW(mgcp, LOGL_ERROR, "Cannot parse MGCP response (head parameters)\n"); |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 753 | rc = 1; |
| 754 | goto error; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 755 | } |
| 756 | |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 757 | pending = mgcp_client_response_pending_get(mgcp, r->head.trans_id); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 758 | if (!pending) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 759 | LOGPMGW(mgcp, LOGL_ERROR, "Cannot find matching MGCP transaction for trans_id %d\n", |
| 760 | r->head.trans_id); |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 761 | rc = -ENOENT; |
| 762 | goto error; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 763 | } |
| 764 | |
Philipp Maier | 1fc6999 | 2018-01-31 15:32:55 +0100 | [diff] [blame] | 765 | mgcp_client_handle_response(mgcp, pending, r); |
| 766 | rc = 0; |
| 767 | |
| 768 | error: |
| 769 | talloc_free(r); |
| 770 | return rc; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 771 | } |
| 772 | |
| 773 | static int mgcp_do_read(struct osmo_fd *fd) |
| 774 | { |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 775 | struct mgcp_client *mgcp = fd->data; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 776 | struct msgb *msg; |
| 777 | int ret; |
| 778 | |
| 779 | msg = msgb_alloc_headroom(4096, 128, "mgcp_from_gw"); |
| 780 | if (!msg) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 781 | LOGPMGW(mgcp, LOGL_ERROR, "Failed to allocate MGCP message.\n"); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 782 | return -1; |
| 783 | } |
| 784 | |
Vadim Yanitskiy | f3715dc | 2023-12-11 21:03:26 +0700 | [diff] [blame] | 785 | /* msgb_tailroom() is basically (4096 - 128); -1 is for '\0' */ |
| 786 | ret = read(fd->fd, msg->data, msgb_tailroom(msg) - 1); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 787 | if (ret <= 0) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 788 | LOGPMGW(mgcp, LOGL_ERROR, "Failed to read: %s: %d='%s'\n", |
| 789 | osmo_sock_get_name2(fd->fd), errno, strerror(errno)); |
Neels Hofmeyr | 0a40379 | 2018-12-12 03:10:18 +0100 | [diff] [blame] | 790 | |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 791 | msgb_free(msg); |
| 792 | return -1; |
Harald Welte | 9bf7c53 | 2017-11-17 14:14:31 +0100 | [diff] [blame] | 793 | } |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 794 | |
| 795 | msg->l2h = msgb_put(msg, ret); |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 796 | ret = mgcp_client_rx(mgcp, msg); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 797 | talloc_free(msg); |
| 798 | return ret; |
| 799 | } |
| 800 | |
| 801 | static int mgcp_do_write(struct osmo_fd *fd, struct msgb *msg) |
| 802 | { |
| 803 | int ret; |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 804 | struct mgcp_client *mgcp = fd->data; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 805 | |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 806 | LOGPMGW(mgcp, LOGL_DEBUG, "Tx MGCP: %s: len=%u '%s'...\n", |
| 807 | osmo_sock_get_name2(fd->fd), msg->len, |
| 808 | osmo_escape_str((const char *)msg->data, OSMO_MIN(42, msg->len))); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 809 | |
| 810 | ret = write(fd->fd, msg->data, msg->len); |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 811 | if (OSMO_UNLIKELY(ret != msg->len)) |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 812 | LOGPMGW(mgcp, LOGL_ERROR, "Failed to Tx MGCP: %s: %d='%s'; msg: len=%u '%s'...\n", |
| 813 | osmo_sock_get_name2(fd->fd), errno, strerror(errno), |
| 814 | msg->len, osmo_escape_str((const char *)msg->data, OSMO_MIN(42, msg->len))); |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 815 | |
| 816 | /* Re-arm the keepalive Tx timer: */ |
| 817 | if (mgcp->actual.keepalive.req_interval_sec > 0) |
| 818 | osmo_timer_schedule(&mgcp->keepalive_tx_timer, mgcp->actual.keepalive.req_interval_sec, 0); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 819 | return ret; |
| 820 | } |
| 821 | |
Pau Espin Pedrol | 2e411f3 | 2023-06-14 11:52:04 +0200 | [diff] [blame] | 822 | static const char *_mgcp_client_name_append_domain(const struct mgcp_client *mgcp, const char *name) |
| 823 | { |
| 824 | static char endpoint[MGCP_ENDPOINT_MAXLEN]; |
| 825 | int rc; |
| 826 | |
| 827 | rc = snprintf(endpoint, sizeof(endpoint), "%s@%s", name, mgcp_client_endpoint_domain(mgcp)); |
| 828 | if (rc > sizeof(endpoint) - 1) { |
| 829 | LOGPMGW(mgcp, LOGL_ERROR, "MGCP endpoint exceeds maximum length of %zu: '%s@%s'\n", |
| 830 | sizeof(endpoint) - 1, name, mgcp_client_endpoint_domain(mgcp)); |
| 831 | return NULL; |
| 832 | } |
| 833 | if (rc < 1) { |
| 834 | LOGPMGW(mgcp, LOGL_ERROR, "Cannot compose MGCP endpoint name\n"); |
| 835 | return NULL; |
| 836 | } |
| 837 | return endpoint; |
| 838 | } |
| 839 | |
| 840 | /* Safely ignore the MGCP response to the DLCX sent via _mgcp_client_send_dlcx() */ |
| 841 | static void _ignore_mgcp_response(struct mgcp_response *response, void *priv) { } |
| 842 | |
| 843 | /* Format DLCX message (fire and forget) and send it off to the MGW */ |
| 844 | static void _mgcp_client_send_dlcx(struct mgcp_client *mgcp, const char *epname) |
| 845 | { |
| 846 | struct msgb *msgb_dlcx; |
| 847 | struct mgcp_msg mgcp_msg_dlcx = { |
| 848 | .verb = MGCP_VERB_DLCX, |
| 849 | .presence = MGCP_MSG_PRESENCE_ENDPOINT, |
| 850 | }; |
| 851 | osmo_strlcpy(mgcp_msg_dlcx.endpoint, epname, sizeof(mgcp_msg_dlcx.endpoint)); |
| 852 | msgb_dlcx = mgcp_msg_gen(mgcp, &mgcp_msg_dlcx); |
| 853 | mgcp_client_tx(mgcp, msgb_dlcx, &_ignore_mgcp_response, NULL); |
| 854 | } |
| 855 | |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 856 | /* Format AuditEndpoint message (fire and forget) and send it off to the MGW */ |
| 857 | static void _mgcp_client_send_auep(struct mgcp_client *mgcp, const char *epname) |
| 858 | { |
| 859 | struct msgb *msgb_auep; |
| 860 | struct mgcp_msg mgcp_msg_auep = { |
| 861 | .verb = MGCP_VERB_AUEP, |
| 862 | .presence = MGCP_MSG_PRESENCE_ENDPOINT, |
| 863 | }; |
| 864 | OSMO_STRLCPY_ARRAY(mgcp_msg_auep.endpoint, epname); |
| 865 | msgb_auep = mgcp_msg_gen(mgcp, &mgcp_msg_auep); |
| 866 | mgcp_client_tx(mgcp, msgb_auep, &_ignore_mgcp_response, NULL); |
| 867 | } |
| 868 | |
| 869 | static void mgcp_client_keepalive_tx_timer_cb(void *data) |
| 870 | { |
| 871 | struct mgcp_client *mgcp = (struct mgcp_client *)data; |
| 872 | LOGPMGW(mgcp, LOGL_INFO, "Triggering keepalive MGCP request\n"); |
| 873 | const char *epname = _mgcp_client_name_append_domain(mgcp, mgcp->actual.keepalive.req_endpoint_name); |
| 874 | _mgcp_client_send_auep(mgcp, epname); |
| 875 | |
| 876 | /* Re-arm the timer: */ |
| 877 | osmo_timer_schedule(&mgcp->keepalive_tx_timer, mgcp->actual.keepalive.req_interval_sec, 0); |
| 878 | } |
| 879 | |
| 880 | static void mgcp_client_keepalive_rx_timer_cb(void *data) |
| 881 | { |
| 882 | struct mgcp_client *mgcp = (struct mgcp_client *)data; |
| 883 | LOGPMGW(mgcp, LOGL_ERROR, "MGCP link to MGW now considered DOWN (keepalive timeout, more than %u seconds with no answer from MGW)\n", |
| 884 | mgcp->actual.keepalive.timeout_sec); |
| 885 | mgcp->conn_up = false; |
| 886 | /* TODO: Potentially time out all ongoing transactions for that MGW. Maybe based on VTY cfg? */ |
| 887 | } |
| 888 | |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 889 | struct mgcp_client *mgcp_client_init(void *ctx, |
| 890 | struct mgcp_client_conf *conf) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 891 | { |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 892 | struct mgcp_client *mgcp; |
Philipp Maier | 3f2c15f | 2021-07-22 11:53:07 +0200 | [diff] [blame] | 893 | struct reset_ep *reset_ep; |
| 894 | struct reset_ep *actual_reset_ep; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 895 | |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 896 | mgcp = talloc_zero(ctx, struct mgcp_client); |
Harald Welte | efe1571 | 2020-07-15 10:56:45 +0200 | [diff] [blame] | 897 | if (!mgcp) |
| 898 | return NULL; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 899 | |
| 900 | INIT_LLIST_HEAD(&mgcp->responses_pending); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 901 | |
| 902 | mgcp->next_trans_id = 1; |
| 903 | |
| 904 | mgcp->actual.local_addr = conf->local_addr ? conf->local_addr : |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 905 | MGCP_CLIENT_LOCAL_ADDR_DEFAULT; |
Pau Espin Pedrol | 8e74c63 | 2022-10-17 19:20:45 +0200 | [diff] [blame] | 906 | mgcp->actual.local_port = conf->local_port > 0 ? (uint16_t)conf->local_port : |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 907 | MGCP_CLIENT_LOCAL_PORT_DEFAULT; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 908 | |
| 909 | mgcp->actual.remote_addr = conf->remote_addr ? conf->remote_addr : |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 910 | MGCP_CLIENT_REMOTE_ADDR_DEFAULT; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 911 | mgcp->actual.remote_port = conf->remote_port >= 0 ? (uint16_t)conf->remote_port : |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 912 | MGCP_CLIENT_REMOTE_PORT_DEFAULT; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 913 | |
Neels Hofmeyr | ac69ea9 | 2018-12-19 00:27:50 +0100 | [diff] [blame] | 914 | if (osmo_strlcpy(mgcp->actual.endpoint_domain_name, conf->endpoint_domain_name, |
| 915 | sizeof(mgcp->actual.endpoint_domain_name)) |
| 916 | >= sizeof(mgcp->actual.endpoint_domain_name)) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 917 | LOGPMGW(mgcp, LOGL_ERROR, "MGCP client: endpoint domain name is too long, max length is %zu: '%s'\n", |
| 918 | sizeof(mgcp->actual.endpoint_domain_name) - 1, conf->endpoint_domain_name); |
Neels Hofmeyr | ac69ea9 | 2018-12-19 00:27:50 +0100 | [diff] [blame] | 919 | talloc_free(mgcp); |
| 920 | return NULL; |
| 921 | } |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 922 | LOGPMGW(mgcp, LOGL_NOTICE, "MGCP client: using endpoint domain '@%s'\n", mgcp_client_endpoint_domain(mgcp)); |
Neels Hofmeyr | ac69ea9 | 2018-12-19 00:27:50 +0100 | [diff] [blame] | 923 | |
Philipp Maier | 3f2c15f | 2021-07-22 11:53:07 +0200 | [diff] [blame] | 924 | INIT_LLIST_HEAD(&mgcp->actual.reset_epnames); |
| 925 | llist_for_each_entry(reset_ep, &conf->reset_epnames, list) { |
| 926 | actual_reset_ep = talloc_memdup(mgcp, reset_ep, sizeof(*reset_ep)); |
| 927 | llist_add_tail(&actual_reset_ep->list, &mgcp->actual.reset_epnames); |
| 928 | } |
| 929 | |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 930 | if (conf->description) |
| 931 | mgcp->actual.description = talloc_strdup(mgcp, conf->description); |
| 932 | |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 933 | osmo_wqueue_init(&mgcp->wq, 1024); |
| 934 | mgcp->wq.read_cb = mgcp_do_read; |
| 935 | mgcp->wq.write_cb = mgcp_do_write; |
| 936 | osmo_fd_setup(&mgcp->wq.bfd, -1, OSMO_FD_READ, osmo_wqueue_bfd_cb, mgcp, 0); |
| 937 | |
| 938 | memcpy(&mgcp->actual.keepalive, &conf->keepalive, sizeof(conf->keepalive)); |
| 939 | osmo_timer_setup(&mgcp->keepalive_tx_timer, mgcp_client_keepalive_tx_timer_cb, mgcp); |
| 940 | osmo_timer_setup(&mgcp->keepalive_rx_timer, mgcp_client_keepalive_rx_timer_cb, mgcp); |
| 941 | |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 942 | return mgcp; |
| 943 | } |
| 944 | |
Philipp Maier | 3f2c15f | 2021-07-22 11:53:07 +0200 | [diff] [blame] | 945 | /*! Initialize client connection (opens socket) |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 946 | * \param[in,out] mgcp MGCP client descriptor. |
| 947 | * \returns 0 on success, -EINVAL on error. */ |
Pau Espin Pedrol | 8e74c63 | 2022-10-17 19:20:45 +0200 | [diff] [blame] | 948 | int mgcp_client_connect(struct mgcp_client *mgcp) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 949 | { |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 950 | int rc; |
Philipp Maier | 3f2c15f | 2021-07-22 11:53:07 +0200 | [diff] [blame] | 951 | struct reset_ep *reset_ep; |
| 952 | const char *epname; |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 953 | bool some_dlcx_sent = false; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 954 | |
| 955 | if (!mgcp) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 956 | LOGPMGW(mgcp, LOGL_FATAL, "Client not initialized properly\n"); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 957 | return -EINVAL; |
| 958 | } |
| 959 | |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 960 | rc = osmo_sock_init2_ofd(&mgcp->wq.bfd, AF_UNSPEC, SOCK_DGRAM, IPPROTO_UDP, mgcp->actual.local_addr, |
Pau Espin Pedrol | 8e74c63 | 2022-10-17 19:20:45 +0200 | [diff] [blame] | 961 | mgcp->actual.local_port, mgcp->actual.remote_addr, mgcp->actual.remote_port, |
| 962 | OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT); |
Harald Welte | 8890dfa | 2017-11-17 15:09:30 +0100 | [diff] [blame] | 963 | if (rc < 0) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 964 | LOGPMGW(mgcp, LOGL_FATAL, |
| 965 | "Failed to initialize socket %s:%u -> %s:%u for MGW: %s\n", |
Philipp Maier | 276a414 | 2021-07-29 11:55:14 +0200 | [diff] [blame] | 966 | mgcp->actual.local_addr ? mgcp->actual.local_addr : "(any)", mgcp->actual.local_port, |
| 967 | mgcp->actual.remote_addr ? mgcp->actual.local_addr : "(any)", mgcp->actual.remote_port, |
| 968 | strerror(errno)); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 969 | goto error_close_fd; |
| 970 | } |
| 971 | |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 972 | LOGPMGW(mgcp, LOGL_INFO, "MGW connection: %s\n", osmo_sock_get_name2(mgcp->wq.bfd.fd)); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 973 | |
Philipp Maier | 3f2c15f | 2021-07-22 11:53:07 +0200 | [diff] [blame] | 974 | /* If configured, send a DLCX message to the endpoints that are configured to |
| 975 | * be reset on startup. Usually this is a wildcarded endpoint. */ |
| 976 | llist_for_each_entry(reset_ep, &mgcp->actual.reset_epnames, list) { |
| 977 | epname = _mgcp_client_name_append_domain(mgcp, reset_ep->name); |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 978 | LOGPMGW(mgcp, LOGL_INFO, "Sending DLCX to: %s\n", epname); |
Philipp Maier | 3f2c15f | 2021-07-22 11:53:07 +0200 | [diff] [blame] | 979 | _mgcp_client_send_dlcx(mgcp, epname); |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 980 | some_dlcx_sent = true; |
Philipp Maier | 3f2c15f | 2021-07-22 11:53:07 +0200 | [diff] [blame] | 981 | } |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 982 | |
Pau Espin Pedrol | 4c06589 | 2023-06-26 18:44:44 +0200 | [diff] [blame] | 983 | if (mgcp->actual.keepalive.req_interval_sec > 0) { |
| 984 | if (!some_dlcx_sent) { |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 985 | /* Attempt an immediate probe to find out if link is UP or DOWN: */ |
| 986 | osmo_timer_schedule(&mgcp->keepalive_tx_timer, 0, 0); |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 987 | } |
Pau Espin Pedrol | 4c06589 | 2023-06-26 18:44:44 +0200 | [diff] [blame] | 988 | /* else: keepalive_tx_timer was already scheduled (if needed) down in the stack during Tx DLCX above */ |
| 989 | } else { |
| 990 | /* Assume link is UP by default, so that this MGW can be selected: */ |
| 991 | mgcp->conn_up = true; |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 992 | } |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 993 | |
| 994 | if (mgcp->actual.keepalive.timeout_sec > 0) |
| 995 | osmo_timer_schedule(&mgcp->keepalive_rx_timer, mgcp->actual.keepalive.timeout_sec, 0); |
| 996 | |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 997 | return 0; |
| 998 | error_close_fd: |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 999 | close(mgcp->wq.bfd.fd); |
| 1000 | mgcp->wq.bfd.fd = -1; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1001 | return rc; |
| 1002 | } |
| 1003 | |
Pau Espin Pedrol | 8e74c63 | 2022-10-17 19:20:45 +0200 | [diff] [blame] | 1004 | /*! DEPRECATED: Initialize client connection (opens socket) |
Philipp Maier | 3f4a4cb | 2021-07-26 13:20:05 +0200 | [diff] [blame] | 1005 | * \param[in,out] mgcp MGCP client descriptor. |
| 1006 | * \returns 0 on success, -EINVAL on error. */ |
Pau Espin Pedrol | 8e74c63 | 2022-10-17 19:20:45 +0200 | [diff] [blame] | 1007 | int mgcp_client_connect2(struct mgcp_client *mgcp, unsigned int retry_n_ports) |
Philipp Maier | 3f4a4cb | 2021-07-26 13:20:05 +0200 | [diff] [blame] | 1008 | { |
Pau Espin Pedrol | 8e74c63 | 2022-10-17 19:20:45 +0200 | [diff] [blame] | 1009 | return mgcp_client_connect(mgcp); |
Philipp Maier | 3f4a4cb | 2021-07-26 13:20:05 +0200 | [diff] [blame] | 1010 | } |
| 1011 | |
| 1012 | /*! Terminate client connection |
| 1013 | * \param[in,out] mgcp MGCP client descriptor. |
| 1014 | * \returns 0 on success, -EINVAL on error. */ |
| 1015 | void mgcp_client_disconnect(struct mgcp_client *mgcp) |
| 1016 | { |
| 1017 | struct osmo_wqueue *wq; |
| 1018 | |
| 1019 | if (!mgcp) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1020 | LOGP(DLMGCP, LOGL_FATAL, "MGCP client not initialized properly\n"); |
Philipp Maier | 3f4a4cb | 2021-07-26 13:20:05 +0200 | [diff] [blame] | 1021 | return; |
| 1022 | } |
| 1023 | |
Pau Espin Pedrol | 563386e | 2023-06-14 12:20:49 +0200 | [diff] [blame] | 1024 | /* Disarm keepalive Tx/Rx timer until next connect() */ |
| 1025 | osmo_timer_del(&mgcp->keepalive_rx_timer); |
| 1026 | osmo_timer_del(&mgcp->keepalive_tx_timer); |
| 1027 | mgcp->conn_up = false; |
| 1028 | |
Philipp Maier | 3f4a4cb | 2021-07-26 13:20:05 +0200 | [diff] [blame] | 1029 | wq = &mgcp->wq; |
| 1030 | osmo_wqueue_clear(wq); |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1031 | LOGPMGW(mgcp, LOGL_INFO, "MGCP association: %s -- closed!\n", osmo_sock_get_name2(wq->bfd.fd)); |
Philipp Maier | 3f4a4cb | 2021-07-26 13:20:05 +0200 | [diff] [blame] | 1032 | if (osmo_fd_is_registered(&wq->bfd)) |
| 1033 | osmo_fd_unregister(&wq->bfd); |
Pau Espin Pedrol | 747fbce | 2023-03-14 11:48:27 +0100 | [diff] [blame] | 1034 | close(wq->bfd.fd); |
| 1035 | wq->bfd.fd = -1; |
Philipp Maier | 3f4a4cb | 2021-07-26 13:20:05 +0200 | [diff] [blame] | 1036 | } |
| 1037 | |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1038 | /*! Get the IP-Aaddress of the associated MGW as string. |
| 1039 | * \param[in] mgcp MGCP client descriptor. |
| 1040 | * \returns a pointer to the address string. */ |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 1041 | const char *mgcp_client_remote_addr_str(struct mgcp_client *mgcp) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1042 | { |
| 1043 | return mgcp->actual.remote_addr; |
| 1044 | } |
| 1045 | |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1046 | /*! Get the IP-Port of the associated MGW. |
| 1047 | * \param[in] mgcp MGCP client descriptor. |
| 1048 | * \returns port number. */ |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 1049 | uint16_t mgcp_client_remote_port(struct mgcp_client *mgcp) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1050 | { |
| 1051 | return mgcp->actual.remote_port; |
| 1052 | } |
| 1053 | |
Pau Espin Pedrol | 74d0e5c | 2020-09-02 17:19:20 +0200 | [diff] [blame] | 1054 | /*! Get the IP-Address of the associated MGW as its numeric representation. |
| 1055 | * DEPRECATED, DON'T USE. |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1056 | * \param[in] mgcp MGCP client descriptor. |
| 1057 | * \returns IP-Address as 32 bit integer (network byte order) */ |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 1058 | uint32_t mgcp_client_remote_addr_n(struct mgcp_client *mgcp) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1059 | { |
Pau Espin Pedrol | 74d0e5c | 2020-09-02 17:19:20 +0200 | [diff] [blame] | 1060 | return 0; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1061 | } |
| 1062 | |
Neels Hofmeyr | ac69ea9 | 2018-12-19 00:27:50 +0100 | [diff] [blame] | 1063 | /* To compose endpoint names, usually for CRCX, use this as domain name. |
| 1064 | * For example, snprintf("rtpbridge\*@%s", mgcp_client_endpoint_domain(mgcp)). */ |
| 1065 | const char *mgcp_client_endpoint_domain(const struct mgcp_client *mgcp) |
| 1066 | { |
| 1067 | return mgcp->actual.endpoint_domain_name[0] ? mgcp->actual.endpoint_domain_name : "mgw"; |
| 1068 | } |
| 1069 | |
Philipp Maier | a466f57 | 2020-06-25 16:11:04 +0200 | [diff] [blame] | 1070 | /*! Compose endpoint name for a wildcarded request to the virtual trunk |
| 1071 | * \param[in] mgcp MGCP client descriptor. |
| 1072 | * \returns string containing the endpoint name (e.g. rtpbridge\*@mgw) */ |
Pau Espin Pedrol | ca0818c | 2019-04-16 17:23:38 +0200 | [diff] [blame] | 1073 | const char *mgcp_client_rtpbridge_wildcard(const struct mgcp_client *mgcp) |
| 1074 | { |
| 1075 | return _mgcp_client_name_append_domain(mgcp, "rtpbridge/*"); |
| 1076 | } |
| 1077 | |
Philipp Maier | 4863591 | 2020-06-25 20:16:22 +0200 | [diff] [blame] | 1078 | /*! Compose endpoint name for an E1 endpoint. |
| 1079 | * \param[in] ctx talloc context. |
| 1080 | * \param[in] mgcp MGCP client descriptor. |
| 1081 | * \param[in] trunk_id id number of the E1 trunk (1-64). |
| 1082 | * \param[in] ts timeslot on the E1 trunk (1-31). |
| 1083 | * \param[in] rate bitrate used on the E1 trunk (e.g 16 for 16kbit). |
| 1084 | * \param[in] offset bit offset of the E1 subslot (e.g. 4 for the third 16k subslot). |
| 1085 | * \returns string containing the endpoint name (e.g. ds/e1-1/s-1/su16-4). */ |
| 1086 | const char *mgcp_client_e1_epname(void *ctx, const struct mgcp_client *mgcp, uint8_t trunk_id, uint8_t ts, |
| 1087 | uint8_t rate, uint8_t offset) |
| 1088 | { |
| 1089 | /* See also comment in libosmo-mgcp, mgcp_client.c, gen_e1_epname() */ |
| 1090 | const uint8_t valid_rates[] = { 64, 32, 32, 16, 16, 16, 16, 8, 8, 8, 8, 8, 8, 8, 8 }; |
| 1091 | const uint8_t valid_offsets[] = { 0, 0, 4, 0, 2, 4, 6, 0, 1, 2, 3, 4, 5, 6, 7 }; |
| 1092 | |
| 1093 | uint8_t i; |
| 1094 | bool rate_offs_valid = false; |
| 1095 | char *epname; |
| 1096 | |
| 1097 | epname = |
| 1098 | talloc_asprintf(ctx, "ds/e1-%u/s-%u/su%u-%u@%s", trunk_id, ts, rate, offset, |
| 1099 | mgcp_client_endpoint_domain(mgcp)); |
| 1100 | if (!epname) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1101 | LOGPMGW(mgcp, LOGL_ERROR, "Cannot compose MGCP e1-endpoint name!\n"); |
Philipp Maier | 4863591 | 2020-06-25 20:16:22 +0200 | [diff] [blame] | 1102 | return NULL; |
| 1103 | } |
| 1104 | |
| 1105 | /* Check if the supplied rate/offset pair resembles a valid combination */ |
| 1106 | for (i = 0; i < sizeof(valid_rates); i++) { |
| 1107 | if (valid_rates[i] == rate && valid_offsets[i] == offset) |
| 1108 | rate_offs_valid = true; |
| 1109 | } |
| 1110 | if (!rate_offs_valid) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1111 | LOGPMGW(mgcp, LOGL_ERROR, |
| 1112 | "Cannot compose MGCP e1-endpoint name (%s), rate(%u)/offset(%u) combination is invalid!\n", |
| 1113 | epname, rate, offset); |
Philipp Maier | 4863591 | 2020-06-25 20:16:22 +0200 | [diff] [blame] | 1114 | talloc_free(epname); |
| 1115 | return NULL; |
| 1116 | } |
| 1117 | |
| 1118 | /* An E1 line has a maximum of 32 timeslots, while the first (ts=0) is |
| 1119 | * reserverd for framing and alignment, so we can not use it here. */ |
Philipp Maier | 92a73cd | 2020-11-26 22:21:11 +0100 | [diff] [blame] | 1120 | if (ts == 0 || ts > NUM_E1_TS-1) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1121 | LOGPMGW(mgcp, LOGL_ERROR, |
| 1122 | "Cannot compose MGCP e1-endpoint name (%s), E1-timeslot number (%u) is invalid!\n", |
| 1123 | epname, ts); |
Philipp Maier | 4863591 | 2020-06-25 20:16:22 +0200 | [diff] [blame] | 1124 | talloc_free(epname); |
| 1125 | return NULL; |
| 1126 | } |
| 1127 | |
| 1128 | return epname; |
| 1129 | } |
| 1130 | |
Philipp Maier | 30bdf94 | 2023-02-20 12:40:46 +0100 | [diff] [blame] | 1131 | struct mgcp_response_pending *mgcp_client_pending_add(struct mgcp_client *mgcp, mgcp_trans_id_t trans_id, |
| 1132 | mgcp_response_cb_t response_cb, void *priv) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1133 | { |
| 1134 | struct mgcp_response_pending *pending; |
| 1135 | |
| 1136 | pending = talloc_zero(mgcp, struct mgcp_response_pending); |
Harald Welte | 827da2c | 2020-07-15 10:57:08 +0200 | [diff] [blame] | 1137 | if (!pending) |
| 1138 | return NULL; |
| 1139 | |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1140 | pending->trans_id = trans_id; |
| 1141 | pending->response_cb = response_cb; |
| 1142 | pending->priv = priv; |
| 1143 | llist_add_tail(&pending->entry, &mgcp->responses_pending); |
| 1144 | |
| 1145 | return pending; |
| 1146 | } |
| 1147 | |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1148 | /* Send the MGCP message in msg to the MGW and handle a response with |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1149 | * response_cb. NOTE: the response_cb still needs to call |
| 1150 | * mgcp_response_parse_params(response) to get the parsed parameters -- to |
| 1151 | * potentially save some CPU cycles, only the head line has been parsed when |
Neels Hofmeyr | c8f37cb | 2017-11-30 13:43:11 +0100 | [diff] [blame] | 1152 | * the response_cb is invoked. |
| 1153 | * Before the priv pointer becomes invalid, e.g. due to transaction timeout, |
| 1154 | * mgcp_client_cancel() needs to be called for this transaction. |
| 1155 | */ |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 1156 | int mgcp_client_tx(struct mgcp_client *mgcp, struct msgb *msg, |
| 1157 | mgcp_response_cb_t response_cb, void *priv) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1158 | { |
Harald Welte | 563ffc5 | 2020-06-17 21:54:13 +0700 | [diff] [blame] | 1159 | struct mgcp_response_pending *pending = NULL; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1160 | mgcp_trans_id_t trans_id; |
| 1161 | int rc; |
| 1162 | |
| 1163 | trans_id = msg->cb[MSGB_CB_MGCP_TRANS_ID]; |
| 1164 | if (!trans_id) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1165 | LOGPMGW(mgcp, LOGL_ERROR, |
| 1166 | "Unset transaction id in mgcp send request\n"); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1167 | talloc_free(msg); |
| 1168 | return -EINVAL; |
| 1169 | } |
| 1170 | |
Harald Welte | 563ffc5 | 2020-06-17 21:54:13 +0700 | [diff] [blame] | 1171 | /* Do not allocate a dummy 'mgcp_response_pending' entry */ |
| 1172 | if (response_cb != NULL) { |
| 1173 | pending = mgcp_client_pending_add(mgcp, trans_id, response_cb, priv); |
| 1174 | if (!pending) { |
| 1175 | talloc_free(msg); |
| 1176 | return -ENOMEM; |
| 1177 | } |
Harald Welte | 827da2c | 2020-07-15 10:57:08 +0200 | [diff] [blame] | 1178 | } |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1179 | |
| 1180 | if (msgb_l2len(msg) > 4096) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1181 | LOGPMGW(mgcp, LOGL_ERROR, |
| 1182 | "Cannot send, MGCP message too large: %u\n", |
| 1183 | msgb_l2len(msg)); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1184 | msgb_free(msg); |
| 1185 | rc = -EINVAL; |
| 1186 | goto mgcp_tx_error; |
| 1187 | } |
| 1188 | |
| 1189 | rc = osmo_wqueue_enqueue(&mgcp->wq, msg); |
| 1190 | if (rc) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1191 | LOGPMGW(mgcp, LOGL_FATAL, "Could not queue message to MGW\n"); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1192 | msgb_free(msg); |
| 1193 | goto mgcp_tx_error; |
| 1194 | } else |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1195 | LOGPMGW(mgcp, LOGL_DEBUG, "Queued %u bytes for MGW\n", |
| 1196 | msgb_l2len(msg)); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1197 | return 0; |
| 1198 | |
| 1199 | mgcp_tx_error: |
Harald Welte | 563ffc5 | 2020-06-17 21:54:13 +0700 | [diff] [blame] | 1200 | if (!pending) |
Vadim Yanitskiy | ffbc618 | 2020-07-16 15:48:13 +0700 | [diff] [blame] | 1201 | return rc; |
Vadim Yanitskiy | 3f8139c | 2020-06-17 20:50:17 +0700 | [diff] [blame] | 1202 | /* Dequeue pending response, it's going to be free()d */ |
| 1203 | llist_del(&pending->entry); |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1204 | /* Pass NULL to response cb to indicate an error */ |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 1205 | mgcp_client_handle_response(mgcp, pending, NULL); |
Vadim Yanitskiy | ffbc618 | 2020-07-16 15:48:13 +0700 | [diff] [blame] | 1206 | return rc; |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1207 | } |
| 1208 | |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1209 | /*! Cancel a pending transaction. |
| 1210 | * \param[in] mgcp MGCP client descriptor. |
| 1211 | * \param[in,out] trans_id Transaction id. |
| 1212 | * \returns 0 on success, -ENOENT on error. |
| 1213 | * |
Neels Hofmeyr | c8f37cb | 2017-11-30 13:43:11 +0100 | [diff] [blame] | 1214 | * Should a priv pointer passed to mgcp_client_tx() become invalid, this function must be called. In |
| 1215 | * practical terms, if the caller of mgcp_client_tx() wishes to tear down a transaction without having |
| 1216 | * received a response this function must be called. The trans_id can be obtained by calling |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1217 | * mgcp_msg_trans_id() on the msgb produced by mgcp_msg_gen(). */ |
Neels Hofmeyr | c8f37cb | 2017-11-30 13:43:11 +0100 | [diff] [blame] | 1218 | int mgcp_client_cancel(struct mgcp_client *mgcp, mgcp_trans_id_t trans_id) |
| 1219 | { |
| 1220 | struct mgcp_response_pending *pending = mgcp_client_response_pending_get(mgcp, trans_id); |
| 1221 | if (!pending) { |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1222 | /*! Note: it is not harmful to cancel a transaction twice. */ |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1223 | LOGPMGW(mgcp, LOGL_ERROR, "Cannot cancel, no such transaction: %u\n", trans_id); |
Neels Hofmeyr | c8f37cb | 2017-11-30 13:43:11 +0100 | [diff] [blame] | 1224 | return -ENOENT; |
| 1225 | } |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1226 | LOGPMGW(mgcp, LOGL_DEBUG, "Canceled transaction %u\n", trans_id); |
Neels Hofmeyr | c8f37cb | 2017-11-30 13:43:11 +0100 | [diff] [blame] | 1227 | talloc_free(pending); |
| 1228 | return 0; |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1229 | /*! We don't really need to clean up the wqueue: In all sane cases, the msgb has already been sent |
| 1230 | * out and is no longer in the wqueue. If it still is in the wqueue, then sending MGCP messages |
| 1231 | * per se is broken and the program should notice so by a full wqueue. Even if this was called |
| 1232 | * before we had a chance to send out the message and it is still going to be sent, we will just |
| 1233 | * ignore the reply to it later. Removing a msgb from the wqueue here would just introduce more |
| 1234 | * bug surface in terms of failing to update wqueue API's counters or some such. |
Neels Hofmeyr | c8f37cb | 2017-11-30 13:43:11 +0100 | [diff] [blame] | 1235 | */ |
| 1236 | } |
| 1237 | |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 1238 | static mgcp_trans_id_t mgcp_client_next_trans_id(struct mgcp_client *mgcp) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1239 | { |
| 1240 | /* avoid zero trans_id to distinguish from unset trans_id */ |
| 1241 | if (!mgcp->next_trans_id) |
| 1242 | mgcp->next_trans_id ++; |
| 1243 | return mgcp->next_trans_id ++; |
| 1244 | } |
| 1245 | |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1246 | #define MGCP_CRCX_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT | \ |
| 1247 | MGCP_MSG_PRESENCE_CALL_ID | \ |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1248 | MGCP_MSG_PRESENCE_CONN_MODE) |
| 1249 | #define MGCP_MDCX_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT | \ |
Philipp Maier | 490cbaa | 2018-01-22 17:32:38 +0100 | [diff] [blame] | 1250 | MGCP_MSG_PRESENCE_CALL_ID | \ |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1251 | MGCP_MSG_PRESENCE_CONN_ID) |
| 1252 | #define MGCP_DLCX_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT) |
| 1253 | #define MGCP_AUEP_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT) |
| 1254 | #define MGCP_RSIP_MANDATORY 0 /* none */ |
| 1255 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1256 | /* Helper function for mgcp_msg_gen(): Add LCO information to MGCP message */ |
| 1257 | static int add_lco(struct msgb *msg, struct mgcp_msg *mgcp_msg) |
| 1258 | { |
| 1259 | unsigned int i; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1260 | const char *codec; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1261 | |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1262 | #define MSGB_PRINTF_OR_RET(FMT, ARGS...) do { \ |
| 1263 | if (msgb_printf(msg, FMT, ##ARGS) != 0) { \ |
| 1264 | LOGP(DLMGCP, LOGL_ERROR, "Message buffer too small, can not generate MGCP/SDP message\n"); \ |
| 1265 | return -ENOBUFS; \ |
| 1266 | } \ |
| 1267 | } while (0) |
| 1268 | |
| 1269 | MSGB_PRINTF_OR_RET("L:"); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1270 | |
| 1271 | if (mgcp_msg->ptime) |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1272 | MSGB_PRINTF_OR_RET(" p:%u,", mgcp_msg->ptime); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1273 | |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1274 | if (mgcp_msg->ptmap_len) { |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1275 | MSGB_PRINTF_OR_RET(" a:"); |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1276 | for (i = 0; i < mgcp_msg->ptmap_len; i++) { |
| 1277 | codec = get_value_string_or_null(osmo_mgcpc_codec_names, mgcp_msg->ptmap[i].codec); |
Pau Espin Pedrol | c12bfb7 | 2019-04-16 17:23:09 +0200 | [diff] [blame] | 1278 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1279 | /* Note: Use codec descriptors from enum mgcp_codecs |
| 1280 | * in mgcp_client only! */ |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1281 | if (!codec) |
Philipp Maier | 7d86d4c | 2021-06-11 15:16:13 +0200 | [diff] [blame] | 1282 | return -EINVAL; |
Philipp Maier | 7d86d4c | 2021-06-11 15:16:13 +0200 | [diff] [blame] | 1283 | |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1284 | MSGB_PRINTF_OR_RET("%s", extract_codec_name(codec)); |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1285 | if (i < mgcp_msg->ptmap_len - 1) |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1286 | MSGB_PRINTF_OR_RET(";"); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1287 | } |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1288 | MSGB_PRINTF_OR_RET(","); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1289 | } |
| 1290 | |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1291 | MSGB_PRINTF_OR_RET(" nt:IN\r\n"); |
Philipp Maier | 7d86d4c | 2021-06-11 15:16:13 +0200 | [diff] [blame] | 1292 | return 0; |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1293 | |
| 1294 | #undef MSGB_PRINTF_OR_RET |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1295 | } |
| 1296 | |
| 1297 | /* Helper function for mgcp_msg_gen(): Add SDP information to MGCP message */ |
| 1298 | static int add_sdp(struct msgb *msg, struct mgcp_msg *mgcp_msg, struct mgcp_client *mgcp) |
| 1299 | { |
| 1300 | unsigned int i; |
Pau Espin Pedrol | 8667d51 | 2020-08-28 19:37:08 +0200 | [diff] [blame] | 1301 | char local_ip[INET6_ADDRSTRLEN]; |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 1302 | int local_ip_family, audio_ip_family; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1303 | const char *codec; |
| 1304 | unsigned int pt; |
| 1305 | |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1306 | #define MSGB_PRINTF_OR_RET(FMT, ARGS...) do { \ |
| 1307 | if (msgb_printf(msg, FMT, ##ARGS) != 0) { \ |
| 1308 | LOGPMGW(mgcp, LOGL_ERROR, "Message buffer too small, can not generate MGCP message (SDP)\n"); \ |
| 1309 | return -ENOBUFS; \ |
| 1310 | } \ |
| 1311 | } while (0) |
| 1312 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1313 | /* Add separator to mark the beginning of the SDP block */ |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1314 | MSGB_PRINTF_OR_RET("\r\n"); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1315 | |
| 1316 | /* Add SDP protocol version */ |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1317 | MSGB_PRINTF_OR_RET("v=0\r\n"); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1318 | |
| 1319 | /* Determine local IP-Address */ |
| 1320 | if (osmo_sock_local_ip(local_ip, mgcp->actual.remote_addr) < 0) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1321 | LOGPMGW(mgcp, LOGL_ERROR, |
| 1322 | "Could not determine local IP-Address!\n"); |
Philipp Maier | 7d86d4c | 2021-06-11 15:16:13 +0200 | [diff] [blame] | 1323 | return -EINVAL; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1324 | } |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 1325 | local_ip_family = osmo_ip_str_type(local_ip); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1326 | if (local_ip_family == AF_UNSPEC) |
Philipp Maier | 7d86d4c | 2021-06-11 15:16:13 +0200 | [diff] [blame] | 1327 | return -EINVAL; |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1328 | |
| 1329 | /* Add owner/creator (SDP) */ |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1330 | MSGB_PRINTF_OR_RET("o=- %x 23 IN IP%c %s\r\n", mgcp_msg->call_id, |
Pau Espin Pedrol | 9dc7359 | 2020-08-28 20:21:55 +0200 | [diff] [blame] | 1331 | local_ip_family == AF_INET6 ? '6' : '4', |
| 1332 | local_ip); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1333 | |
| 1334 | /* Add session name (none) */ |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1335 | MSGB_PRINTF_OR_RET("s=-\r\n"); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1336 | |
Pau Espin Pedrol | a5acaa6 | 2023-11-28 18:28:44 +0100 | [diff] [blame] | 1337 | /* Add RTP address */ |
| 1338 | if (mgcp_msg->presence & MGCP_MSG_PRESENCE_AUDIO_IP) { |
| 1339 | audio_ip_family = osmo_ip_str_type(mgcp_msg->audio_ip); |
| 1340 | if (audio_ip_family == AF_UNSPEC) |
| 1341 | return -EINVAL; |
| 1342 | if (strlen(mgcp_msg->audio_ip) <= 0) { |
| 1343 | LOGPMGW(mgcp, LOGL_ERROR, |
| 1344 | "Empty ip address, can not generate MGCP message\n"); |
| 1345 | return -EINVAL; |
| 1346 | } |
| 1347 | MSGB_PRINTF_OR_RET("c=IN IP%c %s\r\n", |
| 1348 | audio_ip_family == AF_INET6 ? '6' : '4', |
| 1349 | mgcp_msg->audio_ip); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1350 | } |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1351 | |
| 1352 | /* Add time description, active time (SDP) */ |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1353 | MSGB_PRINTF_OR_RET("t=0 0\r\n"); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1354 | |
Pau Espin Pedrol | a5acaa6 | 2023-11-28 18:28:44 +0100 | [diff] [blame] | 1355 | /* Add RTP address port and codecs */ |
| 1356 | if (mgcp_msg->presence & MGCP_MSG_PRESENCE_AUDIO_PORT) { |
| 1357 | if (mgcp_msg->audio_port == 0) { |
| 1358 | LOGPMGW(mgcp, LOGL_ERROR, |
| 1359 | "Invalid port number, can not generate MGCP message\n"); |
| 1360 | return -EINVAL; |
| 1361 | } |
| 1362 | MSGB_PRINTF_OR_RET("m=audio %u RTP/AVP", mgcp_msg->audio_port); |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1363 | for (i = 0; i < mgcp_msg->ptmap_len; i++) |
| 1364 | MSGB_PRINTF_OR_RET(" %u", mgcp_msg->ptmap[i].pt); |
Pau Espin Pedrol | a5acaa6 | 2023-11-28 18:28:44 +0100 | [diff] [blame] | 1365 | MSGB_PRINTF_OR_RET("\r\n"); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1366 | } |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1367 | |
Philipp Maier | 228e591 | 2019-03-05 13:56:59 +0100 | [diff] [blame] | 1368 | /* Add optional codec parameters (fmtp) */ |
| 1369 | if (mgcp_msg->param_present) { |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1370 | for (i = 0; i < mgcp_msg->ptmap_len; i++) { |
Philipp Maier | 228e591 | 2019-03-05 13:56:59 +0100 | [diff] [blame] | 1371 | /* The following is only applicable for AMR */ |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1372 | if (mgcp_msg->ptmap[i].codec != CODEC_AMR_8000_1 |
| 1373 | && mgcp_msg->ptmap[i].codec != CODEC_AMRWB_16000_1) |
Pau Espin Pedrol | f6db465 | 2023-12-05 13:35:41 +0100 | [diff] [blame] | 1374 | continue; |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1375 | pt = mgcp_msg->ptmap[i].pt; |
Philipp Maier | 228e591 | 2019-03-05 13:56:59 +0100 | [diff] [blame] | 1376 | if (mgcp_msg->param.amr_octet_aligned_present && mgcp_msg->param.amr_octet_aligned) |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1377 | MSGB_PRINTF_OR_RET("a=fmtp:%u octet-align=1\r\n", pt); |
Philipp Maier | 228e591 | 2019-03-05 13:56:59 +0100 | [diff] [blame] | 1378 | else if (mgcp_msg->param.amr_octet_aligned_present && !mgcp_msg->param.amr_octet_aligned) |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1379 | MSGB_PRINTF_OR_RET("a=fmtp:%u octet-align=0\r\n", pt); |
Philipp Maier | 228e591 | 2019-03-05 13:56:59 +0100 | [diff] [blame] | 1380 | } |
| 1381 | } |
| 1382 | |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1383 | for (i = 0; i < mgcp_msg->ptmap_len; i++) { |
| 1384 | pt = mgcp_msg->ptmap[i].pt; |
Pau Espin Pedrol | c12bfb7 | 2019-04-16 17:23:09 +0200 | [diff] [blame] | 1385 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1386 | /* Note: Only dynamic payload type from the range 96-127 |
| 1387 | * require to be explained further via rtpmap. All others |
| 1388 | * are implcitly definedby the number in m=audio */ |
| 1389 | if (pt >= 96 && pt <= 127) { |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1390 | codec = get_value_string_or_null(osmo_mgcpc_codec_names, mgcp_msg->ptmap[i].codec); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1391 | |
| 1392 | /* Note: Use codec descriptors from enum mgcp_codecs |
| 1393 | * in mgcp_client only! */ |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1394 | if (!codec) |
Philipp Maier | 7d86d4c | 2021-06-11 15:16:13 +0200 | [diff] [blame] | 1395 | return -EINVAL; |
Pau Espin Pedrol | c12bfb7 | 2019-04-16 17:23:09 +0200 | [diff] [blame] | 1396 | |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1397 | MSGB_PRINTF_OR_RET("a=rtpmap:%u %s\r\n", pt, codec); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1398 | } |
| 1399 | } |
Pau Espin Pedrol | c12bfb7 | 2019-04-16 17:23:09 +0200 | [diff] [blame] | 1400 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1401 | if (mgcp_msg->ptime) |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1402 | MSGB_PRINTF_OR_RET("a=ptime:%u\r\n", mgcp_msg->ptime); |
Philipp Maier | 7d86d4c | 2021-06-11 15:16:13 +0200 | [diff] [blame] | 1403 | |
| 1404 | return 0; |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1405 | #undef MSGB_PRINTF_OR_RET |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1406 | } |
| 1407 | |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1408 | /*! Generate an MGCP message |
| 1409 | * \param[in] mgcp MGCP client descriptor. |
| 1410 | * \param[in] mgcp_msg Message description |
| 1411 | * \returns message buffer on success, NULL on error. */ |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1412 | struct msgb *mgcp_msg_gen(struct mgcp_client *mgcp, struct mgcp_msg *mgcp_msg) |
| 1413 | { |
| 1414 | mgcp_trans_id_t trans_id = mgcp_client_next_trans_id(mgcp); |
| 1415 | uint32_t mandatory_mask; |
| 1416 | struct msgb *msg = msgb_alloc_headroom(4096, 128, "MGCP tx"); |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1417 | bool use_sdp = false; |
Pau Espin Pedrol | 900cd65 | 2019-04-24 22:06:22 +0200 | [diff] [blame] | 1418 | char buf[32]; |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1419 | |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1420 | #define MSGB_PRINTF_OR_RET(FMT, ARGS...) do { \ |
| 1421 | if (msgb_printf(msg, FMT, ##ARGS) != 0) { \ |
| 1422 | LOGPMGW(mgcp, LOGL_ERROR, "Message buffer too small, can not generate MGCP/SDP message\n"); \ |
| 1423 | goto exit_error; \ |
| 1424 | } \ |
| 1425 | } while (0) |
| 1426 | |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1427 | msg->l2h = msg->data; |
| 1428 | msg->cb[MSGB_CB_MGCP_TRANS_ID] = trans_id; |
| 1429 | |
| 1430 | /* Add command verb */ |
| 1431 | switch (mgcp_msg->verb) { |
| 1432 | case MGCP_VERB_CRCX: |
| 1433 | mandatory_mask = MGCP_CRCX_MANDATORY; |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1434 | MSGB_PRINTF_OR_RET("CRCX %u", trans_id); |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1435 | break; |
| 1436 | case MGCP_VERB_MDCX: |
| 1437 | mandatory_mask = MGCP_MDCX_MANDATORY; |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1438 | MSGB_PRINTF_OR_RET("MDCX %u", trans_id); |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1439 | break; |
| 1440 | case MGCP_VERB_DLCX: |
| 1441 | mandatory_mask = MGCP_DLCX_MANDATORY; |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1442 | MSGB_PRINTF_OR_RET("DLCX %u", trans_id); |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1443 | break; |
| 1444 | case MGCP_VERB_AUEP: |
| 1445 | mandatory_mask = MGCP_AUEP_MANDATORY; |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1446 | MSGB_PRINTF_OR_RET("AUEP %u", trans_id); |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1447 | break; |
| 1448 | case MGCP_VERB_RSIP: |
| 1449 | mandatory_mask = MGCP_RSIP_MANDATORY; |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1450 | MSGB_PRINTF_OR_RET("RSIP %u", trans_id); |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1451 | break; |
| 1452 | default: |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1453 | LOGPMGW(mgcp, LOGL_ERROR, "Invalid command verb, can not generate MGCP message\n"); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1454 | goto exit_error; |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1455 | } |
| 1456 | |
| 1457 | /* Check if mandatory fields are missing */ |
| 1458 | if (!((mgcp_msg->presence & mandatory_mask) == mandatory_mask)) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1459 | LOGPMGW(mgcp, LOGL_ERROR, |
| 1460 | "One or more missing mandatory fields, can not generate MGCP message\n"); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1461 | goto exit_error; |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1462 | } |
| 1463 | |
| 1464 | /* Add endpoint name */ |
Philipp Maier | 7bc5552 | 2017-12-10 22:52:22 +0100 | [diff] [blame] | 1465 | if (mgcp_msg->presence & MGCP_MSG_PRESENCE_ENDPOINT) { |
| 1466 | if (strlen(mgcp_msg->endpoint) <= 0) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1467 | LOGPMGW(mgcp, LOGL_ERROR, "Empty endpoint name, can not generate MGCP message\n"); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1468 | goto exit_error; |
Philipp Maier | 7bc5552 | 2017-12-10 22:52:22 +0100 | [diff] [blame] | 1469 | } |
Philipp Maier | 3aa8157 | 2018-01-31 14:13:45 +0100 | [diff] [blame] | 1470 | |
| 1471 | if (strstr(mgcp_msg->endpoint, "@") == NULL) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1472 | LOGPMGW(mgcp, LOGL_ERROR, |
| 1473 | "Endpoint name (%s) lacks separator (@), can not generate MGCP message\n", |
| 1474 | mgcp_msg->endpoint); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1475 | goto exit_error; |
Philipp Maier | 3aa8157 | 2018-01-31 14:13:45 +0100 | [diff] [blame] | 1476 | } |
| 1477 | |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1478 | MSGB_PRINTF_OR_RET(" %s", mgcp_msg->endpoint); |
Philipp Maier | 7bc5552 | 2017-12-10 22:52:22 +0100 | [diff] [blame] | 1479 | } |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1480 | |
| 1481 | /* Add protocol version */ |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1482 | MSGB_PRINTF_OR_RET(" MGCP 1.0\r\n"); |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1483 | |
| 1484 | /* Add call id */ |
| 1485 | if (mgcp_msg->presence & MGCP_MSG_PRESENCE_CALL_ID) |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1486 | MSGB_PRINTF_OR_RET("C: %x\r\n", mgcp_msg->call_id); |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1487 | |
| 1488 | /* Add connection id */ |
Philipp Maier | 7bc5552 | 2017-12-10 22:52:22 +0100 | [diff] [blame] | 1489 | if (mgcp_msg->presence & MGCP_MSG_PRESENCE_CONN_ID) { |
| 1490 | if (strlen(mgcp_msg->conn_id) <= 0) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1491 | LOGPMGW(mgcp, LOGL_ERROR, "Empty connection id, can not generate MGCP message\n"); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1492 | goto exit_error; |
Philipp Maier | 7bc5552 | 2017-12-10 22:52:22 +0100 | [diff] [blame] | 1493 | } |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1494 | MSGB_PRINTF_OR_RET("I: %s\r\n", mgcp_msg->conn_id); |
Philipp Maier | 7bc5552 | 2017-12-10 22:52:22 +0100 | [diff] [blame] | 1495 | } |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1496 | |
Pau Espin Pedrol | a5acaa6 | 2023-11-28 18:28:44 +0100 | [diff] [blame] | 1497 | /* Using SDP makes sense when a valid IP or Port is specified, |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1498 | * if we do not know this information yet, we fall back to LCO */ |
| 1499 | if (mgcp_msg->presence & MGCP_MSG_PRESENCE_AUDIO_IP |
Pau Espin Pedrol | a5acaa6 | 2023-11-28 18:28:44 +0100 | [diff] [blame] | 1500 | || mgcp_msg->presence & MGCP_MSG_PRESENCE_AUDIO_PORT) |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1501 | use_sdp = true; |
| 1502 | |
| 1503 | /* Add local connection options (LCO) */ |
| 1504 | if (!use_sdp |
| 1505 | && (mgcp_msg->verb == MGCP_VERB_CRCX |
Philipp Maier | 7d86d4c | 2021-06-11 15:16:13 +0200 | [diff] [blame] | 1506 | || mgcp_msg->verb == MGCP_VERB_MDCX)) { |
Oliver Smith | 0dbaaad | 2023-02-22 16:30:02 +0100 | [diff] [blame] | 1507 | if (add_lco(msg, mgcp_msg) < 0) { |
| 1508 | LOGPMGW(mgcp, LOGL_ERROR, "Failed to add LCO, can not generate MGCP message\n"); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1509 | goto exit_error; |
Oliver Smith | 0dbaaad | 2023-02-22 16:30:02 +0100 | [diff] [blame] | 1510 | } |
Philipp Maier | 7d86d4c | 2021-06-11 15:16:13 +0200 | [diff] [blame] | 1511 | } |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1512 | |
| 1513 | /* Add mode */ |
| 1514 | if (mgcp_msg->presence & MGCP_MSG_PRESENCE_CONN_MODE) |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1515 | MSGB_PRINTF_OR_RET("M: %s\r\n", mgcp_client_cmode_name(mgcp_msg->conn_mode)); |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1516 | |
Neels Hofmeyr | e6d8e91 | 2018-08-23 16:36:48 +0200 | [diff] [blame] | 1517 | /* Add X-Osmo-IGN */ |
| 1518 | if ((mgcp_msg->presence & MGCP_MSG_PRESENCE_X_OSMO_IGN) |
| 1519 | && (mgcp_msg->x_osmo_ign != 0)) |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1520 | MSGB_PRINTF_OR_RET(MGCP_X_OSMO_IGN_HEADER "%s\r\n", |
| 1521 | mgcp_msg->x_osmo_ign & MGCP_X_OSMO_IGN_CALLID ? " C" : ""); |
Neels Hofmeyr | e6d8e91 | 2018-08-23 16:36:48 +0200 | [diff] [blame] | 1522 | |
Pau Espin Pedrol | 900cd65 | 2019-04-24 22:06:22 +0200 | [diff] [blame] | 1523 | /* Add X-Osmo-Osmux */ |
| 1524 | if ((mgcp_msg->presence & MGCP_MSG_PRESENCE_X_OSMO_OSMUX_CID)) { |
Pau Espin Pedrol | 1b1d7ed | 2019-05-23 16:48:24 +0200 | [diff] [blame] | 1525 | if (mgcp_msg->x_osmo_osmux_cid < -1 || mgcp_msg->x_osmo_osmux_cid > OSMUX_CID_MAX) { |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1526 | LOGPMGW(mgcp, LOGL_ERROR, "Wrong Osmux CID %d, can not generate MGCP message\n", |
| 1527 | mgcp_msg->x_osmo_osmux_cid); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1528 | goto exit_error; |
Pau Espin Pedrol | 1b1d7ed | 2019-05-23 16:48:24 +0200 | [diff] [blame] | 1529 | } |
Pau Espin Pedrol | 900cd65 | 2019-04-24 22:06:22 +0200 | [diff] [blame] | 1530 | snprintf(buf, sizeof(buf), " %d", mgcp_msg->x_osmo_osmux_cid); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1531 | MSGB_PRINTF_OR_RET(MGCP_X_OSMO_OSMUX_HEADER "%s\r\n", |
| 1532 | mgcp_msg->x_osmo_osmux_cid == -1 ? " *" : buf); |
Pau Espin Pedrol | 900cd65 | 2019-04-24 22:06:22 +0200 | [diff] [blame] | 1533 | } |
| 1534 | |
| 1535 | |
Philipp Maier | 704c4f0 | 2018-06-07 18:51:31 +0200 | [diff] [blame] | 1536 | /* Add session description protocol (SDP) */ |
| 1537 | if (use_sdp |
| 1538 | && (mgcp_msg->verb == MGCP_VERB_CRCX |
| 1539 | || mgcp_msg->verb == MGCP_VERB_MDCX)) { |
Oliver Smith | 0dbaaad | 2023-02-22 16:30:02 +0100 | [diff] [blame] | 1540 | if (add_sdp(msg, mgcp_msg, mgcp) < 0) { |
| 1541 | LOGPMGW(mgcp, LOGL_ERROR, "Failed to add SDP, can not generate MGCP message\n"); |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1542 | goto exit_error; |
Oliver Smith | 0dbaaad | 2023-02-22 16:30:02 +0100 | [diff] [blame] | 1543 | } |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1544 | } |
| 1545 | |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1546 | return msg; |
Neels Hofmeyr | 45fe47c | 2023-03-30 16:53:13 +0200 | [diff] [blame] | 1547 | |
| 1548 | exit_error: |
| 1549 | msgb_free(msg); |
| 1550 | return NULL; |
| 1551 | #undef MSGB_PRINTF_OR_RET |
Philipp Maier | 1dc6be6 | 2017-10-05 18:25:37 +0200 | [diff] [blame] | 1552 | } |
| 1553 | |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1554 | /*! Retrieve the MGCP transaction ID from a msgb generated by mgcp_msg_gen() |
| 1555 | * \param[in] msg message buffer |
| 1556 | * \returns Transaction id. */ |
Neels Hofmeyr | c8f37cb | 2017-11-30 13:43:11 +0100 | [diff] [blame] | 1557 | mgcp_trans_id_t mgcp_msg_trans_id(struct msgb *msg) |
| 1558 | { |
| 1559 | return (mgcp_trans_id_t)msg->cb[MSGB_CB_MGCP_TRANS_ID]; |
| 1560 | } |
| 1561 | |
Philipp Maier | fa495d6 | 2021-09-02 10:08:56 +0200 | [diff] [blame] | 1562 | /*! Get the configuration parameters for a given MGCP client instance |
Philipp Maier | 275ac97 | 2018-01-20 00:58:16 +0100 | [diff] [blame] | 1563 | * \param[in] mgcp MGCP client descriptor. |
| 1564 | * \returns configuration */ |
Neels Hofmeyr | 3a8e723 | 2017-09-04 01:02:56 +0200 | [diff] [blame] | 1565 | struct mgcp_client_conf *mgcp_client_conf_actual(struct mgcp_client *mgcp) |
Neels Hofmeyr | e9920f2 | 2017-07-10 15:07:22 +0200 | [diff] [blame] | 1566 | { |
| 1567 | return &mgcp->actual; |
| 1568 | } |
Neels Hofmeyr | d95ab1e | 2017-09-22 00:52:54 +0200 | [diff] [blame] | 1569 | |
| 1570 | const struct value_string mgcp_client_connection_mode_strs[] = { |
| 1571 | { MGCP_CONN_NONE, "none" }, |
| 1572 | { MGCP_CONN_RECV_SEND, "sendrecv" }, |
| 1573 | { MGCP_CONN_SEND_ONLY, "sendonly" }, |
| 1574 | { MGCP_CONN_RECV_ONLY, "recvonly" }, |
Andreas Eversberg | dc7dfd0 | 2023-07-05 12:36:49 +0200 | [diff] [blame] | 1575 | { MGCP_CONN_CONFECHO, "confecho" }, |
Neels Hofmeyr | d95ab1e | 2017-09-22 00:52:54 +0200 | [diff] [blame] | 1576 | { MGCP_CONN_LOOPBACK, "loopback" }, |
| 1577 | { 0, NULL } |
| 1578 | }; |
Philipp Maier | df9192e | 2021-09-03 17:50:51 +0200 | [diff] [blame] | 1579 | |
| 1580 | /*! Get MGCP client instance name (VTY). |
| 1581 | * \param[in] mgcp MGCP client descriptor. |
| 1582 | * \returns MGCP client name. |
| 1583 | * |
| 1584 | * The user can only modify the name of an MGCP client instance when it is |
| 1585 | * part of a pool. For single MGCP client instances and MGCP client instance |
| 1586 | * where no description is set via the VTY, the MGW domain name will be used |
| 1587 | * as name. */ |
| 1588 | const char *mgcp_client_name(const struct mgcp_client *mgcp) |
| 1589 | { |
| 1590 | if (!mgcp) |
| 1591 | return "(null)"; |
| 1592 | |
| 1593 | if (mgcp->actual.description) |
| 1594 | return mgcp->actual.description; |
| 1595 | else |
| 1596 | return mgcp_client_endpoint_domain(mgcp); |
| 1597 | } |
Neels Hofmeyr | cc2f793 | 2023-12-07 03:46:46 +0100 | [diff] [blame^] | 1598 | |
| 1599 | /*! Return typical cmp result, comparing a to b. |
| 1600 | * Return 0 if a == b, -1 if a < b, 1 if a > b; comparing all members of ptmap in turn. */ |
| 1601 | int ptmap_cmp(const struct ptmap *a, const struct ptmap *b) |
| 1602 | { |
| 1603 | int rc; |
| 1604 | if (a == b) |
| 1605 | return 0; |
| 1606 | if (!a) |
| 1607 | return -1; |
| 1608 | if (!b) |
| 1609 | return 1; |
| 1610 | rc = OSMO_CMP(a->codec, b->codec); |
| 1611 | if (rc) |
| 1612 | return rc; |
| 1613 | return OSMO_CMP(a->pt, b->pt); |
| 1614 | } |