blob: 2d062cf237b851ff6c04791cb0ae03bcdafd1fe0 [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*! \file gprs_ns.c
2 * GPRS Networks Service (NS) messages on the Gb interface.
3 * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05). */
4/*
5 * (C) 2009-2012 by Harald Welte <laforge@gnumonks.org>
Harald Welte9ba50052010-03-14 15:45:01 +08006 *
7 * All Rights Reserved
8 *
9 * This program is free software; you can redistribute it and/or modify
Harald Welte7fa89c22014-10-26 20:33:09 +010010 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
Harald Welte9ba50052010-03-14 15:45:01 +080012 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Harald Welte7fa89c22014-10-26 20:33:09 +010017 * GNU General Public License for more details.
Harald Welte9ba50052010-03-14 15:45:01 +080018 *
Harald Welte7fa89c22014-10-26 20:33:09 +010019 * You should have received a copy of the GNU General Public License
Harald Weltee4cbb3f2011-01-01 15:25:50 +010020 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Harald Welte9ba50052010-03-14 15:45:01 +080021 *
22 */
23
Harald Weltea9f23c82011-11-23 15:01:31 +010024/*! \addtogroup libgb
25 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020026 *
Harald Weltea9f23c82011-11-23 15:01:31 +010027 * GPRS Networks Service (NS) messages on the Gb interface
28 * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05)
29 *
30 * Some introduction into NS: NS is used typically on top of frame relay,
Harald Welte9ba50052010-03-14 15:45:01 +080031 * but in the ip.access world it is encapsulated in UDP packets. It serves
32 * as an intermediate shim betwen BSSGP and the underlying medium. It doesn't
33 * do much, apart from providing congestion notification and status indication.
34 *
35 * Terms:
Harald Welte9ba50052010-03-14 15:45:01 +080036 *
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020037 * NS Network Service
38 * NSVC NS Virtual Connection
39 * NSEI NS Entity Identifier
40 * NSVL NS Virtual Link
41 * NSVLI NS Virtual Link Identifier
42 * BVC BSSGP Virtual Connection
43 * BVCI BSSGP Virtual Connection Identifier
44 * NSVCG NS Virtual Connection Goup
45 * Blocked NS-VC cannot be used for user traffic
46 * Alive Ability of a NS-VC to provide communication
47 *
48 * There can be multiple BSSGP virtual connections over one (group of) NSVC's. BSSGP will
Harald Welte9ba50052010-03-14 15:45:01 +080049 * therefore identify the BSSGP virtual connection by a BVCI passed down to NS.
50 * NS then has to firgure out which NSVC's are responsible for this BVCI.
51 * Those mappings are administratively configured.
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020052 *
53 * This implementation has the following limitations:
54 * - Only one NS-VC for each NSE: No load-sharing function
55 * - NSVCI 65535 and 65534 are reserved for internal use
56 * - Only UDP is supported as of now, no frame relay support
57 * - The IP Sub-Network-Service (SNS) as specified in 48.016 is not implemented
58 * - There are no BLOCK and UNBLOCK timers (yet?)
59 *
60 * \file gprs_ns.c */
Harald Weltedd1c83c2010-05-13 13:58:08 +020061
Harald Welte9ba50052010-03-14 15:45:01 +080062#include <stdlib.h>
63#include <unistd.h>
64#include <errno.h>
Harald Welte8f9a3ee2010-05-02 11:26:34 +020065#include <stdint.h>
Harald Welte9ba50052010-03-14 15:45:01 +080066
Holger Hans Peter Freyther3c16de22012-07-12 14:13:41 +020067#include <sys/types.h>
68#include <sys/socket.h>
Harald Welte9ba50052010-03-14 15:45:01 +080069#include <arpa/inet.h>
70
Pablo Neira Ayusoff663232011-03-22 16:47:59 +010071#include <osmocom/core/msgb.h>
Harald Weltebfe62e52017-05-15 12:48:30 +020072#include <osmocom/core/byteswap.h>
Pablo Neira Ayusoff663232011-03-22 16:47:59 +010073#include <osmocom/gsm/tlv.h>
74#include <osmocom/core/talloc.h>
75#include <osmocom/core/select.h>
76#include <osmocom/core/rate_ctr.h>
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +020077#include <osmocom/core/stat_item.h>
Jacob Erlbeckbc9d9ac2015-11-02 14:49:35 +010078#include <osmocom/core/stats.h>
Harald Welte73952e32012-06-16 14:59:56 +080079#include <osmocom/core/socket.h>
Harald Welte4fcdd762012-06-16 16:40:42 +080080#include <osmocom/core/signal.h>
Harald Welte73952e32012-06-16 14:59:56 +080081#include <osmocom/gprs/gprs_ns.h>
82#include <osmocom/gprs/gprs_bssgp.h>
83#include <osmocom/gprs/gprs_ns_frgre.h>
84
Harald Weltecca49632012-06-16 17:45:59 +080085#include "common_vty.h"
Harald Welte9ba50052010-03-14 15:45:01 +080086
Maxc513c0f2017-10-23 15:11:14 +020087#define ns_set_state(ns_, st_) ns_set_state_with_log(ns_, st_, false, __BASE_FILE__, __LINE__)
88#define ns_set_remote_state(ns_, st_) ns_set_state_with_log(ns_, st_, true, __BASE_FILE__, __LINE__)
89#define ns_mark_blocked(ns_) ns_set_state(ns_, (ns_)->state | NSE_S_BLOCKED)
90#define ns_mark_unblocked(ns_) ns_set_state(ns_, (ns_)->state & (~NSE_S_BLOCKED));
91
Harald Welte9ba50052010-03-14 15:45:01 +080092static const struct tlv_definition ns_att_tlvdef = {
93 .def = {
94 [NS_IE_CAUSE] = { TLV_TYPE_TvLV, 0 },
95 [NS_IE_VCI] = { TLV_TYPE_TvLV, 0 },
96 [NS_IE_PDU] = { TLV_TYPE_TvLV, 0 },
97 [NS_IE_BVCI] = { TLV_TYPE_TvLV, 0 },
98 [NS_IE_NSEI] = { TLV_TYPE_TvLV, 0 },
99 },
100};
101
Harald Weltec51c23c2010-05-13 12:55:20 +0200102enum ns_ctr {
103 NS_CTR_PKTS_IN,
104 NS_CTR_PKTS_OUT,
105 NS_CTR_BYTES_IN,
106 NS_CTR_BYTES_OUT,
107 NS_CTR_BLOCKED,
108 NS_CTR_DEAD,
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200109 NS_CTR_REPLACED,
110 NS_CTR_NSEI_CHG,
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200111 NS_CTR_INV_VCI,
112 NS_CTR_INV_NSEI,
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200113 NS_CTR_LOST_ALIVE,
114 NS_CTR_LOST_RESET,
Harald Weltec51c23c2010-05-13 12:55:20 +0200115};
116
Harald Welte144e0292010-05-13 11:45:07 +0200117static const struct rate_ctr_desc nsvc_ctr_description[] = {
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200118 { "packets.in", "Packets at NS Level ( In)" },
119 { "packets.out","Packets at NS Level (Out)" },
120 { "bytes.in", "Bytes at NS Level ( In)" },
121 { "bytes.out", "Bytes at NS Level (Out)" },
122 { "blocked", "NS-VC Block count " },
123 { "dead", "NS-VC gone dead count " },
124 { "replaced", "NS-VC replaced other count" },
Jacob Erlbeckab852ee2013-10-24 01:33:24 +0200125 { "nsei-chg", "NS-VC changed NSEI count " },
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200126 { "inv-nsvci", "NS-VCI was invalid count " },
127 { "inv-nsei", "NSEI was invalid count " },
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200128 { "lost.alive", "ALIVE ACK missing count " },
129 { "lost.reset", "RESET ACK missing count " },
Harald Welte144e0292010-05-13 11:45:07 +0200130};
131
132static const struct rate_ctr_group_desc nsvc_ctrg_desc = {
Harald Weltec51c23c2010-05-13 12:55:20 +0200133 .group_name_prefix = "ns.nsvc",
Harald Welte144e0292010-05-13 11:45:07 +0200134 .group_description = "NSVC Peer Statistics",
135 .num_ctr = ARRAY_SIZE(nsvc_ctr_description),
136 .ctr_desc = nsvc_ctr_description,
Jacob Erlbeckfed2a482015-11-03 16:18:56 +0100137 .class_id = OSMO_STATS_CLASS_PEER,
Harald Welte144e0292010-05-13 11:45:07 +0200138};
139
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200140enum ns_stat {
141 NS_STAT_ALIVE_DELAY,
142};
143
Jacob Erlbeckfc9533d2015-10-29 00:55:58 +0100144static const struct osmo_stat_item_desc nsvc_stat_description[] = {
Thorsten Alteholza81055d2017-03-02 22:13:48 +0100145 { "alive.delay", "ALIVE response time ", "ms", 16, 0 },
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200146};
147
Jacob Erlbeckfc9533d2015-10-29 00:55:58 +0100148static const struct osmo_stat_item_group_desc nsvc_statg_desc = {
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200149 .group_name_prefix = "ns.nsvc",
150 .group_description = "NSVC Peer Statistics",
151 .num_items = ARRAY_SIZE(nsvc_stat_description),
152 .item_desc = nsvc_stat_description,
Jacob Erlbeckbc9d9ac2015-11-02 14:49:35 +0100153 .class_id = OSMO_STATS_CLASS_PEER,
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200154};
155
Max54ca30c2017-05-22 14:48:27 +0200156const struct value_string gprs_ns_signal_ns_names[] = {
157 { S_NS_RESET, "NS-RESET" },
158 { S_NS_BLOCK, "NS-BLOCK" },
159 { S_NS_UNBLOCK, "NS-UNBLOCK" },
160 { S_NS_ALIVE_EXP, "NS-ALIVE expired" },
161 { S_NS_REPLACED, "NSVC replaced" },
162 { S_NS_MISMATCH, "Unexpected IE" },
163 { 0, NULL }
164};
165
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +0200166#define CHECK_TX_RC(rc, nsvc) \
167 if (rc < 0) \
168 LOGP(DNS, LOGL_ERROR, "TX failed (%d) to peer %s\n", \
169 rc, gprs_ns_ll_str(nsvc));
170
Jacob Erlbeck8d192d72015-04-07 17:52:45 +0200171struct msgb *gprs_ns_msgb_alloc(void)
172{
173 struct msgb *msg = msgb_alloc_headroom(NS_ALLOC_SIZE, NS_ALLOC_HEADROOM,
174 "GPRS/NS");
175 if (!msg) {
176 LOGP(DNS, LOGL_ERROR, "Failed to allocate NS message of size %d\n",
177 NS_ALLOC_SIZE);
178 }
179 return msg;
180}
181
Maxc513c0f2017-10-23 15:11:14 +0200182/* FIXME: convert to osmo_fsm */
183static inline void ns_set_state_with_log(struct gprs_nsvc *nsvc, uint32_t state, bool is_remote,
184 const char *file, unsigned line)
185{
186 uint32_t old_state = is_remote ? nsvc->remote_state : nsvc->state;
187
188 LOGPSRC(DNS, LOGL_DEBUG, file, line, "NSEI %d (NS-VCI=%u) setting %sstate [%s,%s,%s] -> [%s,%s,%s]\n",
189 nsvc->nsei, nsvc->nsvci, is_remote ? "remote " : "",
190 NS_DESC_A(old_state), NS_DESC_B(old_state), NS_DESC_R(old_state),
191 NS_DESC_A(state), NS_DESC_B(state), NS_DESC_R(state));
192
193 if (is_remote)
194 nsvc->remote_state = state;
195 else
196 nsvc->state = state;
197}
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +0200198
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200199/*! Lookup struct gprs_nsvc based on NSVCI
Harald Weltea9f23c82011-11-23 15:01:31 +0100200 * \param[in] nsi NS instance in which to search
201 * \param[in] nsvci NSVCI to be searched
202 * \returns gprs_nsvc of respective NSVCI
203 */
Harald Weltef5430362012-06-17 12:25:53 +0800204struct gprs_nsvc *gprs_nsvc_by_nsvci(struct gprs_ns_inst *nsi, uint16_t nsvci)
Harald Weltef030b212010-04-26 19:18:54 +0200205{
206 struct gprs_nsvc *nsvc;
207 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
208 if (nsvc->nsvci == nsvci)
209 return nsvc;
210 }
211 return NULL;
212}
213
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200214/*! Lookup struct gprs_nsvc based on NSEI
Harald Weltea9f23c82011-11-23 15:01:31 +0100215 * \param[in] nsi NS instance in which to search
216 * \param[in] nsei NSEI to be searched
Jacob Erlbeck69017152013-10-14 12:03:54 +0200217 * \returns first gprs_nsvc of respective NSEI
Harald Weltea9f23c82011-11-23 15:01:31 +0100218 */
Harald Weltef5430362012-06-17 12:25:53 +0800219struct gprs_nsvc *gprs_nsvc_by_nsei(struct gprs_ns_inst *nsi, uint16_t nsei)
Harald Welte24a655f2010-04-30 19:54:29 +0200220{
221 struct gprs_nsvc *nsvc;
222 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
223 if (nsvc->nsei == nsei)
224 return nsvc;
225 }
226 return NULL;
227}
228
Jacob Erlbeck69017152013-10-14 12:03:54 +0200229static struct gprs_nsvc *gprs_active_nsvc_by_nsei(struct gprs_ns_inst *nsi,
230 uint16_t nsei)
231{
232 struct gprs_nsvc *nsvc;
233 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
234 if (nsvc->nsei == nsei) {
Jacob Erlbeckbf021962013-10-17 13:58:35 +0200235 if (!(nsvc->state & NSE_S_BLOCKED) &&
236 nsvc->state & NSE_S_ALIVE)
Jacob Erlbeck69017152013-10-14 12:03:54 +0200237 return nsvc;
238 }
239 }
240 return NULL;
241}
242
Harald Weltef030b212010-04-26 19:18:54 +0200243/* Lookup struct gprs_nsvc based on remote peer socket addr */
244static struct gprs_nsvc *nsvc_by_rem_addr(struct gprs_ns_inst *nsi,
245 struct sockaddr_in *sin)
246{
247 struct gprs_nsvc *nsvc;
248 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
Harald Welte38407ef2010-05-12 11:56:39 +0000249 if (nsvc->ip.bts_addr.sin_addr.s_addr ==
250 sin->sin_addr.s_addr &&
251 nsvc->ip.bts_addr.sin_port == sin->sin_port)
Harald Weltef030b212010-04-26 19:18:54 +0200252 return nsvc;
253 }
254 return NULL;
255}
256
Harald Welte69a4cf22010-05-03 20:55:10 +0200257static void gprs_ns_timer_cb(void *data);
258
Harald Weltef5430362012-06-17 12:25:53 +0800259struct gprs_nsvc *gprs_nsvc_create(struct gprs_ns_inst *nsi, uint16_t nsvci)
Harald Weltef030b212010-04-26 19:18:54 +0200260{
261 struct gprs_nsvc *nsvc;
262
Harald Welteb1020d52010-05-25 22:17:30 +0200263 LOGP(DNS, LOGL_INFO, "NSVCI=%u Creating NS-VC\n", nsvci);
264
Harald Weltef030b212010-04-26 19:18:54 +0200265 nsvc = talloc_zero(nsi, struct gprs_nsvc);
266 nsvc->nsvci = nsvci;
Jacob Erlbeck9b591b72013-11-11 09:43:05 +0100267 nsvc->nsvci_is_valid = 1;
Harald Weltef030b212010-04-26 19:18:54 +0200268 /* before RESET procedure: BLOCKED and DEAD */
Maxc513c0f2017-10-23 15:11:14 +0200269 ns_set_state(nsvc, NSE_S_BLOCKED);
Harald Weltef030b212010-04-26 19:18:54 +0200270 nsvc->nsi = nsi;
Pablo Neira Ayuso44f423f2017-05-08 18:00:28 +0200271 osmo_timer_setup(&nsvc->timer, gprs_ns_timer_cb, nsvc);
Harald Welte144e0292010-05-13 11:45:07 +0200272 nsvc->ctrg = rate_ctr_group_alloc(nsvc, &nsvc_ctrg_desc, nsvci);
Jacob Erlbeckfc9533d2015-10-29 00:55:58 +0100273 nsvc->statg = osmo_stat_item_group_alloc(nsvc, &nsvc_statg_desc, nsvci);
Harald Welte69a4cf22010-05-03 20:55:10 +0200274
Harald Weltef030b212010-04-26 19:18:54 +0200275 llist_add(&nsvc->list, &nsi->gprs_nsvcs);
276
277 return nsvc;
278}
Harald Welte9ba50052010-03-14 15:45:01 +0800279
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200280/*! Delete given NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100281 * \param[in] nsvc gprs_nsvc to be deleted
282 */
Harald Weltef5430362012-06-17 12:25:53 +0800283void gprs_nsvc_delete(struct gprs_nsvc *nsvc)
Harald Welte2bffac52010-05-12 15:55:23 +0000284{
Pablo Neira Ayuso2b159522011-05-06 12:11:06 +0200285 if (osmo_timer_pending(&nsvc->timer))
286 osmo_timer_del(&nsvc->timer);
Harald Welte2bffac52010-05-12 15:55:23 +0000287 llist_del(&nsvc->list);
Jacob Erlbecka52ba012013-10-24 01:33:21 +0200288 rate_ctr_group_free(nsvc->ctrg);
Jacob Erlbeck0975a7f2015-12-17 09:51:53 +0100289 osmo_stat_item_group_free(nsvc->statg);
Harald Welte2bffac52010-05-12 15:55:23 +0000290 talloc_free(nsvc);
291}
292
Pablo Neira Ayuso2b88a2a2011-05-06 12:12:31 +0200293static void ns_osmo_signal_dispatch(struct gprs_nsvc *nsvc, unsigned int signal,
Harald Welte834f26d2010-05-11 06:20:54 +0200294 uint8_t cause)
295{
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200296 struct ns_signal_data nssd = {0};
Harald Welte834f26d2010-05-11 06:20:54 +0200297
298 nssd.nsvc = nsvc;
299 nssd.cause = cause;
300
Harald Welte4fcdd762012-06-16 16:40:42 +0800301 osmo_signal_dispatch(SS_L_NS, signal, &nssd);
Harald Welte834f26d2010-05-11 06:20:54 +0200302}
303
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200304static void ns_osmo_signal_dispatch_mismatch(struct gprs_nsvc *nsvc,
305 struct msgb *msg,
306 uint8_t pdu_type, uint8_t ie_type)
307{
308 struct ns_signal_data nssd = {0};
309
310 nssd.nsvc = nsvc;
311 nssd.pdu_type = pdu_type;
312 nssd.ie_type = ie_type;
313 nssd.msg = msg;
314
315 osmo_signal_dispatch(SS_L_NS, S_NS_MISMATCH, &nssd);
316}
317
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200318static void ns_osmo_signal_dispatch_replaced(struct gprs_nsvc *nsvc, struct gprs_nsvc *old_nsvc)
319{
320 struct ns_signal_data nssd = {0};
321
322 nssd.nsvc = nsvc;
323 nssd.old_nsvc = old_nsvc;
324
325 osmo_signal_dispatch(SS_L_NS, S_NS_REPLACED, &nssd);
326}
327
Max584f4b62017-05-04 11:59:52 +0200328const struct value_string gprs_ns_pdu_strings[] = {
329 /* 3GPP TS 48.016 §9.2 Network Service Control PDUs */
330 { NS_PDUT_UNITDATA, "NS-UNITDATA" }, /* §9.2.1 */
331 { NS_PDUT_RESET, "NS-RESET" }, /* §9.2.5 */
332 { NS_PDUT_RESET_ACK, "NS-RESET-ACK" }, /* §9.2.6 */
333 { NS_PDUT_BLOCK, "NS-BLOCK" }, /* §9.2.3 */
334 { NS_PDUT_BLOCK_ACK, "NS-BLOCK-ACK" }, /* §9.2.4 */
335 { NS_PDUT_UNBLOCK, "NS-UNBLOCK" }, /* §9.2.8 */
336 { NS_PDUT_UNBLOCK_ACK, "NS-UNBLOCK-ACK" }, /* §9.2.9 */
337 { NS_PDUT_STATUS, "NS-STATUS" }, /* §9.2.7 */
338 { NS_PDUT_ALIVE, "NS-ALIVE" }, /* §9.2.1 */
339 { NS_PDUT_ALIVE_ACK, "NS-ALIVE-ACK" }, /* §9.2.2 */
340 /* 3GPP TS 48.016 §9.3 Sub-Network Service Control PDUs */
341 { SNS_PDUT_ACK, "SNS-ACK" }, /* §9.3.1 */
342 { SNS_PDUT_ADD, "SNS-ADD" }, /* §9.3.2 */
343 { SNS_PDUT_CHANGE_WEIGHT, "SNS-CHANGEWEIGHT" }, /* §9.3.3 */
344 { SNS_PDUT_CONFIG, "SNS-CONFIG" }, /* §9.3.4 */
345 { SNS_PDUT_CONFIG_ACK, "SNS-CONFIG-ACK" }, /* §9.3.5 */
346 { SNS_PDUT_DELETE, "SNS-DELETE" }, /* §9.3.6 */
347 { SNS_PDUT_SIZE, "SNS-SIZE" }, /* §9.3.7 */
348 { SNS_PDUT_SIZE_ACK, "SNS-SIZE-ACK" }, /* §9.3.8 */
349 { 0, NULL }
350};
351
Harald Welte9ba50052010-03-14 15:45:01 +0800352/* Section 10.3.2, Table 13 */
Harald Welte2577d412010-05-02 09:37:45 +0200353static const struct value_string ns_cause_str[] = {
354 { NS_CAUSE_TRANSIT_FAIL, "Transit network failure" },
355 { NS_CAUSE_OM_INTERVENTION, "O&M intervention" },
356 { NS_CAUSE_EQUIP_FAIL, "Equipment failure" },
357 { NS_CAUSE_NSVC_BLOCKED, "NS-VC blocked" },
358 { NS_CAUSE_NSVC_UNKNOWN, "NS-VC unknown" },
359 { NS_CAUSE_BVCI_UNKNOWN, "BVCI unknown" },
360 { NS_CAUSE_SEM_INCORR_PDU, "Semantically incorrect PDU" },
361 { NS_CAUSE_PDU_INCOMP_PSTATE, "PDU not compatible with protocol state" },
Harald Welte69a4cf22010-05-03 20:55:10 +0200362 { NS_CAUSE_PROTO_ERR_UNSPEC, "Protocol error, unspecified" },
Harald Welte2577d412010-05-02 09:37:45 +0200363 { NS_CAUSE_INVAL_ESSENT_IE, "Invalid essential IE" },
364 { NS_CAUSE_MISSING_ESSENT_IE, "Missing essential IE" },
365 { 0, NULL }
Harald Welte9ba50052010-03-14 15:45:01 +0800366};
367
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200368/*! Obtain a human-readable string for NS cause value */
Harald Welte2577d412010-05-02 09:37:45 +0200369const char *gprs_ns_cause_str(enum ns_cause cause)
Harald Welte9ba50052010-03-14 15:45:01 +0800370{
Harald Welte2577d412010-05-02 09:37:45 +0200371 return get_value_string(ns_cause_str, cause);
Harald Welte9ba50052010-03-14 15:45:01 +0800372}
373
Harald Welte24a655f2010-04-30 19:54:29 +0200374static int nsip_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg);
Harald Welteb3ee2652010-05-19 14:38:50 +0200375extern int grps_ns_frgre_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg);
Harald Weltef030b212010-04-26 19:18:54 +0200376
Harald Welte24a655f2010-04-30 19:54:29 +0200377static int gprs_ns_tx(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800378{
Harald Weltef030b212010-04-26 19:18:54 +0200379 int ret;
380
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100381 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200382
Harald Welte144e0292010-05-13 11:45:07 +0200383 /* Increment number of Uplink bytes */
Harald Weltec51c23c2010-05-13 12:55:20 +0200384 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_PKTS_OUT]);
385 rate_ctr_add(&nsvc->ctrg->ctr[NS_CTR_BYTES_OUT], msgb_l2len(msg));
Harald Welte144e0292010-05-13 11:45:07 +0200386
Harald Welteb3ee2652010-05-19 14:38:50 +0200387 switch (nsvc->ll) {
Harald Weltef030b212010-04-26 19:18:54 +0200388 case GPRS_NS_LL_UDP:
Harald Welte24a655f2010-04-30 19:54:29 +0200389 ret = nsip_sendmsg(nsvc, msg);
Jacob Erlbeck8d192d72015-04-07 17:52:45 +0200390 if (ret < 0)
391 LOGP(DNS, LOGL_INFO,
392 "failed to send NS message via UDP: %s\n",
393 strerror(-ret));
Harald Weltef030b212010-04-26 19:18:54 +0200394 break;
Harald Welteb3ee2652010-05-19 14:38:50 +0200395 case GPRS_NS_LL_FR_GRE:
396 ret = gprs_ns_frgre_sendmsg(nsvc, msg);
Jacob Erlbeck8d192d72015-04-07 17:52:45 +0200397 if (ret < 0)
398 LOGP(DNS, LOGL_INFO,
399 "failed to send NS message via FR/GRE: %s\n",
400 strerror(-ret));
Harald Welteb3ee2652010-05-19 14:38:50 +0200401 break;
Harald Weltef030b212010-04-26 19:18:54 +0200402 default:
Harald Welteb3ee2652010-05-19 14:38:50 +0200403 LOGP(DNS, LOGL_ERROR, "unsupported NS linklayer %u\n", nsvc->ll);
Harald Weltef030b212010-04-26 19:18:54 +0200404 msgb_free(msg);
405 ret = -EIO;
406 break;
407 }
408 return ret;
Harald Welte9ba50052010-03-14 15:45:01 +0800409}
410
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200411static int gprs_ns_tx_simple(struct gprs_nsvc *nsvc, uint8_t pdu_type)
Harald Welte9ba50052010-03-14 15:45:01 +0800412{
Harald Welteba4c6662010-05-19 15:38:10 +0200413 struct msgb *msg = gprs_ns_msgb_alloc();
Harald Welte9ba50052010-03-14 15:45:01 +0800414 struct gprs_ns_hdr *nsh;
415
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100416 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200417
Harald Welte9ba50052010-03-14 15:45:01 +0800418 if (!msg)
419 return -ENOMEM;
420
Harald Welte144e0292010-05-13 11:45:07 +0200421 msg->l2h = msgb_put(msg, sizeof(*nsh));
422 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +0800423
424 nsh->pdu_type = pdu_type;
425
Harald Welte24a655f2010-04-30 19:54:29 +0200426 return gprs_ns_tx(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800427}
428
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200429/*! Transmit a NS-RESET on a given NSVC
Harald Weltea9f23c82011-11-23 15:01:31 +0100430 * \param[in] nsvc NS-VC used for transmission
431 * \paam[in] cause Numeric NS cause value
432 */
Harald Welte834f26d2010-05-11 06:20:54 +0200433int gprs_ns_tx_reset(struct gprs_nsvc *nsvc, uint8_t cause)
Harald Welte69a4cf22010-05-03 20:55:10 +0200434{
Harald Welteba4c6662010-05-19 15:38:10 +0200435 struct msgb *msg = gprs_ns_msgb_alloc();
Harald Welte69a4cf22010-05-03 20:55:10 +0200436 struct gprs_ns_hdr *nsh;
Harald Weltebfe62e52017-05-15 12:48:30 +0200437 uint16_t nsvci = osmo_htons(nsvc->nsvci);
438 uint16_t nsei = osmo_htons(nsvc->nsei);
Harald Welte69a4cf22010-05-03 20:55:10 +0200439
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100440 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200441
Harald Welte69a4cf22010-05-03 20:55:10 +0200442 if (!msg)
443 return -ENOMEM;
444
Harald Welte6ecaa3d2010-05-12 12:01:33 +0000445 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS RESET (NSVCI=%u, cause=%s)\n",
446 nsvc->nsei, nsvc->nsvci, gprs_ns_cause_str(cause));
447
Harald Welte144e0292010-05-13 11:45:07 +0200448 msg->l2h = msgb_put(msg, sizeof(*nsh));
449 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte69a4cf22010-05-03 20:55:10 +0200450 nsh->pdu_type = NS_PDUT_RESET;
451
452 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, &cause);
453 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *) &nsvci);
454 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *) &nsei);
455
456 return gprs_ns_tx(nsvc, msg);
457
458}
459
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200460/*! Transmit a NS-STATUS on a given NSVC
Harald Weltea9f23c82011-11-23 15:01:31 +0100461 * \param[in] nsvc NS-VC to be used for transmission
462 * \param[in] cause Numeric NS cause value
463 * \param[in] bvci BVCI to be reset within NSVC
464 * \param[in] orig_msg message causing the STATUS */
Harald Weltec1402a62010-05-12 11:48:44 +0200465int gprs_ns_tx_status(struct gprs_nsvc *nsvc, uint8_t cause,
466 uint16_t bvci, struct msgb *orig_msg)
467{
Harald Welteba4c6662010-05-19 15:38:10 +0200468 struct msgb *msg = gprs_ns_msgb_alloc();
Harald Weltec1402a62010-05-12 11:48:44 +0200469 struct gprs_ns_hdr *nsh;
Harald Weltebfe62e52017-05-15 12:48:30 +0200470 uint16_t nsvci = osmo_htons(nsvc->nsvci);
Harald Weltec1402a62010-05-12 11:48:44 +0200471
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100472 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200473
Harald Weltebfe62e52017-05-15 12:48:30 +0200474 bvci = osmo_htons(bvci);
Harald Weltec1402a62010-05-12 11:48:44 +0200475
476 if (!msg)
477 return -ENOMEM;
478
Harald Welte90af1942010-05-15 23:02:24 +0200479 LOGP(DNS, LOGL_NOTICE, "NSEI=%u Tx NS STATUS (NSVCI=%u, cause=%s)\n",
Harald Welte6ecaa3d2010-05-12 12:01:33 +0000480 nsvc->nsei, nsvc->nsvci, gprs_ns_cause_str(cause));
481
Harald Welte144e0292010-05-13 11:45:07 +0200482 msg->l2h = msgb_put(msg, sizeof(*nsh));
483 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Weltec1402a62010-05-12 11:48:44 +0200484 nsh->pdu_type = NS_PDUT_STATUS;
485
486 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, &cause);
487
488 /* Section 9.2.7.1: Static conditions for NS-VCI */
489 if (cause == NS_CAUSE_NSVC_BLOCKED ||
490 cause == NS_CAUSE_NSVC_UNKNOWN)
491 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *)&nsvci);
492
493 /* Section 9.2.7.2: Static conditions for NS PDU */
494 switch (cause) {
495 case NS_CAUSE_SEM_INCORR_PDU:
496 case NS_CAUSE_PDU_INCOMP_PSTATE:
497 case NS_CAUSE_PROTO_ERR_UNSPEC:
498 case NS_CAUSE_INVAL_ESSENT_IE:
499 case NS_CAUSE_MISSING_ESSENT_IE:
500 msgb_tvlv_put(msg, NS_IE_PDU, msgb_l2len(orig_msg),
501 orig_msg->l2h);
502 break;
503 default:
504 break;
505 }
506
507 /* Section 9.2.7.3: Static conditions for BVCI */
508 if (cause == NS_CAUSE_BVCI_UNKNOWN)
509 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *)&bvci);
510
511 return gprs_ns_tx(nsvc, msg);
512}
513
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200514/*! Transmit a NS-BLOCK on a tiven NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100515 * \param[in] nsvc NS-VC on which the NS-BLOCK is to be transmitted
516 * \param[in] cause Numeric NS Cause value
517 * \returns 0 in case of success
518 */
Harald Welte834f26d2010-05-11 06:20:54 +0200519int gprs_ns_tx_block(struct gprs_nsvc *nsvc, uint8_t cause)
520{
Harald Welteba4c6662010-05-19 15:38:10 +0200521 struct msgb *msg = gprs_ns_msgb_alloc();
Harald Welte834f26d2010-05-11 06:20:54 +0200522 struct gprs_ns_hdr *nsh;
Harald Weltebfe62e52017-05-15 12:48:30 +0200523 uint16_t nsvci = osmo_htons(nsvc->nsvci);
Harald Welte834f26d2010-05-11 06:20:54 +0200524
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100525 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200526
Harald Welte834f26d2010-05-11 06:20:54 +0200527 if (!msg)
528 return -ENOMEM;
529
Harald Welte6ecaa3d2010-05-12 12:01:33 +0000530 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS BLOCK (NSVCI=%u, cause=%s)\n",
531 nsvc->nsei, nsvc->nsvci, gprs_ns_cause_str(cause));
532
Harald Welte834f26d2010-05-11 06:20:54 +0200533 /* be conservative and mark it as blocked even now! */
Maxc513c0f2017-10-23 15:11:14 +0200534 ns_mark_blocked(nsvc);
Harald Weltec51c23c2010-05-13 12:55:20 +0200535 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_BLOCKED]);
Harald Welte834f26d2010-05-11 06:20:54 +0200536
Harald Welte144e0292010-05-13 11:45:07 +0200537 msg->l2h = msgb_put(msg, sizeof(*nsh));
538 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte834f26d2010-05-11 06:20:54 +0200539 nsh->pdu_type = NS_PDUT_BLOCK;
540
541 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, &cause);
542 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *) &nsvci);
543
544 return gprs_ns_tx(nsvc, msg);
545}
546
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200547/*! Transmit a NS-UNBLOCK on a given NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100548 * \param[in] nsvc NS-VC on which the NS-UNBLOCK is to be transmitted
549 * \returns 0 in case of success
550 */
Harald Welte834f26d2010-05-11 06:20:54 +0200551int gprs_ns_tx_unblock(struct gprs_nsvc *nsvc)
552{
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100553 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte6ecaa3d2010-05-12 12:01:33 +0000554 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS UNBLOCK (NSVCI=%u)\n",
555 nsvc->nsei, nsvc->nsvci);
556
Harald Welte834f26d2010-05-11 06:20:54 +0200557 return gprs_ns_tx_simple(nsvc, NS_PDUT_UNBLOCK);
558}
559
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200560/*! Transmit a NS-ALIVE on a given NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100561 * \param[in] nsvc NS-VC on which the NS-ALIVE is to be transmitted
562 * \returns 0 in case of success
563 */
Harald Welteb983c312010-05-12 12:11:45 +0000564int gprs_ns_tx_alive(struct gprs_nsvc *nsvc)
565{
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100566 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welteb983c312010-05-12 12:11:45 +0000567 LOGP(DNS, LOGL_DEBUG, "NSEI=%u Tx NS ALIVE (NSVCI=%u)\n",
568 nsvc->nsei, nsvc->nsvci);
569
570 return gprs_ns_tx_simple(nsvc, NS_PDUT_ALIVE);
571}
572
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200573/*! Transmit a NS-ALIVE-ACK on a given NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100574 * \param[in] nsvc NS-VC on which the NS-ALIVE-ACK is to be transmitted
575 * \returns 0 in case of success
576 */
Harald Welteb983c312010-05-12 12:11:45 +0000577int gprs_ns_tx_alive_ack(struct gprs_nsvc *nsvc)
578{
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100579 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welteb983c312010-05-12 12:11:45 +0000580 LOGP(DNS, LOGL_DEBUG, "NSEI=%u Tx NS ALIVE_ACK (NSVCI=%u)\n",
581 nsvc->nsei, nsvc->nsvci);
582
583 return gprs_ns_tx_simple(nsvc, NS_PDUT_ALIVE_ACK);
584}
585
Harald Weltefe4ab902010-05-12 17:19:53 +0000586static const enum ns_timeout timer_mode_tout[_NSVC_TIMER_NR] = {
587 [NSVC_TIMER_TNS_RESET] = NS_TOUT_TNS_RESET,
588 [NSVC_TIMER_TNS_ALIVE] = NS_TOUT_TNS_ALIVE,
589 [NSVC_TIMER_TNS_TEST] = NS_TOUT_TNS_TEST,
Harald Welte69a4cf22010-05-03 20:55:10 +0200590};
591
Harald Welte7c24b9e2010-05-12 12:21:52 +0000592static const struct value_string timer_mode_strs[] = {
593 { NSVC_TIMER_TNS_RESET, "tns-reset" },
594 { NSVC_TIMER_TNS_ALIVE, "tns-alive" },
595 { NSVC_TIMER_TNS_TEST, "tns-test" },
596 { 0, NULL }
597};
598
Harald Welte69a4cf22010-05-03 20:55:10 +0200599static void nsvc_start_timer(struct gprs_nsvc *nsvc, enum nsvc_timer_mode mode)
600{
Harald Weltefe4ab902010-05-12 17:19:53 +0000601 enum ns_timeout tout = timer_mode_tout[mode];
602 unsigned int seconds = nsvc->nsi->timeout[tout];
603
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100604 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte4e187c62010-05-12 13:55:36 +0000605 DEBUGP(DNS, "NSEI=%u Starting timer in mode %s (%u seconds)\n",
606 nsvc->nsei, get_value_string(timer_mode_strs, mode),
Harald Weltefe4ab902010-05-12 17:19:53 +0000607 seconds);
Harald Welte7c24b9e2010-05-12 12:21:52 +0000608
Pablo Neira Ayuso2b159522011-05-06 12:11:06 +0200609 if (osmo_timer_pending(&nsvc->timer))
610 osmo_timer_del(&nsvc->timer);
Harald Welte69a4cf22010-05-03 20:55:10 +0200611
Neels Hofmeyr8e2f7e82016-09-22 03:58:13 +0200612 osmo_gettimeofday(&nsvc->timer_started, NULL);
Harald Welte69a4cf22010-05-03 20:55:10 +0200613 nsvc->timer_mode = mode;
Pablo Neira Ayuso2b159522011-05-06 12:11:06 +0200614 osmo_timer_schedule(&nsvc->timer, seconds, 0);
Harald Welte69a4cf22010-05-03 20:55:10 +0200615}
616
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200617static int nsvc_timer_elapsed_ms(struct gprs_nsvc *nsvc)
618{
619 struct timeval now, elapsed;
Neels Hofmeyr8e2f7e82016-09-22 03:58:13 +0200620 osmo_gettimeofday(&now, NULL);
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200621 timersub(&now, &nsvc->timer_started, &elapsed);
622
623 return 1000 * elapsed.tv_sec + elapsed.tv_usec / 1000;
624}
625
Harald Welte80405452010-05-03 20:16:13 +0200626static void gprs_ns_timer_cb(void *data)
Harald Welte9ba50052010-03-14 15:45:01 +0800627{
628 struct gprs_nsvc *nsvc = data;
Harald Weltefe4ab902010-05-12 17:19:53 +0000629 enum ns_timeout tout = timer_mode_tout[nsvc->timer_mode];
630 unsigned int seconds = nsvc->nsi->timeout[tout];
Harald Welte9ba50052010-03-14 15:45:01 +0800631
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100632 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte4e187c62010-05-12 13:55:36 +0000633 DEBUGP(DNS, "NSEI=%u Timer expired in mode %s (%u seconds)\n",
634 nsvc->nsei, get_value_string(timer_mode_strs, nsvc->timer_mode),
Harald Weltefe4ab902010-05-12 17:19:53 +0000635 seconds);
Harald Welte7c24b9e2010-05-12 12:21:52 +0000636
Harald Welte80405452010-05-03 20:16:13 +0200637 switch (nsvc->timer_mode) {
638 case NSVC_TIMER_TNS_ALIVE:
Harald Welte9ba50052010-03-14 15:45:01 +0800639 /* Tns-alive case: we expired without response ! */
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200640 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_LOST_ALIVE]);
Harald Welte9ba50052010-03-14 15:45:01 +0800641 nsvc->alive_retries++;
Harald Weltefe4ab902010-05-12 17:19:53 +0000642 if (nsvc->alive_retries >
643 nsvc->nsi->timeout[NS_TOUT_TNS_ALIVE_RETRIES]) {
Harald Welte9ba50052010-03-14 15:45:01 +0800644 /* mark as dead and blocked */
Maxc513c0f2017-10-23 15:11:14 +0200645 ns_set_state(nsvc, NSE_S_BLOCKED);
Harald Weltec51c23c2010-05-13 12:55:20 +0200646 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_BLOCKED]);
647 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_DEAD]);
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200648 LOGP(DNS, LOGL_NOTICE,
649 "NSEI=%u Tns-alive expired more then "
Harald Welte69a4cf22010-05-03 20:55:10 +0200650 "%u times, blocking NS-VC\n", nsvc->nsei,
Harald Weltefe4ab902010-05-12 17:19:53 +0000651 nsvc->nsi->timeout[NS_TOUT_TNS_ALIVE_RETRIES]);
Pablo Neira Ayuso2b88a2a2011-05-06 12:12:31 +0200652 ns_osmo_signal_dispatch(nsvc, S_NS_ALIVE_EXP, 0);
653 ns_osmo_signal_dispatch(nsvc, S_NS_BLOCK, NS_CAUSE_NSVC_BLOCKED);
Harald Welte9ba50052010-03-14 15:45:01 +0800654 return;
655 }
Harald Welteb983c312010-05-12 12:11:45 +0000656 /* Tns-test case: send NS-ALIVE PDU */
657 gprs_ns_tx_alive(nsvc);
658 /* start Tns-alive timer */
Harald Welte69a4cf22010-05-03 20:55:10 +0200659 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_ALIVE);
Harald Welte80405452010-05-03 20:16:13 +0200660 break;
661 case NSVC_TIMER_TNS_TEST:
Harald Welte9ba50052010-03-14 15:45:01 +0800662 /* Tns-test case: send NS-ALIVE PDU */
Harald Welteb983c312010-05-12 12:11:45 +0000663 gprs_ns_tx_alive(nsvc);
664 /* start Tns-alive timer (transition into faster
665 * alive retransmissions) */
Harald Welte7c24b9e2010-05-12 12:21:52 +0000666 nsvc->alive_retries = 0;
Harald Welte69a4cf22010-05-03 20:55:10 +0200667 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_ALIVE);
668 break;
669 case NSVC_TIMER_TNS_RESET:
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200670 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_LOST_RESET]);
Jacob Erlbeckcc6ac4c2015-12-17 13:22:36 +0100671 if (!(nsvc->state & NSE_S_RESET))
672 LOGP(DNS, LOGL_NOTICE,
673 "NSEI=%u Reset timed out but RESET flag is not set\n",
674 nsvc->nsei);
675 /* Mark NS-VC locally as blocked and dead */
Maxc513c0f2017-10-23 15:11:14 +0200676 ns_set_state(nsvc, NSE_S_BLOCKED | NSE_S_RESET);
Harald Welte69a4cf22010-05-03 20:55:10 +0200677 /* Chapter 7.3: Re-send the RESET */
Harald Welte570fb832010-05-03 21:05:24 +0200678 gprs_ns_tx_reset(nsvc, NS_CAUSE_OM_INTERVENTION);
Harald Weltec1402a62010-05-12 11:48:44 +0200679 /* Re-start Tns-reset timer */
Harald Welte69a4cf22010-05-03 20:55:10 +0200680 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_RESET);
Harald Welte80405452010-05-03 20:16:13 +0200681 break;
Harald Welte2fc725d2010-05-11 10:15:26 +0200682 case _NSVC_TIMER_NR:
683 break;
Harald Welte9ba50052010-03-14 15:45:01 +0800684 }
Harald Welte9ba50052010-03-14 15:45:01 +0800685}
686
687/* Section 9.2.6 */
Harald Weltec5478482010-03-18 00:01:43 +0800688static int gprs_ns_tx_reset_ack(struct gprs_nsvc *nsvc)
Harald Welte9ba50052010-03-14 15:45:01 +0800689{
Harald Welteba4c6662010-05-19 15:38:10 +0200690 struct msgb *msg = gprs_ns_msgb_alloc();
Harald Welte9ba50052010-03-14 15:45:01 +0800691 struct gprs_ns_hdr *nsh;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200692 uint16_t nsvci, nsei;
Harald Welte9ba50052010-03-14 15:45:01 +0800693
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100694 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte9ba50052010-03-14 15:45:01 +0800695 if (!msg)
696 return -ENOMEM;
697
Harald Weltebfe62e52017-05-15 12:48:30 +0200698 nsvci = osmo_htons(nsvc->nsvci);
699 nsei = osmo_htons(nsvc->nsei);
Harald Welte9ba50052010-03-14 15:45:01 +0800700
Harald Welte144e0292010-05-13 11:45:07 +0200701 msg->l2h = msgb_put(msg, sizeof(*nsh));
702 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +0800703
704 nsh->pdu_type = NS_PDUT_RESET_ACK;
705
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200706 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS RESET ACK (NSVCI=%u)\n",
Harald Weltebbc9fac2010-05-03 18:54:12 +0200707 nsvc->nsei, nsvc->nsvci);
Harald Weltec5478482010-03-18 00:01:43 +0800708
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200709 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *)&nsvci);
710 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *)&nsei);
Harald Welte9ba50052010-03-14 15:45:01 +0800711
Harald Welte24a655f2010-04-30 19:54:29 +0200712 return gprs_ns_tx(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800713}
714
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200715/*! High-level function for transmitting a NS-UNITDATA messsage
Harald Weltea9f23c82011-11-23 15:01:31 +0100716 * \param[in] nsi NS-instance on which we shall transmit
717 * \param[in] msg struct msgb to be trasnmitted
718 *
719 * This function obtains the NS-VC by the msgb_nsei(msg) and then checks
720 * if the NS-VC is ALIVEV and not BLOCKED. After that, it adds a NS
721 * header for the NS-UNITDATA message type and sends it off.
722 *
723 * Section 9.2.10: transmit side / NS-UNITDATA-REQUEST primitive
724 */
Harald Welte24a655f2010-04-30 19:54:29 +0200725int gprs_ns_sendmsg(struct gprs_ns_inst *nsi, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800726{
Harald Welte24a655f2010-04-30 19:54:29 +0200727 struct gprs_nsvc *nsvc;
Harald Welte9ba50052010-03-14 15:45:01 +0800728 struct gprs_ns_hdr *nsh;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200729 uint16_t bvci = msgb_bvci(msg);
Harald Welte24a655f2010-04-30 19:54:29 +0200730
Jacob Erlbeck69017152013-10-14 12:03:54 +0200731 nsvc = gprs_active_nsvc_by_nsei(nsi, msgb_nsei(msg));
Harald Welte24a655f2010-04-30 19:54:29 +0200732 if (!nsvc) {
Jacob Erlbeck69017152013-10-14 12:03:54 +0200733 int rc;
734 if (gprs_nsvc_by_nsei(nsi, msgb_nsei(msg))) {
735 LOGP(DNS, LOGL_ERROR,
736 "All NS-VCs for NSEI %u are either dead or blocked!\n",
737 msgb_nsei(msg));
738 rc = -EBUSY;
739 } else {
740 LOGP(DNS, LOGL_ERROR, "Unable to resolve NSEI %u "
741 "to NS-VC!\n", msgb_nsei(msg));
742 rc = -EINVAL;
743 }
744
Harald Weltef47df642010-08-09 21:15:40 +0800745 msgb_free(msg);
Jacob Erlbeck69017152013-10-14 12:03:54 +0200746 return rc;
Harald Welte24a655f2010-04-30 19:54:29 +0200747 }
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100748 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte9ba50052010-03-14 15:45:01 +0800749
Harald Welteec20ba42010-05-13 12:18:49 +0200750 msg->l2h = msgb_push(msg, sizeof(*nsh) + 3);
751 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +0800752 if (!nsh) {
Harald Welteb8a6a832010-05-11 05:54:22 +0200753 LOGP(DNS, LOGL_ERROR, "Not enough headroom for NS header\n");
Harald Weltef47df642010-08-09 21:15:40 +0800754 msgb_free(msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800755 return -EIO;
756 }
757
758 nsh->pdu_type = NS_PDUT_UNITDATA;
759 /* spare octet in data[0] */
760 nsh->data[1] = bvci >> 8;
761 nsh->data[2] = bvci & 0xff;
762
Harald Welte24a655f2010-04-30 19:54:29 +0200763 return gprs_ns_tx(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800764}
765
766/* Section 9.2.10: receive side */
Harald Welte24a655f2010-04-30 19:54:29 +0200767static int gprs_ns_rx_unitdata(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800768{
769 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *)msg->l2h;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200770 uint16_t bvci;
Harald Welte9ba50052010-03-14 15:45:01 +0800771
Harald Weltec1402a62010-05-12 11:48:44 +0200772 if (nsvc->state & NSE_S_BLOCKED)
773 return gprs_ns_tx_status(nsvc, NS_CAUSE_NSVC_BLOCKED,
774 0, msg);
775
Harald Welte9ba50052010-03-14 15:45:01 +0800776 /* spare octet in data[0] */
777 bvci = nsh->data[1] << 8 | nsh->data[2];
Harald Welteec19c102010-05-02 09:50:42 +0200778 msgb_bssgph(msg) = &nsh->data[3];
Harald Welte30bc19a2010-05-02 11:19:37 +0200779 msgb_bvci(msg) = bvci;
Harald Welte9ba50052010-03-14 15:45:01 +0800780
781 /* call upper layer (BSSGP) */
Harald Weltef030b212010-04-26 19:18:54 +0200782 return nsvc->nsi->cb(GPRS_NS_EVT_UNIT_DATA, nsvc, msg, bvci);
Harald Welte9ba50052010-03-14 15:45:01 +0800783}
784
785/* Section 9.2.7 */
Harald Welte24a655f2010-04-30 19:54:29 +0200786static int gprs_ns_rx_status(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800787{
Harald Weltef030b212010-04-26 19:18:54 +0200788 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +0800789 struct tlv_parsed tp;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200790 uint8_t cause;
Harald Welte9ba50052010-03-14 15:45:01 +0800791 int rc;
792
Harald Welte41337832010-05-16 00:24:26 +0200793 LOGP(DNS, LOGL_NOTICE, "NSEI=%u Rx NS STATUS ", nsvc->nsei);
Harald Welte9ba50052010-03-14 15:45:01 +0800794
Harald Weltebd33f3d2010-05-30 17:19:38 +0200795 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
796 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
Harald Welte36250382010-05-28 10:08:14 +0200797 if (rc < 0) {
798 LOGPC(DNS, LOGL_NOTICE, "Error during TLV Parse\n");
799 LOGP(DNS, LOGL_ERROR, "NSEI=%u Rx NS STATUS: "
800 "Error during TLV Parse\n", nsvc->nsei);
801 return rc;
802 }
Harald Welte9ba50052010-03-14 15:45:01 +0800803
804 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE)) {
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200805 LOGPC(DNS, LOGL_INFO, "missing cause IE\n");
Harald Welte9ba50052010-03-14 15:45:01 +0800806 return -EINVAL;
807 }
808
809 cause = *TLVP_VAL(&tp, NS_IE_CAUSE);
Harald Welte41337832010-05-16 00:24:26 +0200810 LOGPC(DNS, LOGL_NOTICE, "cause=%s\n", gprs_ns_cause_str(cause));
Harald Welte9ba50052010-03-14 15:45:01 +0800811
812 return 0;
813}
814
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200815/* Replace a nsvc object with another based on NSVCI.
816 * This function replaces looks for a NSVC with the given NSVCI and replaces it
817 * if possible and necessary. If replaced, the former value of *nsvc is
818 * returned in *old_nsvc.
819 * \return != 0 if *nsvc points to a matching NSVC.
820 */
821static int gprs_nsvc_replace_if_found(uint16_t nsvci,
822 struct gprs_nsvc **nsvc,
823 struct gprs_nsvc **old_nsvc)
824{
825 struct gprs_nsvc *matching_nsvc;
826
827 if ((*nsvc)->nsvci == nsvci) {
828 *old_nsvc = NULL;
829 return 1;
830 }
831
832 matching_nsvc = gprs_nsvc_by_nsvci((*nsvc)->nsi, nsvci);
833
834 if (!matching_nsvc)
835 return 0;
836
837 /* The NS-VCI is already used by this NS-VC */
838
839 char *old_peer;
840
841 /* Exchange the NS-VC objects */
842 *old_nsvc = *nsvc;
843 *nsvc = matching_nsvc;
844
845 /* Do logging */
846 old_peer = talloc_strdup(*old_nsvc, gprs_ns_ll_str(*old_nsvc));
847 LOGP(DNS, LOGL_INFO, "NS-VC changed link (NSVCI=%u) from %s to %s\n",
848 nsvci, old_peer, gprs_ns_ll_str(*nsvc));
849
850 talloc_free(old_peer);
851
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200852 return 1;
853}
854
Harald Welte9ba50052010-03-14 15:45:01 +0800855/* Section 7.3 */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200856static int gprs_ns_rx_reset(struct gprs_nsvc **nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800857{
858 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +0800859 struct tlv_parsed tp;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200860 uint8_t cause;
861 uint16_t nsvci, nsei;
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200862 struct gprs_nsvc *orig_nsvc = NULL;
Harald Welte9ba50052010-03-14 15:45:01 +0800863 int rc;
864
Harald Weltebd33f3d2010-05-30 17:19:38 +0200865 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
866 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
Harald Welte36250382010-05-28 10:08:14 +0200867 if (rc < 0) {
868 LOGP(DNS, LOGL_ERROR, "NSEI=%u Rx NS RESET "
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200869 "Error during TLV Parse\n", (*nsvc)->nsei);
Harald Welte36250382010-05-28 10:08:14 +0200870 return rc;
871 }
Harald Welte9ba50052010-03-14 15:45:01 +0800872
873 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE) ||
874 !TLVP_PRESENT(&tp, NS_IE_VCI) ||
875 !TLVP_PRESENT(&tp, NS_IE_NSEI)) {
Harald Welteb8a6a832010-05-11 05:54:22 +0200876 LOGP(DNS, LOGL_ERROR, "NS RESET Missing mandatory IE\n");
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200877 gprs_ns_tx_status(*nsvc, NS_CAUSE_MISSING_ESSENT_IE, 0, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800878 return -EINVAL;
879 }
880
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200881 cause = *(uint8_t *) TLVP_VAL(&tp, NS_IE_CAUSE);
Harald Weltebfe62e52017-05-15 12:48:30 +0200882 nsvci = tlvp_val16be(&tp, NS_IE_VCI);
883 nsei = tlvp_val16be(&tp, NS_IE_NSEI);
Harald Welte9ba50052010-03-14 15:45:01 +0800884
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200885 LOGP(DNS, LOGL_INFO, "NSVCI=%u%s Rx NS RESET (NSEI=%u, NSVCI=%u, cause=%s)\n",
886 (*nsvc)->nsvci, (*nsvc)->nsvci_is_valid ? "" : "(invalid)",
887 nsei, nsvci, gprs_ns_cause_str(cause));
888
Jacob Erlbeckab852ee2013-10-24 01:33:24 +0200889 if ((*nsvc)->nsvci_is_valid && (*nsvc)->nsvci != nsvci) {
890 if ((*nsvc)->persistent || (*nsvc)->remote_end_is_sgsn) {
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200891 /* The incoming RESET doesn't match the NSVCI. Send an
892 * appropriate RESET_ACK and ignore the RESET.
893 * See 3GPP TS 08.16, 7.3.1, 2nd paragraph.
894 */
895 ns_osmo_signal_dispatch_mismatch(*nsvc, msg,
896 NS_PDUT_RESET,
897 NS_IE_VCI);
898 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_INV_VCI]);
899 gprs_ns_tx_reset_ack(*nsvc);
900 return 0;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200901 }
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200902
903 /* NS-VCI has changed */
Jacob Erlbeck54b8b2d2013-10-24 01:33:25 +0200904 if (!gprs_nsvc_replace_if_found(nsvci, nsvc, &orig_nsvc)) {
905 LOGP(DNS, LOGL_INFO, "Creating NS-VC %d replacing %d "
906 "at %s\n",
907 nsvci, (*nsvc)->nsvci,
908 gprs_ns_ll_str(*nsvc));
909 orig_nsvc = *nsvc;
910 *nsvc = gprs_nsvc_create((*nsvc)->nsi, nsvci);
Jacob Erlbeck54b8b2d2013-10-24 01:33:25 +0200911 (*nsvc)->nsei = nsei;
912 }
Jacob Erlbeckab852ee2013-10-24 01:33:24 +0200913 }
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200914
Jacob Erlbeckab852ee2013-10-24 01:33:24 +0200915 if ((*nsvc)->nsvci_is_valid && (*nsvc)->nsei != nsei) {
916 if ((*nsvc)->persistent || (*nsvc)->remote_end_is_sgsn) {
917 /* The incoming RESET doesn't match the NSEI. Send an
918 * appropriate RESET_ACK and ignore the RESET.
919 * See 3GPP TS 08.16, 7.3.1, 3rd paragraph.
920 */
921 ns_osmo_signal_dispatch_mismatch(*nsvc, msg,
922 NS_PDUT_RESET,
923 NS_IE_NSEI);
924 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_INV_NSEI]);
Holger Hans Peter Freyther726e2722013-10-25 11:05:10 +0200925 rc = gprs_ns_tx_reset_ack(*nsvc);
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +0200926 CHECK_TX_RC(rc, *nsvc);
Jacob Erlbeckab852ee2013-10-24 01:33:24 +0200927 return 0;
928 }
929
930 /* NSEI has changed */
931 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_NSEI_CHG]);
932 (*nsvc)->nsei = nsei;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200933 }
Harald Weltebbc9fac2010-05-03 18:54:12 +0200934
Harald Weltec1402a62010-05-12 11:48:44 +0200935 /* Mark NS-VC as blocked and alive */
Maxc513c0f2017-10-23 15:11:14 +0200936 ns_set_state(*nsvc, NSE_S_BLOCKED | NSE_S_ALIVE);
Harald Weltee8b9ca22010-05-11 18:18:31 +0200937
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200938 if (orig_nsvc) {
Jacob Erlbeck54b8b2d2013-10-24 01:33:25 +0200939 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_REPLACED]);
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200940 ns_osmo_signal_dispatch_replaced(*nsvc, orig_nsvc);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200941
942 /* Update the ll info fields */
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200943 gprs_ns_ll_copy(*nsvc, orig_nsvc);
944 gprs_ns_ll_clear(orig_nsvc);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200945 } else {
946 (*nsvc)->nsei = nsei;
947 (*nsvc)->nsvci = nsvci;
948 (*nsvc)->nsvci_is_valid = 1;
Holger Hans Peter Freyther495b0db2015-11-04 14:39:37 +0100949 rate_ctr_group_upd_idx((*nsvc)->ctrg, nsvci);
950 osmo_stat_item_group_udp_idx((*nsvc)->statg, nsvci);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200951 }
Harald Welte9ba50052010-03-14 15:45:01 +0800952
Harald Welte834f26d2010-05-11 06:20:54 +0200953 /* inform interested parties about the fact that this NSVC
954 * has received RESET */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200955 ns_osmo_signal_dispatch(*nsvc, S_NS_RESET, cause);
Harald Welte834f26d2010-05-11 06:20:54 +0200956
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200957 rc = gprs_ns_tx_reset_ack(*nsvc);
Jacob Erlbeck05395a62013-10-08 12:04:45 +0200958
959 /* start the test procedure */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200960 gprs_ns_tx_simple((*nsvc), NS_PDUT_ALIVE);
961 nsvc_start_timer((*nsvc), NSVC_TIMER_TNS_TEST);
Jacob Erlbeck05395a62013-10-08 12:04:45 +0200962
963 return rc;
Harald Welte9ba50052010-03-14 15:45:01 +0800964}
965
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200966static int gprs_ns_rx_reset_ack(struct gprs_nsvc **nsvc, struct msgb *msg)
967{
968 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
969 struct tlv_parsed tp;
970 uint16_t nsvci, nsei;
971 struct gprs_nsvc *orig_nsvc = NULL;
972 int rc;
973
974 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
975 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
976 if (rc < 0) {
977 LOGP(DNS, LOGL_ERROR, "NSEI=%u Rx NS RESET ACK "
978 "Error during TLV Parse\n", (*nsvc)->nsei);
979 return rc;
980 }
981
982 if (!TLVP_PRESENT(&tp, NS_IE_VCI) ||
983 !TLVP_PRESENT(&tp, NS_IE_NSEI)) {
984 LOGP(DNS, LOGL_ERROR, "NS RESET ACK Missing mandatory IE\n");
Holger Hans Peter Freyther7c91bfd2013-10-25 11:02:05 +0200985 rc = gprs_ns_tx_status(*nsvc, NS_CAUSE_MISSING_ESSENT_IE, 0, msg);
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +0200986 CHECK_TX_RC(rc, *nsvc);
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200987 return -EINVAL;
988 }
989
Harald Weltebfe62e52017-05-15 12:48:30 +0200990 nsvci = tlvp_val16be(&tp, NS_IE_VCI);
991 nsei = tlvp_val16be(&tp, NS_IE_NSEI);
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200992
993 LOGP(DNS, LOGL_INFO, "NSVCI=%u%s Rx NS RESET ACK (NSEI=%u, NSVCI=%u)\n",
994 (*nsvc)->nsvci, (*nsvc)->nsvci_is_valid ? "" : "(invalid)",
995 nsei, nsvci);
996
997 if (!((*nsvc)->state & NSE_S_RESET)) {
998 /* Not waiting for a RESET_ACK on this NS-VC, ignore it.
999 * See 3GPP TS 08.16, 7.3.1, 5th paragraph.
1000 */
1001 LOGP(DNS, LOGL_ERROR,
1002 "NS RESET ACK Discarding unexpected message for "
1003 "NS-VCI %d from SGSN NSEI=%d\n",
1004 nsvci, nsei);
1005 return 0;
1006 }
1007
1008 if (!(*nsvc)->nsvci_is_valid) {
1009 LOGP(DNS, LOGL_NOTICE,
1010 "NS RESET ACK Uninitialised NS-VC (%u) for "
1011 "NS-VCI %d, NSEI=%d from %s\n",
1012 (*nsvc)->nsvci, nsvci, nsei, gprs_ns_ll_str(*nsvc));
1013 return -EINVAL;
1014 }
1015
1016 if ((*nsvc)->nsvci != nsvci) {
1017 /* NS-VCI has changed */
1018
1019 /* if !0, use another NSVC object that matches the NSVCI */
1020 int use_other_nsvc;
1021
1022 /* Only do this with BSS peers */
Jacob Erlbeckab852ee2013-10-24 01:33:24 +02001023 use_other_nsvc = !(*nsvc)->remote_end_is_sgsn &&
1024 !(*nsvc)->persistent;
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001025
1026 if (use_other_nsvc)
1027 /* Update *nsvc to point to the right NSVC object */
1028 use_other_nsvc = gprs_nsvc_replace_if_found(nsvci, nsvc,
1029 &orig_nsvc);
1030
1031 if (!use_other_nsvc) {
1032 /* The incoming RESET_ACK doesn't match the NSVCI.
1033 * See 3GPP TS 08.16, 7.3.1, 4th paragraph.
1034 */
1035 ns_osmo_signal_dispatch_mismatch(*nsvc, msg,
1036 NS_PDUT_RESET_ACK,
1037 NS_IE_VCI);
1038 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_INV_VCI]);
1039 LOGP(DNS, LOGL_ERROR,
1040 "NS RESET ACK Unknown NS-VCI %d (%s NSEI=%d) "
1041 "from %s\n",
1042 nsvci,
1043 (*nsvc)->remote_end_is_sgsn ? "SGSN" : "BSS",
1044 nsei, gprs_ns_ll_str(*nsvc));
1045 return -EINVAL;
1046 }
1047
1048 /* Notify others */
Jacob Erlbeck54b8b2d2013-10-24 01:33:25 +02001049 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_REPLACED]);
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001050 ns_osmo_signal_dispatch_replaced(*nsvc, orig_nsvc);
1051
1052 /* Update the ll info fields */
1053 gprs_ns_ll_copy(*nsvc, orig_nsvc);
1054 gprs_ns_ll_clear(orig_nsvc);
1055 } else if ((*nsvc)->nsei != nsei) {
Jacob Erlbeckab852ee2013-10-24 01:33:24 +02001056 if ((*nsvc)->persistent || (*nsvc)->remote_end_is_sgsn) {
1057 /* The incoming RESET_ACK doesn't match the NSEI.
1058 * See 3GPP TS 08.16, 7.3.1, 4th paragraph.
1059 */
1060 ns_osmo_signal_dispatch_mismatch(*nsvc, msg,
1061 NS_PDUT_RESET_ACK,
1062 NS_IE_NSEI);
1063 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_INV_NSEI]);
1064 LOGP(DNS, LOGL_ERROR,
1065 "NS RESET ACK Unknown NSEI %d (NS-VCI=%u) from %s\n",
1066 nsei, nsvci, gprs_ns_ll_str(*nsvc));
1067 return -EINVAL;
1068 }
1069
1070 /* NSEI has changed */
1071 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_NSEI_CHG]);
1072 (*nsvc)->nsei = nsei;
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001073 }
1074
1075 /* Mark NS-VC as blocked and alive */
Maxc513c0f2017-10-23 15:11:14 +02001076 ns_set_state(*nsvc, NSE_S_BLOCKED | NSE_S_ALIVE);
1077 ns_set_remote_state(*nsvc, NSE_S_BLOCKED | NSE_S_ALIVE);
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001078 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_BLOCKED]);
1079 if ((*nsvc)->persistent || (*nsvc)->remote_end_is_sgsn) {
1080 /* stop RESET timer */
1081 osmo_timer_del(&(*nsvc)->timer);
1082 }
1083 /* Initiate TEST proc.: Send ALIVE and start timer */
1084 rc = gprs_ns_tx_simple(*nsvc, NS_PDUT_ALIVE);
1085 nsvc_start_timer(*nsvc, NSVC_TIMER_TNS_TEST);
1086
1087 return rc;
1088}
1089
Harald Welte834f26d2010-05-11 06:20:54 +02001090static int gprs_ns_rx_block(struct gprs_nsvc *nsvc, struct msgb *msg)
1091{
1092 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
1093 struct tlv_parsed tp;
1094 uint8_t *cause;
1095 int rc;
1096
Harald Weltee4ecc8c2010-05-12 00:16:57 +02001097 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS BLOCK\n", nsvc->nsei);
Harald Welte834f26d2010-05-11 06:20:54 +02001098
Maxc513c0f2017-10-23 15:11:14 +02001099 ns_mark_blocked(nsvc);
Harald Welte834f26d2010-05-11 06:20:54 +02001100
Harald Weltebd33f3d2010-05-30 17:19:38 +02001101 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
1102 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
Harald Welte36250382010-05-28 10:08:14 +02001103 if (rc < 0) {
1104 LOGP(DNS, LOGL_ERROR, "NSEI=%u Rx NS BLOCK "
1105 "Error during TLV Parse\n", nsvc->nsei);
1106 return rc;
1107 }
Harald Welte834f26d2010-05-11 06:20:54 +02001108
1109 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE) ||
1110 !TLVP_PRESENT(&tp, NS_IE_VCI)) {
Harald Welte834f26d2010-05-11 06:20:54 +02001111 LOGP(DNS, LOGL_ERROR, "NS RESET Missing mandatory IE\n");
Harald Weltec1402a62010-05-12 11:48:44 +02001112 gprs_ns_tx_status(nsvc, NS_CAUSE_MISSING_ESSENT_IE, 0, msg);
Harald Welte834f26d2010-05-11 06:20:54 +02001113 return -EINVAL;
1114 }
1115
1116 cause = (uint8_t *) TLVP_VAL(&tp, NS_IE_CAUSE);
1117 //nsvci = (uint16_t *) TLVP_VAL(&tp, NS_IE_VCI);
1118
Pablo Neira Ayuso2b88a2a2011-05-06 12:12:31 +02001119 ns_osmo_signal_dispatch(nsvc, S_NS_BLOCK, *cause);
Harald Weltec51c23c2010-05-13 12:55:20 +02001120 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_BLOCKED]);
Harald Welte834f26d2010-05-11 06:20:54 +02001121
1122 return gprs_ns_tx_simple(nsvc, NS_PDUT_BLOCK_ACK);
1123}
1124
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001125int gprs_ns_vc_create(struct gprs_ns_inst *nsi, struct msgb *msg,
1126 struct gprs_nsvc *fallback_nsvc,
1127 struct gprs_nsvc **new_nsvc);
1128
1129int gprs_ns_process_msg(struct gprs_ns_inst *nsi, struct msgb *msg,
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001130 struct gprs_nsvc **nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001131
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001132/*! Receive incoming NS message from underlying transport layer
Harald Weltea9f23c82011-11-23 15:01:31 +01001133 * \param nsi NS instance to which the data belongs
1134 * \param[in] msg message buffer containing newly-received data
1135 * \param[in] saddr socketaddr from which data was received
1136 * \param[in] ll link-layer type in which data was received
1137 * \returns 0 in case of success, < 0 in case of error
1138 *
1139 * This is the main entry point int othe NS imlementation where frames
1140 * from the underlying transport (normally UDP) enter.
1141 */
Harald Weltef030b212010-04-26 19:18:54 +02001142int gprs_ns_rcvmsg(struct gprs_ns_inst *nsi, struct msgb *msg,
Harald Welteb3ee2652010-05-19 14:38:50 +02001143 struct sockaddr_in *saddr, enum gprs_ns_ll ll)
Harald Welte9ba50052010-03-14 15:45:01 +08001144{
Harald Weltef030b212010-04-26 19:18:54 +02001145 struct gprs_nsvc *nsvc;
Harald Welte9ba50052010-03-14 15:45:01 +08001146 int rc = 0;
1147
Harald Weltef030b212010-04-26 19:18:54 +02001148 /* look up the NSVC based on source address */
1149 nsvc = nsvc_by_rem_addr(nsi, saddr);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001150
Harald Weltef030b212010-04-26 19:18:54 +02001151 if (!nsvc) {
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001152 struct gprs_nsvc *fallback_nsvc;
1153
1154 fallback_nsvc = nsi->unknown_nsvc;
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +01001155 log_set_context(LOG_CTX_GB_NSVC, fallback_nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001156 fallback_nsvc->ip.bts_addr = *saddr;
1157 fallback_nsvc->ll = ll;
1158
1159 rc = gprs_ns_vc_create(nsi, msg, fallback_nsvc, &nsvc);
1160
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001161 if (rc < 0)
Harald Welte36250382010-05-28 10:08:14 +02001162 return rc;
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001163
1164 rc = 0;
1165 }
1166
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001167 if (nsvc)
1168 rc = gprs_ns_process_msg(nsi, msg, &nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001169
1170 return rc;
1171}
1172
Jacob Erlbeck96550e02013-10-14 22:06:47 +02001173const char *gprs_ns_ll_str(struct gprs_nsvc *nsvc)
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001174{
1175 static char buf[80];
1176 snprintf(buf, sizeof(buf), "%s:%u",
1177 inet_ntoa(nsvc->ip.bts_addr.sin_addr),
Harald Weltebfe62e52017-05-15 12:48:30 +02001178 osmo_ntohs(nsvc->ip.bts_addr.sin_port));
Holger Hans Peter Freyther0cccf402013-10-25 11:00:23 +02001179 buf[sizeof(buf) - 1] = '\0';
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001180
1181 return buf;
1182}
1183
Jacob Erlbeck96550e02013-10-14 22:06:47 +02001184void gprs_ns_ll_copy(struct gprs_nsvc *nsvc, struct gprs_nsvc *other)
1185{
1186 nsvc->ll = other->ll;
1187
1188 switch (nsvc->ll) {
1189 case GPRS_NS_LL_UDP:
1190 nsvc->ip = other->ip;
1191 break;
1192 case GPRS_NS_LL_FR_GRE:
1193 nsvc->frgre = other->frgre;
1194 break;
1195 default:
1196 break;
1197 }
1198}
1199
1200void gprs_ns_ll_clear(struct gprs_nsvc *nsvc)
1201{
1202 switch (nsvc->ll) {
1203 case GPRS_NS_LL_UDP:
1204 nsvc->ip.bts_addr.sin_addr.s_addr = INADDR_ANY;
1205 nsvc->ip.bts_addr.sin_port = 0;
1206 break;
1207 case GPRS_NS_LL_FR_GRE:
1208 nsvc->frgre.bts_addr.sin_addr.s_addr = INADDR_ANY;
1209 nsvc->frgre.bts_addr.sin_port = 0;
1210 break;
1211 default:
1212 break;
1213 }
1214}
1215
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001216/*! Create/get NS-VC independently from underlying transport layer
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001217 * \param nsi NS instance to which the data belongs
1218 * \param[in] msg message buffer containing newly-received data
1219 * \param[in] fallback_nsvc is used to send error messages back to the peer
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001220 * and to initialise the ll info of a created NS-VC object
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001221 * \param[out] new_nsvc contains a pointer to a NS-VC object if one has
1222 * been created or found
1223 * \returns < 0 in case of error, GPRS_NS_CS_SKIPPED if a message has been
1224 * skipped, GPRS_NS_CS_REJECTED if a message has been rejected and
1225 * answered accordingly, GPRS_NS_CS_CREATED if a new NS-VC object
1226 * has been created and registered, and GPRS_NS_CS_FOUND if an
1227 * existing NS-VC object has been found with the same NSEI.
1228 *
1229 * This contains the initial NS automaton state (NS-VC not yet attached).
1230 */
1231int gprs_ns_vc_create(struct gprs_ns_inst *nsi, struct msgb *msg,
1232 struct gprs_nsvc *fallback_nsvc,
1233 struct gprs_nsvc **new_nsvc)
1234{
1235 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *)msg->l2h;
1236 struct gprs_nsvc *existing_nsvc;
1237
1238 struct tlv_parsed tp;
Jacob Erlbeckb6390f92013-10-08 12:04:46 +02001239 uint16_t nsvci;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001240 uint16_t nsei;
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001241
1242 int rc;
1243
1244 if (nsh->pdu_type == NS_PDUT_STATUS) {
Jacob Erlbeck3d557b12013-10-28 13:29:11 +01001245 /* Do not respond, see 3GPP TS 08.16, 7.5.1 */
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001246 LOGP(DNS, LOGL_INFO, "Ignoring NS STATUS from %s "
1247 "for non-existing NS-VC\n",
Jacob Erlbeck96550e02013-10-14 22:06:47 +02001248 gprs_ns_ll_str(fallback_nsvc));
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001249 return GPRS_NS_CS_SKIPPED;
1250 }
1251
Jacob Erlbeck3d557b12013-10-28 13:29:11 +01001252 if (nsh->pdu_type == NS_PDUT_ALIVE_ACK) {
1253 /* Ignore this, see 3GPP TS 08.16, 7.4.1 */
1254 LOGP(DNS, LOGL_INFO, "Ignoring NS ALIVE ACK from %s "
1255 "for non-existing NS-VC\n",
1256 gprs_ns_ll_str(fallback_nsvc));
1257 return GPRS_NS_CS_SKIPPED;
1258 }
1259
1260 if (nsh->pdu_type == NS_PDUT_RESET_ACK) {
1261 /* Ignore this, see 3GPP TS 08.16, 7.3.1 */
1262 LOGP(DNS, LOGL_INFO, "Ignoring NS RESET ACK from %s "
1263 "for non-existing NS-VC\n",
1264 gprs_ns_ll_str(fallback_nsvc));
1265 return GPRS_NS_CS_SKIPPED;
1266 }
1267
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001268 /* Only the RESET procedure creates a new NSVC */
1269 if (nsh->pdu_type != NS_PDUT_RESET) {
1270 /* Since we have no NSVC, we have to use a fake */
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +01001271 log_set_context(LOG_CTX_GB_NSVC, fallback_nsvc);
Max584f4b62017-05-04 11:59:52 +02001272 LOGP(DNS, LOGL_INFO, "Rejecting NS PDU type %s "
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001273 "from %s for non-existing NS-VC\n",
Max584f4b62017-05-04 11:59:52 +02001274 get_value_string(gprs_ns_pdu_strings, nsh->pdu_type), gprs_ns_ll_str(fallback_nsvc));
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001275 fallback_nsvc->nsvci = fallback_nsvc->nsei = 0xfffe;
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001276 fallback_nsvc->nsvci_is_valid = 0;
Maxc513c0f2017-10-23 15:11:14 +02001277 ns_set_state(fallback_nsvc, NSE_S_ALIVE);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001278
1279 rc = gprs_ns_tx_status(fallback_nsvc,
1280 NS_CAUSE_PDU_INCOMP_PSTATE, 0, msg);
1281 if (rc < 0) {
1282 LOGP(DNS, LOGL_ERROR, "TX failed (%d) to peer %s\n",
Jacob Erlbeck96550e02013-10-14 22:06:47 +02001283 rc, gprs_ns_ll_str(fallback_nsvc));
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001284 return rc;
1285 }
1286 return GPRS_NS_CS_REJECTED;
1287 }
1288
1289 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
1290 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
1291 if (rc < 0) {
1292 LOGP(DNS, LOGL_ERROR, "Rx NS RESET Error %d during "
1293 "TLV Parse\n", rc);
1294 return rc;
1295 }
1296 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE) ||
1297 !TLVP_PRESENT(&tp, NS_IE_VCI) || !TLVP_PRESENT(&tp, NS_IE_NSEI)) {
1298 LOGP(DNS, LOGL_ERROR, "NS RESET Missing mandatory IE\n");
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +02001299 rc = gprs_ns_tx_status(fallback_nsvc, NS_CAUSE_MISSING_ESSENT_IE, 0,
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001300 msg);
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +02001301 CHECK_TX_RC(rc, fallback_nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001302 return -EINVAL;
1303 }
Harald Weltebfe62e52017-05-15 12:48:30 +02001304 nsvci = tlvp_val16be(&tp, NS_IE_VCI);
1305 nsei = tlvp_val16be(&tp, NS_IE_NSEI);
Jacob Erlbeckb6390f92013-10-08 12:04:46 +02001306 /* Check if we already know this NSVCI, the remote end might
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001307 * simply have changed addresses, or it is a SGSN */
Jacob Erlbeckb6390f92013-10-08 12:04:46 +02001308 existing_nsvc = gprs_nsvc_by_nsvci(nsi, nsvci);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001309 if (!existing_nsvc) {
1310 *new_nsvc = gprs_nsvc_create(nsi, 0xffff);
Jacob Erlbeck9b591b72013-11-11 09:43:05 +01001311 (*new_nsvc)->nsvci_is_valid = 0;
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +01001312 log_set_context(LOG_CTX_GB_NSVC, *new_nsvc);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001313 gprs_ns_ll_copy(*new_nsvc, fallback_nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001314 LOGP(DNS, LOGL_INFO, "Creating NS-VC for BSS at %s\n",
Jacob Erlbeck96550e02013-10-14 22:06:47 +02001315 gprs_ns_ll_str(fallback_nsvc));
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001316
1317 return GPRS_NS_CS_CREATED;
1318 }
1319
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001320 /* Check NSEI */
1321 if (existing_nsvc->nsei != nsei) {
1322 LOGP(DNS, LOGL_NOTICE,
1323 "NS-VC changed NSEI (NSVCI=%u) from %u to %u\n",
1324 nsvci, existing_nsvc->nsei, nsei);
1325
1326 /* Override old NSEI */
1327 existing_nsvc->nsei = nsei;
1328
1329 /* Do statistics */
1330 rate_ctr_inc(&existing_nsvc->ctrg->ctr[NS_CTR_NSEI_CHG]);
1331 }
1332
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001333 *new_nsvc = existing_nsvc;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001334 gprs_ns_ll_copy(*new_nsvc, fallback_nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001335 return GPRS_NS_CS_FOUND;
1336}
1337
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001338/*! Process NS message independently from underlying transport layer
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001339 * \param nsi NS instance to which the data belongs
1340 * \param[in] msg message buffer containing newly-received data
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001341 * \param[inout] nsvc refers to the virtual connection, may be modified when
1342 * processing a NS_RESET
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001343 * \returns 0 in case of success, < 0 in case of error
1344 *
1345 * This contains the main NS automaton.
1346 */
1347int gprs_ns_process_msg(struct gprs_ns_inst *nsi, struct msgb *msg,
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001348 struct gprs_nsvc **nsvc)
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001349{
1350 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
1351 int rc = 0;
1352
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001353 msgb_nsei(msg) = (*nsvc)->nsei;
Harald Weltec5478482010-03-18 00:01:43 +08001354
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +01001355 log_set_context(LOG_CTX_GB_NSVC, *nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +02001356
Harald Welte144e0292010-05-13 11:45:07 +02001357 /* Increment number of Incoming bytes */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001358 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_PKTS_IN]);
1359 rate_ctr_add(&(*nsvc)->ctrg->ctr[NS_CTR_BYTES_IN], msgb_l2len(msg));
Harald Welte144e0292010-05-13 11:45:07 +02001360
Harald Welte9ba50052010-03-14 15:45:01 +08001361 switch (nsh->pdu_type) {
1362 case NS_PDUT_ALIVE:
Harald Welte2bffac52010-05-12 15:55:23 +00001363 /* If we're dead and blocked and suddenly receive a
1364 * NS-ALIVE out of the blue, we might have been re-started
1365 * and should send a NS-RESET to make sure everything recovers
1366 * fine. */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001367 if ((*nsvc)->state == NSE_S_BLOCKED)
Jacob Erlbeck6ac70a42014-10-07 14:12:30 +02001368 rc = gprs_nsvc_reset((*nsvc), NS_CAUSE_PDU_INCOMP_PSTATE);
1369 else if (!((*nsvc)->state & NSE_S_RESET))
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001370 rc = gprs_ns_tx_alive_ack(*nsvc);
Harald Welte9ba50052010-03-14 15:45:01 +08001371 break;
1372 case NS_PDUT_ALIVE_ACK:
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +02001373 if ((*nsvc)->timer_mode == NSVC_TIMER_TNS_ALIVE)
Jacob Erlbeckfc9533d2015-10-29 00:55:58 +01001374 osmo_stat_item_set((*nsvc)->statg->items[NS_STAT_ALIVE_DELAY],
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +02001375 nsvc_timer_elapsed_ms(*nsvc));
Harald Welte90af1942010-05-15 23:02:24 +02001376 /* stop Tns-alive and start Tns-test */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001377 nsvc_start_timer(*nsvc, NSVC_TIMER_TNS_TEST);
1378 if ((*nsvc)->remote_end_is_sgsn) {
Harald Welte7fb7e612010-05-03 21:11:22 +02001379 /* FIXME: this should be one level higher */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001380 if ((*nsvc)->state & NSE_S_BLOCKED)
1381 rc = gprs_ns_tx_unblock(*nsvc);
Harald Welte7fb7e612010-05-03 21:11:22 +02001382 }
Harald Welte9ba50052010-03-14 15:45:01 +08001383 break;
1384 case NS_PDUT_UNITDATA:
1385 /* actual user data */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001386 rc = gprs_ns_rx_unitdata(*nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001387 break;
1388 case NS_PDUT_STATUS:
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001389 rc = gprs_ns_rx_status(*nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001390 break;
1391 case NS_PDUT_RESET:
Harald Welte24a655f2010-04-30 19:54:29 +02001392 rc = gprs_ns_rx_reset(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001393 break;
1394 case NS_PDUT_RESET_ACK:
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001395 rc = gprs_ns_rx_reset_ack(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001396 break;
1397 case NS_PDUT_UNBLOCK:
1398 /* Section 7.2: unblocking procedure */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001399 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS UNBLOCK\n", (*nsvc)->nsei);
Maxc513c0f2017-10-23 15:11:14 +02001400 ns_mark_unblocked(*nsvc);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001401 ns_osmo_signal_dispatch(*nsvc, S_NS_UNBLOCK, 0);
1402 rc = gprs_ns_tx_simple(*nsvc, NS_PDUT_UNBLOCK_ACK);
Harald Welte9ba50052010-03-14 15:45:01 +08001403 break;
1404 case NS_PDUT_UNBLOCK_ACK:
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001405 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS UNBLOCK ACK\n", (*nsvc)->nsei);
Harald Weltec1402a62010-05-12 11:48:44 +02001406 /* mark NS-VC as unblocked + active */
Maxc513c0f2017-10-23 15:11:14 +02001407 ns_set_state(*nsvc, NSE_S_ALIVE);
1408 ns_set_remote_state(*nsvc, NSE_S_ALIVE);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001409 ns_osmo_signal_dispatch(*nsvc, S_NS_UNBLOCK, 0);
Harald Welte9ba50052010-03-14 15:45:01 +08001410 break;
1411 case NS_PDUT_BLOCK:
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001412 rc = gprs_ns_rx_block(*nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001413 break;
1414 case NS_PDUT_BLOCK_ACK:
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001415 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS BLOCK ACK\n", (*nsvc)->nsei);
Harald Weltef030b212010-04-26 19:18:54 +02001416 /* mark remote NS-VC as blocked + active */
Maxc513c0f2017-10-23 15:11:14 +02001417 ns_set_remote_state(*nsvc, NSE_S_BLOCKED | NSE_S_ALIVE);
Harald Welte9ba50052010-03-14 15:45:01 +08001418 break;
1419 default:
Harald Weltee4ecc8c2010-05-12 00:16:57 +02001420 LOGP(DNS, LOGL_NOTICE, "NSEI=%u Rx Unknown NS PDU type 0x%02x\n",
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001421 (*nsvc)->nsei, nsh->pdu_type);
Harald Welte9ba50052010-03-14 15:45:01 +08001422 rc = -EINVAL;
1423 break;
1424 }
1425 return rc;
1426}
1427
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001428/*! Create a new GPRS NS instance
Harald Weltea9f23c82011-11-23 15:01:31 +01001429 * \param[in] cb Call-back function for incoming BSSGP data
1430 * \returns dynamically allocated gprs_ns_inst
1431 */
Harald Welte4fcdd762012-06-16 16:40:42 +08001432struct gprs_ns_inst *gprs_ns_instantiate(gprs_ns_cb_t *cb, void *ctx)
Harald Weltef030b212010-04-26 19:18:54 +02001433{
Harald Welte4fcdd762012-06-16 16:40:42 +08001434 struct gprs_ns_inst *nsi = talloc_zero(ctx, struct gprs_ns_inst);
Harald Weltef030b212010-04-26 19:18:54 +02001435
1436 nsi->cb = cb;
1437 INIT_LLIST_HEAD(&nsi->gprs_nsvcs);
Harald Weltefe4ab902010-05-12 17:19:53 +00001438 nsi->timeout[NS_TOUT_TNS_BLOCK] = 3;
1439 nsi->timeout[NS_TOUT_TNS_BLOCK_RETRIES] = 3;
1440 nsi->timeout[NS_TOUT_TNS_RESET] = 3;
1441 nsi->timeout[NS_TOUT_TNS_RESET_RETRIES] = 3;
1442 nsi->timeout[NS_TOUT_TNS_TEST] = 30;
1443 nsi->timeout[NS_TOUT_TNS_ALIVE] = 3;
1444 nsi->timeout[NS_TOUT_TNS_ALIVE_RETRIES] = 10;
Harald Weltef030b212010-04-26 19:18:54 +02001445
Harald Welte60cc6ac2010-05-13 14:20:56 +02001446 /* Create the dummy NSVC that we use for sending
1447 * messages to non-existant/unknown NS-VC's */
Harald Weltef5430362012-06-17 12:25:53 +08001448 nsi->unknown_nsvc = gprs_nsvc_create(nsi, 0xfffe);
Jacob Erlbeck9b591b72013-11-11 09:43:05 +01001449 nsi->unknown_nsvc->nsvci_is_valid = 0;
Harald Welte60cc6ac2010-05-13 14:20:56 +02001450 llist_del(&nsi->unknown_nsvc->list);
Holger Hans Peter Freyther777b0562014-07-07 20:00:35 +02001451 INIT_LLIST_HEAD(&nsi->unknown_nsvc->list);
Harald Weltedd1c83c2010-05-13 13:58:08 +02001452
Harald Welte3771d092010-04-30 20:26:32 +02001453 return nsi;
Harald Weltef030b212010-04-26 19:18:54 +02001454}
1455
Holger Hans Peter Freytherc62a1bf2013-07-02 09:10:11 +02001456void gprs_ns_close(struct gprs_ns_inst *nsi)
Harald Weltef030b212010-04-26 19:18:54 +02001457{
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001458 struct gprs_nsvc *nsvc, *nsvc2;
Harald Weltef030b212010-04-26 19:18:54 +02001459
Holger Hans Peter Freyther777b0562014-07-07 20:00:35 +02001460 gprs_nsvc_delete(nsi->unknown_nsvc);
1461
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001462 /* delete all NSVCs and clear their timers */
1463 llist_for_each_entry_safe(nsvc, nsvc2, &nsi->gprs_nsvcs, list)
1464 gprs_nsvc_delete(nsvc);
1465
1466 /* close socket and unregister */
1467 if (nsi->nsip.fd.data) {
1468 close(nsi->nsip.fd.fd);
1469 osmo_fd_unregister(&nsi->nsip.fd);
Holger Hans Peter Freytherc62a1bf2013-07-02 09:10:11 +02001470 nsi->nsip.fd.data = NULL;
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001471 }
Holger Hans Peter Freytherc62a1bf2013-07-02 09:10:11 +02001472}
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001473
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001474/*! Destroy an entire NS instance
Holger Hans Peter Freytherc62a1bf2013-07-02 09:10:11 +02001475 * \param nsi gprs_ns_inst that is to be destroyed
1476 *
1477 * This function releases all resources associated with the
1478 * NS-instance.
1479 */
1480void gprs_ns_destroy(struct gprs_ns_inst *nsi)
1481{
1482 gprs_ns_close(nsi);
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001483 /* free the NSI */
Harald Weltef030b212010-04-26 19:18:54 +02001484 talloc_free(nsi);
1485}
1486
1487
1488/* NS-over-IP code, according to 3GPP TS 48.016 Chapter 6.2
1489 * We don't support Size Procedure, Configuration Procedure, ChangeWeight Procedure */
1490
1491/* Read a single NS-over-IP message */
Pablo Neira Ayusobfadfb72011-05-06 12:11:23 +02001492static struct msgb *read_nsip_msg(struct osmo_fd *bfd, int *error,
Harald Weltef030b212010-04-26 19:18:54 +02001493 struct sockaddr_in *saddr)
1494{
Harald Welteba4c6662010-05-19 15:38:10 +02001495 struct msgb *msg = gprs_ns_msgb_alloc();
Harald Weltef030b212010-04-26 19:18:54 +02001496 int ret = 0;
1497 socklen_t saddr_len = sizeof(*saddr);
1498
1499 if (!msg) {
1500 *error = -ENOMEM;
1501 return NULL;
1502 }
1503
Holger Hans Peter Freyther26c32512010-05-28 03:25:36 +08001504 ret = recvfrom(bfd->fd, msg->data, NS_ALLOC_SIZE - NS_ALLOC_HEADROOM, 0,
Harald Weltef030b212010-04-26 19:18:54 +02001505 (struct sockaddr *)saddr, &saddr_len);
1506 if (ret < 0) {
Harald Welteb8a6a832010-05-11 05:54:22 +02001507 LOGP(DNS, LOGL_ERROR, "recv error %s during NSIP recv\n",
Harald Weltebbc9fac2010-05-03 18:54:12 +02001508 strerror(errno));
Harald Weltef030b212010-04-26 19:18:54 +02001509 msgb_free(msg);
1510 *error = ret;
1511 return NULL;
1512 } else if (ret == 0) {
1513 msgb_free(msg);
1514 *error = ret;
1515 return NULL;
1516 }
1517
1518 msg->l2h = msg->data;
1519 msgb_put(msg, ret);
1520
1521 return msg;
1522}
1523
Pablo Neira Ayusobfadfb72011-05-06 12:11:23 +02001524static int handle_nsip_read(struct osmo_fd *bfd)
Harald Weltef030b212010-04-26 19:18:54 +02001525{
1526 int error;
1527 struct sockaddr_in saddr;
1528 struct gprs_ns_inst *nsi = bfd->data;
1529 struct msgb *msg = read_nsip_msg(bfd, &error, &saddr);
1530
1531 if (!msg)
1532 return error;
1533
Harald Welteb3ee2652010-05-19 14:38:50 +02001534 error = gprs_ns_rcvmsg(nsi, msg, &saddr, GPRS_NS_LL_UDP);
Harald Welte91813cf2010-05-12 18:38:45 +00001535
1536 msgb_free(msg);
1537
1538 return error;
Harald Weltef030b212010-04-26 19:18:54 +02001539}
1540
Pablo Neira Ayusobfadfb72011-05-06 12:11:23 +02001541static int handle_nsip_write(struct osmo_fd *bfd)
Harald Weltef030b212010-04-26 19:18:54 +02001542{
1543 /* FIXME: actually send the data here instead of nsip_sendmsg() */
1544 return -EIO;
1545}
1546
Harald Welteb3ee2652010-05-19 14:38:50 +02001547static int nsip_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Weltef030b212010-04-26 19:18:54 +02001548{
1549 int rc;
1550 struct gprs_ns_inst *nsi = nsvc->nsi;
1551 struct sockaddr_in *daddr = &nsvc->ip.bts_addr;
1552
1553 rc = sendto(nsi->nsip.fd.fd, msg->data, msg->len, 0,
1554 (struct sockaddr *)daddr, sizeof(*daddr));
1555
Holger Hans Peter Freyther52746462012-03-01 20:30:32 +01001556 msgb_free(msg);
Harald Weltef030b212010-04-26 19:18:54 +02001557
1558 return rc;
1559}
1560
1561/* UDP Port 23000 carries the LLC-in-BSSGP-in-NS protocol stack */
Pablo Neira Ayusobfadfb72011-05-06 12:11:23 +02001562static int nsip_fd_cb(struct osmo_fd *bfd, unsigned int what)
Harald Weltef030b212010-04-26 19:18:54 +02001563{
1564 int rc = 0;
1565
1566 if (what & BSC_FD_READ)
1567 rc = handle_nsip_read(bfd);
1568 if (what & BSC_FD_WRITE)
1569 rc = handle_nsip_write(bfd);
1570
1571 return rc;
1572}
1573
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001574/*! Create a listening socket for GPRS NS/UDP/IP
Harald Weltea9f23c82011-11-23 15:01:31 +01001575 * \param[in] nsi NS protocol instance to listen
1576 * \returns >=0 (fd) in case of success, negative in case of error
1577 *
1578 * A call to this function will create a UDP socket bound to the port
1579 * number and IP address specified in the NS protocol instance. The
1580 * file descriptor of the socket will be stored in nsi->nsip.fd.
1581 */
Harald Welte7fb05232010-05-19 15:09:09 +02001582int gprs_ns_nsip_listen(struct gprs_ns_inst *nsi)
Harald Weltef030b212010-04-26 19:18:54 +02001583{
Harald Welte73952e32012-06-16 14:59:56 +08001584 struct in_addr in;
Philipp Maier224a6dd2017-10-17 15:23:53 +02001585 struct in_addr remote;
1586 char remote_str[INET_ADDRSTRLEN];
Harald Weltef030b212010-04-26 19:18:54 +02001587 int ret;
1588
Harald Weltebfe62e52017-05-15 12:48:30 +02001589 in.s_addr = osmo_htonl(nsi->nsip.local_ip);
Philipp Maier224a6dd2017-10-17 15:23:53 +02001590 remote.s_addr = osmo_htonl(nsi->nsip.remote_ip);
Harald Welte73952e32012-06-16 14:59:56 +08001591
1592 nsi->nsip.fd.cb = nsip_fd_cb;
1593 nsi->nsip.fd.data = nsi;
Philipp Maier224a6dd2017-10-17 15:23:53 +02001594
1595 if (nsi->nsip.remote_ip && nsi->nsip.remote_port) {
1596 /* connect to ensure only we only accept packets from the
1597 * configured remote end/peer */
1598 snprintf(remote_str, sizeof(remote_str), "%s", inet_ntoa(remote));
1599 ret =
1600 osmo_sock_init2_ofd(&nsi->nsip.fd, AF_INET, SOCK_DGRAM,
1601 IPPROTO_UDP, inet_ntoa(in),
1602 nsi->nsip.local_port, remote_str,
1603 nsi->nsip.remote_port, OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT);
1604
1605 LOGP(DNS, LOGL_NOTICE,
1606 "Listening for nsip packets from %s:%u on %s:%u\n",
1607 remote_str, nsi->nsip.remote_port, inet_ntoa(in), nsi->nsip.local_port);
1608 } else {
1609 /* Accept UDP packets from any source IP/Port */
1610 ret = osmo_sock_init_ofd(&nsi->nsip.fd, AF_INET, SOCK_DGRAM,
1611 IPPROTO_UDP, inet_ntoa(in), nsi->nsip.local_port, OSMO_SOCK_F_BIND);
1612
1613 LOGP(DNS, LOGL_NOTICE, "Listening for nsip packets on %s:%u\n", inet_ntoa(in), nsi->nsip.local_port);
1614 }
1615
Harald Weltef030b212010-04-26 19:18:54 +02001616 if (ret < 0)
1617 return ret;
1618
Holger Hans Peter Freyther2c3393d2013-03-25 11:59:58 +01001619 ret = setsockopt(nsi->nsip.fd.fd, IPPROTO_IP, IP_TOS,
1620 &nsi->nsip.dscp, sizeof(nsi->nsip.dscp));
1621 if (ret < 0)
1622 LOGP(DNS, LOGL_ERROR,
1623 "Failed to set the DSCP to %d with ret(%d) errno(%d)\n",
1624 nsi->nsip.dscp, ret, errno);
1625
Maxa19c1262017-10-20 15:39:45 +02001626 LOGP(DNS, LOGL_NOTICE, "NS UDP socket at %s:%d\n", inet_ntoa(in), nsi->nsip.local_port);
Harald Weltef030b212010-04-26 19:18:54 +02001627
1628 return ret;
1629}
Harald Welte3771d092010-04-30 20:26:32 +02001630
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001631/*! Initiate a RESET procedure
Harald Weltea9f23c82011-11-23 15:01:31 +01001632 * \param[in] nsvc NS-VC in which to start the procedure
1633 * \param[in] cause Numeric NS cause value
1634 *
1635 * This is a high-level function initiating a NS-RESET procedure. It
1636 * will not only send a NS-RESET, but also set the state to BLOCKED and
1637 * start the Tns-reset timer.
1638 */
Jacob Erlbeck0540d832014-10-08 11:47:36 +02001639int gprs_nsvc_reset(struct gprs_nsvc *nsvc, uint8_t cause)
Harald Welte731d1fc2010-05-14 11:53:08 +00001640{
Jacob Erlbeck0540d832014-10-08 11:47:36 +02001641 int rc;
1642
Harald Welteb1020d52010-05-25 22:17:30 +02001643 LOGP(DNS, LOGL_INFO, "NSEI=%u RESET procedure based on API request\n",
1644 nsvc->nsei);
1645
Harald Welte731d1fc2010-05-14 11:53:08 +00001646 /* Mark NS-VC locally as blocked and dead */
Maxc513c0f2017-10-23 15:11:14 +02001647 ns_set_state(nsvc, NSE_S_BLOCKED | NSE_S_RESET);
Jacob Erlbeck6ac70a42014-10-07 14:12:30 +02001648
Harald Welte731d1fc2010-05-14 11:53:08 +00001649 /* Send NS-RESET PDU */
Jacob Erlbeck0540d832014-10-08 11:47:36 +02001650 rc = gprs_ns_tx_reset(nsvc, cause);
1651 if (rc < 0) {
Harald Welte731d1fc2010-05-14 11:53:08 +00001652 LOGP(DNS, LOGL_ERROR, "NSEI=%u, error resetting NS-VC\n",
1653 nsvc->nsei);
1654 }
1655 /* Start Tns-reset */
1656 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_RESET);
Jacob Erlbeck0540d832014-10-08 11:47:36 +02001657
1658 return rc;
Harald Welte731d1fc2010-05-14 11:53:08 +00001659}
1660
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001661/*! Establish a NS connection (from the BSS) to the SGSN
Harald Weltea9f23c82011-11-23 15:01:31 +01001662 * \param nsi NS-instance
1663 * \param[in] dest Destination IP/Port
1664 * \param[in] nsei NSEI of the to-be-established NS-VC
1665 * \param[in] nsvci NSVCI of the to-be-established NS-VC
1666 * \returns struct gprs_nsvc representing the new NS-VC
1667 *
1668 * This function will establish a single NS/UDP/IP connection in uplink
1669 * (BSS to SGSN) direction.
1670 */
Harald Weltef5430362012-06-17 12:25:53 +08001671struct gprs_nsvc *gprs_ns_nsip_connect(struct gprs_ns_inst *nsi,
Harald Welte1203de32010-05-01 11:28:43 +02001672 struct sockaddr_in *dest, uint16_t nsei,
1673 uint16_t nsvci)
Harald Welte3771d092010-04-30 20:26:32 +02001674{
1675 struct gprs_nsvc *nsvc;
1676
1677 nsvc = nsvc_by_rem_addr(nsi, dest);
Harald Welte38407ef2010-05-12 11:56:39 +00001678 if (!nsvc)
Harald Weltef5430362012-06-17 12:25:53 +08001679 nsvc = gprs_nsvc_create(nsi, nsvci);
Harald Welte38407ef2010-05-12 11:56:39 +00001680 nsvc->ip.bts_addr = *dest;
Harald Welte1203de32010-05-01 11:28:43 +02001681 nsvc->nsei = nsei;
Harald Welte3771d092010-04-30 20:26:32 +02001682 nsvc->remote_end_is_sgsn = 1;
1683
Holger Hans Peter Freyther5617d992010-05-23 21:18:01 +08001684 gprs_nsvc_reset(nsvc, NS_CAUSE_OM_INTERVENTION);
1685 return nsvc;
Harald Welte3771d092010-04-30 20:26:32 +02001686}
Harald Weltea9f23c82011-11-23 15:01:31 +01001687
Harald Weltecca49632012-06-16 17:45:59 +08001688void gprs_ns_set_log_ss(int ss)
1689{
1690 DNS = ss;
1691}
1692
Harald Welte96e2a002017-06-12 21:44:18 +02001693/*! @} */