blob: fdefa653cd66844207b02df230159e629063c7bb [file] [log] [blame]
Harald Welte24a655f2010-04-30 19:54:29 +02001/* GPRS Networks Service (NS) messages on the Gb interfacebvci = msgb_bvci(msg);
Harald Welte9ba50052010-03-14 15:45:01 +08002 * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05) */
3
Harald Weltef030b212010-04-26 19:18:54 +02004/* (C) 2009-2010 by Harald Welte <laforge@gnumonks.org>
Harald Welte9ba50052010-03-14 15:45:01 +08005 *
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 General Public License as published by
10 * the Free Software Foundation; either version 2 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 General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 *
22 */
23
24/* Some introduction into NS: NS is used typically on top of frame relay,
25 * but in the ip.access world it is encapsulated in UDP packets. It serves
26 * as an intermediate shim betwen BSSGP and the underlying medium. It doesn't
27 * do much, apart from providing congestion notification and status indication.
28 *
29 * Terms:
30 * NS Network Service
31 * NSVC NS Virtual Connection
32 * NSEI NS Entity Identifier
33 * NSVL NS Virtual Link
34 * NSVLI NS Virtual Link Identifier
35 * BVC BSSGP Virtual Connection
36 * BVCI BSSGP Virtual Connection Identifier
37 * NSVCG NS Virtual Connection Goup
38 * Blocked NS-VC cannot be used for user traffic
39 * Alive Ability of a NS-VC to provide communication
40 *
41 * There can be multiple BSSGP virtual connections over one (group of) NSVC's. BSSGP will
42 * therefore identify the BSSGP virtual connection by a BVCI passed down to NS.
43 * NS then has to firgure out which NSVC's are responsible for this BVCI.
44 * Those mappings are administratively configured.
45 */
46
47#include <stdlib.h>
48#include <unistd.h>
49#include <errno.h>
Harald Welte8f9a3ee2010-05-02 11:26:34 +020050#include <stdint.h>
Harald Welte9ba50052010-03-14 15:45:01 +080051
52#include <arpa/inet.h>
53
54#include <openbsc/gsm_data.h>
55#include <osmocore/msgb.h>
56#include <osmocore/tlv.h>
57#include <osmocore/talloc.h>
Harald Weltef030b212010-04-26 19:18:54 +020058#include <osmocore/select.h>
Harald Welte9ba50052010-03-14 15:45:01 +080059#include <openbsc/debug.h>
Harald Welte834f26d2010-05-11 06:20:54 +020060#include <openbsc/signal.h>
Harald Welte9ba50052010-03-14 15:45:01 +080061#include <openbsc/gprs_ns.h>
62#include <openbsc/gprs_bssgp.h>
63
64#define NS_ALLOC_SIZE 1024
65
66static const struct tlv_definition ns_att_tlvdef = {
67 .def = {
68 [NS_IE_CAUSE] = { TLV_TYPE_TvLV, 0 },
69 [NS_IE_VCI] = { TLV_TYPE_TvLV, 0 },
70 [NS_IE_PDU] = { TLV_TYPE_TvLV, 0 },
71 [NS_IE_BVCI] = { TLV_TYPE_TvLV, 0 },
72 [NS_IE_NSEI] = { TLV_TYPE_TvLV, 0 },
73 },
74};
75
Harald Weltef030b212010-04-26 19:18:54 +020076/* Lookup struct gprs_nsvc based on NSVCI */
77static struct gprs_nsvc *nsvc_by_nsvci(struct gprs_ns_inst *nsi,
Harald Welte8f9a3ee2010-05-02 11:26:34 +020078 uint16_t nsvci)
Harald Weltef030b212010-04-26 19:18:54 +020079{
80 struct gprs_nsvc *nsvc;
81 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
82 if (nsvc->nsvci == nsvci)
83 return nsvc;
84 }
85 return NULL;
86}
87
Harald Welte24a655f2010-04-30 19:54:29 +020088/* Lookup struct gprs_nsvc based on NSVCI */
89static struct gprs_nsvc *nsvc_by_nsei(struct gprs_ns_inst *nsi,
Harald Welte8f9a3ee2010-05-02 11:26:34 +020090 uint16_t nsei)
Harald Welte24a655f2010-04-30 19:54:29 +020091{
92 struct gprs_nsvc *nsvc;
93 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
94 if (nsvc->nsei == nsei)
95 return nsvc;
96 }
97 return NULL;
98}
99
100
Harald Weltef030b212010-04-26 19:18:54 +0200101/* Lookup struct gprs_nsvc based on remote peer socket addr */
102static struct gprs_nsvc *nsvc_by_rem_addr(struct gprs_ns_inst *nsi,
103 struct sockaddr_in *sin)
104{
105 struct gprs_nsvc *nsvc;
106 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
107 if (!memcmp(&nsvc->ip.bts_addr, sin, sizeof(*sin)))
108 return nsvc;
109 }
110 return NULL;
111}
112
Harald Welte69a4cf22010-05-03 20:55:10 +0200113static void gprs_ns_timer_cb(void *data);
114
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200115static struct gprs_nsvc *nsvc_create(struct gprs_ns_inst *nsi, uint16_t nsvci)
Harald Weltef030b212010-04-26 19:18:54 +0200116{
117 struct gprs_nsvc *nsvc;
118
119 nsvc = talloc_zero(nsi, struct gprs_nsvc);
120 nsvc->nsvci = nsvci;
121 /* before RESET procedure: BLOCKED and DEAD */
122 nsvc->state = NSE_S_BLOCKED;
123 nsvc->nsi = nsi;
Harald Welte69a4cf22010-05-03 20:55:10 +0200124 nsvc->timer.cb = gprs_ns_timer_cb;
125 nsvc->timer.data = nsvc;
126
Harald Weltef030b212010-04-26 19:18:54 +0200127 llist_add(&nsvc->list, &nsi->gprs_nsvcs);
128
129 return nsvc;
130}
Harald Welte9ba50052010-03-14 15:45:01 +0800131
Harald Welte2fc725d2010-05-11 10:15:26 +0200132static void ns_dispatch_signal(struct gprs_nsvc *nsvc, unsigned int signal,
Harald Welte834f26d2010-05-11 06:20:54 +0200133 uint8_t cause)
134{
135 struct ns_signal_data nssd;
136
137 nssd.nsvc = nsvc;
138 nssd.cause = cause;
139
140 dispatch_signal(SS_NS, signal, &nssd);
141}
142
Harald Welte9ba50052010-03-14 15:45:01 +0800143/* Section 10.3.2, Table 13 */
Harald Welte2577d412010-05-02 09:37:45 +0200144static const struct value_string ns_cause_str[] = {
145 { NS_CAUSE_TRANSIT_FAIL, "Transit network failure" },
146 { NS_CAUSE_OM_INTERVENTION, "O&M intervention" },
147 { NS_CAUSE_EQUIP_FAIL, "Equipment failure" },
148 { NS_CAUSE_NSVC_BLOCKED, "NS-VC blocked" },
149 { NS_CAUSE_NSVC_UNKNOWN, "NS-VC unknown" },
150 { NS_CAUSE_BVCI_UNKNOWN, "BVCI unknown" },
151 { NS_CAUSE_SEM_INCORR_PDU, "Semantically incorrect PDU" },
152 { NS_CAUSE_PDU_INCOMP_PSTATE, "PDU not compatible with protocol state" },
Harald Welte69a4cf22010-05-03 20:55:10 +0200153 { NS_CAUSE_PROTO_ERR_UNSPEC, "Protocol error, unspecified" },
Harald Welte2577d412010-05-02 09:37:45 +0200154 { NS_CAUSE_INVAL_ESSENT_IE, "Invalid essential IE" },
155 { NS_CAUSE_MISSING_ESSENT_IE, "Missing essential IE" },
156 { 0, NULL }
Harald Welte9ba50052010-03-14 15:45:01 +0800157};
158
Harald Welte2577d412010-05-02 09:37:45 +0200159const char *gprs_ns_cause_str(enum ns_cause cause)
Harald Welte9ba50052010-03-14 15:45:01 +0800160{
Harald Welte2577d412010-05-02 09:37:45 +0200161 return get_value_string(ns_cause_str, cause);
Harald Welte9ba50052010-03-14 15:45:01 +0800162}
163
Harald Welte24a655f2010-04-30 19:54:29 +0200164static int nsip_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg);
Harald Weltef030b212010-04-26 19:18:54 +0200165
Harald Welte24a655f2010-04-30 19:54:29 +0200166static int gprs_ns_tx(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800167{
Harald Weltef030b212010-04-26 19:18:54 +0200168 int ret;
169
170 switch (nsvc->nsi->ll) {
171 case GPRS_NS_LL_UDP:
Harald Welte24a655f2010-04-30 19:54:29 +0200172 ret = nsip_sendmsg(nsvc, msg);
Harald Weltef030b212010-04-26 19:18:54 +0200173 break;
174 default:
Harald Welteb8a6a832010-05-11 05:54:22 +0200175 LOGP(DNS, LOGL_ERROR, "unsupported NS linklayer %u\n", nsvc->nsi->ll);
Harald Weltef030b212010-04-26 19:18:54 +0200176 msgb_free(msg);
177 ret = -EIO;
178 break;
179 }
180 return ret;
Harald Welte9ba50052010-03-14 15:45:01 +0800181}
182
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200183static int gprs_ns_tx_simple(struct gprs_nsvc *nsvc, uint8_t pdu_type)
Harald Welte9ba50052010-03-14 15:45:01 +0800184{
185 struct msgb *msg = msgb_alloc(NS_ALLOC_SIZE, "GPRS/NS");
186 struct gprs_ns_hdr *nsh;
187
188 if (!msg)
189 return -ENOMEM;
190
191 nsh = (struct gprs_ns_hdr *) msgb_put(msg, sizeof(*nsh));
192
193 nsh->pdu_type = pdu_type;
194
Harald Welte24a655f2010-04-30 19:54:29 +0200195 return gprs_ns_tx(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800196}
197
Harald Welte834f26d2010-05-11 06:20:54 +0200198int gprs_ns_tx_reset(struct gprs_nsvc *nsvc, uint8_t cause)
Harald Welte69a4cf22010-05-03 20:55:10 +0200199{
200 struct msgb *msg = msgb_alloc(NS_ALLOC_SIZE, "GPRS/NS");
201 struct gprs_ns_hdr *nsh;
Harald Welte69a4cf22010-05-03 20:55:10 +0200202 uint16_t nsvci = htons(nsvc->nsvci);
203 uint16_t nsei = htons(nsvc->nsei);
204
205 if (!msg)
206 return -ENOMEM;
207
208 nsh = (struct gprs_ns_hdr *) msgb_put(msg, sizeof(*nsh));
209 nsh->pdu_type = NS_PDUT_RESET;
210
211 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, &cause);
212 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *) &nsvci);
213 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *) &nsei);
214
215 return gprs_ns_tx(nsvc, msg);
216
217}
218
Harald Welte834f26d2010-05-11 06:20:54 +0200219int gprs_ns_tx_block(struct gprs_nsvc *nsvc, uint8_t cause)
220{
221 struct msgb *msg = msgb_alloc(NS_ALLOC_SIZE, "GPRS/NS");
222 struct gprs_ns_hdr *nsh;
223 uint16_t nsvci = htons(nsvc->nsvci);
224
225 if (!msg)
226 return -ENOMEM;
227
228 /* be conservative and mark it as blocked even now! */
229 nsvc->state |= NSE_S_BLOCKED;
230
231 nsh = (struct gprs_ns_hdr *) msgb_put(msg, sizeof(*nsh));
232 nsh->pdu_type = NS_PDUT_BLOCK;
233
234 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, &cause);
235 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *) &nsvci);
236
237 return gprs_ns_tx(nsvc, msg);
238}
239
240int gprs_ns_tx_unblock(struct gprs_nsvc *nsvc)
241{
242 return gprs_ns_tx_simple(nsvc, NS_PDUT_UNBLOCK);
243}
244
Harald Welte9ba50052010-03-14 15:45:01 +0800245#define NS_ALIVE_RETRIES 10 /* after 3 failed retransmit we declare BTS as dead */
246
Harald Welte69a4cf22010-05-03 20:55:10 +0200247static const uint8_t timer_mode_tout[_NSVC_TIMER_NR] = {
248 [NSVC_TIMER_TNS_RESET] = 60,
249 [NSVC_TIMER_TNS_ALIVE] = 3,
250 [NSVC_TIMER_TNS_TEST] = 30,
251};
252
253static void nsvc_start_timer(struct gprs_nsvc *nsvc, enum nsvc_timer_mode mode)
254{
255 nsvc->alive_retries = 0;
256
257 if (bsc_timer_pending(&nsvc->timer))
258 bsc_del_timer(&nsvc->timer);
259
260 nsvc->timer_mode = mode;
261 bsc_schedule_timer(&nsvc->timer, timer_mode_tout[mode], 0);
262}
263
Harald Welte80405452010-05-03 20:16:13 +0200264static void gprs_ns_timer_cb(void *data)
Harald Welte9ba50052010-03-14 15:45:01 +0800265{
266 struct gprs_nsvc *nsvc = data;
267
Harald Welte80405452010-05-03 20:16:13 +0200268 switch (nsvc->timer_mode) {
269 case NSVC_TIMER_TNS_ALIVE:
Harald Welte9ba50052010-03-14 15:45:01 +0800270 /* Tns-alive case: we expired without response ! */
271 nsvc->alive_retries++;
272 if (nsvc->alive_retries > NS_ALIVE_RETRIES) {
273 /* mark as dead and blocked */
274 nsvc->state = NSE_S_BLOCKED;
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200275 LOGP(DNS, LOGL_NOTICE,
276 "NSEI=%u Tns-alive expired more then "
Harald Welte69a4cf22010-05-03 20:55:10 +0200277 "%u times, blocking NS-VC\n", nsvc->nsei,
278 NS_ALIVE_RETRIES);
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200279 ns_dispatch_signal(nsvc, S_NS_BLOCK, NS_CAUSE_NSVC_BLOCKED);
Harald Welte9ba50052010-03-14 15:45:01 +0800280 return;
281 }
Harald Welte69a4cf22010-05-03 20:55:10 +0200282 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_ALIVE);
Harald Welte80405452010-05-03 20:16:13 +0200283 break;
284 case NSVC_TIMER_TNS_TEST:
Harald Welte9ba50052010-03-14 15:45:01 +0800285 /* Tns-test case: send NS-ALIVE PDU */
Harald Weltec5478482010-03-18 00:01:43 +0800286 gprs_ns_tx_simple(nsvc, NS_PDUT_ALIVE);
Harald Welte9ba50052010-03-14 15:45:01 +0800287 /* start Tns-alive timer */
Harald Welte69a4cf22010-05-03 20:55:10 +0200288 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_ALIVE);
289 break;
290 case NSVC_TIMER_TNS_RESET:
291 /* Chapter 7.3: Re-send the RESET */
Harald Welte570fb832010-05-03 21:05:24 +0200292 gprs_ns_tx_reset(nsvc, NS_CAUSE_OM_INTERVENTION);
Harald Welte69a4cf22010-05-03 20:55:10 +0200293 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_RESET);
Harald Welte80405452010-05-03 20:16:13 +0200294 break;
Harald Welte2fc725d2010-05-11 10:15:26 +0200295 case _NSVC_TIMER_NR:
296 break;
Harald Welte9ba50052010-03-14 15:45:01 +0800297 }
Harald Welte9ba50052010-03-14 15:45:01 +0800298}
299
300/* Section 9.2.6 */
Harald Weltec5478482010-03-18 00:01:43 +0800301static int gprs_ns_tx_reset_ack(struct gprs_nsvc *nsvc)
Harald Welte9ba50052010-03-14 15:45:01 +0800302{
303 struct msgb *msg = msgb_alloc(NS_ALLOC_SIZE, "GPRS/NS");
304 struct gprs_ns_hdr *nsh;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200305 uint16_t nsvci, nsei;
Harald Welte9ba50052010-03-14 15:45:01 +0800306
307 if (!msg)
308 return -ENOMEM;
309
Harald Weltec5478482010-03-18 00:01:43 +0800310 nsvci = htons(nsvc->nsvci);
311 nsei = htons(nsvc->nsei);
Harald Welte9ba50052010-03-14 15:45:01 +0800312
313 nsh = (struct gprs_ns_hdr *) msgb_put(msg, sizeof(*nsh));
314
315 nsh->pdu_type = NS_PDUT_RESET_ACK;
316
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200317 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS RESET ACK (NSVCI=%u)\n",
Harald Weltebbc9fac2010-05-03 18:54:12 +0200318 nsvc->nsei, nsvc->nsvci);
Harald Weltec5478482010-03-18 00:01:43 +0800319
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200320 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *)&nsvci);
321 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *)&nsei);
Harald Welte9ba50052010-03-14 15:45:01 +0800322
Harald Welte24a655f2010-04-30 19:54:29 +0200323 return gprs_ns_tx(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800324}
325
Harald Welte24a655f2010-04-30 19:54:29 +0200326/* Section 9.2.10: transmit side / NS-UNITDATA-REQUEST primitive */
327int gprs_ns_sendmsg(struct gprs_ns_inst *nsi, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800328{
Harald Welte24a655f2010-04-30 19:54:29 +0200329 struct gprs_nsvc *nsvc;
Harald Welte9ba50052010-03-14 15:45:01 +0800330 struct gprs_ns_hdr *nsh;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200331 uint16_t bvci = msgb_bvci(msg);
Harald Welte24a655f2010-04-30 19:54:29 +0200332
333 nsvc = nsvc_by_nsei(nsi, msgb_nsei(msg));
334 if (!nsvc) {
Harald Welteb8a6a832010-05-11 05:54:22 +0200335 LOGP(DNS, LOGL_ERROR, "Unable to resolve NSEI %u "
Harald Weltebbc9fac2010-05-03 18:54:12 +0200336 "to NS-VC!\n", msgb_nsei(msg));
Harald Welte24a655f2010-04-30 19:54:29 +0200337 return -EINVAL;
338 }
Harald Welte9ba50052010-03-14 15:45:01 +0800339
Harald Welte69a4cf22010-05-03 20:55:10 +0200340 if (!(nsvc->state & NSE_S_ALIVE)) {
Harald Welteb8a6a832010-05-11 05:54:22 +0200341 LOGP(DNS, LOGL_ERROR, "NSEI=%u is not alive, cannot send\n",
Harald Welte69a4cf22010-05-03 20:55:10 +0200342 nsvc->nsei);
343 return -EBUSY;
344 }
345 if (nsvc->state & NSE_S_BLOCKED) {
Harald Welteb8a6a832010-05-11 05:54:22 +0200346 LOGP(DNS, LOGL_ERROR, "NSEI=%u is blocked, cannot send\n",
Harald Welte69a4cf22010-05-03 20:55:10 +0200347 nsvc->nsei);
348 return -EBUSY;
349 }
350
Harald Welte9ba50052010-03-14 15:45:01 +0800351 nsh = (struct gprs_ns_hdr *) msgb_push(msg, sizeof(*nsh) + 3);
352 if (!nsh) {
Harald Welteb8a6a832010-05-11 05:54:22 +0200353 LOGP(DNS, LOGL_ERROR, "Not enough headroom for NS header\n");
Harald Welte9ba50052010-03-14 15:45:01 +0800354 return -EIO;
355 }
356
357 nsh->pdu_type = NS_PDUT_UNITDATA;
358 /* spare octet in data[0] */
359 nsh->data[1] = bvci >> 8;
360 nsh->data[2] = bvci & 0xff;
361
Harald Welte24a655f2010-04-30 19:54:29 +0200362 return gprs_ns_tx(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800363}
364
365/* Section 9.2.10: receive side */
Harald Welte24a655f2010-04-30 19:54:29 +0200366static int gprs_ns_rx_unitdata(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800367{
368 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *)msg->l2h;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200369 uint16_t bvci;
Harald Welte9ba50052010-03-14 15:45:01 +0800370
371 /* spare octet in data[0] */
372 bvci = nsh->data[1] << 8 | nsh->data[2];
Harald Welteec19c102010-05-02 09:50:42 +0200373 msgb_bssgph(msg) = &nsh->data[3];
Harald Welte30bc19a2010-05-02 11:19:37 +0200374 msgb_bvci(msg) = bvci;
Harald Welte9ba50052010-03-14 15:45:01 +0800375
376 /* call upper layer (BSSGP) */
Harald Weltef030b212010-04-26 19:18:54 +0200377 return nsvc->nsi->cb(GPRS_NS_EVT_UNIT_DATA, nsvc, msg, bvci);
Harald Welte9ba50052010-03-14 15:45:01 +0800378}
379
380/* Section 9.2.7 */
Harald Welte24a655f2010-04-30 19:54:29 +0200381static int gprs_ns_rx_status(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800382{
Harald Weltef030b212010-04-26 19:18:54 +0200383 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +0800384 struct tlv_parsed tp;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200385 uint8_t cause;
Harald Welte9ba50052010-03-14 15:45:01 +0800386 int rc;
387
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200388 LOGP(DNS, LOGL_INFO, "NSEI=%u NS STATUS ", nsvc->nsei);
Harald Welte9ba50052010-03-14 15:45:01 +0800389
390 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data, msgb_l2len(msg), 0, 0);
391
392 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE)) {
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200393 LOGPC(DNS, LOGL_INFO, "missing cause IE\n");
Harald Welte9ba50052010-03-14 15:45:01 +0800394 return -EINVAL;
395 }
396
397 cause = *TLVP_VAL(&tp, NS_IE_CAUSE);
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200398 LOGPC(DNS, LOGL_INFO, "cause=%s\n", gprs_ns_cause_str(cause));
Harald Welte9ba50052010-03-14 15:45:01 +0800399
400 return 0;
401}
402
403/* Section 7.3 */
Harald Welte24a655f2010-04-30 19:54:29 +0200404static int gprs_ns_rx_reset(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800405{
406 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +0800407 struct tlv_parsed tp;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200408 uint8_t *cause;
409 uint16_t *nsvci, *nsei;
Harald Welte9ba50052010-03-14 15:45:01 +0800410 int rc;
411
Harald Welte9ba50052010-03-14 15:45:01 +0800412 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data, msgb_l2len(msg), 0, 0);
413
414 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE) ||
415 !TLVP_PRESENT(&tp, NS_IE_VCI) ||
416 !TLVP_PRESENT(&tp, NS_IE_NSEI)) {
417 /* FIXME: respond with NS_CAUSE_MISSING_ESSENT_IE */
Harald Welteb8a6a832010-05-11 05:54:22 +0200418 LOGP(DNS, LOGL_ERROR, "NS RESET Missing mandatory IE\n");
Harald Welte9ba50052010-03-14 15:45:01 +0800419 return -EINVAL;
420 }
421
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200422 cause = (uint8_t *) TLVP_VAL(&tp, NS_IE_CAUSE);
423 nsvci = (uint16_t *) TLVP_VAL(&tp, NS_IE_VCI);
424 nsei = (uint16_t *) TLVP_VAL(&tp, NS_IE_NSEI);
Harald Welte9ba50052010-03-14 15:45:01 +0800425
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200426 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS RESET (NSVCI=%u, cause=%s)\n",
Harald Weltebbc9fac2010-05-03 18:54:12 +0200427 nsvc->nsvci, nsvc->nsei, gprs_ns_cause_str(*cause));
428
Harald Weltec5478482010-03-18 00:01:43 +0800429 nsvc->state = NSE_S_BLOCKED | NSE_S_ALIVE;
Harald Weltee8b9ca22010-05-11 18:18:31 +0200430 /* FIXME: Check if we have an existing peer with this NSEI/NSVCI
431 * and remove it, as our BSS may just have changed its source IP
432 * address */
433
Harald Weltec5478482010-03-18 00:01:43 +0800434 nsvc->nsei = ntohs(*nsei);
435 nsvc->nsvci = ntohs(*nsvci);
Harald Welte9ba50052010-03-14 15:45:01 +0800436
Harald Welte9ba50052010-03-14 15:45:01 +0800437 /* mark the NS-VC as blocked and alive */
Harald Welte9ba50052010-03-14 15:45:01 +0800438 /* start the test procedure */
Harald Welte69a4cf22010-05-03 20:55:10 +0200439 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_ALIVE);
Harald Welte9ba50052010-03-14 15:45:01 +0800440
Harald Welte834f26d2010-05-11 06:20:54 +0200441 /* inform interested parties about the fact that this NSVC
442 * has received RESET */
Harald Welte2fc725d2010-05-11 10:15:26 +0200443 ns_dispatch_signal(nsvc, S_NS_RESET, *cause);
Harald Welte834f26d2010-05-11 06:20:54 +0200444
Harald Weltec5478482010-03-18 00:01:43 +0800445 return gprs_ns_tx_reset_ack(nsvc);
Harald Welte9ba50052010-03-14 15:45:01 +0800446}
447
Harald Welte834f26d2010-05-11 06:20:54 +0200448static int gprs_ns_rx_block(struct gprs_nsvc *nsvc, struct msgb *msg)
449{
450 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
451 struct tlv_parsed tp;
452 uint8_t *cause;
453 int rc;
454
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200455 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS BLOCK\n", nsvc->nsei);
Harald Welte834f26d2010-05-11 06:20:54 +0200456
457 nsvc->state |= NSE_S_BLOCKED;
458
459 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data, msgb_l2len(msg), 0, 0);
460
461 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE) ||
462 !TLVP_PRESENT(&tp, NS_IE_VCI)) {
463 /* FIXME: respond with NS_CAUSE_MISSING_ESSENT_IE */
464 LOGP(DNS, LOGL_ERROR, "NS RESET Missing mandatory IE\n");
465 return -EINVAL;
466 }
467
468 cause = (uint8_t *) TLVP_VAL(&tp, NS_IE_CAUSE);
469 //nsvci = (uint16_t *) TLVP_VAL(&tp, NS_IE_VCI);
470
Harald Welte2fc725d2010-05-11 10:15:26 +0200471 ns_dispatch_signal(nsvc, S_NS_BLOCK, *cause);
Harald Welte834f26d2010-05-11 06:20:54 +0200472
473 return gprs_ns_tx_simple(nsvc, NS_PDUT_BLOCK_ACK);
474}
475
Harald Welte9ba50052010-03-14 15:45:01 +0800476/* main entry point, here incoming NS frames enter */
Harald Weltef030b212010-04-26 19:18:54 +0200477int gprs_ns_rcvmsg(struct gprs_ns_inst *nsi, struct msgb *msg,
478 struct sockaddr_in *saddr)
Harald Welte9ba50052010-03-14 15:45:01 +0800479{
480 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Weltef030b212010-04-26 19:18:54 +0200481 struct gprs_nsvc *nsvc;
Harald Welte9ba50052010-03-14 15:45:01 +0800482 int rc = 0;
483
Harald Weltef030b212010-04-26 19:18:54 +0200484 /* look up the NSVC based on source address */
485 nsvc = nsvc_by_rem_addr(nsi, saddr);
486 if (!nsvc) {
Harald Welte9a392932010-05-11 18:30:37 +0200487 struct tlv_parsed tp;
488 uint16_t nsei;
Harald Weltef030b212010-04-26 19:18:54 +0200489 /* Only the RESET procedure creates a new NSVC */
Harald Weltebbc9fac2010-05-03 18:54:12 +0200490 if (nsh->pdu_type != NS_PDUT_RESET) {
Harald Welteb8a6a832010-05-11 05:54:22 +0200491 LOGP(DNS, LOGL_INFO, "Ignoring NS PDU type 0x%0x "
Harald Weltebba902d2010-05-11 18:38:36 +0200492 "from %s:%u for non-existing NS-VC\n",
493 nsh->pdu_type, inet_ntoa(saddr->sin_addr),
494 ntohs(saddr->sin_port));
Harald Welte570fb832010-05-03 21:05:24 +0200495 //gprs_ns_tx_reset(nsvc, NS_CAUSE_NSVC_UNKNOWN);
Harald Weltef030b212010-04-26 19:18:54 +0200496 return -EIO;
Harald Weltebbc9fac2010-05-03 18:54:12 +0200497 }
Harald Welte9a392932010-05-11 18:30:37 +0200498 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
499 msgb_l2len(msg), 0, 0);
500 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE) ||
501 !TLVP_PRESENT(&tp, NS_IE_VCI) ||
502 !TLVP_PRESENT(&tp, NS_IE_NSEI)) {
503 /* FIXME: respond with NS_CAUSE_MISSING_ESSENT_IE */
504 LOGP(DNS, LOGL_ERROR, "NS RESET Missing mandatory IE\n");
505 return -EINVAL;
506 }
507 nsei = ntohs(*(uint16_t *)TLVP_VAL(&tp, NS_IE_NSEI));
508 /* Check if we already know this NSEI, the remote end might
509 * simply have changed addresses, or it is a SGSN */
510 nsvc = nsvc_by_nsei(nsi, nsei);
511 if (!nsvc) {
512 LOGP(DNS, LOGL_INFO, "Creating NS-VC for BSS at %s:%u\n",
513 inet_ntoa(saddr->sin_addr), ntohs(saddr->sin_port));
514 nsvc = nsvc_create(nsi, 0xffff);
Harald Welte9a392932010-05-11 18:30:37 +0200515 }
Harald Welte2b7d4652010-05-11 18:40:45 +0200516 /* Update the remote peer IP address/port */
517 nsvc->ip.bts_addr = *saddr;
Harald Weltebbc9fac2010-05-03 18:54:12 +0200518 } else
519 msgb_nsei(msg) = nsvc->nsei;
Harald Weltec5478482010-03-18 00:01:43 +0800520
Harald Welte9ba50052010-03-14 15:45:01 +0800521 switch (nsh->pdu_type) {
522 case NS_PDUT_ALIVE:
523 /* remote end inquires whether we're still alive,
524 * we need to respond with ALIVE_ACK */
Harald Weltec5478482010-03-18 00:01:43 +0800525 rc = gprs_ns_tx_simple(nsvc, NS_PDUT_ALIVE_ACK);
Harald Welte9ba50052010-03-14 15:45:01 +0800526 break;
527 case NS_PDUT_ALIVE_ACK:
528 /* stop Tns-alive */
Harald Welte80405452010-05-03 20:16:13 +0200529 bsc_del_timer(&nsvc->timer);
Harald Welte9ba50052010-03-14 15:45:01 +0800530 /* start Tns-test */
Harald Welte69a4cf22010-05-03 20:55:10 +0200531 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_TEST);
Harald Welte7fb7e612010-05-03 21:11:22 +0200532 if (nsvc->remote_end_is_sgsn) {
533 /* FIXME: this should be one level higher */
534 if (nsvc->state & NSE_S_BLOCKED)
535 rc = gprs_ns_tx_simple(nsvc, NS_PDUT_UNBLOCK);
536 }
Harald Welte9ba50052010-03-14 15:45:01 +0800537 break;
538 case NS_PDUT_UNITDATA:
539 /* actual user data */
Harald Welte24a655f2010-04-30 19:54:29 +0200540 rc = gprs_ns_rx_unitdata(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800541 break;
542 case NS_PDUT_STATUS:
Harald Welte24a655f2010-04-30 19:54:29 +0200543 rc = gprs_ns_rx_status(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800544 break;
545 case NS_PDUT_RESET:
Harald Welte24a655f2010-04-30 19:54:29 +0200546 rc = gprs_ns_rx_reset(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800547 break;
548 case NS_PDUT_RESET_ACK:
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200549 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS RESET ACK\n", nsvc->nsei);
Harald Weltef030b212010-04-26 19:18:54 +0200550 /* mark remote NS-VC as blocked + active */
551 nsvc->remote_state = NSE_S_BLOCKED | NSE_S_ALIVE;
Harald Welte69a4cf22010-05-03 20:55:10 +0200552 if (nsvc->remote_end_is_sgsn) {
553 /* stop RESET timer */
554 bsc_del_timer(&nsvc->timer);
Harald Welte570fb832010-05-03 21:05:24 +0200555 /* send ALIVE PDU */
556 rc = gprs_ns_tx_simple(nsvc, NS_PDUT_ALIVE);
557 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_ALIVE);
Harald Welte7fb7e612010-05-03 21:11:22 +0200558 /* mark local state as BLOCKED + ALIVE */
559 nsvc->state = NSE_S_BLOCKED | NSE_S_ALIVE;
Harald Welte69a4cf22010-05-03 20:55:10 +0200560 }
Harald Welte9ba50052010-03-14 15:45:01 +0800561 break;
562 case NS_PDUT_UNBLOCK:
563 /* Section 7.2: unblocking procedure */
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200564 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS UNBLOCK\n", nsvc->nsei);
Harald Welte9ba50052010-03-14 15:45:01 +0800565 nsvc->state &= ~NSE_S_BLOCKED;
Harald Welte834f26d2010-05-11 06:20:54 +0200566 ns_dispatch_signal(nsvc, S_NS_UNBLOCK, 0);
Harald Weltec5478482010-03-18 00:01:43 +0800567 rc = gprs_ns_tx_simple(nsvc, NS_PDUT_UNBLOCK_ACK);
Harald Welte9ba50052010-03-14 15:45:01 +0800568 break;
569 case NS_PDUT_UNBLOCK_ACK:
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200570 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS UNBLOCK ACK\n", nsvc->nsei);
Harald Weltef030b212010-04-26 19:18:54 +0200571 /* mark remote NS-VC as unblocked + active */
572 nsvc->remote_state = NSE_S_ALIVE;
Harald Welte7fb7e612010-05-03 21:11:22 +0200573 if (nsvc->remote_end_is_sgsn)
574 nsvc->state = NSE_S_ALIVE;
Harald Welte9ba50052010-03-14 15:45:01 +0800575 break;
576 case NS_PDUT_BLOCK:
Harald Welte834f26d2010-05-11 06:20:54 +0200577 rc = gprs_ns_rx_block(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800578 break;
579 case NS_PDUT_BLOCK_ACK:
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200580 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS BLOCK ACK\n", nsvc->nsei);
Harald Weltef030b212010-04-26 19:18:54 +0200581 /* mark remote NS-VC as blocked + active */
582 nsvc->remote_state = NSE_S_BLOCKED | NSE_S_ALIVE;
Harald Welte9ba50052010-03-14 15:45:01 +0800583 break;
584 default:
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200585 LOGP(DNS, LOGL_NOTICE, "NSEI=%u Rx Unknown NS PDU type 0x%02x\n",
Harald Weltebbc9fac2010-05-03 18:54:12 +0200586 nsvc->nsei, nsh->pdu_type);
Harald Welte9ba50052010-03-14 15:45:01 +0800587 rc = -EINVAL;
588 break;
589 }
590 return rc;
591}
592
Harald Weltef030b212010-04-26 19:18:54 +0200593struct gprs_ns_inst *gprs_ns_instantiate(gprs_ns_cb_t *cb)
594{
595 struct gprs_ns_inst *nsi = talloc_zero(tall_bsc_ctx, struct gprs_ns_inst);
596
597 nsi->cb = cb;
598 INIT_LLIST_HEAD(&nsi->gprs_nsvcs);
599
Harald Welte3771d092010-04-30 20:26:32 +0200600 return nsi;
Harald Weltef030b212010-04-26 19:18:54 +0200601}
602
603void gprs_ns_destroy(struct gprs_ns_inst *nsi)
604{
605 /* FIXME: clear all timers */
606
607 /* recursively free the NSI and all its NSVCs */
608 talloc_free(nsi);
609}
610
611
612/* NS-over-IP code, according to 3GPP TS 48.016 Chapter 6.2
613 * We don't support Size Procedure, Configuration Procedure, ChangeWeight Procedure */
614
615/* Read a single NS-over-IP message */
616static struct msgb *read_nsip_msg(struct bsc_fd *bfd, int *error,
617 struct sockaddr_in *saddr)
618{
619 struct msgb *msg = msgb_alloc(NS_ALLOC_SIZE, "Abis/IP/GPRS-NS");
620 int ret = 0;
621 socklen_t saddr_len = sizeof(*saddr);
622
623 if (!msg) {
624 *error = -ENOMEM;
625 return NULL;
626 }
627
628 ret = recvfrom(bfd->fd, msg->data, NS_ALLOC_SIZE, 0,
629 (struct sockaddr *)saddr, &saddr_len);
630 if (ret < 0) {
Harald Welteb8a6a832010-05-11 05:54:22 +0200631 LOGP(DNS, LOGL_ERROR, "recv error %s during NSIP recv\n",
Harald Weltebbc9fac2010-05-03 18:54:12 +0200632 strerror(errno));
Harald Weltef030b212010-04-26 19:18:54 +0200633 msgb_free(msg);
634 *error = ret;
635 return NULL;
636 } else if (ret == 0) {
637 msgb_free(msg);
638 *error = ret;
639 return NULL;
640 }
641
642 msg->l2h = msg->data;
643 msgb_put(msg, ret);
644
645 return msg;
646}
647
648static int handle_nsip_read(struct bsc_fd *bfd)
649{
650 int error;
651 struct sockaddr_in saddr;
652 struct gprs_ns_inst *nsi = bfd->data;
653 struct msgb *msg = read_nsip_msg(bfd, &error, &saddr);
654
655 if (!msg)
656 return error;
657
658 return gprs_ns_rcvmsg(nsi, msg, &saddr);
659}
660
661static int handle_nsip_write(struct bsc_fd *bfd)
662{
663 /* FIXME: actually send the data here instead of nsip_sendmsg() */
664 return -EIO;
665}
666
Harald Welte24a655f2010-04-30 19:54:29 +0200667int nsip_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Weltef030b212010-04-26 19:18:54 +0200668{
669 int rc;
670 struct gprs_ns_inst *nsi = nsvc->nsi;
671 struct sockaddr_in *daddr = &nsvc->ip.bts_addr;
672
673 rc = sendto(nsi->nsip.fd.fd, msg->data, msg->len, 0,
674 (struct sockaddr *)daddr, sizeof(*daddr));
675
676 talloc_free(msg);
677
678 return rc;
679}
680
681/* UDP Port 23000 carries the LLC-in-BSSGP-in-NS protocol stack */
682static int nsip_fd_cb(struct bsc_fd *bfd, unsigned int what)
683{
684 int rc = 0;
685
686 if (what & BSC_FD_READ)
687 rc = handle_nsip_read(bfd);
688 if (what & BSC_FD_WRITE)
689 rc = handle_nsip_write(bfd);
690
691 return rc;
692}
693
694
695/* FIXME: this is currently in input/ipaccess.c */
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200696extern int make_sock(struct bsc_fd *bfd, int proto, uint16_t port,
Harald Weltef030b212010-04-26 19:18:54 +0200697 int (*cb)(struct bsc_fd *fd, unsigned int what));
698
699/* Listen for incoming GPRS packets */
700int nsip_listen(struct gprs_ns_inst *nsi, uint16_t udp_port)
701{
702 int ret;
703
704 ret = make_sock(&nsi->nsip.fd, IPPROTO_UDP, udp_port, nsip_fd_cb);
705 if (ret < 0)
706 return ret;
707
708 nsi->ll = GPRS_NS_LL_UDP;
709 nsi->nsip.fd.data = nsi;
710
711 return ret;
712}
Harald Welte3771d092010-04-30 20:26:32 +0200713
714/* Establish a connection (from the BSS) to the SGSN */
715struct gprs_nsvc *nsip_connect(struct gprs_ns_inst *nsi,
Harald Welte1203de32010-05-01 11:28:43 +0200716 struct sockaddr_in *dest, uint16_t nsei,
717 uint16_t nsvci)
Harald Welte3771d092010-04-30 20:26:32 +0200718{
719 struct gprs_nsvc *nsvc;
720
721 nsvc = nsvc_by_rem_addr(nsi, dest);
722 if (!nsvc) {
723 nsvc = nsvc_create(nsi, nsvci);
724 nsvc->ip.bts_addr = *dest;
725 }
Harald Welte1203de32010-05-01 11:28:43 +0200726 nsvc->nsei = nsei;
727 nsvc->nsvci = nsvci;
Harald Welte3771d092010-04-30 20:26:32 +0200728 nsvc->remote_end_is_sgsn = 1;
729
730 /* Initiate a RESET procedure */
Harald Welte570fb832010-05-03 21:05:24 +0200731 if (gprs_ns_tx_reset(nsvc, NS_CAUSE_OM_INTERVENTION) < 0) {
Harald Welteb8a6a832010-05-11 05:54:22 +0200732 LOGP(DNS, LOGL_ERROR, "NSEI=%u, error resetting NS-VC\n",
Harald Welte69a4cf22010-05-03 20:55:10 +0200733 nsei);
734 }
735 /* run a timer and re-transmit the reset request? */
736 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_RESET);
Harald Welte3771d092010-04-30 20:26:32 +0200737
738 return nsvc;
739}