blob: b3638fe3f1d06cc8aa0fd951411199e9d40cef90 [file] [log] [blame]
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001/* GTP Hub Implementation */
2
3/* (C) 2015 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
4 * All Rights Reserved
5 *
6 * Author: Neels Hofmeyr
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#include <string.h>
23#include <errno.h>
24#include <inttypes.h>
25#include <time.h>
26#include <limits.h>
27#include <sys/socket.h>
28#include <netinet/in.h>
29#include <arpa/inet.h>
30
31#include <gtp.h>
32#include <gtpie.h>
33
34#include <openbsc/gtphub.h>
35#include <openbsc/debug.h>
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +010036#include <openbsc/gprs_utils.h>
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +020037
38#include <osmocom/core/utils.h>
39#include <osmocom/core/logging.h>
40#include <osmocom/core/socket.h>
41
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +010042
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +020043#define GTPHUB_DEBUG 1
44
45static const int GTPH_GC_TICK_SECONDS = 1;
46
47void *osmo_gtphub_ctx;
48
49#define LOGERR(fmt, args...) \
50 LOGP(DGTPHUB, LOGL_ERROR, fmt, ##args)
51
52#define LOG(fmt, args...) \
53 LOGP(DGTPHUB, LOGL_NOTICE, fmt, ##args)
54
55#define ZERO_STRUCT(struct_pointer) memset(struct_pointer, '\0', sizeof(*(struct_pointer)))
56
57/* TODO move this to osmocom/core/select.h ? */
58typedef int (*osmo_fd_cb_t)(struct osmo_fd *fd, unsigned int what);
59
60/* TODO move this to osmocom/core/linuxlist.h ? */
61#define __llist_first(head) (((head)->next == (head)) ? NULL : (head)->next)
62#define llist_first(head, type, entry) llist_entry(__llist_first(head), type, entry)
63
64/* TODO move GTP header stuff to openggsn/gtp/ ? See gtp_decaps*() */
65
66enum gtp_rc {
67 GTP_RC_UNKNOWN = 0,
68 GTP_RC_TINY = 1, /* no IEs (like ping/pong) */
Neels Hofmeyre921e322015-11-11 00:45:50 +010069 GTP_RC_PDU_C = 2, /* a real packet with IEs */
70 GTP_RC_PDU_U = 3, /* a real packet with User data */
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +020071
72 GTP_RC_TOOSHORT = -1,
73 GTP_RC_UNSUPPORTED_VERSION = -2,
74 GTP_RC_INVALID_IE = -3,
75};
76
77struct gtp_packet_desc {
78 union gtp_packet *data;
79 int data_len;
80 int header_len;
81 int version;
82 uint8_t type;
83 uint16_t seq;
84 uint32_t header_tei;
85 int rc; /* enum gtp_rc */
86 unsigned int plane_idx;
87 union gtpie_member *ie[GTPIE_SIZE];
88};
89
90void gsn_addr_copy(struct gsn_addr *gsna, const struct gsn_addr *src)
91{
92 memcpy(gsna, src, sizeof(struct gsn_addr));
93}
94
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +020095int gsn_addr_from_sockaddr(struct gsn_addr *gsna, uint16_t *port,
96 const struct osmo_sockaddr *sa)
97{
98 char addr_str[256];
99 char port_str[6];
100
101 if (osmo_sockaddr_to_strs(addr_str, sizeof(addr_str),
102 port_str, sizeof(port_str),
103 sa, (NI_NUMERICHOST | NI_NUMERICSERV))
104 != 0) {
105 return -1;
106 }
107
108 if (port)
109 *port = atoi(port_str);
110
111 return gsn_addr_from_str(gsna, addr_str);
112}
113
114int gsn_addr_from_str(struct gsn_addr *gsna, const char *numeric_addr_str)
115{
116 int af = AF_INET;
117 gsna->len = 4;
118 const char *pos = numeric_addr_str;
119 for (; *pos; pos++) {
120 if (*pos == ':') {
121 af = AF_INET6;
122 gsna->len = 16;
123 break;
124 }
125 }
126
127 int rc = inet_pton(af, numeric_addr_str, gsna->buf);
128 if (rc != 1) {
129 LOGERR("Cannot resolve numeric address: '%s'\n", numeric_addr_str);
130 return -1;
131 }
132 return 0;
133}
134
135const char *gsn_addr_to_str(const struct gsn_addr *gsna)
136{
137 static char buf[INET6_ADDRSTRLEN + 1];
138 return gsn_addr_to_strb(gsna, buf, sizeof(buf));
139}
140
141const char *gsn_addr_to_strb(const struct gsn_addr *gsna,
142 char *strbuf,
143 int strbuf_len)
144{
145 int af;
146 switch (gsna->len) {
147 case 4:
148 af = AF_INET;
149 break;
150 case 16:
151 af = AF_INET6;
152 break;
153 default:
154 return NULL;
155 }
156
157 const char *r = inet_ntop(af, gsna->buf, strbuf, strbuf_len);
158 if (!r) {
159 LOGERR("Cannot convert gsn_addr to string: %s: len=%d, buf=%s\n",
160 strerror(errno),
161 (int)gsna->len,
162 osmo_hexdump(gsna->buf, sizeof(gsna->buf)));
163 }
164 return r;
165}
166
167int gsn_addr_same(const struct gsn_addr *a, const struct gsn_addr *b)
168{
169 if (a == b)
170 return 1;
171 if ((!a) || (!b))
172 return 0;
173 if (a->len != b->len)
174 return 0;
175 return (memcmp(a->buf, b->buf, a->len) == 0)? 1 : 0;
176}
177
178static int gsn_addr_get(struct gsn_addr *gsna, const struct gtp_packet_desc *p, int idx)
179{
Neels Hofmeyre921e322015-11-11 00:45:50 +0100180 if (p->rc != GTP_RC_PDU_C)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200181 return -1;
182
183 unsigned int len;
184 /* gtpie.h fails to declare gtpie_gettlv()'s first arg as const. */
185 if (gtpie_gettlv((union gtpie_member**)p->ie, GTPIE_GSN_ADDR, idx,
186 &len, gsna->buf, sizeof(gsna->buf))
187 != 0)
188 return -1;
189 gsna->len = len;
190 return 0;
191}
192
193static int gsn_addr_put(const struct gsn_addr *gsna, struct gtp_packet_desc *p, int idx)
194{
Neels Hofmeyre921e322015-11-11 00:45:50 +0100195 if (p->rc != GTP_RC_PDU_C)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200196 return -1;
197
198 int ie_idx;
199 ie_idx = gtpie_getie(p->ie, GTPIE_GSN_ADDR, idx);
200
201 if (ie_idx < 0)
202 return -1;
203
204 struct gtpie_tlv *ie = &p->ie[ie_idx]->tlv;
205 int ie_l = ntoh16(ie->l);
206 if (ie_l != gsna->len) {
207 LOG("Not implemented: replace an IE address of different size:"
208 " replace %d with %d\n", (int)ie_l, (int)gsna->len);
209 return -1;
210 }
211
212 memcpy(ie->v, gsna->buf, (int)ie_l);
213 return 0;
214}
215
216/* Validate GTP version 0 data; analogous to validate_gtp1_header(), see there.
217 */
218void validate_gtp0_header(struct gtp_packet_desc *p)
219{
220 const struct gtp0_header *pheader = &(p->data->gtp0.h);
221 p->rc = GTP_RC_UNKNOWN;
222 p->header_len = 0;
223
224 OSMO_ASSERT(p->data_len >= 1);
225 OSMO_ASSERT(p->version == 0);
226
227 if (p->data_len < GTP0_HEADER_SIZE) {
228 LOGERR("GTP0 packet too short: %d\n", p->data_len);
229 p->rc = GTP_RC_TOOSHORT;
230 return;
231 }
232
233 p->type = ntoh8(pheader->type);
234 p->seq = ntoh16(pheader->seq);
235 p->header_tei = 0; /* TODO */
236
237 if (p->data_len == GTP0_HEADER_SIZE) {
238 p->rc = GTP_RC_TINY;
239 p->header_len = GTP0_HEADER_SIZE;
240 return;
241 }
242
243 /* Check packet length field versus length of packet */
244 if (p->data_len != (ntoh16(pheader->length) + GTP0_HEADER_SIZE)) {
245 LOGERR("GTP packet length field (%d + %d) does not match"
246 " actual length (%d)\n",
247 GTP0_HEADER_SIZE, (int)ntoh16(pheader->length),
248 p->data_len);
249 p->rc = GTP_RC_TOOSHORT;
250 return;
251 }
252
253 LOG("GTP v0 TID = %" PRIu64 "\n", pheader->tid);
254 p->header_len = GTP0_HEADER_SIZE;
Neels Hofmeyre921e322015-11-11 00:45:50 +0100255 p->rc = GTP_RC_PDU_C;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200256}
257
258/* Validate GTP version 1 data, and update p->rc with the result, as well as
259 * p->header_len in case of a valid header. */
260void validate_gtp1_header(struct gtp_packet_desc *p)
261{
262 const struct gtp1_header_long *pheader = &(p->data->gtp1l.h);
263 p->rc = GTP_RC_UNKNOWN;
264 p->header_len = 0;
265
266 OSMO_ASSERT(p->data_len >= 1);
267 OSMO_ASSERT(p->version == 1);
268
269 if ((p->data_len < GTP1_HEADER_SIZE_LONG)
270 && (p->data_len != GTP1_HEADER_SIZE_SHORT)){
271 LOGERR("GTP packet too short: %d\n", p->data_len);
272 p->rc = GTP_RC_TOOSHORT;
273 return;
274 }
275
276 p->type = ntoh8(pheader->type);
277 p->header_tei = ntoh32(pheader->tei);
278 p->seq = ntoh16(pheader->seq);
279
280 LOG("|GTPv1\n");
281 LOG("| type = %" PRIu8 " 0x%02" PRIx8 "\n",
282 p->type, p->type);
283 LOG("| length = %" PRIu16 " 0x%04" PRIx16 "\n",
284 ntoh16(pheader->length), ntoh16(pheader->length));
285 LOG("| TEI = %" PRIu32 " 0x%08" PRIx32 "\n",
286 p->header_tei, p->header_tei);
287 LOG("| seq = %" PRIu16 " 0x%04" PRIx16 "\n",
288 p->seq, p->seq);
289 LOG("| npdu = %" PRIu8 " 0x%02" PRIx8 "\n",
290 pheader->npdu, pheader->npdu);
291 LOG("| next = %" PRIu8 " 0x%02" PRIx8 "\n",
292 pheader->next, pheader->next);
293
294 if (p->data_len <= GTP1_HEADER_SIZE_LONG) {
295 p->rc = GTP_RC_TINY;
296 p->header_len = GTP1_HEADER_SIZE_SHORT;
297 return;
298 }
299
300 /* Check packet length field versus length of packet */
301 if (p->data_len != (ntoh16(pheader->length) + GTP1_HEADER_SIZE_SHORT)) {
302 LOGERR("GTP packet length field (%d + %d) does not match"
303 " actual length (%d)\n",
304 GTP1_HEADER_SIZE_SHORT, (int)ntoh16(pheader->length),
305 p->data_len);
306 p->rc = GTP_RC_TOOSHORT;
307 return;
308 }
309
Neels Hofmeyre921e322015-11-11 00:45:50 +0100310 p->rc = GTP_RC_PDU_C;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200311 p->header_len = GTP1_HEADER_SIZE_LONG;
312}
313
314/* Examine whether p->data of size p->data_len has a valid GTP header. Set
315 * p->version, p->rc and p->header_len. On error, p->rc <= 0 (see enum
316 * gtp_rc). p->data must point at a buffer with p->data_len set. */
317void validate_gtp_header(struct gtp_packet_desc *p)
318{
319 p->rc = GTP_RC_UNKNOWN;
320
321 /* Need at least 1 byte in order to check version */
322 if (p->data_len < 1) {
323 LOGERR("Discarding packet - too small: %d\n", p->data_len);
324 p->rc = GTP_RC_TOOSHORT;
325 return;
326 }
327
328 p->version = p->data->flags >> 5;
329
330 switch (p->version) {
331 case 0:
332 validate_gtp0_header(p);
333 break;
334 case 1:
335 validate_gtp1_header(p);
336 break;
337 default:
338 LOGERR("Unsupported GTP version: %d\n", p->version);
339 p->rc = GTP_RC_UNSUPPORTED_VERSION;
340 break;
341 }
342}
343
344
345/* Return the value of the i'th IMSI IEI by copying to *imsi.
346 * The first IEI is reached by passing i = 0.
347 * imsi must point at allocated space of (at least) 8 bytes.
348 * Return 1 on success, or 0 if not found. */
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100349static int get_ie_imsi(union gtpie_member *ie[], int i, uint8_t *imsi)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200350{
351 return gtpie_gettv0(ie, GTPIE_IMSI, i, imsi, 8) == 0;
352}
353
354/* Analogous to get_ie_imsi(). nsapi must point at a single uint8_t. */
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100355static int get_ie_nsapi(union gtpie_member *ie[], int i, uint8_t *nsapi)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200356{
357 return gtpie_gettv1(ie, GTPIE_NSAPI, i, nsapi) == 0;
358}
359
360static char imsi_digit_to_char(uint8_t nibble)
361{
362 nibble &= 0x0f;
363 if (nibble > 9)
364 return (nibble == 0x0f) ? '\0' : '?';
365 return '0' + nibble;
366}
367
368/* Return a human readable IMSI string, in a static buffer.
369 * imsi must point at 8 octets of IMSI IE encoded IMSI data. */
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100370static int imsi_to_str(uint8_t *imsi, const char **imsi_str)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200371{
372 static char str[17];
373 int i;
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100374 char c;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200375
376 for (i = 0; i < 8; i++) {
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100377 c = imsi_digit_to_char(imsi[i]);
378 if (c == '?')
379 return -1;
380 str[2*i] = c;
381
382 c = imsi_digit_to_char(imsi[i] >> 4);
383 if (c == '?')
384 return -1;
385 str[2*i + 1] = c;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200386 }
387 str[16] = '\0';
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100388 *imsi_str = str;
389 return 1;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200390}
391
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100392/* Return 0 if not present, 1 if present and decoded successfully, -1 if
393 * present but cannot be decoded. */
394static int get_ie_imsi_str(union gtpie_member *ie[], int i, const char **imsi_str)
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100395{
396 uint8_t imsi_buf[8];
397 if (!get_ie_imsi(ie, i, imsi_buf))
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100398 return 0;
399 return imsi_to_str(imsi_buf, imsi_str);
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100400}
401
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100402/* Return 0 if not present, 1 if present and decoded successfully, -1 if
403 * present but cannot be decoded. */
404static int get_ie_apn_str(union gtpie_member *ie[], const char **apn_str)
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100405{
406 static char apn_buf[GSM_APN_LENGTH];
407 unsigned int len;
408 if (gtpie_gettlv(ie, GTPIE_APN, 0,
409 &len, apn_buf, sizeof(apn_buf)) != 0)
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100410 return 0;
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100411
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100412 if (len < 2) {
413 LOGERR("APN IE: invalid length: %d\n",
414 (int)len);
415 return -1;
416 }
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100417
418 if (len > (sizeof(apn_buf) - 1))
419 len = sizeof(apn_buf) - 1;
420 apn_buf[len] = '\0';
421
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100422 *apn_str = gprs_apn_to_str(apn_buf, (uint8_t*)apn_buf, len);
423 if (!(*apn_str)) {
424 LOGERR("APN IE: present but cannot be decoded: %s\n",
425 osmo_hexdump((uint8_t*)apn_buf, len));
426 return -1;
427 }
428 return 1;
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100429}
430
431
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200432/* Validate header, and index information elements. Write decoded packet
433 * information to *res. res->data will point at the given data buffer. On
434 * error, p->rc is set <= 0 (see enum gtp_rc). */
435static void gtp_decode(const uint8_t *data, int data_len,
436 unsigned int from_plane_idx,
437 struct gtp_packet_desc *res)
438{
439 ZERO_STRUCT(res);
440 res->data = (union gtp_packet*)data;
441 res->data_len = data_len;
442 res->plane_idx = from_plane_idx;
443
444 validate_gtp_header(res);
445
446 if (res->rc <= 0) {
447 LOGERR("INVALID: dropping GTP packet.\n");
448 return;
449 }
450
451 LOG("Valid GTP header (v%d)\n", res->version);
452
Neels Hofmeyre921e322015-11-11 00:45:50 +0100453 if (from_plane_idx == GTPH_PLANE_USER) {
454 res->rc = GTP_RC_PDU_U;
455 return;
456 }
457
458 if (res->rc != GTP_RC_PDU_C) {
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200459 LOG("no IEs in this GTP packet\n");
460 return;
461 }
462
463 if (gtpie_decaps(res->ie, res->version,
464 (void*)(data + res->header_len),
465 res->data_len - res->header_len) != 0) {
466 res->rc = GTP_RC_INVALID_IE;
Neels Hofmeyre921e322015-11-11 00:45:50 +0100467 LOGERR("INVALID: cannot decode IEs. Dropping GTP packet.\n");
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200468 return;
469 }
470
471#if GTPHUB_DEBUG
472 int i;
473
474 for (i = 0; i < 10; i++) {
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100475 const char *imsi;
476 if (get_ie_imsi_str(res->ie, i, &imsi) < 1)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200477 break;
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100478 LOG("| IMSI %s\n", imsi);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200479 }
480
481 for (i = 0; i < 10; i++) {
482 uint8_t nsapi;
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100483 if (!get_ie_nsapi(res->ie, i, &nsapi))
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200484 break;
485 LOG("| NSAPI %d\n", (int)nsapi);
486 }
487
488 for (i = 0; i < 2; i++) {
489 struct gsn_addr addr;
490 if (gsn_addr_get(&addr, res, i) == 0)
491 LOG("| addr %s\n", gsn_addr_to_str(&addr));
492 }
493
494 for (i = 0; i < 10; i++) {
495 uint32_t tei;
496 if (gtpie_gettv4(res->ie, GTPIE_TEI_DI, i, &tei) != 0)
497 break;
498 LOG("| TEI DI (USER) %" PRIu32 " 0x%08" PRIx32 "\n",
499 tei, tei);
500 }
501
502 for (i = 0; i < 10; i++) {
503 uint32_t tei;
504 if (gtpie_gettv4(res->ie, GTPIE_TEI_C, i, &tei) != 0)
505 break;
506 LOG("| TEI (CTRL) %" PRIu32 " 0x%08" PRIx32 "\n",
507 tei, tei);
508 }
509#endif
510}
511
512
513/* expiry */
514
515void expiry_init(struct expiry *exq, int expiry_in_seconds)
516{
517 ZERO_STRUCT(exq);
518 exq->expiry_in_seconds = expiry_in_seconds;
519 INIT_LLIST_HEAD(&exq->items);
520}
521
522void expiry_add(struct expiry *exq, struct expiring_item *item, time_t now)
523{
524 item->expiry = now + exq->expiry_in_seconds;
525
526 /* Add/move to the tail to always sort by expiry, ascending. */
527 llist_del(&item->entry);
528 llist_add_tail(&item->entry, &exq->items);
529}
530
531int expiry_tick(struct expiry *exq, time_t now)
532{
533 int expired = 0;
534 struct expiring_item *m, *n;
535 llist_for_each_entry_safe(m, n, &exq->items, entry) {
536 if (m->expiry <= now) {
537 expiring_item_del(m);
538 expired ++;
539 } else {
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200540 /* The items are added sorted by expiry. So when we hit
541 * an unexpired entry, only more unexpired ones will
542 * follow. */
543 break;
544 }
545 }
546 return expired;
547}
548
549void expiring_item_init(struct expiring_item *item)
550{
551 ZERO_STRUCT(item);
552 INIT_LLIST_HEAD(&item->entry);
553}
554
555void expiring_item_del(struct expiring_item *item)
556{
557 OSMO_ASSERT(item);
558 llist_del(&item->entry);
559 INIT_LLIST_HEAD(&item->entry);
560 if (item->del_cb) {
561 /* avoid loops */
562 del_cb_t del_cb = item->del_cb;
563 item->del_cb = 0;
564 (del_cb)(item);
565 }
566}
567
568
569/* nr_map, nr_pool */
570
571void nr_pool_init(struct nr_pool *pool)
572{
573 *pool = (struct nr_pool){};
574}
575
576nr_t nr_pool_next(struct nr_pool *pool)
577{
578 pool->last_nr ++;
579
580 OSMO_ASSERT(pool->last_nr > 0);
581 /* TODO: gracefully handle running out of TEIs. */
582 /* TODO: random TEIs. */
583
584 return pool->last_nr;
585}
586
587void nr_map_init(struct nr_map *map, struct nr_pool *pool,
588 struct expiry *exq)
589{
590 ZERO_STRUCT(map);
591 map->pool = pool;
592 map->add_items_to_expiry = exq;
593 INIT_LLIST_HEAD(&map->mappings);
594}
595
596void nr_mapping_init(struct nr_mapping *m)
597{
598 ZERO_STRUCT(m);
599 INIT_LLIST_HEAD(&m->entry);
600 expiring_item_init(&m->expiry_entry);
601}
602
603void nr_map_add(struct nr_map *map, struct nr_mapping *mapping, time_t now)
604{
605 /* Generate a mapped number */
606 mapping->repl = nr_pool_next(map->pool);
607
608 /* Add to the tail to always yield a list sorted by expiry, in
609 * ascending order. */
610 llist_add_tail(&mapping->entry, &map->mappings);
611 if (map->add_items_to_expiry)
612 expiry_add(map->add_items_to_expiry,
613 &mapping->expiry_entry,
614 now);
615}
616
617void nr_map_clear(struct nr_map *map)
618{
619 struct nr_mapping *m;
620 struct nr_mapping *n;
621 llist_for_each_entry_safe(m, n, &map->mappings, entry) {
622 nr_mapping_del(m);
623 }
624}
625
626int nr_map_empty(const struct nr_map *map)
627{
628 return llist_empty(&map->mappings);
629}
630
631struct nr_mapping *nr_map_get(const struct nr_map *map,
632 void *origin, nr_t nr_orig)
633{
634 struct nr_mapping *mapping;
635 llist_for_each_entry(mapping, &map->mappings, entry) {
636 if ((mapping->origin == origin)
637 && (mapping->orig == nr_orig))
638 return mapping;
639 }
640 /* Not found. */
641 return NULL;
642}
643
644struct nr_mapping *nr_map_get_inv(const struct nr_map *map, nr_t nr_repl)
645{
646 struct nr_mapping *mapping;
647 llist_for_each_entry(mapping, &map->mappings, entry) {
648 if (mapping->repl == nr_repl) {
649 return mapping;
650 }
651 }
652 /* Not found. */
653 return NULL;
654}
655
656void nr_mapping_del(struct nr_mapping *mapping)
657{
658 OSMO_ASSERT(mapping);
659 llist_del(&mapping->entry);
660 INIT_LLIST_HEAD(&mapping->entry);
661 expiring_item_del(&mapping->expiry_entry);
662}
663
664
665/* gtphub */
666
667const char* const gtphub_plane_idx_names[GTPH_PLANE_N] = {
668 "CTRL",
669 "USER",
670};
671
672const uint16_t gtphub_plane_idx_default_port[GTPH_PLANE_N] = {
673 2123,
674 2152,
675};
676
677time_t gtphub_now(void)
678{
679 struct timespec now_tp;
680 OSMO_ASSERT(clock_gettime(CLOCK_MONOTONIC, &now_tp) >= 0);
681 return now_tp.tv_sec;
682}
683
684/* Remove a gtphub_peer from its list and free it. */
685static void gtphub_peer_del(struct gtphub_peer *peer)
686{
687 nr_map_clear(&peer->seq_map);
688 llist_del(&peer->entry);
689 talloc_free(peer);
690}
691
692static void gtphub_peer_addr_del(struct gtphub_peer_addr *pa)
693{
694 OSMO_ASSERT(llist_empty(&pa->ports));
695 llist_del(&pa->entry);
696 talloc_free(pa);
697}
698
699static void gtphub_peer_port_del(struct gtphub_peer_port *pp)
700{
701 OSMO_ASSERT(pp->ref_count == 0);
702 llist_del(&pp->entry);
703 talloc_free(pp);
704}
705
706/* From the information in the gtp_packet_desc, return the address of a GGSN.
707 * Return -1 on error. */
Neels Hofmeyr5b664f42015-11-10 20:32:13 +0100708static int gtphub_resolve_ggsn(struct gtphub *hub,
709 struct gtp_packet_desc *p,
710 struct gtphub_peer_port **pp);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200711
712/* See gtphub_ext.c (wrapped by unit test) */
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100713struct gtphub_peer_port *gtphub_resolve_ggsn_addr(struct gtphub *hub,
714 const char *imsi_str,
715 const char *apn_ni_str);
716int gtphub_ares_init(struct gtphub *hub);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200717
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200718static void gtphub_zero(struct gtphub *hub)
719{
720 ZERO_STRUCT(hub);
721}
722
723static int gtphub_sock_init(struct osmo_fd *ofd,
724 const struct gtphub_cfg_addr *addr,
725 osmo_fd_cb_t cb,
726 void *data,
727 int ofd_id)
728{
729 if (!addr->addr_str) {
730 LOGERR("Cannot bind: empty address.\n");
731 return -1;
732 }
733 if (!addr->port) {
734 LOGERR("Cannot bind: zero port not permitted.\n");
735 return -1;
736 }
737
738 ofd->when = BSC_FD_READ;
739 ofd->cb = cb;
740 ofd->data = data;
741 ofd->priv_nr = ofd_id;
742
743 int rc;
744 rc = osmo_sock_init_ofd(ofd,
745 AF_UNSPEC, SOCK_DGRAM, IPPROTO_UDP,
746 addr->addr_str, addr->port,
747 OSMO_SOCK_F_BIND);
748 if (rc < 1) {
749 LOGERR("Cannot bind to %s port %d (rc %d)\n",
750 addr->addr_str, (int)addr->port, rc);
751 return -1;
752 }
753
754 return 0;
755}
756
757static void gtphub_bind_init(struct gtphub_bind *b)
758{
759 ZERO_STRUCT(b);
760
761 INIT_LLIST_HEAD(&b->peers);
762}
763
764static int gtphub_bind_start(struct gtphub_bind *b,
765 const struct gtphub_cfg_bind *cfg,
766 osmo_fd_cb_t cb, void *cb_data,
767 unsigned int ofd_id)
768{
769 if (gsn_addr_from_str(&b->local_addr, cfg->bind.addr_str) != 0)
770 return -1;
771 if (gtphub_sock_init(&b->ofd, &cfg->bind, cb, cb_data, ofd_id) != 0)
772 return -1;
773 return 0;
774}
775
776/* Recv datagram from from->fd, optionally write sender's address to *from_addr.
777 * Return the number of bytes read, zero on error. */
778static int gtphub_read(const struct osmo_fd *from,
779 struct osmo_sockaddr *from_addr,
780 uint8_t *buf, size_t buf_len)
781{
782 /* recvfrom requires the available length to be set in *from_addr_len. */
783 if (from_addr)
784 from_addr->l = sizeof(from_addr->a);
785
786 errno = 0;
787 ssize_t received = recvfrom(from->fd, buf, buf_len, 0,
788 (struct sockaddr*)&from_addr->a, &from_addr->l);
789 /* TODO use recvmsg and get a MSG_TRUNC flag to make sure the message
790 * is not truncated. Then maybe reduce buf's size. */
791
792 if (received <= 0) {
793 if (errno != EAGAIN)
794 LOGERR("error: %s\n", strerror(errno));
795 return 0;
796 }
797
798 if (from_addr) {
799 LOG("from %s\n", osmo_sockaddr_to_str(from_addr));
800 }
801
802 if (received <= 0) {
803 LOGERR("error: %s\n", strerror(errno));
804 return 0;
805 }
806
807 LOG("Received %d\n%s\n", (int)received, osmo_hexdump(buf, received));
808 return received;
809}
810
811inline void gtphub_port_ref_count_inc(struct gtphub_peer_port *pp)
812{
813 OSMO_ASSERT(pp->ref_count < UINT_MAX);
814 pp->ref_count++;
815}
816
817inline void gtphub_port_ref_count_dec(struct gtphub_peer_port *pp)
818{
819 OSMO_ASSERT(pp->ref_count > 0);
820 pp->ref_count--;
821}
822
823inline void set_seq(struct gtp_packet_desc *p, uint16_t seq)
824{
825 OSMO_ASSERT(p->version == 1);
826 p->data->gtp1l.h.seq = hton16(seq);
827 p->seq = seq;
828}
829
830inline void set_tei(struct gtp_packet_desc *p, uint32_t tei)
831{
832 OSMO_ASSERT(p->version == 1);
833 p->data->gtp1l.h.tei = hton32(tei);
834 p->header_tei = tei;
835}
836
837static void gtphub_mapping_del_cb(struct expiring_item *expi);
838
839static struct nr_mapping *gtphub_mapping_new()
840{
841 struct nr_mapping *nrm;
842 nrm = talloc_zero(osmo_gtphub_ctx, struct nr_mapping);
843 OSMO_ASSERT(nrm);
844
845 nr_mapping_init(nrm);
846 nrm->expiry_entry.del_cb = gtphub_mapping_del_cb;
847 return nrm;
848}
849
850static const char *gtphub_peer_strb(struct gtphub_peer *peer, char *buf, int buflen)
851{
852 if (llist_empty(&peer->addresses))
853 return "(addressless)";
854
855 struct gtphub_peer_addr *a = llist_first(&peer->addresses,
856 struct gtphub_peer_addr,
857 entry);
858 return gsn_addr_to_strb(&a->addr, buf, buflen);
859}
860
861static const char *gtphub_port_strb(struct gtphub_peer_port *port, char *buf, int buflen)
862{
863 if (!port)
864 return "(null port)";
865
866 snprintf(buf, buflen, "%s port %d",
867 gsn_addr_to_str(&port->peer_addr->addr),
868 (int)port->port);
869 return buf;
870}
871
872const char *gtphub_peer_str(struct gtphub_peer *peer)
873{
874 static char buf[256];
875 return gtphub_peer_strb(peer, buf, sizeof(buf));
876}
877
878const char *gtphub_peer_str2(struct gtphub_peer *peer)
879{
880 static char buf[256];
881 return gtphub_peer_strb(peer, buf, sizeof(buf));
882}
883
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +0100884const char *gtphub_port_str(struct gtphub_peer_port *port)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200885{
886 static char buf[256];
887 return gtphub_port_strb(port, buf, sizeof(buf));
888}
889
890static const char *gtphub_port_str2(struct gtphub_peer_port *port)
891{
892 static char buf[256];
893 return gtphub_port_strb(port, buf, sizeof(buf));
894}
895
896static void gtphub_mapping_del_cb(struct expiring_item *expi)
897{
898 expi->del_cb = 0; /* avoid recursion loops */
899
900 struct nr_mapping *nrm = container_of(expi,
901 struct nr_mapping,
902 expiry_entry);
903 llist_del(&nrm->entry);
904 INIT_LLIST_HEAD(&nrm->entry); /* mark unused */
905
906 /* Just for log */
907 struct gtphub_peer_port *from = nrm->origin;
908 OSMO_ASSERT(from);
909 LOG("expired: %d: nr mapping from %s: %d->%d\n",
910 (int)nrm->expiry_entry.expiry,
911 gtphub_port_str(from),
912 (int)nrm->orig, (int)nrm->repl);
913
914 gtphub_port_ref_count_dec(from);
915
916 talloc_free(nrm);
917}
918
919static struct nr_mapping *gtphub_mapping_have(struct nr_map *map,
920 struct gtphub_peer_port *from,
921 nr_t orig_nr,
922 time_t now)
923{
924 struct nr_mapping *nrm;
925
926 nrm = nr_map_get(map, from, orig_nr);
927
928 if (!nrm) {
929 nrm = gtphub_mapping_new();
930 nrm->orig = orig_nr;
931 nrm->origin = from;
932 nr_map_add(map, nrm, now);
933 gtphub_port_ref_count_inc(from);
934 LOG("peer %s: MAP %d --> %d\n",
935 gtphub_port_str(from),
936 (int)(nrm->orig), (int)(nrm->repl));
937 } else {
938 /* restart expiry timeout */
939 expiry_add(map->add_items_to_expiry, &nrm->expiry_entry,
940 now);
941 }
942
943 OSMO_ASSERT(nrm);
944 return nrm;
945}
946
947static uint32_t gtphub_tei_mapping_have(struct gtphub *hub,
948 int plane_idx,
949 struct gtphub_peer_port *from,
950 uint32_t orig_tei,
951 time_t now)
952{
953 struct nr_mapping *nrm = gtphub_mapping_have(&hub->tei_map[plane_idx],
954 from, orig_tei, now);
955 LOG("New %s TEI: (from %s, TEI %d) <-- TEI %d\n",
956 gtphub_plane_idx_names[plane_idx],
957 gtphub_port_str(from),
958 (int)orig_tei, (int)nrm->repl);
959
960 return (uint32_t)nrm->repl;
961}
962
Neels Hofmeyr3317c842015-11-11 17:20:42 +0100963static void gtphub_map_seq(struct gtp_packet_desc *p,
964 struct gtphub_peer_port *from_port,
965 struct gtphub_peer_port *to_port,
966 time_t now)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200967{
968 /* Store a mapping in to_peer's map, so when we later receive a GTP
969 * packet back from to_peer, the seq nr can be unmapped back to its
970 * origin (from_peer here). */
971 struct nr_mapping *nrm;
972 nrm = gtphub_mapping_have(&to_port->peer_addr->peer->seq_map,
973 from_port, p->seq, now);
974
975 /* Change the GTP packet to yield the new, mapped seq nr */
976 set_seq(p, nrm->repl);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +0200977}
978
979static struct gtphub_peer_port *gtphub_unmap_seq(struct gtp_packet_desc *p,
980 struct gtphub_peer_port *responding_port)
981{
982 OSMO_ASSERT(p->version == 1);
983 struct nr_mapping *nrm = nr_map_get_inv(&responding_port->peer_addr->peer->seq_map,
984 p->seq);
985 if (!nrm)
986 return NULL;
987 LOG("peer %p: UNMAP %d <-- %d\n", nrm->origin, (int)(nrm->orig), (int)(nrm->repl));
988 set_seq(p, nrm->orig);
989 return nrm->origin;
990}
991
992static void gtphub_check_restart_counter(struct gtphub *hub,
993 struct gtp_packet_desc *p,
994 struct gtphub_peer_port *from)
995{
996 /* TODO */
997 /* If the peer is sending a Recovery IE (7.7.11) with a restart counter
998 * that doesn't match the peer's previously sent restart counter, clear
999 * that peer and cancel PDP contexts. */
1000}
1001
1002static void gtphub_map_restart_counter(struct gtphub *hub,
1003 struct gtp_packet_desc *p,
1004 struct gtphub_peer_port *from,
1005 struct gtphub_peer_port *to)
1006{
1007 /* TODO */
1008}
1009
1010/* gtphub_map_ie_teis() and gtphub_unmap_header_tei():
1011 *
1012 * TEI mapping must happen symmetrically. An SGSN contacts gtphub instead of N
1013 * GGSNs, and a GGSN replies to gtphub for N SGSNs. From either end, TEIs may
1014 * collide: two GGSNs picking the same TEIs, or two SGSNs picking the same
1015 * TEIs. Since the opposite side sees the sender address being gtphub's
1016 * address, TEIs among the SGSNs, and among the GGSNs, must not overlap. If a
1017 * peer sends a TEI already sent before from a peer of the same side, gtphub
1018 * replaces it with a TEI not yet seen from that side and remembers the
1019 * mapping.
1020 *
1021 * Consider two SGSNs A and B contacting two GGSNs C and D thru gtphub.
1022 *
1023 * A: Create PDP Ctx, I have TEI 1.
1024 * ---> gtphub: A has TEI 1, sending 1 for C.
1025 * ---> C: gtphub has TEI 1.
1026 * <--- C: Response to TEI 1: I have TEI 11.
1027 * <--- gtphub: ok, telling A: 11.
1028 * A: gtphub's first TEI is 11. (1)
1029 *
1030 * B: Create PDP Ctx, I have TEIs 1.
1031 * ---> gtphub: 1 already taken for C, sending 2 for B. (map)
1032 * ---> C: gtphub also has 2.
1033 * <--- C: Response to TEI 2: I have TEI 12.
1034 * <--- gtphub: ok, TEI 2 is actually B with TEI 1. (unmap)
1035 * B: gtphub's first TEI is 12, as far as I can tell.
1036 *
1037 * Now the second GGSN comes into play:
1038 *
1039 * A: Create PDP Ctx, I have TEI 2.
1040 * ---> gtphub: A also has TEI 2, but for D, sending 1. (2)
1041 * ---> D: gtphub has 1.
1042 * <--- D: Response to TEI 1: I have TEI 11.
1043 * <--- gtphub: from D, 1 is A. 11 already taken by C, sending 13. (3)
1044 * A: gtphub also has TEI 13. (4)
1045 *
1046 * And some messages routed through:
1047 *
1048 * A: message to TEI 11, see (1).
1049 * ---> gtphub: ok, telling C with TEI 11.
1050 * ---> C: I see, 11 means reply with 1.
1051 * <--- C: Response to TEI 1
1052 * <--- gtphub: 1 from C is actually for A with TEI 1.
1053 * A: ah, my TEI 1, thanks!
1054 *
1055 * A: message to TEI 13, see (4).
1056 * ---> gtphub: ok, but not 13, D wanted TEI 11 instead, see (3).
1057 * ---> D: I see, 11 means reply with 1.
1058 * <--- D: Response to TEI 1
1059 * <--- gtphub: 1 from D is actually for A with TEI 2, see (2).
1060 * A: ah, my TEI 2, thanks!
1061 *
1062 * What if a GGSN initiates a request:
1063 *
1064 * <--- D: Request to gtphub TEI 1
1065 * <--- gtphub: 1 from D is for A with 2, see (2).
1066 * A: my TEI 2 means reply with 13.
1067 * ---> gtphub: 13 was D with 11, see (3).
1068 * ---> D: 11 from gtphub: a reply to my request for TEI 1.
1069 *
1070 * Note that usually, it's the sequence numbers that route a response back to
1071 * the requesting peer. Nevertheless, the TEI mappings must be carried out to
1072 * replace the TEIs in the GTP packet that is relayed.
1073 *
1074 * Also note: the TEI in the GTP header is "reversed" from the TEI in the IEs:
1075 * the TEI in the header is used to send something *to* a peer, while the TEI
1076 * in e.g. a Create PDP Context Request's IE is for routing messages *back*
1077 * later. */
1078
1079static int gtphub_unmap_header_tei(struct gtphub_peer_port **to_port_p,
1080 struct gtphub *hub,
1081 struct gtp_packet_desc *p,
1082 struct gtphub_peer_port *from_port)
1083{
1084 OSMO_ASSERT(p->version == 1);
1085 *to_port_p = NULL;
1086
1087 /* If the header's TEI is zero, no PDP context has been established
1088 * yet. If nonzero, a mapping should actually already exist for this
1089 * TEI, since it must have been announced in a PDP context creation. */
1090 uint32_t tei = p->header_tei;
1091 if (!tei)
1092 return 0;
1093
1094 /* to_peer has previously announced a TEI, which was stored and
1095 * mapped in from_peer's tei_map. */
1096 struct nr_mapping *nrm;
1097 nrm = nr_map_get_inv(&hub->tei_map[p->plane_idx], tei);
1098 if (!nrm) {
1099 LOGERR("Received unknown TEI %" PRIu32 " from %s\n",
1100 tei, gtphub_port_str(from_port));
1101 return -1;
1102 }
1103
1104 struct gtphub_peer_port *to_port = nrm->origin;
1105 uint32_t unmapped_tei = nrm->orig;
1106 set_tei(p, unmapped_tei);
1107
1108 LOG("Unmapped TEI coming from %s: %d -> %d (to %s)\n",
1109 gtphub_port_str(from_port), tei, unmapped_tei,
1110 gtphub_port_str2(to_port));
1111
1112 *to_port_p = to_port;
1113 return 0;
1114}
1115
1116/* Read GSN address IEs from p, and make sure these peer addresses exist in
1117 * bind[plane_idx] with default ports, in their respective planes (both Ctrl
1118 * and User). Map TEIs announced in IEs, and write mapped TEIs in-place into
1119 * the packet p. */
1120static int gtphub_handle_pdp_ctx_ies(struct gtphub *hub,
1121 struct gtphub_bind from_bind[],
1122 struct gtphub_bind to_bind[],
1123 struct gtp_packet_desc *p,
1124 time_t now)
1125{
1126 OSMO_ASSERT(p->plane_idx == GTPH_PLANE_CTRL);
1127
1128 int rc;
1129 int plane_idx;
1130
1131 switch (p->type) {
1132 case GTP_CREATE_PDP_REQ:
1133 case GTP_CREATE_PDP_RSP:
1134 /* Go for it below */
1135 break;
1136 default:
1137 /* Nothing to do for this message type. */
1138 return 0;
1139 }
1140
1141 /* TODO enforce a Request only from SGSN, a Response only from GGSN? */
1142
1143 osmo_static_assert((GTPH_PLANE_CTRL == 0) && (GTPH_PLANE_USER == 1),
1144 plane_nrs_match_GSN_addr_IE_indices);
1145
1146 uint8_t ie_type[] = { GTPIE_TEI_C, GTPIE_TEI_DI };
1147 int ie_mandatory = (p->type == GTP_CREATE_PDP_REQ);
1148
1149 for (plane_idx = 0; plane_idx < 2; plane_idx++) {
1150 struct gsn_addr addr_from_ie;
1151 uint32_t tei_from_ie;
1152 int ie_idx;
1153
1154 /* Fetch GSN Address and TEI from IEs */
1155 rc = gsn_addr_get(&addr_from_ie, p, plane_idx);
1156 if (rc) {
1157 LOGERR("Cannot read %s GSN Address IE\n",
1158 gtphub_plane_idx_names[plane_idx]);
1159 return -1;
1160 }
1161 LOG("Read %s GSN addr %s (%d)\n",
1162 gtphub_plane_idx_names[plane_idx],
1163 gsn_addr_to_str(&addr_from_ie),
1164 addr_from_ie.len);
1165
1166 ie_idx = gtpie_getie(p->ie, ie_type[plane_idx], 0);
1167 if (ie_idx < 0) {
1168 if (ie_mandatory) {
1169 LOGERR("Create PDP Context message invalid:"
1170 " missing IE %d\n", (int)ie_type[plane_idx]);
1171 return -1;
1172 }
1173 tei_from_ie = 0;
1174 }
1175 else
1176 tei_from_ie = ntoh32(p->ie[ie_idx]->tv4.v);
1177
1178 /* Make sure an entry for this peer address with default port
1179 * exists */
1180 struct gtphub_peer_port *peer_from_ie =
1181 gtphub_port_have(hub, &from_bind[plane_idx],
1182 &addr_from_ie,
1183 gtphub_plane_idx_default_port[plane_idx]);
1184
1185 if (tei_from_ie) {
1186 /* Create TEI mapping and replace in GTP packet IE */
1187 uint32_t mapped_tei =
1188 gtphub_tei_mapping_have(hub, plane_idx,
1189 peer_from_ie,
1190 tei_from_ie,
1191 now);
1192 p->ie[ie_idx]->tv4.v = hton32(mapped_tei);
1193 }
1194
1195 /* Replace the GSN address to reflect gtphub. */
1196 rc = gsn_addr_put(&to_bind[plane_idx].local_addr, p, plane_idx);
1197 if (rc) {
1198 LOGERR("Cannot write %s GSN Address IE\n",
1199 gtphub_plane_idx_names[plane_idx]);
1200 return -1;
1201 }
1202 }
1203
1204 return 0;
1205}
1206
1207static int gtphub_write(const struct osmo_fd *to,
1208 const struct osmo_sockaddr *to_addr,
1209 const uint8_t *buf, size_t buf_len)
1210{
1211 errno = 0;
1212 ssize_t sent = sendto(to->fd, buf, buf_len, 0,
1213 (struct sockaddr*)&to_addr->a, to_addr->l);
1214
1215 if (to_addr) {
1216 LOG("to %s\n", osmo_sockaddr_to_str(to_addr));
1217 }
1218
1219 if (sent == -1) {
1220 LOGERR("error: %s\n", strerror(errno));
1221 return -EINVAL;
1222 }
1223
1224 if (sent != buf_len)
1225 LOGERR("sent(%d) != data_len(%d)\n", (int)sent, (int)buf_len);
1226 else
1227 LOG("Sent %d\n%s\n", (int)sent, osmo_hexdump(buf, sent));
1228
1229 return 0;
1230}
1231
1232static int from_ggsns_read_cb(struct osmo_fd *from_ggsns_ofd, unsigned int what)
1233{
1234 unsigned int plane_idx = from_ggsns_ofd->priv_nr;
1235 OSMO_ASSERT(plane_idx < GTPH_PLANE_N);
1236 LOG("\n\n=== reading from GGSN (%s)\n", gtphub_plane_idx_names[plane_idx]);
1237 if (!(what & BSC_FD_READ))
1238 return 0;
1239
1240 struct gtphub *hub = from_ggsns_ofd->data;
1241
1242 static uint8_t buf[4096];
1243 struct osmo_sockaddr from_addr;
1244 struct osmo_sockaddr to_addr;
1245 struct osmo_fd *to_ofd;
1246 size_t len;
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001247 uint8_t *reply_buf;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001248
1249 len = gtphub_read(from_ggsns_ofd, &from_addr, buf, sizeof(buf));
1250 if (len < 1)
1251 return 0;
1252
1253 len = gtphub_from_ggsns_handle_buf(hub, plane_idx, &from_addr, buf, len,
1254 gtphub_now(),
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001255 &reply_buf, &to_ofd, &to_addr);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001256 if (len < 1)
1257 return 0;
1258
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001259 return gtphub_write(to_ofd, &to_addr, reply_buf, len);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001260}
1261
1262static int gtphub_unmap(struct gtphub *hub,
1263 struct gtp_packet_desc *p,
1264 struct gtphub_peer_port *from,
1265 struct gtphub_peer_port *to_proxy,
1266 struct gtphub_peer_port **final_unmapped,
1267 struct gtphub_peer_port **unmapped_from_seq,
1268 struct gtphub_peer_port **unmapped_from_tei)
1269{
1270 /* Always (try to) unmap sequence and TEI numbers, which need to be
1271 * replaced in the packet. Either way, give precedence to the proxy, if
1272 * configured. */
1273
1274 struct gtphub_peer_port *from_seq = NULL;
1275 struct gtphub_peer_port *from_tei = NULL;
1276 struct gtphub_peer_port *unmapped = NULL;
1277
1278 if (unmapped_from_seq)
1279 *unmapped_from_seq = from_seq;
1280 if (unmapped_from_tei)
1281 *unmapped_from_tei = from_tei;
1282 if (final_unmapped)
1283 *final_unmapped = unmapped;
1284
1285 from_seq = gtphub_unmap_seq(p, from);
1286
1287 if (gtphub_unmap_header_tei(&from_tei, hub, p, from) < 0)
1288 return -1;
1289
1290 struct gtphub_peer *from_peer = from->peer_addr->peer;
1291 if (from_seq && from_tei && (from_seq != from_tei)) {
1292 LOGERR("Seq unmap and TEI unmap yield two different peers. Using seq unmap."
1293 "(from %s %s: seq %d yields %s, tei %u yields %s)\n",
1294 gtphub_plane_idx_names[p->plane_idx],
1295 gtphub_peer_str(from_peer),
1296 (int)p->seq,
1297 gtphub_port_str(from_seq),
1298 (int)p->header_tei,
1299 gtphub_port_str2(from_tei)
1300 );
1301 }
1302 unmapped = (from_seq? from_seq : from_tei);
1303
1304 if (unmapped && to_proxy && (unmapped != to_proxy)) {
1305 LOGERR("Unmap yields a different peer than the configured proxy. Using proxy."
1306 " unmapped: %s proxy: %s\n",
1307 gtphub_port_str(unmapped),
1308 gtphub_port_str2(to_proxy)
1309 );
1310 }
1311 unmapped = (to_proxy? to_proxy : unmapped);
1312
1313 if (!unmapped) {
1314 /* Return no error, but returned pointers are all NULL. */
1315 return 0;
1316 }
1317
1318 LOG("from seq %p; from tei %p; unmapped => %p\n",
1319 from_seq, from_tei, unmapped);
1320
1321 if (unmapped_from_seq)
1322 *unmapped_from_seq = from_seq;
1323 if (unmapped_from_tei)
1324 *unmapped_from_tei = from_tei;
1325 if (final_unmapped)
1326 *final_unmapped = unmapped;
1327 return 0;
1328}
1329
1330static int gsn_addr_to_sockaddr(struct gsn_addr *src,
1331 uint16_t port,
1332 struct osmo_sockaddr *dst)
1333{
1334 return osmo_sockaddr_init_udp(dst, gsn_addr_to_str(src), port);
1335}
1336
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001337/* If p is an Echo request, replace p's data with the matching response and
1338 * return 1. If p is no Echo request, return 0, or -1 if an invalid packet is
1339 * detected. */
1340static int gtphub_handle_echo(struct gtphub *hub, struct gtp_packet_desc *p, uint8_t **reply_buf)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001341{
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001342 if (p->type != GTP_ECHO_REQ)
1343 return 0;
1344
1345 static uint8_t echo_response_data[14] = {
1346 0x32, /* flags */
1347 GTP_ECHO_RSP,
1348 0x00, 14 - 8, /* Length in network byte order */
1349 0x00, 0x00, 0x00, 0x00, /* Zero TEI */
1350 0, 0, /* Seq, to be replaced */
1351 0, 0, /* no extensions */
1352 0x0e, /* Recovery IE */
1353 0 /* Recovery counter, to be replaced */
1354 };
1355 uint16_t *seq = (uint16_t*)&echo_response_data[8];
1356 uint8_t *recovery = &echo_response_data[13];
1357
1358 *seq = hton16(p->seq);
1359 *recovery = hub->restart_counter;
1360
1361 *reply_buf = echo_response_data;
1362
1363 return sizeof(echo_response_data);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001364}
1365
Neels Hofmeyrc83cd892015-11-11 14:01:06 +01001366struct gtphub_peer_port *gtphub_known_addr_have_port(const struct gtphub_bind *bind,
1367 const struct osmo_sockaddr *addr);
1368
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001369/* Parse buffer as GTP packet, replace elements in-place and return the ofd and
1370 * address to forward to. Return a pointer to the osmo_fd, but copy the
1371 * sockaddr to *to_addr. The reason for this is that the sockaddr may expire at
1372 * any moment, while the osmo_fd is guaranteed to persist. Return the number of
1373 * bytes to forward, 0 or less on failure. */
1374int gtphub_from_ggsns_handle_buf(struct gtphub *hub,
1375 unsigned int plane_idx,
1376 const struct osmo_sockaddr *from_addr,
1377 uint8_t *buf,
1378 size_t received,
1379 time_t now,
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001380 uint8_t **reply_buf,
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001381 struct osmo_fd **to_ofd,
1382 struct osmo_sockaddr *to_addr)
1383{
Neels Hofmeyre921e322015-11-11 00:45:50 +01001384 LOG("<- rx %s from GGSN %s\n",
1385 gtphub_plane_idx_names[plane_idx],
1386 osmo_sockaddr_to_str(from_addr));
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001387
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001388 static struct gtp_packet_desc p;
1389 gtp_decode(buf, received, plane_idx, &p);
1390
1391 if (p.rc <= 0)
1392 return -1;
1393
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001394 int reply_len;
1395 reply_len = gtphub_handle_echo(hub, &p, reply_buf);
1396 if (reply_len > 0) {
1397 /* It was an echo. Nothing left to do. */
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001398 osmo_sockaddr_copy(to_addr, from_addr);
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001399 *to_ofd = &hub->to_ggsns[plane_idx].ofd;
1400 return reply_len;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001401 }
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001402 if (reply_len < 0)
1403 return -1;
1404
1405 *to_ofd = &hub->to_sgsns[plane_idx].ofd;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001406
1407 /* If a GGSN proxy is configured, check that it's indeed that proxy
1408 * talking to us. A proxy is a forced 1:1 connection, e.g. to another
1409 * gtphub, so no-one else is allowed to talk to us from that side. */
1410 struct gtphub_peer_port *ggsn = hub->ggsn_proxy[plane_idx];
1411 if (ggsn) {
1412 if (osmo_sockaddr_cmp(&ggsn->sa, from_addr) != 0) {
1413 LOGERR("Rejecting: GGSN proxy configured, but GTP packet"
1414 " received on GGSN bind is from another sender:"
1415 " proxy: %s sender: %s\n",
1416 gtphub_port_str(ggsn),
1417 osmo_sockaddr_to_str(from_addr));
1418 return -1;
1419 }
1420 }
1421
1422 if (!ggsn) {
Neels Hofmeyrc83cd892015-11-11 14:01:06 +01001423 /* Find a GGSN peer with a matching address. The sender's port
1424 * may in fact differ. */
1425 ggsn = gtphub_known_addr_have_port(&hub->to_ggsns[plane_idx],
1426 from_addr);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001427 }
1428
1429 /* If any PDP context has been created, we already have an entry for
1430 * this GGSN. If we don't have an entry, the GGSN has nothing to tell
1431 * us about. */
1432 if (!ggsn) {
Neels Hofmeyre921e322015-11-11 00:45:50 +01001433 LOGERR("Dropping packet: unknown GGSN peer: %s\n",
1434 osmo_sockaddr_to_str(from_addr));
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001435 return -1;
1436 }
1437
1438 LOG("GGSN peer: %s\n", gtphub_port_str(ggsn));
1439
1440 struct gtphub_peer_port *sgsn_from_seq;
1441 struct gtphub_peer_port *sgsn;
1442 if (gtphub_unmap(hub, &p, ggsn,
1443 hub->sgsn_proxy[plane_idx],
1444 &sgsn, &sgsn_from_seq,
1445 NULL /* not interested, got it in &sgsn already */
1446 )
1447 != 0) {
1448 return -1;
1449 }
1450
1451 if (!sgsn) {
1452 /* A GGSN initiated request would go to a known TEI. So this is
1453 * bogus. */
1454 LOGERR("No SGSN to send to. Dropping packet.\n");
1455 return -1;
1456 }
1457
1458 if (plane_idx == GTPH_PLANE_CTRL) {
1459 /* This may be a Create PDP Context response. If it is, there are other
1460 * addresses in the GTP message to set up apart from the sender. */
1461 if (gtphub_handle_pdp_ctx_ies(hub, hub->to_ggsns,
1462 hub->to_sgsns, &p, now)
1463 != 0)
1464 return -1;
1465 }
1466
1467 gtphub_check_restart_counter(hub, &p, ggsn);
1468 gtphub_map_restart_counter(hub, &p, ggsn, sgsn);
1469
1470 /* If the GGSN is replying to an SGSN request, the sequence nr has
1471 * already been unmapped above (sgsn_from_seq != NULL), and we need not
1472 * create a new mapping. */
1473 if (!sgsn_from_seq)
1474 gtphub_map_seq(&p, ggsn, sgsn, now);
1475
1476 osmo_sockaddr_copy(to_addr, &sgsn->sa);
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001477
1478 *reply_buf = (uint8_t*)p.data;
Neels Hofmeyre921e322015-11-11 00:45:50 +01001479
1480 LOG("<-- Forward to SGSN: %d bytes to %s\n",
1481 (int)received, osmo_sockaddr_to_str(to_addr));
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001482 return received;
1483}
1484
1485static int from_sgsns_read_cb(struct osmo_fd *from_sgsns_ofd, unsigned int what)
1486{
1487 unsigned int plane_idx = from_sgsns_ofd->priv_nr;
1488 OSMO_ASSERT(plane_idx < GTPH_PLANE_N);
1489 LOG("\n\n=== reading from SGSN (%s)\n", gtphub_plane_idx_names[plane_idx]);
1490
1491 if (!(what & BSC_FD_READ))
1492 return 0;
1493
1494 struct gtphub *hub = from_sgsns_ofd->data;
1495
1496 static uint8_t buf[4096];
1497 struct osmo_sockaddr from_addr;
1498 struct osmo_sockaddr to_addr;
1499 struct osmo_fd *to_ofd;
1500 size_t len;
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001501 uint8_t *reply_buf;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001502
1503 len = gtphub_read(from_sgsns_ofd, &from_addr, buf, sizeof(buf));
1504 if (len < 1)
1505 return 0;
1506
1507 len = gtphub_from_sgsns_handle_buf(hub, plane_idx, &from_addr, buf, len,
1508 gtphub_now(),
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001509 &reply_buf, &to_ofd, &to_addr);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001510 if (len < 1)
1511 return 0;
1512
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001513 return gtphub_write(to_ofd, &to_addr, reply_buf, len);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001514}
1515
1516/* Analogous to gtphub_from_ggsns_handle_buf(), see the comment there. */
1517int gtphub_from_sgsns_handle_buf(struct gtphub *hub,
1518 unsigned int plane_idx,
1519 const struct osmo_sockaddr *from_addr,
1520 uint8_t *buf,
1521 size_t received,
1522 time_t now,
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001523 uint8_t **reply_buf,
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001524 struct osmo_fd **to_ofd,
1525 struct osmo_sockaddr *to_addr)
1526{
Neels Hofmeyre921e322015-11-11 00:45:50 +01001527 LOG("-> rx %s from SGSN %s\n",
1528 gtphub_plane_idx_names[plane_idx],
1529 osmo_sockaddr_to_str(from_addr));
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001530
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001531 static struct gtp_packet_desc p;
1532 gtp_decode(buf, received, plane_idx, &p);
1533
1534 if (p.rc <= 0)
1535 return -1;
1536
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001537 int reply_len;
1538 reply_len = gtphub_handle_echo(hub, &p, reply_buf);
1539 if (reply_len > 0) {
1540 /* It was an echo. Nothing left to do. */
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001541 osmo_sockaddr_copy(to_addr, from_addr);
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001542 *to_ofd = &hub->to_ggsns[plane_idx].ofd;
1543 return reply_len;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001544 }
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001545 if (reply_len < 0)
1546 return -1;
1547
1548 *to_ofd = &hub->to_ggsns[plane_idx].ofd;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001549
1550 /* If an SGSN proxy is configured, check that it's indeed that proxy
1551 * talking to us. A proxy is a forced 1:1 connection, e.g. to another
1552 * gtphub, so no-one else is allowed to talk to us from that side. */
1553 struct gtphub_peer_port *sgsn = hub->sgsn_proxy[plane_idx];
1554 if (sgsn) {
1555 if (osmo_sockaddr_cmp(&sgsn->sa, from_addr) != 0) {
1556 LOGERR("Rejecting: GGSN proxy configured, but GTP packet"
1557 " received on GGSN bind is from another sender:"
1558 " proxy: %s sender: %s\n",
1559 gtphub_port_str(sgsn),
1560 osmo_sockaddr_to_str(from_addr));
1561 return -1;
1562 }
1563 }
1564
1565 if (!sgsn) {
1566 /* If any contact has been made before, we already have an
Neels Hofmeyrc83cd892015-11-11 14:01:06 +01001567 * entry for this SGSN. The port may differ. */
1568 sgsn = gtphub_known_addr_have_port(&hub->to_sgsns[plane_idx],
1569 from_addr);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001570 }
1571
1572 if (!sgsn) {
1573 /* A new peer. If this is on the Ctrl plane, an SGSN may make
1574 * first contact without being known yet, so create the peer
1575 * struct for the current sender. */
1576 if (plane_idx != GTPH_PLANE_CTRL) {
1577 LOGERR("User plane peer was not announced by PDP Context, discarding: %s\n",
1578 osmo_sockaddr_to_str(from_addr));
1579 return -1;
1580 }
1581
1582 struct gsn_addr from_gsna;
1583 uint16_t from_port;
1584 if (gsn_addr_from_sockaddr(&from_gsna, &from_port, from_addr) != 0)
1585 return -1;
1586
1587 sgsn = gtphub_port_have(hub, &hub->to_sgsns[plane_idx],
1588 &from_gsna, from_port);
1589 }
1590
1591 if (!sgsn) {
1592 /* This could theoretically happen for invalid address data or somesuch. */
Neels Hofmeyre921e322015-11-11 00:45:50 +01001593 LOGERR("Dropping packet: invalid SGSN peer: %s\n",
1594 osmo_sockaddr_to_str(from_addr));
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001595 return -1;
1596 }
1597 LOG("SGSN peer: %s\n", gtphub_port_str(sgsn));
1598
1599 struct gtphub_peer_port *ggsn_from_seq;
1600 struct gtphub_peer_port *ggsn;
1601 if (gtphub_unmap(hub, &p, sgsn,
1602 hub->ggsn_proxy[plane_idx],
1603 &ggsn, &ggsn_from_seq,
1604 NULL /* not interested, got it in &ggsn already */
1605 )
1606 != 0) {
1607 return -1;
1608 }
1609
1610 /* See what our GGSN guess would be from the packet data per se. */
1611 /* TODO maybe not do this always? */
1612 struct gtphub_peer_port *ggsn_from_packet;
Neels Hofmeyr5b664f42015-11-10 20:32:13 +01001613 if (gtphub_resolve_ggsn(hub, &p, &ggsn_from_packet) < 0)
1614 return -1;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001615
1616 if (ggsn_from_packet && ggsn
1617 && (ggsn_from_packet != ggsn)) {
1618 LOGERR("GGSN implied from packet does not match unmapped"
1619 " GGSN, using unmapped GGSN:"
1620 " from packet: %s unmapped: %s\n",
1621 gtphub_port_str(ggsn_from_packet),
1622 gtphub_port_str2(ggsn));
1623 /* TODO return -1; ? */
1624 }
1625
1626 if (!ggsn)
1627 ggsn = ggsn_from_packet;
1628
1629 if (!ggsn) {
1630 LOGERR("No GGSN to send to. Dropping packet.\n");
1631 return -1;
1632 }
1633
1634 if (plane_idx == GTPH_PLANE_CTRL) {
1635 /* This may be a Create PDP Context requst. If it is, there are other
1636 * addresses in the GTP message to set up apart from the sender. */
1637 if (gtphub_handle_pdp_ctx_ies(hub, hub->to_sgsns,
1638 hub->to_ggsns, &p, now)
1639 != 0)
1640 return -1;
1641 }
1642
1643 gtphub_check_restart_counter(hub, &p, sgsn);
1644 gtphub_map_restart_counter(hub, &p, sgsn, ggsn);
1645
1646 /* If the SGSN is replying to a GGSN request, the sequence nr has
1647 * already been unmapped above (unmap_ggsn != NULL), and we need not
1648 * create a new outgoing sequence map. */
1649 if (!ggsn_from_seq)
1650 gtphub_map_seq(&p, sgsn, ggsn, now);
1651
1652 osmo_sockaddr_copy(to_addr, &ggsn->sa);
1653
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001654 *reply_buf = (uint8_t*)p.data;
Neels Hofmeyre921e322015-11-11 00:45:50 +01001655
1656 LOG("--> Forward to GGSN: %d bytes to %s\n",
1657 (int)received, osmo_sockaddr_to_str(to_addr));
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001658 return received;
1659}
1660
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +01001661static void resolved_gssn_del_cb(struct expiring_item *expi)
1662{
1663 struct gtphub_resolved_ggsn *ggsn;
1664 ggsn = container_of(expi, struct gtphub_resolved_ggsn, expiry_entry);
1665
1666 gtphub_port_ref_count_dec(ggsn->peer);
1667 llist_del(&ggsn->entry);
1668
1669 ggsn->expiry_entry.del_cb = 0;
1670 expiring_item_del(&ggsn->expiry_entry);
1671
1672 talloc_free(ggsn);
1673}
1674
1675void gtphub_resolved_ggsn(struct gtphub *hub, const char *apn_oi_str,
1676 struct gsn_addr *resolved_addr,
1677 time_t now)
1678{
1679 struct gtphub_peer_port *pp;
1680 struct gtphub_resolved_ggsn *ggsn;
1681
Neels Hofmeyr3317c842015-11-11 17:20:42 +01001682 LOG("Resolved GGSN callback: %s %s\n",
1683 apn_oi_str, osmo_hexdump((unsigned char*)resolved_addr, sizeof(*resolved_addr)));
1684
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +01001685 pp = gtphub_port_have(hub, &hub->to_ggsns[GTPH_PLANE_CTRL],
1686 resolved_addr, 2123);
1687 if (!pp) {
1688 LOGERR("Internal: Cannot create/find peer '%s'\n",
1689 gsn_addr_to_str(resolved_addr));
1690 return;
1691 }
1692
1693 ggsn = talloc_zero(osmo_gtphub_ctx, struct gtphub_resolved_ggsn);
1694 OSMO_ASSERT(ggsn);
1695
1696 ggsn->peer = pp;
1697 gtphub_port_ref_count_inc(pp);
1698
1699 strncpy(ggsn->apn_oi_str, apn_oi_str, sizeof(ggsn->apn_oi_str));
1700
1701 ggsn->expiry_entry.del_cb = resolved_gssn_del_cb;
1702 expiry_add(&hub->expire_tei_maps, &ggsn->expiry_entry, now);
1703
1704 llist_add(&ggsn->entry, &hub->resolved_ggsns);
1705}
1706
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001707static int gtphub_gc_peer_port(struct gtphub_peer_port *pp)
1708{
1709 return pp->ref_count == 0;
1710}
1711
1712static int gtphub_gc_peer_addr(struct gtphub_peer_addr *pa)
1713{
1714 struct gtphub_peer_port *pp, *npp;
1715 llist_for_each_entry_safe(pp, npp, &pa->ports, entry) {
1716 if (gtphub_gc_peer_port(pp)) {
1717 LOG("expired: peer %s\n",
1718 gtphub_port_str(pp));
1719 gtphub_peer_port_del(pp);
1720 }
1721 }
1722 return llist_empty(&pa->ports);
1723}
1724
1725static int gtphub_gc_peer(struct gtphub_peer *p)
1726{
1727 struct gtphub_peer_addr *pa, *npa;
1728 llist_for_each_entry_safe(pa, npa, &p->addresses, entry) {
1729 if (gtphub_gc_peer_addr(pa)) {
1730 gtphub_peer_addr_del(pa);
1731 }
1732 }
1733
1734 /* Note that there's a ref_count in each gtphub_peer_port instance
1735 * listed within p->addresses, referenced by TEI mappings from
1736 * hub->tei_map. As long as those don't expire, this peer will stay. */
1737
1738 LOG("gc peer %p llist_empty %d seq_map_empty %d\n", p,
1739 (int)llist_empty(&p->addresses), (int) nr_map_empty(&p->seq_map));
1740 if (! nr_map_empty(&p->seq_map)) {
1741 printf("not empty\n");
1742 struct nr_mapping *nrm;
1743 llist_for_each_entry(nrm, &p->seq_map.mappings, entry) {
1744 printf("%p %s %d -> %d\n",
1745 nrm->origin, gtphub_port_str(nrm->origin),nrm->orig, nrm->repl);
1746 }
1747 }
1748 return llist_empty(&p->addresses)
1749 && nr_map_empty(&p->seq_map);
1750}
1751
1752static void gtphub_gc_bind(struct gtphub_bind *b)
1753{
1754 struct gtphub_peer *p, *n;
1755 llist_for_each_entry_safe(p, n, &b->peers, entry) {
1756 if (gtphub_gc_peer(p)) {
1757 gtphub_peer_del(p);
1758 }
1759 }
1760}
1761
1762void gtphub_gc(struct gtphub *hub, time_t now)
1763{
1764 int expired;
1765 expired = expiry_tick(&hub->expire_seq_maps, now);
1766 expired += expiry_tick(&hub->expire_tei_maps, now);
1767
1768 /* ... */
1769
1770 if (expired) {
1771 int i;
1772 for (i = 0; i < GTPH_PLANE_N; i++) {
1773 gtphub_gc_bind(&hub->to_sgsns[i]);
1774 gtphub_gc_bind(&hub->to_ggsns[i]);
1775 }
1776 }
1777}
1778
1779static void gtphub_gc_cb(void *data)
1780{
1781 struct gtphub *hub = data;
1782 gtphub_gc(hub, gtphub_now());
1783 osmo_timer_schedule(&hub->gc_timer, GTPH_GC_TICK_SECONDS, 0);
1784}
1785
1786static void gtphub_gc_start(struct gtphub *hub)
1787{
1788 hub->gc_timer.cb = gtphub_gc_cb;
1789 hub->gc_timer.data = hub;
1790
1791 osmo_timer_schedule(&hub->gc_timer, GTPH_GC_TICK_SECONDS, 0);
1792}
1793
1794/* called by unit tests */
1795void gtphub_init(struct gtphub *hub)
1796{
1797 gtphub_zero(hub);
1798
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +01001799 INIT_LLIST_HEAD(&hub->resolved_ggsns);
1800
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001801 expiry_init(&hub->expire_seq_maps, GTPH_SEQ_MAPPING_EXPIRY_SECS);
1802 expiry_init(&hub->expire_tei_maps, GTPH_TEI_MAPPING_EXPIRY_MINUTES * 60);
1803
1804 int plane_idx;
1805 for (plane_idx = 0; plane_idx < GTPH_PLANE_N; plane_idx++) {
1806 nr_pool_init(&hub->tei_pool[plane_idx]);
1807 nr_map_init(&hub->tei_map[plane_idx],
1808 &hub->tei_pool[plane_idx],
1809 &hub->expire_tei_maps);
1810
1811 gtphub_bind_init(&hub->to_ggsns[plane_idx]);
1812 gtphub_bind_init(&hub->to_sgsns[plane_idx]);
1813 }
1814}
1815
1816static int gtphub_make_proxy(struct gtphub *hub,
1817 struct gtphub_peer_port **pp,
1818 struct gtphub_bind *bind,
1819 const struct gtphub_cfg_addr *addr)
1820{
1821 if (!addr->addr_str)
1822 return 0;
1823
1824 struct gsn_addr gsna;
1825 if (gsn_addr_from_str(&gsna, addr->addr_str) != 0)
1826 return -1;
1827
1828 *pp = gtphub_port_have(hub, bind, &gsna, addr->port);
1829
1830 /* This is *the* proxy. Make sure it is never expired. */
1831 gtphub_port_ref_count_inc(*pp);
1832 return 0;
1833}
1834
1835int gtphub_start(struct gtphub *hub, struct gtphub_cfg *cfg)
1836{
1837 int rc;
1838
1839 gtphub_init(hub);
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +01001840 gtphub_ares_init(hub);
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001841
Neels Hofmeyrbb3d6782015-11-09 15:12:25 +01001842 /* TODO set hub->restart_counter from external file. */
1843
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02001844 int plane_idx;
1845 for (plane_idx = 0; plane_idx < GTPH_PLANE_N; plane_idx++) {
1846 rc = gtphub_bind_start(&hub->to_ggsns[plane_idx],
1847 &cfg->to_ggsns[plane_idx],
1848 from_ggsns_read_cb, hub, plane_idx);
1849 if (rc) {
1850 LOGERR("Failed to bind for GGSNs (%s)\n",
1851 gtphub_plane_idx_names[plane_idx]);
1852 return rc;
1853 }
1854
1855 rc = gtphub_bind_start(&hub->to_sgsns[plane_idx],
1856 &cfg->to_sgsns[plane_idx],
1857 from_sgsns_read_cb, hub, plane_idx);
1858 if (rc) {
1859 LOGERR("Failed to bind for SGSNs (%s)\n",
1860 gtphub_plane_idx_names[plane_idx]);
1861 return rc;
1862 }
1863 }
1864
1865
1866 for (plane_idx = 0; plane_idx < GTPH_PLANE_N; plane_idx++) {
1867 if (gtphub_make_proxy(hub,
1868 &hub->sgsn_proxy[plane_idx],
1869 &hub->to_sgsns[plane_idx],
1870 &cfg->sgsn_proxy[plane_idx])
1871 != 0) {
1872 LOGERR("Cannot configure SGSN proxy %s port %d.\n",
1873 cfg->sgsn_proxy[plane_idx].addr_str,
1874 (int)cfg->sgsn_proxy[plane_idx].port);
1875 return -1;
1876 }
1877 if (gtphub_make_proxy(hub,
1878 &hub->ggsn_proxy[plane_idx],
1879 &hub->to_ggsns[plane_idx],
1880 &cfg->ggsn_proxy[plane_idx])
1881 != 0) {
1882 LOGERR("Cannot configure GGSN proxy.\n");
1883 return -1;
1884 }
1885 }
1886
1887 for (plane_idx = 0; plane_idx < GTPH_PLANE_N; plane_idx++) {
1888 if (hub->sgsn_proxy[plane_idx])
1889 LOG("Using SGSN %s proxy %s\n",
1890 gtphub_plane_idx_names[plane_idx],
1891 gtphub_port_str(hub->sgsn_proxy[plane_idx]));
1892 }
1893
1894 for (plane_idx = 0; plane_idx < GTPH_PLANE_N; plane_idx++) {
1895 if (hub->sgsn_proxy[plane_idx])
1896 LOG("Using GGSN %s proxy %s\n",
1897 gtphub_plane_idx_names[plane_idx],
1898 gtphub_port_str(hub->ggsn_proxy[plane_idx]));
1899 }
1900
1901 gtphub_gc_start(hub);
1902 return 0;
1903}
1904
1905static struct gtphub_peer_addr *gtphub_peer_find_addr(const struct gtphub_peer *peer,
1906 const struct gsn_addr *addr)
1907{
1908 struct gtphub_peer_addr *a;
1909 llist_for_each_entry(a, &peer->addresses, entry) {
1910 if (gsn_addr_same(&a->addr, addr))
1911 return a;
1912 }
1913 return NULL;
1914}
1915
1916static struct gtphub_peer_port *gtphub_addr_find_port(const struct gtphub_peer_addr *a,
1917 uint16_t port)
1918{
1919 OSMO_ASSERT(port);
1920 struct gtphub_peer_port *pp;
1921 llist_for_each_entry(pp, &a->ports, entry) {
1922 if (pp->port == port)
1923 return pp;
1924 }
1925 return NULL;
1926}
1927
1928static struct gtphub_peer_addr *gtphub_addr_find(const struct gtphub_bind *bind,
1929 const struct gsn_addr *addr)
1930{
1931 struct gtphub_peer *peer;
1932 llist_for_each_entry(peer, &bind->peers, entry) {
1933 struct gtphub_peer_addr *a = gtphub_peer_find_addr(peer, addr);
1934 if (a)
1935 return a;
1936 }
1937 return NULL;
1938}
1939
1940static struct gtphub_peer_port *gtphub_port_find(const struct gtphub_bind *bind,
1941 const struct gsn_addr *addr,
1942 uint16_t port)
1943{
1944 struct gtphub_peer_addr *a = gtphub_addr_find(bind, addr);
1945 if (!a)
1946 return NULL;
1947 return gtphub_addr_find_port(a, port);
1948}
1949
1950struct gtphub_peer_port *gtphub_port_find_sa(const struct gtphub_bind *bind,
1951 const struct osmo_sockaddr *addr)
1952{
1953 struct gsn_addr gsna;
1954 uint16_t port;
1955 gsn_addr_from_sockaddr(&gsna, &port, addr);
1956 return gtphub_port_find(bind, &gsna, port);
1957}
1958
1959static struct gtphub_peer *gtphub_peer_new(struct gtphub *hub,
1960 struct gtphub_bind *bind)
1961{
1962 struct gtphub_peer *peer = talloc_zero(osmo_gtphub_ctx, struct gtphub_peer);
1963 OSMO_ASSERT(peer);
1964
1965 INIT_LLIST_HEAD(&peer->addresses);
1966
1967 nr_pool_init(&peer->seq_pool);
1968 nr_map_init(&peer->seq_map, &peer->seq_pool, &hub->expire_seq_maps);
1969
1970 /* TODO use something random to pick the initial sequence nr.
1971 0x6d31 produces the ASCII character sequence 'm1', currently used in
1972 gtphub_nc_test.sh. */
1973 peer->seq_pool.last_nr = 0x6d31 - 1;
1974
1975 llist_add(&peer->entry, &bind->peers);
1976 return peer;
1977}
1978
1979static struct gtphub_peer_addr *gtphub_peer_add_addr(struct gtphub_peer *peer,
1980 const struct gsn_addr *addr)
1981{
1982 struct gtphub_peer_addr *a;
1983 a = talloc_zero(osmo_gtphub_ctx, struct gtphub_peer_addr);
1984 OSMO_ASSERT(a);
1985 a->peer = peer;
1986 gsn_addr_copy(&a->addr, addr);
1987 INIT_LLIST_HEAD(&a->ports);
1988 llist_add(&a->entry, &peer->addresses);
1989
1990 return a;
1991}
1992
1993static struct gtphub_peer_addr *gtphub_addr_have(struct gtphub *hub,
1994 struct gtphub_bind *bind,
1995 const struct gsn_addr *addr)
1996{
1997 struct gtphub_peer_addr *a = gtphub_addr_find(bind, addr);
1998 if (a)
1999 return a;
2000
2001 /* If we haven't found an address, that means we need to create an
2002 * entirely new peer for the new address. More addresses may be added
2003 * to this peer later, but not via this function. */
2004 struct gtphub_peer *peer = gtphub_peer_new(hub, bind);
Neels Hofmeyre921e322015-11-11 00:45:50 +01002005
2006 a = gtphub_peer_add_addr(peer, addr);
2007
2008 LOG("New peer address: %s\n",
2009 gsn_addr_to_str(&a->addr));
2010
2011 return a;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02002012}
2013
2014static struct gtphub_peer_port *gtphub_addr_add_port(struct gtphub_peer_addr *a,
2015 uint16_t port)
2016{
2017 struct gtphub_peer_port *pp;
2018
2019 pp = talloc_zero(osmo_gtphub_ctx, struct gtphub_peer_port);
2020 OSMO_ASSERT(pp);
2021 pp->peer_addr = a;
2022 pp->port = port;
2023
2024 if (gsn_addr_to_sockaddr(&a->addr, port, &pp->sa) != 0) {
2025 talloc_free(pp);
2026 return NULL;
2027 }
2028
2029 llist_add(&pp->entry, &a->ports);
2030
Neels Hofmeyre921e322015-11-11 00:45:50 +01002031 LOG("New peer port: %s port %d\n",
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02002032 gsn_addr_to_str(&a->addr),
2033 (int)port);
2034
2035 return pp;
2036}
2037
Neels Hofmeyr30f7bcb2015-11-08 20:34:47 +01002038struct gtphub_peer_port *gtphub_port_have(struct gtphub *hub,
2039 struct gtphub_bind *bind,
2040 const struct gsn_addr *addr,
2041 uint16_t port)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02002042{
2043 struct gtphub_peer_addr *a = gtphub_addr_have(hub, bind, addr);
2044
2045 struct gtphub_peer_port *pp = gtphub_addr_find_port(a, port);
2046 if (pp)
2047 return pp;
2048
2049 return gtphub_addr_add_port(a, port);
2050}
2051
Neels Hofmeyrc83cd892015-11-11 14:01:06 +01002052/* Find a GGSN peer with a matching address. If the address is known but the
2053 * port not, create a new port for that peer address. */
2054struct gtphub_peer_port *gtphub_known_addr_have_port(const struct gtphub_bind *bind,
2055 const struct osmo_sockaddr *addr)
2056{
2057 struct gtphub_peer_addr *pa;
2058 struct gtphub_peer_port *pp;
2059
2060 struct gsn_addr gsna;
2061 uint16_t port;
2062 gsn_addr_from_sockaddr(&gsna, &port, addr);
2063
2064 pa = gtphub_addr_find(bind, &gsna);
2065 if (!pa)
2066 return NULL;
2067
2068 pp = gtphub_addr_find_port(pa, port);
2069
2070 if (!pp)
2071 pp = gtphub_addr_add_port(pa, port);
2072
2073 return pp;
2074}
2075
2076
Neels Hofmeyr5b664f42015-11-10 20:32:13 +01002077/* Return 0 if the message in p is not applicable for GGSN resolution, -1 if
2078 * resolution should be possible but failed, and 1 if resolution was
2079 * successful. *pp will be set to NULL if <1 is returned. */
2080static int gtphub_resolve_ggsn(struct gtphub *hub,
2081 struct gtp_packet_desc *p,
2082 struct gtphub_peer_port **pp)
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02002083{
Neels Hofmeyr5b664f42015-11-10 20:32:13 +01002084 *pp = NULL;
2085
2086 /* TODO determine from message type whether IEs should be present? */
2087
2088 int rc;
2089 const char *imsi_str;
2090 rc = get_ie_imsi_str(p->ie, 0, &imsi_str);
2091 if (rc < 1)
2092 return rc;
2093 OSMO_ASSERT(imsi_str);
2094
2095 const char *apn_str;
2096 rc = get_ie_apn_str(p->ie, &apn_str);
2097 if (rc < 1)
2098 return rc;
2099 OSMO_ASSERT(apn_str);
2100
2101 *pp = gtphub_resolve_ggsn_addr(hub, imsi_str, apn_str);
2102 return (*pp)? 1 : -1;
Neels Hofmeyrc8a614d2015-09-24 17:32:30 +02002103}
2104
2105
2106/* TODO move to osmocom/core/socket.c ? */
2107/* The caller is required to call freeaddrinfo(*result), iff zero is returned. */
2108/* use this in osmo_sock_init() to remove dup. */
2109static int _osmo_getaddrinfo(struct addrinfo **result,
2110 uint16_t family, uint16_t type, uint8_t proto,
2111 const char *host, uint16_t port)
2112{
2113 struct addrinfo hints;
2114 char portbuf[16];
2115
2116 sprintf(portbuf, "%u", port);
2117 memset(&hints, '\0', sizeof(struct addrinfo));
2118 hints.ai_family = family;
2119 if (type == SOCK_RAW) {
2120 /* Workaround for glibc, that returns EAI_SERVICE (-8) if
2121 * SOCK_RAW and IPPROTO_GRE is used.
2122 */
2123 hints.ai_socktype = SOCK_DGRAM;
2124 hints.ai_protocol = IPPROTO_UDP;
2125 } else {
2126 hints.ai_socktype = type;
2127 hints.ai_protocol = proto;
2128 }
2129
2130 return getaddrinfo(host, portbuf, &hints, result);
2131}
2132
2133/* TODO move to osmocom/core/socket.c ? */
2134int osmo_sockaddr_init(struct osmo_sockaddr *addr,
2135 uint16_t family, uint16_t type, uint8_t proto,
2136 const char *host, uint16_t port)
2137{
2138 struct addrinfo *res;
2139 int rc;
2140 rc = _osmo_getaddrinfo(&res, family, type, proto, host, port);
2141
2142 if (rc != 0) {
2143 LOGERR("getaddrinfo returned error %d\n", (int)rc);
2144 return -EINVAL;
2145 }
2146
2147 OSMO_ASSERT(res->ai_addrlen <= sizeof(addr->a));
2148 memcpy(&addr->a, res->ai_addr, res->ai_addrlen);
2149 addr->l = res->ai_addrlen;
2150 freeaddrinfo(res);
2151
2152 return 0;
2153}
2154
2155int osmo_sockaddr_to_strs(char *addr_str, size_t addr_str_len,
2156 char *port_str, size_t port_str_len,
2157 const struct osmo_sockaddr *addr,
2158 int flags)
2159{
2160 int rc;
2161
2162 if ((addr->l < 1) || (addr->l > sizeof(addr->a))) {
2163 LOGP(DGTPHUB, LOGL_ERROR, "Invalid address size: %d\n", addr->l);
2164 return -1;
2165 }
2166
2167 if (addr->l > sizeof(addr->a)) {
2168 LOGP(DGTPHUB, LOGL_ERROR, "Invalid address: too long: %d\n", addr->l);
2169 return -1;
2170 }
2171
2172 rc = getnameinfo((struct sockaddr*)&addr->a, addr->l,
2173 addr_str, addr_str_len,
2174 port_str, port_str_len,
2175 flags);
2176
2177 if (rc)
2178 LOGP(DGTPHUB, LOGL_ERROR, "Invalid address: %s: %s\n", gai_strerror(rc),
2179 osmo_hexdump((uint8_t*)&addr->a, addr->l));
2180
2181 return rc;
2182}
2183
2184const char *osmo_sockaddr_to_strb(const struct osmo_sockaddr *addr,
2185 char *buf, size_t buf_len)
2186{
2187 const int portbuf_len = 6;
2188 OSMO_ASSERT(buf_len > portbuf_len);
2189 char *portbuf = buf + buf_len - portbuf_len;
2190 buf_len -= portbuf_len;
2191 if (osmo_sockaddr_to_strs(buf, buf_len,
2192 portbuf, portbuf_len,
2193 addr,
2194 NI_NUMERICHOST | NI_NUMERICSERV))
2195 return NULL;
2196
2197 char *pos = buf + strnlen(buf, buf_len-1);
2198 size_t len = buf_len - (pos - buf);
2199
2200 snprintf(pos, len, " port %s", portbuf);
2201 buf[buf_len-1] = '\0';
2202
2203 return buf;
2204}
2205
2206const char *osmo_sockaddr_to_str(const struct osmo_sockaddr *addr)
2207{
2208 static char buf[256];
2209 const char *result = osmo_sockaddr_to_strb(addr, buf, sizeof(buf));
2210 if (! result)
2211 return "(invalid)";
2212 return result;
2213}
2214
2215int osmo_sockaddr_cmp(const struct osmo_sockaddr *a, const struct osmo_sockaddr *b)
2216{
2217 if (a == b)
2218 return 0;
2219 if (!a)
2220 return -1;
2221 if (!b)
2222 return 1;
2223 if (a->l != b->l) {
2224 /* Lengths are not the same, but determine the order. Will
2225 * anyone ever sort a list by osmo_sockaddr though...? */
2226 int cmp = memcmp(&a->a, &b->a, (a->l < b->l)? a->l : b->l);
2227 if (cmp == 0) {
2228 if (a->l < b->l)
2229 return -1;
2230 else
2231 return 1;
2232 }
2233 return cmp;
2234 }
2235 return memcmp(&a->a, &b->a, a->l);
2236}
2237
2238void osmo_sockaddr_copy(struct osmo_sockaddr *dst, const struct osmo_sockaddr *src)
2239{
2240 OSMO_ASSERT(src->l <= sizeof(dst->a));
2241 memcpy(&dst->a, &src->a, src->l);
2242 dst->l = src->l;
2243}