blob: 75c7b14f589ed2f5824e609c37b41dc544a2b2e8 [file] [log] [blame]
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001/* 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 Welte220f4872018-02-04 09:04:16 +01007 * 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 Hofmeyre9920f22017-07-10 15:07:22 +02009 * (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 Welte220f4872018-02-04 09:04:16 +010014 * GNU General Public License for more details.
Neels Hofmeyre9920f22017-07-10 15:07:22 +020015 *
Harald Welte220f4872018-02-04 09:04:16 +010016 * You should have received a copy of the GNU General Public License
Neels Hofmeyre9920f22017-07-10 15:07:22 +020017 * 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 Maier1dc6be62017-10-05 18:25:37 +020026#include <osmocom/core/byteswap.h>
Harald Welte8890dfa2017-11-17 15:09:30 +010027#include <osmocom/core/socket.h>
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +020028#include <osmocom/core/sockaddr_str.h>
Neels Hofmeyre9920f22017-07-10 15:07:22 +020029
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +020030#include <osmocom/mgcp_client/mgcp_client.h>
31#include <osmocom/mgcp_client/mgcp_client_internal.h>
Neels Hofmeyre9920f22017-07-10 15:07:22 +020032
Philipp Maier92a73cd2020-11-26 22:21:11 +010033#include <osmocom/abis/e1_input.h>
34
Neels Hofmeyre9920f22017-07-10 15:07:22 +020035#include <netinet/in.h>
36#include <arpa/inet.h>
37
38#include <errno.h>
39#include <unistd.h>
40#include <string.h>
Pau Espin Pedrol166077e2019-06-26 12:21:38 +020041#include <ctype.h>
Pau Espin Pedrolc5c14302019-07-23 16:19:41 +020042#include <stdlib.h>
43#include <limits.h>
Neels Hofmeyre9920f22017-07-10 15:07:22 +020044
Pau Espin Pedrol1b1d7ed2019-05-23 16:48:24 +020045#ifndef OSMUX_CID_MAX
46#define OSMUX_CID_MAX 255 /* FIXME: use OSMUX_CID_MAX from libosmo-netif? */
47#endif
48
Philipp Maierdf9192e2021-09-03 17:50:51 +020049#define LOGPMGW(mgcp, level, fmt, args...) \
50LOGP(DLMGCP, level, "MGW(%s) " fmt, mgcp_client_name(mgcp), ## args)
51
Philipp Maier704c4f02018-06-07 18:51:31 +020052/* Codec descripton for dynamic payload types (SDP) */
Neels Hofmeyr47642f22019-02-27 05:56:53 +010053const struct value_string osmo_mgcpc_codec_names[] = {
Philipp Maier704c4f02018-06-07 18:51:31 +020054 { 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 Maier1de5ed62021-12-21 14:38:14 +010062 { CODEC_IUFP, "VND.3GPP.IUFP/16000" },
Oliver Smith26d6b2b2023-01-24 13:04:47 +010063 { CODEC_CLEARMODE, "CLEARMODE/8000" },
Philipp Maier704c4f02018-06-07 18:51:31 +020064 { 0, NULL },
65};
66
67/* Get encoding name from a full codec string e,g.
68 * ("CODEC/8000/2" => returns "CODEC") */
69static char *extract_codec_name(const char *str)
70{
71 static char buf[64];
72 unsigned int i;
73
74 if (!str)
75 return NULL;
76
Philipp Maier704c4f02018-06-07 18:51:31 +020077 osmo_strlcpy(buf, str, sizeof(buf));
78
79 for (i = 0; i < strlen(buf); i++) {
80 if (buf[i] == '/')
81 buf[i] = '\0';
82 }
83
84 return buf;
85}
86
87/*! Map a string to a codec.
88 * \ptmap[in] str input string (e.g "GSM/8000/1", "GSM/8000" or "GSM")
89 * \returns codec that corresponds to the given string representation. */
90enum mgcp_codecs map_str_to_codec(const char *str)
91{
92 unsigned int i;
93 char *codec_name;
94 char str_buf[64];
95
96 osmo_strlcpy(str_buf, extract_codec_name(str), sizeof(str_buf));
97
Neels Hofmeyr47642f22019-02-27 05:56:53 +010098 for (i = 0; i < ARRAY_SIZE(osmo_mgcpc_codec_names); i++) {
99 codec_name = extract_codec_name(osmo_mgcpc_codec_names[i].str);
Philipp Maier704c4f02018-06-07 18:51:31 +0200100 if (!codec_name)
101 continue;
102 if (strcmp(codec_name, str_buf) == 0)
Neels Hofmeyr47642f22019-02-27 05:56:53 +0100103 return osmo_mgcpc_codec_names[i].value;
Philipp Maier704c4f02018-06-07 18:51:31 +0200104 }
105
106 return -1;
107}
108
109/* Check the ptmap for illegal mappings */
Neels Hofmeyr84274e42019-04-27 19:08:36 +0200110static int check_ptmap(const struct ptmap *ptmap)
Philipp Maier704c4f02018-06-07 18:51:31 +0200111{
112 /* Check if there are mappings that leave the IANA assigned dynamic
113 * payload type range. Under normal conditions such mappings should
114 * not occur */
115
116 /* Its ok to have a 1:1 mapping in the statically defined
117 * range, this won't hurt */
118 if (ptmap->codec == ptmap->pt)
119 return 0;
120
121 if (ptmap->codec < 96 || ptmap->codec > 127)
122 goto error;
123 if (ptmap->pt < 96 || ptmap->pt > 127)
124 goto error;
125
126 return 0;
127error:
128 LOGP(DLMGCP, LOGL_ERROR,
129 "ptmap contains illegal mapping: codec=%u maps to pt=%u\n",
130 ptmap->codec, ptmap->pt);
131 return -1;
132}
133
134/*! Map a codec to a payload type.
135 * \ptmap[in] payload pointer to payload type map with specified payload types.
136 * \ptmap[in] ptmap_len length of the payload type map.
137 * \ptmap[in] codec the codec for which the payload type should be looked up.
138 * \returns assigned payload type */
Neels Hofmeyr84274e42019-04-27 19:08:36 +0200139unsigned int map_codec_to_pt(const struct ptmap *ptmap, unsigned int ptmap_len,
Philipp Maier704c4f02018-06-07 18:51:31 +0200140 enum mgcp_codecs codec)
141{
142 unsigned int i;
143
144 /*! Note: If the payload type map is empty or the codec is not found
145 * in the map, then a 1:1 mapping is performed. If the codec falls
146 * into the statically defined range or if the mapping table isself
147 * tries to map to the statically defined range, then the mapping
148 * is also ignored and a 1:1 mapping is performed instead. */
149
150 /* we may return the codec directly since enum mgcp_codecs directly
Oliver Smith292ba1b2023-06-28 10:30:25 +0200151 * corresponds to the statically assigned payload types */
Philipp Maier704c4f02018-06-07 18:51:31 +0200152 if (codec < 96 || codec > 127)
153 return codec;
154
155 for (i = 0; i < ptmap_len; i++) {
156 /* Skip illegal map entries */
157 if (check_ptmap(ptmap) == 0 && ptmap->codec == codec)
158 return ptmap->pt;
159 ptmap++;
160 }
161
162 /* If nothing is found, do not perform any mapping */
163 return codec;
164}
165
166/*! Map a payload type to a codec.
167 * \ptmap[in] payload pointer to payload type map with specified payload types.
168 * \ptmap[in] ptmap_len length of the payload type map.
169 * \ptmap[in] payload type for which the codec should be looked up.
170 * \returns codec that corresponds to the specified payload type */
171enum mgcp_codecs map_pt_to_codec(struct ptmap *ptmap, unsigned int ptmap_len,
172 unsigned int pt)
173{
174 unsigned int i;
175
176 /*! Note: If the payload type map is empty or the payload type is not
177 * found in the map, then a 1:1 mapping is performed. If the payload
178 * type falls into the statically defined range or if the mapping
179 * table isself tries to map to the statically defined range, then
180 * the mapping is also ignored and a 1:1 mapping is performed
181 * instead. */
182
183 /* See also note in map_codec_to_pt() */
184 if (pt < 96 || pt > 127)
185 return pt;
186
187 for (i = 0; i < ptmap_len; i++) {
188 if (check_ptmap(ptmap) == 0 && ptmap->pt == pt)
189 return ptmap->codec;
190 ptmap++;
191 }
192
193 /* If nothing is found, do not perform any mapping */
194 return pt;
195}
196
Pau Espin Pedrol8e8d59f2023-06-13 19:41:44 +0200197static void _mgcp_client_conf_init(struct mgcp_client_conf *conf)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200198{
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200199 /* NULL and -1 default to MGCP_CLIENT_*_DEFAULT values */
200 *conf = (struct mgcp_client_conf){
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200201 .local_addr = NULL,
202 .local_port = -1,
203 .remote_addr = NULL,
204 .remote_port = -1,
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200205 .keepalive = {
206 .timeout_sec = 0, /* disabled */
207 .req_interval_sec = 0, /* disabled */
208 .req_endpoint_name = MGCP_CLIENT_KEEPALIVE_DEFAULT_ENDP,
209 },
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200210 };
Philipp Maier3f2c15f2021-07-22 11:53:07 +0200211
212 INIT_LLIST_HEAD(&conf->reset_epnames);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200213}
214
Pau Espin Pedrol8e8d59f2023-06-13 19:41:44 +0200215/*! Allocate and initialize MGCP client configuration struct with default values.
216 * \param[in] ctx talloc context to use as a parent during allocation.
217 *
218 * The returned struct can be freed using talloc_free().
219 */
220struct mgcp_client_conf *mgcp_client_conf_alloc(void *ctx)
221{
222 struct mgcp_client_conf *conf = talloc(ctx, struct mgcp_client_conf);
223 _mgcp_client_conf_init(conf);
224 return conf;
225}
226
227/*! Initialize MGCP client configuration struct with default values.
228 * \param[out] conf Client configuration.
229 *
230 * This function is deprecated and should not be used, as it may break if size
231 * of struct mgcp_client_conf changes in the future!
232 */
233void mgcp_client_conf_init(struct mgcp_client_conf *conf)
234{
235 _mgcp_client_conf_init(conf);
236}
237
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200238static void mgcp_client_handle_response(struct mgcp_client *mgcp,
239 struct mgcp_response_pending *pending,
240 struct mgcp_response *response)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200241{
242 if (!pending) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200243 LOGPMGW(mgcp, LOGL_ERROR, "Cannot handle NULL response\n");
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200244 return;
245 }
246 if (pending->response_cb)
247 pending->response_cb(response, pending->priv);
248 else
Philipp Maierdf9192e2021-09-03 17:50:51 +0200249 LOGPMGW(mgcp, LOGL_DEBUG, "MGCP response ignored (NULL cb)\n");
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200250 talloc_free(pending);
251}
252
253static int mgcp_response_parse_head(struct mgcp_response *r, struct msgb *msg)
254{
255 int comment_pos;
256 char *end;
257
258 if (mgcp_msg_terminate_nul(msg))
259 goto response_parse_failure;
260
261 r->body = (char *)msg->data;
262
Harald Welte9bf7c532017-11-17 14:14:31 +0100263 if (sscanf(r->body, "%3d %u %n",
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200264 &r->head.response_code, &r->head.trans_id,
265 &comment_pos) != 2)
266 goto response_parse_failure;
267
Philipp Maierabe8c892018-01-20 00:15:12 +0100268 osmo_strlcpy(r->head.comment, r->body + comment_pos, sizeof(r->head.comment));
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200269 end = strchr(r->head.comment, '\r');
270 if (!end)
271 goto response_parse_failure;
272 /* Mark the end of the comment */
273 *end = '\0';
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200274 return 0;
275
276response_parse_failure:
277 LOGP(DLMGCP, LOGL_ERROR,
278 "Failed to parse MGCP response header\n");
279 return -EINVAL;
280}
281
282/* TODO undup against mgcp_protocol.c:mgcp_check_param() */
283static bool mgcp_line_is_valid(const char *line)
284{
285 const size_t line_len = strlen(line);
286 if (line[0] == '\0')
287 return true;
288
289 if (line_len < 2
290 || line[1] != '=') {
291 LOGP(DLMGCP, LOGL_ERROR,
292 "Wrong MGCP option format: '%s'\n",
293 line);
294 return false;
295 }
296
297 return true;
298}
299
Philipp Maier704c4f02018-06-07 18:51:31 +0200300/* Parse a line like "m=audio 16002 RTP/AVP 98", extract port and payload types */
301static int mgcp_parse_audio_port_pt(struct mgcp_response *r, char *line)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200302{
Philipp Maier704c4f02018-06-07 18:51:31 +0200303 char *pt_str;
Pau Espin Pedrolc5c14302019-07-23 16:19:41 +0200304 char *pt_end;
Pau Espin Pedrola2b1c5e2019-07-26 14:13:14 +0200305 unsigned long int pt;
Philipp Maier704c4f02018-06-07 18:51:31 +0200306 unsigned int count = 0;
307 unsigned int i;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200308
Philipp Maier704c4f02018-06-07 18:51:31 +0200309 /* Extract port information */
310 if (sscanf(line, "m=audio %hu", &r->audio_port) != 1)
311 goto response_parse_failure_port;
Philipp Maier10f32db2017-12-13 12:34:34 +0100312 if (r->audio_port == 0)
Philipp Maier704c4f02018-06-07 18:51:31 +0200313 goto response_parse_failure_port;
Philipp Maier10f32db2017-12-13 12:34:34 +0100314
Philipp Maier704c4f02018-06-07 18:51:31 +0200315 /* Extract payload types */
316 line = strstr(line, "RTP/AVP ");
317 if (!line)
318 goto exit;
319
320 pt_str = strtok(line, " ");
321 while (1) {
322 /* Do not allow excessive payload types */
323 if (count > ARRAY_SIZE(r->codecs))
324 goto response_parse_failure_pt;
325
326 pt_str = strtok(NULL, " ");
327 if (!pt_str)
328 break;
Pau Espin Pedrolc5c14302019-07-23 16:19:41 +0200329 errno = 0;
330 pt = strtoul(pt_str, &pt_end, 0);
331 if ((errno == ERANGE && pt == ULONG_MAX) || (errno && !pt) ||
332 pt_str == pt_end)
333 goto response_parse_failure_pt;
Philipp Maier704c4f02018-06-07 18:51:31 +0200334
Pau Espin Pedrola2b1c5e2019-07-26 14:13:14 +0200335 if (pt >> 7) /* PT is 7 bit field, higher values not allowed */
336 goto response_parse_failure_pt;
337
Philipp Maier704c4f02018-06-07 18:51:31 +0200338 /* Do not allow duplicate payload types */
339 for (i = 0; i < count; i++)
340 if (r->codecs[i] == pt)
341 goto response_parse_failure_pt;
342
343 /* Note: The payload type we store may not necessarly match
344 * the codec types we have defined in enum mgcp_codecs. To
345 * ensure that the end result only contains codec types which
346 * match enum mgcp_codecs, we will go through afterwards and
347 * remap the affected entries with the inrofmation we learn
348 * from rtpmap */
349 r->codecs[count] = pt;
350 count++;
351 }
352
353 r->codecs_len = count;
354
355exit:
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200356 return 0;
357
Philipp Maier704c4f02018-06-07 18:51:31 +0200358response_parse_failure_port:
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200359 LOGP(DLMGCP, LOGL_ERROR,
Philipp Maier704c4f02018-06-07 18:51:31 +0200360 "Failed to parse SDP parameter port (%s)\n", line);
Philipp Maier06da85e2017-10-05 18:49:24 +0200361 return -EINVAL;
Philipp Maier704c4f02018-06-07 18:51:31 +0200362
363response_parse_failure_pt:
364 LOGP(DLMGCP, LOGL_ERROR,
365 "Failed to parse SDP parameter payload types (%s)\n", line);
366 return -EINVAL;
367}
368
369/* Parse a line like "m=audio 16002 RTP/AVP 98", extract port and payload types */
370static int mgcp_parse_audio_ptime_rtpmap(struct mgcp_response *r, const char *line)
371{
372 unsigned int pt;
373 char codec_resp[64];
Oliver Smith94238172023-06-28 13:28:57 +0200374 int rc;
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +0200375
Neels Hofmeyr23f40482019-08-08 04:03:42 +0200376#define A_PTIME "a=ptime:"
377#define A_RTPMAP "a=rtpmap:"
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +0200378
Neels Hofmeyr23f40482019-08-08 04:03:42 +0200379 if (osmo_str_startswith(line, A_PTIME)) {
380 if (sscanf(line, A_PTIME "%u", &r->ptime) != 1) {
381 LOGP(DLMGCP, LOGL_ERROR,
382 "Failed to parse SDP parameter, invalid ptime (%s)\n", line);
383 return -EINVAL;
384 }
385 } else if (osmo_str_startswith(line, A_RTPMAP)) {
386 if (sscanf(line, A_RTPMAP "%d %63s", &pt, codec_resp) != 2) {
387 LOGP(DLMGCP, LOGL_ERROR,
388 "Failed to parse SDP parameter, invalid rtpmap: %s\n", osmo_quote_str(line, -1));
389 return -EINVAL;
390 }
Neels Hofmeyr3ab8ca42019-08-08 04:03:42 +0200391 if (r->ptmap_len >= ARRAY_SIZE(r->ptmap)) {
392 LOGP(DLMGCP, LOGL_ERROR, "No more space in ptmap array (len=%u)\n", r->ptmap_len);
393 return -ENOSPC;
Neels Hofmeyr23f40482019-08-08 04:03:42 +0200394 }
Oliver Smith94238172023-06-28 13:28:57 +0200395 rc = map_str_to_codec(codec_resp);
396 if (rc < 0) {
397 LOGP(DLMGCP, LOGL_ERROR,
398 "Failed to parse SDP parameter, can't parse codec in rtpmap: %s\n", osmo_quote_str(line, -1));
399 return -EINVAL;
400 }
Neels Hofmeyr3ab8ca42019-08-08 04:03:42 +0200401 r->ptmap[r->ptmap_len].pt = pt;
Oliver Smith94238172023-06-28 13:28:57 +0200402 r->ptmap[r->ptmap_len].codec = rc;
Neels Hofmeyr3ab8ca42019-08-08 04:03:42 +0200403 r->ptmap_len++;
Philipp Maier704c4f02018-06-07 18:51:31 +0200404 }
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +0200405
Philipp Maier704c4f02018-06-07 18:51:31 +0200406 return 0;
Philipp Maier06da85e2017-10-05 18:49:24 +0200407}
408
409/* Parse a line like "c=IN IP4 10.11.12.13" */
410static int mgcp_parse_audio_ip(struct mgcp_response *r, const char *line)
411{
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +0200412 struct in6_addr ip_test;
413 bool is_ipv6;
Philipp Maier06da85e2017-10-05 18:49:24 +0200414
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +0200415 if (strncmp("c=IN IP", line, 7) != 0)
Philipp Maier06da85e2017-10-05 18:49:24 +0200416 goto response_parse_failure;
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +0200417 line += 7;
418 if (*line == '6')
419 is_ipv6 = true;
420 else if (*line == '4')
421 is_ipv6 = false;
422 else
Philipp Maier06da85e2017-10-05 18:49:24 +0200423 goto response_parse_failure;
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +0200424 line++;
425 if (*line != ' ')
Philipp Maier06da85e2017-10-05 18:49:24 +0200426 goto response_parse_failure;
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +0200427 line++;
Philipp Maier06da85e2017-10-05 18:49:24 +0200428
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +0200429 /* Extract and check IP-Address */
430 if (is_ipv6) {
431 /* 45 = INET6_ADDRSTRLEN -1 */
432 if (sscanf(line, "%45s", r->audio_ip) != 1)
433 goto response_parse_failure;
434 if (inet_pton(AF_INET6, r->audio_ip, &ip_test) != 1)
435 goto response_parse_failure;
436 } else {
437 /* 15 = INET_ADDRSTRLEN -1 */
438 if (sscanf(line, "%15s", r->audio_ip) != 1)
439 goto response_parse_failure;
440 if (inet_pton(AF_INET, r->audio_ip, &ip_test) != 1)
441 goto response_parse_failure;
442 }
Philipp Maier06da85e2017-10-05 18:49:24 +0200443 return 0;
444
445response_parse_failure:
446 LOGP(DLMGCP, LOGL_ERROR,
447 "Failed to parse MGCP response header (audio ip)\n");
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200448 return -EINVAL;
449}
450
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200451/*! Extract OSMUX CID from an MGCP parameter line (string).
452 * \param[in] line single parameter line from the MGCP message
453 * \returns OSMUX CID, -1 wildcard, -2 on error
454 * FIXME: This is a copy of function in mgcp_msg.c. Have some common.c file between both libs?
455 */
456static int mgcp_parse_osmux_cid(const char *line)
457{
458 int osmux_cid;
459
460
Pau Espin Pedrolc1bf4692019-05-14 16:23:24 +0200461 if (strcasecmp(line + 2, "Osmux: *") == 0) {
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200462 LOGP(DLMGCP, LOGL_DEBUG, "Parsed wilcard Osmux CID\n");
463 return -1;
464 }
465
Pau Espin Pedrolc1bf4692019-05-14 16:23:24 +0200466 if (sscanf(line + 2 + 7, "%u", &osmux_cid) != 1) {
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200467 LOGP(DLMGCP, LOGL_ERROR, "Failed parsing Osmux in MGCP msg line: %s\n",
468 line);
469 return -2;
470 }
471
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200472 if (osmux_cid > OSMUX_CID_MAX) { /* OSMUX_CID_MAX from libosmo-netif */
473 LOGP(DLMGCP, LOGL_ERROR, "Osmux ID too large: %u > %u\n",
474 osmux_cid, OSMUX_CID_MAX);
475 return -2;
476 }
Pau Espin Pedrolc7c8e642022-10-06 18:24:21 +0200477 LOGP(DLMGCP, LOGL_DEBUG, "MGW offered Osmux CID %u\n", osmux_cid);
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200478
479 return osmux_cid;
480}
481
Philipp Maier3b12e1b2018-01-18 15:16:13 +0100482/* A new section is marked by a double line break, check a few more
483 * patterns as there may be variants */
484static char *mgcp_find_section_end(char *string)
485{
486 char *rc;
487
488 rc = strstr(string, "\n\n");
489 if (rc)
Neels Hofmeyrce356ee2023-03-30 16:51:40 +0200490 return rc + 2;
Philipp Maier3b12e1b2018-01-18 15:16:13 +0100491
492 rc = strstr(string, "\n\r\n\r");
493 if (rc)
Neels Hofmeyrce356ee2023-03-30 16:51:40 +0200494 return rc + 4;
Philipp Maier3b12e1b2018-01-18 15:16:13 +0100495
496 rc = strstr(string, "\r\n\r\n");
497 if (rc)
Neels Hofmeyrce356ee2023-03-30 16:51:40 +0200498 return rc + 4;
Philipp Maier3b12e1b2018-01-18 15:16:13 +0100499
500 return NULL;
501}
502
Philipp Maier275ac972018-01-20 00:58:16 +0100503/*! Parse body (SDP) parameters of the MGCP response
504 * \param[in,out] r Response data
505 * \returns 0 on success, -EINVAL on error. */
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200506int mgcp_response_parse_params(struct mgcp_response *r)
507{
508 char *line;
509 int rc;
Neels Hofmeyr0793d2f2018-02-21 14:55:34 +0100510 char *data;
Philipp Maiere9d645b2018-01-19 23:54:08 +0100511 char *data_ptr;
Philipp Maier704c4f02018-06-07 18:51:31 +0200512 int i;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200513
Philipp Maiere9d645b2018-01-19 23:54:08 +0100514 /* Since this functions performs a destructive parsing, we create a
515 * local copy of the body data */
Neels Hofmeyr0793d2f2018-02-21 14:55:34 +0100516 OSMO_ASSERT(r->body);
517 data = talloc_strdup(r, r->body);
Philipp Maiere9d645b2018-01-19 23:54:08 +0100518 OSMO_ASSERT(data);
Philipp Maier55295f72018-01-15 14:00:28 +0100519
Philipp Maiere9d645b2018-01-19 23:54:08 +0100520 /* Find beginning of the parameter (SDP) section */
521 data_ptr = mgcp_find_section_end(data);
Neels Hofmeyr10835332018-02-21 14:55:34 +0100522 if (!data_ptr) {
Neels Hofmeyre8278312019-09-19 03:06:46 +0200523 LOGP(DLMGCP, LOGL_DEBUG, "MGCP response contains no SDP parameters\n");
524 rc = 0;
Philipp Maiere9d645b2018-01-19 23:54:08 +0100525 goto exit;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200526 }
527
Neels Hofmeyr0793d2f2018-02-21 14:55:34 +0100528 /* data_ptr now points to the beginning of the section-end-marker; for_each_non_empty_line()
529 * skips any \r and \n characters for free, so we don't need to skip the marker. */
530
Philipp Maiere9d645b2018-01-19 23:54:08 +0100531 for_each_non_empty_line(line, data_ptr) {
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200532 if (!mgcp_line_is_valid(line))
533 return -EINVAL;
534
535 switch (line[0]) {
Philipp Maier704c4f02018-06-07 18:51:31 +0200536 case 'a':
537 rc = mgcp_parse_audio_ptime_rtpmap(r, line);
538 if (rc)
539 goto exit;
540 break;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200541 case 'm':
Philipp Maier704c4f02018-06-07 18:51:31 +0200542 rc = mgcp_parse_audio_port_pt(r, line);
Philipp Maier06da85e2017-10-05 18:49:24 +0200543 if (rc)
Philipp Maiere9d645b2018-01-19 23:54:08 +0100544 goto exit;
Philipp Maier06da85e2017-10-05 18:49:24 +0200545 break;
546 case 'c':
547 rc = mgcp_parse_audio_ip(r, line);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200548 if (rc)
Philipp Maiere9d645b2018-01-19 23:54:08 +0100549 goto exit;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200550 break;
551 default:
552 /* skip unhandled parameters */
553 break;
554 }
555 }
Philipp Maiere9d645b2018-01-19 23:54:08 +0100556
Philipp Maier704c4f02018-06-07 18:51:31 +0200557 /* See also note in mgcp_parse_audio_port_pt() */
558 for (i = 0; i < r->codecs_len; i++)
559 r->codecs[i] = map_pt_to_codec(r->ptmap, r->ptmap_len, r->codecs[i]);
560
Philipp Maiere9d645b2018-01-19 23:54:08 +0100561 rc = 0;
562exit:
563 talloc_free(data);
564 return rc;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200565}
566
Philipp Maier55295f72018-01-15 14:00:28 +0100567/* Parse a line like "X: something" */
568static int mgcp_parse_head_param(char *result, unsigned int result_len,
569 char label, const char *line)
Philipp Maierffd75e42017-11-22 11:44:50 +0100570{
Philipp Maier55295f72018-01-15 14:00:28 +0100571 char label_string[4];
Neels Hofmeyr23e7bf12018-09-03 21:26:22 +0200572 size_t rc;
Philipp Maier55295f72018-01-15 14:00:28 +0100573
574 /* Detect empty parameters */
Philipp Maierffd75e42017-11-22 11:44:50 +0100575 if (strlen(line) < 4)
576 goto response_parse_failure;
577
Philipp Maier55295f72018-01-15 14:00:28 +0100578 /* Check if the label matches */
579 snprintf(label_string, sizeof(label_string), "%c: ", label);
580 if (memcmp(label_string, line, 3) != 0)
Philipp Maierffd75e42017-11-22 11:44:50 +0100581 goto response_parse_failure;
582
Philipp Maier55295f72018-01-15 14:00:28 +0100583 /* Copy payload part of the string to destinations (the label string
584 * is always 3 chars long) */
Neels Hofmeyr23e7bf12018-09-03 21:26:22 +0200585 rc = osmo_strlcpy(result, line + 3, result_len);
586 if (rc >= result_len) {
587 LOGP(DLMGCP, LOGL_ERROR,
588 "Failed to parse MGCP response (parameter label: %c):"
589 " the received conn ID is too long: %zu, maximum is %u characters\n",
590 label, rc, result_len - 1);
591 return -ENOSPC;
592 }
Philipp Maierffd75e42017-11-22 11:44:50 +0100593 return 0;
594
595response_parse_failure:
596 LOGP(DLMGCP, LOGL_ERROR,
Philipp Maier55295f72018-01-15 14:00:28 +0100597 "Failed to parse MGCP response (parameter label: %c)\n", label);
Philipp Maierffd75e42017-11-22 11:44:50 +0100598 return -EINVAL;
599}
600
601/* Parse MGCP parameters of the response */
602static int parse_head_params(struct mgcp_response *r)
603{
604 char *line;
605 int rc = 0;
606 OSMO_ASSERT(r->body);
Philipp Maier55295f72018-01-15 14:00:28 +0100607 char *data;
608 char *data_ptr;
609 char *data_end;
Philipp Maierffd75e42017-11-22 11:44:50 +0100610
Philipp Maier55295f72018-01-15 14:00:28 +0100611 /* Since this functions performs a destructive parsing, we create a
612 * local copy of the body data */
Philipp Maier1fc69992018-01-31 15:32:55 +0100613 data = talloc_zero_size(r, strlen(r->body)+1);
Philipp Maier55295f72018-01-15 14:00:28 +0100614 OSMO_ASSERT(data);
615 data_ptr = data;
616 osmo_strlcpy(data, r->body, strlen(r->body));
617
618 /* If there is an SDP body attached, prevent for_each_non_empty_line()
619 * into running in there, we are not yet interested in the parameters
620 * stored there. */
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +0200621 data_end = mgcp_find_section_end(data);
Philipp Maierffd75e42017-11-22 11:44:50 +0100622 if (data_end)
623 *data_end = '\0';
624
Philipp Maier55295f72018-01-15 14:00:28 +0100625 for_each_non_empty_line(line, data_ptr) {
Pau Espin Pedrol166077e2019-06-26 12:21:38 +0200626 switch (toupper(line[0])) {
Philipp Maier55295f72018-01-15 14:00:28 +0100627 case 'Z':
628 rc = mgcp_parse_head_param(r->head.endpoint,
629 sizeof(r->head.endpoint),
630 'Z', line);
631 if (rc)
632 goto exit;
Philipp Maier771b26a2018-01-31 13:53:11 +0100633
634 /* A specific endpoint identifier returned by the MGW
635 * must not contain any wildcard characters */
636 if (strstr(r->head.endpoint, "*") != NULL) {
637 rc = -EINVAL;
638 goto exit;
639 }
Philipp Maier3261dc72018-01-31 14:03:13 +0100640
641 /* A specific endpoint identifier returned by the MGW
642 * must contain an @ character */
643 if (strstr(r->head.endpoint, "@") == NULL) {
644 rc = -EINVAL;
645 goto exit;
646 }
Philipp Maier55295f72018-01-15 14:00:28 +0100647 break;
Philipp Maierffd75e42017-11-22 11:44:50 +0100648 case 'I':
Philipp Maier55295f72018-01-15 14:00:28 +0100649 rc = mgcp_parse_head_param(r->head.conn_id,
650 sizeof(r->head.conn_id),
651 'I', line);
Philipp Maierffd75e42017-11-22 11:44:50 +0100652 if (rc)
653 goto exit;
654 break;
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200655 case 'X':
Pau Espin Pedrolc1bf4692019-05-14 16:23:24 +0200656 if (strncasecmp("Osmux: ", line + 2, strlen("Osmux: ")) == 0) {
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200657 rc = mgcp_parse_osmux_cid(line);
658 if (rc < 0) {
659 /* -1: we don't want wildcards in response. -2: error */
660 rc = -EINVAL;
661 goto exit;
662 }
663 r->head.x_osmo_osmux_use = true;
664 r->head.x_osmo_osmux_cid = (uint8_t) rc;
665 rc = 0;
666 break;
667 }
668 /* Ignore unknown X-headers */
669 break;
Philipp Maierffd75e42017-11-22 11:44:50 +0100670 default:
671 /* skip unhandled parameters */
672 break;
673 }
674 }
675exit:
Philipp Maier55295f72018-01-15 14:00:28 +0100676 talloc_free(data);
Philipp Maierffd75e42017-11-22 11:44:50 +0100677 return rc;
678}
679
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200680static struct mgcp_response_pending *mgcp_client_response_pending_get(
681 struct mgcp_client *mgcp,
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +0100682 mgcp_trans_id_t trans_id)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200683{
684 struct mgcp_response_pending *pending;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200685 llist_for_each_entry(pending, &mgcp->responses_pending, entry) {
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +0100686 if (pending->trans_id == trans_id) {
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200687 llist_del(&pending->entry);
688 return pending;
689 }
690 }
691 return NULL;
692}
693
694/* Feed an MGCP message into the receive processing.
695 * Parse the head and call any callback registered for the transaction id found
696 * in the MGCP message. This is normally called directly from the internal
697 * mgcp_do_read that reads from the socket connected to the MGCP gateway. This
698 * function is published mainly to be able to feed data from the test suite.
699 */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200700int mgcp_client_rx(struct mgcp_client *mgcp, struct msgb *msg)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200701{
Philipp Maier1fc69992018-01-31 15:32:55 +0100702 struct mgcp_response *r;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200703 struct mgcp_response_pending *pending;
704 int rc;
705
Philipp Maier1fc69992018-01-31 15:32:55 +0100706 r = talloc_zero(mgcp, struct mgcp_response);
707 OSMO_ASSERT(r);
708
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200709 /* Re-arm keepalive timer if enabled */
710 if (OSMO_UNLIKELY(mgcp->conn_up == false)) {
711 LOGPMGW(mgcp, LOGL_NOTICE, "MGCP link to MGW now considered UP\n");
712 mgcp->conn_up = true;
713 }
714 if (mgcp->actual.keepalive.timeout_sec > 0)
715 osmo_timer_schedule(&mgcp->keepalive_rx_timer, mgcp->actual.keepalive.timeout_sec, 0);
716
Philipp Maier1fc69992018-01-31 15:32:55 +0100717 rc = mgcp_response_parse_head(r, msg);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200718 if (rc) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200719 LOGPMGW(mgcp, LOGL_ERROR, "Cannot parse MGCP response (head)\n");
Philipp Maier1fc69992018-01-31 15:32:55 +0100720 rc = 1;
721 goto error;
Philipp Maierffd75e42017-11-22 11:44:50 +0100722 }
723
Philipp Maierdf9192e2021-09-03 17:50:51 +0200724 LOGPMGW(mgcp, LOGL_DEBUG, "MGCP client: Rx %d %u %s\n",
Neels Hofmeyrd5731072021-07-15 01:36:47 +0200725 r->head.response_code, r->head.trans_id, r->head.comment);
726
Philipp Maier1fc69992018-01-31 15:32:55 +0100727 rc = parse_head_params(r);
Philipp Maierffd75e42017-11-22 11:44:50 +0100728 if (rc) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200729 LOGPMGW(mgcp, LOGL_ERROR, "Cannot parse MGCP response (head parameters)\n");
Philipp Maier1fc69992018-01-31 15:32:55 +0100730 rc = 1;
731 goto error;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200732 }
733
Philipp Maier1fc69992018-01-31 15:32:55 +0100734 pending = mgcp_client_response_pending_get(mgcp, r->head.trans_id);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200735 if (!pending) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200736 LOGPMGW(mgcp, LOGL_ERROR, "Cannot find matching MGCP transaction for trans_id %d\n",
737 r->head.trans_id);
Philipp Maier1fc69992018-01-31 15:32:55 +0100738 rc = -ENOENT;
739 goto error;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200740 }
741
Philipp Maier1fc69992018-01-31 15:32:55 +0100742 mgcp_client_handle_response(mgcp, pending, r);
743 rc = 0;
744
745error:
746 talloc_free(r);
747 return rc;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200748}
749
750static int mgcp_do_read(struct osmo_fd *fd)
751{
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200752 struct mgcp_client *mgcp = fd->data;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200753 struct msgb *msg;
754 int ret;
755
756 msg = msgb_alloc_headroom(4096, 128, "mgcp_from_gw");
757 if (!msg) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200758 LOGPMGW(mgcp, LOGL_ERROR, "Failed to allocate MGCP message.\n");
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200759 return -1;
760 }
761
762 ret = read(fd->fd, msg->data, 4096 - 128);
763 if (ret <= 0) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200764 LOGPMGW(mgcp, LOGL_ERROR, "Failed to read: %s: %d='%s'\n",
765 osmo_sock_get_name2(fd->fd), errno, strerror(errno));
Neels Hofmeyr0a403792018-12-12 03:10:18 +0100766
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200767 msgb_free(msg);
768 return -1;
Harald Welte9bf7c532017-11-17 14:14:31 +0100769 }
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200770
771 msg->l2h = msgb_put(msg, ret);
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200772 ret = mgcp_client_rx(mgcp, msg);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200773 talloc_free(msg);
774 return ret;
775}
776
777static int mgcp_do_write(struct osmo_fd *fd, struct msgb *msg)
778{
779 int ret;
Philipp Maierdf9192e2021-09-03 17:50:51 +0200780 struct mgcp_client *mgcp = fd->data;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200781
Philipp Maierdf9192e2021-09-03 17:50:51 +0200782 LOGPMGW(mgcp, LOGL_DEBUG, "Tx MGCP: %s: len=%u '%s'...\n",
783 osmo_sock_get_name2(fd->fd), msg->len,
784 osmo_escape_str((const char *)msg->data, OSMO_MIN(42, msg->len)));
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200785
786 ret = write(fd->fd, msg->data, msg->len);
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200787 if (OSMO_UNLIKELY(ret != msg->len))
Philipp Maierdf9192e2021-09-03 17:50:51 +0200788 LOGPMGW(mgcp, LOGL_ERROR, "Failed to Tx MGCP: %s: %d='%s'; msg: len=%u '%s'...\n",
789 osmo_sock_get_name2(fd->fd), errno, strerror(errno),
790 msg->len, osmo_escape_str((const char *)msg->data, OSMO_MIN(42, msg->len)));
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200791
792 /* Re-arm the keepalive Tx timer: */
793 if (mgcp->actual.keepalive.req_interval_sec > 0)
794 osmo_timer_schedule(&mgcp->keepalive_tx_timer, mgcp->actual.keepalive.req_interval_sec, 0);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200795 return ret;
796}
797
Pau Espin Pedrol2e411f32023-06-14 11:52:04 +0200798static const char *_mgcp_client_name_append_domain(const struct mgcp_client *mgcp, const char *name)
799{
800 static char endpoint[MGCP_ENDPOINT_MAXLEN];
801 int rc;
802
803 rc = snprintf(endpoint, sizeof(endpoint), "%s@%s", name, mgcp_client_endpoint_domain(mgcp));
804 if (rc > sizeof(endpoint) - 1) {
805 LOGPMGW(mgcp, LOGL_ERROR, "MGCP endpoint exceeds maximum length of %zu: '%s@%s'\n",
806 sizeof(endpoint) - 1, name, mgcp_client_endpoint_domain(mgcp));
807 return NULL;
808 }
809 if (rc < 1) {
810 LOGPMGW(mgcp, LOGL_ERROR, "Cannot compose MGCP endpoint name\n");
811 return NULL;
812 }
813 return endpoint;
814}
815
816/* Safely ignore the MGCP response to the DLCX sent via _mgcp_client_send_dlcx() */
817static void _ignore_mgcp_response(struct mgcp_response *response, void *priv) { }
818
819/* Format DLCX message (fire and forget) and send it off to the MGW */
820static void _mgcp_client_send_dlcx(struct mgcp_client *mgcp, const char *epname)
821{
822 struct msgb *msgb_dlcx;
823 struct mgcp_msg mgcp_msg_dlcx = {
824 .verb = MGCP_VERB_DLCX,
825 .presence = MGCP_MSG_PRESENCE_ENDPOINT,
826 };
827 osmo_strlcpy(mgcp_msg_dlcx.endpoint, epname, sizeof(mgcp_msg_dlcx.endpoint));
828 msgb_dlcx = mgcp_msg_gen(mgcp, &mgcp_msg_dlcx);
829 mgcp_client_tx(mgcp, msgb_dlcx, &_ignore_mgcp_response, NULL);
830}
831
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200832/* Format AuditEndpoint message (fire and forget) and send it off to the MGW */
833static void _mgcp_client_send_auep(struct mgcp_client *mgcp, const char *epname)
834{
835 struct msgb *msgb_auep;
836 struct mgcp_msg mgcp_msg_auep = {
837 .verb = MGCP_VERB_AUEP,
838 .presence = MGCP_MSG_PRESENCE_ENDPOINT,
839 };
840 OSMO_STRLCPY_ARRAY(mgcp_msg_auep.endpoint, epname);
841 msgb_auep = mgcp_msg_gen(mgcp, &mgcp_msg_auep);
842 mgcp_client_tx(mgcp, msgb_auep, &_ignore_mgcp_response, NULL);
843}
844
845static void mgcp_client_keepalive_tx_timer_cb(void *data)
846{
847 struct mgcp_client *mgcp = (struct mgcp_client *)data;
848 LOGPMGW(mgcp, LOGL_INFO, "Triggering keepalive MGCP request\n");
849 const char *epname = _mgcp_client_name_append_domain(mgcp, mgcp->actual.keepalive.req_endpoint_name);
850 _mgcp_client_send_auep(mgcp, epname);
851
852 /* Re-arm the timer: */
853 osmo_timer_schedule(&mgcp->keepalive_tx_timer, mgcp->actual.keepalive.req_interval_sec, 0);
854}
855
856static void mgcp_client_keepalive_rx_timer_cb(void *data)
857{
858 struct mgcp_client *mgcp = (struct mgcp_client *)data;
859 LOGPMGW(mgcp, LOGL_ERROR, "MGCP link to MGW now considered DOWN (keepalive timeout, more than %u seconds with no answer from MGW)\n",
860 mgcp->actual.keepalive.timeout_sec);
861 mgcp->conn_up = false;
862 /* TODO: Potentially time out all ongoing transactions for that MGW. Maybe based on VTY cfg? */
863}
864
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200865struct mgcp_client *mgcp_client_init(void *ctx,
866 struct mgcp_client_conf *conf)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200867{
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200868 struct mgcp_client *mgcp;
Philipp Maier3f2c15f2021-07-22 11:53:07 +0200869 struct reset_ep *reset_ep;
870 struct reset_ep *actual_reset_ep;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200871
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200872 mgcp = talloc_zero(ctx, struct mgcp_client);
Harald Welteefe15712020-07-15 10:56:45 +0200873 if (!mgcp)
874 return NULL;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200875
876 INIT_LLIST_HEAD(&mgcp->responses_pending);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200877
878 mgcp->next_trans_id = 1;
879
880 mgcp->actual.local_addr = conf->local_addr ? conf->local_addr :
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200881 MGCP_CLIENT_LOCAL_ADDR_DEFAULT;
Pau Espin Pedrol8e74c632022-10-17 19:20:45 +0200882 mgcp->actual.local_port = conf->local_port > 0 ? (uint16_t)conf->local_port :
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200883 MGCP_CLIENT_LOCAL_PORT_DEFAULT;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200884
885 mgcp->actual.remote_addr = conf->remote_addr ? conf->remote_addr :
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200886 MGCP_CLIENT_REMOTE_ADDR_DEFAULT;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200887 mgcp->actual.remote_port = conf->remote_port >= 0 ? (uint16_t)conf->remote_port :
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200888 MGCP_CLIENT_REMOTE_PORT_DEFAULT;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200889
Neels Hofmeyrac69ea92018-12-19 00:27:50 +0100890 if (osmo_strlcpy(mgcp->actual.endpoint_domain_name, conf->endpoint_domain_name,
891 sizeof(mgcp->actual.endpoint_domain_name))
892 >= sizeof(mgcp->actual.endpoint_domain_name)) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200893 LOGPMGW(mgcp, LOGL_ERROR, "MGCP client: endpoint domain name is too long, max length is %zu: '%s'\n",
894 sizeof(mgcp->actual.endpoint_domain_name) - 1, conf->endpoint_domain_name);
Neels Hofmeyrac69ea92018-12-19 00:27:50 +0100895 talloc_free(mgcp);
896 return NULL;
897 }
Philipp Maierdf9192e2021-09-03 17:50:51 +0200898 LOGPMGW(mgcp, LOGL_NOTICE, "MGCP client: using endpoint domain '@%s'\n", mgcp_client_endpoint_domain(mgcp));
Neels Hofmeyrac69ea92018-12-19 00:27:50 +0100899
Philipp Maier3f2c15f2021-07-22 11:53:07 +0200900 INIT_LLIST_HEAD(&mgcp->actual.reset_epnames);
901 llist_for_each_entry(reset_ep, &conf->reset_epnames, list) {
902 actual_reset_ep = talloc_memdup(mgcp, reset_ep, sizeof(*reset_ep));
903 llist_add_tail(&actual_reset_ep->list, &mgcp->actual.reset_epnames);
904 }
905
Philipp Maierdf9192e2021-09-03 17:50:51 +0200906 if (conf->description)
907 mgcp->actual.description = talloc_strdup(mgcp, conf->description);
908
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200909 osmo_wqueue_init(&mgcp->wq, 1024);
910 mgcp->wq.read_cb = mgcp_do_read;
911 mgcp->wq.write_cb = mgcp_do_write;
912 osmo_fd_setup(&mgcp->wq.bfd, -1, OSMO_FD_READ, osmo_wqueue_bfd_cb, mgcp, 0);
913
914 memcpy(&mgcp->actual.keepalive, &conf->keepalive, sizeof(conf->keepalive));
915 osmo_timer_setup(&mgcp->keepalive_tx_timer, mgcp_client_keepalive_tx_timer_cb, mgcp);
916 osmo_timer_setup(&mgcp->keepalive_rx_timer, mgcp_client_keepalive_rx_timer_cb, mgcp);
917
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200918 return mgcp;
919}
920
Philipp Maier3f2c15f2021-07-22 11:53:07 +0200921/*! Initialize client connection (opens socket)
Philipp Maier275ac972018-01-20 00:58:16 +0100922 * \param[in,out] mgcp MGCP client descriptor.
923 * \returns 0 on success, -EINVAL on error. */
Pau Espin Pedrol8e74c632022-10-17 19:20:45 +0200924int mgcp_client_connect(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200925{
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200926 int rc;
Philipp Maier3f2c15f2021-07-22 11:53:07 +0200927 struct reset_ep *reset_ep;
928 const char *epname;
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200929 bool some_dlcx_sent = false;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200930
931 if (!mgcp) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200932 LOGPMGW(mgcp, LOGL_FATAL, "Client not initialized properly\n");
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200933 return -EINVAL;
934 }
935
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200936 rc = osmo_sock_init2_ofd(&mgcp->wq.bfd, AF_UNSPEC, SOCK_DGRAM, IPPROTO_UDP, mgcp->actual.local_addr,
Pau Espin Pedrol8e74c632022-10-17 19:20:45 +0200937 mgcp->actual.local_port, mgcp->actual.remote_addr, mgcp->actual.remote_port,
938 OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT);
Harald Welte8890dfa2017-11-17 15:09:30 +0100939 if (rc < 0) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200940 LOGPMGW(mgcp, LOGL_FATAL,
941 "Failed to initialize socket %s:%u -> %s:%u for MGW: %s\n",
Philipp Maier276a4142021-07-29 11:55:14 +0200942 mgcp->actual.local_addr ? mgcp->actual.local_addr : "(any)", mgcp->actual.local_port,
943 mgcp->actual.remote_addr ? mgcp->actual.local_addr : "(any)", mgcp->actual.remote_port,
944 strerror(errno));
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200945 goto error_close_fd;
946 }
947
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200948 LOGPMGW(mgcp, LOGL_INFO, "MGW connection: %s\n", osmo_sock_get_name2(mgcp->wq.bfd.fd));
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200949
Philipp Maier3f2c15f2021-07-22 11:53:07 +0200950 /* If configured, send a DLCX message to the endpoints that are configured to
951 * be reset on startup. Usually this is a wildcarded endpoint. */
952 llist_for_each_entry(reset_ep, &mgcp->actual.reset_epnames, list) {
953 epname = _mgcp_client_name_append_domain(mgcp, reset_ep->name);
Philipp Maierdf9192e2021-09-03 17:50:51 +0200954 LOGPMGW(mgcp, LOGL_INFO, "Sending DLCX to: %s\n", epname);
Philipp Maier3f2c15f2021-07-22 11:53:07 +0200955 _mgcp_client_send_dlcx(mgcp, epname);
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200956 some_dlcx_sent = true;
Philipp Maier3f2c15f2021-07-22 11:53:07 +0200957 }
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200958
Pau Espin Pedrol4c065892023-06-26 18:44:44 +0200959 if (mgcp->actual.keepalive.req_interval_sec > 0) {
960 if (!some_dlcx_sent) {
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200961 /* Attempt an immediate probe to find out if link is UP or DOWN: */
962 osmo_timer_schedule(&mgcp->keepalive_tx_timer, 0, 0);
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200963 }
Pau Espin Pedrol4c065892023-06-26 18:44:44 +0200964 /* else: keepalive_tx_timer was already scheduled (if needed) down in the stack during Tx DLCX above */
965 } else {
966 /* Assume link is UP by default, so that this MGW can be selected: */
967 mgcp->conn_up = true;
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200968 }
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200969
970 if (mgcp->actual.keepalive.timeout_sec > 0)
971 osmo_timer_schedule(&mgcp->keepalive_rx_timer, mgcp->actual.keepalive.timeout_sec, 0);
972
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200973 return 0;
974error_close_fd:
Pau Espin Pedrol563386e2023-06-14 12:20:49 +0200975 close(mgcp->wq.bfd.fd);
976 mgcp->wq.bfd.fd = -1;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200977 return rc;
978}
979
Pau Espin Pedrol8e74c632022-10-17 19:20:45 +0200980/*! DEPRECATED: Initialize client connection (opens socket)
Philipp Maier3f4a4cb2021-07-26 13:20:05 +0200981 * \param[in,out] mgcp MGCP client descriptor.
982 * \returns 0 on success, -EINVAL on error. */
Pau Espin Pedrol8e74c632022-10-17 19:20:45 +0200983int mgcp_client_connect2(struct mgcp_client *mgcp, unsigned int retry_n_ports)
Philipp Maier3f4a4cb2021-07-26 13:20:05 +0200984{
Pau Espin Pedrol8e74c632022-10-17 19:20:45 +0200985 return mgcp_client_connect(mgcp);
Philipp Maier3f4a4cb2021-07-26 13:20:05 +0200986}
987
988/*! Terminate client connection
989 * \param[in,out] mgcp MGCP client descriptor.
990 * \returns 0 on success, -EINVAL on error. */
991void mgcp_client_disconnect(struct mgcp_client *mgcp)
992{
993 struct osmo_wqueue *wq;
994
995 if (!mgcp) {
Philipp Maierdf9192e2021-09-03 17:50:51 +0200996 LOGP(DLMGCP, LOGL_FATAL, "MGCP client not initialized properly\n");
Philipp Maier3f4a4cb2021-07-26 13:20:05 +0200997 return;
998 }
999
Pau Espin Pedrol563386e2023-06-14 12:20:49 +02001000 /* Disarm keepalive Tx/Rx timer until next connect() */
1001 osmo_timer_del(&mgcp->keepalive_rx_timer);
1002 osmo_timer_del(&mgcp->keepalive_tx_timer);
1003 mgcp->conn_up = false;
1004
Philipp Maier3f4a4cb2021-07-26 13:20:05 +02001005 wq = &mgcp->wq;
1006 osmo_wqueue_clear(wq);
Philipp Maierdf9192e2021-09-03 17:50:51 +02001007 LOGPMGW(mgcp, LOGL_INFO, "MGCP association: %s -- closed!\n", osmo_sock_get_name2(wq->bfd.fd));
Philipp Maier3f4a4cb2021-07-26 13:20:05 +02001008 if (osmo_fd_is_registered(&wq->bfd))
1009 osmo_fd_unregister(&wq->bfd);
Pau Espin Pedrol747fbce2023-03-14 11:48:27 +01001010 close(wq->bfd.fd);
1011 wq->bfd.fd = -1;
Philipp Maier3f4a4cb2021-07-26 13:20:05 +02001012}
1013
Philipp Maier275ac972018-01-20 00:58:16 +01001014/*! Get the IP-Aaddress of the associated MGW as string.
1015 * \param[in] mgcp MGCP client descriptor.
1016 * \returns a pointer to the address string. */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001017const char *mgcp_client_remote_addr_str(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001018{
1019 return mgcp->actual.remote_addr;
1020}
1021
Philipp Maier275ac972018-01-20 00:58:16 +01001022/*! Get the IP-Port of the associated MGW.
1023 * \param[in] mgcp MGCP client descriptor.
1024 * \returns port number. */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001025uint16_t mgcp_client_remote_port(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001026{
1027 return mgcp->actual.remote_port;
1028}
1029
Pau Espin Pedrol74d0e5c2020-09-02 17:19:20 +02001030/*! Get the IP-Address of the associated MGW as its numeric representation.
1031 * DEPRECATED, DON'T USE.
Philipp Maier275ac972018-01-20 00:58:16 +01001032 * \param[in] mgcp MGCP client descriptor.
1033 * \returns IP-Address as 32 bit integer (network byte order) */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001034uint32_t mgcp_client_remote_addr_n(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001035{
Pau Espin Pedrol74d0e5c2020-09-02 17:19:20 +02001036 return 0;
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001037}
1038
Neels Hofmeyrac69ea92018-12-19 00:27:50 +01001039/* To compose endpoint names, usually for CRCX, use this as domain name.
1040 * For example, snprintf("rtpbridge\*@%s", mgcp_client_endpoint_domain(mgcp)). */
1041const char *mgcp_client_endpoint_domain(const struct mgcp_client *mgcp)
1042{
1043 return mgcp->actual.endpoint_domain_name[0] ? mgcp->actual.endpoint_domain_name : "mgw";
1044}
1045
Philipp Maiera466f572020-06-25 16:11:04 +02001046/*! Compose endpoint name for a wildcarded request to the virtual trunk
1047 * \param[in] mgcp MGCP client descriptor.
1048 * \returns string containing the endpoint name (e.g. rtpbridge\*@mgw) */
Pau Espin Pedrolca0818c2019-04-16 17:23:38 +02001049const char *mgcp_client_rtpbridge_wildcard(const struct mgcp_client *mgcp)
1050{
1051 return _mgcp_client_name_append_domain(mgcp, "rtpbridge/*");
1052}
1053
Philipp Maier48635912020-06-25 20:16:22 +02001054/*! Compose endpoint name for an E1 endpoint.
1055 * \param[in] ctx talloc context.
1056 * \param[in] mgcp MGCP client descriptor.
1057 * \param[in] trunk_id id number of the E1 trunk (1-64).
1058 * \param[in] ts timeslot on the E1 trunk (1-31).
1059 * \param[in] rate bitrate used on the E1 trunk (e.g 16 for 16kbit).
1060 * \param[in] offset bit offset of the E1 subslot (e.g. 4 for the third 16k subslot).
1061 * \returns string containing the endpoint name (e.g. ds/e1-1/s-1/su16-4). */
1062const char *mgcp_client_e1_epname(void *ctx, const struct mgcp_client *mgcp, uint8_t trunk_id, uint8_t ts,
1063 uint8_t rate, uint8_t offset)
1064{
1065 /* See also comment in libosmo-mgcp, mgcp_client.c, gen_e1_epname() */
1066 const uint8_t valid_rates[] = { 64, 32, 32, 16, 16, 16, 16, 8, 8, 8, 8, 8, 8, 8, 8 };
1067 const uint8_t valid_offsets[] = { 0, 0, 4, 0, 2, 4, 6, 0, 1, 2, 3, 4, 5, 6, 7 };
1068
1069 uint8_t i;
1070 bool rate_offs_valid = false;
1071 char *epname;
1072
1073 epname =
1074 talloc_asprintf(ctx, "ds/e1-%u/s-%u/su%u-%u@%s", trunk_id, ts, rate, offset,
1075 mgcp_client_endpoint_domain(mgcp));
1076 if (!epname) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001077 LOGPMGW(mgcp, LOGL_ERROR, "Cannot compose MGCP e1-endpoint name!\n");
Philipp Maier48635912020-06-25 20:16:22 +02001078 return NULL;
1079 }
1080
1081 /* Check if the supplied rate/offset pair resembles a valid combination */
1082 for (i = 0; i < sizeof(valid_rates); i++) {
1083 if (valid_rates[i] == rate && valid_offsets[i] == offset)
1084 rate_offs_valid = true;
1085 }
1086 if (!rate_offs_valid) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001087 LOGPMGW(mgcp, LOGL_ERROR,
1088 "Cannot compose MGCP e1-endpoint name (%s), rate(%u)/offset(%u) combination is invalid!\n",
1089 epname, rate, offset);
Philipp Maier48635912020-06-25 20:16:22 +02001090 talloc_free(epname);
1091 return NULL;
1092 }
1093
1094 /* An E1 line has a maximum of 32 timeslots, while the first (ts=0) is
1095 * reserverd for framing and alignment, so we can not use it here. */
Philipp Maier92a73cd2020-11-26 22:21:11 +01001096 if (ts == 0 || ts > NUM_E1_TS-1) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001097 LOGPMGW(mgcp, LOGL_ERROR,
1098 "Cannot compose MGCP e1-endpoint name (%s), E1-timeslot number (%u) is invalid!\n",
1099 epname, ts);
Philipp Maier48635912020-06-25 20:16:22 +02001100 talloc_free(epname);
1101 return NULL;
1102 }
1103
1104 return epname;
1105}
1106
Philipp Maier30bdf942023-02-20 12:40:46 +01001107struct mgcp_response_pending *mgcp_client_pending_add(struct mgcp_client *mgcp, mgcp_trans_id_t trans_id,
1108 mgcp_response_cb_t response_cb, void *priv)
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001109{
1110 struct mgcp_response_pending *pending;
1111
1112 pending = talloc_zero(mgcp, struct mgcp_response_pending);
Harald Welte827da2c2020-07-15 10:57:08 +02001113 if (!pending)
1114 return NULL;
1115
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001116 pending->trans_id = trans_id;
1117 pending->response_cb = response_cb;
1118 pending->priv = priv;
1119 llist_add_tail(&pending->entry, &mgcp->responses_pending);
1120
1121 return pending;
1122}
1123
Philipp Maierdf9192e2021-09-03 17:50:51 +02001124/* Send the MGCP message in msg to the MGW and handle a response with
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001125 * response_cb. NOTE: the response_cb still needs to call
1126 * mgcp_response_parse_params(response) to get the parsed parameters -- to
1127 * potentially save some CPU cycles, only the head line has been parsed when
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001128 * the response_cb is invoked.
1129 * Before the priv pointer becomes invalid, e.g. due to transaction timeout,
1130 * mgcp_client_cancel() needs to be called for this transaction.
1131 */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001132int mgcp_client_tx(struct mgcp_client *mgcp, struct msgb *msg,
1133 mgcp_response_cb_t response_cb, void *priv)
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001134{
Harald Welte563ffc52020-06-17 21:54:13 +07001135 struct mgcp_response_pending *pending = NULL;
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001136 mgcp_trans_id_t trans_id;
1137 int rc;
1138
1139 trans_id = msg->cb[MSGB_CB_MGCP_TRANS_ID];
1140 if (!trans_id) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001141 LOGPMGW(mgcp, LOGL_ERROR,
1142 "Unset transaction id in mgcp send request\n");
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001143 talloc_free(msg);
1144 return -EINVAL;
1145 }
1146
Harald Welte563ffc52020-06-17 21:54:13 +07001147 /* Do not allocate a dummy 'mgcp_response_pending' entry */
1148 if (response_cb != NULL) {
1149 pending = mgcp_client_pending_add(mgcp, trans_id, response_cb, priv);
1150 if (!pending) {
1151 talloc_free(msg);
1152 return -ENOMEM;
1153 }
Harald Welte827da2c2020-07-15 10:57:08 +02001154 }
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001155
1156 if (msgb_l2len(msg) > 4096) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001157 LOGPMGW(mgcp, LOGL_ERROR,
1158 "Cannot send, MGCP message too large: %u\n",
1159 msgb_l2len(msg));
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001160 msgb_free(msg);
1161 rc = -EINVAL;
1162 goto mgcp_tx_error;
1163 }
1164
1165 rc = osmo_wqueue_enqueue(&mgcp->wq, msg);
1166 if (rc) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001167 LOGPMGW(mgcp, LOGL_FATAL, "Could not queue message to MGW\n");
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001168 msgb_free(msg);
1169 goto mgcp_tx_error;
1170 } else
Philipp Maierdf9192e2021-09-03 17:50:51 +02001171 LOGPMGW(mgcp, LOGL_DEBUG, "Queued %u bytes for MGW\n",
1172 msgb_l2len(msg));
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001173 return 0;
1174
1175mgcp_tx_error:
Harald Welte563ffc52020-06-17 21:54:13 +07001176 if (!pending)
Vadim Yanitskiyffbc6182020-07-16 15:48:13 +07001177 return rc;
Vadim Yanitskiy3f8139c2020-06-17 20:50:17 +07001178 /* Dequeue pending response, it's going to be free()d */
1179 llist_del(&pending->entry);
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001180 /* Pass NULL to response cb to indicate an error */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001181 mgcp_client_handle_response(mgcp, pending, NULL);
Vadim Yanitskiyffbc6182020-07-16 15:48:13 +07001182 return rc;
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001183}
1184
Philipp Maier275ac972018-01-20 00:58:16 +01001185/*! Cancel a pending transaction.
1186 * \param[in] mgcp MGCP client descriptor.
1187 * \param[in,out] trans_id Transaction id.
1188 * \returns 0 on success, -ENOENT on error.
1189 *
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001190 * Should a priv pointer passed to mgcp_client_tx() become invalid, this function must be called. In
1191 * practical terms, if the caller of mgcp_client_tx() wishes to tear down a transaction without having
1192 * received a response this function must be called. The trans_id can be obtained by calling
Philipp Maier275ac972018-01-20 00:58:16 +01001193 * mgcp_msg_trans_id() on the msgb produced by mgcp_msg_gen(). */
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001194int mgcp_client_cancel(struct mgcp_client *mgcp, mgcp_trans_id_t trans_id)
1195{
1196 struct mgcp_response_pending *pending = mgcp_client_response_pending_get(mgcp, trans_id);
1197 if (!pending) {
Philipp Maier275ac972018-01-20 00:58:16 +01001198 /*! Note: it is not harmful to cancel a transaction twice. */
Philipp Maierdf9192e2021-09-03 17:50:51 +02001199 LOGPMGW(mgcp, LOGL_ERROR, "Cannot cancel, no such transaction: %u\n", trans_id);
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001200 return -ENOENT;
1201 }
Philipp Maierdf9192e2021-09-03 17:50:51 +02001202 LOGPMGW(mgcp, LOGL_DEBUG, "Canceled transaction %u\n", trans_id);
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001203 talloc_free(pending);
1204 return 0;
Philipp Maier275ac972018-01-20 00:58:16 +01001205 /*! We don't really need to clean up the wqueue: In all sane cases, the msgb has already been sent
1206 * out and is no longer in the wqueue. If it still is in the wqueue, then sending MGCP messages
1207 * per se is broken and the program should notice so by a full wqueue. Even if this was called
1208 * before we had a chance to send out the message and it is still going to be sent, we will just
1209 * ignore the reply to it later. Removing a msgb from the wqueue here would just introduce more
1210 * bug surface in terms of failing to update wqueue API's counters or some such.
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001211 */
1212}
1213
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001214static mgcp_trans_id_t mgcp_client_next_trans_id(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001215{
1216 /* avoid zero trans_id to distinguish from unset trans_id */
1217 if (!mgcp->next_trans_id)
1218 mgcp->next_trans_id ++;
1219 return mgcp->next_trans_id ++;
1220}
1221
Philipp Maier1dc6be62017-10-05 18:25:37 +02001222#define MGCP_CRCX_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT | \
1223 MGCP_MSG_PRESENCE_CALL_ID | \
Philipp Maier1dc6be62017-10-05 18:25:37 +02001224 MGCP_MSG_PRESENCE_CONN_MODE)
1225#define MGCP_MDCX_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT | \
Philipp Maier490cbaa2018-01-22 17:32:38 +01001226 MGCP_MSG_PRESENCE_CALL_ID | \
Philipp Maier1dc6be62017-10-05 18:25:37 +02001227 MGCP_MSG_PRESENCE_CONN_ID)
1228#define MGCP_DLCX_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT)
1229#define MGCP_AUEP_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT)
1230#define MGCP_RSIP_MANDATORY 0 /* none */
1231
Philipp Maier704c4f02018-06-07 18:51:31 +02001232/* Helper function for mgcp_msg_gen(): Add LCO information to MGCP message */
1233static int add_lco(struct msgb *msg, struct mgcp_msg *mgcp_msg)
1234{
1235 unsigned int i;
Philipp Maier704c4f02018-06-07 18:51:31 +02001236 const char *codec;
1237 unsigned int pt;
1238
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001239#define MSGB_PRINTF_OR_RET(FMT, ARGS...) do { \
1240 if (msgb_printf(msg, FMT, ##ARGS) != 0) { \
1241 LOGP(DLMGCP, LOGL_ERROR, "Message buffer too small, can not generate MGCP/SDP message\n"); \
1242 return -ENOBUFS; \
1243 } \
1244 } while (0)
1245
1246 MSGB_PRINTF_OR_RET("L:");
Philipp Maier704c4f02018-06-07 18:51:31 +02001247
1248 if (mgcp_msg->ptime)
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001249 MSGB_PRINTF_OR_RET(" p:%u,", mgcp_msg->ptime);
Philipp Maier704c4f02018-06-07 18:51:31 +02001250
1251 if (mgcp_msg->codecs_len) {
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001252 MSGB_PRINTF_OR_RET(" a:");
Philipp Maier704c4f02018-06-07 18:51:31 +02001253 for (i = 0; i < mgcp_msg->codecs_len; i++) {
1254 pt = mgcp_msg->codecs[i];
Neels Hofmeyr47642f22019-02-27 05:56:53 +01001255 codec = get_value_string_or_null(osmo_mgcpc_codec_names, pt);
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +02001256
Philipp Maier704c4f02018-06-07 18:51:31 +02001257 /* Note: Use codec descriptors from enum mgcp_codecs
1258 * in mgcp_client only! */
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001259 if (!codec)
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001260 return -EINVAL;
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001261
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001262 MSGB_PRINTF_OR_RET("%s", extract_codec_name(codec));
Philipp Maier704c4f02018-06-07 18:51:31 +02001263 if (i < mgcp_msg->codecs_len - 1)
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001264 MSGB_PRINTF_OR_RET(";");
Philipp Maier704c4f02018-06-07 18:51:31 +02001265 }
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001266 MSGB_PRINTF_OR_RET(",");
Philipp Maier704c4f02018-06-07 18:51:31 +02001267 }
1268
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001269 MSGB_PRINTF_OR_RET(" nt:IN\r\n");
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001270 return 0;
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001271
1272#undef MSGB_PRINTF_OR_RET
Philipp Maier704c4f02018-06-07 18:51:31 +02001273}
1274
1275/* Helper function for mgcp_msg_gen(): Add SDP information to MGCP message */
1276static int add_sdp(struct msgb *msg, struct mgcp_msg *mgcp_msg, struct mgcp_client *mgcp)
1277{
1278 unsigned int i;
Pau Espin Pedrol8667d512020-08-28 19:37:08 +02001279 char local_ip[INET6_ADDRSTRLEN];
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +02001280 int local_ip_family, audio_ip_family;
Philipp Maier704c4f02018-06-07 18:51:31 +02001281 const char *codec;
1282 unsigned int pt;
1283
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001284#define MSGB_PRINTF_OR_RET(FMT, ARGS...) do { \
1285 if (msgb_printf(msg, FMT, ##ARGS) != 0) { \
1286 LOGPMGW(mgcp, LOGL_ERROR, "Message buffer too small, can not generate MGCP message (SDP)\n"); \
1287 return -ENOBUFS; \
1288 } \
1289 } while (0)
1290
Philipp Maier704c4f02018-06-07 18:51:31 +02001291 /* Add separator to mark the beginning of the SDP block */
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001292 MSGB_PRINTF_OR_RET("\r\n");
Philipp Maier704c4f02018-06-07 18:51:31 +02001293
1294 /* Add SDP protocol version */
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001295 MSGB_PRINTF_OR_RET("v=0\r\n");
Philipp Maier704c4f02018-06-07 18:51:31 +02001296
1297 /* Determine local IP-Address */
1298 if (osmo_sock_local_ip(local_ip, mgcp->actual.remote_addr) < 0) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001299 LOGPMGW(mgcp, LOGL_ERROR,
1300 "Could not determine local IP-Address!\n");
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001301 return -EINVAL;
Philipp Maier704c4f02018-06-07 18:51:31 +02001302 }
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +02001303 local_ip_family = osmo_ip_str_type(local_ip);
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001304 if (local_ip_family == AF_UNSPEC)
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001305 return -EINVAL;
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +02001306 audio_ip_family = osmo_ip_str_type(mgcp_msg->audio_ip);
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001307 if (audio_ip_family == AF_UNSPEC)
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001308 return -EINVAL;
Philipp Maier704c4f02018-06-07 18:51:31 +02001309
1310 /* Add owner/creator (SDP) */
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001311 MSGB_PRINTF_OR_RET("o=- %x 23 IN IP%c %s\r\n", mgcp_msg->call_id,
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +02001312 local_ip_family == AF_INET6 ? '6' : '4',
1313 local_ip);
Philipp Maier704c4f02018-06-07 18:51:31 +02001314
1315 /* Add session name (none) */
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001316 MSGB_PRINTF_OR_RET("s=-\r\n");
Philipp Maier704c4f02018-06-07 18:51:31 +02001317
1318 /* Add RTP address and port */
1319 if (mgcp_msg->audio_port == 0) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001320 LOGPMGW(mgcp, LOGL_ERROR,
1321 "Invalid port number, can not generate MGCP message\n");
Philipp Maier704c4f02018-06-07 18:51:31 +02001322 msgb_free(msg);
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001323 return -EINVAL;
Philipp Maier704c4f02018-06-07 18:51:31 +02001324 }
1325 if (strlen(mgcp_msg->audio_ip) <= 0) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001326 LOGPMGW(mgcp, LOGL_ERROR,
1327 "Empty ip address, can not generate MGCP message\n");
Philipp Maier704c4f02018-06-07 18:51:31 +02001328 msgb_free(msg);
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001329 return -EINVAL;
Philipp Maier704c4f02018-06-07 18:51:31 +02001330 }
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001331 MSGB_PRINTF_OR_RET("c=IN IP%c %s\r\n",
Pau Espin Pedrol9dc73592020-08-28 20:21:55 +02001332 audio_ip_family == AF_INET6 ? '6' : '4',
1333 mgcp_msg->audio_ip);
Philipp Maier704c4f02018-06-07 18:51:31 +02001334
1335 /* Add time description, active time (SDP) */
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001336 MSGB_PRINTF_OR_RET("t=0 0\r\n");
Philipp Maier704c4f02018-06-07 18:51:31 +02001337
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001338 MSGB_PRINTF_OR_RET("m=audio %u RTP/AVP", mgcp_msg->audio_port);
Philipp Maier704c4f02018-06-07 18:51:31 +02001339 for (i = 0; i < mgcp_msg->codecs_len; i++) {
1340 pt = map_codec_to_pt(mgcp_msg->ptmap, mgcp_msg->ptmap_len, mgcp_msg->codecs[i]);
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001341 MSGB_PRINTF_OR_RET(" %u", pt);
Philipp Maier704c4f02018-06-07 18:51:31 +02001342
1343 }
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001344 MSGB_PRINTF_OR_RET("\r\n");
Philipp Maier704c4f02018-06-07 18:51:31 +02001345
Philipp Maier228e5912019-03-05 13:56:59 +01001346 /* Add optional codec parameters (fmtp) */
1347 if (mgcp_msg->param_present) {
1348 for (i = 0; i < mgcp_msg->codecs_len; i++) {
1349 /* The following is only applicable for AMR */
1350 if (mgcp_msg->codecs[i] != CODEC_AMR_8000_1 && mgcp_msg->codecs[i] != CODEC_AMRWB_16000_1)
1351 continue;
1352 pt = map_codec_to_pt(mgcp_msg->ptmap, mgcp_msg->ptmap_len, mgcp_msg->codecs[i]);
1353 if (mgcp_msg->param.amr_octet_aligned_present && mgcp_msg->param.amr_octet_aligned)
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001354 MSGB_PRINTF_OR_RET("a=fmtp:%u octet-align=1\r\n", pt);
Philipp Maier228e5912019-03-05 13:56:59 +01001355 else if (mgcp_msg->param.amr_octet_aligned_present && !mgcp_msg->param.amr_octet_aligned)
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001356 MSGB_PRINTF_OR_RET("a=fmtp:%u octet-align=0\r\n", pt);
Philipp Maier228e5912019-03-05 13:56:59 +01001357 }
1358 }
1359
Philipp Maier704c4f02018-06-07 18:51:31 +02001360 for (i = 0; i < mgcp_msg->codecs_len; i++) {
1361 pt = map_codec_to_pt(mgcp_msg->ptmap, mgcp_msg->ptmap_len, mgcp_msg->codecs[i]);
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +02001362
Philipp Maier704c4f02018-06-07 18:51:31 +02001363 /* Note: Only dynamic payload type from the range 96-127
1364 * require to be explained further via rtpmap. All others
1365 * are implcitly definedby the number in m=audio */
1366 if (pt >= 96 && pt <= 127) {
Neels Hofmeyr47642f22019-02-27 05:56:53 +01001367 codec = get_value_string_or_null(osmo_mgcpc_codec_names, mgcp_msg->codecs[i]);
Philipp Maier704c4f02018-06-07 18:51:31 +02001368
1369 /* Note: Use codec descriptors from enum mgcp_codecs
1370 * in mgcp_client only! */
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001371 if (!codec)
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001372 return -EINVAL;
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +02001373
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001374 MSGB_PRINTF_OR_RET("a=rtpmap:%u %s\r\n", pt, codec);
Philipp Maier704c4f02018-06-07 18:51:31 +02001375 }
1376 }
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +02001377
Philipp Maier704c4f02018-06-07 18:51:31 +02001378 if (mgcp_msg->ptime)
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001379 MSGB_PRINTF_OR_RET("a=ptime:%u\r\n", mgcp_msg->ptime);
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001380
1381 return 0;
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001382#undef MSGB_PRINTF_OR_RET
Philipp Maier704c4f02018-06-07 18:51:31 +02001383}
1384
Philipp Maier275ac972018-01-20 00:58:16 +01001385/*! Generate an MGCP message
1386 * \param[in] mgcp MGCP client descriptor.
1387 * \param[in] mgcp_msg Message description
1388 * \returns message buffer on success, NULL on error. */
Philipp Maier1dc6be62017-10-05 18:25:37 +02001389struct msgb *mgcp_msg_gen(struct mgcp_client *mgcp, struct mgcp_msg *mgcp_msg)
1390{
1391 mgcp_trans_id_t trans_id = mgcp_client_next_trans_id(mgcp);
1392 uint32_t mandatory_mask;
1393 struct msgb *msg = msgb_alloc_headroom(4096, 128, "MGCP tx");
Philipp Maier704c4f02018-06-07 18:51:31 +02001394 bool use_sdp = false;
Pau Espin Pedrol900cd652019-04-24 22:06:22 +02001395 char buf[32];
Philipp Maier1dc6be62017-10-05 18:25:37 +02001396
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001397#define MSGB_PRINTF_OR_RET(FMT, ARGS...) do { \
1398 if (msgb_printf(msg, FMT, ##ARGS) != 0) { \
1399 LOGPMGW(mgcp, LOGL_ERROR, "Message buffer too small, can not generate MGCP/SDP message\n"); \
1400 goto exit_error; \
1401 } \
1402 } while (0)
1403
Philipp Maier1dc6be62017-10-05 18:25:37 +02001404 msg->l2h = msg->data;
1405 msg->cb[MSGB_CB_MGCP_TRANS_ID] = trans_id;
1406
1407 /* Add command verb */
1408 switch (mgcp_msg->verb) {
1409 case MGCP_VERB_CRCX:
1410 mandatory_mask = MGCP_CRCX_MANDATORY;
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001411 MSGB_PRINTF_OR_RET("CRCX %u", trans_id);
Philipp Maier1dc6be62017-10-05 18:25:37 +02001412 break;
1413 case MGCP_VERB_MDCX:
1414 mandatory_mask = MGCP_MDCX_MANDATORY;
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001415 MSGB_PRINTF_OR_RET("MDCX %u", trans_id);
Philipp Maier1dc6be62017-10-05 18:25:37 +02001416 break;
1417 case MGCP_VERB_DLCX:
1418 mandatory_mask = MGCP_DLCX_MANDATORY;
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001419 MSGB_PRINTF_OR_RET("DLCX %u", trans_id);
Philipp Maier1dc6be62017-10-05 18:25:37 +02001420 break;
1421 case MGCP_VERB_AUEP:
1422 mandatory_mask = MGCP_AUEP_MANDATORY;
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001423 MSGB_PRINTF_OR_RET("AUEP %u", trans_id);
Philipp Maier1dc6be62017-10-05 18:25:37 +02001424 break;
1425 case MGCP_VERB_RSIP:
1426 mandatory_mask = MGCP_RSIP_MANDATORY;
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001427 MSGB_PRINTF_OR_RET("RSIP %u", trans_id);
Philipp Maier1dc6be62017-10-05 18:25:37 +02001428 break;
1429 default:
Philipp Maierdf9192e2021-09-03 17:50:51 +02001430 LOGPMGW(mgcp, LOGL_ERROR, "Invalid command verb, can not generate MGCP message\n");
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001431 goto exit_error;
Philipp Maier1dc6be62017-10-05 18:25:37 +02001432 }
1433
1434 /* Check if mandatory fields are missing */
1435 if (!((mgcp_msg->presence & mandatory_mask) == mandatory_mask)) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001436 LOGPMGW(mgcp, LOGL_ERROR,
1437 "One or more missing mandatory fields, can not generate MGCP message\n");
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001438 goto exit_error;
Philipp Maier1dc6be62017-10-05 18:25:37 +02001439 }
1440
1441 /* Add endpoint name */
Philipp Maier7bc55522017-12-10 22:52:22 +01001442 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_ENDPOINT) {
1443 if (strlen(mgcp_msg->endpoint) <= 0) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001444 LOGPMGW(mgcp, LOGL_ERROR, "Empty endpoint name, can not generate MGCP message\n");
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001445 goto exit_error;
Philipp Maier7bc55522017-12-10 22:52:22 +01001446 }
Philipp Maier3aa81572018-01-31 14:13:45 +01001447
1448 if (strstr(mgcp_msg->endpoint, "@") == NULL) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001449 LOGPMGW(mgcp, LOGL_ERROR,
1450 "Endpoint name (%s) lacks separator (@), can not generate MGCP message\n",
1451 mgcp_msg->endpoint);
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001452 goto exit_error;
Philipp Maier3aa81572018-01-31 14:13:45 +01001453 }
1454
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001455 MSGB_PRINTF_OR_RET(" %s", mgcp_msg->endpoint);
Philipp Maier7bc55522017-12-10 22:52:22 +01001456 }
Philipp Maier1dc6be62017-10-05 18:25:37 +02001457
1458 /* Add protocol version */
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001459 MSGB_PRINTF_OR_RET(" MGCP 1.0\r\n");
Philipp Maier1dc6be62017-10-05 18:25:37 +02001460
1461 /* Add call id */
1462 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_CALL_ID)
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001463 MSGB_PRINTF_OR_RET("C: %x\r\n", mgcp_msg->call_id);
Philipp Maier1dc6be62017-10-05 18:25:37 +02001464
1465 /* Add connection id */
Philipp Maier7bc55522017-12-10 22:52:22 +01001466 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_CONN_ID) {
1467 if (strlen(mgcp_msg->conn_id) <= 0) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001468 LOGPMGW(mgcp, LOGL_ERROR, "Empty connection id, can not generate MGCP message\n");
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001469 goto exit_error;
Philipp Maier7bc55522017-12-10 22:52:22 +01001470 }
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001471 MSGB_PRINTF_OR_RET("I: %s\r\n", mgcp_msg->conn_id);
Philipp Maier7bc55522017-12-10 22:52:22 +01001472 }
Philipp Maier1dc6be62017-10-05 18:25:37 +02001473
Oliver Smitha3125232023-04-18 16:11:03 +02001474 /* Using SDP makes sense when a valid IP/Port combination is specified,
Philipp Maier704c4f02018-06-07 18:51:31 +02001475 * if we do not know this information yet, we fall back to LCO */
1476 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_AUDIO_IP
1477 && mgcp_msg->presence & MGCP_MSG_PRESENCE_AUDIO_PORT)
1478 use_sdp = true;
1479
1480 /* Add local connection options (LCO) */
1481 if (!use_sdp
1482 && (mgcp_msg->verb == MGCP_VERB_CRCX
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001483 || mgcp_msg->verb == MGCP_VERB_MDCX)) {
Oliver Smith0dbaaad2023-02-22 16:30:02 +01001484 if (add_lco(msg, mgcp_msg) < 0) {
1485 LOGPMGW(mgcp, LOGL_ERROR, "Failed to add LCO, can not generate MGCP message\n");
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001486 goto exit_error;
Oliver Smith0dbaaad2023-02-22 16:30:02 +01001487 }
Philipp Maier7d86d4c2021-06-11 15:16:13 +02001488 }
Philipp Maier1dc6be62017-10-05 18:25:37 +02001489
1490 /* Add mode */
1491 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_CONN_MODE)
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001492 MSGB_PRINTF_OR_RET("M: %s\r\n", mgcp_client_cmode_name(mgcp_msg->conn_mode));
Philipp Maier1dc6be62017-10-05 18:25:37 +02001493
Neels Hofmeyre6d8e912018-08-23 16:36:48 +02001494 /* Add X-Osmo-IGN */
1495 if ((mgcp_msg->presence & MGCP_MSG_PRESENCE_X_OSMO_IGN)
1496 && (mgcp_msg->x_osmo_ign != 0))
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001497 MSGB_PRINTF_OR_RET(MGCP_X_OSMO_IGN_HEADER "%s\r\n",
1498 mgcp_msg->x_osmo_ign & MGCP_X_OSMO_IGN_CALLID ? " C" : "");
Neels Hofmeyre6d8e912018-08-23 16:36:48 +02001499
Pau Espin Pedrol900cd652019-04-24 22:06:22 +02001500 /* Add X-Osmo-Osmux */
1501 if ((mgcp_msg->presence & MGCP_MSG_PRESENCE_X_OSMO_OSMUX_CID)) {
Pau Espin Pedrol1b1d7ed2019-05-23 16:48:24 +02001502 if (mgcp_msg->x_osmo_osmux_cid < -1 || mgcp_msg->x_osmo_osmux_cid > OSMUX_CID_MAX) {
Philipp Maierdf9192e2021-09-03 17:50:51 +02001503 LOGPMGW(mgcp, LOGL_ERROR, "Wrong Osmux CID %d, can not generate MGCP message\n",
1504 mgcp_msg->x_osmo_osmux_cid);
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001505 goto exit_error;
Pau Espin Pedrol1b1d7ed2019-05-23 16:48:24 +02001506 }
Pau Espin Pedrol900cd652019-04-24 22:06:22 +02001507 snprintf(buf, sizeof(buf), " %d", mgcp_msg->x_osmo_osmux_cid);
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001508 MSGB_PRINTF_OR_RET(MGCP_X_OSMO_OSMUX_HEADER "%s\r\n",
1509 mgcp_msg->x_osmo_osmux_cid == -1 ? " *" : buf);
Pau Espin Pedrol900cd652019-04-24 22:06:22 +02001510 }
1511
1512
Philipp Maier704c4f02018-06-07 18:51:31 +02001513 /* Add session description protocol (SDP) */
1514 if (use_sdp
1515 && (mgcp_msg->verb == MGCP_VERB_CRCX
1516 || mgcp_msg->verb == MGCP_VERB_MDCX)) {
Oliver Smith0dbaaad2023-02-22 16:30:02 +01001517 if (add_sdp(msg, mgcp_msg, mgcp) < 0) {
1518 LOGPMGW(mgcp, LOGL_ERROR, "Failed to add SDP, can not generate MGCP message\n");
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001519 goto exit_error;
Oliver Smith0dbaaad2023-02-22 16:30:02 +01001520 }
Philipp Maier1dc6be62017-10-05 18:25:37 +02001521 }
1522
Philipp Maier1dc6be62017-10-05 18:25:37 +02001523 return msg;
Neels Hofmeyr45fe47c2023-03-30 16:53:13 +02001524
1525exit_error:
1526 msgb_free(msg);
1527 return NULL;
1528#undef MSGB_PRINTF_OR_RET
Philipp Maier1dc6be62017-10-05 18:25:37 +02001529}
1530
Philipp Maier275ac972018-01-20 00:58:16 +01001531/*! Retrieve the MGCP transaction ID from a msgb generated by mgcp_msg_gen()
1532 * \param[in] msg message buffer
1533 * \returns Transaction id. */
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001534mgcp_trans_id_t mgcp_msg_trans_id(struct msgb *msg)
1535{
1536 return (mgcp_trans_id_t)msg->cb[MSGB_CB_MGCP_TRANS_ID];
1537}
1538
Philipp Maierfa495d62021-09-02 10:08:56 +02001539/*! Get the configuration parameters for a given MGCP client instance
Philipp Maier275ac972018-01-20 00:58:16 +01001540 * \param[in] mgcp MGCP client descriptor.
1541 * \returns configuration */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001542struct mgcp_client_conf *mgcp_client_conf_actual(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001543{
1544 return &mgcp->actual;
1545}
Neels Hofmeyrd95ab1e2017-09-22 00:52:54 +02001546
1547const struct value_string mgcp_client_connection_mode_strs[] = {
1548 { MGCP_CONN_NONE, "none" },
1549 { MGCP_CONN_RECV_SEND, "sendrecv" },
1550 { MGCP_CONN_SEND_ONLY, "sendonly" },
1551 { MGCP_CONN_RECV_ONLY, "recvonly" },
1552 { MGCP_CONN_LOOPBACK, "loopback" },
1553 { 0, NULL }
1554};
Philipp Maierdf9192e2021-09-03 17:50:51 +02001555
1556/*! Get MGCP client instance name (VTY).
1557 * \param[in] mgcp MGCP client descriptor.
1558 * \returns MGCP client name.
1559 *
1560 * The user can only modify the name of an MGCP client instance when it is
1561 * part of a pool. For single MGCP client instances and MGCP client instance
1562 * where no description is set via the VTY, the MGW domain name will be used
1563 * as name. */
1564const char *mgcp_client_name(const struct mgcp_client *mgcp)
1565{
1566 if (!mgcp)
1567 return "(null)";
1568
1569 if (mgcp->actual.description)
1570 return mgcp->actual.description;
1571 else
1572 return mgcp_client_endpoint_domain(mgcp);
1573}