blob: b1909f0bd1e3d80896d2a467294617268417d603 [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>
Neels Hofmeyre9920f22017-07-10 15:07:22 +020028
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +020029#include <osmocom/mgcp_client/mgcp_client.h>
30#include <osmocom/mgcp_client/mgcp_client_internal.h>
Neels Hofmeyre9920f22017-07-10 15:07:22 +020031
32#include <netinet/in.h>
33#include <arpa/inet.h>
34
35#include <errno.h>
36#include <unistd.h>
37#include <string.h>
Pau Espin Pedrol166077e2019-06-26 12:21:38 +020038#include <ctype.h>
Pau Espin Pedrolc5c14302019-07-23 16:19:41 +020039#include <stdlib.h>
40#include <limits.h>
Neels Hofmeyre9920f22017-07-10 15:07:22 +020041
Pau Espin Pedrol1b1d7ed2019-05-23 16:48:24 +020042#ifndef OSMUX_CID_MAX
43#define OSMUX_CID_MAX 255 /* FIXME: use OSMUX_CID_MAX from libosmo-netif? */
44#endif
45
Philipp Maier704c4f02018-06-07 18:51:31 +020046/* Codec descripton for dynamic payload types (SDP) */
Neels Hofmeyr47642f22019-02-27 05:56:53 +010047const struct value_string osmo_mgcpc_codec_names[] = {
Philipp Maier704c4f02018-06-07 18:51:31 +020048 { CODEC_PCMU_8000_1, "PCMU/8000/1" },
49 { CODEC_GSM_8000_1, "GSM/8000/1" },
50 { CODEC_PCMA_8000_1, "PCMA/8000/1" },
51 { CODEC_G729_8000_1, "G729/8000/1" },
52 { CODEC_GSMEFR_8000_1, "GSM-EFR/8000/1" },
53 { CODEC_GSMHR_8000_1, "GSM-HR-08/8000/1" },
54 { CODEC_AMR_8000_1, "AMR/8000/1" },
55 { CODEC_AMRWB_16000_1, "AMR-WB/16000/1" },
56 { 0, NULL },
57};
58
59/* Get encoding name from a full codec string e,g.
60 * ("CODEC/8000/2" => returns "CODEC") */
61static char *extract_codec_name(const char *str)
62{
63 static char buf[64];
64 unsigned int i;
65
66 if (!str)
67 return NULL;
68
69 /* FIXME osmo_strlcpy */
70 osmo_strlcpy(buf, str, sizeof(buf));
71
72 for (i = 0; i < strlen(buf); i++) {
73 if (buf[i] == '/')
74 buf[i] = '\0';
75 }
76
77 return buf;
78}
79
80/*! Map a string to a codec.
81 * \ptmap[in] str input string (e.g "GSM/8000/1", "GSM/8000" or "GSM")
82 * \returns codec that corresponds to the given string representation. */
83enum mgcp_codecs map_str_to_codec(const char *str)
84{
85 unsigned int i;
86 char *codec_name;
87 char str_buf[64];
88
89 osmo_strlcpy(str_buf, extract_codec_name(str), sizeof(str_buf));
90
Neels Hofmeyr47642f22019-02-27 05:56:53 +010091 for (i = 0; i < ARRAY_SIZE(osmo_mgcpc_codec_names); i++) {
92 codec_name = extract_codec_name(osmo_mgcpc_codec_names[i].str);
Philipp Maier704c4f02018-06-07 18:51:31 +020093 if (!codec_name)
94 continue;
95 if (strcmp(codec_name, str_buf) == 0)
Neels Hofmeyr47642f22019-02-27 05:56:53 +010096 return osmo_mgcpc_codec_names[i].value;
Philipp Maier704c4f02018-06-07 18:51:31 +020097 }
98
99 return -1;
100}
101
102/* Check the ptmap for illegal mappings */
Neels Hofmeyr84274e42019-04-27 19:08:36 +0200103static int check_ptmap(const struct ptmap *ptmap)
Philipp Maier704c4f02018-06-07 18:51:31 +0200104{
105 /* Check if there are mappings that leave the IANA assigned dynamic
106 * payload type range. Under normal conditions such mappings should
107 * not occur */
108
109 /* Its ok to have a 1:1 mapping in the statically defined
110 * range, this won't hurt */
111 if (ptmap->codec == ptmap->pt)
112 return 0;
113
114 if (ptmap->codec < 96 || ptmap->codec > 127)
115 goto error;
116 if (ptmap->pt < 96 || ptmap->pt > 127)
117 goto error;
118
119 return 0;
120error:
121 LOGP(DLMGCP, LOGL_ERROR,
122 "ptmap contains illegal mapping: codec=%u maps to pt=%u\n",
123 ptmap->codec, ptmap->pt);
124 return -1;
125}
126
127/*! Map a codec to a payload type.
128 * \ptmap[in] payload pointer to payload type map with specified payload types.
129 * \ptmap[in] ptmap_len length of the payload type map.
130 * \ptmap[in] codec the codec for which the payload type should be looked up.
131 * \returns assigned payload type */
Neels Hofmeyr84274e42019-04-27 19:08:36 +0200132unsigned int map_codec_to_pt(const struct ptmap *ptmap, unsigned int ptmap_len,
Philipp Maier704c4f02018-06-07 18:51:31 +0200133 enum mgcp_codecs codec)
134{
135 unsigned int i;
136
137 /*! Note: If the payload type map is empty or the codec is not found
138 * in the map, then a 1:1 mapping is performed. If the codec falls
139 * into the statically defined range or if the mapping table isself
140 * tries to map to the statically defined range, then the mapping
141 * is also ignored and a 1:1 mapping is performed instead. */
142
143 /* we may return the codec directly since enum mgcp_codecs directly
144 * corresponds to the statićally assigned payload types */
145 if (codec < 96 || codec > 127)
146 return codec;
147
148 for (i = 0; i < ptmap_len; i++) {
149 /* Skip illegal map entries */
150 if (check_ptmap(ptmap) == 0 && ptmap->codec == codec)
151 return ptmap->pt;
152 ptmap++;
153 }
154
155 /* If nothing is found, do not perform any mapping */
156 return codec;
157}
158
159/*! Map a payload type to a codec.
160 * \ptmap[in] payload pointer to payload type map with specified payload types.
161 * \ptmap[in] ptmap_len length of the payload type map.
162 * \ptmap[in] payload type for which the codec should be looked up.
163 * \returns codec that corresponds to the specified payload type */
164enum mgcp_codecs map_pt_to_codec(struct ptmap *ptmap, unsigned int ptmap_len,
165 unsigned int pt)
166{
167 unsigned int i;
168
169 /*! Note: If the payload type map is empty or the payload type is not
170 * found in the map, then a 1:1 mapping is performed. If the payload
171 * type falls into the statically defined range or if the mapping
172 * table isself tries to map to the statically defined range, then
173 * the mapping is also ignored and a 1:1 mapping is performed
174 * instead. */
175
176 /* See also note in map_codec_to_pt() */
177 if (pt < 96 || pt > 127)
178 return pt;
179
180 for (i = 0; i < ptmap_len; i++) {
181 if (check_ptmap(ptmap) == 0 && ptmap->pt == pt)
182 return ptmap->codec;
183 ptmap++;
184 }
185
186 /* If nothing is found, do not perform any mapping */
187 return pt;
188}
189
Philipp Maier275ac972018-01-20 00:58:16 +0100190/*! Initalize MGCP client configuration struct with default values.
191 * \param[out] conf Client configuration.*/
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200192void mgcp_client_conf_init(struct mgcp_client_conf *conf)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200193{
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200194 /* NULL and -1 default to MGCP_CLIENT_*_DEFAULT values */
195 *conf = (struct mgcp_client_conf){
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200196 .local_addr = NULL,
197 .local_port = -1,
198 .remote_addr = NULL,
199 .remote_port = -1,
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200200 };
201}
202
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200203static void mgcp_client_handle_response(struct mgcp_client *mgcp,
204 struct mgcp_response_pending *pending,
205 struct mgcp_response *response)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200206{
207 if (!pending) {
208 LOGP(DLMGCP, LOGL_ERROR,
209 "Cannot handle NULL response\n");
210 return;
211 }
212 if (pending->response_cb)
213 pending->response_cb(response, pending->priv);
214 else
Neels Hofmeyred0c1aa2018-12-21 03:07:53 +0100215 LOGP(DLMGCP, LOGL_DEBUG, "MGCP response ignored (NULL cb)\n");
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200216 talloc_free(pending);
217}
218
219static int mgcp_response_parse_head(struct mgcp_response *r, struct msgb *msg)
220{
221 int comment_pos;
222 char *end;
223
224 if (mgcp_msg_terminate_nul(msg))
225 goto response_parse_failure;
226
227 r->body = (char *)msg->data;
228
Harald Welte9bf7c532017-11-17 14:14:31 +0100229 if (sscanf(r->body, "%3d %u %n",
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200230 &r->head.response_code, &r->head.trans_id,
231 &comment_pos) != 2)
232 goto response_parse_failure;
233
Philipp Maierabe8c892018-01-20 00:15:12 +0100234 osmo_strlcpy(r->head.comment, r->body + comment_pos, sizeof(r->head.comment));
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200235 end = strchr(r->head.comment, '\r');
236 if (!end)
237 goto response_parse_failure;
238 /* Mark the end of the comment */
239 *end = '\0';
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200240 return 0;
241
242response_parse_failure:
243 LOGP(DLMGCP, LOGL_ERROR,
244 "Failed to parse MGCP response header\n");
245 return -EINVAL;
246}
247
248/* TODO undup against mgcp_protocol.c:mgcp_check_param() */
249static bool mgcp_line_is_valid(const char *line)
250{
251 const size_t line_len = strlen(line);
252 if (line[0] == '\0')
253 return true;
254
255 if (line_len < 2
256 || line[1] != '=') {
257 LOGP(DLMGCP, LOGL_ERROR,
258 "Wrong MGCP option format: '%s'\n",
259 line);
260 return false;
261 }
262
263 return true;
264}
265
Philipp Maier704c4f02018-06-07 18:51:31 +0200266/* Parse a line like "m=audio 16002 RTP/AVP 98", extract port and payload types */
267static int mgcp_parse_audio_port_pt(struct mgcp_response *r, char *line)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200268{
Philipp Maier704c4f02018-06-07 18:51:31 +0200269 char *pt_str;
Pau Espin Pedrolc5c14302019-07-23 16:19:41 +0200270 char *pt_end;
Pau Espin Pedrola2b1c5e2019-07-26 14:13:14 +0200271 unsigned long int pt;
Philipp Maier704c4f02018-06-07 18:51:31 +0200272 unsigned int count = 0;
273 unsigned int i;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200274
Philipp Maier704c4f02018-06-07 18:51:31 +0200275 /* Extract port information */
276 if (sscanf(line, "m=audio %hu", &r->audio_port) != 1)
277 goto response_parse_failure_port;
Philipp Maier10f32db2017-12-13 12:34:34 +0100278 if (r->audio_port == 0)
Philipp Maier704c4f02018-06-07 18:51:31 +0200279 goto response_parse_failure_port;
Philipp Maier10f32db2017-12-13 12:34:34 +0100280
Philipp Maier704c4f02018-06-07 18:51:31 +0200281 /* Extract payload types */
282 line = strstr(line, "RTP/AVP ");
283 if (!line)
284 goto exit;
285
286 pt_str = strtok(line, " ");
287 while (1) {
288 /* Do not allow excessive payload types */
289 if (count > ARRAY_SIZE(r->codecs))
290 goto response_parse_failure_pt;
291
292 pt_str = strtok(NULL, " ");
293 if (!pt_str)
294 break;
Pau Espin Pedrolc5c14302019-07-23 16:19:41 +0200295 errno = 0;
296 pt = strtoul(pt_str, &pt_end, 0);
297 if ((errno == ERANGE && pt == ULONG_MAX) || (errno && !pt) ||
298 pt_str == pt_end)
299 goto response_parse_failure_pt;
Philipp Maier704c4f02018-06-07 18:51:31 +0200300
Pau Espin Pedrola2b1c5e2019-07-26 14:13:14 +0200301 if (pt >> 7) /* PT is 7 bit field, higher values not allowed */
302 goto response_parse_failure_pt;
303
Philipp Maier704c4f02018-06-07 18:51:31 +0200304 /* Do not allow duplicate payload types */
305 for (i = 0; i < count; i++)
306 if (r->codecs[i] == pt)
307 goto response_parse_failure_pt;
308
309 /* Note: The payload type we store may not necessarly match
310 * the codec types we have defined in enum mgcp_codecs. To
311 * ensure that the end result only contains codec types which
312 * match enum mgcp_codecs, we will go through afterwards and
313 * remap the affected entries with the inrofmation we learn
314 * from rtpmap */
315 r->codecs[count] = pt;
316 count++;
317 }
318
319 r->codecs_len = count;
320
321exit:
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200322 return 0;
323
Philipp Maier704c4f02018-06-07 18:51:31 +0200324response_parse_failure_port:
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200325 LOGP(DLMGCP, LOGL_ERROR,
Philipp Maier704c4f02018-06-07 18:51:31 +0200326 "Failed to parse SDP parameter port (%s)\n", line);
Philipp Maier06da85e2017-10-05 18:49:24 +0200327 return -EINVAL;
Philipp Maier704c4f02018-06-07 18:51:31 +0200328
329response_parse_failure_pt:
330 LOGP(DLMGCP, LOGL_ERROR,
331 "Failed to parse SDP parameter payload types (%s)\n", line);
332 return -EINVAL;
333}
334
335/* Parse a line like "m=audio 16002 RTP/AVP 98", extract port and payload types */
336static int mgcp_parse_audio_ptime_rtpmap(struct mgcp_response *r, const char *line)
337{
338 unsigned int pt;
339 char codec_resp[64];
Neels Hofmeyr3ab8ca42019-08-08 04:03:42 +0200340 enum mgcp_codecs codec;
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +0200341
Neels Hofmeyr23f40482019-08-08 04:03:42 +0200342#define A_PTIME "a=ptime:"
343#define A_RTPMAP "a=rtpmap:"
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +0200344
Neels Hofmeyr23f40482019-08-08 04:03:42 +0200345 if (osmo_str_startswith(line, A_PTIME)) {
346 if (sscanf(line, A_PTIME "%u", &r->ptime) != 1) {
347 LOGP(DLMGCP, LOGL_ERROR,
348 "Failed to parse SDP parameter, invalid ptime (%s)\n", line);
349 return -EINVAL;
350 }
351 } else if (osmo_str_startswith(line, A_RTPMAP)) {
352 if (sscanf(line, A_RTPMAP "%d %63s", &pt, codec_resp) != 2) {
353 LOGP(DLMGCP, LOGL_ERROR,
354 "Failed to parse SDP parameter, invalid rtpmap: %s\n", osmo_quote_str(line, -1));
355 return -EINVAL;
356 }
Neels Hofmeyr3ab8ca42019-08-08 04:03:42 +0200357 if (r->ptmap_len >= ARRAY_SIZE(r->ptmap)) {
358 LOGP(DLMGCP, LOGL_ERROR, "No more space in ptmap array (len=%u)\n", r->ptmap_len);
359 return -ENOSPC;
Neels Hofmeyr23f40482019-08-08 04:03:42 +0200360 }
Neels Hofmeyr3ab8ca42019-08-08 04:03:42 +0200361 codec = map_str_to_codec(codec_resp);
362 r->ptmap[r->ptmap_len].pt = pt;
363 r->ptmap[r->ptmap_len].codec = codec;
364 r->ptmap_len++;
Philipp Maier704c4f02018-06-07 18:51:31 +0200365 }
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +0200366
Philipp Maier704c4f02018-06-07 18:51:31 +0200367 return 0;
Philipp Maier06da85e2017-10-05 18:49:24 +0200368}
369
370/* Parse a line like "c=IN IP4 10.11.12.13" */
371static int mgcp_parse_audio_ip(struct mgcp_response *r, const char *line)
372{
373 struct in_addr ip_test;
374
375 if (strlen(line) < 16)
376 goto response_parse_failure;
377
378 /* The current implementation strictly supports IPV4 only ! */
379 if (memcmp("c=IN IP4 ", line, 9) != 0)
380 goto response_parse_failure;
381
382 /* Extract IP-Address */
Philipp Maierf8bfbe82017-11-23 19:32:31 +0100383 osmo_strlcpy(r->audio_ip, line + 9, sizeof(r->audio_ip));
Philipp Maier06da85e2017-10-05 18:49:24 +0200384
385 /* Check IP-Address */
386 if (inet_aton(r->audio_ip, &ip_test) == 0)
387 goto response_parse_failure;
388
389 return 0;
390
391response_parse_failure:
392 LOGP(DLMGCP, LOGL_ERROR,
393 "Failed to parse MGCP response header (audio ip)\n");
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200394 return -EINVAL;
395}
396
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200397/*! Extract OSMUX CID from an MGCP parameter line (string).
398 * \param[in] line single parameter line from the MGCP message
399 * \returns OSMUX CID, -1 wildcard, -2 on error
400 * FIXME: This is a copy of function in mgcp_msg.c. Have some common.c file between both libs?
401 */
402static int mgcp_parse_osmux_cid(const char *line)
403{
404 int osmux_cid;
405
406
Pau Espin Pedrolc1bf4692019-05-14 16:23:24 +0200407 if (strcasecmp(line + 2, "Osmux: *") == 0) {
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200408 LOGP(DLMGCP, LOGL_DEBUG, "Parsed wilcard Osmux CID\n");
409 return -1;
410 }
411
Pau Espin Pedrolc1bf4692019-05-14 16:23:24 +0200412 if (sscanf(line + 2 + 7, "%u", &osmux_cid) != 1) {
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200413 LOGP(DLMGCP, LOGL_ERROR, "Failed parsing Osmux in MGCP msg line: %s\n",
414 line);
415 return -2;
416 }
417
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200418 if (osmux_cid > OSMUX_CID_MAX) { /* OSMUX_CID_MAX from libosmo-netif */
419 LOGP(DLMGCP, LOGL_ERROR, "Osmux ID too large: %u > %u\n",
420 osmux_cid, OSMUX_CID_MAX);
421 return -2;
422 }
423 LOGP(DLMGCP, LOGL_DEBUG, "bsc-nat offered Osmux CID %u\n", osmux_cid);
424
425 return osmux_cid;
426}
427
Philipp Maier3b12e1b2018-01-18 15:16:13 +0100428/* A new section is marked by a double line break, check a few more
429 * patterns as there may be variants */
430static char *mgcp_find_section_end(char *string)
431{
432 char *rc;
433
434 rc = strstr(string, "\n\n");
435 if (rc)
436 return rc;
437
438 rc = strstr(string, "\n\r\n\r");
439 if (rc)
440 return rc;
441
442 rc = strstr(string, "\r\n\r\n");
443 if (rc)
444 return rc;
445
446 return NULL;
447}
448
Philipp Maier275ac972018-01-20 00:58:16 +0100449/*! Parse body (SDP) parameters of the MGCP response
450 * \param[in,out] r Response data
451 * \returns 0 on success, -EINVAL on error. */
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200452int mgcp_response_parse_params(struct mgcp_response *r)
453{
454 char *line;
455 int rc;
Neels Hofmeyr0793d2f2018-02-21 14:55:34 +0100456 char *data;
Philipp Maiere9d645b2018-01-19 23:54:08 +0100457 char *data_ptr;
Philipp Maier704c4f02018-06-07 18:51:31 +0200458 int i;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200459
Philipp Maiere9d645b2018-01-19 23:54:08 +0100460 /* Since this functions performs a destructive parsing, we create a
461 * local copy of the body data */
Neels Hofmeyr0793d2f2018-02-21 14:55:34 +0100462 OSMO_ASSERT(r->body);
463 data = talloc_strdup(r, r->body);
Philipp Maiere9d645b2018-01-19 23:54:08 +0100464 OSMO_ASSERT(data);
Philipp Maier55295f72018-01-15 14:00:28 +0100465
Philipp Maiere9d645b2018-01-19 23:54:08 +0100466 /* Find beginning of the parameter (SDP) section */
467 data_ptr = mgcp_find_section_end(data);
Neels Hofmeyr10835332018-02-21 14:55:34 +0100468 if (!data_ptr) {
Neels Hofmeyre8278312019-09-19 03:06:46 +0200469 LOGP(DLMGCP, LOGL_DEBUG, "MGCP response contains no SDP parameters\n");
470 rc = 0;
Philipp Maiere9d645b2018-01-19 23:54:08 +0100471 goto exit;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200472 }
473
Neels Hofmeyr0793d2f2018-02-21 14:55:34 +0100474 /* data_ptr now points to the beginning of the section-end-marker; for_each_non_empty_line()
475 * skips any \r and \n characters for free, so we don't need to skip the marker. */
476
Philipp Maiere9d645b2018-01-19 23:54:08 +0100477 for_each_non_empty_line(line, data_ptr) {
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200478 if (!mgcp_line_is_valid(line))
479 return -EINVAL;
480
481 switch (line[0]) {
Philipp Maier704c4f02018-06-07 18:51:31 +0200482 case 'a':
483 rc = mgcp_parse_audio_ptime_rtpmap(r, line);
484 if (rc)
485 goto exit;
486 break;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200487 case 'm':
Philipp Maier704c4f02018-06-07 18:51:31 +0200488 rc = mgcp_parse_audio_port_pt(r, line);
Philipp Maier06da85e2017-10-05 18:49:24 +0200489 if (rc)
Philipp Maiere9d645b2018-01-19 23:54:08 +0100490 goto exit;
Philipp Maier06da85e2017-10-05 18:49:24 +0200491 break;
492 case 'c':
493 rc = mgcp_parse_audio_ip(r, line);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200494 if (rc)
Philipp Maiere9d645b2018-01-19 23:54:08 +0100495 goto exit;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200496 break;
497 default:
498 /* skip unhandled parameters */
499 break;
500 }
501 }
Philipp Maiere9d645b2018-01-19 23:54:08 +0100502
Philipp Maier704c4f02018-06-07 18:51:31 +0200503 /* See also note in mgcp_parse_audio_port_pt() */
504 for (i = 0; i < r->codecs_len; i++)
505 r->codecs[i] = map_pt_to_codec(r->ptmap, r->ptmap_len, r->codecs[i]);
506
Philipp Maiere9d645b2018-01-19 23:54:08 +0100507 rc = 0;
508exit:
509 talloc_free(data);
510 return rc;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200511}
512
Philipp Maier55295f72018-01-15 14:00:28 +0100513/* Parse a line like "X: something" */
514static int mgcp_parse_head_param(char *result, unsigned int result_len,
515 char label, const char *line)
Philipp Maierffd75e42017-11-22 11:44:50 +0100516{
Philipp Maier55295f72018-01-15 14:00:28 +0100517 char label_string[4];
Neels Hofmeyr23e7bf12018-09-03 21:26:22 +0200518 size_t rc;
Philipp Maier55295f72018-01-15 14:00:28 +0100519
520 /* Detect empty parameters */
Philipp Maierffd75e42017-11-22 11:44:50 +0100521 if (strlen(line) < 4)
522 goto response_parse_failure;
523
Philipp Maier55295f72018-01-15 14:00:28 +0100524 /* Check if the label matches */
525 snprintf(label_string, sizeof(label_string), "%c: ", label);
526 if (memcmp(label_string, line, 3) != 0)
Philipp Maierffd75e42017-11-22 11:44:50 +0100527 goto response_parse_failure;
528
Philipp Maier55295f72018-01-15 14:00:28 +0100529 /* Copy payload part of the string to destinations (the label string
530 * is always 3 chars long) */
Neels Hofmeyr23e7bf12018-09-03 21:26:22 +0200531 rc = osmo_strlcpy(result, line + 3, result_len);
532 if (rc >= result_len) {
533 LOGP(DLMGCP, LOGL_ERROR,
534 "Failed to parse MGCP response (parameter label: %c):"
535 " the received conn ID is too long: %zu, maximum is %u characters\n",
536 label, rc, result_len - 1);
537 return -ENOSPC;
538 }
Philipp Maierffd75e42017-11-22 11:44:50 +0100539 return 0;
540
541response_parse_failure:
542 LOGP(DLMGCP, LOGL_ERROR,
Philipp Maier55295f72018-01-15 14:00:28 +0100543 "Failed to parse MGCP response (parameter label: %c)\n", label);
Philipp Maierffd75e42017-11-22 11:44:50 +0100544 return -EINVAL;
545}
546
547/* Parse MGCP parameters of the response */
548static int parse_head_params(struct mgcp_response *r)
549{
550 char *line;
551 int rc = 0;
552 OSMO_ASSERT(r->body);
Philipp Maier55295f72018-01-15 14:00:28 +0100553 char *data;
554 char *data_ptr;
555 char *data_end;
Philipp Maierffd75e42017-11-22 11:44:50 +0100556
Philipp Maier55295f72018-01-15 14:00:28 +0100557 /* Since this functions performs a destructive parsing, we create a
558 * local copy of the body data */
Philipp Maier1fc69992018-01-31 15:32:55 +0100559 data = talloc_zero_size(r, strlen(r->body)+1);
Philipp Maier55295f72018-01-15 14:00:28 +0100560 OSMO_ASSERT(data);
561 data_ptr = data;
562 osmo_strlcpy(data, r->body, strlen(r->body));
563
564 /* If there is an SDP body attached, prevent for_each_non_empty_line()
565 * into running in there, we are not yet interested in the parameters
566 * stored there. */
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +0200567 data_end = mgcp_find_section_end(data);
Philipp Maierffd75e42017-11-22 11:44:50 +0100568 if (data_end)
569 *data_end = '\0';
570
Philipp Maier55295f72018-01-15 14:00:28 +0100571 for_each_non_empty_line(line, data_ptr) {
Pau Espin Pedrol166077e2019-06-26 12:21:38 +0200572 switch (toupper(line[0])) {
Philipp Maier55295f72018-01-15 14:00:28 +0100573 case 'Z':
574 rc = mgcp_parse_head_param(r->head.endpoint,
575 sizeof(r->head.endpoint),
576 'Z', line);
577 if (rc)
578 goto exit;
Philipp Maier771b26a2018-01-31 13:53:11 +0100579
580 /* A specific endpoint identifier returned by the MGW
581 * must not contain any wildcard characters */
582 if (strstr(r->head.endpoint, "*") != NULL) {
583 rc = -EINVAL;
584 goto exit;
585 }
Philipp Maier3261dc72018-01-31 14:03:13 +0100586
587 /* A specific endpoint identifier returned by the MGW
588 * must contain an @ character */
589 if (strstr(r->head.endpoint, "@") == NULL) {
590 rc = -EINVAL;
591 goto exit;
592 }
Philipp Maier55295f72018-01-15 14:00:28 +0100593 break;
Philipp Maierffd75e42017-11-22 11:44:50 +0100594 case 'I':
Philipp Maier55295f72018-01-15 14:00:28 +0100595 rc = mgcp_parse_head_param(r->head.conn_id,
596 sizeof(r->head.conn_id),
597 'I', line);
Philipp Maierffd75e42017-11-22 11:44:50 +0100598 if (rc)
599 goto exit;
600 break;
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200601 case 'X':
Pau Espin Pedrolc1bf4692019-05-14 16:23:24 +0200602 if (strncasecmp("Osmux: ", line + 2, strlen("Osmux: ")) == 0) {
Pau Espin Pedrol91088c32019-04-24 21:02:40 +0200603 rc = mgcp_parse_osmux_cid(line);
604 if (rc < 0) {
605 /* -1: we don't want wildcards in response. -2: error */
606 rc = -EINVAL;
607 goto exit;
608 }
609 r->head.x_osmo_osmux_use = true;
610 r->head.x_osmo_osmux_cid = (uint8_t) rc;
611 rc = 0;
612 break;
613 }
614 /* Ignore unknown X-headers */
615 break;
Philipp Maierffd75e42017-11-22 11:44:50 +0100616 default:
617 /* skip unhandled parameters */
618 break;
619 }
620 }
621exit:
Philipp Maier55295f72018-01-15 14:00:28 +0100622 talloc_free(data);
Philipp Maierffd75e42017-11-22 11:44:50 +0100623 return rc;
624}
625
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200626static struct mgcp_response_pending *mgcp_client_response_pending_get(
627 struct mgcp_client *mgcp,
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +0100628 mgcp_trans_id_t trans_id)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200629{
630 struct mgcp_response_pending *pending;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200631 llist_for_each_entry(pending, &mgcp->responses_pending, entry) {
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +0100632 if (pending->trans_id == trans_id) {
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200633 llist_del(&pending->entry);
634 return pending;
635 }
636 }
637 return NULL;
638}
639
640/* Feed an MGCP message into the receive processing.
641 * Parse the head and call any callback registered for the transaction id found
642 * in the MGCP message. This is normally called directly from the internal
643 * mgcp_do_read that reads from the socket connected to the MGCP gateway. This
644 * function is published mainly to be able to feed data from the test suite.
645 */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200646int mgcp_client_rx(struct mgcp_client *mgcp, struct msgb *msg)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200647{
Philipp Maier1fc69992018-01-31 15:32:55 +0100648 struct mgcp_response *r;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200649 struct mgcp_response_pending *pending;
650 int rc;
651
Philipp Maier1fc69992018-01-31 15:32:55 +0100652 r = talloc_zero(mgcp, struct mgcp_response);
653 OSMO_ASSERT(r);
654
655 rc = mgcp_response_parse_head(r, msg);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200656 if (rc) {
Philipp Maierffd75e42017-11-22 11:44:50 +0100657 LOGP(DLMGCP, LOGL_ERROR, "Cannot parse MGCP response (head)\n");
Philipp Maier1fc69992018-01-31 15:32:55 +0100658 rc = 1;
659 goto error;
Philipp Maierffd75e42017-11-22 11:44:50 +0100660 }
661
Philipp Maier1fc69992018-01-31 15:32:55 +0100662 rc = parse_head_params(r);
Philipp Maierffd75e42017-11-22 11:44:50 +0100663 if (rc) {
664 LOGP(DLMGCP, LOGL_ERROR, "Cannot parse MGCP response (head parameters)\n");
Philipp Maier1fc69992018-01-31 15:32:55 +0100665 rc = 1;
666 goto error;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200667 }
668
Philipp Maier1fc69992018-01-31 15:32:55 +0100669 pending = mgcp_client_response_pending_get(mgcp, r->head.trans_id);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200670 if (!pending) {
671 LOGP(DLMGCP, LOGL_ERROR,
672 "Cannot find matching MGCP transaction for trans_id %d\n",
Philipp Maier1fc69992018-01-31 15:32:55 +0100673 r->head.trans_id);
674 rc = -ENOENT;
675 goto error;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200676 }
677
Philipp Maier1fc69992018-01-31 15:32:55 +0100678 mgcp_client_handle_response(mgcp, pending, r);
679 rc = 0;
680
681error:
682 talloc_free(r);
683 return rc;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200684}
685
686static int mgcp_do_read(struct osmo_fd *fd)
687{
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200688 struct mgcp_client *mgcp = fd->data;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200689 struct msgb *msg;
690 int ret;
691
692 msg = msgb_alloc_headroom(4096, 128, "mgcp_from_gw");
693 if (!msg) {
694 LOGP(DLMGCP, LOGL_ERROR, "Failed to allocate MGCP message.\n");
695 return -1;
696 }
697
698 ret = read(fd->fd, msg->data, 4096 - 128);
699 if (ret <= 0) {
Neels Hofmeyr0a403792018-12-12 03:10:18 +0100700 LOGP(DLMGCP, LOGL_ERROR, "Failed to read: %s: %d='%s'\n", osmo_sock_get_name2(fd->fd),
701 errno, strerror(errno));
702
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200703 msgb_free(msg);
704 return -1;
705 } else if (ret > 4096 - 128) {
Neels Hofmeyr0a403792018-12-12 03:10:18 +0100706 LOGP(DLMGCP, LOGL_ERROR, "Too much data: %s: %d\n", osmo_sock_get_name2(fd->fd), ret);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200707 msgb_free(msg);
708 return -1;
Harald Welte9bf7c532017-11-17 14:14:31 +0100709 }
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200710
711 msg->l2h = msgb_put(msg, ret);
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200712 ret = mgcp_client_rx(mgcp, msg);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200713 talloc_free(msg);
714 return ret;
715}
716
717static int mgcp_do_write(struct osmo_fd *fd, struct msgb *msg)
718{
719 int ret;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200720
Neels Hofmeyr0a403792018-12-12 03:10:18 +0100721 LOGP(DLMGCP, LOGL_DEBUG, "Tx MGCP: %s: len=%u '%s'...\n",
722 osmo_sock_get_name2(fd->fd), msg->len, osmo_escape_str((const char*)msg->data, OSMO_MIN(42, msg->len)));
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200723
724 ret = write(fd->fd, msg->data, msg->len);
725 if (ret != msg->len)
Neels Hofmeyr0a403792018-12-12 03:10:18 +0100726 LOGP(DLMGCP, LOGL_ERROR, "Failed to Tx MGCP: %s: %d='%s'; msg: len=%u '%s'...\n",
727 osmo_sock_get_name2(fd->fd), errno, strerror(errno),
Neels Hofmeyr32d15cc2018-12-12 03:05:33 +0100728 msg->len, osmo_escape_str((const char*)msg->data, OSMO_MIN(42, msg->len)));
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200729 return ret;
730}
731
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200732struct mgcp_client *mgcp_client_init(void *ctx,
733 struct mgcp_client_conf *conf)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200734{
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200735 struct mgcp_client *mgcp;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200736
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200737 mgcp = talloc_zero(ctx, struct mgcp_client);
Harald Welteefe15712020-07-15 10:56:45 +0200738 if (!mgcp)
739 return NULL;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200740
741 INIT_LLIST_HEAD(&mgcp->responses_pending);
742 INIT_LLIST_HEAD(&mgcp->inuse_endpoints);
743
744 mgcp->next_trans_id = 1;
745
746 mgcp->actual.local_addr = conf->local_addr ? conf->local_addr :
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200747 MGCP_CLIENT_LOCAL_ADDR_DEFAULT;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200748 mgcp->actual.local_port = conf->local_port >= 0 ? (uint16_t)conf->local_port :
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200749 MGCP_CLIENT_LOCAL_PORT_DEFAULT;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200750
751 mgcp->actual.remote_addr = conf->remote_addr ? conf->remote_addr :
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200752 MGCP_CLIENT_REMOTE_ADDR_DEFAULT;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200753 mgcp->actual.remote_port = conf->remote_port >= 0 ? (uint16_t)conf->remote_port :
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200754 MGCP_CLIENT_REMOTE_PORT_DEFAULT;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200755
Neels Hofmeyrac69ea92018-12-19 00:27:50 +0100756 if (osmo_strlcpy(mgcp->actual.endpoint_domain_name, conf->endpoint_domain_name,
757 sizeof(mgcp->actual.endpoint_domain_name))
758 >= sizeof(mgcp->actual.endpoint_domain_name)) {
759 LOGP(DLMGCP, LOGL_ERROR, "MGCP client: endpoint domain name is too long, max length is %zu: '%s'\n",
760 sizeof(mgcp->actual.endpoint_domain_name) - 1, conf->endpoint_domain_name);
761 talloc_free(mgcp);
762 return NULL;
763 }
764 LOGP(DLMGCP, LOGL_NOTICE, "MGCP client: using endpoint domain '@%s'\n", mgcp_client_endpoint_domain(mgcp));
765
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200766 return mgcp;
767}
768
Philipp Maier6a26c162018-08-01 16:37:06 +0200769static int init_socket(struct mgcp_client *mgcp)
770{
771 int rc;
772 struct osmo_wqueue *wq;
773 int i;
774
775 wq = &mgcp->wq;
776
777 for (i = 0; i < 100; i++) {
778
779 /* Initalize socket with the currently configured port
780 * number */
781 rc = osmo_sock_init2_ofd(&wq->bfd, AF_INET, SOCK_DGRAM, IPPROTO_UDP, mgcp->actual.local_addr,
782 mgcp->actual.local_port, mgcp->actual.remote_addr, mgcp->actual.remote_port,
783 OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT);
784 if (rc > 0)
785 return rc;
786
787 /* If there is a different port than the default port
788 * configured then we assume that the user has choosen
789 * that port conciously and we will not try to resolve
790 * this by silently choosing a different port. */
Philipp Maier9a7ccc32018-08-09 11:41:19 +0200791 if (mgcp->actual.local_port != MGCP_CLIENT_LOCAL_PORT_DEFAULT && i == 0)
Philipp Maier6a26c162018-08-01 16:37:06 +0200792 return -EINVAL;
793
794 /* Choose a new port number to try next */
795 LOGP(DLMGCP, LOGL_NOTICE,
Neels Hofmeyr0a403792018-12-12 03:10:18 +0100796 "MGCPGW failed to bind to %s:%u, retrying with port %u\n",
797 mgcp->actual.local_addr, mgcp->actual.local_port, mgcp->actual.local_port + 1);
Philipp Maier6a26c162018-08-01 16:37:06 +0200798 mgcp->actual.local_port++;
799 }
800
Neels Hofmeyr0a403792018-12-12 03:10:18 +0100801 LOGP(DLMGCP, LOGL_FATAL, "MGCPGW failed to find a port to bind on %i times.\n", i);
Philipp Maier6a26c162018-08-01 16:37:06 +0200802 return -EINVAL;
803}
804
Philipp Maier275ac972018-01-20 00:58:16 +0100805/*! Initalize client connection (opens socket only, no request is sent yet)
806 * \param[in,out] mgcp MGCP client descriptor.
807 * \returns 0 on success, -EINVAL on error. */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200808int mgcp_client_connect(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200809{
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200810 struct sockaddr_in addr;
811 struct osmo_wqueue *wq;
812 int rc;
813
814 if (!mgcp) {
815 LOGP(DLMGCP, LOGL_FATAL, "MGCPGW client not initialized properly\n");
816 return -EINVAL;
817 }
818
819 wq = &mgcp->wq;
820
Philipp Maier6a26c162018-08-01 16:37:06 +0200821 rc = init_socket(mgcp);
Harald Welte8890dfa2017-11-17 15:09:30 +0100822 if (rc < 0) {
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200823 LOGP(DLMGCP, LOGL_FATAL,
Harald Welte8890dfa2017-11-17 15:09:30 +0100824 "Failed to initialize socket %s:%u -> %s:%u for MGCP GW: %s\n",
825 mgcp->actual.local_addr, mgcp->actual.local_port,
826 mgcp->actual.remote_addr, mgcp->actual.remote_port, strerror(errno));
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200827 goto error_close_fd;
828 }
829
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200830 inet_aton(mgcp->actual.remote_addr, &addr.sin_addr);
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200831 mgcp->remote_addr = htonl(addr.sin_addr.s_addr);
832
Neels Hofmeyr3abced82020-03-10 03:55:35 +0100833 osmo_wqueue_init(wq, 1024);
Pau Espin Pedrola7152e02020-05-09 19:15:50 +0200834 wq->bfd.when = OSMO_FD_READ;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200835 wq->bfd.data = mgcp;
836 wq->read_cb = mgcp_do_read;
837 wq->write_cb = mgcp_do_write;
838
Neels Hofmeyr0a403792018-12-12 03:10:18 +0100839 LOGP(DLMGCP, LOGL_INFO, "MGCP GW connection: %s\n", osmo_sock_get_name2(wq->bfd.fd));
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200840
841 return 0;
842error_close_fd:
843 close(wq->bfd.fd);
844 wq->bfd.fd = -1;
845 return rc;
846}
847
Philipp Maier275ac972018-01-20 00:58:16 +0100848/*! Get the IP-Aaddress of the associated MGW as string.
849 * \param[in] mgcp MGCP client descriptor.
850 * \returns a pointer to the address string. */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200851const char *mgcp_client_remote_addr_str(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200852{
853 return mgcp->actual.remote_addr;
854}
855
Philipp Maier275ac972018-01-20 00:58:16 +0100856/*! Get the IP-Port of the associated MGW.
857 * \param[in] mgcp MGCP client descriptor.
858 * \returns port number. */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200859uint16_t mgcp_client_remote_port(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200860{
861 return mgcp->actual.remote_port;
862}
863
Philipp Maier275ac972018-01-20 00:58:16 +0100864/*! Get the IP-Aaddress of the associated MGW as its numeric representation.
865 * \param[in] mgcp MGCP client descriptor.
866 * \returns IP-Address as 32 bit integer (network byte order) */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200867uint32_t mgcp_client_remote_addr_n(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200868{
869 return mgcp->remote_addr;
870}
871
Neels Hofmeyrac69ea92018-12-19 00:27:50 +0100872/* To compose endpoint names, usually for CRCX, use this as domain name.
873 * For example, snprintf("rtpbridge\*@%s", mgcp_client_endpoint_domain(mgcp)). */
874const char *mgcp_client_endpoint_domain(const struct mgcp_client *mgcp)
875{
876 return mgcp->actual.endpoint_domain_name[0] ? mgcp->actual.endpoint_domain_name : "mgw";
877}
878
Pau Espin Pedrolca0818c2019-04-16 17:23:38 +0200879static const char *_mgcp_client_name_append_domain(const struct mgcp_client *mgcp, char *name)
Neels Hofmeyrac69ea92018-12-19 00:27:50 +0100880{
881 static char endpoint[MGCP_ENDPOINT_MAXLEN];
882 int rc;
883
Pau Espin Pedrolca0818c2019-04-16 17:23:38 +0200884 rc = snprintf(endpoint, sizeof(endpoint), "%s@%s", name, mgcp_client_endpoint_domain(mgcp));
Neels Hofmeyrac69ea92018-12-19 00:27:50 +0100885 if (rc > sizeof(endpoint) - 1) {
Pau Espin Pedrolca0818c2019-04-16 17:23:38 +0200886 LOGP(DLMGCP, LOGL_ERROR, "MGCP endpoint exceeds maximum length of %zu: '%s@%s'\n",
887 sizeof(endpoint) - 1, name, mgcp_client_endpoint_domain(mgcp));
Neels Hofmeyrac69ea92018-12-19 00:27:50 +0100888 return NULL;
889 }
890 if (rc < 1) {
891 LOGP(DLMGCP, LOGL_ERROR, "Cannot compose MGCP endpoint name\n");
892 return NULL;
893 }
894 return endpoint;
895}
896
Philipp Maiera466f572020-06-25 16:11:04 +0200897/*! Compose endpoint name for a wildcarded request to the virtual trunk
898 * \param[in] mgcp MGCP client descriptor.
899 * \returns string containing the endpoint name (e.g. rtpbridge\*@mgw) */
Pau Espin Pedrolca0818c2019-04-16 17:23:38 +0200900const char *mgcp_client_rtpbridge_wildcard(const struct mgcp_client *mgcp)
901{
902 return _mgcp_client_name_append_domain(mgcp, "rtpbridge/*");
903}
904
Philipp Maier48635912020-06-25 20:16:22 +0200905/*! Compose endpoint name for an E1 endpoint.
906 * \param[in] ctx talloc context.
907 * \param[in] mgcp MGCP client descriptor.
908 * \param[in] trunk_id id number of the E1 trunk (1-64).
909 * \param[in] ts timeslot on the E1 trunk (1-31).
910 * \param[in] rate bitrate used on the E1 trunk (e.g 16 for 16kbit).
911 * \param[in] offset bit offset of the E1 subslot (e.g. 4 for the third 16k subslot).
912 * \returns string containing the endpoint name (e.g. ds/e1-1/s-1/su16-4). */
913const char *mgcp_client_e1_epname(void *ctx, const struct mgcp_client *mgcp, uint8_t trunk_id, uint8_t ts,
914 uint8_t rate, uint8_t offset)
915{
916 /* See also comment in libosmo-mgcp, mgcp_client.c, gen_e1_epname() */
917 const uint8_t valid_rates[] = { 64, 32, 32, 16, 16, 16, 16, 8, 8, 8, 8, 8, 8, 8, 8 };
918 const uint8_t valid_offsets[] = { 0, 0, 4, 0, 2, 4, 6, 0, 1, 2, 3, 4, 5, 6, 7 };
919
920 uint8_t i;
921 bool rate_offs_valid = false;
922 char *epname;
923
924 epname =
925 talloc_asprintf(ctx, "ds/e1-%u/s-%u/su%u-%u@%s", trunk_id, ts, rate, offset,
926 mgcp_client_endpoint_domain(mgcp));
927 if (!epname) {
928 LOGP(DLMGCP, LOGL_ERROR, "Cannot compose MGCP e1-endpoint name!\n");
929 return NULL;
930 }
931
932 /* Check if the supplied rate/offset pair resembles a valid combination */
933 for (i = 0; i < sizeof(valid_rates); i++) {
934 if (valid_rates[i] == rate && valid_offsets[i] == offset)
935 rate_offs_valid = true;
936 }
937 if (!rate_offs_valid) {
938 LOGP(DLMGCP, LOGL_ERROR,
939 "Cannot compose MGCP e1-endpoint name (%s), rate(%u)/offset(%u) combination is invalid!\n", epname,
940 rate, offset);
941 talloc_free(epname);
942 return NULL;
943 }
944
945 /* An E1 line has a maximum of 32 timeslots, while the first (ts=0) is
946 * reserverd for framing and alignment, so we can not use it here. */
947 if (ts == 0 || ts > 31) {
948 LOGP(DLMGCP, LOGL_ERROR,
949 "Cannot compose MGCP e1-endpoint name (%s), E1-timeslot number (%u) is invalid!\n", epname, ts);
950 talloc_free(epname);
951 return NULL;
952 }
953
954 return epname;
955}
956
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200957struct mgcp_response_pending * mgcp_client_pending_add(
958 struct mgcp_client *mgcp,
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200959 mgcp_trans_id_t trans_id,
960 mgcp_response_cb_t response_cb,
961 void *priv)
962{
963 struct mgcp_response_pending *pending;
964
965 pending = talloc_zero(mgcp, struct mgcp_response_pending);
Harald Welte827da2c2020-07-15 10:57:08 +0200966 if (!pending)
967 return NULL;
968
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200969 pending->trans_id = trans_id;
970 pending->response_cb = response_cb;
971 pending->priv = priv;
972 llist_add_tail(&pending->entry, &mgcp->responses_pending);
973
974 return pending;
975}
976
977/* Send the MGCP message in msg to the MGCP GW and handle a response with
978 * response_cb. NOTE: the response_cb still needs to call
979 * mgcp_response_parse_params(response) to get the parsed parameters -- to
980 * potentially save some CPU cycles, only the head line has been parsed when
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +0100981 * the response_cb is invoked.
982 * Before the priv pointer becomes invalid, e.g. due to transaction timeout,
983 * mgcp_client_cancel() needs to be called for this transaction.
984 */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +0200985int mgcp_client_tx(struct mgcp_client *mgcp, struct msgb *msg,
986 mgcp_response_cb_t response_cb, void *priv)
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200987{
Harald Welte563ffc52020-06-17 21:54:13 +0700988 struct mgcp_response_pending *pending = NULL;
Neels Hofmeyre9920f22017-07-10 15:07:22 +0200989 mgcp_trans_id_t trans_id;
990 int rc;
991
992 trans_id = msg->cb[MSGB_CB_MGCP_TRANS_ID];
993 if (!trans_id) {
994 LOGP(DLMGCP, LOGL_ERROR,
995 "Unset transaction id in mgcp send request\n");
996 talloc_free(msg);
997 return -EINVAL;
998 }
999
Harald Welte563ffc52020-06-17 21:54:13 +07001000 /* Do not allocate a dummy 'mgcp_response_pending' entry */
1001 if (response_cb != NULL) {
1002 pending = mgcp_client_pending_add(mgcp, trans_id, response_cb, priv);
1003 if (!pending) {
1004 talloc_free(msg);
1005 return -ENOMEM;
1006 }
Harald Welte827da2c2020-07-15 10:57:08 +02001007 }
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001008
1009 if (msgb_l2len(msg) > 4096) {
1010 LOGP(DLMGCP, LOGL_ERROR,
1011 "Cannot send, MGCP message too large: %u\n",
1012 msgb_l2len(msg));
1013 msgb_free(msg);
1014 rc = -EINVAL;
1015 goto mgcp_tx_error;
1016 }
1017
1018 rc = osmo_wqueue_enqueue(&mgcp->wq, msg);
1019 if (rc) {
1020 LOGP(DLMGCP, LOGL_FATAL, "Could not queue message to MGCP GW\n");
1021 msgb_free(msg);
1022 goto mgcp_tx_error;
1023 } else
Neels Hofmeyred0c1aa2018-12-21 03:07:53 +01001024 LOGP(DLMGCP, LOGL_DEBUG, "Queued %u bytes for MGCP GW\n",
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001025 msgb_l2len(msg));
1026 return 0;
1027
1028mgcp_tx_error:
Harald Welte563ffc52020-06-17 21:54:13 +07001029 if (!pending)
Vadim Yanitskiyffbc6182020-07-16 15:48:13 +07001030 return rc;
Vadim Yanitskiy3f8139c2020-06-17 20:50:17 +07001031 /* Dequeue pending response, it's going to be free()d */
1032 llist_del(&pending->entry);
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001033 /* Pass NULL to response cb to indicate an error */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001034 mgcp_client_handle_response(mgcp, pending, NULL);
Vadim Yanitskiyffbc6182020-07-16 15:48:13 +07001035 return rc;
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001036}
1037
Philipp Maier275ac972018-01-20 00:58:16 +01001038/*! Cancel a pending transaction.
1039 * \param[in] mgcp MGCP client descriptor.
1040 * \param[in,out] trans_id Transaction id.
1041 * \returns 0 on success, -ENOENT on error.
1042 *
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001043 * Should a priv pointer passed to mgcp_client_tx() become invalid, this function must be called. In
1044 * practical terms, if the caller of mgcp_client_tx() wishes to tear down a transaction without having
1045 * received a response this function must be called. The trans_id can be obtained by calling
Philipp Maier275ac972018-01-20 00:58:16 +01001046 * mgcp_msg_trans_id() on the msgb produced by mgcp_msg_gen(). */
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001047int mgcp_client_cancel(struct mgcp_client *mgcp, mgcp_trans_id_t trans_id)
1048{
1049 struct mgcp_response_pending *pending = mgcp_client_response_pending_get(mgcp, trans_id);
1050 if (!pending) {
Philipp Maier275ac972018-01-20 00:58:16 +01001051 /*! Note: it is not harmful to cancel a transaction twice. */
Neels Hofmeyred0c1aa2018-12-21 03:07:53 +01001052 LOGP(DLMGCP, LOGL_ERROR, "Cannot cancel, no such transaction: %u\n", trans_id);
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001053 return -ENOENT;
1054 }
Neels Hofmeyred0c1aa2018-12-21 03:07:53 +01001055 LOGP(DLMGCP, LOGL_DEBUG, "Canceled transaction %u\n", trans_id);
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001056 talloc_free(pending);
1057 return 0;
Philipp Maier275ac972018-01-20 00:58:16 +01001058 /*! We don't really need to clean up the wqueue: In all sane cases, the msgb has already been sent
1059 * out and is no longer in the wqueue. If it still is in the wqueue, then sending MGCP messages
1060 * per se is broken and the program should notice so by a full wqueue. Even if this was called
1061 * before we had a chance to send out the message and it is still going to be sent, we will just
1062 * ignore the reply to it later. Removing a msgb from the wqueue here would just introduce more
1063 * bug surface in terms of failing to update wqueue API's counters or some such.
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001064 */
1065}
1066
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001067static mgcp_trans_id_t mgcp_client_next_trans_id(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001068{
1069 /* avoid zero trans_id to distinguish from unset trans_id */
1070 if (!mgcp->next_trans_id)
1071 mgcp->next_trans_id ++;
1072 return mgcp->next_trans_id ++;
1073}
1074
Philipp Maier1dc6be62017-10-05 18:25:37 +02001075#define MGCP_CRCX_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT | \
1076 MGCP_MSG_PRESENCE_CALL_ID | \
Philipp Maier1dc6be62017-10-05 18:25:37 +02001077 MGCP_MSG_PRESENCE_CONN_MODE)
1078#define MGCP_MDCX_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT | \
Philipp Maier490cbaa2018-01-22 17:32:38 +01001079 MGCP_MSG_PRESENCE_CALL_ID | \
Philipp Maier1dc6be62017-10-05 18:25:37 +02001080 MGCP_MSG_PRESENCE_CONN_ID)
1081#define MGCP_DLCX_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT)
1082#define MGCP_AUEP_MANDATORY (MGCP_MSG_PRESENCE_ENDPOINT)
1083#define MGCP_RSIP_MANDATORY 0 /* none */
1084
Philipp Maier704c4f02018-06-07 18:51:31 +02001085/* Helper function for mgcp_msg_gen(): Add LCO information to MGCP message */
1086static int add_lco(struct msgb *msg, struct mgcp_msg *mgcp_msg)
1087{
1088 unsigned int i;
1089 int rc = 0;
1090 const char *codec;
1091 unsigned int pt;
1092
1093 rc += msgb_printf(msg, "L:");
1094
1095 if (mgcp_msg->ptime)
1096 rc += msgb_printf(msg, " p:%u,", mgcp_msg->ptime);
1097
1098 if (mgcp_msg->codecs_len) {
1099 rc += msgb_printf(msg, " a:");
1100 for (i = 0; i < mgcp_msg->codecs_len; i++) {
1101 pt = mgcp_msg->codecs[i];
Neels Hofmeyr47642f22019-02-27 05:56:53 +01001102 codec = get_value_string_or_null(osmo_mgcpc_codec_names, pt);
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +02001103
Philipp Maier704c4f02018-06-07 18:51:31 +02001104 /* Note: Use codec descriptors from enum mgcp_codecs
1105 * in mgcp_client only! */
1106 OSMO_ASSERT(codec);
1107 rc += msgb_printf(msg, "%s", extract_codec_name(codec));
1108 if (i < mgcp_msg->codecs_len - 1)
1109 rc += msgb_printf(msg, ";");
1110 }
1111 rc += msgb_printf(msg, ",");
1112 }
1113
1114 rc += msgb_printf(msg, " nt:IN\r\n");
1115
1116 return rc;
1117}
1118
1119/* Helper function for mgcp_msg_gen(): Add SDP information to MGCP message */
1120static int add_sdp(struct msgb *msg, struct mgcp_msg *mgcp_msg, struct mgcp_client *mgcp)
1121{
1122 unsigned int i;
1123 int rc = 0;
1124 char local_ip[INET_ADDRSTRLEN];
1125 const char *codec;
1126 unsigned int pt;
1127
1128 /* Add separator to mark the beginning of the SDP block */
1129 rc += msgb_printf(msg, "\r\n");
1130
1131 /* Add SDP protocol version */
1132 rc += msgb_printf(msg, "v=0\r\n");
1133
1134 /* Determine local IP-Address */
1135 if (osmo_sock_local_ip(local_ip, mgcp->actual.remote_addr) < 0) {
1136 LOGP(DLMGCP, LOGL_ERROR,
1137 "Could not determine local IP-Address!\n");
1138 msgb_free(msg);
1139 return -2;
1140 }
1141
1142 /* Add owner/creator (SDP) */
1143 rc += msgb_printf(msg, "o=- %x 23 IN IP4 %s\r\n",
1144 mgcp_msg->call_id, local_ip);
1145
1146 /* Add session name (none) */
1147 rc += msgb_printf(msg, "s=-\r\n");
1148
1149 /* Add RTP address and port */
1150 if (mgcp_msg->audio_port == 0) {
1151 LOGP(DLMGCP, LOGL_ERROR,
1152 "Invalid port number, can not generate MGCP message\n");
1153 msgb_free(msg);
1154 return -2;
1155 }
1156 if (strlen(mgcp_msg->audio_ip) <= 0) {
1157 LOGP(DLMGCP, LOGL_ERROR,
1158 "Empty ip address, can not generate MGCP message\n");
1159 msgb_free(msg);
1160 return -2;
1161 }
1162 rc += msgb_printf(msg, "c=IN IP4 %s\r\n", mgcp_msg->audio_ip);
1163
1164 /* Add time description, active time (SDP) */
1165 rc += msgb_printf(msg, "t=0 0\r\n");
1166
1167 rc += msgb_printf(msg, "m=audio %u RTP/AVP", mgcp_msg->audio_port);
1168 for (i = 0; i < mgcp_msg->codecs_len; i++) {
1169 pt = map_codec_to_pt(mgcp_msg->ptmap, mgcp_msg->ptmap_len, mgcp_msg->codecs[i]);
1170 rc += msgb_printf(msg, " %u", pt);
1171
1172 }
1173 rc += msgb_printf(msg, "\r\n");
1174
Philipp Maier228e5912019-03-05 13:56:59 +01001175 /* Add optional codec parameters (fmtp) */
1176 if (mgcp_msg->param_present) {
1177 for (i = 0; i < mgcp_msg->codecs_len; i++) {
1178 /* The following is only applicable for AMR */
1179 if (mgcp_msg->codecs[i] != CODEC_AMR_8000_1 && mgcp_msg->codecs[i] != CODEC_AMRWB_16000_1)
1180 continue;
1181 pt = map_codec_to_pt(mgcp_msg->ptmap, mgcp_msg->ptmap_len, mgcp_msg->codecs[i]);
1182 if (mgcp_msg->param.amr_octet_aligned_present && mgcp_msg->param.amr_octet_aligned)
1183 rc += msgb_printf(msg, "a=fmtp:%u octet-align=1\r\n", pt);
1184 else if (mgcp_msg->param.amr_octet_aligned_present && !mgcp_msg->param.amr_octet_aligned)
1185 rc += msgb_printf(msg, "a=fmtp:%u octet-align=0\r\n", pt);
1186 }
1187 }
1188
Philipp Maier704c4f02018-06-07 18:51:31 +02001189 for (i = 0; i < mgcp_msg->codecs_len; i++) {
1190 pt = map_codec_to_pt(mgcp_msg->ptmap, mgcp_msg->ptmap_len, mgcp_msg->codecs[i]);
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +02001191
Philipp Maier704c4f02018-06-07 18:51:31 +02001192 /* Note: Only dynamic payload type from the range 96-127
1193 * require to be explained further via rtpmap. All others
1194 * are implcitly definedby the number in m=audio */
1195 if (pt >= 96 && pt <= 127) {
Neels Hofmeyr47642f22019-02-27 05:56:53 +01001196 codec = get_value_string_or_null(osmo_mgcpc_codec_names, mgcp_msg->codecs[i]);
Philipp Maier704c4f02018-06-07 18:51:31 +02001197
1198 /* Note: Use codec descriptors from enum mgcp_codecs
1199 * in mgcp_client only! */
1200 OSMO_ASSERT(codec);
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +02001201
Philipp Maier704c4f02018-06-07 18:51:31 +02001202 rc += msgb_printf(msg, "a=rtpmap:%u %s\r\n", pt, codec);
1203 }
1204 }
Pau Espin Pedrolc12bfb72019-04-16 17:23:09 +02001205
Philipp Maier704c4f02018-06-07 18:51:31 +02001206 if (mgcp_msg->ptime)
1207 rc += msgb_printf(msg, "a=ptime:%u\r\n", mgcp_msg->ptime);
1208
1209 return rc;
1210}
1211
Philipp Maier275ac972018-01-20 00:58:16 +01001212/*! Generate an MGCP message
1213 * \param[in] mgcp MGCP client descriptor.
1214 * \param[in] mgcp_msg Message description
1215 * \returns message buffer on success, NULL on error. */
Philipp Maier1dc6be62017-10-05 18:25:37 +02001216struct msgb *mgcp_msg_gen(struct mgcp_client *mgcp, struct mgcp_msg *mgcp_msg)
1217{
1218 mgcp_trans_id_t trans_id = mgcp_client_next_trans_id(mgcp);
1219 uint32_t mandatory_mask;
1220 struct msgb *msg = msgb_alloc_headroom(4096, 128, "MGCP tx");
1221 int rc = 0;
Philipp Maier704c4f02018-06-07 18:51:31 +02001222 int rc_sdp;
1223 bool use_sdp = false;
Pau Espin Pedrol900cd652019-04-24 22:06:22 +02001224 char buf[32];
Philipp Maier1dc6be62017-10-05 18:25:37 +02001225
1226 msg->l2h = msg->data;
1227 msg->cb[MSGB_CB_MGCP_TRANS_ID] = trans_id;
1228
1229 /* Add command verb */
1230 switch (mgcp_msg->verb) {
1231 case MGCP_VERB_CRCX:
1232 mandatory_mask = MGCP_CRCX_MANDATORY;
1233 rc += msgb_printf(msg, "CRCX %u", trans_id);
1234 break;
1235 case MGCP_VERB_MDCX:
1236 mandatory_mask = MGCP_MDCX_MANDATORY;
1237 rc += msgb_printf(msg, "MDCX %u", trans_id);
1238 break;
1239 case MGCP_VERB_DLCX:
1240 mandatory_mask = MGCP_DLCX_MANDATORY;
1241 rc += msgb_printf(msg, "DLCX %u", trans_id);
1242 break;
1243 case MGCP_VERB_AUEP:
1244 mandatory_mask = MGCP_AUEP_MANDATORY;
1245 rc += msgb_printf(msg, "AUEP %u", trans_id);
1246 break;
1247 case MGCP_VERB_RSIP:
1248 mandatory_mask = MGCP_RSIP_MANDATORY;
1249 rc += msgb_printf(msg, "RSIP %u", trans_id);
1250 break;
1251 default:
1252 LOGP(DLMGCP, LOGL_ERROR,
1253 "Invalid command verb, can not generate MGCP message\n");
1254 msgb_free(msg);
1255 return NULL;
1256 }
1257
1258 /* Check if mandatory fields are missing */
1259 if (!((mgcp_msg->presence & mandatory_mask) == mandatory_mask)) {
1260 LOGP(DLMGCP, LOGL_ERROR,
1261 "One or more missing mandatory fields, can not generate MGCP message\n");
1262 msgb_free(msg);
1263 return NULL;
1264 }
1265
1266 /* Add endpoint name */
Philipp Maier7bc55522017-12-10 22:52:22 +01001267 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_ENDPOINT) {
1268 if (strlen(mgcp_msg->endpoint) <= 0) {
1269 LOGP(DLMGCP, LOGL_ERROR,
1270 "Empty endpoint name, can not generate MGCP message\n");
1271 msgb_free(msg);
1272 return NULL;
1273 }
Philipp Maier3aa81572018-01-31 14:13:45 +01001274
1275 if (strstr(mgcp_msg->endpoint, "@") == NULL) {
1276 LOGP(DLMGCP, LOGL_ERROR,
1277 "Endpoint name (%s) lacks separator (@), can not generate MGCP message\n",
1278 mgcp_msg->endpoint);
1279 msgb_free(msg);
Vadim Yanitskiye6743452020-06-18 03:04:13 +07001280 return NULL;
Philipp Maier3aa81572018-01-31 14:13:45 +01001281 }
1282
Philipp Maier1dc6be62017-10-05 18:25:37 +02001283 rc += msgb_printf(msg, " %s", mgcp_msg->endpoint);
Philipp Maier7bc55522017-12-10 22:52:22 +01001284 }
Philipp Maier1dc6be62017-10-05 18:25:37 +02001285
1286 /* Add protocol version */
1287 rc += msgb_printf(msg, " MGCP 1.0\r\n");
1288
1289 /* Add call id */
1290 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_CALL_ID)
1291 rc += msgb_printf(msg, "C: %x\r\n", mgcp_msg->call_id);
1292
1293 /* Add connection id */
Philipp Maier7bc55522017-12-10 22:52:22 +01001294 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_CONN_ID) {
1295 if (strlen(mgcp_msg->conn_id) <= 0) {
1296 LOGP(DLMGCP, LOGL_ERROR,
1297 "Empty connection id, can not generate MGCP message\n");
1298 msgb_free(msg);
1299 return NULL;
1300 }
Philipp Maier01d24a32017-11-21 17:26:09 +01001301 rc += msgb_printf(msg, "I: %s\r\n", mgcp_msg->conn_id);
Philipp Maier7bc55522017-12-10 22:52:22 +01001302 }
Philipp Maier1dc6be62017-10-05 18:25:37 +02001303
Philipp Maier704c4f02018-06-07 18:51:31 +02001304 /* Using SDP makes sense when a valid IP/Port combination is specifiec,
1305 * if we do not know this information yet, we fall back to LCO */
1306 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_AUDIO_IP
1307 && mgcp_msg->presence & MGCP_MSG_PRESENCE_AUDIO_PORT)
1308 use_sdp = true;
1309
1310 /* Add local connection options (LCO) */
1311 if (!use_sdp
1312 && (mgcp_msg->verb == MGCP_VERB_CRCX
1313 || mgcp_msg->verb == MGCP_VERB_MDCX))
1314 rc += add_lco(msg, mgcp_msg);
Philipp Maier1dc6be62017-10-05 18:25:37 +02001315
1316 /* Add mode */
1317 if (mgcp_msg->presence & MGCP_MSG_PRESENCE_CONN_MODE)
1318 rc +=
1319 msgb_printf(msg, "M: %s\r\n",
1320 mgcp_client_cmode_name(mgcp_msg->conn_mode));
1321
Neels Hofmeyre6d8e912018-08-23 16:36:48 +02001322 /* Add X-Osmo-IGN */
1323 if ((mgcp_msg->presence & MGCP_MSG_PRESENCE_X_OSMO_IGN)
1324 && (mgcp_msg->x_osmo_ign != 0))
1325 rc +=
1326 msgb_printf(msg, MGCP_X_OSMO_IGN_HEADER "%s\r\n",
1327 mgcp_msg->x_osmo_ign & MGCP_X_OSMO_IGN_CALLID ? " C": "");
1328
Pau Espin Pedrol900cd652019-04-24 22:06:22 +02001329 /* Add X-Osmo-Osmux */
1330 if ((mgcp_msg->presence & MGCP_MSG_PRESENCE_X_OSMO_OSMUX_CID)) {
Pau Espin Pedrol1b1d7ed2019-05-23 16:48:24 +02001331 if (mgcp_msg->x_osmo_osmux_cid < -1 || mgcp_msg->x_osmo_osmux_cid > OSMUX_CID_MAX) {
1332 LOGP(DLMGCP, LOGL_ERROR,
1333 "Wrong Osmux CID %d, can not generate MGCP message\n",
1334 mgcp_msg->x_osmo_osmux_cid);
1335 msgb_free(msg);
1336 return NULL;
1337 }
Pau Espin Pedrol900cd652019-04-24 22:06:22 +02001338 snprintf(buf, sizeof(buf), " %d", mgcp_msg->x_osmo_osmux_cid);
1339 rc +=
1340 msgb_printf(msg, MGCP_X_OSMO_OSMUX_HEADER "%s\r\n",
1341 mgcp_msg->x_osmo_osmux_cid == -1 ? " *": buf);
1342 }
1343
1344
Philipp Maier704c4f02018-06-07 18:51:31 +02001345 /* Add session description protocol (SDP) */
1346 if (use_sdp
1347 && (mgcp_msg->verb == MGCP_VERB_CRCX
1348 || mgcp_msg->verb == MGCP_VERB_MDCX)) {
1349 rc_sdp = add_sdp(msg, mgcp_msg, mgcp);
1350 if (rc_sdp == -2)
Philipp Maier9d25d7a2018-01-22 17:31:10 +01001351 return NULL;
Philipp Maier704c4f02018-06-07 18:51:31 +02001352 else
1353 rc += rc_sdp;
Philipp Maier1dc6be62017-10-05 18:25:37 +02001354 }
1355
1356 if (rc != 0) {
1357 LOGP(DLMGCP, LOGL_ERROR,
1358 "message buffer to small, can not generate MGCP message\n");
1359 msgb_free(msg);
1360 msg = NULL;
1361 }
1362
1363 return msg;
1364}
1365
Philipp Maier275ac972018-01-20 00:58:16 +01001366/*! Retrieve the MGCP transaction ID from a msgb generated by mgcp_msg_gen()
1367 * \param[in] msg message buffer
1368 * \returns Transaction id. */
Neels Hofmeyrc8f37cb2017-11-30 13:43:11 +01001369mgcp_trans_id_t mgcp_msg_trans_id(struct msgb *msg)
1370{
1371 return (mgcp_trans_id_t)msg->cb[MSGB_CB_MGCP_TRANS_ID];
1372}
1373
Philipp Maier275ac972018-01-20 00:58:16 +01001374/*! Get the configuration parameters a given MGCP client instance
1375 * \param[in] mgcp MGCP client descriptor.
1376 * \returns configuration */
Neels Hofmeyr3a8e7232017-09-04 01:02:56 +02001377struct mgcp_client_conf *mgcp_client_conf_actual(struct mgcp_client *mgcp)
Neels Hofmeyre9920f22017-07-10 15:07:22 +02001378{
1379 return &mgcp->actual;
1380}
Neels Hofmeyrd95ab1e2017-09-22 00:52:54 +02001381
1382const struct value_string mgcp_client_connection_mode_strs[] = {
1383 { MGCP_CONN_NONE, "none" },
1384 { MGCP_CONN_RECV_SEND, "sendrecv" },
1385 { MGCP_CONN_SEND_ONLY, "sendonly" },
1386 { MGCP_CONN_RECV_ONLY, "recvonly" },
1387 { MGCP_CONN_LOOPBACK, "loopback" },
1388 { 0, NULL }
1389};