Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 1 | /* A Media Gateway Control Protocol Media Gateway: RFC 3435 */ |
| 2 | |
| 3 | /* |
| 4 | * (C) 2009-2012 by Holger Hans Peter Freyther <zecke@selfish.org> |
| 5 | * (C) 2009-2012 by On-Waves |
| 6 | * All Rights Reserved |
| 7 | * |
| 8 | * This program is free software; you can redistribute it and/or modify |
| 9 | * it under the terms of the GNU Affero General Public License as published by |
| 10 | * the Free Software Foundation; either version 3 of the License, or |
| 11 | * (at your option) any later version. |
| 12 | * |
| 13 | * This program is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU Affero General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU Affero General Public License |
| 19 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 20 | * |
| 21 | */ |
| 22 | |
Philipp Maier | 87bd9be | 2017-08-22 16:35:41 +0200 | [diff] [blame] | 23 | #pragma once |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 24 | |
| 25 | #include <osmocom/core/msgb.h> |
| 26 | #include <osmocom/core/write_queue.h> |
| 27 | #include <osmocom/core/timer.h> |
| 28 | #include <osmocom/core/logging.h> |
| 29 | |
Neels Hofmeyr | 6779354 | 2017-09-08 04:25:16 +0200 | [diff] [blame] | 30 | #include <osmocom/mgcp/mgcp_common.h> |
| 31 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 32 | #include <arpa/inet.h> |
| 33 | #include <sys/types.h> |
| 34 | #include <sys/socket.h> |
| 35 | #include <netinet/in.h> |
| 36 | |
Philipp Maier | 87bd9be | 2017-08-22 16:35:41 +0200 | [diff] [blame] | 37 | #define RTP_PORT_DEFAULT_RANGE_START 16002 |
| 38 | #define RTP_PORT_DEFAULT_RANGE_END RTP_PORT_DEFAULT_RANGE_START + 64 |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 39 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 40 | /* |
| 41 | * Handling of MGCP Endpoints and the MGCP Config |
| 42 | */ |
| 43 | struct mgcp_endpoint; |
| 44 | struct mgcp_config; |
| 45 | struct mgcp_trunk_config; |
| 46 | struct mgcp_rtp_end; |
| 47 | |
| 48 | #define MGCP_ENDP_CRCX 1 |
| 49 | #define MGCP_ENDP_DLCX 2 |
| 50 | #define MGCP_ENDP_MDCX 3 |
| 51 | |
| 52 | /* |
| 53 | * what to do with the msg? |
| 54 | * - continue as usual? |
| 55 | * - reject and send a failure code? |
| 56 | * - defer? do not send anything |
| 57 | */ |
| 58 | #define MGCP_POLICY_CONT 4 |
| 59 | #define MGCP_POLICY_REJECT 5 |
| 60 | #define MGCP_POLICY_DEFER 6 |
| 61 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 62 | typedef int (*mgcp_change)(struct mgcp_trunk_config *cfg, int endpoint, int state); |
| 63 | typedef int (*mgcp_policy)(struct mgcp_trunk_config *cfg, int endpoint, int state, const char *transactio_id); |
| 64 | typedef int (*mgcp_reset)(struct mgcp_trunk_config *cfg); |
| 65 | typedef int (*mgcp_rqnt)(struct mgcp_endpoint *endp, char tone); |
| 66 | |
| 67 | /** |
| 68 | * Return: |
| 69 | * < 0 in case no audio was processed |
| 70 | * >= 0 in case audio was processed. The remaining payload |
| 71 | * length will be returned. |
| 72 | */ |
| 73 | typedef int (*mgcp_processing)(struct mgcp_endpoint *endp, |
| 74 | struct mgcp_rtp_end *dst_end, |
| 75 | char *data, int *len, int buf_size); |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 76 | |
Philipp Maier | 87bd9be | 2017-08-22 16:35:41 +0200 | [diff] [blame] | 77 | struct mgcp_conn_rtp; |
Philipp Maier | acc1035 | 2018-07-19 18:07:57 +0200 | [diff] [blame] | 78 | |
| 79 | typedef int (*mgcp_processing_setup)(struct mgcp_endpoint *endp, |
| 80 | struct mgcp_conn_rtp *conn_dst, |
| 81 | struct mgcp_conn_rtp *conn_src); |
| 82 | |
Philipp Maier | 5812825 | 2019-03-06 11:28:18 +0100 | [diff] [blame] | 83 | struct mgcp_rtp_codec; |
| 84 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 85 | typedef void (*mgcp_get_format)(struct mgcp_endpoint *endp, |
Philipp Maier | 5812825 | 2019-03-06 11:28:18 +0100 | [diff] [blame] | 86 | const struct mgcp_rtp_codec **codec, |
| 87 | const char **fmtp_extra, |
Philipp Maier | 87bd9be | 2017-08-22 16:35:41 +0200 | [diff] [blame] | 88 | struct mgcp_conn_rtp *conn); |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 89 | |
| 90 | /** |
| 91 | * This holds information on how to allocate ports |
| 92 | */ |
| 93 | struct mgcp_port_range { |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 94 | /* addr or NULL to fall-back to default */ |
| 95 | char *bind_addr; |
| 96 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 97 | /* dynamically allocated */ |
| 98 | int range_start; |
| 99 | int range_end; |
| 100 | int last_port; |
Philipp Maier | 1cb1e38 | 2017-11-02 17:16:04 +0100 | [diff] [blame] | 101 | |
| 102 | /* set to true to enable automatic probing |
| 103 | * of the local bind IP-Address, bind_addr |
| 104 | * (or its fall back) is used when automatic |
| 105 | * probing fails */ |
| 106 | bool bind_addr_probe; |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 107 | }; |
| 108 | |
Philipp Maier | e726d4f | 2017-11-01 10:41:34 +0100 | [diff] [blame] | 109 | /* There are up to three modes in which the keep-alive dummy packet can be |
Harald Welte | 1d1b98f | 2017-12-25 10:03:40 +0100 | [diff] [blame] | 110 | * sent. The behaviour is controlled via the keepalive_interval member of the |
Philipp Maier | e726d4f | 2017-11-01 10:41:34 +0100 | [diff] [blame] | 111 | * trunk config. If that member is set to 0 (MGCP_KEEPALIVE_NEVER) no dummy- |
| 112 | * packet is sent at all and the timer that sends regular dummy packets |
| 113 | * is no longer scheduled. If the keepalive_interval is set to -1, only |
| 114 | * one dummy packet is sent when an CRCX or an MDCX is performed. No timer |
Harald Welte | 1d1b98f | 2017-12-25 10:03:40 +0100 | [diff] [blame] | 115 | * is scheduled. For all vales greater 0, the timer is scheduled and the |
Philipp Maier | e726d4f | 2017-11-01 10:41:34 +0100 | [diff] [blame] | 116 | * value is used as interval. See also mgcp_keepalive_timer_cb(), |
| 117 | * handle_modify_con(), and handle_create_con() */ |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 118 | #define MGCP_KEEPALIVE_ONCE (-1) |
Philipp Maier | e726d4f | 2017-11-01 10:41:34 +0100 | [diff] [blame] | 119 | #define MGCP_KEEPALIVE_NEVER 0 |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 120 | |
Alexander Chemeris | 6386600 | 2020-05-05 17:18:40 +0300 | [diff] [blame] | 121 | /* Global MCGP general rate counters */ |
| 122 | enum { |
| 123 | MGCP_GENERAL_RX_MSGS_TOTAL, |
| 124 | MGCP_GENERAL_RX_MSGS_RETRANSMITTED, |
| 125 | MGCP_GENERAL_RX_MSGS_HANDLED, |
| 126 | MGCP_GENERAL_RX_MSGS_UNHANDLED, |
| 127 | MGCP_GENERAL_RX_FAIL_MSG_PARSE, |
| 128 | MGCP_GENERAL_RX_FAIL_NO_ENDPOINT, |
| 129 | }; |
| 130 | |
Stefan Sperling | 1e17487 | 2018-10-25 18:36:10 +0200 | [diff] [blame] | 131 | /* Global MCGP CRCX related rate counters */ |
| 132 | enum { |
| 133 | MGCP_CRCX_SUCCESS, |
| 134 | MGCP_CRCX_FAIL_BAD_ACTION, |
| 135 | MGCP_CRCX_FAIL_UNHANDLED_PARAM, |
| 136 | MGCP_CRCX_FAIL_MISSING_CALLID, |
| 137 | MGCP_CRCX_FAIL_INVALID_MODE, |
| 138 | MGCP_CRCX_FAIL_LIMIT_EXCEEDED, |
| 139 | MGCP_CRCX_FAIL_UNKNOWN_CALLID, |
| 140 | MGCP_CRCX_FAIL_ALLOC_CONN, |
| 141 | MGCP_CRCX_FAIL_NO_REMOTE_CONN_DESC, |
| 142 | MGCP_CRCX_FAIL_START_RTP, |
| 143 | MGCP_CRCX_FAIL_REJECTED_BY_POLICY, |
Stefan Sperling | a714abf | 2018-10-29 14:19:54 +0100 | [diff] [blame] | 144 | MGCP_CRCX_FAIL_NO_OSMUX, |
| 145 | MGCP_CRCX_FAIL_INVALID_CONN_OPTIONS, |
| 146 | MGCP_CRCX_FAIL_CODEC_NEGOTIATION, |
| 147 | MGCP_CRCX_FAIL_BIND_PORT, |
Stefan Sperling | 1e17487 | 2018-10-25 18:36:10 +0200 | [diff] [blame] | 148 | }; |
| 149 | |
Stefan Sperling | aa823bf | 2018-10-29 14:51:41 +0100 | [diff] [blame] | 150 | /* Global MCGP MDCX related rate counters */ |
| 151 | enum { |
| 152 | MGCP_MDCX_SUCCESS, |
| 153 | MGCP_MDCX_FAIL_WILDCARD, |
| 154 | MGCP_MDCX_FAIL_NO_CONN, |
| 155 | MGCP_MDCX_FAIL_INVALID_CALLID, |
| 156 | MGCP_MDCX_FAIL_INVALID_CONNID, |
| 157 | MGCP_MDCX_FAIL_UNHANDLED_PARAM, |
| 158 | MGCP_MDCX_FAIL_NO_CONNID, |
| 159 | MGCP_MDCX_FAIL_CONN_NOT_FOUND, |
| 160 | MGCP_MDCX_FAIL_INVALID_MODE, |
| 161 | MGCP_MDCX_FAIL_INVALID_CONN_OPTIONS, |
| 162 | MGCP_MDCX_FAIL_NO_REMOTE_CONN_DESC, |
| 163 | MGCP_MDCX_FAIL_START_RTP, |
| 164 | MGCP_MDCX_FAIL_REJECTED_BY_POLICY, |
Stefan Sperling | 8ab3fbb | 2018-10-30 14:57:25 +0100 | [diff] [blame] | 165 | MGCP_MDCX_DEFERRED_BY_POLICY |
Stefan Sperling | aa823bf | 2018-10-29 14:51:41 +0100 | [diff] [blame] | 166 | }; |
| 167 | |
Stefan Sperling | 8ab3fbb | 2018-10-30 14:57:25 +0100 | [diff] [blame] | 168 | /* Global MCGP DLCX related rate counters */ |
| 169 | enum { |
| 170 | MGCP_DLCX_SUCCESS, |
| 171 | MGCP_DLCX_FAIL_WILDCARD, |
| 172 | MGCP_DLCX_FAIL_NO_CONN, |
| 173 | MGCP_DLCX_FAIL_INVALID_CALLID, |
| 174 | MGCP_DLCX_FAIL_INVALID_CONNID, |
| 175 | MGCP_DLCX_FAIL_UNHANDLED_PARAM, |
| 176 | MGCP_DLCX_FAIL_REJECTED_BY_POLICY, |
| 177 | MGCP_DLCX_DEFERRED_BY_POLICY, |
| 178 | }; |
Stefan Sperling | aa823bf | 2018-10-29 14:51:41 +0100 | [diff] [blame] | 179 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 180 | struct mgcp_trunk_config { |
| 181 | struct llist_head entry; |
| 182 | |
| 183 | struct mgcp_config *cfg; |
| 184 | |
| 185 | int trunk_nr; |
| 186 | int trunk_type; |
| 187 | |
| 188 | char *audio_fmtp_extra; |
| 189 | char *audio_name; |
| 190 | int audio_payload; |
| 191 | int audio_send_ptime; |
| 192 | int audio_send_name; |
| 193 | int audio_loop; |
| 194 | |
| 195 | int no_audio_transcoding; |
| 196 | |
| 197 | int omit_rtcp; |
| 198 | int keepalive_interval; |
| 199 | |
| 200 | /* RTP patching */ |
| 201 | int force_constant_ssrc; /* 0: don't, 1: once */ |
| 202 | int force_aligned_timing; |
Philipp Maier | 9fc8a02 | 2019-02-20 12:26:52 +0100 | [diff] [blame] | 203 | bool rfc5993_hr_convert; |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 204 | |
| 205 | /* spec handling */ |
| 206 | int force_realloc; |
| 207 | |
| 208 | /* timer */ |
| 209 | struct osmo_timer_list keepalive_timer; |
| 210 | |
Philipp Maier | 87bd9be | 2017-08-22 16:35:41 +0200 | [diff] [blame] | 211 | /* When set, incoming RTP packets are not filtered |
| 212 | * when ports and ip-address do not match (debug) */ |
| 213 | int rtp_accept_all; |
| 214 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 215 | unsigned int number_endpoints; |
Philipp Maier | fcd0655 | 2017-11-10 17:32:22 +0100 | [diff] [blame] | 216 | int vty_number_endpoints; |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 217 | struct mgcp_endpoint *endpoints; |
Stefan Sperling | 1e17487 | 2018-10-25 18:36:10 +0200 | [diff] [blame] | 218 | |
Alexander Chemeris | 6386600 | 2020-05-05 17:18:40 +0300 | [diff] [blame] | 219 | /* Rate counter group which contains stats for generic MGCP events. */ |
| 220 | struct rate_ctr_group *mgcp_general_ctr_group; |
Stefan Sperling | ba25eab | 2018-10-30 14:32:31 +0100 | [diff] [blame] | 221 | /* Rate counter group which contains stats for processed CRCX commands. */ |
Stefan Sperling | 1e17487 | 2018-10-25 18:36:10 +0200 | [diff] [blame] | 222 | struct rate_ctr_group *mgcp_crcx_ctr_group; |
Stefan Sperling | ba25eab | 2018-10-30 14:32:31 +0100 | [diff] [blame] | 223 | /* Rate counter group which contains stats for processed MDCX commands. */ |
Stefan Sperling | aa823bf | 2018-10-29 14:51:41 +0100 | [diff] [blame] | 224 | struct rate_ctr_group *mgcp_mdcx_ctr_group; |
Stefan Sperling | 8ab3fbb | 2018-10-30 14:57:25 +0100 | [diff] [blame] | 225 | /* Rate counter group which contains stats for processed DLCX commands. */ |
| 226 | struct rate_ctr_group *mgcp_dlcx_ctr_group; |
Stefan Sperling | ba25eab | 2018-10-30 14:32:31 +0100 | [diff] [blame] | 227 | /* Rate counter group which aggregates stats of individual RTP connections. */ |
| 228 | struct rate_ctr_group *all_rtp_conn_stats; |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 229 | }; |
| 230 | |
| 231 | enum mgcp_role { |
| 232 | MGCP_BSC = 0, |
| 233 | MGCP_BSC_NAT, |
| 234 | }; |
| 235 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 236 | struct mgcp_config { |
| 237 | int source_port; |
| 238 | char *local_ip; |
| 239 | char *source_addr; |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 240 | char *call_agent_addr; |
| 241 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 242 | /* RTP processing */ |
| 243 | mgcp_processing rtp_processing_cb; |
| 244 | mgcp_processing_setup setup_rtp_processing_cb; |
| 245 | |
| 246 | mgcp_get_format get_net_downlink_format_cb; |
| 247 | |
| 248 | struct osmo_wqueue gw_fd; |
| 249 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 250 | struct mgcp_port_range net_ports; |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 251 | int endp_dscp; |
| 252 | |
Philipp Maier | 87bd9be | 2017-08-22 16:35:41 +0200 | [diff] [blame] | 253 | int force_ptime; |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 254 | |
| 255 | mgcp_change change_cb; |
| 256 | mgcp_policy policy_cb; |
| 257 | mgcp_reset reset_cb; |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 258 | mgcp_rqnt rqnt_cb; |
| 259 | void *data; |
| 260 | |
| 261 | uint32_t last_call_id; |
| 262 | |
| 263 | /* trunk handling */ |
Harald Welte | c39b1bf | 2020-03-08 11:29:39 +0100 | [diff] [blame] | 264 | |
| 265 | /* virtual trunk for RTP - RTP endpoints */ |
| 266 | struct mgcp_trunk_config *virt_trunk; |
| 267 | /* physical trunks with underlying E1 endpoints */ |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 268 | struct llist_head trunks; |
| 269 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 270 | enum mgcp_role role; |
| 271 | |
| 272 | /* osmux translator: 0 means disabled, 1 means enabled */ |
| 273 | int osmux; |
| 274 | /* addr to bind the server to */ |
| 275 | char *osmux_addr; |
| 276 | /* The BSC-NAT may ask for enabling osmux on demand. This tells us if |
| 277 | * the osmux socket is already initialized. |
| 278 | */ |
| 279 | int osmux_init; |
| 280 | /* osmux batch factor: from 1 to 4 maximum */ |
| 281 | int osmux_batch; |
| 282 | /* osmux batch size (in bytes) */ |
| 283 | int osmux_batch_size; |
| 284 | /* osmux port */ |
| 285 | uint16_t osmux_port; |
| 286 | /* Pad circuit with dummy messages until we see the first voice |
| 287 | * message. |
| 288 | */ |
| 289 | uint16_t osmux_dummy; |
Philipp Maier | 12943ea | 2018-01-17 15:40:25 +0100 | [diff] [blame] | 290 | /* domain name of the media gateway */ |
| 291 | char domain[255+1]; |
Oliver Smith | e36b775 | 2019-01-22 16:31:36 +0100 | [diff] [blame] | 292 | |
| 293 | /* time after which inactive connections (CIs) get closed */ |
| 294 | int conn_timeout; |
Harald Welte | 9852e22 | 2020-03-08 10:22:14 +0100 | [diff] [blame] | 295 | |
| 296 | /* osmocom CTRL interface */ |
| 297 | struct ctrl_handle *ctrl; |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 298 | }; |
| 299 | |
| 300 | /* config management */ |
| 301 | struct mgcp_config *mgcp_config_alloc(void); |
| 302 | int mgcp_parse_config(const char *config_file, struct mgcp_config *cfg, |
| 303 | enum mgcp_role role); |
| 304 | int mgcp_vty_init(void); |
| 305 | int mgcp_endpoints_allocate(struct mgcp_trunk_config *cfg); |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 306 | void mgcp_trunk_set_keepalive(struct mgcp_trunk_config *tcfg, int interval); |
| 307 | |
| 308 | /* |
| 309 | * format helper functions |
| 310 | */ |
| 311 | struct msgb *mgcp_handle_message(struct mgcp_config *cfg, struct msgb *msg); |
| 312 | |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 313 | |
| 314 | int mgcp_send_reset_ep(struct mgcp_endpoint *endp, int endpoint); |
| 315 | int mgcp_send_reset_all(struct mgcp_config *cfg); |
| 316 | |
| 317 | |
| 318 | int mgcp_create_bind(const char *source_addr, struct osmo_fd *fd, int port); |
Neels Hofmeyr | f83ec56 | 2017-09-07 19:18:40 +0200 | [diff] [blame] | 319 | int mgcp_udp_send(int fd, struct in_addr *addr, int port, char *buf, int len); |