blob: cee48855400ae6cb3d0f899b05ed21f47dbc54b1 [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.
Harald Welte17a642d2018-07-01 19:09:52 +02003 * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05)
4 * as well as its successor 3GPP TS 48.016 */
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02005/*
Harald Welte17a642d2018-07-01 19:09:52 +02006 * (C) 2009-2018 by Harald Welte <laforge@gnumonks.org>
Harald Weltee08da972017-11-13 01:00:26 +09007 * (C) 2016-2017 sysmocom - s.f.m.c. GmbH
Harald Welte9ba50052010-03-14 15:45:01 +08008 *
9 * All Rights Reserved
10 *
Harald Weltee08da972017-11-13 01:00:26 +090011 * SPDX-License-Identifier: GPL-2.0+
12 *
Harald Welte9ba50052010-03-14 15:45:01 +080013 * This program is free software; you can redistribute it and/or modify
Harald Welte7fa89c22014-10-26 20:33:09 +010014 * it under the terms of the GNU General Public License as published by
15 * the Free Software Foundation; either version 2 of the License, or
Harald Welte9ba50052010-03-14 15:45:01 +080016 * (at your option) any later version.
17 *
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Harald Welte7fa89c22014-10-26 20:33:09 +010021 * GNU General Public License for more details.
Harald Welte9ba50052010-03-14 15:45:01 +080022 *
Harald Welte7fa89c22014-10-26 20:33:09 +010023 * You should have received a copy of the GNU General Public License
Harald Weltee4cbb3f2011-01-01 15:25:50 +010024 * along with this program. If not, see <http://www.gnu.org/licenses/>.
Harald Welte9ba50052010-03-14 15:45:01 +080025 *
26 */
27
Harald Weltea9f23c82011-11-23 15:01:31 +010028/*! \addtogroup libgb
29 * @{
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020030 *
Harald Weltea9f23c82011-11-23 15:01:31 +010031 * GPRS Networks Service (NS) messages on the Gb interface
32 * 3GPP TS 08.16 version 8.0.1 Release 1999 / ETSI TS 101 299 V8.0.1 (2002-05)
33 *
34 * Some introduction into NS: NS is used typically on top of frame relay,
Harald Welte9ba50052010-03-14 15:45:01 +080035 * but in the ip.access world it is encapsulated in UDP packets. It serves
36 * as an intermediate shim betwen BSSGP and the underlying medium. It doesn't
37 * do much, apart from providing congestion notification and status indication.
38 *
39 * Terms:
Harald Welte9ba50052010-03-14 15:45:01 +080040 *
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020041 * NS Network Service
42 * NSVC NS Virtual Connection
43 * NSEI NS Entity Identifier
44 * NSVL NS Virtual Link
45 * NSVLI NS Virtual Link Identifier
46 * BVC BSSGP Virtual Connection
47 * BVCI BSSGP Virtual Connection Identifier
48 * NSVCG NS Virtual Connection Goup
49 * Blocked NS-VC cannot be used for user traffic
50 * Alive Ability of a NS-VC to provide communication
51 *
52 * There can be multiple BSSGP virtual connections over one (group of) NSVC's. BSSGP will
Harald Welte9ba50052010-03-14 15:45:01 +080053 * therefore identify the BSSGP virtual connection by a BVCI passed down to NS.
54 * NS then has to firgure out which NSVC's are responsible for this BVCI.
55 * Those mappings are administratively configured.
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020056 *
57 * This implementation has the following limitations:
58 * - Only one NS-VC for each NSE: No load-sharing function
59 * - NSVCI 65535 and 65534 are reserved for internal use
60 * - Only UDP is supported as of now, no frame relay support
Neels Hofmeyr17518fe2017-06-20 04:35:06 +020061 * - There are no BLOCK and UNBLOCK timers (yet?)
62 *
63 * \file gprs_ns.c */
Harald Weltedd1c83c2010-05-13 13:58:08 +020064
Harald Welte9ba50052010-03-14 15:45:01 +080065#include <stdlib.h>
66#include <unistd.h>
67#include <errno.h>
Harald Welte8f9a3ee2010-05-02 11:26:34 +020068#include <stdint.h>
Harald Welte9ba50052010-03-14 15:45:01 +080069
Holger Hans Peter Freyther3c16de22012-07-12 14:13:41 +020070#include <sys/types.h>
71#include <sys/socket.h>
Harald Welte9ba50052010-03-14 15:45:01 +080072#include <arpa/inet.h>
73
Harald Welte047f3872018-07-01 21:04:45 +020074#include <osmocom/core/fsm.h>
Pablo Neira Ayusoff663232011-03-22 16:47:59 +010075#include <osmocom/core/msgb.h>
Harald Weltebfe62e52017-05-15 12:48:30 +020076#include <osmocom/core/byteswap.h>
Pablo Neira Ayusoff663232011-03-22 16:47:59 +010077#include <osmocom/gsm/tlv.h>
78#include <osmocom/core/talloc.h>
79#include <osmocom/core/select.h>
80#include <osmocom/core/rate_ctr.h>
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +020081#include <osmocom/core/stat_item.h>
Jacob Erlbeckbc9d9ac2015-11-02 14:49:35 +010082#include <osmocom/core/stats.h>
Harald Welte73952e32012-06-16 14:59:56 +080083#include <osmocom/core/socket.h>
Harald Welte4fcdd762012-06-16 16:40:42 +080084#include <osmocom/core/signal.h>
Harald Welte73952e32012-06-16 14:59:56 +080085#include <osmocom/gprs/gprs_ns.h>
86#include <osmocom/gprs/gprs_bssgp.h>
87#include <osmocom/gprs/gprs_ns_frgre.h>
88
Harald Weltecca49632012-06-16 17:45:59 +080089#include "common_vty.h"
Harald Welte17a642d2018-07-01 19:09:52 +020090#include "gb_internal.h"
Harald Welte9ba50052010-03-14 15:45:01 +080091
Neels Hofmeyr983dcb92018-08-20 12:33:22 +020092#define ns_set_state(ns_, st_) ns_set_state_with_log(ns_, st_, false, __FILE__, __LINE__)
93#define ns_set_remote_state(ns_, st_) ns_set_state_with_log(ns_, st_, true, __FILE__, __LINE__)
Maxc513c0f2017-10-23 15:11:14 +020094#define ns_mark_blocked(ns_) ns_set_state(ns_, (ns_)->state | NSE_S_BLOCKED)
95#define ns_mark_unblocked(ns_) ns_set_state(ns_, (ns_)->state & (~NSE_S_BLOCKED));
Harald Welte047f3872018-07-01 21:04:45 +020096#define ns_mark_alive(ns_) ns_set_state(ns_, (ns_)->state | NSE_S_ALIVE)
97#define ns_mark_dead(ns_) ns_set_state(ns_, (ns_)->state & (~NSE_S_ALIVE));
98
99#define ERR_IF_NSVC_USES_SNS(nsvc, reason) \
100 do { \
101 if ((nsvc)->nsi->bss_sns_fi) { \
102 LOGP(DNS, LOGL_ERROR, "NSEI=%u Asked to %s. Rejected on IP-SNS\n", \
103 nsvc->nsei, reason); \
104 osmo_log_backtrace(DNS, LOGL_ERROR); \
105 return -EIO; \
106 } \
107 } while (0)
Maxc513c0f2017-10-23 15:11:14 +0200108
Harald Welte9ba50052010-03-14 15:45:01 +0800109static const struct tlv_definition ns_att_tlvdef = {
110 .def = {
111 [NS_IE_CAUSE] = { TLV_TYPE_TvLV, 0 },
112 [NS_IE_VCI] = { TLV_TYPE_TvLV, 0 },
113 [NS_IE_PDU] = { TLV_TYPE_TvLV, 0 },
114 [NS_IE_BVCI] = { TLV_TYPE_TvLV, 0 },
115 [NS_IE_NSEI] = { TLV_TYPE_TvLV, 0 },
Harald Welte17a642d2018-07-01 19:09:52 +0200116 [NS_IE_IPv4_LIST] = { TLV_TYPE_TvLV, 0 },
117 [NS_IE_IPv6_LIST] = { TLV_TYPE_TvLV, 0 },
118 [NS_IE_MAX_NR_NSVC] = { TLV_TYPE_FIXED, 2 },
119 [NS_IE_IPv4_EP_NR] = { TLV_TYPE_FIXED, 2 },
120 [NS_IE_IPv6_EP_NR] = { TLV_TYPE_FIXED, 2 },
121 [NS_IE_RESET_FLAG] = { TLV_TYPE_TV, 0 },
Harald Welte047f3872018-07-01 21:04:45 +0200122 /* TODO: IP_ADDR can be 5 or 17 bytes long, depending on first byte. This
123 * cannot be expressed in our TLV parser. However, we don't do IPv6 anyway */
124 [NS_IE_IP_ADDR] = { TLV_TYPE_FIXED, 5 },
Harald Welte9ba50052010-03-14 15:45:01 +0800125 },
126};
127
Harald Weltec51c23c2010-05-13 12:55:20 +0200128enum ns_ctr {
129 NS_CTR_PKTS_IN,
130 NS_CTR_PKTS_OUT,
131 NS_CTR_BYTES_IN,
132 NS_CTR_BYTES_OUT,
133 NS_CTR_BLOCKED,
134 NS_CTR_DEAD,
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200135 NS_CTR_REPLACED,
136 NS_CTR_NSEI_CHG,
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200137 NS_CTR_INV_VCI,
138 NS_CTR_INV_NSEI,
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200139 NS_CTR_LOST_ALIVE,
140 NS_CTR_LOST_RESET,
Harald Weltec51c23c2010-05-13 12:55:20 +0200141};
142
Harald Welte144e0292010-05-13 11:45:07 +0200143static const struct rate_ctr_desc nsvc_ctr_description[] = {
Harald Weltea7a50652017-10-03 17:49:21 +0800144 { "packets:in", "Packets at NS Level ( In)" },
145 { "packets:out","Packets at NS Level (Out)" },
146 { "bytes:in", "Bytes at NS Level ( In)" },
147 { "bytes:out", "Bytes at NS Level (Out)" },
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200148 { "blocked", "NS-VC Block count " },
149 { "dead", "NS-VC gone dead count " },
150 { "replaced", "NS-VC replaced other count" },
Jacob Erlbeckab852ee2013-10-24 01:33:24 +0200151 { "nsei-chg", "NS-VC changed NSEI count " },
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200152 { "inv-nsvci", "NS-VCI was invalid count " },
153 { "inv-nsei", "NSEI was invalid count " },
Harald Weltea7a50652017-10-03 17:49:21 +0800154 { "lost:alive", "ALIVE ACK missing count " },
155 { "lost:reset", "RESET ACK missing count " },
Harald Welte144e0292010-05-13 11:45:07 +0200156};
157
158static const struct rate_ctr_group_desc nsvc_ctrg_desc = {
Harald Weltea7a50652017-10-03 17:49:21 +0800159 .group_name_prefix = "ns:nsvc",
Harald Welte144e0292010-05-13 11:45:07 +0200160 .group_description = "NSVC Peer Statistics",
161 .num_ctr = ARRAY_SIZE(nsvc_ctr_description),
162 .ctr_desc = nsvc_ctr_description,
Jacob Erlbeckfed2a482015-11-03 16:18:56 +0100163 .class_id = OSMO_STATS_CLASS_PEER,
Harald Welte144e0292010-05-13 11:45:07 +0200164};
165
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200166enum ns_stat {
167 NS_STAT_ALIVE_DELAY,
168};
169
Jacob Erlbeckfc9533d2015-10-29 00:55:58 +0100170static const struct osmo_stat_item_desc nsvc_stat_description[] = {
Thorsten Alteholza81055d2017-03-02 22:13:48 +0100171 { "alive.delay", "ALIVE response time ", "ms", 16, 0 },
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200172};
173
Jacob Erlbeckfc9533d2015-10-29 00:55:58 +0100174static const struct osmo_stat_item_group_desc nsvc_statg_desc = {
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200175 .group_name_prefix = "ns.nsvc",
176 .group_description = "NSVC Peer Statistics",
177 .num_items = ARRAY_SIZE(nsvc_stat_description),
178 .item_desc = nsvc_stat_description,
Jacob Erlbeckbc9d9ac2015-11-02 14:49:35 +0100179 .class_id = OSMO_STATS_CLASS_PEER,
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200180};
181
Max54ca30c2017-05-22 14:48:27 +0200182const struct value_string gprs_ns_signal_ns_names[] = {
183 { S_NS_RESET, "NS-RESET" },
184 { S_NS_BLOCK, "NS-BLOCK" },
185 { S_NS_UNBLOCK, "NS-UNBLOCK" },
186 { S_NS_ALIVE_EXP, "NS-ALIVE expired" },
187 { S_NS_REPLACED, "NSVC replaced" },
188 { S_NS_MISMATCH, "Unexpected IE" },
Harald Welte047f3872018-07-01 21:04:45 +0200189 { S_SNS_CONFIGURED, "SNS Configured" },
Max54ca30c2017-05-22 14:48:27 +0200190 { 0, NULL }
191};
192
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +0200193#define CHECK_TX_RC(rc, nsvc) \
194 if (rc < 0) \
195 LOGP(DNS, LOGL_ERROR, "TX failed (%d) to peer %s\n", \
196 rc, gprs_ns_ll_str(nsvc));
197
Harald Welte94c9b442019-03-16 14:38:19 +0100198static bool nsvc_is_not_used(const struct gprs_nsvc *nsvc)
199{
200 if (nsvc->data_weight == 0 && nsvc->sig_weight == 0)
201 return true;
202 else
203 return false;
204}
205
Jacob Erlbeck8d192d72015-04-07 17:52:45 +0200206struct msgb *gprs_ns_msgb_alloc(void)
207{
208 struct msgb *msg = msgb_alloc_headroom(NS_ALLOC_SIZE, NS_ALLOC_HEADROOM,
209 "GPRS/NS");
210 if (!msg) {
211 LOGP(DNS, LOGL_ERROR, "Failed to allocate NS message of size %d\n",
212 NS_ALLOC_SIZE);
213 }
214 return msg;
215}
216
Maxc513c0f2017-10-23 15:11:14 +0200217/* FIXME: convert to osmo_fsm */
218static inline void ns_set_state_with_log(struct gprs_nsvc *nsvc, uint32_t state, bool is_remote,
219 const char *file, unsigned line)
220{
221 uint32_t old_state = is_remote ? nsvc->remote_state : nsvc->state;
222
223 LOGPSRC(DNS, LOGL_DEBUG, file, line, "NSEI %d (NS-VCI=%u) setting %sstate [%s,%s,%s] -> [%s,%s,%s]\n",
224 nsvc->nsei, nsvc->nsvci, is_remote ? "remote " : "",
225 NS_DESC_A(old_state), NS_DESC_B(old_state), NS_DESC_R(old_state),
226 NS_DESC_A(state), NS_DESC_B(state), NS_DESC_R(state));
227
228 if (is_remote)
229 nsvc->remote_state = state;
230 else
231 nsvc->state = state;
232}
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +0200233
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200234/*! Lookup struct gprs_nsvc based on NSVCI
Harald Weltea9f23c82011-11-23 15:01:31 +0100235 * \param[in] nsi NS instance in which to search
236 * \param[in] nsvci NSVCI to be searched
237 * \returns gprs_nsvc of respective NSVCI
238 */
Harald Weltef5430362012-06-17 12:25:53 +0800239struct gprs_nsvc *gprs_nsvc_by_nsvci(struct gprs_ns_inst *nsi, uint16_t nsvci)
Harald Weltef030b212010-04-26 19:18:54 +0200240{
241 struct gprs_nsvc *nsvc;
242 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
243 if (nsvc->nsvci == nsvci)
244 return nsvc;
245 }
246 return NULL;
247}
248
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200249/*! Lookup struct gprs_nsvc based on NSEI
Harald Weltea9f23c82011-11-23 15:01:31 +0100250 * \param[in] nsi NS instance in which to search
251 * \param[in] nsei NSEI to be searched
Jacob Erlbeck69017152013-10-14 12:03:54 +0200252 * \returns first gprs_nsvc of respective NSEI
Harald Weltea9f23c82011-11-23 15:01:31 +0100253 */
Harald Weltef5430362012-06-17 12:25:53 +0800254struct gprs_nsvc *gprs_nsvc_by_nsei(struct gprs_ns_inst *nsi, uint16_t nsei)
Harald Welte24a655f2010-04-30 19:54:29 +0200255{
256 struct gprs_nsvc *nsvc;
257 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
258 if (nsvc->nsei == nsei)
259 return nsvc;
260 }
261 return NULL;
262}
263
Harald Welte047f3872018-07-01 21:04:45 +0200264/*! Determine active NS-VC for given NSEI + BVCI.
265 * Use this function to determine which of the NS-VCs inside the NS Instance
266 * shall be used to transmit data for given NSEI + BVCI */
Jacob Erlbeck69017152013-10-14 12:03:54 +0200267static struct gprs_nsvc *gprs_active_nsvc_by_nsei(struct gprs_ns_inst *nsi,
Harald Welte047f3872018-07-01 21:04:45 +0200268 uint16_t nsei, uint16_t bvci)
Jacob Erlbeck69017152013-10-14 12:03:54 +0200269{
270 struct gprs_nsvc *nsvc;
271 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
Harald Welte047f3872018-07-01 21:04:45 +0200272 /* if signalling BVCI, skip any NSVC with signalling weight == 0 */
273 if (bvci == 0 && nsvc->sig_weight == 0)
274 continue;
275 /* if point-to-point BVCI, skip any NSVC with data weight == 0 */
276 if (bvci != 0 && nsvc->data_weight == 0)
277 continue;
Jacob Erlbeck69017152013-10-14 12:03:54 +0200278 if (nsvc->nsei == nsei) {
Jacob Erlbeckbf021962013-10-17 13:58:35 +0200279 if (!(nsvc->state & NSE_S_BLOCKED) &&
280 nsvc->state & NSE_S_ALIVE)
Jacob Erlbeck69017152013-10-14 12:03:54 +0200281 return nsvc;
282 }
283 }
284 return NULL;
285}
286
Harald Welte047f3872018-07-01 21:04:45 +0200287/*! Lookup NS-VC based on specified remote peer socket addr.
288 * \param[in] nsi NS Instance within which we shall look up the NS-VC
289 * \param[in] sin Remote peer Socket Address (IP + UDP Port)
290 * \returns NS-VC matching the given peer; NULL in case of none */
291struct gprs_nsvc *gprs_nsvc_by_rem_addr(struct gprs_ns_inst *nsi, const struct sockaddr_in *sin)
Harald Weltef030b212010-04-26 19:18:54 +0200292{
293 struct gprs_nsvc *nsvc;
294 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
Harald Welte38407ef2010-05-12 11:56:39 +0000295 if (nsvc->ip.bts_addr.sin_addr.s_addr ==
296 sin->sin_addr.s_addr &&
297 nsvc->ip.bts_addr.sin_port == sin->sin_port)
Harald Weltef030b212010-04-26 19:18:54 +0200298 return nsvc;
299 }
300 return NULL;
301}
302
Harald Welte69a4cf22010-05-03 20:55:10 +0200303static void gprs_ns_timer_cb(void *data);
304
Harald Welte047f3872018-07-01 21:04:45 +0200305/*! Create a new NS-VC (Virtual Circuit) within given instance
306 * \param[in] nsi NS Instance in which to create the NSVC
307 * \param[in] nsvci] NS Virtual Connection Identifier for this NSVC
308 * \param[in] sig_weight Signalling Weight of this NS-VC. Use "0" for no signalling
309 * \param[in] data_weight Data WEight of this NS-VC. Use "0" for no data
310 * \returns newly-created gprs_nsvc within nsi. NULL on error. */
311struct gprs_nsvc *gprs_nsvc_create2(struct gprs_ns_inst *nsi, uint16_t nsvci,
312 uint8_t sig_weight, uint8_t data_weight)
Harald Weltef030b212010-04-26 19:18:54 +0200313{
314 struct gprs_nsvc *nsvc;
315
Harald Welte047f3872018-07-01 21:04:45 +0200316 if (gprs_nsvc_by_nsvci(nsi, nsvci)) {
317 LOGP(DNS, LOGL_ERROR, "Cannot create NS-VC for already-existing NSVCI=%u\n", nsvci);
318 return NULL;
319 }
320
Harald Welteb1020d52010-05-25 22:17:30 +0200321 LOGP(DNS, LOGL_INFO, "NSVCI=%u Creating NS-VC\n", nsvci);
322
Harald Weltef030b212010-04-26 19:18:54 +0200323 nsvc = talloc_zero(nsi, struct gprs_nsvc);
Harald Welte047f3872018-07-01 21:04:45 +0200324 if (!nsvc)
325 return NULL;
Harald Weltef030b212010-04-26 19:18:54 +0200326 nsvc->nsvci = nsvci;
Jacob Erlbeck9b591b72013-11-11 09:43:05 +0100327 nsvc->nsvci_is_valid = 1;
Harald Weltef030b212010-04-26 19:18:54 +0200328 /* before RESET procedure: BLOCKED and DEAD */
Harald Welte047f3872018-07-01 21:04:45 +0200329 if (nsi->bss_sns_fi)
330 ns_set_state(nsvc, 0);
331 else
332 ns_set_state(nsvc, NSE_S_BLOCKED);
Harald Weltef030b212010-04-26 19:18:54 +0200333 nsvc->nsi = nsi;
Pablo Neira Ayuso44f423f2017-05-08 18:00:28 +0200334 osmo_timer_setup(&nsvc->timer, gprs_ns_timer_cb, nsvc);
Harald Welte144e0292010-05-13 11:45:07 +0200335 nsvc->ctrg = rate_ctr_group_alloc(nsvc, &nsvc_ctrg_desc, nsvci);
Harald Welte6d3135c2019-05-08 14:00:37 +0200336 if (!nsvc->ctrg) {
337 talloc_free(nsvc);
338 return NULL;
339 }
Jacob Erlbeckfc9533d2015-10-29 00:55:58 +0100340 nsvc->statg = osmo_stat_item_group_alloc(nsvc, &nsvc_statg_desc, nsvci);
Harald Welte047f3872018-07-01 21:04:45 +0200341 nsvc->sig_weight = sig_weight;
342 nsvc->data_weight = data_weight;
Harald Welte69a4cf22010-05-03 20:55:10 +0200343
Harald Weltef030b212010-04-26 19:18:54 +0200344 llist_add(&nsvc->list, &nsi->gprs_nsvcs);
345
346 return nsvc;
347}
Harald Welte9ba50052010-03-14 15:45:01 +0800348
Harald Welte047f3872018-07-01 21:04:45 +0200349/*! Old API for creating a NS-VC. Uses gprs_nsvc_create2 with fixed weights. */
350struct gprs_nsvc *gprs_nsvc_create(struct gprs_ns_inst *nsi, uint16_t nsvci)
351{
352 return gprs_nsvc_create2(nsi, nsvci, 1, 1);
353}
354
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200355/*! Delete given NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100356 * \param[in] nsvc gprs_nsvc to be deleted
357 */
Harald Weltef5430362012-06-17 12:25:53 +0800358void gprs_nsvc_delete(struct gprs_nsvc *nsvc)
Harald Welte2bffac52010-05-12 15:55:23 +0000359{
Pablo Neira Ayuso2b159522011-05-06 12:11:06 +0200360 if (osmo_timer_pending(&nsvc->timer))
361 osmo_timer_del(&nsvc->timer);
Harald Welte2bffac52010-05-12 15:55:23 +0000362 llist_del(&nsvc->list);
Jacob Erlbecka52ba012013-10-24 01:33:21 +0200363 rate_ctr_group_free(nsvc->ctrg);
Jacob Erlbeck0975a7f2015-12-17 09:51:53 +0100364 osmo_stat_item_group_free(nsvc->statg);
Harald Welte2bffac52010-05-12 15:55:23 +0000365 talloc_free(nsvc);
366}
367
Pablo Neira Ayuso2b88a2a2011-05-06 12:12:31 +0200368static void ns_osmo_signal_dispatch(struct gprs_nsvc *nsvc, unsigned int signal,
Harald Welte834f26d2010-05-11 06:20:54 +0200369 uint8_t cause)
370{
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200371 struct ns_signal_data nssd = {0};
Harald Welte834f26d2010-05-11 06:20:54 +0200372
373 nssd.nsvc = nsvc;
374 nssd.cause = cause;
375
Harald Welte4fcdd762012-06-16 16:40:42 +0800376 osmo_signal_dispatch(SS_L_NS, signal, &nssd);
Harald Welte834f26d2010-05-11 06:20:54 +0200377}
378
Jacob Erlbeck5405a102013-10-24 01:33:23 +0200379static void ns_osmo_signal_dispatch_mismatch(struct gprs_nsvc *nsvc,
380 struct msgb *msg,
381 uint8_t pdu_type, uint8_t ie_type)
382{
383 struct ns_signal_data nssd = {0};
384
385 nssd.nsvc = nsvc;
386 nssd.pdu_type = pdu_type;
387 nssd.ie_type = ie_type;
388 nssd.msg = msg;
389
390 osmo_signal_dispatch(SS_L_NS, S_NS_MISMATCH, &nssd);
391}
392
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +0200393static void ns_osmo_signal_dispatch_replaced(struct gprs_nsvc *nsvc, struct gprs_nsvc *old_nsvc)
394{
395 struct ns_signal_data nssd = {0};
396
397 nssd.nsvc = nsvc;
398 nssd.old_nsvc = old_nsvc;
399
400 osmo_signal_dispatch(SS_L_NS, S_NS_REPLACED, &nssd);
401}
402
Max584f4b62017-05-04 11:59:52 +0200403const struct value_string gprs_ns_pdu_strings[] = {
404 /* 3GPP TS 48.016 §9.2 Network Service Control PDUs */
405 { NS_PDUT_UNITDATA, "NS-UNITDATA" }, /* §9.2.1 */
406 { NS_PDUT_RESET, "NS-RESET" }, /* §9.2.5 */
407 { NS_PDUT_RESET_ACK, "NS-RESET-ACK" }, /* §9.2.6 */
408 { NS_PDUT_BLOCK, "NS-BLOCK" }, /* §9.2.3 */
409 { NS_PDUT_BLOCK_ACK, "NS-BLOCK-ACK" }, /* §9.2.4 */
410 { NS_PDUT_UNBLOCK, "NS-UNBLOCK" }, /* §9.2.8 */
411 { NS_PDUT_UNBLOCK_ACK, "NS-UNBLOCK-ACK" }, /* §9.2.9 */
412 { NS_PDUT_STATUS, "NS-STATUS" }, /* §9.2.7 */
413 { NS_PDUT_ALIVE, "NS-ALIVE" }, /* §9.2.1 */
414 { NS_PDUT_ALIVE_ACK, "NS-ALIVE-ACK" }, /* §9.2.2 */
415 /* 3GPP TS 48.016 §9.3 Sub-Network Service Control PDUs */
416 { SNS_PDUT_ACK, "SNS-ACK" }, /* §9.3.1 */
417 { SNS_PDUT_ADD, "SNS-ADD" }, /* §9.3.2 */
418 { SNS_PDUT_CHANGE_WEIGHT, "SNS-CHANGEWEIGHT" }, /* §9.3.3 */
419 { SNS_PDUT_CONFIG, "SNS-CONFIG" }, /* §9.3.4 */
420 { SNS_PDUT_CONFIG_ACK, "SNS-CONFIG-ACK" }, /* §9.3.5 */
421 { SNS_PDUT_DELETE, "SNS-DELETE" }, /* §9.3.6 */
422 { SNS_PDUT_SIZE, "SNS-SIZE" }, /* §9.3.7 */
423 { SNS_PDUT_SIZE_ACK, "SNS-SIZE-ACK" }, /* §9.3.8 */
424 { 0, NULL }
425};
426
Harald Welte9ba50052010-03-14 15:45:01 +0800427/* Section 10.3.2, Table 13 */
Harald Welte2577d412010-05-02 09:37:45 +0200428static const struct value_string ns_cause_str[] = {
429 { NS_CAUSE_TRANSIT_FAIL, "Transit network failure" },
430 { NS_CAUSE_OM_INTERVENTION, "O&M intervention" },
431 { NS_CAUSE_EQUIP_FAIL, "Equipment failure" },
432 { NS_CAUSE_NSVC_BLOCKED, "NS-VC blocked" },
433 { NS_CAUSE_NSVC_UNKNOWN, "NS-VC unknown" },
434 { NS_CAUSE_BVCI_UNKNOWN, "BVCI unknown" },
435 { NS_CAUSE_SEM_INCORR_PDU, "Semantically incorrect PDU" },
436 { NS_CAUSE_PDU_INCOMP_PSTATE, "PDU not compatible with protocol state" },
Harald Welte69a4cf22010-05-03 20:55:10 +0200437 { NS_CAUSE_PROTO_ERR_UNSPEC, "Protocol error, unspecified" },
Harald Welte2577d412010-05-02 09:37:45 +0200438 { NS_CAUSE_INVAL_ESSENT_IE, "Invalid essential IE" },
439 { NS_CAUSE_MISSING_ESSENT_IE, "Missing essential IE" },
Harald Welte47cf21f2019-02-23 13:42:06 +0100440 { NS_CAUSE_INVAL_NR_IPv4_EP, "Invalid Number of IPv4 Endpoints" },
441 { NS_CAUSE_INVAL_NR_IPv6_EP, "Invalid Number of IPv6 Endpoints" },
442 { NS_CAUSE_INVAL_NR_NS_VC, "Invalid Number of NS-VCs" },
443 { NS_CAUSE_INVAL_WEIGH, "Invalid Weights" },
444 { NS_CAUSE_UNKN_IP_EP, "Unknown IP Endpoint" },
445 { NS_CAUSE_UNKN_IP_ADDR, "Unknown IP Address" },
446 { NS_CAUSE_UNKN_IP_TEST_FAILED, "IP Test Failed" },
Harald Welte2577d412010-05-02 09:37:45 +0200447 { 0, NULL }
Harald Welte9ba50052010-03-14 15:45:01 +0800448};
449
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200450/*! Obtain a human-readable string for NS cause value */
Harald Welte2577d412010-05-02 09:37:45 +0200451const char *gprs_ns_cause_str(enum ns_cause cause)
Harald Welte9ba50052010-03-14 15:45:01 +0800452{
Harald Welte2577d412010-05-02 09:37:45 +0200453 return get_value_string(ns_cause_str, cause);
Harald Welte9ba50052010-03-14 15:45:01 +0800454}
455
Harald Welte24a655f2010-04-30 19:54:29 +0200456static int nsip_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg);
Harald Welteb3ee2652010-05-19 14:38:50 +0200457extern int grps_ns_frgre_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg);
Harald Weltef030b212010-04-26 19:18:54 +0200458
Harald Welte94c9b442019-03-16 14:38:19 +0100459static bool ns_is_sns(uint8_t pdu_type)
460{
461 switch (pdu_type) {
462 case SNS_PDUT_CONFIG:
463 case SNS_PDUT_ACK:
464 case SNS_PDUT_ADD:
465 case SNS_PDUT_CHANGE_WEIGHT:
466 case SNS_PDUT_DELETE:
467 case SNS_PDUT_CONFIG_ACK:
468 case SNS_PDUT_SIZE:
469 case SNS_PDUT_SIZE_ACK:
470 return true;
471 default:
472 return false;
473 }
474}
475
Harald Welte24a655f2010-04-30 19:54:29 +0200476static int gprs_ns_tx(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +0800477{
Harald Welte94c9b442019-03-16 14:38:19 +0100478 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Weltef030b212010-04-26 19:18:54 +0200479 int ret;
480
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100481 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200482
Harald Welte94c9b442019-03-16 14:38:19 +0100483 /* A pre-configured endpoint shall not be used for NSE data or signalling
484 * traffic (with the exception of Size and Configuration procedures) unless it
485 * is configured by the SGSN using the auto-configuration procedures. */
486 if (nsvc_is_not_used(nsvc) && !ns_is_sns(nsh->pdu_type) && nsh->pdu_type != NS_PDUT_STATUS) {
487 LOGP(DNS, LOGL_NOTICE, "Not transmitting %s on unused/pre-configured endpoint\n",
488 get_value_string(gprs_ns_pdu_strings, nsh->pdu_type));
489 msgb_free(msg);
490 return -EINVAL;
491 }
492
Harald Welte144e0292010-05-13 11:45:07 +0200493 /* Increment number of Uplink bytes */
Harald Weltec51c23c2010-05-13 12:55:20 +0200494 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_PKTS_OUT]);
495 rate_ctr_add(&nsvc->ctrg->ctr[NS_CTR_BYTES_OUT], msgb_l2len(msg));
Harald Welte144e0292010-05-13 11:45:07 +0200496
Harald Welteb3ee2652010-05-19 14:38:50 +0200497 switch (nsvc->ll) {
Harald Weltef030b212010-04-26 19:18:54 +0200498 case GPRS_NS_LL_UDP:
Harald Welte24a655f2010-04-30 19:54:29 +0200499 ret = nsip_sendmsg(nsvc, msg);
Jacob Erlbeck8d192d72015-04-07 17:52:45 +0200500 if (ret < 0)
501 LOGP(DNS, LOGL_INFO,
502 "failed to send NS message via UDP: %s\n",
503 strerror(-ret));
Harald Weltef030b212010-04-26 19:18:54 +0200504 break;
Harald Welteb3ee2652010-05-19 14:38:50 +0200505 case GPRS_NS_LL_FR_GRE:
506 ret = gprs_ns_frgre_sendmsg(nsvc, msg);
Jacob Erlbeck8d192d72015-04-07 17:52:45 +0200507 if (ret < 0)
508 LOGP(DNS, LOGL_INFO,
509 "failed to send NS message via FR/GRE: %s\n",
510 strerror(-ret));
Harald Welteb3ee2652010-05-19 14:38:50 +0200511 break;
Harald Weltef030b212010-04-26 19:18:54 +0200512 default:
Harald Welteb3ee2652010-05-19 14:38:50 +0200513 LOGP(DNS, LOGL_ERROR, "unsupported NS linklayer %u\n", nsvc->ll);
Harald Weltef030b212010-04-26 19:18:54 +0200514 msgb_free(msg);
515 ret = -EIO;
516 break;
517 }
518 return ret;
Harald Welte9ba50052010-03-14 15:45:01 +0800519}
520
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200521static int gprs_ns_tx_simple(struct gprs_nsvc *nsvc, uint8_t pdu_type)
Harald Welte9ba50052010-03-14 15:45:01 +0800522{
Harald Welteba4c6662010-05-19 15:38:10 +0200523 struct msgb *msg = gprs_ns_msgb_alloc();
Harald Welte9ba50052010-03-14 15:45:01 +0800524 struct gprs_ns_hdr *nsh;
525
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100526 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200527
Harald Welte9ba50052010-03-14 15:45:01 +0800528 if (!msg)
529 return -ENOMEM;
530
Harald Welte144e0292010-05-13 11:45:07 +0200531 msg->l2h = msgb_put(msg, sizeof(*nsh));
532 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +0800533
534 nsh->pdu_type = pdu_type;
535
Harald Welte24a655f2010-04-30 19:54:29 +0200536 return gprs_ns_tx(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800537}
538
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200539/*! Transmit a NS-RESET on a given NSVC
Harald Weltea9f23c82011-11-23 15:01:31 +0100540 * \param[in] nsvc NS-VC used for transmission
541 * \paam[in] cause Numeric NS cause value
542 */
Harald Welte834f26d2010-05-11 06:20:54 +0200543int gprs_ns_tx_reset(struct gprs_nsvc *nsvc, uint8_t cause)
Harald Welte69a4cf22010-05-03 20:55:10 +0200544{
Harald Welte047f3872018-07-01 21:04:45 +0200545 struct msgb *msg;
Harald Welte69a4cf22010-05-03 20:55:10 +0200546 struct gprs_ns_hdr *nsh;
Harald Weltebfe62e52017-05-15 12:48:30 +0200547 uint16_t nsvci = osmo_htons(nsvc->nsvci);
548 uint16_t nsei = osmo_htons(nsvc->nsei);
Harald Welte69a4cf22010-05-03 20:55:10 +0200549
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100550 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200551
Harald Welte047f3872018-07-01 21:04:45 +0200552 ERR_IF_NSVC_USES_SNS(nsvc, "transmit NS RESET");
553
554 msg = gprs_ns_msgb_alloc();
Harald Welte69a4cf22010-05-03 20:55:10 +0200555 if (!msg)
556 return -ENOMEM;
557
Harald Welte6ecaa3d2010-05-12 12:01:33 +0000558 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS RESET (NSVCI=%u, cause=%s)\n",
559 nsvc->nsei, nsvc->nsvci, gprs_ns_cause_str(cause));
560
Harald Welte144e0292010-05-13 11:45:07 +0200561 msg->l2h = msgb_put(msg, sizeof(*nsh));
562 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte69a4cf22010-05-03 20:55:10 +0200563 nsh->pdu_type = NS_PDUT_RESET;
564
565 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, &cause);
566 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *) &nsvci);
567 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *) &nsei);
568
569 return gprs_ns_tx(nsvc, msg);
570
571}
572
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200573/*! Transmit a NS-STATUS on a given NSVC
Harald Weltea9f23c82011-11-23 15:01:31 +0100574 * \param[in] nsvc NS-VC to be used for transmission
575 * \param[in] cause Numeric NS cause value
576 * \param[in] bvci BVCI to be reset within NSVC
577 * \param[in] orig_msg message causing the STATUS */
Harald Weltec1402a62010-05-12 11:48:44 +0200578int gprs_ns_tx_status(struct gprs_nsvc *nsvc, uint8_t cause,
579 uint16_t bvci, struct msgb *orig_msg)
580{
Harald Welteba4c6662010-05-19 15:38:10 +0200581 struct msgb *msg = gprs_ns_msgb_alloc();
Harald Weltec1402a62010-05-12 11:48:44 +0200582 struct gprs_ns_hdr *nsh;
Harald Weltebfe62e52017-05-15 12:48:30 +0200583 uint16_t nsvci = osmo_htons(nsvc->nsvci);
Harald Weltec1402a62010-05-12 11:48:44 +0200584
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100585 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200586
Harald Weltebfe62e52017-05-15 12:48:30 +0200587 bvci = osmo_htons(bvci);
Harald Weltec1402a62010-05-12 11:48:44 +0200588
589 if (!msg)
590 return -ENOMEM;
591
Harald Welte90af1942010-05-15 23:02:24 +0200592 LOGP(DNS, LOGL_NOTICE, "NSEI=%u Tx NS STATUS (NSVCI=%u, cause=%s)\n",
Harald Welte6ecaa3d2010-05-12 12:01:33 +0000593 nsvc->nsei, nsvc->nsvci, gprs_ns_cause_str(cause));
594
Harald Welte144e0292010-05-13 11:45:07 +0200595 msg->l2h = msgb_put(msg, sizeof(*nsh));
596 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Weltec1402a62010-05-12 11:48:44 +0200597 nsh->pdu_type = NS_PDUT_STATUS;
598
599 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, &cause);
600
601 /* Section 9.2.7.1: Static conditions for NS-VCI */
602 if (cause == NS_CAUSE_NSVC_BLOCKED ||
603 cause == NS_CAUSE_NSVC_UNKNOWN)
604 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *)&nsvci);
605
606 /* Section 9.2.7.2: Static conditions for NS PDU */
607 switch (cause) {
608 case NS_CAUSE_SEM_INCORR_PDU:
609 case NS_CAUSE_PDU_INCOMP_PSTATE:
610 case NS_CAUSE_PROTO_ERR_UNSPEC:
611 case NS_CAUSE_INVAL_ESSENT_IE:
612 case NS_CAUSE_MISSING_ESSENT_IE:
613 msgb_tvlv_put(msg, NS_IE_PDU, msgb_l2len(orig_msg),
614 orig_msg->l2h);
615 break;
616 default:
617 break;
618 }
619
620 /* Section 9.2.7.3: Static conditions for BVCI */
621 if (cause == NS_CAUSE_BVCI_UNKNOWN)
622 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *)&bvci);
623
624 return gprs_ns_tx(nsvc, msg);
625}
626
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200627/*! Transmit a NS-BLOCK on a tiven NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100628 * \param[in] nsvc NS-VC on which the NS-BLOCK is to be transmitted
629 * \param[in] cause Numeric NS Cause value
630 * \returns 0 in case of success
631 */
Harald Welte834f26d2010-05-11 06:20:54 +0200632int gprs_ns_tx_block(struct gprs_nsvc *nsvc, uint8_t cause)
633{
Harald Welte047f3872018-07-01 21:04:45 +0200634 struct msgb *msg;
Harald Welte834f26d2010-05-11 06:20:54 +0200635 struct gprs_ns_hdr *nsh;
Harald Weltebfe62e52017-05-15 12:48:30 +0200636 uint16_t nsvci = osmo_htons(nsvc->nsvci);
Harald Welte834f26d2010-05-11 06:20:54 +0200637
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100638 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +0200639
Harald Welte047f3872018-07-01 21:04:45 +0200640 ERR_IF_NSVC_USES_SNS(nsvc, "transmit NS BLOCK");
641
642 msg = gprs_ns_msgb_alloc();
Harald Welte834f26d2010-05-11 06:20:54 +0200643 if (!msg)
644 return -ENOMEM;
645
Harald Welte6ecaa3d2010-05-12 12:01:33 +0000646 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS BLOCK (NSVCI=%u, cause=%s)\n",
647 nsvc->nsei, nsvc->nsvci, gprs_ns_cause_str(cause));
648
Harald Welte834f26d2010-05-11 06:20:54 +0200649 /* be conservative and mark it as blocked even now! */
Maxc513c0f2017-10-23 15:11:14 +0200650 ns_mark_blocked(nsvc);
Harald Weltec51c23c2010-05-13 12:55:20 +0200651 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_BLOCKED]);
Harald Welte834f26d2010-05-11 06:20:54 +0200652
Harald Welte144e0292010-05-13 11:45:07 +0200653 msg->l2h = msgb_put(msg, sizeof(*nsh));
654 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte834f26d2010-05-11 06:20:54 +0200655 nsh->pdu_type = NS_PDUT_BLOCK;
656
657 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, &cause);
658 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *) &nsvci);
659
660 return gprs_ns_tx(nsvc, msg);
661}
662
Harald Welte9ef2e152019-02-19 23:42:04 +0100663/*! Transmit a NS-BLOCK-ACK on a given NS-VC
664 * \param[in] nsvc NS-VC on which the NS-BLOCK is to be transmitted
665 * \returns 0 in case of success
666 */
667static int gprs_ns_tx_block_ack(struct gprs_nsvc *nsvc)
668{
669 struct msgb *msg;
670 struct gprs_ns_hdr *nsh;
671 uint16_t nsvci = osmo_htons(nsvc->nsvci);
672
673 log_set_context(LOG_CTX_GB_NSVC, nsvc);
674
Harald Welte047f3872018-07-01 21:04:45 +0200675 ERR_IF_NSVC_USES_SNS(nsvc, "transmit NS BLOCK ACK");
676
Harald Welte9ef2e152019-02-19 23:42:04 +0100677 msg = gprs_ns_msgb_alloc();
678 if (!msg)
679 return -ENOMEM;
680
681 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS BLOCK ACK (NSVCI=%u)\n", nsvc->nsei, nsvc->nsvci);
682
683 /* be conservative and mark it as blocked even now! */
684 msg->l2h = msgb_put(msg, sizeof(*nsh));
685 nsh = (struct gprs_ns_hdr *) msg->l2h;
686 nsh->pdu_type = NS_PDUT_BLOCK_ACK;
687
688 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *) &nsvci);
689
690 return gprs_ns_tx(nsvc, msg);
691}
692
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200693/*! Transmit a NS-UNBLOCK on a given NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100694 * \param[in] nsvc NS-VC on which the NS-UNBLOCK is to be transmitted
695 * \returns 0 in case of success
696 */
Harald Welte834f26d2010-05-11 06:20:54 +0200697int gprs_ns_tx_unblock(struct gprs_nsvc *nsvc)
698{
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100699 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte047f3872018-07-01 21:04:45 +0200700
701 ERR_IF_NSVC_USES_SNS(nsvc, "transmit NS UNBLOCK");
702
Harald Welte6ecaa3d2010-05-12 12:01:33 +0000703 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS UNBLOCK (NSVCI=%u)\n",
704 nsvc->nsei, nsvc->nsvci);
705
Harald Welte834f26d2010-05-11 06:20:54 +0200706 return gprs_ns_tx_simple(nsvc, NS_PDUT_UNBLOCK);
707}
708
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200709/*! Transmit a NS-ALIVE on a given NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100710 * \param[in] nsvc NS-VC on which the NS-ALIVE is to be transmitted
711 * \returns 0 in case of success
712 */
Harald Welteb983c312010-05-12 12:11:45 +0000713int gprs_ns_tx_alive(struct gprs_nsvc *nsvc)
714{
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100715 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welteb983c312010-05-12 12:11:45 +0000716 LOGP(DNS, LOGL_DEBUG, "NSEI=%u Tx NS ALIVE (NSVCI=%u)\n",
717 nsvc->nsei, nsvc->nsvci);
718
719 return gprs_ns_tx_simple(nsvc, NS_PDUT_ALIVE);
720}
721
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200722/*! Transmit a NS-ALIVE-ACK on a given NS-VC
Harald Weltea9f23c82011-11-23 15:01:31 +0100723 * \param[in] nsvc NS-VC on which the NS-ALIVE-ACK is to be transmitted
724 * \returns 0 in case of success
725 */
Harald Welteb983c312010-05-12 12:11:45 +0000726int gprs_ns_tx_alive_ack(struct gprs_nsvc *nsvc)
727{
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100728 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welteb983c312010-05-12 12:11:45 +0000729 LOGP(DNS, LOGL_DEBUG, "NSEI=%u Tx NS ALIVE_ACK (NSVCI=%u)\n",
730 nsvc->nsei, nsvc->nsvci);
731
732 return gprs_ns_tx_simple(nsvc, NS_PDUT_ALIVE_ACK);
733}
734
Harald Weltefe4ab902010-05-12 17:19:53 +0000735static const enum ns_timeout timer_mode_tout[_NSVC_TIMER_NR] = {
736 [NSVC_TIMER_TNS_RESET] = NS_TOUT_TNS_RESET,
737 [NSVC_TIMER_TNS_ALIVE] = NS_TOUT_TNS_ALIVE,
738 [NSVC_TIMER_TNS_TEST] = NS_TOUT_TNS_TEST,
Harald Welte69a4cf22010-05-03 20:55:10 +0200739};
740
Harald Welte7c24b9e2010-05-12 12:21:52 +0000741static const struct value_string timer_mode_strs[] = {
742 { NSVC_TIMER_TNS_RESET, "tns-reset" },
743 { NSVC_TIMER_TNS_ALIVE, "tns-alive" },
744 { NSVC_TIMER_TNS_TEST, "tns-test" },
745 { 0, NULL }
746};
747
Harald Welte69a4cf22010-05-03 20:55:10 +0200748static void nsvc_start_timer(struct gprs_nsvc *nsvc, enum nsvc_timer_mode mode)
749{
Harald Weltefe4ab902010-05-12 17:19:53 +0000750 enum ns_timeout tout = timer_mode_tout[mode];
751 unsigned int seconds = nsvc->nsi->timeout[tout];
752
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100753 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte4e187c62010-05-12 13:55:36 +0000754 DEBUGP(DNS, "NSEI=%u Starting timer in mode %s (%u seconds)\n",
755 nsvc->nsei, get_value_string(timer_mode_strs, mode),
Harald Weltefe4ab902010-05-12 17:19:53 +0000756 seconds);
Harald Welte9612fcb2019-02-19 11:43:35 +0100757
Pablo Neira Ayuso2b159522011-05-06 12:11:06 +0200758 if (osmo_timer_pending(&nsvc->timer))
759 osmo_timer_del(&nsvc->timer);
Harald Welte69a4cf22010-05-03 20:55:10 +0200760
Neels Hofmeyr8e2f7e82016-09-22 03:58:13 +0200761 osmo_gettimeofday(&nsvc->timer_started, NULL);
Harald Welte69a4cf22010-05-03 20:55:10 +0200762 nsvc->timer_mode = mode;
Pablo Neira Ayuso2b159522011-05-06 12:11:06 +0200763 osmo_timer_schedule(&nsvc->timer, seconds, 0);
Harald Welte69a4cf22010-05-03 20:55:10 +0200764}
765
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200766static int nsvc_timer_elapsed_ms(struct gprs_nsvc *nsvc)
767{
768 struct timeval now, elapsed;
Neels Hofmeyr8e2f7e82016-09-22 03:58:13 +0200769 osmo_gettimeofday(&now, NULL);
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200770 timersub(&now, &nsvc->timer_started, &elapsed);
771
772 return 1000 * elapsed.tv_sec + elapsed.tv_usec / 1000;
773}
774
Harald Welte80405452010-05-03 20:16:13 +0200775static void gprs_ns_timer_cb(void *data)
Harald Welte9ba50052010-03-14 15:45:01 +0800776{
777 struct gprs_nsvc *nsvc = data;
Harald Weltefe4ab902010-05-12 17:19:53 +0000778 enum ns_timeout tout = timer_mode_tout[nsvc->timer_mode];
779 unsigned int seconds = nsvc->nsi->timeout[tout];
Harald Welte9ba50052010-03-14 15:45:01 +0800780
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100781 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte4e187c62010-05-12 13:55:36 +0000782 DEBUGP(DNS, "NSEI=%u Timer expired in mode %s (%u seconds)\n",
783 nsvc->nsei, get_value_string(timer_mode_strs, nsvc->timer_mode),
Harald Weltefe4ab902010-05-12 17:19:53 +0000784 seconds);
Harald Welte9612fcb2019-02-19 11:43:35 +0100785
Harald Welte80405452010-05-03 20:16:13 +0200786 switch (nsvc->timer_mode) {
787 case NSVC_TIMER_TNS_ALIVE:
Harald Welte9ba50052010-03-14 15:45:01 +0800788 /* Tns-alive case: we expired without response ! */
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200789 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_LOST_ALIVE]);
Harald Welte9ba50052010-03-14 15:45:01 +0800790 nsvc->alive_retries++;
Harald Weltefe4ab902010-05-12 17:19:53 +0000791 if (nsvc->alive_retries >
792 nsvc->nsi->timeout[NS_TOUT_TNS_ALIVE_RETRIES]) {
Harald Welte047f3872018-07-01 21:04:45 +0200793 /* mark as dead (and blocked unless IP-SNS) */
Harald Weltec51c23c2010-05-13 12:55:20 +0200794 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_DEAD]);
Harald Welte047f3872018-07-01 21:04:45 +0200795 if (!nsvc->nsi->bss_sns_fi) {
796 ns_set_state(nsvc, NSE_S_BLOCKED);
797 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_BLOCKED]);
798 } else
799 ns_set_state(nsvc, 0);
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200800 LOGP(DNS, LOGL_NOTICE,
801 "NSEI=%u Tns-alive expired more then "
Harald Welte69a4cf22010-05-03 20:55:10 +0200802 "%u times, blocking NS-VC\n", nsvc->nsei,
Harald Weltefe4ab902010-05-12 17:19:53 +0000803 nsvc->nsi->timeout[NS_TOUT_TNS_ALIVE_RETRIES]);
Pablo Neira Ayuso2b88a2a2011-05-06 12:12:31 +0200804 ns_osmo_signal_dispatch(nsvc, S_NS_ALIVE_EXP, 0);
Harald Welte047f3872018-07-01 21:04:45 +0200805 /* FIXME: should we send this signal in case of SNS? */
806 if (!nsvc->nsi->bss_sns_fi)
807 ns_osmo_signal_dispatch(nsvc, S_NS_BLOCK, NS_CAUSE_NSVC_BLOCKED);
Harald Welte9ba50052010-03-14 15:45:01 +0800808 return;
809 }
Harald Welteb983c312010-05-12 12:11:45 +0000810 /* Tns-test case: send NS-ALIVE PDU */
811 gprs_ns_tx_alive(nsvc);
812 /* start Tns-alive timer */
Harald Welte69a4cf22010-05-03 20:55:10 +0200813 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_ALIVE);
Harald Welte80405452010-05-03 20:16:13 +0200814 break;
815 case NSVC_TIMER_TNS_TEST:
Harald Welte9ba50052010-03-14 15:45:01 +0800816 /* Tns-test case: send NS-ALIVE PDU */
Harald Welteb983c312010-05-12 12:11:45 +0000817 gprs_ns_tx_alive(nsvc);
818 /* start Tns-alive timer (transition into faster
819 * alive retransmissions) */
Harald Welte7c24b9e2010-05-12 12:21:52 +0000820 nsvc->alive_retries = 0;
Harald Welte69a4cf22010-05-03 20:55:10 +0200821 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_ALIVE);
822 break;
823 case NSVC_TIMER_TNS_RESET:
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +0200824 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_LOST_RESET]);
Jacob Erlbeckcc6ac4c2015-12-17 13:22:36 +0100825 if (!(nsvc->state & NSE_S_RESET))
826 LOGP(DNS, LOGL_NOTICE,
827 "NSEI=%u Reset timed out but RESET flag is not set\n",
828 nsvc->nsei);
829 /* Mark NS-VC locally as blocked and dead */
Maxc513c0f2017-10-23 15:11:14 +0200830 ns_set_state(nsvc, NSE_S_BLOCKED | NSE_S_RESET);
Harald Welte69a4cf22010-05-03 20:55:10 +0200831 /* Chapter 7.3: Re-send the RESET */
Harald Welte570fb832010-05-03 21:05:24 +0200832 gprs_ns_tx_reset(nsvc, NS_CAUSE_OM_INTERVENTION);
Harald Weltec1402a62010-05-12 11:48:44 +0200833 /* Re-start Tns-reset timer */
Harald Welte69a4cf22010-05-03 20:55:10 +0200834 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_RESET);
Harald Welte80405452010-05-03 20:16:13 +0200835 break;
Harald Welte2fc725d2010-05-11 10:15:26 +0200836 case _NSVC_TIMER_NR:
837 break;
Harald Welte9ba50052010-03-14 15:45:01 +0800838 }
Harald Welte9ba50052010-03-14 15:45:01 +0800839}
840
841/* Section 9.2.6 */
Harald Weltec5478482010-03-18 00:01:43 +0800842static int gprs_ns_tx_reset_ack(struct gprs_nsvc *nsvc)
Harald Welte9ba50052010-03-14 15:45:01 +0800843{
Harald Welte047f3872018-07-01 21:04:45 +0200844 struct msgb *msg;
Harald Welte9ba50052010-03-14 15:45:01 +0800845 struct gprs_ns_hdr *nsh;
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200846 uint16_t nsvci, nsei;
Harald Welte9ba50052010-03-14 15:45:01 +0800847
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +0100848 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte047f3872018-07-01 21:04:45 +0200849
850 ERR_IF_NSVC_USES_SNS(nsvc, "transmit NS RESET ACK");
851
852 msg = gprs_ns_msgb_alloc();
Harald Welte9ba50052010-03-14 15:45:01 +0800853 if (!msg)
854 return -ENOMEM;
855
Harald Weltebfe62e52017-05-15 12:48:30 +0200856 nsvci = osmo_htons(nsvc->nsvci);
857 nsei = osmo_htons(nsvc->nsei);
Harald Welte9ba50052010-03-14 15:45:01 +0800858
Harald Welte144e0292010-05-13 11:45:07 +0200859 msg->l2h = msgb_put(msg, sizeof(*nsh));
860 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +0800861
862 nsh->pdu_type = NS_PDUT_RESET_ACK;
863
Harald Weltee4ecc8c2010-05-12 00:16:57 +0200864 LOGP(DNS, LOGL_INFO, "NSEI=%u Tx NS RESET ACK (NSVCI=%u)\n",
Harald Weltebbc9fac2010-05-03 18:54:12 +0200865 nsvc->nsei, nsvc->nsvci);
Harald Weltec5478482010-03-18 00:01:43 +0800866
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200867 msgb_tvlv_put(msg, NS_IE_VCI, 2, (uint8_t *)&nsvci);
868 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *)&nsei);
Harald Welte9ba50052010-03-14 15:45:01 +0800869
Harald Welte24a655f2010-04-30 19:54:29 +0200870 return gprs_ns_tx(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +0800871}
872
Harald Welte17a642d2018-07-01 19:09:52 +0200873/*! Encode + Transmit a SNS-ACK as per Section 9.3.1.
874 * \param[in] nsvc NS-VC through which to transmit the ACK
875 * \param[in] trans_id Transaction ID which to acknowledge
876 * \param[in] cause Pointer to cause value (NULL if no cause to be sent)
877 * \param[in] ip4_elems Array of IPv4 Elements
878 * \param[in] num_ip4_elems number of ip4_elems
879 * \returns 0 on success; negative in case of error */
880int gprs_ns_tx_sns_ack(struct gprs_nsvc *nsvc, uint8_t trans_id, uint8_t *cause,
881 const struct gprs_ns_ie_ip4_elem *ip4_elems,
882 unsigned int num_ip4_elems)
883{
884 struct msgb *msg = gprs_ns_msgb_alloc();
885 struct gprs_ns_hdr *nsh;
886 uint16_t nsei;
887
888 log_set_context(LOG_CTX_GB_NSVC, nsvc);
889 if (!msg)
890 return -ENOMEM;
891
Harald Welte047f3872018-07-01 21:04:45 +0200892 if (!nsvc->nsi->bss_sns_fi) {
893 LOGP(DNS, LOGL_ERROR, "NSEI=%u Cannot transmit SNS on NSVC without SNS active\n",
894 nsvc->nsei);
895 msgb_free(msg);
896 return -EIO;
897 }
898
Harald Welte17a642d2018-07-01 19:09:52 +0200899 nsei = osmo_htons(nsvc->nsei);
900
901 msg->l2h = msgb_put(msg, sizeof(*nsh));
902 nsh = (struct gprs_ns_hdr *) msg->l2h;
903
904 nsh->pdu_type = SNS_PDUT_ACK;
905 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *)&nsei);
906 msgb_v_put(msg, trans_id);
907 if (cause)
908 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, cause);
909 if (ip4_elems) {
910 /* List of IP4 Elements 10.3.2c */
911 msgb_tvlv_put(msg, NS_IE_IPv4_LIST,
912 num_ip4_elems*sizeof(struct gprs_ns_ie_ip4_elem),
913 (const uint8_t *)ip4_elems);
914 }
915 /* FIXME: List of IP6 elements 10.3.2d */
916 return gprs_ns_tx(nsvc, msg);
917}
918
919/*! Encode + Transmit a SNS-CONFIG as per Section 9.3.4.
920 * \param[in] nsvc NS-VC through which to transmit the SNS-CONFIG
921 * \param[in] end_flag Whether or not this is the last SNS-CONFIG
922 * \param[in] ip4_elems Array of IPv4 Elements
923 * \param[in] num_ip4_elems number of ip4_elems
924 * \returns 0 on success; negative in case of error */
925int gprs_ns_tx_sns_config(struct gprs_nsvc *nsvc, bool end_flag,
926 const struct gprs_ns_ie_ip4_elem *ip4_elems,
927 unsigned int num_ip4_elems)
928{
929 struct msgb *msg = gprs_ns_msgb_alloc();
930 struct gprs_ns_hdr *nsh;
931 uint16_t nsei;
932
933 log_set_context(LOG_CTX_GB_NSVC, nsvc);
934 if (!msg)
935 return -ENOMEM;
936
Harald Welte047f3872018-07-01 21:04:45 +0200937 if (!nsvc->nsi->bss_sns_fi) {
938 LOGP(DNS, LOGL_ERROR, "NSEI=%u Cannot transmit SNS on NSVC without SNS active\n",
939 nsvc->nsei);
940 msgb_free(msg);
941 return -EIO;
942 }
943
Harald Welte17a642d2018-07-01 19:09:52 +0200944 nsei = osmo_htons(nsvc->nsei);
945
946 msg->l2h = msgb_put(msg, sizeof(*nsh));
947 nsh = (struct gprs_ns_hdr *) msg->l2h;
948
949 nsh->pdu_type = SNS_PDUT_CONFIG;
950
951 msgb_v_put(msg, end_flag ? 0x01 : 0x00);
952 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *)&nsei);
953
954 /* List of IP4 Elements 10.3.2c */
955 msgb_tvlv_put(msg, NS_IE_IPv4_LIST, num_ip4_elems*sizeof(struct gprs_ns_ie_ip4_elem),
956 (const uint8_t *)ip4_elems);
957 /* FIXME: List of IP6 elements 10.3.2d */
958
959 return gprs_ns_tx(nsvc, msg);
960}
961
962/*! Encode + Transmit a SNS-CONFIG-ACK as per Section 9.3.5.
963 * \param[in] nsvc NS-VC through which to transmit the SNS-CONFIG-ACK
964 * \param[in] cause Pointer to cause value (NULL if no cause to be sent)
965 * \returns 0 on success; negative in case of error */
966int gprs_ns_tx_sns_config_ack(struct gprs_nsvc *nsvc, uint8_t *cause)
967{
968 struct msgb *msg = gprs_ns_msgb_alloc();
969 struct gprs_ns_hdr *nsh;
970 uint16_t nsei;
971
972 log_set_context(LOG_CTX_GB_NSVC, nsvc);
973 if (!msg)
974 return -ENOMEM;
975
Harald Welte047f3872018-07-01 21:04:45 +0200976 if (!nsvc->nsi->bss_sns_fi) {
977 LOGP(DNS, LOGL_ERROR, "NSEI=%u Cannot transmit SNS on NSVC without SNS active\n",
978 nsvc->nsei);
979 msgb_free(msg);
980 return -EIO;
981 }
982
Harald Welte17a642d2018-07-01 19:09:52 +0200983 nsei = osmo_htons(nsvc->nsei);
984
985 msg->l2h = msgb_put(msg, sizeof(*nsh));
986 nsh = (struct gprs_ns_hdr *) msg->l2h;
987
988 nsh->pdu_type = SNS_PDUT_CONFIG_ACK;
989
990 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *)&nsei);
991 if (cause)
992 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, cause);
993
994 return gprs_ns_tx(nsvc, msg);
995}
996
997
998/*! Encode + transmit a SNS-SIZE as per Section 9.3.7.
999 * \param[in] nsvc NS-VC through which to transmit the SNS-SIZE
1000 * \param[in] reset_flag Whether or not to add a RESET flag
1001 * \param[in] max_nr_nsvc Maximum number of NS-VCs
1002 * \param[in] ip4_ep_nr Number of IPv4 endpoints (NULL if none)
1003 * \param[in] ip6_ep_nr Number of IPv6 endpoints (NULL if none)
1004 * \returns 0 on success; negative in case of error */
1005int gprs_ns_tx_sns_size(struct gprs_nsvc *nsvc, bool reset_flag, uint16_t max_nr_nsvc,
1006 uint16_t *ip4_ep_nr, uint16_t *ip6_ep_nr)
1007{
1008 struct msgb *msg = gprs_ns_msgb_alloc();
1009 struct gprs_ns_hdr *nsh;
1010 uint16_t nsei;
1011
1012 log_set_context(LOG_CTX_GB_NSVC, nsvc);
1013 if (!msg)
1014 return -ENOMEM;
1015
Harald Welte047f3872018-07-01 21:04:45 +02001016 if (!nsvc->nsi->bss_sns_fi) {
1017 LOGP(DNS, LOGL_ERROR, "NSEI=%u Cannot transmit SNS on NSVC without SNS active\n",
1018 nsvc->nsei);
1019 msgb_free(msg);
1020 return -EIO;
1021 }
1022
Harald Welte17a642d2018-07-01 19:09:52 +02001023 nsei = osmo_htons(nsvc->nsei);
1024
1025 msg->l2h = msgb_put(msg, sizeof(*nsh));
1026 nsh = (struct gprs_ns_hdr *) msg->l2h;
1027
1028 nsh->pdu_type = SNS_PDUT_SIZE;
1029
1030 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *)&nsei);
1031 msgb_tv_put(msg, NS_IE_RESET_FLAG, reset_flag ? 0x01 : 0x00);
1032 msgb_tv16_put(msg, NS_IE_MAX_NR_NSVC, max_nr_nsvc);
1033 if (ip4_ep_nr)
1034 msgb_tv16_put(msg, NS_IE_IPv4_EP_NR, *ip4_ep_nr);
1035 if (ip6_ep_nr)
1036 msgb_tv16_put(msg, NS_IE_IPv6_EP_NR, *ip6_ep_nr);
1037
1038 return gprs_ns_tx(nsvc, msg);
1039}
1040
1041/*! Encode + Transmit a SNS-SIZE-ACK as per Section 9.3.8.
1042 * \param[in] nsvc NS-VC through which to transmit the SNS-SIZE-ACK
1043 * \param[in] cause Pointer to cause value (NULL if no cause to be sent)
1044 * \returns 0 on success; negative in case of error */
1045int gprs_ns_tx_sns_size_ack(struct gprs_nsvc *nsvc, uint8_t *cause)
1046{
1047 struct msgb *msg = gprs_ns_msgb_alloc();
1048 struct gprs_ns_hdr *nsh;
1049 uint16_t nsei;
1050
1051 log_set_context(LOG_CTX_GB_NSVC, nsvc);
1052 if (!msg)
1053 return -ENOMEM;
1054
Harald Welte047f3872018-07-01 21:04:45 +02001055 if (!nsvc->nsi->bss_sns_fi) {
1056 LOGP(DNS, LOGL_ERROR, "NSEI=%u Cannot transmit SNS on NSVC without SNS active\n",
1057 nsvc->nsei);
1058 msgb_free(msg);
1059 return -EIO;
1060 }
1061
Harald Welte17a642d2018-07-01 19:09:52 +02001062 nsei = osmo_htons(nsvc->nsei);
1063
1064 msg->l2h = msgb_put(msg, sizeof(*nsh));
1065 nsh = (struct gprs_ns_hdr *) msg->l2h;
1066
1067 nsh->pdu_type = SNS_PDUT_SIZE_ACK;
1068
1069 msgb_tvlv_put(msg, NS_IE_NSEI, 2, (uint8_t *)&nsei);
1070 if (cause)
1071 msgb_tvlv_put(msg, NS_IE_CAUSE, 1, cause);
1072
1073 return gprs_ns_tx(nsvc, msg);
1074}
1075
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001076/*! High-level function for transmitting a NS-UNITDATA messsage
Harald Weltea9f23c82011-11-23 15:01:31 +01001077 * \param[in] nsi NS-instance on which we shall transmit
1078 * \param[in] msg struct msgb to be trasnmitted
1079 *
1080 * This function obtains the NS-VC by the msgb_nsei(msg) and then checks
1081 * if the NS-VC is ALIVEV and not BLOCKED. After that, it adds a NS
1082 * header for the NS-UNITDATA message type and sends it off.
1083 *
1084 * Section 9.2.10: transmit side / NS-UNITDATA-REQUEST primitive
1085 */
Harald Welte24a655f2010-04-30 19:54:29 +02001086int gprs_ns_sendmsg(struct gprs_ns_inst *nsi, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +08001087{
Harald Welte24a655f2010-04-30 19:54:29 +02001088 struct gprs_nsvc *nsvc;
Harald Welte9ba50052010-03-14 15:45:01 +08001089 struct gprs_ns_hdr *nsh;
Harald Welte8f9a3ee2010-05-02 11:26:34 +02001090 uint16_t bvci = msgb_bvci(msg);
Harald Welte24a655f2010-04-30 19:54:29 +02001091
Harald Welte047f3872018-07-01 21:04:45 +02001092 nsvc = gprs_active_nsvc_by_nsei(nsi, msgb_nsei(msg), msgb_bvci(msg));
Harald Welte24a655f2010-04-30 19:54:29 +02001093 if (!nsvc) {
Jacob Erlbeck69017152013-10-14 12:03:54 +02001094 int rc;
1095 if (gprs_nsvc_by_nsei(nsi, msgb_nsei(msg))) {
1096 LOGP(DNS, LOGL_ERROR,
1097 "All NS-VCs for NSEI %u are either dead or blocked!\n",
1098 msgb_nsei(msg));
1099 rc = -EBUSY;
1100 } else {
1101 LOGP(DNS, LOGL_ERROR, "Unable to resolve NSEI %u "
1102 "to NS-VC!\n", msgb_nsei(msg));
1103 rc = -EINVAL;
1104 }
1105
Harald Weltef47df642010-08-09 21:15:40 +08001106 msgb_free(msg);
Jacob Erlbeck69017152013-10-14 12:03:54 +02001107 return rc;
Harald Welte24a655f2010-04-30 19:54:29 +02001108 }
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +01001109 log_set_context(LOG_CTX_GB_NSVC, nsvc);
Harald Welte9ba50052010-03-14 15:45:01 +08001110
Harald Welteec20ba42010-05-13 12:18:49 +02001111 msg->l2h = msgb_push(msg, sizeof(*nsh) + 3);
1112 nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +08001113 if (!nsh) {
Harald Welteb8a6a832010-05-11 05:54:22 +02001114 LOGP(DNS, LOGL_ERROR, "Not enough headroom for NS header\n");
Harald Weltef47df642010-08-09 21:15:40 +08001115 msgb_free(msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001116 return -EIO;
1117 }
1118
1119 nsh->pdu_type = NS_PDUT_UNITDATA;
1120 /* spare octet in data[0] */
1121 nsh->data[1] = bvci >> 8;
1122 nsh->data[2] = bvci & 0xff;
1123
Harald Welte24a655f2010-04-30 19:54:29 +02001124 return gprs_ns_tx(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001125}
1126
1127/* Section 9.2.10: receive side */
Harald Welte24a655f2010-04-30 19:54:29 +02001128static int gprs_ns_rx_unitdata(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +08001129{
1130 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *)msg->l2h;
Harald Welte8f9a3ee2010-05-02 11:26:34 +02001131 uint16_t bvci;
Harald Welte9ba50052010-03-14 15:45:01 +08001132
Harald Weltec1402a62010-05-12 11:48:44 +02001133 if (nsvc->state & NSE_S_BLOCKED)
1134 return gprs_ns_tx_status(nsvc, NS_CAUSE_NSVC_BLOCKED,
1135 0, msg);
1136
Harald Welte9ba50052010-03-14 15:45:01 +08001137 /* spare octet in data[0] */
1138 bvci = nsh->data[1] << 8 | nsh->data[2];
Harald Welteec19c102010-05-02 09:50:42 +02001139 msgb_bssgph(msg) = &nsh->data[3];
Harald Welte30bc19a2010-05-02 11:19:37 +02001140 msgb_bvci(msg) = bvci;
Harald Welte9ba50052010-03-14 15:45:01 +08001141
1142 /* call upper layer (BSSGP) */
Harald Weltef030b212010-04-26 19:18:54 +02001143 return nsvc->nsi->cb(GPRS_NS_EVT_UNIT_DATA, nsvc, msg, bvci);
Harald Welte9ba50052010-03-14 15:45:01 +08001144}
1145
1146/* Section 9.2.7 */
Harald Welte24a655f2010-04-30 19:54:29 +02001147static int gprs_ns_rx_status(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +08001148{
Harald Weltef030b212010-04-26 19:18:54 +02001149 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +08001150 struct tlv_parsed tp;
Harald Welte8f9a3ee2010-05-02 11:26:34 +02001151 uint8_t cause;
Harald Welte9ba50052010-03-14 15:45:01 +08001152 int rc;
1153
Harald Welte41337832010-05-16 00:24:26 +02001154 LOGP(DNS, LOGL_NOTICE, "NSEI=%u Rx NS STATUS ", nsvc->nsei);
Harald Welte9ba50052010-03-14 15:45:01 +08001155
Harald Weltebd33f3d2010-05-30 17:19:38 +02001156 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
1157 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
Harald Welte36250382010-05-28 10:08:14 +02001158 if (rc < 0) {
1159 LOGPC(DNS, LOGL_NOTICE, "Error during TLV Parse\n");
1160 LOGP(DNS, LOGL_ERROR, "NSEI=%u Rx NS STATUS: "
1161 "Error during TLV Parse\n", nsvc->nsei);
1162 return rc;
1163 }
Harald Welte9ba50052010-03-14 15:45:01 +08001164
1165 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE)) {
Harald Weltee4ecc8c2010-05-12 00:16:57 +02001166 LOGPC(DNS, LOGL_INFO, "missing cause IE\n");
Harald Welte9ba50052010-03-14 15:45:01 +08001167 return -EINVAL;
1168 }
1169
1170 cause = *TLVP_VAL(&tp, NS_IE_CAUSE);
Harald Welte41337832010-05-16 00:24:26 +02001171 LOGPC(DNS, LOGL_NOTICE, "cause=%s\n", gprs_ns_cause_str(cause));
Harald Welte9ba50052010-03-14 15:45:01 +08001172
1173 return 0;
1174}
1175
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001176/* Replace a nsvc object with another based on NSVCI.
1177 * This function replaces looks for a NSVC with the given NSVCI and replaces it
1178 * if possible and necessary. If replaced, the former value of *nsvc is
1179 * returned in *old_nsvc.
1180 * \return != 0 if *nsvc points to a matching NSVC.
1181 */
1182static int gprs_nsvc_replace_if_found(uint16_t nsvci,
1183 struct gprs_nsvc **nsvc,
1184 struct gprs_nsvc **old_nsvc)
1185{
1186 struct gprs_nsvc *matching_nsvc;
1187
1188 if ((*nsvc)->nsvci == nsvci) {
1189 *old_nsvc = NULL;
1190 return 1;
1191 }
1192
1193 matching_nsvc = gprs_nsvc_by_nsvci((*nsvc)->nsi, nsvci);
1194
1195 if (!matching_nsvc)
1196 return 0;
1197
1198 /* The NS-VCI is already used by this NS-VC */
1199
1200 char *old_peer;
1201
1202 /* Exchange the NS-VC objects */
1203 *old_nsvc = *nsvc;
1204 *nsvc = matching_nsvc;
1205
1206 /* Do logging */
1207 old_peer = talloc_strdup(*old_nsvc, gprs_ns_ll_str(*old_nsvc));
1208 LOGP(DNS, LOGL_INFO, "NS-VC changed link (NSVCI=%u) from %s to %s\n",
1209 nsvci, old_peer, gprs_ns_ll_str(*nsvc));
1210
1211 talloc_free(old_peer);
1212
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001213 return 1;
1214}
1215
Harald Welte9ba50052010-03-14 15:45:01 +08001216/* Section 7.3 */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001217static int gprs_ns_rx_reset(struct gprs_nsvc **nsvc, struct msgb *msg)
Harald Welte9ba50052010-03-14 15:45:01 +08001218{
1219 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte9ba50052010-03-14 15:45:01 +08001220 struct tlv_parsed tp;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001221 uint8_t cause;
1222 uint16_t nsvci, nsei;
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001223 struct gprs_nsvc *orig_nsvc = NULL;
Harald Welte9ba50052010-03-14 15:45:01 +08001224 int rc;
1225
Harald Weltebd33f3d2010-05-30 17:19:38 +02001226 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
1227 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
Harald Welte36250382010-05-28 10:08:14 +02001228 if (rc < 0) {
1229 LOGP(DNS, LOGL_ERROR, "NSEI=%u Rx NS RESET "
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001230 "Error during TLV Parse\n", (*nsvc)->nsei);
Harald Welte36250382010-05-28 10:08:14 +02001231 return rc;
1232 }
Harald Welte9ba50052010-03-14 15:45:01 +08001233
1234 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE) ||
1235 !TLVP_PRESENT(&tp, NS_IE_VCI) ||
1236 !TLVP_PRESENT(&tp, NS_IE_NSEI)) {
Harald Welteb8a6a832010-05-11 05:54:22 +02001237 LOGP(DNS, LOGL_ERROR, "NS RESET Missing mandatory IE\n");
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001238 gprs_ns_tx_status(*nsvc, NS_CAUSE_MISSING_ESSENT_IE, 0, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001239 return -EINVAL;
1240 }
1241
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001242 cause = *(uint8_t *) TLVP_VAL(&tp, NS_IE_CAUSE);
Harald Weltebfe62e52017-05-15 12:48:30 +02001243 nsvci = tlvp_val16be(&tp, NS_IE_VCI);
1244 nsei = tlvp_val16be(&tp, NS_IE_NSEI);
Harald Welte9ba50052010-03-14 15:45:01 +08001245
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001246 LOGP(DNS, LOGL_INFO, "NSVCI=%u%s Rx NS RESET (NSEI=%u, NSVCI=%u, cause=%s)\n",
1247 (*nsvc)->nsvci, (*nsvc)->nsvci_is_valid ? "" : "(invalid)",
1248 nsei, nsvci, gprs_ns_cause_str(cause));
1249
Jacob Erlbeckab852ee2013-10-24 01:33:24 +02001250 if ((*nsvc)->nsvci_is_valid && (*nsvc)->nsvci != nsvci) {
1251 if ((*nsvc)->persistent || (*nsvc)->remote_end_is_sgsn) {
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001252 /* The incoming RESET doesn't match the NSVCI. Send an
1253 * appropriate RESET_ACK and ignore the RESET.
1254 * See 3GPP TS 08.16, 7.3.1, 2nd paragraph.
1255 */
1256 ns_osmo_signal_dispatch_mismatch(*nsvc, msg,
1257 NS_PDUT_RESET,
1258 NS_IE_VCI);
1259 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_INV_VCI]);
1260 gprs_ns_tx_reset_ack(*nsvc);
1261 return 0;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001262 }
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001263
1264 /* NS-VCI has changed */
Jacob Erlbeck54b8b2d2013-10-24 01:33:25 +02001265 if (!gprs_nsvc_replace_if_found(nsvci, nsvc, &orig_nsvc)) {
1266 LOGP(DNS, LOGL_INFO, "Creating NS-VC %d replacing %d "
1267 "at %s\n",
1268 nsvci, (*nsvc)->nsvci,
1269 gprs_ns_ll_str(*nsvc));
1270 orig_nsvc = *nsvc;
1271 *nsvc = gprs_nsvc_create((*nsvc)->nsi, nsvci);
Jacob Erlbeck54b8b2d2013-10-24 01:33:25 +02001272 (*nsvc)->nsei = nsei;
1273 }
Jacob Erlbeckab852ee2013-10-24 01:33:24 +02001274 }
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001275
Jacob Erlbeckab852ee2013-10-24 01:33:24 +02001276 if ((*nsvc)->nsvci_is_valid && (*nsvc)->nsei != nsei) {
1277 if ((*nsvc)->persistent || (*nsvc)->remote_end_is_sgsn) {
1278 /* The incoming RESET doesn't match the NSEI. Send an
1279 * appropriate RESET_ACK and ignore the RESET.
1280 * See 3GPP TS 08.16, 7.3.1, 3rd paragraph.
1281 */
1282 ns_osmo_signal_dispatch_mismatch(*nsvc, msg,
1283 NS_PDUT_RESET,
1284 NS_IE_NSEI);
1285 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_INV_NSEI]);
Holger Hans Peter Freyther726e2722013-10-25 11:05:10 +02001286 rc = gprs_ns_tx_reset_ack(*nsvc);
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +02001287 CHECK_TX_RC(rc, *nsvc);
Jacob Erlbeckab852ee2013-10-24 01:33:24 +02001288 return 0;
1289 }
1290
1291 /* NSEI has changed */
1292 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_NSEI_CHG]);
1293 (*nsvc)->nsei = nsei;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001294 }
Harald Weltebbc9fac2010-05-03 18:54:12 +02001295
Harald Weltec1402a62010-05-12 11:48:44 +02001296 /* Mark NS-VC as blocked and alive */
Maxc513c0f2017-10-23 15:11:14 +02001297 ns_set_state(*nsvc, NSE_S_BLOCKED | NSE_S_ALIVE);
Harald Weltee8b9ca22010-05-11 18:18:31 +02001298
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001299 if (orig_nsvc) {
Jacob Erlbeck54b8b2d2013-10-24 01:33:25 +02001300 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_REPLACED]);
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001301 ns_osmo_signal_dispatch_replaced(*nsvc, orig_nsvc);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001302
1303 /* Update the ll info fields */
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001304 gprs_ns_ll_copy(*nsvc, orig_nsvc);
1305 gprs_ns_ll_clear(orig_nsvc);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001306 } else {
1307 (*nsvc)->nsei = nsei;
1308 (*nsvc)->nsvci = nsvci;
1309 (*nsvc)->nsvci_is_valid = 1;
Holger Hans Peter Freyther495b0db2015-11-04 14:39:37 +01001310 rate_ctr_group_upd_idx((*nsvc)->ctrg, nsvci);
1311 osmo_stat_item_group_udp_idx((*nsvc)->statg, nsvci);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001312 }
Harald Welte9ba50052010-03-14 15:45:01 +08001313
Harald Welte834f26d2010-05-11 06:20:54 +02001314 /* inform interested parties about the fact that this NSVC
1315 * has received RESET */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001316 ns_osmo_signal_dispatch(*nsvc, S_NS_RESET, cause);
Harald Welte834f26d2010-05-11 06:20:54 +02001317
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001318 rc = gprs_ns_tx_reset_ack(*nsvc);
Jacob Erlbeck05395a62013-10-08 12:04:45 +02001319
1320 /* start the test procedure */
Harald Welte35042a22019-02-23 14:07:00 +01001321 gprs_nsvc_start_test(*nsvc);
Jacob Erlbeck05395a62013-10-08 12:04:45 +02001322
1323 return rc;
Harald Welte9ba50052010-03-14 15:45:01 +08001324}
1325
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001326static int gprs_ns_rx_reset_ack(struct gprs_nsvc **nsvc, struct msgb *msg)
1327{
1328 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
1329 struct tlv_parsed tp;
1330 uint16_t nsvci, nsei;
1331 struct gprs_nsvc *orig_nsvc = NULL;
1332 int rc;
1333
1334 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
1335 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
1336 if (rc < 0) {
1337 LOGP(DNS, LOGL_ERROR, "NSEI=%u Rx NS RESET ACK "
1338 "Error during TLV Parse\n", (*nsvc)->nsei);
1339 return rc;
1340 }
1341
1342 if (!TLVP_PRESENT(&tp, NS_IE_VCI) ||
1343 !TLVP_PRESENT(&tp, NS_IE_NSEI)) {
1344 LOGP(DNS, LOGL_ERROR, "NS RESET ACK Missing mandatory IE\n");
Holger Hans Peter Freyther7c91bfd2013-10-25 11:02:05 +02001345 rc = gprs_ns_tx_status(*nsvc, NS_CAUSE_MISSING_ESSENT_IE, 0, msg);
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +02001346 CHECK_TX_RC(rc, *nsvc);
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001347 return -EINVAL;
1348 }
1349
Harald Weltebfe62e52017-05-15 12:48:30 +02001350 nsvci = tlvp_val16be(&tp, NS_IE_VCI);
1351 nsei = tlvp_val16be(&tp, NS_IE_NSEI);
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001352
1353 LOGP(DNS, LOGL_INFO, "NSVCI=%u%s Rx NS RESET ACK (NSEI=%u, NSVCI=%u)\n",
1354 (*nsvc)->nsvci, (*nsvc)->nsvci_is_valid ? "" : "(invalid)",
1355 nsei, nsvci);
1356
1357 if (!((*nsvc)->state & NSE_S_RESET)) {
1358 /* Not waiting for a RESET_ACK on this NS-VC, ignore it.
1359 * See 3GPP TS 08.16, 7.3.1, 5th paragraph.
1360 */
1361 LOGP(DNS, LOGL_ERROR,
1362 "NS RESET ACK Discarding unexpected message for "
1363 "NS-VCI %d from SGSN NSEI=%d\n",
1364 nsvci, nsei);
1365 return 0;
1366 }
1367
1368 if (!(*nsvc)->nsvci_is_valid) {
1369 LOGP(DNS, LOGL_NOTICE,
1370 "NS RESET ACK Uninitialised NS-VC (%u) for "
1371 "NS-VCI %d, NSEI=%d from %s\n",
1372 (*nsvc)->nsvci, nsvci, nsei, gprs_ns_ll_str(*nsvc));
1373 return -EINVAL;
1374 }
1375
1376 if ((*nsvc)->nsvci != nsvci) {
1377 /* NS-VCI has changed */
1378
1379 /* if !0, use another NSVC object that matches the NSVCI */
1380 int use_other_nsvc;
1381
1382 /* Only do this with BSS peers */
Jacob Erlbeckab852ee2013-10-24 01:33:24 +02001383 use_other_nsvc = !(*nsvc)->remote_end_is_sgsn &&
1384 !(*nsvc)->persistent;
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001385
1386 if (use_other_nsvc)
1387 /* Update *nsvc to point to the right NSVC object */
1388 use_other_nsvc = gprs_nsvc_replace_if_found(nsvci, nsvc,
1389 &orig_nsvc);
1390
1391 if (!use_other_nsvc) {
1392 /* The incoming RESET_ACK doesn't match the NSVCI.
1393 * See 3GPP TS 08.16, 7.3.1, 4th paragraph.
1394 */
1395 ns_osmo_signal_dispatch_mismatch(*nsvc, msg,
1396 NS_PDUT_RESET_ACK,
1397 NS_IE_VCI);
1398 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_INV_VCI]);
1399 LOGP(DNS, LOGL_ERROR,
1400 "NS RESET ACK Unknown NS-VCI %d (%s NSEI=%d) "
1401 "from %s\n",
1402 nsvci,
1403 (*nsvc)->remote_end_is_sgsn ? "SGSN" : "BSS",
1404 nsei, gprs_ns_ll_str(*nsvc));
1405 return -EINVAL;
1406 }
1407
1408 /* Notify others */
Jacob Erlbeck54b8b2d2013-10-24 01:33:25 +02001409 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_REPLACED]);
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001410 ns_osmo_signal_dispatch_replaced(*nsvc, orig_nsvc);
1411
1412 /* Update the ll info fields */
1413 gprs_ns_ll_copy(*nsvc, orig_nsvc);
1414 gprs_ns_ll_clear(orig_nsvc);
1415 } else if ((*nsvc)->nsei != nsei) {
Jacob Erlbeckab852ee2013-10-24 01:33:24 +02001416 if ((*nsvc)->persistent || (*nsvc)->remote_end_is_sgsn) {
1417 /* The incoming RESET_ACK doesn't match the NSEI.
1418 * See 3GPP TS 08.16, 7.3.1, 4th paragraph.
1419 */
1420 ns_osmo_signal_dispatch_mismatch(*nsvc, msg,
1421 NS_PDUT_RESET_ACK,
1422 NS_IE_NSEI);
1423 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_INV_NSEI]);
1424 LOGP(DNS, LOGL_ERROR,
1425 "NS RESET ACK Unknown NSEI %d (NS-VCI=%u) from %s\n",
1426 nsei, nsvci, gprs_ns_ll_str(*nsvc));
1427 return -EINVAL;
1428 }
1429
1430 /* NSEI has changed */
1431 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_NSEI_CHG]);
1432 (*nsvc)->nsei = nsei;
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001433 }
1434
1435 /* Mark NS-VC as blocked and alive */
Maxc513c0f2017-10-23 15:11:14 +02001436 ns_set_state(*nsvc, NSE_S_BLOCKED | NSE_S_ALIVE);
1437 ns_set_remote_state(*nsvc, NSE_S_BLOCKED | NSE_S_ALIVE);
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001438 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_BLOCKED]);
1439 if ((*nsvc)->persistent || (*nsvc)->remote_end_is_sgsn) {
1440 /* stop RESET timer */
1441 osmo_timer_del(&(*nsvc)->timer);
1442 }
1443 /* Initiate TEST proc.: Send ALIVE and start timer */
Harald Welte35042a22019-02-23 14:07:00 +01001444 gprs_nsvc_start_test(*nsvc);
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001445
Harald Welte35042a22019-02-23 14:07:00 +01001446 return 0;
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001447}
1448
Harald Welte834f26d2010-05-11 06:20:54 +02001449static int gprs_ns_rx_block(struct gprs_nsvc *nsvc, struct msgb *msg)
1450{
1451 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
1452 struct tlv_parsed tp;
1453 uint8_t *cause;
1454 int rc;
1455
Harald Weltee4ecc8c2010-05-12 00:16:57 +02001456 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS BLOCK\n", nsvc->nsei);
Harald Welte834f26d2010-05-11 06:20:54 +02001457
Maxc513c0f2017-10-23 15:11:14 +02001458 ns_mark_blocked(nsvc);
Harald Welte834f26d2010-05-11 06:20:54 +02001459
Harald Weltebd33f3d2010-05-30 17:19:38 +02001460 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
1461 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
Harald Welte36250382010-05-28 10:08:14 +02001462 if (rc < 0) {
1463 LOGP(DNS, LOGL_ERROR, "NSEI=%u Rx NS BLOCK "
1464 "Error during TLV Parse\n", nsvc->nsei);
1465 return rc;
1466 }
Harald Welte834f26d2010-05-11 06:20:54 +02001467
1468 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE) ||
1469 !TLVP_PRESENT(&tp, NS_IE_VCI)) {
Harald Welte834f26d2010-05-11 06:20:54 +02001470 LOGP(DNS, LOGL_ERROR, "NS RESET Missing mandatory IE\n");
Harald Weltec1402a62010-05-12 11:48:44 +02001471 gprs_ns_tx_status(nsvc, NS_CAUSE_MISSING_ESSENT_IE, 0, msg);
Harald Welte834f26d2010-05-11 06:20:54 +02001472 return -EINVAL;
1473 }
1474
1475 cause = (uint8_t *) TLVP_VAL(&tp, NS_IE_CAUSE);
1476 //nsvci = (uint16_t *) TLVP_VAL(&tp, NS_IE_VCI);
1477
Pablo Neira Ayuso2b88a2a2011-05-06 12:12:31 +02001478 ns_osmo_signal_dispatch(nsvc, S_NS_BLOCK, *cause);
Harald Weltec51c23c2010-05-13 12:55:20 +02001479 rate_ctr_inc(&nsvc->ctrg->ctr[NS_CTR_BLOCKED]);
Harald Welte834f26d2010-05-11 06:20:54 +02001480
Harald Welte9ef2e152019-02-19 23:42:04 +01001481 return gprs_ns_tx_block_ack(nsvc);
Harald Welte834f26d2010-05-11 06:20:54 +02001482}
1483
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001484int gprs_ns_vc_create(struct gprs_ns_inst *nsi, struct msgb *msg,
1485 struct gprs_nsvc *fallback_nsvc,
1486 struct gprs_nsvc **new_nsvc);
1487
1488int gprs_ns_process_msg(struct gprs_ns_inst *nsi, struct msgb *msg,
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001489 struct gprs_nsvc **nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001490
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001491/*! Receive incoming NS message from underlying transport layer
Harald Weltea9f23c82011-11-23 15:01:31 +01001492 * \param nsi NS instance to which the data belongs
1493 * \param[in] msg message buffer containing newly-received data
1494 * \param[in] saddr socketaddr from which data was received
1495 * \param[in] ll link-layer type in which data was received
1496 * \returns 0 in case of success, < 0 in case of error
1497 *
1498 * This is the main entry point int othe NS imlementation where frames
1499 * from the underlying transport (normally UDP) enter.
1500 */
Harald Weltef030b212010-04-26 19:18:54 +02001501int gprs_ns_rcvmsg(struct gprs_ns_inst *nsi, struct msgb *msg,
Harald Welteb3ee2652010-05-19 14:38:50 +02001502 struct sockaddr_in *saddr, enum gprs_ns_ll ll)
Harald Welte9ba50052010-03-14 15:45:01 +08001503{
Harald Weltef030b212010-04-26 19:18:54 +02001504 struct gprs_nsvc *nsvc;
Harald Welte9ba50052010-03-14 15:45:01 +08001505 int rc = 0;
1506
Harald Weltef030b212010-04-26 19:18:54 +02001507 /* look up the NSVC based on source address */
Harald Welte047f3872018-07-01 21:04:45 +02001508 nsvc = gprs_nsvc_by_rem_addr(nsi, saddr);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001509
Harald Weltef030b212010-04-26 19:18:54 +02001510 if (!nsvc) {
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001511 struct gprs_nsvc *fallback_nsvc;
1512
1513 fallback_nsvc = nsi->unknown_nsvc;
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +01001514 log_set_context(LOG_CTX_GB_NSVC, fallback_nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001515 fallback_nsvc->ip.bts_addr = *saddr;
1516 fallback_nsvc->ll = ll;
1517
1518 rc = gprs_ns_vc_create(nsi, msg, fallback_nsvc, &nsvc);
1519
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001520 if (rc < 0)
Harald Welte36250382010-05-28 10:08:14 +02001521 return rc;
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001522
1523 rc = 0;
1524 }
1525
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001526 if (nsvc)
1527 rc = gprs_ns_process_msg(nsi, msg, &nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001528
1529 return rc;
1530}
1531
Harald Welte4a62eda2019-03-18 18:27:00 +01001532char *gprs_ns_ll_str_buf(char *buf, size_t buf_len, const struct gprs_nsvc *nsvc)
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001533{
Max95308592017-10-24 15:54:28 +02001534 switch(nsvc->ll) {
1535 case GPRS_NS_LL_UDP:
Harald Welte4a62eda2019-03-18 18:27:00 +01001536 snprintf(buf, buf_len, "%s:%u",
Max95308592017-10-24 15:54:28 +02001537 inet_ntoa(nsvc->ip.bts_addr.sin_addr), osmo_ntohs(nsvc->ip.bts_addr.sin_port));
1538 break;
1539 case GPRS_NS_LL_FR_GRE:
Harald Welte4a62eda2019-03-18 18:27:00 +01001540 snprintf(buf, buf_len, "%s:%u",
Max95308592017-10-24 15:54:28 +02001541 inet_ntoa(nsvc->frgre.bts_addr.sin_addr), osmo_ntohs(nsvc->frgre.bts_addr.sin_port));
1542 break;
1543 default:
1544 buf[0] = '\0';
1545 break;
1546 }
1547
Harald Welte4a62eda2019-03-18 18:27:00 +01001548 buf[buf_len - 1] = '\0';
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001549
1550 return buf;
1551}
1552
Harald Welte4a62eda2019-03-18 18:27:00 +01001553const char *gprs_ns_ll_str(const struct gprs_nsvc *nsvc)
1554{
1555 static char buf[80];
1556 return gprs_ns_ll_str_buf(buf, sizeof(buf), nsvc);
1557}
1558
Harald Welte179f3572019-03-18 18:38:47 +01001559char *gprs_ns_ll_str_c(const void *ctx, const struct gprs_nsvc *nsvc)
1560{
1561 char *buf = talloc_size(ctx, INET6_ADDRSTRLEN+10);
1562 if (!buf)
1563 return buf;
1564 return gprs_ns_ll_str_buf(buf, INET6_ADDRSTRLEN+10, nsvc);
1565}
1566
Jacob Erlbeck96550e02013-10-14 22:06:47 +02001567void gprs_ns_ll_copy(struct gprs_nsvc *nsvc, struct gprs_nsvc *other)
1568{
1569 nsvc->ll = other->ll;
1570
1571 switch (nsvc->ll) {
1572 case GPRS_NS_LL_UDP:
1573 nsvc->ip = other->ip;
1574 break;
1575 case GPRS_NS_LL_FR_GRE:
1576 nsvc->frgre = other->frgre;
1577 break;
1578 default:
1579 break;
1580 }
1581}
1582
1583void gprs_ns_ll_clear(struct gprs_nsvc *nsvc)
1584{
1585 switch (nsvc->ll) {
1586 case GPRS_NS_LL_UDP:
1587 nsvc->ip.bts_addr.sin_addr.s_addr = INADDR_ANY;
1588 nsvc->ip.bts_addr.sin_port = 0;
1589 break;
1590 case GPRS_NS_LL_FR_GRE:
1591 nsvc->frgre.bts_addr.sin_addr.s_addr = INADDR_ANY;
1592 nsvc->frgre.bts_addr.sin_port = 0;
1593 break;
1594 default:
1595 break;
1596 }
1597}
1598
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001599/*! Create/get NS-VC independently from underlying transport layer
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001600 * \param nsi NS instance to which the data belongs
1601 * \param[in] msg message buffer containing newly-received data
1602 * \param[in] fallback_nsvc is used to send error messages back to the peer
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001603 * and to initialise the ll info of a created NS-VC object
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001604 * \param[out] new_nsvc contains a pointer to a NS-VC object if one has
1605 * been created or found
1606 * \returns < 0 in case of error, GPRS_NS_CS_SKIPPED if a message has been
1607 * skipped, GPRS_NS_CS_REJECTED if a message has been rejected and
1608 * answered accordingly, GPRS_NS_CS_CREATED if a new NS-VC object
1609 * has been created and registered, and GPRS_NS_CS_FOUND if an
1610 * existing NS-VC object has been found with the same NSEI.
1611 *
1612 * This contains the initial NS automaton state (NS-VC not yet attached).
1613 */
1614int gprs_ns_vc_create(struct gprs_ns_inst *nsi, struct msgb *msg,
1615 struct gprs_nsvc *fallback_nsvc,
1616 struct gprs_nsvc **new_nsvc)
1617{
1618 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *)msg->l2h;
1619 struct gprs_nsvc *existing_nsvc;
1620
1621 struct tlv_parsed tp;
Jacob Erlbeckb6390f92013-10-08 12:04:46 +02001622 uint16_t nsvci;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001623 uint16_t nsei;
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001624
1625 int rc;
1626
1627 if (nsh->pdu_type == NS_PDUT_STATUS) {
Jacob Erlbeck3d557b12013-10-28 13:29:11 +01001628 /* Do not respond, see 3GPP TS 08.16, 7.5.1 */
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001629 LOGP(DNS, LOGL_INFO, "Ignoring NS STATUS from %s "
1630 "for non-existing NS-VC\n",
Jacob Erlbeck96550e02013-10-14 22:06:47 +02001631 gprs_ns_ll_str(fallback_nsvc));
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001632 return GPRS_NS_CS_SKIPPED;
1633 }
1634
Jacob Erlbeck3d557b12013-10-28 13:29:11 +01001635 if (nsh->pdu_type == NS_PDUT_ALIVE_ACK) {
1636 /* Ignore this, see 3GPP TS 08.16, 7.4.1 */
1637 LOGP(DNS, LOGL_INFO, "Ignoring NS ALIVE ACK from %s "
1638 "for non-existing NS-VC\n",
1639 gprs_ns_ll_str(fallback_nsvc));
1640 return GPRS_NS_CS_SKIPPED;
1641 }
1642
1643 if (nsh->pdu_type == NS_PDUT_RESET_ACK) {
1644 /* Ignore this, see 3GPP TS 08.16, 7.3.1 */
1645 LOGP(DNS, LOGL_INFO, "Ignoring NS RESET ACK from %s "
1646 "for non-existing NS-VC\n",
1647 gprs_ns_ll_str(fallback_nsvc));
1648 return GPRS_NS_CS_SKIPPED;
1649 }
1650
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001651 /* Only the RESET procedure creates a new NSVC */
1652 if (nsh->pdu_type != NS_PDUT_RESET) {
1653 /* Since we have no NSVC, we have to use a fake */
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +01001654 log_set_context(LOG_CTX_GB_NSVC, fallback_nsvc);
Max584f4b62017-05-04 11:59:52 +02001655 LOGP(DNS, LOGL_INFO, "Rejecting NS PDU type %s "
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001656 "from %s for non-existing NS-VC\n",
Max584f4b62017-05-04 11:59:52 +02001657 get_value_string(gprs_ns_pdu_strings, nsh->pdu_type), gprs_ns_ll_str(fallback_nsvc));
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001658 fallback_nsvc->nsvci = fallback_nsvc->nsei = 0xfffe;
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001659 fallback_nsvc->nsvci_is_valid = 0;
Maxc513c0f2017-10-23 15:11:14 +02001660 ns_set_state(fallback_nsvc, NSE_S_ALIVE);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001661
1662 rc = gprs_ns_tx_status(fallback_nsvc,
1663 NS_CAUSE_PDU_INCOMP_PSTATE, 0, msg);
1664 if (rc < 0) {
1665 LOGP(DNS, LOGL_ERROR, "TX failed (%d) to peer %s\n",
Jacob Erlbeck96550e02013-10-14 22:06:47 +02001666 rc, gprs_ns_ll_str(fallback_nsvc));
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001667 return rc;
1668 }
1669 return GPRS_NS_CS_REJECTED;
1670 }
1671
1672 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
1673 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
1674 if (rc < 0) {
1675 LOGP(DNS, LOGL_ERROR, "Rx NS RESET Error %d during "
1676 "TLV Parse\n", rc);
1677 return rc;
1678 }
1679 if (!TLVP_PRESENT(&tp, NS_IE_CAUSE) ||
1680 !TLVP_PRESENT(&tp, NS_IE_VCI) || !TLVP_PRESENT(&tp, NS_IE_NSEI)) {
1681 LOGP(DNS, LOGL_ERROR, "NS RESET Missing mandatory IE\n");
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +02001682 rc = gprs_ns_tx_status(fallback_nsvc, NS_CAUSE_MISSING_ESSENT_IE, 0,
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001683 msg);
Holger Hans Peter Freyther9e1cd5a2013-10-25 11:09:26 +02001684 CHECK_TX_RC(rc, fallback_nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001685 return -EINVAL;
1686 }
Harald Weltebfe62e52017-05-15 12:48:30 +02001687 nsvci = tlvp_val16be(&tp, NS_IE_VCI);
1688 nsei = tlvp_val16be(&tp, NS_IE_NSEI);
Jacob Erlbeckb6390f92013-10-08 12:04:46 +02001689 /* Check if we already know this NSVCI, the remote end might
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001690 * simply have changed addresses, or it is a SGSN */
Jacob Erlbeckb6390f92013-10-08 12:04:46 +02001691 existing_nsvc = gprs_nsvc_by_nsvci(nsi, nsvci);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001692 if (!existing_nsvc) {
1693 *new_nsvc = gprs_nsvc_create(nsi, 0xffff);
Jacob Erlbeck9b591b72013-11-11 09:43:05 +01001694 (*new_nsvc)->nsvci_is_valid = 0;
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +01001695 log_set_context(LOG_CTX_GB_NSVC, *new_nsvc);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001696 gprs_ns_ll_copy(*new_nsvc, fallback_nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001697 LOGP(DNS, LOGL_INFO, "Creating NS-VC for BSS at %s\n",
Jacob Erlbeck96550e02013-10-14 22:06:47 +02001698 gprs_ns_ll_str(fallback_nsvc));
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001699
1700 return GPRS_NS_CS_CREATED;
1701 }
1702
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001703 /* Check NSEI */
1704 if (existing_nsvc->nsei != nsei) {
1705 LOGP(DNS, LOGL_NOTICE,
1706 "NS-VC changed NSEI (NSVCI=%u) from %u to %u\n",
1707 nsvci, existing_nsvc->nsei, nsei);
1708
1709 /* Override old NSEI */
1710 existing_nsvc->nsei = nsei;
1711
1712 /* Do statistics */
1713 rate_ctr_inc(&existing_nsvc->ctrg->ctr[NS_CTR_NSEI_CHG]);
1714 }
1715
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001716 *new_nsvc = existing_nsvc;
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001717 gprs_ns_ll_copy(*new_nsvc, fallback_nsvc);
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001718 return GPRS_NS_CS_FOUND;
1719}
1720
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001721/*! Process NS message independently from underlying transport layer
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001722 * \param nsi NS instance to which the data belongs
1723 * \param[in] msg message buffer containing newly-received data
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001724 * \param[inout] nsvc refers to the virtual connection, may be modified when
1725 * processing a NS_RESET
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001726 * \returns 0 in case of success, < 0 in case of error
1727 *
1728 * This contains the main NS automaton.
1729 */
1730int gprs_ns_process_msg(struct gprs_ns_inst *nsi, struct msgb *msg,
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001731 struct gprs_nsvc **nsvc)
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001732{
1733 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
Harald Welte047f3872018-07-01 21:04:45 +02001734 struct tlv_parsed tp;
Jacob Erlbeck84cdc702013-10-08 12:04:44 +02001735 int rc = 0;
1736
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001737 msgb_nsei(msg) = (*nsvc)->nsei;
Harald Weltec5478482010-03-18 00:01:43 +08001738
Neels Hofmeyr8b86cd72017-02-23 18:03:28 +01001739 log_set_context(LOG_CTX_GB_NSVC, *nsvc);
Harald Welte91f7f4b2010-05-15 23:52:02 +02001740
Harald Welte144e0292010-05-13 11:45:07 +02001741 /* Increment number of Incoming bytes */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001742 rate_ctr_inc(&(*nsvc)->ctrg->ctr[NS_CTR_PKTS_IN]);
1743 rate_ctr_add(&(*nsvc)->ctrg->ctr[NS_CTR_BYTES_IN], msgb_l2len(msg));
Harald Welte144e0292010-05-13 11:45:07 +02001744
Harald Welte94c9b442019-03-16 14:38:19 +01001745 if (nsvc_is_not_used(*nsvc) && !ns_is_sns(nsh->pdu_type) && nsh->pdu_type != NS_PDUT_STATUS) {
1746 LOGP(DNS, LOGL_NOTICE, "NSEI=%u Rx %s on unused/pre-configured endpoint, discarding\n",
1747 (*nsvc)->nsei, get_value_string(gprs_ns_pdu_strings, nsh->pdu_type));
1748 gprs_ns_tx_status(*nsvc, NS_CAUSE_PROTO_ERR_UNSPEC, 0, msg);
1749 return 0;
1750 }
1751
Harald Welte9ba50052010-03-14 15:45:01 +08001752 switch (nsh->pdu_type) {
1753 case NS_PDUT_ALIVE:
Harald Welte2bffac52010-05-12 15:55:23 +00001754 /* If we're dead and blocked and suddenly receive a
1755 * NS-ALIVE out of the blue, we might have been re-started
1756 * and should send a NS-RESET to make sure everything recovers
1757 * fine. */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001758 if ((*nsvc)->state == NSE_S_BLOCKED)
Jacob Erlbeck6ac70a42014-10-07 14:12:30 +02001759 rc = gprs_nsvc_reset((*nsvc), NS_CAUSE_PDU_INCOMP_PSTATE);
1760 else if (!((*nsvc)->state & NSE_S_RESET))
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001761 rc = gprs_ns_tx_alive_ack(*nsvc);
Harald Welte9ba50052010-03-14 15:45:01 +08001762 break;
1763 case NS_PDUT_ALIVE_ACK:
Harald Welte047f3872018-07-01 21:04:45 +02001764 ns_mark_alive(*nsvc);
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +02001765 if ((*nsvc)->timer_mode == NSVC_TIMER_TNS_ALIVE)
Jacob Erlbeckfc9533d2015-10-29 00:55:58 +01001766 osmo_stat_item_set((*nsvc)->statg->items[NS_STAT_ALIVE_DELAY],
Jacob Erlbeck0a1400f2015-10-06 15:23:25 +02001767 nsvc_timer_elapsed_ms(*nsvc));
Harald Welte90af1942010-05-15 23:02:24 +02001768 /* stop Tns-alive and start Tns-test */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001769 nsvc_start_timer(*nsvc, NSVC_TIMER_TNS_TEST);
1770 if ((*nsvc)->remote_end_is_sgsn) {
Harald Welte7fb7e612010-05-03 21:11:22 +02001771 /* FIXME: this should be one level higher */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001772 if ((*nsvc)->state & NSE_S_BLOCKED)
1773 rc = gprs_ns_tx_unblock(*nsvc);
Harald Welte7fb7e612010-05-03 21:11:22 +02001774 }
Harald Welte9ba50052010-03-14 15:45:01 +08001775 break;
1776 case NS_PDUT_UNITDATA:
1777 /* actual user data */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001778 rc = gprs_ns_rx_unitdata(*nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001779 break;
1780 case NS_PDUT_STATUS:
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001781 rc = gprs_ns_rx_status(*nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001782 break;
1783 case NS_PDUT_RESET:
Harald Welte24a655f2010-04-30 19:54:29 +02001784 rc = gprs_ns_rx_reset(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001785 break;
1786 case NS_PDUT_RESET_ACK:
Jacob Erlbeck5405a102013-10-24 01:33:23 +02001787 rc = gprs_ns_rx_reset_ack(nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001788 break;
1789 case NS_PDUT_UNBLOCK:
1790 /* Section 7.2: unblocking procedure */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001791 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS UNBLOCK\n", (*nsvc)->nsei);
Maxc513c0f2017-10-23 15:11:14 +02001792 ns_mark_unblocked(*nsvc);
Stefan Sperlingc6bfc632018-11-20 11:01:36 +01001793 /* This UNBLOCK_ACK message will cause our peer to move us into NS_UNBLOCKED state. */
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001794 rc = gprs_ns_tx_simple(*nsvc, NS_PDUT_UNBLOCK_ACK);
Stefan Sperling797558e2018-11-19 17:18:41 +01001795 if (rc < 0)
1796 break;
Stefan Sperlingc6bfc632018-11-20 11:01:36 +01001797 /*
1798 * UNBLOCK_ACK has been transmitted.
1799 * Signal handlers may send additional messages following UNBLOCK_ACK under
1800 * the assumption that NS is now in UNBLOCKED state at our peer's end.
1801 */
Stefan Sperling797558e2018-11-19 17:18:41 +01001802 ns_osmo_signal_dispatch(*nsvc, S_NS_UNBLOCK, 0);
Harald Welte9ba50052010-03-14 15:45:01 +08001803 break;
1804 case NS_PDUT_UNBLOCK_ACK:
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001805 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS UNBLOCK ACK\n", (*nsvc)->nsei);
Harald Weltec1402a62010-05-12 11:48:44 +02001806 /* mark NS-VC as unblocked + active */
Maxc513c0f2017-10-23 15:11:14 +02001807 ns_set_state(*nsvc, NSE_S_ALIVE);
1808 ns_set_remote_state(*nsvc, NSE_S_ALIVE);
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001809 ns_osmo_signal_dispatch(*nsvc, S_NS_UNBLOCK, 0);
Harald Welte9ba50052010-03-14 15:45:01 +08001810 break;
1811 case NS_PDUT_BLOCK:
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001812 rc = gprs_ns_rx_block(*nsvc, msg);
Harald Welte9ba50052010-03-14 15:45:01 +08001813 break;
1814 case NS_PDUT_BLOCK_ACK:
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001815 LOGP(DNS, LOGL_INFO, "NSEI=%u Rx NS BLOCK ACK\n", (*nsvc)->nsei);
Harald Weltef030b212010-04-26 19:18:54 +02001816 /* mark remote NS-VC as blocked + active */
Maxc513c0f2017-10-23 15:11:14 +02001817 ns_set_remote_state(*nsvc, NSE_S_BLOCKED | NSE_S_ALIVE);
Harald Welte9ba50052010-03-14 15:45:01 +08001818 break;
Harald Welte047f3872018-07-01 21:04:45 +02001819 case SNS_PDUT_CONFIG:
1820 if (!nsi->bss_sns_fi)
1821 goto unexpected_sns;
1822 /* one additional byte ('end flag') before the TLV part starts */
1823 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data+1,
1824 msgb_l2len(msg) - sizeof(*nsh)-1, 0, 0);
1825 if (rc < 0) {
1826 LOGPC(DNS, LOGL_NOTICE, "Error during TLV Parse in %s\n", msgb_hexdump(msg));
1827 return rc;
1828 }
1829 /* All sub-network service related message types */
1830 rc = gprs_ns_rx_sns(nsi, msg, &tp);
1831 break;
1832 case SNS_PDUT_ACK:
1833 case SNS_PDUT_ADD:
1834 case SNS_PDUT_CHANGE_WEIGHT:
1835 case SNS_PDUT_DELETE:
1836 if (!nsi->bss_sns_fi)
1837 goto unexpected_sns;
1838 /* weird layout: NSEI TLV, then value-only transaction IE, then TLV again */
1839 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data+5,
1840 msgb_l2len(msg) - sizeof(*nsh)-5, 0, 0);
1841 if (rc < 0) {
1842 LOGPC(DNS, LOGL_NOTICE, "Error during TLV Parse in %s\n", msgb_hexdump(msg));
1843 return rc;
1844 }
1845 tp.lv[NS_IE_NSEI].val = nsh->data+2;
1846 tp.lv[NS_IE_NSEI].len = 2;
1847 tp.lv[NS_IE_TRANS_ID].val = nsh->data+4;
1848 tp.lv[NS_IE_TRANS_ID].len = 1;
1849 rc = gprs_ns_rx_sns(nsi, msg, &tp);
1850 break;
1851 case SNS_PDUT_CONFIG_ACK:
1852 case SNS_PDUT_SIZE:
1853 case SNS_PDUT_SIZE_ACK:
1854 if (!nsi->bss_sns_fi)
1855 goto unexpected_sns;
1856 rc = tlv_parse(&tp, &ns_att_tlvdef, nsh->data,
1857 msgb_l2len(msg) - sizeof(*nsh), 0, 0);
1858 if (rc < 0) {
1859 LOGPC(DNS, LOGL_NOTICE, "Error during TLV Parse in %s\n", msgb_hexdump(msg));
1860 return rc;
1861 }
1862 /* All sub-network service related message types */
1863 rc = gprs_ns_rx_sns(nsi, msg, &tp);
1864 break;
Harald Welte9ba50052010-03-14 15:45:01 +08001865 default:
Harald Weltee4ecc8c2010-05-12 00:16:57 +02001866 LOGP(DNS, LOGL_NOTICE, "NSEI=%u Rx Unknown NS PDU type 0x%02x\n",
Jacob Erlbeck5e6d6792013-10-14 22:06:48 +02001867 (*nsvc)->nsei, nsh->pdu_type);
Harald Welte9ba50052010-03-14 15:45:01 +08001868 rc = -EINVAL;
1869 break;
Harald Welte047f3872018-07-01 21:04:45 +02001870unexpected_sns:
1871 LOGP(DNS, LOGL_NOTICE, "NSEI=%u Rx %s for NS Instance that has no SNS!\n",
1872 (*nsvc)->nsei, get_value_string(gprs_ns_pdu_strings, nsh->pdu_type));
1873 rc = -EINVAL;
1874 break;
Harald Welte9ba50052010-03-14 15:45:01 +08001875 }
1876 return rc;
1877}
1878
Harald Welte047f3872018-07-01 21:04:45 +02001879static bool gprs_sns_fsm_registered = false;
1880
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001881/*! Create a new GPRS NS instance
Harald Weltea9f23c82011-11-23 15:01:31 +01001882 * \param[in] cb Call-back function for incoming BSSGP data
1883 * \returns dynamically allocated gprs_ns_inst
1884 */
Harald Welte4fcdd762012-06-16 16:40:42 +08001885struct gprs_ns_inst *gprs_ns_instantiate(gprs_ns_cb_t *cb, void *ctx)
Harald Weltef030b212010-04-26 19:18:54 +02001886{
Harald Welte4fcdd762012-06-16 16:40:42 +08001887 struct gprs_ns_inst *nsi = talloc_zero(ctx, struct gprs_ns_inst);
Harald Weltef030b212010-04-26 19:18:54 +02001888
Harald Welte047f3872018-07-01 21:04:45 +02001889 if (!gprs_sns_fsm_registered) {
1890 gprs_sns_init();
1891 gprs_sns_fsm_registered = true;
1892 }
1893
Harald Weltef030b212010-04-26 19:18:54 +02001894 nsi->cb = cb;
1895 INIT_LLIST_HEAD(&nsi->gprs_nsvcs);
Harald Weltefe4ab902010-05-12 17:19:53 +00001896 nsi->timeout[NS_TOUT_TNS_BLOCK] = 3;
1897 nsi->timeout[NS_TOUT_TNS_BLOCK_RETRIES] = 3;
1898 nsi->timeout[NS_TOUT_TNS_RESET] = 3;
1899 nsi->timeout[NS_TOUT_TNS_RESET_RETRIES] = 3;
1900 nsi->timeout[NS_TOUT_TNS_TEST] = 30;
1901 nsi->timeout[NS_TOUT_TNS_ALIVE] = 3;
1902 nsi->timeout[NS_TOUT_TNS_ALIVE_RETRIES] = 10;
Harald Welte047f3872018-07-01 21:04:45 +02001903 nsi->timeout[NS_TOUT_TSNS_PROV] = 3; /* 1..10 */
Harald Weltef030b212010-04-26 19:18:54 +02001904
Harald Welte60cc6ac2010-05-13 14:20:56 +02001905 /* Create the dummy NSVC that we use for sending
1906 * messages to non-existant/unknown NS-VC's */
Harald Weltef5430362012-06-17 12:25:53 +08001907 nsi->unknown_nsvc = gprs_nsvc_create(nsi, 0xfffe);
Jacob Erlbeck9b591b72013-11-11 09:43:05 +01001908 nsi->unknown_nsvc->nsvci_is_valid = 0;
Harald Welte60cc6ac2010-05-13 14:20:56 +02001909 llist_del(&nsi->unknown_nsvc->list);
Holger Hans Peter Freyther777b0562014-07-07 20:00:35 +02001910 INIT_LLIST_HEAD(&nsi->unknown_nsvc->list);
Harald Weltedd1c83c2010-05-13 13:58:08 +02001911
Harald Welte3771d092010-04-30 20:26:32 +02001912 return nsi;
Harald Weltef030b212010-04-26 19:18:54 +02001913}
1914
Holger Hans Peter Freytherc62a1bf2013-07-02 09:10:11 +02001915void gprs_ns_close(struct gprs_ns_inst *nsi)
Harald Weltef030b212010-04-26 19:18:54 +02001916{
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001917 struct gprs_nsvc *nsvc, *nsvc2;
Harald Weltef030b212010-04-26 19:18:54 +02001918
Holger Hans Peter Freyther777b0562014-07-07 20:00:35 +02001919 gprs_nsvc_delete(nsi->unknown_nsvc);
1920
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001921 /* delete all NSVCs and clear their timers */
1922 llist_for_each_entry_safe(nsvc, nsvc2, &nsi->gprs_nsvcs, list)
1923 gprs_nsvc_delete(nsvc);
1924
1925 /* close socket and unregister */
1926 if (nsi->nsip.fd.data) {
1927 close(nsi->nsip.fd.fd);
1928 osmo_fd_unregister(&nsi->nsip.fd);
Holger Hans Peter Freytherc62a1bf2013-07-02 09:10:11 +02001929 nsi->nsip.fd.data = NULL;
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001930 }
Holger Hans Peter Freytherc62a1bf2013-07-02 09:10:11 +02001931}
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001932
Neels Hofmeyr87e45502017-06-20 00:17:59 +02001933/*! Destroy an entire NS instance
Holger Hans Peter Freytherc62a1bf2013-07-02 09:10:11 +02001934 * \param nsi gprs_ns_inst that is to be destroyed
1935 *
1936 * This function releases all resources associated with the
1937 * NS-instance.
1938 */
1939void gprs_ns_destroy(struct gprs_ns_inst *nsi)
1940{
1941 gprs_ns_close(nsi);
Andreas Eversbergaaccdac2012-09-28 10:11:25 +02001942 /* free the NSI */
Harald Weltef030b212010-04-26 19:18:54 +02001943 talloc_free(nsi);
1944}
1945
1946
1947/* NS-over-IP code, according to 3GPP TS 48.016 Chapter 6.2
1948 * We don't support Size Procedure, Configuration Procedure, ChangeWeight Procedure */
1949
1950/* Read a single NS-over-IP message */
Pablo Neira Ayusobfadfb72011-05-06 12:11:23 +02001951static struct msgb *read_nsip_msg(struct osmo_fd *bfd, int *error,
Harald Weltef030b212010-04-26 19:18:54 +02001952 struct sockaddr_in *saddr)
1953{
Harald Welteba4c6662010-05-19 15:38:10 +02001954 struct msgb *msg = gprs_ns_msgb_alloc();
Harald Weltef030b212010-04-26 19:18:54 +02001955 int ret = 0;
1956 socklen_t saddr_len = sizeof(*saddr);
1957
1958 if (!msg) {
1959 *error = -ENOMEM;
1960 return NULL;
1961 }
1962
Holger Hans Peter Freyther26c32512010-05-28 03:25:36 +08001963 ret = recvfrom(bfd->fd, msg->data, NS_ALLOC_SIZE - NS_ALLOC_HEADROOM, 0,
Harald Weltef030b212010-04-26 19:18:54 +02001964 (struct sockaddr *)saddr, &saddr_len);
1965 if (ret < 0) {
Max38176d22018-11-06 17:04:21 +01001966 LOGP(DNS, LOGL_ERROR, "recv error %s during NSIP recvfrom %s\n",
1967 strerror(errno), osmo_sock_get_name2(bfd->fd));
Harald Weltef030b212010-04-26 19:18:54 +02001968 msgb_free(msg);
1969 *error = ret;
1970 return NULL;
1971 } else if (ret == 0) {
1972 msgb_free(msg);
1973 *error = ret;
1974 return NULL;
1975 }
1976
1977 msg->l2h = msg->data;
1978 msgb_put(msg, ret);
1979
1980 return msg;
1981}
1982
Pablo Neira Ayusobfadfb72011-05-06 12:11:23 +02001983static int handle_nsip_read(struct osmo_fd *bfd)
Harald Weltef030b212010-04-26 19:18:54 +02001984{
1985 int error;
1986 struct sockaddr_in saddr;
1987 struct gprs_ns_inst *nsi = bfd->data;
1988 struct msgb *msg = read_nsip_msg(bfd, &error, &saddr);
1989
1990 if (!msg)
1991 return error;
1992
Harald Welteb3ee2652010-05-19 14:38:50 +02001993 error = gprs_ns_rcvmsg(nsi, msg, &saddr, GPRS_NS_LL_UDP);
Harald Welte91813cf2010-05-12 18:38:45 +00001994
1995 msgb_free(msg);
1996
1997 return error;
Harald Weltef030b212010-04-26 19:18:54 +02001998}
1999
Pablo Neira Ayusobfadfb72011-05-06 12:11:23 +02002000static int handle_nsip_write(struct osmo_fd *bfd)
Harald Weltef030b212010-04-26 19:18:54 +02002001{
2002 /* FIXME: actually send the data here instead of nsip_sendmsg() */
2003 return -EIO;
2004}
2005
Harald Welteb3ee2652010-05-19 14:38:50 +02002006static int nsip_sendmsg(struct gprs_nsvc *nsvc, struct msgb *msg)
Harald Weltef030b212010-04-26 19:18:54 +02002007{
2008 int rc;
2009 struct gprs_ns_inst *nsi = nsvc->nsi;
2010 struct sockaddr_in *daddr = &nsvc->ip.bts_addr;
2011
2012 rc = sendto(nsi->nsip.fd.fd, msg->data, msg->len, 0,
2013 (struct sockaddr *)daddr, sizeof(*daddr));
2014
Holger Hans Peter Freyther52746462012-03-01 20:30:32 +01002015 msgb_free(msg);
Harald Weltef030b212010-04-26 19:18:54 +02002016
2017 return rc;
2018}
2019
2020/* UDP Port 23000 carries the LLC-in-BSSGP-in-NS protocol stack */
Pablo Neira Ayusobfadfb72011-05-06 12:11:23 +02002021static int nsip_fd_cb(struct osmo_fd *bfd, unsigned int what)
Harald Weltef030b212010-04-26 19:18:54 +02002022{
2023 int rc = 0;
2024
Harald Welte16886992019-03-20 10:26:39 +01002025 if (what & OSMO_FD_READ)
Harald Weltef030b212010-04-26 19:18:54 +02002026 rc = handle_nsip_read(bfd);
Harald Welte16886992019-03-20 10:26:39 +01002027 if (what & OSMO_FD_WRITE)
Harald Weltef030b212010-04-26 19:18:54 +02002028 rc = handle_nsip_write(bfd);
2029
2030 return rc;
2031}
2032
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002033/*! Create a listening socket for GPRS NS/UDP/IP
Harald Weltea9f23c82011-11-23 15:01:31 +01002034 * \param[in] nsi NS protocol instance to listen
2035 * \returns >=0 (fd) in case of success, negative in case of error
2036 *
2037 * A call to this function will create a UDP socket bound to the port
2038 * number and IP address specified in the NS protocol instance. The
2039 * file descriptor of the socket will be stored in nsi->nsip.fd.
2040 */
Harald Welte7fb05232010-05-19 15:09:09 +02002041int gprs_ns_nsip_listen(struct gprs_ns_inst *nsi)
Harald Weltef030b212010-04-26 19:18:54 +02002042{
Harald Welte73952e32012-06-16 14:59:56 +08002043 struct in_addr in;
Philipp Maier224a6dd2017-10-17 15:23:53 +02002044 struct in_addr remote;
2045 char remote_str[INET_ADDRSTRLEN];
Harald Weltef030b212010-04-26 19:18:54 +02002046 int ret;
2047
Harald Weltebfe62e52017-05-15 12:48:30 +02002048 in.s_addr = osmo_htonl(nsi->nsip.local_ip);
Philipp Maier224a6dd2017-10-17 15:23:53 +02002049 remote.s_addr = osmo_htonl(nsi->nsip.remote_ip);
Harald Welte73952e32012-06-16 14:59:56 +08002050
2051 nsi->nsip.fd.cb = nsip_fd_cb;
2052 nsi->nsip.fd.data = nsi;
Philipp Maier224a6dd2017-10-17 15:23:53 +02002053
2054 if (nsi->nsip.remote_ip && nsi->nsip.remote_port) {
2055 /* connect to ensure only we only accept packets from the
2056 * configured remote end/peer */
2057 snprintf(remote_str, sizeof(remote_str), "%s", inet_ntoa(remote));
2058 ret =
2059 osmo_sock_init2_ofd(&nsi->nsip.fd, AF_INET, SOCK_DGRAM,
2060 IPPROTO_UDP, inet_ntoa(in),
2061 nsi->nsip.local_port, remote_str,
2062 nsi->nsip.remote_port, OSMO_SOCK_F_BIND | OSMO_SOCK_F_CONNECT);
2063
2064 LOGP(DNS, LOGL_NOTICE,
2065 "Listening for nsip packets from %s:%u on %s:%u\n",
2066 remote_str, nsi->nsip.remote_port, inet_ntoa(in), nsi->nsip.local_port);
2067 } else {
2068 /* Accept UDP packets from any source IP/Port */
2069 ret = osmo_sock_init_ofd(&nsi->nsip.fd, AF_INET, SOCK_DGRAM,
2070 IPPROTO_UDP, inet_ntoa(in), nsi->nsip.local_port, OSMO_SOCK_F_BIND);
2071
2072 LOGP(DNS, LOGL_NOTICE, "Listening for nsip packets on %s:%u\n", inet_ntoa(in), nsi->nsip.local_port);
2073 }
2074
Stefan Sperlingf6538212018-10-10 16:09:32 +02002075 if (ret < 0) {
2076 nsi->nsip.fd.cb = NULL;
2077 nsi->nsip.fd.data = NULL;
Harald Weltef030b212010-04-26 19:18:54 +02002078 return ret;
Stefan Sperlingf6538212018-10-10 16:09:32 +02002079 }
Harald Weltef030b212010-04-26 19:18:54 +02002080
Holger Hans Peter Freyther2c3393d2013-03-25 11:59:58 +01002081 ret = setsockopt(nsi->nsip.fd.fd, IPPROTO_IP, IP_TOS,
2082 &nsi->nsip.dscp, sizeof(nsi->nsip.dscp));
2083 if (ret < 0)
2084 LOGP(DNS, LOGL_ERROR,
2085 "Failed to set the DSCP to %d with ret(%d) errno(%d)\n",
2086 nsi->nsip.dscp, ret, errno);
2087
Maxa19c1262017-10-20 15:39:45 +02002088 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 +02002089
2090 return ret;
2091}
Harald Welte3771d092010-04-30 20:26:32 +02002092
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002093/*! Initiate a RESET procedure
Harald Weltea9f23c82011-11-23 15:01:31 +01002094 * \param[in] nsvc NS-VC in which to start the procedure
2095 * \param[in] cause Numeric NS cause value
2096 *
2097 * This is a high-level function initiating a NS-RESET procedure. It
2098 * will not only send a NS-RESET, but also set the state to BLOCKED and
2099 * start the Tns-reset timer.
2100 */
Jacob Erlbeck0540d832014-10-08 11:47:36 +02002101int gprs_nsvc_reset(struct gprs_nsvc *nsvc, uint8_t cause)
Harald Welte731d1fc2010-05-14 11:53:08 +00002102{
Jacob Erlbeck0540d832014-10-08 11:47:36 +02002103 int rc;
2104
Harald Welte047f3872018-07-01 21:04:45 +02002105 ERR_IF_NSVC_USES_SNS(nsvc, "RESET procedure based on API request");
2106
Harald Welteb1020d52010-05-25 22:17:30 +02002107 LOGP(DNS, LOGL_INFO, "NSEI=%u RESET procedure based on API request\n",
2108 nsvc->nsei);
2109
Harald Welte731d1fc2010-05-14 11:53:08 +00002110 /* Mark NS-VC locally as blocked and dead */
Maxc513c0f2017-10-23 15:11:14 +02002111 ns_set_state(nsvc, NSE_S_BLOCKED | NSE_S_RESET);
Jacob Erlbeck6ac70a42014-10-07 14:12:30 +02002112
Harald Welte731d1fc2010-05-14 11:53:08 +00002113 /* Send NS-RESET PDU */
Jacob Erlbeck0540d832014-10-08 11:47:36 +02002114 rc = gprs_ns_tx_reset(nsvc, cause);
2115 if (rc < 0) {
Harald Welte731d1fc2010-05-14 11:53:08 +00002116 LOGP(DNS, LOGL_ERROR, "NSEI=%u, error resetting NS-VC\n",
2117 nsvc->nsei);
2118 }
2119 /* Start Tns-reset */
2120 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_RESET);
Jacob Erlbeck0540d832014-10-08 11:47:36 +02002121
2122 return rc;
Harald Welte731d1fc2010-05-14 11:53:08 +00002123}
2124
Neels Hofmeyr87e45502017-06-20 00:17:59 +02002125/*! Establish a NS connection (from the BSS) to the SGSN
Harald Weltea9f23c82011-11-23 15:01:31 +01002126 * \param nsi NS-instance
2127 * \param[in] dest Destination IP/Port
2128 * \param[in] nsei NSEI of the to-be-established NS-VC
2129 * \param[in] nsvci NSVCI of the to-be-established NS-VC
2130 * \returns struct gprs_nsvc representing the new NS-VC
2131 *
2132 * This function will establish a single NS/UDP/IP connection in uplink
2133 * (BSS to SGSN) direction.
2134 */
Harald Weltef5430362012-06-17 12:25:53 +08002135struct gprs_nsvc *gprs_ns_nsip_connect(struct gprs_ns_inst *nsi,
Harald Welte1203de32010-05-01 11:28:43 +02002136 struct sockaddr_in *dest, uint16_t nsei,
2137 uint16_t nsvci)
Harald Welte3771d092010-04-30 20:26:32 +02002138{
2139 struct gprs_nsvc *nsvc;
2140
Harald Welte047f3872018-07-01 21:04:45 +02002141 nsvc = gprs_nsvc_by_rem_addr(nsi, dest);
Harald Welte38407ef2010-05-12 11:56:39 +00002142 if (!nsvc)
Harald Weltef5430362012-06-17 12:25:53 +08002143 nsvc = gprs_nsvc_create(nsi, nsvci);
Harald Welte38407ef2010-05-12 11:56:39 +00002144 nsvc->ip.bts_addr = *dest;
Harald Welte1203de32010-05-01 11:28:43 +02002145 nsvc->nsei = nsei;
Harald Welte3771d092010-04-30 20:26:32 +02002146 nsvc->remote_end_is_sgsn = 1;
2147
Holger Hans Peter Freyther5617d992010-05-23 21:18:01 +08002148 gprs_nsvc_reset(nsvc, NS_CAUSE_OM_INTERVENTION);
2149 return nsvc;
Harald Welte3771d092010-04-30 20:26:32 +02002150}
Harald Weltea9f23c82011-11-23 15:01:31 +01002151
Harald Welte047f3872018-07-01 21:04:45 +02002152/*! Establish a NS connection (from the BSS) to the SGSN using SNS auto-configuration
2153 * \param nsi NS-instance
2154 * \param[in] dest Destination IP/Port
2155 * \param[in] nsei NSEI of the to-be-established NS-VC
2156 * \param[in] nsvci NSVCI of the to-be-established NS-VC
2157 * \returns struct gprs_nsvc representing the new NS-VC
2158 *
2159 * This function will establish a single NS/UDP/IP connection in uplink
2160 * (BSS to SGSN) direction. It will start with the SNS-SIZE procedure,
2161 * followed by BSS-originated SNS-CONFIG, then SGSN-originated SNS-CONFIG.
2162 *
2163 * Once configuration completes, the user will be notified by the S_SNS_CONFIGURED signal,
2164 * at which point he typically would want to initiate NS-RESET by means of gprs_nsvc_reset().
2165 */
2166struct gprs_nsvc *gprs_ns_nsip_connect_sns(struct gprs_ns_inst *nsi,
2167 struct sockaddr_in *dest, uint16_t nsei,
2168 uint16_t nsvci)
2169{
2170 struct gprs_nsvc *nsvc;
2171
2172 /* FIXME: We are getting the order wrong here. Normally, one would want
2173 * to start the SNS FSM *before* creating any NS-VC and then create the NS-VC
2174 * after the SNS layer has established the IP/port/etc. However, this would
2175 * require some massive code and API changes compared to existing libosmogb,
2176 * so let's keep the old logic. */
2177 nsvc = gprs_nsvc_by_rem_addr(nsi, dest);
Harald Welte94c9b442019-03-16 14:38:19 +01002178 if (!nsvc) {
2179 /* create NSVC with 0 data + signalling weight. This is illegal in SNS
2180 * and can hence only be created locally and serves as indication that
2181 * this NS-VC shall not be used for anything except SNS _unless_ it is
2182 * modified via SNS-{CONFIG,CHANGEWEIGHT,ADD} to become part of the
2183 * active NS-VCs */
2184 nsvc = gprs_nsvc_create2(nsi, nsvci, 0, 0);
2185 }
Harald Welte047f3872018-07-01 21:04:45 +02002186 nsvc->ip.bts_addr = *dest;
2187 nsvc->nsei = nsei;
2188 nsvc->remote_end_is_sgsn = 1;
2189 /* NSVCs are always UNBLOCKED in IP-SNS */
2190 ns_set_state(nsvc, 0);
2191
2192 if (nsi->bss_sns_fi)
2193 osmo_fsm_inst_term(nsi->bss_sns_fi, OSMO_FSM_TERM_REQUEST, NULL);
2194 nsi->bss_sns_fi = gprs_sns_bss_fsm_alloc(nsi, nsvc, "NSIP");
2195 gprs_sns_bss_fsm_start(nsi);
2196 return nsvc;
2197}
2198
Harald Weltecca49632012-06-16 17:45:59 +08002199void gprs_ns_set_log_ss(int ss)
2200{
2201 DNS = ss;
2202}
2203
Daniel Willmannf1318fe2018-05-29 20:55:18 +02002204/*! Append the nsvc state to a talloc string
2205 * \param s The string to append to (allocated with talloc)
2206 * \param[in] nsvc The NS-VC to print the state of
2207 * \returns The new string with state information appended to it
2208 *
2209 * This function will append a comma-separated state of the NS-VC to the
2210 * string. The string needs to be allocated with talloc (e.g. talloc_strdup)
2211 */
2212char *gprs_nsvc_state_append(char *s, struct gprs_nsvc *nsvc)
2213{
2214 s = talloc_asprintf_append(s,
2215 "%u,%u,%s,%s,%s,%s,%s\n",
2216 nsvc->nsei, nsvc->nsvci,
2217 NS_DESC_A(nsvc->state),
2218 NS_DESC_B(nsvc->state),
2219 nsvc->remote_end_is_sgsn ? "SGSN" : "BSS",
2220 NS_DESC_A(nsvc->remote_state),
2221 NS_DESC_B(nsvc->remote_state));
2222
2223 return s;
2224}
2225
Harald Welte35042a22019-02-23 14:07:00 +01002226/*! Start the ALIVE timer procedure in all NS-VCs part of this NS Instance */
2227void gprs_nsvc_start_test(struct gprs_nsvc *nsvc)
2228{
Harald Welte94c9b442019-03-16 14:38:19 +01002229 /* skip the initial NS-VC unless it has explicitly been configured
2230 * via SNS-CONFIG from the SGSN */
2231 if (nsvc_is_not_used(nsvc))
2232 return;
Harald Welte35042a22019-02-23 14:07:00 +01002233 gprs_ns_tx_alive(nsvc);
2234 nsvc_start_timer(nsvc, NSVC_TIMER_TNS_TEST);
2235}
2236
Harald Welte047f3872018-07-01 21:04:45 +02002237void gprs_start_alive_all_nsvcs(struct gprs_ns_inst *nsi)
2238{
2239 struct gprs_nsvc *nsvc;
2240 llist_for_each_entry(nsvc, &nsi->gprs_nsvcs, list) {
2241 /* start the test procedure */
2242 gprs_nsvc_start_test(nsvc);
2243 }
2244}
2245
Harald Welte96e2a002017-06-12 21:44:18 +02002246/*! @} */