blob: 4eb427b26b719c3fc380bf47c8b1108741970f72 [file] [log] [blame]
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +02001/* Gb proxy peer handling */
2
3/* (C) 2010 by Harald Welte <laforge@gnumonks.org>
4 * (C) 2010-2013 by On-Waves
5 * (C) 2013 by Holger Hans Peter Freyther
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
Daniel Willmanna16ecc32021-03-10 09:57:12 +010023#include <osmocom/gbproxy/gb_proxy.h>
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020024
Oliver Smith29532c22021-01-29 11:13:00 +010025#include "debug.h"
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020026
27#include <osmocom/gprs/protocol/gsm_08_18.h>
Daniel Willmannc8a50092021-01-17 13:11:41 +010028#include <osmocom/core/crc16.h>
Daniel Willmann8f407b12020-12-02 19:33:50 +010029#include <osmocom/core/logging.h>
Daniel Willmannee834af2020-12-14 16:22:39 +010030#include <osmocom/core/linuxlist.h>
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020031#include <osmocom/core/rate_ctr.h>
32#include <osmocom/core/stats.h>
33#include <osmocom/core/talloc.h>
Daniel Willmannc8a50092021-01-17 13:11:41 +010034#include <osmocom/core/utils.h>
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020035#include <osmocom/gsm/tlv.h>
36
37#include <string.h>
38
39extern void *tall_sgsn_ctx;
40
Harald Welte560bdb32020-12-04 22:24:47 +010041static const struct rate_ctr_desc bvc_ctr_description[] = {
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020042 { "blocked", "BVC Block " },
43 { "unblocked", "BVC Unblock " },
44 { "dropped", "BVC blocked, dropped packet " },
45 { "inv-nsei", "NSEI mismatch " },
46 { "tx-err", "NS Transmission error " },
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020047};
48
Harald Welte560bdb32020-12-04 22:24:47 +010049osmo_static_assert(ARRAY_SIZE(bvc_ctr_description) == GBPROX_PEER_CTR_LAST, everything_described);
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020050
Harald Welte560bdb32020-12-04 22:24:47 +010051static const struct rate_ctr_group_desc bvc_ctrg_desc = {
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020052 .group_name_prefix = "gbproxy:peer",
53 .group_description = "GBProxy Peer Statistics",
Harald Welte560bdb32020-12-04 22:24:47 +010054 .num_ctr = ARRAY_SIZE(bvc_ctr_description),
55 .ctr_desc = bvc_ctr_description,
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020056 .class_id = OSMO_STATS_CLASS_PEER,
57};
58
59
Harald Welte560bdb32020-12-04 22:24:47 +010060/* Find the gbproxy_bvc by its BVCI. There can only be one match */
Harald Weltee5209642020-12-05 19:59:45 +010061struct gbproxy_bvc *gbproxy_bvc_by_bvci(struct gbproxy_nse *nse, uint16_t bvci)
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020062{
Harald Welte8b4c7942020-12-05 10:14:49 +010063 struct gbproxy_bvc *bvc;
Harald Weltee5209642020-12-05 19:59:45 +010064 hash_for_each_possible(nse->bvcs, bvc, list, bvci) {
65 if (bvc->bvci == bvci)
66 return bvc;
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020067 }
68 return NULL;
69}
70
Harald Welte560bdb32020-12-04 22:24:47 +010071struct gbproxy_bvc *gbproxy_bvc_alloc(struct gbproxy_nse *nse, uint16_t bvci)
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020072{
Daniel Willmann990b1512021-07-09 13:58:58 +020073 char idbuf[64];
Harald Welte560bdb32020-12-04 22:24:47 +010074 struct gbproxy_bvc *bvc;
Daniel Willmanne50550e2020-11-26 18:19:21 +010075 OSMO_ASSERT(nse);
76 struct gbproxy_config *cfg = nse->cfg;
77 OSMO_ASSERT(cfg);
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020078
Harald Welte560bdb32020-12-04 22:24:47 +010079 bvc = talloc_zero(tall_sgsn_ctx, struct gbproxy_bvc);
80 if (!bvc)
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020081 return NULL;
82
Daniel Willmann990b1512021-07-09 13:58:58 +020083 snprintf(idbuf, sizeof(idbuf), "BVC%05u-NSE%05u", bvci,
84 nse->nsei);
85 osmo_identifier_sanitize_buf(idbuf, NULL, '_');
Harald Welte560bdb32020-12-04 22:24:47 +010086 bvc->bvci = bvci;
Harald Welte4bd3e492020-12-07 12:06:52 +010087 bvc->ctrg = rate_ctr_group_alloc(bvc, &bvc_ctrg_desc, (nse->nsei << 16) | bvci);
Harald Welte560bdb32020-12-04 22:24:47 +010088 if (!bvc->ctrg) {
89 talloc_free(bvc);
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020090 return NULL;
91 }
Daniel Willmann990b1512021-07-09 13:58:58 +020092 rate_ctr_group_set_name(bvc->ctrg, idbuf);
Harald Welte560bdb32020-12-04 22:24:47 +010093 bvc->nse = nse;
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020094
Harald Welte8b4c7942020-12-05 10:14:49 +010095 hash_add(nse->bvcs, &bvc->list, bvc->bvci);
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +020096
Harald Weltecfc7e8e2020-12-07 12:03:10 +010097 LOGPBVC_CAT(bvc, DOBJ, LOGL_INFO, "BVC Created\n");
98
99 /* We leave allocating the bvc->fi to the caller, as the FSM details depend
100 * on the type of BVC (SIG/PTP) and role (SGSN/BSS) */
Daniel Willmann3ea37932021-02-10 13:41:14 +0100101 return bvc;
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200102}
103
Harald Welte560bdb32020-12-04 22:24:47 +0100104void gbproxy_bvc_free(struct gbproxy_bvc *bvc)
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200105{
Harald Weltee5209642020-12-05 19:59:45 +0100106 struct gbproxy_cell *cell;
107
Harald Welte560bdb32020-12-04 22:24:47 +0100108 if (!bvc)
Daniel Willmannf6a36cc2020-12-04 17:38:46 +0100109 return;
Daniel Willmanne50550e2020-11-26 18:19:21 +0100110
Harald Weltecfc7e8e2020-12-07 12:03:10 +0100111 LOGPBVC_CAT(bvc, DOBJ, LOGL_INFO, "BVC Destroying\n");
112
Harald Welte8b4c7942020-12-05 10:14:49 +0100113 hash_del(&bvc->list);
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200114
Harald Welte560bdb32020-12-04 22:24:47 +0100115 rate_ctr_group_free(bvc->ctrg);
116 bvc->ctrg = NULL;
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200117
Harald Weltee5209642020-12-05 19:59:45 +0100118 osmo_fsm_inst_free(bvc->fi);
119
120 cell = bvc->cell;
121 if (cell) {
122 int i;
123
124 if (cell->bss_bvc == bvc)
125 cell->bss_bvc = NULL;
126
127 /* we could also be a SGSN-side BVC */
128 for (i = 0; i < ARRAY_SIZE(cell->sgsn_bvc); i++) {
129 if (cell->sgsn_bvc[i] == bvc)
130 cell->sgsn_bvc[i] = NULL;
131 }
132 bvc->cell = NULL;
133 }
134
Harald Welte560bdb32020-12-04 22:24:47 +0100135 talloc_free(bvc);
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200136}
137
Harald Weltee5209642020-12-05 19:59:45 +0100138/*! remove BVCs on NSE specified by NSEI.
Harald Welte560bdb32020-12-04 22:24:47 +0100139 * \param[in] cfg proxy in which we operate
140 * \param[in] nsei NS entity in which we should clean up
Harald Weltee5209642020-12-05 19:59:45 +0100141 * \param[in] bvci if 0: remove all PTP BVCs; if != 0: BVCI of the single BVC to clean up */
142int gbproxy_cleanup_bvcs(struct gbproxy_nse *nse, uint16_t bvci)
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200143{
Harald Weltee5209642020-12-05 19:59:45 +0100144 struct hlist_node *btmp;
145 struct gbproxy_bvc *bvc;
146 int j, counter = 0;
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200147
Harald Weltee5209642020-12-05 19:59:45 +0100148 if (!nse)
149 return 0;
150
151 hash_for_each_safe(nse->bvcs, j, btmp, bvc, list) {
152 if (bvci && bvc->bvci != bvci)
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200153 continue;
Harald Weltee5209642020-12-05 19:59:45 +0100154 if (bvci == 0 && bvc->bvci == 0)
155 continue;
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200156
Harald Weltee5209642020-12-05 19:59:45 +0100157 gbproxy_bvc_free(bvc);
158 counter += 1;
Pau Espin Pedrol1ddefb12019-08-30 19:48:34 +0200159 }
160
161 return counter;
162}
Daniel Willmanne50550e2020-11-26 18:19:21 +0100163
Harald Weltee5209642020-12-05 19:59:45 +0100164
165/***********************************************************************
166 * CELL
167 ***********************************************************************/
168
169/* Allocate a new 'cell' object */
Philipp Maiere4597ec2021-02-09 16:02:00 +0100170struct gbproxy_cell *gbproxy_cell_alloc(struct gbproxy_config *cfg, uint16_t bvci,
171 const struct gprs_ra_id *raid, uint16_t cid)
Harald Weltee5209642020-12-05 19:59:45 +0100172{
173 struct gbproxy_cell *cell;
174 OSMO_ASSERT(cfg);
175
176 cell = talloc_zero(cfg, struct gbproxy_cell);
177 if (!cell)
178 return NULL;
179
180 cell->cfg = cfg;
181 cell->bvci = bvci;
Philipp Maiere4597ec2021-02-09 16:02:00 +0100182 cell->id.cid = cid;
183 memcpy(&cell->id.raid, raid, sizeof(cell->id.raid));
Harald Weltee5209642020-12-05 19:59:45 +0100184
185 hash_add(cfg->cells, &cell->list, cell->bvci);
186
Harald Weltecfc7e8e2020-12-07 12:03:10 +0100187 LOGPCELL_CAT(cell, DOBJ, LOGL_INFO, "CELL Created\n");
188
Harald Weltee5209642020-12-05 19:59:45 +0100189 return cell;
190}
191
192/* Find cell by BVCI */
193struct gbproxy_cell *gbproxy_cell_by_bvci(struct gbproxy_config *cfg, uint16_t bvci)
194{
195 struct gbproxy_cell *cell;
196
197 hash_for_each_possible(cfg->cells, cell, list, bvci) {
198 if (cell->bvci == bvci)
199 return cell;
200 }
201 return NULL;
202}
203
Daniel Willmannfccbef02021-01-19 17:59:19 +0100204struct gbproxy_cell *gbproxy_cell_by_cellid(struct gbproxy_config *cfg, const struct gprs_ra_id *raid, uint16_t cid)
205{
206 int i;
207 struct gbproxy_cell *cell;
208
209 hash_for_each(cfg->cells, i, cell, list) {
210 if (cell->id.cid == cid && gsm48_ra_equal(&cell->id.raid, raid)) {
211 return cell;
212 }
213 }
214 return NULL;
215}
216
Harald Weltee5209642020-12-05 19:59:45 +0100217void gbproxy_cell_free(struct gbproxy_cell *cell)
218{
219 unsigned int i;
220
221 if (!cell)
222 return;
223
Harald Weltecfc7e8e2020-12-07 12:03:10 +0100224 LOGPCELL_CAT(cell, DOBJ, LOGL_INFO, "CELL Destroying\n");
225
Harald Weltee5209642020-12-05 19:59:45 +0100226 /* remove from cfg.cells */
227 hash_del(&cell->list);
228
229 /* remove back-pointers from the BSS side */
230 if (cell->bss_bvc && cell->bss_bvc->cell)
231 cell->bss_bvc->cell = NULL;
232
233 /* remove back-pointers from the SGSN side */
234 for (i = 0; i < ARRAY_SIZE(cell->sgsn_bvc); i++) {
235 if (!cell->sgsn_bvc[i])
236 continue;
237 if (cell->sgsn_bvc[i]->cell)
238 cell->sgsn_bvc[i]->cell = NULL;
239 }
240
241 talloc_free(cell);
242}
243
244bool gbproxy_cell_add_sgsn_bvc(struct gbproxy_cell *cell, struct gbproxy_bvc *bvc)
245{
246 unsigned int i;
247 for (i = 0; i < ARRAY_SIZE(cell->sgsn_bvc); i++) {
248 if (!cell->sgsn_bvc[i]) {
249 cell->sgsn_bvc[i] = bvc;
Harald Weltecfc7e8e2020-12-07 12:03:10 +0100250 LOGPCELL_CAT(cell, DOBJ, LOGL_DEBUG, "CELL linked to SGSN\n");
251 LOGPBVC_CAT(bvc, DOBJ, LOGL_DEBUG, "BVC linked to CELL\n");
Harald Weltee5209642020-12-05 19:59:45 +0100252 return true;
253 }
254 }
255 return false;
256}
257
Daniel Willmann77493b12020-12-29 21:13:31 +0100258
259/***********************************************************************
260 * TLLI cache
261 ***********************************************************************/
262
Daniel Willmann9170c342021-01-17 13:12:46 +0100263static inline struct gbproxy_tlli_cache_entry *_get_tlli_entry(struct gbproxy_config *cfg, uint32_t tlli)
264{
265 struct gbproxy_tlli_cache_entry *cache_entry;
266
267 hash_for_each_possible(cfg->tlli_cache.entries, cache_entry, list, tlli) {
268 if (cache_entry->tlli == tlli)
269 return cache_entry;
270 }
271 return NULL;
272}
273
Daniel Willmann77493b12020-12-29 21:13:31 +0100274void gbproxy_tlli_cache_update(struct gbproxy_nse *nse, uint32_t tlli)
275{
276 struct gbproxy_config *cfg = nse->cfg;
277 struct timespec now;
278 struct gbproxy_tlli_cache_entry *cache_entry = _get_tlli_entry(cfg, tlli);
279
280 osmo_clock_gettime(CLOCK_MONOTONIC, &now);
281
282 if (cache_entry) {
283 /* Update the entry if it already exists */
284 cache_entry->nse = nse;
285 cache_entry->tstamp = now.tv_sec;
286 return;
287 }
288
289 cache_entry = talloc_zero(cfg, struct gbproxy_tlli_cache_entry);
290 cache_entry->tlli = tlli;
291 cache_entry->nse = nse;
292 cache_entry->tstamp = now.tv_sec;
293 hash_add(cfg->tlli_cache.entries, &cache_entry->list, cache_entry->tlli);
294}
295
296static void _tlli_cache_remove_nse(struct gbproxy_nse *nse) {
297 uint i;
298 struct gbproxy_config *cfg = nse->cfg;
299 struct gbproxy_tlli_cache_entry *tlli_cache;
300 struct hlist_node *tmp;
301
302 hash_for_each_safe(cfg->tlli_cache.entries, i, tmp, tlli_cache, list) {
303 if (tlli_cache->nse == nse) {
304 hash_del(&tlli_cache->list);
305 talloc_free(tlli_cache);
306 }
307 }
308}
309
310void gbproxy_tlli_cache_remove(struct gbproxy_config *cfg, uint32_t tlli)
311{
312 struct gbproxy_tlli_cache_entry *tlli_cache;
313 struct hlist_node *tmp;
314
315 hash_for_each_possible_safe(cfg->tlli_cache.entries, tlli_cache, tmp, list, tlli) {
316 if (tlli_cache->tlli == tlli) {
317 hash_del(&tlli_cache->list);
318 talloc_free(tlli_cache);
319 return;
320 }
321 }
322}
323
324int gbproxy_tlli_cache_cleanup(struct gbproxy_config *cfg)
325{
326 int i, count = 0;
327 struct gbproxy_tlli_cache_entry *tlli_cache;
328 struct hlist_node *tmp;
329 struct timespec now;
330 time_t expiry;
331
332 osmo_clock_gettime(CLOCK_MONOTONIC, &now);
333 expiry = now.tv_sec - cfg->tlli_cache.timeout;
334
335 hash_for_each_safe(cfg->tlli_cache.entries, i, tmp, tlli_cache, list) {
336 if (tlli_cache->tstamp < expiry) {
337 count++;
338 LOGP(DGPRS, LOGL_NOTICE, "Cache entry for TLLI %08x expired, removing\n", tlli_cache->tlli);
339 hash_del(&tlli_cache->list);
340 talloc_free(tlli_cache);
341 }
342 }
343 return count;
Daniel Willmannc8a50092021-01-17 13:11:41 +0100344
345}
346/***********************************************************************
347 * IMSI cache
348 ***********************************************************************/
349static inline uint16_t _checksum_imsi(const char *imsi)
350{
351 size_t len = strlen(imsi);
352 return osmo_crc16(0, (const uint8_t *)imsi, len);
353}
354
Daniel Willmann361d0b52021-07-09 17:44:30 +0200355static inline struct gbproxy_imsi_cache_entry *_get_imsi_entry(struct gbproxy_config *cfg, const char *imsi, enum cache_usage_type usage)
Daniel Willmannc8a50092021-01-17 13:11:41 +0100356{
357 struct gbproxy_imsi_cache_entry *cache_entry;
358 uint16_t imsi_hash = _checksum_imsi(imsi);
359
360 hash_for_each_possible(cfg->imsi_cache.entries, cache_entry, list, imsi_hash) {
Daniel Willmann361d0b52021-07-09 17:44:30 +0200361 if (!strncmp(cache_entry->imsi, imsi, sizeof(cache_entry->imsi)) && cache_entry->usage == usage)
Daniel Willmannc8a50092021-01-17 13:11:41 +0100362 return cache_entry;
363 }
364 return NULL;
365}
366
Daniel Willmann361d0b52021-07-09 17:44:30 +0200367void gbproxy_imsi_cache_update(struct gbproxy_nse *nse, const char *imsi, enum cache_usage_type usage)
Daniel Willmannc8a50092021-01-17 13:11:41 +0100368{
369 struct gbproxy_config *cfg = nse->cfg;
370 struct timespec now;
Daniel Willmann361d0b52021-07-09 17:44:30 +0200371 struct gbproxy_imsi_cache_entry *cache_entry = _get_imsi_entry(cfg, imsi, usage);
Daniel Willmannc8a50092021-01-17 13:11:41 +0100372 uint16_t imsi_hash = _checksum_imsi(imsi);
373
374 osmo_clock_gettime(CLOCK_MONOTONIC, &now);
375
376 if (cache_entry) {
377 /* Update the entry if it already exists */
378 cache_entry->nse = nse;
379 cache_entry->tstamp = now.tv_sec;
380 return;
381 }
382
383 cache_entry = talloc_zero(cfg, struct gbproxy_imsi_cache_entry);
384 OSMO_STRLCPY_ARRAY(cache_entry->imsi, imsi);
385 cache_entry->nse = nse;
Daniel Willmann361d0b52021-07-09 17:44:30 +0200386 cache_entry->usage = usage;
Daniel Willmannc8a50092021-01-17 13:11:41 +0100387 cache_entry->tstamp = now.tv_sec;
388 hash_add(cfg->imsi_cache.entries, &cache_entry->list, imsi_hash);
389}
390
391static void _imsi_cache_remove_nse(struct gbproxy_nse *nse) {
392 uint i;
393 struct gbproxy_config *cfg = nse->cfg;
394 struct gbproxy_imsi_cache_entry *imsi_cache;
395 struct hlist_node *tmp;
396
397 hash_for_each_safe(cfg->imsi_cache.entries, i, tmp, imsi_cache, list) {
398 if (imsi_cache->nse == nse) {
399 hash_del(&imsi_cache->list);
400 talloc_free(imsi_cache);
401 }
402 }
403}
404
Daniel Willmann361d0b52021-07-09 17:44:30 +0200405void gbproxy_imsi_cache_remove(struct gbproxy_config *cfg, const char *imsi, enum cache_usage_type usage)
Daniel Willmannc8a50092021-01-17 13:11:41 +0100406{
407 struct gbproxy_imsi_cache_entry *imsi_cache;
408 struct hlist_node *tmp;
409 uint16_t imsi_hash = _checksum_imsi(imsi);
410
411 hash_for_each_possible_safe(cfg->imsi_cache.entries, imsi_cache, tmp, list, imsi_hash) {
Daniel Willmann361d0b52021-07-09 17:44:30 +0200412 if (!(strncmp(imsi_cache->imsi, imsi, sizeof(imsi_cache->imsi))) && imsi_cache->usage == usage) {
Daniel Willmannc8a50092021-01-17 13:11:41 +0100413 hash_del(&imsi_cache->list);
414 talloc_free(imsi_cache);
415 return;
416 }
417 }
418}
419
420int gbproxy_imsi_cache_cleanup(struct gbproxy_config *cfg)
421{
422 int i, count = 0;
423 struct gbproxy_imsi_cache_entry *imsi_cache;
424 struct hlist_node *tmp;
425 struct timespec now;
426 time_t expiry;
427
428 osmo_clock_gettime(CLOCK_MONOTONIC, &now);
429 expiry = now.tv_sec - cfg->imsi_cache.timeout;
430
431 hash_for_each_safe(cfg->imsi_cache.entries, i, tmp, imsi_cache, list) {
432 if (imsi_cache->tstamp < expiry) {
433 count++;
434 LOGP(DGPRS, LOGL_NOTICE, "Cache entry for IMSI %s expired, removing\n", imsi_cache->imsi);
435 hash_del(&imsi_cache->list);
436 talloc_free(imsi_cache);
437 }
438 }
439 return count;
Daniel Willmann77493b12020-12-29 21:13:31 +0100440}
441
Harald Weltee5209642020-12-05 19:59:45 +0100442/***********************************************************************
443 * NSE - NS Entity
444 ***********************************************************************/
445
446struct gbproxy_nse *gbproxy_nse_alloc(struct gbproxy_config *cfg, uint16_t nsei, bool sgsn_facing)
Daniel Willmanne50550e2020-11-26 18:19:21 +0100447{
448 struct gbproxy_nse *nse;
449 OSMO_ASSERT(cfg);
450
451 nse = talloc_zero(tall_sgsn_ctx, struct gbproxy_nse);
452 if (!nse)
453 return NULL;
454
455 nse->nsei = nsei;
Daniel Willmanna8b61652021-02-12 05:05:14 +0100456 nse->max_sdu_len = DEFAULT_NSE_SDU;
Daniel Willmanne50550e2020-11-26 18:19:21 +0100457 nse->cfg = cfg;
Harald Weltee5209642020-12-05 19:59:45 +0100458 nse->sgsn_facing = sgsn_facing;
Daniel Willmanne50550e2020-11-26 18:19:21 +0100459
Harald Weltee5209642020-12-05 19:59:45 +0100460 if (sgsn_facing)
461 hash_add(cfg->sgsn_nses, &nse->list, nsei);
462 else
463 hash_add(cfg->bss_nses, &nse->list, nsei);
Daniel Willmanne50550e2020-11-26 18:19:21 +0100464
Harald Welte8b4c7942020-12-05 10:14:49 +0100465 hash_init(nse->bvcs);
Daniel Willmanne50550e2020-11-26 18:19:21 +0100466
Harald Weltecfc7e8e2020-12-07 12:03:10 +0100467 LOGPNSE_CAT(nse, DOBJ, LOGL_INFO, "NSE Created\n");
468
Daniel Willmanne50550e2020-11-26 18:19:21 +0100469 return nse;
470}
471
Daniel Willmannee834af2020-12-14 16:22:39 +0100472static void _nse_free(struct gbproxy_nse *nse)
Daniel Willmanne50550e2020-11-26 18:19:21 +0100473{
Harald Welte8b4c7942020-12-05 10:14:49 +0100474 struct gbproxy_bvc *bvc;
475 struct hlist_node *tmp;
476 int i;
477
Daniel Willmannf6a36cc2020-12-04 17:38:46 +0100478 if (!nse)
479 return;
Daniel Willmanne50550e2020-11-26 18:19:21 +0100480
Harald Weltecfc7e8e2020-12-07 12:03:10 +0100481 LOGPNSE_CAT(nse, DOBJ, LOGL_INFO, "NSE Destroying\n");
482
Harald Welted2fef952020-12-05 00:31:07 +0100483 hash_del(&nse->list);
Daniel Willmannc8a50092021-01-17 13:11:41 +0100484 /* Clear the cache entries of this NSE */
Daniel Willmann77493b12020-12-29 21:13:31 +0100485 _tlli_cache_remove_nse(nse);
Daniel Willmannc8a50092021-01-17 13:11:41 +0100486 _imsi_cache_remove_nse(nse);
Daniel Willmanne50550e2020-11-26 18:19:21 +0100487
Harald Welte8b4c7942020-12-05 10:14:49 +0100488 hash_for_each_safe(nse->bvcs, i, tmp, bvc, list)
Harald Welte560bdb32020-12-04 22:24:47 +0100489 gbproxy_bvc_free(bvc);
Daniel Willmanne50550e2020-11-26 18:19:21 +0100490
491 talloc_free(nse);
492}
Daniel Willmannee834af2020-12-14 16:22:39 +0100493static void _sgsn_free(struct gbproxy_sgsn *sgsn);
494
495void gbproxy_nse_free(struct gbproxy_nse *nse)
496{
497 if (!nse)
498 return;
499 OSMO_ASSERT(nse->cfg);
500
501 if (nse->sgsn_facing) {
502 struct gbproxy_sgsn *sgsn = gbproxy_sgsn_by_nsei(nse->cfg, nse->nsei);
503 OSMO_ASSERT(sgsn);
504 _sgsn_free(sgsn);
505 }
506
507 _nse_free(nse);
508}
Daniel Willmanne50550e2020-11-26 18:19:21 +0100509
Harald Weltee5209642020-12-05 19:59:45 +0100510struct gbproxy_nse *gbproxy_nse_by_nsei(struct gbproxy_config *cfg, uint16_t nsei, uint32_t flags)
Daniel Willmanne50550e2020-11-26 18:19:21 +0100511{
512 struct gbproxy_nse *nse;
513 OSMO_ASSERT(cfg);
514
Harald Weltee5209642020-12-05 19:59:45 +0100515 if (flags & NSE_F_SGSN) {
516 hash_for_each_possible(cfg->sgsn_nses, nse, list, nsei) {
517 if (nse->nsei == nsei)
518 return nse;
519 }
520 }
521
522 if (flags & NSE_F_BSS) {
523 hash_for_each_possible(cfg->bss_nses, nse, list, nsei) {
524 if (nse->nsei == nsei)
525 return nse;
526 }
Daniel Willmanne50550e2020-11-26 18:19:21 +0100527 }
528
529 return NULL;
530}
531
Harald Weltee5209642020-12-05 19:59:45 +0100532struct gbproxy_nse *gbproxy_nse_by_nsei_or_new(struct gbproxy_config *cfg, uint16_t nsei, bool sgsn_facing)
Daniel Willmanne50550e2020-11-26 18:19:21 +0100533{
534 struct gbproxy_nse *nse;
535 OSMO_ASSERT(cfg);
536
Harald Weltee5209642020-12-05 19:59:45 +0100537 nse = gbproxy_nse_by_nsei(cfg, nsei, sgsn_facing ? NSE_F_SGSN : NSE_F_BSS);
Daniel Willmanne50550e2020-11-26 18:19:21 +0100538 if (!nse)
Harald Weltee5209642020-12-05 19:59:45 +0100539 nse = gbproxy_nse_alloc(cfg, nsei, sgsn_facing);
Daniel Willmanne50550e2020-11-26 18:19:21 +0100540
541 return nse;
Harald Welte560bdb32020-12-04 22:24:47 +0100542}
Daniel Willmannee834af2020-12-14 16:22:39 +0100543
Daniel Willmann77493b12020-12-29 21:13:31 +0100544struct gbproxy_nse *gbproxy_nse_by_tlli(struct gbproxy_config *cfg, uint32_t tlli)
545{
546 struct gbproxy_tlli_cache_entry *tlli_cache;
547
548 hash_for_each_possible(cfg->tlli_cache.entries, tlli_cache, list, tlli) {
549 if (tlli_cache->tlli == tlli)
550 return tlli_cache->nse;
551 }
552 return NULL;
553}
554
Daniel Willmann361d0b52021-07-09 17:44:30 +0200555struct gbproxy_nse *gbproxy_nse_by_imsi(struct gbproxy_config *cfg, const char *imsi, enum cache_usage_type usage)
Daniel Willmannc8a50092021-01-17 13:11:41 +0100556{
557 struct gbproxy_imsi_cache_entry *imsi_cache;
558 uint16_t imsi_hash = _checksum_imsi(imsi);
559
560 hash_for_each_possible(cfg->imsi_cache.entries, imsi_cache, list, imsi_hash) {
Daniel Willmann361d0b52021-07-09 17:44:30 +0200561 if (!strncmp(imsi_cache->imsi, imsi, sizeof(imsi_cache->imsi)) && imsi_cache->usage == usage)
Daniel Willmannc8a50092021-01-17 13:11:41 +0100562 return imsi_cache->nse;
563 }
564 return NULL;
565}
Daniel Willmann77493b12020-12-29 21:13:31 +0100566
Daniel Willmann216dff82020-12-29 16:07:17 +0100567/***********************************************************************
568 * SGSN - Serving GPRS Support Node
569 ***********************************************************************/
570
571/*! Allocate a new SGSN. This ensures the corresponding gbproxy_nse is allocated as well
572 * \param[in] cfg The gbproxy configuration
573 * \param[in] nsei The nsei where the SGSN can be reached
Daniel Willmanna648f3c2020-12-28 18:07:27 +0100574 * \param[in] name A name to give the SGSN
Daniel Willmann216dff82020-12-29 16:07:17 +0100575 * \return The SGSN, NULL if it couldn't be allocated
576 */
Daniel Willmanna648f3c2020-12-28 18:07:27 +0100577struct gbproxy_sgsn *gbproxy_sgsn_alloc(struct gbproxy_config *cfg, uint16_t nsei, const char *name)
Daniel Willmannee834af2020-12-14 16:22:39 +0100578{
579 struct gbproxy_sgsn *sgsn;
580 OSMO_ASSERT(cfg);
581
582 sgsn = talloc_zero(tall_sgsn_ctx, struct gbproxy_sgsn);
583 if (!sgsn)
584 return NULL;
585
586 sgsn->nse = gbproxy_nse_alloc(cfg, nsei, true);
587 if (!sgsn->nse) {
Vadim Yanitskiy6964e882021-01-05 14:42:46 +0100588 LOGP(DOBJ, LOGL_ERROR, "Could not allocate NSE(%05u) for SGSN(%s)\n",
589 nsei, sgsn->name);
Daniel Willmanna648f3c2020-12-28 18:07:27 +0100590 goto free_sgsn;
Daniel Willmannee834af2020-12-14 16:22:39 +0100591 }
592
Daniel Willmanna648f3c2020-12-28 18:07:27 +0100593 if (name)
594 sgsn->name = talloc_strdup(sgsn, name);
595 else
596 sgsn->name = talloc_asprintf(sgsn, "NSE(%05u)", sgsn->nse->nsei);
597 if (!sgsn->name)
598 goto free_sgsn;
599
Daniel Willmannee834af2020-12-14 16:22:39 +0100600 sgsn->pool.allow_attach = true;
601 sgsn->pool.nri_ranges = osmo_nri_ranges_alloc(sgsn);
602
603 llist_add_tail(&sgsn->list, &cfg->sgsns);
604 LOGPSGSN_CAT(sgsn, DOBJ, LOGL_INFO, "SGSN Created\n");
605 return sgsn;
Daniel Willmanna648f3c2020-12-28 18:07:27 +0100606
607free_sgsn:
608 talloc_free(sgsn);
609 return NULL;
Daniel Willmannee834af2020-12-14 16:22:39 +0100610}
611
612/* Only free gbproxy_sgsn, sgsn can't be NULL */
613static void _sgsn_free(struct gbproxy_sgsn *sgsn) {
614 struct gbproxy_config *cfg;
615
616 OSMO_ASSERT(sgsn->nse);
617 cfg = sgsn->nse->cfg;
618 OSMO_ASSERT(cfg);
619
620 LOGPSGSN_CAT(sgsn, DOBJ, LOGL_INFO, "SGSN Destroying\n");
621 llist_del(&sgsn->list);
Daniel Willmann5193f222021-01-11 05:00:46 +0100622 /* talloc will free ->name and ->pool.nri_ranges */
Daniel Willmannee834af2020-12-14 16:22:39 +0100623 talloc_free(sgsn);
624}
625
Daniel Willmann216dff82020-12-29 16:07:17 +0100626/*! Free the SGSN. This ensures the corresponding gbproxy_nse is freed as well
627 * \param[in] sgsn The SGSN
628 */
Daniel Willmannee834af2020-12-14 16:22:39 +0100629void gbproxy_sgsn_free(struct gbproxy_sgsn *sgsn)
630{
631 if (!sgsn)
632 return;
633
Daniel Willmann37518b32021-05-27 18:13:36 +0200634 OSMO_ASSERT(sgsn->nse);
Daniel Willmannee834af2020-12-14 16:22:39 +0100635
636 _nse_free(sgsn->nse);
637 _sgsn_free(sgsn);
638}
639
Daniel Willmann216dff82020-12-29 16:07:17 +0100640/*! Return the SGSN for a given NSEI
641 * \param[in] cfg The gbproxy configuration
642 * \param[in] nsei The nsei where the SGSN can be reached
643 * \return Returns the matching SGSN or NULL if it couldn't be found
644 */
Daniel Willmanna648f3c2020-12-28 18:07:27 +0100645struct gbproxy_sgsn *gbproxy_sgsn_by_name(struct gbproxy_config *cfg, const char *name)
646{
647 struct gbproxy_sgsn *sgsn;
648 OSMO_ASSERT(cfg);
649
650 llist_for_each_entry(sgsn, &cfg->sgsns, list) {
651 if (!strcmp(sgsn->name, name))
652 return sgsn;
653 }
654
655 return NULL;
656}
657
658/*! Return the SGSN for a given NSEI
659 * \param[in] cfg The gbproxy configuration
660 * \param[in] nsei The nsei where the SGSN can be reached
661 * \return Returns the matching SGSN or NULL if it couldn't be found
662 */
Daniel Willmannee834af2020-12-14 16:22:39 +0100663struct gbproxy_sgsn *gbproxy_sgsn_by_nsei(struct gbproxy_config *cfg, uint16_t nsei)
664{
665 struct gbproxy_sgsn *sgsn;
666 OSMO_ASSERT(cfg);
667
668 llist_for_each_entry(sgsn, &cfg->sgsns, list) {
669 if (sgsn->nse->nsei == nsei)
670 return sgsn;
671 }
672
673 return NULL;
674}
675
Daniel Willmann216dff82020-12-29 16:07:17 +0100676/*! Return the SGSN for a given NSEI, creating a new one if none exists
677 * \param[in] cfg The gbproxy configuration
678 * \param[in] nsei The nsei where the SGSN can be reached
679 * \return Returns the SGSN
680 */
Daniel Willmannee834af2020-12-14 16:22:39 +0100681struct gbproxy_sgsn *gbproxy_sgsn_by_nsei_or_new(struct gbproxy_config *cfg, uint16_t nsei)
682{
683 struct gbproxy_sgsn *sgsn;
684 OSMO_ASSERT(cfg);
685
686 sgsn = gbproxy_sgsn_by_nsei(cfg, nsei);
687 if (!sgsn)
Daniel Willmanna648f3c2020-12-28 18:07:27 +0100688 sgsn = gbproxy_sgsn_alloc(cfg, nsei, NULL);
Daniel Willmannee834af2020-12-14 16:22:39 +0100689
690 return sgsn;
691}
692
693/*! Return the gbproxy_sgsn matching that NRI
694 * \param[in] cfg proxy in which we operate
695 * \param[in] nri NRI to look for
696 * \param[out] null_nri If not NULL this indicates whether the NRI is a null NRI
697 * \return The SGSN this NRI has been added to, NULL if no matching SGSN could be found
698 */
699struct gbproxy_sgsn *gbproxy_sgsn_by_nri(struct gbproxy_config *cfg, uint16_t nri, bool *null_nri)
700{
701 struct gbproxy_sgsn *sgsn;
702 OSMO_ASSERT(cfg);
703
704 llist_for_each_entry(sgsn, &cfg->sgsns, list) {
Daniel Willmann37518b32021-05-27 18:13:36 +0200705 if (!sgsn->nse->alive)
706 continue;
707
Daniel Willmannee834af2020-12-14 16:22:39 +0100708 if (osmo_nri_v_matches_ranges(nri, sgsn->pool.nri_ranges)) {
709 /* Also check if the NRI we're looking for is a NULL NRI */
Vadim Yanitskiy4dba67a2021-01-05 14:36:52 +0100710 if (null_nri) {
Daniel Willmannee834af2020-12-14 16:22:39 +0100711 if (osmo_nri_v_matches_ranges(nri, cfg->pool.null_nri_ranges))
712 *null_nri = true;
713 else
714 *null_nri = false;
715 }
716 return sgsn;
717 }
718 }
719
720 return NULL;
721}
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100722
Daniel Willmann37518b32021-05-27 18:13:36 +0200723/*! Select a pseudo-random SGSN for a given TLLI, ignoring any SGSN that is not accepting connections or down
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100724 * \param[in] cfg The gbproxy configuration
725 * \param[in] sgsn_avoid If not NULL then avoid this SGSN when selecting a new one. Use for load redistribution
726 * \param[in] tlli The tlli to choose an SGSN for. The same tlli will map to the same SGSN as long as no SGSN is
727 * added/removed or allow_attach changes.
728 * \return Returns the sgsn on success, NULL if no SGSN that allows new connections could be found
729 */
730struct gbproxy_sgsn *gbproxy_sgsn_by_tlli(struct gbproxy_config *cfg, struct gbproxy_sgsn *sgsn_avoid,
731 uint32_t tlli)
732{
733 uint32_t i = 0;
734 uint32_t index, num_sgsns;
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100735 OSMO_ASSERT(cfg);
736
Daniel Willmannb387c1e2020-12-27 18:14:39 +0100737 struct gbproxy_sgsn *sgsn = cfg->pool.nsf_override;
738
739 if (sgsn) {
740 LOGPSGSN(sgsn, LOGL_DEBUG, "Node selection function is overridden by config\n");
741 return sgsn;
742 }
743
Daniel Willmann5193f222021-01-11 05:00:46 +0100744 /* TODO: We should keep track of count in cfg */
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100745 num_sgsns = llist_count(&cfg->sgsns);
746
747 if (num_sgsns == 0)
748 return NULL;
749
Daniel Willmann5193f222021-01-11 05:00:46 +0100750 /* FIXME: 256 SGSNs ought to be enough for everyone */
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100751 index = hash_32(tlli, 8) % num_sgsns;
752
Daniel Willmann5193f222021-01-11 05:00:46 +0100753 /* Get the first enabled SGSN after index */
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100754 llist_for_each_entry(sgsn, &cfg->sgsns, list) {
Daniel Willmann37518b32021-05-27 18:13:36 +0200755 if (i >= index && sgsn->pool.allow_attach && sgsn->nse->alive) {
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100756 return sgsn;
757 }
758 i++;
759 }
Daniel Willmann5193f222021-01-11 05:00:46 +0100760 /* Start again from the beginning */
Daniel Willmann3c56a2a2021-01-05 15:52:05 +0100761 i = 0;
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100762 llist_for_each_entry(sgsn, &cfg->sgsns, list) {
Daniel Willmann3c56a2a2021-01-05 15:52:05 +0100763 if (i >= index) {
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100764 break;
Daniel Willmann37518b32021-05-27 18:13:36 +0200765 } else if (sgsn->pool.allow_attach && sgsn->nse->alive) {
Daniel Willmannd4ab1f92020-12-21 18:53:55 +0100766 return sgsn;
767 }
768 i++;
769 }
770
771 return NULL;
772}
Daniel Willmann37518b32021-05-27 18:13:36 +0200773
774/*! Return the first available gbproxy_sgsn
775 * \param[in] cfg proxy in which we operate
776 * \return The SGSN, NULL if no matching SGSN could be found
777 */
778struct gbproxy_sgsn *gbproxy_sgsn_by_available(struct gbproxy_config *cfg)
779{
780 struct gbproxy_sgsn *sgsn;
781 OSMO_ASSERT(cfg);
782
783 llist_for_each_entry(sgsn, &cfg->sgsns, list)
784 if (sgsn->nse->alive &&sgsn->pool.allow_attach)
785 return sgsn;
786
787 return NULL;
788}