Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 1 | /* Trunk handling */ |
| 2 | |
| 3 | /* |
| 4 | * (C) 2009-2012 by Holger Hans Peter Freyther <zecke@selfish.org> |
| 5 | * (C) 2009-2012 by On-Waves |
| 6 | * (C) 2017-2020 by sysmocom s.f.m.c. GmbH <info@sysmocom.de> |
| 7 | * All Rights Reserved |
| 8 | * |
| 9 | * This program is free software; you can redistribute it and/or modify |
| 10 | * it under the terms of the GNU Affero General Public License as published by |
| 11 | * the Free Software Foundation; either version 3 of the License, or |
| 12 | * (at your option) any later version. |
| 13 | * |
| 14 | * This program is distributed in the hope that it will be useful, |
| 15 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 16 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 17 | * GNU Affero General Public License for more details. |
| 18 | * |
| 19 | * You should have received a copy of the GNU Affero General Public License |
| 20 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 21 | * |
| 22 | */ |
| 23 | |
Philipp Maier | 993ea6b | 2020-08-04 18:26:50 +0200 | [diff] [blame] | 24 | #include <osmocom/mgcp/mgcp.h> |
| 25 | #include <osmocom/mgcp/mgcp_protocol.h> |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 26 | #include <osmocom/mgcp/mgcp_endp.h> |
| 27 | #include <osmocom/mgcp/mgcp_trunk.h> |
Philipp Maier | 889fe7f | 2020-07-06 17:44:12 +0200 | [diff] [blame] | 28 | #include <osmocom/mgcp/mgcp_e1.h> |
| 29 | #include <osmocom/abis/e1_input.h> |
Philipp Maier | 124a3e0 | 2021-07-26 11:17:15 +0200 | [diff] [blame^] | 30 | #include <osmocom/core/stat_item.h> |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 31 | |
Philipp Maier | bd060c3 | 2021-07-09 10:24:33 +0200 | [diff] [blame] | 32 | const struct value_string mgcp_trunk_type_strs[] = { |
| 33 | { MGCP_TRUNK_VIRTUAL, "virtual" }, |
| 34 | { MGCP_TRUNK_E1, "e1" }, |
| 35 | { 0, NULL } |
| 36 | }; |
| 37 | |
Philipp Maier | bce5f29 | 2020-06-18 11:57:17 +0200 | [diff] [blame] | 38 | /*! allocate trunk and add it (if required) to the trunk list. |
| 39 | * (called once at startup by VTY). |
| 40 | * \param[in] cfg mgcp configuration. |
Philipp Maier | bce5f29 | 2020-06-18 11:57:17 +0200 | [diff] [blame] | 41 | * \param[in] ttype trunk type. |
Philipp Maier | 080935a | 2020-07-01 23:08:50 +0200 | [diff] [blame] | 42 | * \param[in] nr trunk number. |
Philipp Maier | bce5f29 | 2020-06-18 11:57:17 +0200 | [diff] [blame] | 43 | * \returns pointer to allocated trunk, NULL on failure. */ |
Philipp Maier | d70eef6 | 2021-07-19 13:53:28 +0200 | [diff] [blame] | 44 | struct mgcp_trunk *mgcp_trunk_alloc(struct mgcp_config *cfg, enum mgcp_trunk_type ttype, unsigned int nr) |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 45 | { |
| 46 | struct mgcp_trunk *trunk; |
| 47 | |
| 48 | trunk = talloc_zero(cfg, struct mgcp_trunk); |
| 49 | if (!trunk) { |
| 50 | LOGP(DLMGCP, LOGL_ERROR, "Failed to allocate.\n"); |
| 51 | return NULL; |
| 52 | } |
| 53 | |
| 54 | trunk->cfg = cfg; |
| 55 | trunk->trunk_type = ttype; |
| 56 | trunk->trunk_nr = nr; |
| 57 | |
| 58 | trunk->audio_send_ptime = 1; |
| 59 | trunk->audio_send_name = 1; |
Philipp Maier | ae6858b | 2020-09-07 12:07:40 +0200 | [diff] [blame] | 60 | trunk->v.vty_number_endpoints = 512; |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 61 | trunk->omit_rtcp = 0; |
| 62 | |
| 63 | mgcp_trunk_set_keepalive(trunk, MGCP_KEEPALIVE_ONCE); |
| 64 | |
Philipp Maier | d19de2e | 2020-06-03 13:55:33 +0200 | [diff] [blame] | 65 | llist_add_tail(&trunk->entry, &cfg->trunks); |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 66 | |
Philipp Maier | a065e63 | 2021-07-09 13:22:42 +0200 | [diff] [blame] | 67 | mgcp_ratectr_trunk_alloc(trunk); |
Philipp Maier | 124a3e0 | 2021-07-26 11:17:15 +0200 | [diff] [blame^] | 68 | mgcp_stat_trunk_alloc(trunk); |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 69 | |
| 70 | return trunk; |
| 71 | } |
| 72 | |
Philipp Maier | bce5f29 | 2020-06-18 11:57:17 +0200 | [diff] [blame] | 73 | /*! allocate endpoints and set default values |
| 74 | * (called once at startup by VTY). |
| 75 | * \param[in] trunk trunk configuration. |
| 76 | * \returns 0 on success, -1 on failure. */ |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 77 | int mgcp_trunk_alloc_endpts(struct mgcp_trunk *trunk) |
| 78 | { |
| 79 | int i; |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 80 | struct mgcp_endpoint *endp; |
Philipp Maier | 869b21c | 2020-07-03 16:04:16 +0200 | [diff] [blame] | 81 | unsigned int number_endpoints; |
| 82 | unsigned int first_endpoint_nr; |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 83 | |
| 84 | /* This function is called once on startup by the VTY to allocate the |
| 85 | * endpoints. The number of endpoints must not change througout the |
| 86 | * runtime of the MGW */ |
| 87 | OSMO_ASSERT(trunk->number_endpoints == 0); |
| 88 | OSMO_ASSERT(trunk->endpoints == NULL); |
| 89 | |
Philipp Maier | 869b21c | 2020-07-03 16:04:16 +0200 | [diff] [blame] | 90 | switch (trunk->trunk_type) { |
| 91 | case MGCP_TRUNK_VIRTUAL: |
| 92 | /* Due to historical reasons the endpoints on the virtual |
| 93 | * trunk start counting at 1. */ |
| 94 | first_endpoint_nr = 1; |
Philipp Maier | 889fe7f | 2020-07-06 17:44:12 +0200 | [diff] [blame] | 95 | number_endpoints = trunk->v.vty_number_endpoints; |
Philipp Maier | 869b21c | 2020-07-03 16:04:16 +0200 | [diff] [blame] | 96 | break; |
| 97 | case MGCP_TRUNK_E1: |
| 98 | /* The first timeslot on an E1 line is reserved for framing |
| 99 | * and alignment and can not be used for audio transport */ |
| 100 | first_endpoint_nr = 1 * MGCP_ENDP_E1_SUBSLOTS; |
Philipp Maier | 889fe7f | 2020-07-06 17:44:12 +0200 | [diff] [blame] | 101 | number_endpoints = (NUM_E1_TS-1) * MGCP_ENDP_E1_SUBSLOTS; |
Philipp Maier | 869b21c | 2020-07-03 16:04:16 +0200 | [diff] [blame] | 102 | break; |
| 103 | default: |
| 104 | OSMO_ASSERT(false); |
| 105 | } |
| 106 | |
| 107 | /* Make sure the amount of requested endpoints does not execeed |
| 108 | * sane limits. The VTY already limits the possible amount, |
| 109 | * however miss-initialization of the struct or memory corruption |
| 110 | * could still lead to an excessive allocation of endpoints, so |
| 111 | * better stop early if that is the case. */ |
| 112 | OSMO_ASSERT(number_endpoints < 65534); |
| 113 | |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 114 | /* allocate pointer array for the endpoints */ |
Philipp Maier | 7a755be | 2020-07-07 15:51:06 +0200 | [diff] [blame] | 115 | trunk->endpoints = talloc_zero_array(trunk->cfg, struct mgcp_endpoint*, |
| 116 | number_endpoints); |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 117 | if (!trunk->endpoints) |
| 118 | return -1; |
| 119 | |
| 120 | /* create endpoints */ |
Philipp Maier | 869b21c | 2020-07-03 16:04:16 +0200 | [diff] [blame] | 121 | for (i = 0; i < number_endpoints; i++) { |
| 122 | endp = mgcp_endp_alloc(trunk, i + first_endpoint_nr); |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 123 | if (!endp) { |
| 124 | talloc_free(trunk->endpoints); |
| 125 | return -1; |
| 126 | } |
| 127 | trunk->endpoints[i] = endp; |
| 128 | } |
| 129 | |
| 130 | /* make the endpoints we just created available to the MGW code */ |
Philipp Maier | 869b21c | 2020-07-03 16:04:16 +0200 | [diff] [blame] | 131 | trunk->number_endpoints = number_endpoints; |
Philipp Maier | 124a3e0 | 2021-07-26 11:17:15 +0200 | [diff] [blame^] | 132 | osmo_stat_item_set(osmo_stat_item_group_get_item(trunk->stats.common, TRUNK_STAT_ENDPOINTS_TOTAL), |
| 133 | trunk->number_endpoints); |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 134 | return 0; |
| 135 | } |
| 136 | |
Philipp Maier | 889fe7f | 2020-07-06 17:44:12 +0200 | [diff] [blame] | 137 | /*! Equip trunk with endpoints and resources |
| 138 | * (called once at startup by VTY). |
| 139 | * \param[in] trunk trunk configuration. |
| 140 | * \returns 0 on success, -1 on failure. */ |
| 141 | int mgcp_trunk_equip(struct mgcp_trunk *trunk) |
| 142 | { |
| 143 | unsigned int i; |
| 144 | |
| 145 | /* Allocate endpoints */ |
| 146 | if(mgcp_trunk_alloc_endpts(trunk) != 0) |
| 147 | return -1; |
| 148 | |
| 149 | /* Allocate resources */ |
| 150 | switch (trunk->trunk_type) { |
| 151 | case MGCP_TRUNK_VIRTUAL: |
| 152 | /* No additional initaliziation required here, virtual |
| 153 | * endpoints will open/close network sockets themselves |
| 154 | * on demand. */ |
| 155 | break; |
| 156 | case MGCP_TRUNK_E1: |
| 157 | /* The TS initalization happens once on startup for all |
| 158 | * timeslots. This only affects the i460 multiplexer. Until |
| 159 | * now no E1 resources are claimed yet. This happens on demand |
| 160 | * when the related endpoint is actually used */ |
| 161 | memset(trunk->e1.i460_ts, 0, sizeof(trunk->e1.i460_ts)); |
| 162 | for (i = 0; i < (NUM_E1_TS-1); i++) |
| 163 | osmo_i460_ts_init(&trunk->e1.i460_ts[i]); |
| 164 | break; |
| 165 | default: |
| 166 | OSMO_ASSERT(false); |
| 167 | } |
| 168 | |
| 169 | return 0; |
| 170 | } |
| 171 | |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 172 | /*! get trunk configuration by trunk number (index). |
Philipp Maier | bce5f29 | 2020-06-18 11:57:17 +0200 | [diff] [blame] | 173 | * \param[in] cfg mgcp configuration. |
Philipp Maier | 6fbbeec | 2020-07-01 23:00:54 +0200 | [diff] [blame] | 174 | * \param[in] ttype trunk type. |
| 175 | * \param[in] nr trunk number. |
Philipp Maier | bce5f29 | 2020-06-18 11:57:17 +0200 | [diff] [blame] | 176 | * \returns pointer to trunk configuration, NULL on error. */ |
Philipp Maier | d70eef6 | 2021-07-19 13:53:28 +0200 | [diff] [blame] | 177 | struct mgcp_trunk *mgcp_trunk_by_num(const struct mgcp_config *cfg, enum mgcp_trunk_type ttype, unsigned int nr) |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 178 | { |
| 179 | struct mgcp_trunk *trunk; |
| 180 | |
Philipp Maier | 6fbbeec | 2020-07-01 23:00:54 +0200 | [diff] [blame] | 181 | llist_for_each_entry(trunk, &cfg->trunks, entry) { |
| 182 | if (trunk->trunk_nr == nr && trunk->trunk_type == ttype) |
| 183 | return trunk; |
| 184 | } |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 185 | |
| 186 | return NULL; |
| 187 | } |
| 188 | |
Philipp Maier | 7e9ddc9 | 2020-06-10 15:22:32 +0200 | [diff] [blame] | 189 | /* Made public for unit-testing, do not use from outside this file */ |
Philipp Maier | d70eef6 | 2021-07-19 13:53:28 +0200 | [diff] [blame] | 190 | int e1_trunk_nr_from_epname(unsigned int *trunk_nr, const char *epname) |
Philipp Maier | 7e9ddc9 | 2020-06-10 15:22:32 +0200 | [diff] [blame] | 191 | { |
Philipp Maier | d70eef6 | 2021-07-19 13:53:28 +0200 | [diff] [blame] | 192 | unsigned long trunk_nr_temp; |
Philipp Maier | 7e9ddc9 | 2020-06-10 15:22:32 +0200 | [diff] [blame] | 193 | size_t prefix_len; |
| 194 | char *str_trunk_nr_end; |
| 195 | |
| 196 | prefix_len = sizeof(MGCP_ENDPOINT_PREFIX_E1_TRUNK) - 1; |
| 197 | if (strncmp(epname, MGCP_ENDPOINT_PREFIX_E1_TRUNK, prefix_len) != 0) |
| 198 | return -EINVAL; |
| 199 | |
| 200 | errno = 0; |
Philipp Maier | d70eef6 | 2021-07-19 13:53:28 +0200 | [diff] [blame] | 201 | trunk_nr_temp = strtoul(epname + prefix_len, &str_trunk_nr_end, 10); |
| 202 | if (errno == ERANGE || trunk_nr_temp > 64 |
Philipp Maier | 7e9ddc9 | 2020-06-10 15:22:32 +0200 | [diff] [blame] | 203 | || epname + prefix_len == str_trunk_nr_end |
| 204 | || str_trunk_nr_end[0] != '/') |
| 205 | return -EINVAL; |
Philipp Maier | d70eef6 | 2021-07-19 13:53:28 +0200 | [diff] [blame] | 206 | else { |
| 207 | *trunk_nr = (unsigned int)trunk_nr_temp; |
| 208 | return 0; |
| 209 | } |
Philipp Maier | 7e9ddc9 | 2020-06-10 15:22:32 +0200 | [diff] [blame] | 210 | } |
| 211 | |
Philipp Maier | 96c6e06 | 2021-07-29 15:15:36 +0200 | [diff] [blame] | 212 | /* Check if the domain name, which is supplied with the endpoint name |
| 213 | * matches the configuration. */ |
| 214 | static int check_domain_name(const char *epname, const struct mgcp_config *cfg) |
| 215 | { |
| 216 | char *domain_to_check; |
| 217 | |
| 218 | domain_to_check = strstr(epname, "@"); |
| 219 | if (!domain_to_check) { |
| 220 | LOGP(DLMGCP, LOGL_ERROR, "missing domain name in endpoint name \"%s\", expecting \"%s\"\n", |
| 221 | epname, cfg->domain); |
| 222 | return -EINVAL; |
| 223 | } |
| 224 | |
| 225 | /* Accept any domain if configured as "*" */ |
| 226 | if (!strcmp(cfg->domain, "*")) |
| 227 | return 0; |
| 228 | |
| 229 | if (strcmp(domain_to_check+1, cfg->domain) != 0) { |
| 230 | LOGP(DLMGCP, LOGL_ERROR, "wrong domain name in endpoint name \"%s\", expecting \"%s\"\n", |
| 231 | epname, cfg->domain); |
| 232 | return -EINVAL; |
| 233 | } |
| 234 | |
| 235 | return 0; |
| 236 | } |
| 237 | |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 238 | /*! Find a trunk by the trunk prefix in the endpoint name. |
| 239 | * \param[in] epname endpoint name with trunk prefix to look up. |
| 240 | * \param[in] cfg that contains the trunks where the endpoint is located. |
| 241 | * \returns trunk or NULL if trunk was not found. */ |
| 242 | struct mgcp_trunk *mgcp_trunk_by_name(const struct mgcp_config *cfg, const char *epname) |
| 243 | { |
| 244 | size_t prefix_len; |
| 245 | char epname_lc[MGCP_ENDPOINT_MAXLEN]; |
Philipp Maier | d70eef6 | 2021-07-19 13:53:28 +0200 | [diff] [blame] | 246 | unsigned int trunk_nr; |
| 247 | int rc; |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 248 | |
| 249 | osmo_str_tolower_buf(epname_lc, sizeof(epname_lc), epname); |
| 250 | epname = epname_lc; |
| 251 | |
Philipp Maier | 96c6e06 | 2021-07-29 15:15:36 +0200 | [diff] [blame] | 252 | /* All endpoint names require a domain as suffix */ |
| 253 | if (check_domain_name(epname, cfg)) |
| 254 | return NULL; |
| 255 | |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 256 | prefix_len = sizeof(MGCP_ENDPOINT_PREFIX_VIRTUAL_TRUNK) - 1; |
| 257 | if (strncmp(epname, MGCP_ENDPOINT_PREFIX_VIRTUAL_TRUNK, prefix_len) == 0) { |
Philipp Maier | 6fbbeec | 2020-07-01 23:00:54 +0200 | [diff] [blame] | 258 | return mgcp_trunk_by_num(cfg, MGCP_TRUNK_VIRTUAL, MGCP_VIRT_TRUNK_ID); |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 259 | } |
| 260 | |
Philipp Maier | d70eef6 | 2021-07-19 13:53:28 +0200 | [diff] [blame] | 261 | rc = e1_trunk_nr_from_epname(&trunk_nr, epname); |
| 262 | if (rc == 0) |
Philipp Maier | 6fbbeec | 2020-07-01 23:00:54 +0200 | [diff] [blame] | 263 | return mgcp_trunk_by_num(cfg, MGCP_TRUNK_E1, trunk_nr); |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 264 | |
| 265 | /* Earlier versions of osmo-mgw were accepting endpoint names |
| 266 | * without trunk prefix. This is normally not allowed, each MGCP |
| 267 | * request should supply an endpoint name with trunk prefix. |
| 268 | * However in order to stay compatible with old versions of |
| 269 | * osmo-bsc and osmo-msc we still accept endpoint names without |
| 270 | * trunk prefix and just assume that the virtual trunk should |
| 271 | * be selected. There is even a TTCN3 test for this, see also: |
| 272 | * MGCP_Test.TC_crcx_noprefix */ |
| 273 | if ((epname[0] >= '0' && epname[0] <= '9') || (epname[0] >= 'a' && epname[0] <= 'f')) { |
| 274 | LOGP(DLMGCP, LOGL_ERROR, "missing trunk prefix in endpoint name \"%s\", assuming trunk \"%s\"!\n", epname, |
| 275 | MGCP_ENDPOINT_PREFIX_VIRTUAL_TRUNK); |
Philipp Maier | 6fbbeec | 2020-07-01 23:00:54 +0200 | [diff] [blame] | 276 | return mgcp_trunk_by_num(cfg, MGCP_TRUNK_VIRTUAL, MGCP_VIRT_TRUNK_ID); |
Philipp Maier | c66ab2c | 2020-06-02 20:55:34 +0200 | [diff] [blame] | 277 | } |
| 278 | |
| 279 | LOGP(DLMGCP, LOGL_ERROR, "unable to find trunk for endpoint name \"%s\"!\n", epname); |
| 280 | return NULL; |
| 281 | } |
Philipp Maier | 889fe7f | 2020-07-06 17:44:12 +0200 | [diff] [blame] | 282 | |
| 283 | /*! Find a trunk (E1) by its associated E1 line number. |
| 284 | * \param[in] num e1 line number. |
| 285 | * \returns trunk or NULL if trunk was not found. */ |
| 286 | struct mgcp_trunk *mgcp_trunk_by_line_num(const struct mgcp_config *cfg, unsigned int num) |
| 287 | { |
| 288 | /*! When used on trunks other than E1, the result will always be NULL. */ |
| 289 | struct mgcp_trunk *trunk; |
| 290 | |
| 291 | llist_for_each_entry(trunk, &cfg->trunks, entry) { |
| 292 | if (trunk->trunk_type == MGCP_TRUNK_E1 && trunk->e1.vty_line_nr == num) |
| 293 | return trunk; |
| 294 | } |
| 295 | |
| 296 | return NULL; |
| 297 | } |