blob: b07f010a4e81a5eeb21374740130c2b77a0799c3 [file] [log] [blame]
Alexander Couzens6a161492020-07-12 13:45:50 +02001/*! \file gprs_ns2_sns.c
2 * NS Sub-Network Service Protocol implementation
3 * 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 */
5
Harald Weltec1c7e4a2021-03-02 20:47:29 +01006/* (C) 2018-2021 by Harald Welte <laforge@gnumonks.org>
Alexander Couzens6a161492020-07-12 13:45:50 +02007 * (C) 2020 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
8 * Author: Alexander Couzens <lynxis@fe80.eu>
9 *
10 * All Rights Reserved
11 *
12 * SPDX-License-Identifier: GPL-2.0+
13 *
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License as published by
16 * the Free Software Foundation; either version 2 of the License, or
17 * (at your option) any later version.
18 *
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
23 *
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
26 *
27 */
28
29/* The BSS NSE only has one SGSN IP address configured, and it will use the SNS procedures
30 * to communicated its local IPs/ports as well as all the SGSN side IPs/ports and
31 * associated weights. The BSS then uses this to establish a full mesh
32 * of NSVCs between all BSS-side IPs/ports and SGSN-side IPs/ports.
33 *
34 * Known limitation/expectation/bugs:
35 * - No concurrent dual stack. It supports either IPv4 or IPv6, but not both at the same time.
36 * - SNS Add/Change/Delete: Doesn't answer on the same NSVC as received SNS ADD/CHANGE/DELETE PDUs.
37 * - SNS Add/Change/Delete: Doesn't communicated the failed IPv4/IPv6 entries on the SNS_ACK.
38 */
39
40#include <errno.h>
41
42#include <netinet/in.h>
43#include <arpa/inet.h>
44#include <stdint.h>
45
46#include <osmocom/core/fsm.h>
47#include <osmocom/core/msgb.h>
48#include <osmocom/core/socket.h>
Alexander Couzens412bc342020-11-19 05:24:37 +010049#include <osmocom/core/sockaddr_str.h>
Alexander Couzens6a161492020-07-12 13:45:50 +020050#include <osmocom/gsm/tlv.h>
51#include <osmocom/gprs/gprs_msgb.h>
52#include <osmocom/gprs/gprs_ns2.h>
53#include <osmocom/gprs/protocol/gsm_08_16.h>
54
55#include "gprs_ns2_internal.h"
56
57#define S(x) (1 << (x))
58
59enum ns2_sns_type {
60 IPv4,
61 IPv6,
62};
63
Harald Welte4f127462021-03-02 20:49:10 +010064enum ns2_sns_role {
65 GPRS_SNS_ROLE_BSS,
66 GPRS_SNS_ROLE_SGSN,
67};
68
Harald Welte694dad52021-03-23 15:22:16 +010069/* BSS-side-only states _ST_BSS_; SGSN-side only states _ST_SGSN_; others shared */
Alexander Couzens6a161492020-07-12 13:45:50 +020070enum gprs_sns_bss_state {
71 GPRS_SNS_ST_UNCONFIGURED,
Harald Welte694dad52021-03-23 15:22:16 +010072 GPRS_SNS_ST_BSS_SIZE, /*!< SNS-SIZE procedure ongoing */
73 GPRS_SNS_ST_BSS_CONFIG_BSS, /*!< SNS-CONFIG procedure (BSS->SGSN) ongoing */
74 GPRS_SNS_ST_BSS_CONFIG_SGSN, /*!< SNS-CONFIG procedure (SGSN->BSS) ongoing */
Alexander Couzens6a161492020-07-12 13:45:50 +020075 GPRS_SNS_ST_CONFIGURED,
Harald Welte4f127462021-03-02 20:49:10 +010076 GPRS_SNS_ST_SGSN_WAIT_CONFIG, /* !< SGSN role: Wait for CONFIG from BSS */
77 GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK, /* !< SGSN role: Wait for CONFIG-ACK from BSS */
Alexander Couzens6a161492020-07-12 13:45:50 +020078};
79
80enum gprs_sns_event {
Alexander Couzens67725e22021-02-15 02:37:03 +010081 GPRS_SNS_EV_REQ_SELECT_ENDPOINT, /*!< Select a SNS endpoint from the list */
82 GPRS_SNS_EV_RX_SIZE,
83 GPRS_SNS_EV_RX_SIZE_ACK,
84 GPRS_SNS_EV_RX_CONFIG,
85 GPRS_SNS_EV_RX_CONFIG_END, /*!< SNS-CONFIG with end flag received */
86 GPRS_SNS_EV_RX_CONFIG_ACK,
87 GPRS_SNS_EV_RX_ADD,
88 GPRS_SNS_EV_RX_DELETE,
89 GPRS_SNS_EV_RX_CHANGE_WEIGHT,
Harald Welteb9f23872021-03-02 20:48:54 +010090 GPRS_SNS_EV_RX_ACK, /*!< Rx of SNS-ACK (response to ADD/DELETE/CHG_WEIGHT */
Harald Welte04647e12021-03-02 18:50:40 +010091 GPRS_SNS_EV_REQ_NO_NSVC, /*!< no more NS-VC remaining (all dead) */
Alexander Couzens67725e22021-02-15 02:37:03 +010092 GPRS_SNS_EV_REQ_NSVC_ALIVE, /*!< a NS-VC became alive */
Harald Welte04647e12021-03-02 18:50:40 +010093 GPRS_SNS_EV_REQ_ADD_BIND, /*!< add a new local bind to this NSE */
94 GPRS_SNS_EV_REQ_DELETE_BIND, /*!< remove a local bind from this NSE */
Alexander Couzens6a161492020-07-12 13:45:50 +020095};
96
97static const struct value_string gprs_sns_event_names[] = {
Alexander Couzens67725e22021-02-15 02:37:03 +010098 { GPRS_SNS_EV_REQ_SELECT_ENDPOINT, "REQ_SELECT_ENDPOINT" },
99 { GPRS_SNS_EV_RX_SIZE, "RX_SIZE" },
100 { GPRS_SNS_EV_RX_SIZE_ACK, "RX_SIZE_ACK" },
101 { GPRS_SNS_EV_RX_CONFIG, "RX_CONFIG" },
102 { GPRS_SNS_EV_RX_CONFIG_END, "RX_CONFIG_END" },
103 { GPRS_SNS_EV_RX_CONFIG_ACK, "RX_CONFIG_ACK" },
104 { GPRS_SNS_EV_RX_ADD, "RX_ADD" },
105 { GPRS_SNS_EV_RX_DELETE, "RX_DELETE" },
Harald Welteb9f23872021-03-02 20:48:54 +0100106 { GPRS_SNS_EV_RX_ACK, "RX_ACK" },
Alexander Couzens67725e22021-02-15 02:37:03 +0100107 { GPRS_SNS_EV_RX_CHANGE_WEIGHT, "RX_CHANGE_WEIGHT" },
108 { GPRS_SNS_EV_REQ_NO_NSVC, "REQ_NO_NSVC" },
109 { GPRS_SNS_EV_REQ_NSVC_ALIVE, "REQ_NSVC_ALIVE"},
110 { GPRS_SNS_EV_REQ_ADD_BIND, "REQ_ADD_BIND"},
111 { GPRS_SNS_EV_REQ_DELETE_BIND, "REQ_DELETE_BIND"},
Alexander Couzens6a161492020-07-12 13:45:50 +0200112 { 0, NULL }
113};
114
Alexander Couzense769f522020-12-07 07:37:07 +0100115struct sns_endpoint {
116 struct llist_head list;
117 struct osmo_sockaddr saddr;
118};
119
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100120struct ns2_sns_bind {
121 struct llist_head list;
122 struct gprs_ns2_vc_bind *bind;
123};
124
Alexander Couzens6a161492020-07-12 13:45:50 +0200125struct ns2_sns_state {
126 struct gprs_ns2_nse *nse;
127
128 enum ns2_sns_type ip;
Harald Welte4f127462021-03-02 20:49:10 +0100129 enum ns2_sns_role role; /* local role: BSS or SGSN */
Alexander Couzens6a161492020-07-12 13:45:50 +0200130
Alexander Couzense769f522020-12-07 07:37:07 +0100131 /* holds the list of initial SNS endpoints */
132 struct llist_head sns_endpoints;
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100133 /* list of used struct ns2_sns_bind */
134 struct llist_head binds;
135 /* pointer to the bind which was used to initiate the SNS connection */
136 struct ns2_sns_bind *initial_bind;
Alexander Couzense769f522020-12-07 07:37:07 +0100137 /* prevent recursive reselection */
138 bool reselection_running;
139
140 /* The current initial SNS endpoints.
141 * The initial connection will be moved into the NSE
142 * if configured via SNS. Otherwise it will be removed
143 * in configured state. */
144 struct sns_endpoint *initial;
Alexander Couzens6a161492020-07-12 13:45:50 +0200145 /* all SNS PDU will be sent over this nsvc */
146 struct gprs_ns2_vc *sns_nsvc;
Alexander Couzens90ee9632020-12-07 06:18:32 +0100147 /* timer N */
148 int N;
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100149 /* true if at least one nsvc is alive */
150 bool alive;
Alexander Couzens6a161492020-07-12 13:45:50 +0200151
152 /* local configuration to send to the remote end */
153 struct gprs_ns_ie_ip4_elem *ip4_local;
154 size_t num_ip4_local;
155
156 /* local configuration to send to the remote end */
157 struct gprs_ns_ie_ip6_elem *ip6_local;
158 size_t num_ip6_local;
159
160 /* local configuration about our capabilities in terms of connections to
161 * remote (SGSN) side */
162 size_t num_max_nsvcs;
163 size_t num_max_ip4_remote;
164 size_t num_max_ip6_remote;
165
166 /* remote configuration as received */
167 struct gprs_ns_ie_ip4_elem *ip4_remote;
168 unsigned int num_ip4_remote;
169
170 /* remote configuration as received */
171 struct gprs_ns_ie_ip6_elem *ip6_remote;
172 unsigned int num_ip6_remote;
173};
174
175static inline struct gprs_ns2_nse *nse_inst_from_fi(struct osmo_fsm_inst *fi)
176{
177 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
178 return gss->nse;
179}
180
181/* helper function to compute the sum of all (data or signaling) weights */
182static int ip4_weight_sum(const struct gprs_ns_ie_ip4_elem *ip4, unsigned int num,
183 bool data_weight)
184{
185 unsigned int i;
186 int weight_sum = 0;
187
188 for (i = 0; i < num; i++) {
189 if (data_weight)
190 weight_sum += ip4[i].data_weight;
191 else
192 weight_sum += ip4[i].sig_weight;
193 }
194 return weight_sum;
195}
196#define ip4_weight_sum_data(x,y) ip4_weight_sum(x, y, true)
197#define ip4_weight_sum_sig(x,y) ip4_weight_sum(x, y, false)
198
199/* helper function to compute the sum of all (data or signaling) weights */
200static int ip6_weight_sum(const struct gprs_ns_ie_ip6_elem *ip6, unsigned int num,
201 bool data_weight)
202{
203 unsigned int i;
204 int weight_sum = 0;
205
206 for (i = 0; i < num; i++) {
207 if (data_weight)
208 weight_sum += ip6[i].data_weight;
209 else
210 weight_sum += ip6[i].sig_weight;
211 }
212 return weight_sum;
213}
214#define ip6_weight_sum_data(x,y) ip6_weight_sum(x, y, true)
215#define ip6_weight_sum_sig(x,y) ip6_weight_sum(x, y, false)
216
Harald Weltec1c7e4a2021-03-02 20:47:29 +0100217static int nss_weight_sum(const struct ns2_sns_state *nss, bool data_weight)
218{
219 return ip4_weight_sum(nss->ip4_remote, nss->num_ip4_remote, data_weight) +
220 ip6_weight_sum(nss->ip6_remote, nss->num_ip6_remote, data_weight);
221}
222#define nss_weight_sum_data(nss) nss_weight_sum(nss, true)
223#define nss_weight_sum_sig(nss) nss_weight_sum(nss, false)
224
Alexander Couzens6a161492020-07-12 13:45:50 +0200225static struct gprs_ns2_vc *nsvc_by_ip4_elem(struct gprs_ns2_nse *nse,
226 const struct gprs_ns_ie_ip4_elem *ip4)
227{
228 struct osmo_sockaddr sa;
229 /* copy over. Both data structures use network byte order */
230 sa.u.sin.sin_addr.s_addr = ip4->ip_addr;
231 sa.u.sin.sin_port = ip4->udp_port;
232 sa.u.sin.sin_family = AF_INET;
233
Alexander Couzens38b19e82020-09-23 23:56:37 +0200234 return gprs_ns2_nsvc_by_sockaddr_nse(nse, &sa);
Alexander Couzens6a161492020-07-12 13:45:50 +0200235}
236
237static struct gprs_ns2_vc *nsvc_by_ip6_elem(struct gprs_ns2_nse *nse,
238 const struct gprs_ns_ie_ip6_elem *ip6)
239{
240 struct osmo_sockaddr sa;
241 /* copy over. Both data structures use network byte order */
242 sa.u.sin6.sin6_addr = ip6->ip_addr;
243 sa.u.sin6.sin6_port = ip6->udp_port;
244 sa.u.sin6.sin6_family = AF_INET;
245
Alexander Couzens38b19e82020-09-23 23:56:37 +0200246 return gprs_ns2_nsvc_by_sockaddr_nse(nse, &sa);
Alexander Couzens6a161492020-07-12 13:45:50 +0200247}
248
Alexander Couzens125298f2020-10-11 21:22:42 +0200249/*! Return the initial SNS remote socket address
250 * \param nse NS Entity
251 * \return address of the initial SNS connection; NULL in case of error
252 */
253const struct osmo_sockaddr *gprs_ns2_nse_sns_remote(struct gprs_ns2_nse *nse)
254{
255 struct ns2_sns_state *gss;
256
257 if (!nse->bss_sns_fi)
258 return NULL;
259
260 gss = (struct ns2_sns_state *) nse->bss_sns_fi->priv;
Alexander Couzense769f522020-12-07 07:37:07 +0100261 return &gss->initial->saddr;
Alexander Couzens125298f2020-10-11 21:22:42 +0200262}
263
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100264/*! called when a nsvc is beeing freed or the nsvc became dead */
265void ns2_sns_replace_nsvc(struct gprs_ns2_vc *nsvc)
Alexander Couzens6a161492020-07-12 13:45:50 +0200266{
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100267 struct gprs_ns2_nse *nse = nsvc->nse;
Alexander Couzens6a161492020-07-12 13:45:50 +0200268 struct gprs_ns2_vc *tmp;
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100269 struct osmo_fsm_inst *fi = nse->bss_sns_fi;
Alexander Couzens6a161492020-07-12 13:45:50 +0200270 struct ns2_sns_state *gss;
Alexander Couzens6a161492020-07-12 13:45:50 +0200271
272 if (!fi)
273 return;
274
275 gss = (struct ns2_sns_state *) fi->priv;
276 if (nsvc != gss->sns_nsvc)
277 return;
278
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100279 gss->sns_nsvc = NULL;
280 if (gss->alive) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200281 llist_for_each_entry(tmp, &nse->nsvc, list) {
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100282 if (ns2_vc_is_unblocked(tmp)) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200283 gss->sns_nsvc = tmp;
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100284 return;
285 }
Alexander Couzens6a161492020-07-12 13:45:50 +0200286 }
287 } else {
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100288 /* the SNS is waiting for its first NS-VC to come up
289 * choose any other nsvc */
290 llist_for_each_entry(tmp, &nse->nsvc, list) {
291 if (nsvc != tmp) {
292 gss->sns_nsvc = tmp;
293 return;
294 }
295 }
Alexander Couzens6a161492020-07-12 13:45:50 +0200296 }
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100297
Alexander Couzens67725e22021-02-15 02:37:03 +0100298 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_REQ_NO_NSVC, NULL);
Alexander Couzens6a161492020-07-12 13:45:50 +0200299}
300
Harald Welte46eb7642021-03-04 17:49:59 +0100301static void ns2_clear_ipv46_entries_local(struct ns2_sns_state *gss)
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100302{
303 TALLOC_FREE(gss->ip4_local);
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100304 TALLOC_FREE(gss->ip6_local);
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100305
306 gss->num_ip4_local = 0;
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100307 gss->num_ip6_local = 0;
Harald Welte46eb7642021-03-04 17:49:59 +0100308}
309
310static void ns2_clear_ipv46_entries_remote(struct ns2_sns_state *gss)
311{
312 TALLOC_FREE(gss->ip4_remote);
313 TALLOC_FREE(gss->ip6_remote);
314
315 gss->num_ip4_remote = 0;
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100316 gss->num_ip6_remote = 0;
317}
318
Daniel Willmanncf8371a2021-01-16 15:13:51 +0100319static void ns2_vc_create_ip(struct osmo_fsm_inst *fi, struct gprs_ns2_nse *nse, const struct osmo_sockaddr *remote,
320 uint8_t sig_weight, uint8_t data_weight)
Alexander Couzens6a161492020-07-12 13:45:50 +0200321{
322 struct gprs_ns2_inst *nsi = nse->nsi;
323 struct gprs_ns2_vc *nsvc;
324 struct gprs_ns2_vc_bind *bind;
Daniel Willmanncf8371a2021-01-16 15:13:51 +0100325
326 /* for every bind, create a connection if bind type == IP */
327 llist_for_each_entry(bind, &nsi->binding, list) {
328 if (bind->ll != GPRS_NS2_LL_UDP)
329 continue;
330 /* ignore failed connection */
331 nsvc = gprs_ns2_ip_connect_inactive(bind,
332 remote,
333 nse, 0);
334 if (!nsvc) {
335 LOGPFSML(fi, LOGL_ERROR, "SNS-CONFIG: Failed to create NSVC\n");
336 continue;
337 }
338
339 nsvc->sig_weight = sig_weight;
340 nsvc->data_weight = data_weight;
341 }
342}
343
344static void ns2_nsvc_create_ip4(struct osmo_fsm_inst *fi,
345 struct gprs_ns2_nse *nse,
346 const struct gprs_ns_ie_ip4_elem *ip4)
347{
Alexander Couzensc068d862020-10-12 04:11:51 +0200348 struct osmo_sockaddr remote = { };
Alexander Couzens6a161492020-07-12 13:45:50 +0200349 /* copy over. Both data structures use network byte order */
350 remote.u.sin.sin_family = AF_INET;
351 remote.u.sin.sin_addr.s_addr = ip4->ip_addr;
352 remote.u.sin.sin_port = ip4->udp_port;
353
Daniel Willmanncf8371a2021-01-16 15:13:51 +0100354 ns2_vc_create_ip(fi, nse, &remote, ip4->sig_weight, ip4->data_weight);
Alexander Couzens6a161492020-07-12 13:45:50 +0200355}
356
357static void ns2_nsvc_create_ip6(struct osmo_fsm_inst *fi,
358 struct gprs_ns2_nse *nse,
359 const struct gprs_ns_ie_ip6_elem *ip6)
360{
Alexander Couzens6a161492020-07-12 13:45:50 +0200361 struct osmo_sockaddr remote = {};
362 /* copy over. Both data structures use network byte order */
363 remote.u.sin6.sin6_family = AF_INET6;
364 remote.u.sin6.sin6_addr = ip6->ip_addr;
365 remote.u.sin6.sin6_port = ip6->udp_port;
366
Daniel Willmanncf8371a2021-01-16 15:13:51 +0100367 ns2_vc_create_ip(fi, nse, &remote, ip6->sig_weight, ip6->data_weight);
Alexander Couzens6a161492020-07-12 13:45:50 +0200368}
369
Harald Weltee8c61062021-03-24 13:16:27 +0100370static struct gprs_ns2_vc *nsvc_for_bind_and_remote(struct gprs_ns2_nse *nse,
371 struct gprs_ns2_vc_bind *bind,
372 const struct osmo_sockaddr *remote)
373{
374 struct gprs_ns2_vc *nsvc;
375
376 llist_for_each_entry(nsvc, &nse->nsvc, list) {
377 if (nsvc->bind != bind)
378 continue;
379
380 if (!osmo_sockaddr_cmp(remote, gprs_ns2_ip_vc_remote(nsvc)))
381 return nsvc;
382 }
383 return NULL;
384}
Alexander Couzens6a161492020-07-12 13:45:50 +0200385
386static int create_missing_nsvcs(struct osmo_fsm_inst *fi)
387{
388 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
389 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
390 struct gprs_ns2_vc *nsvc;
Harald Welte3053bbb2021-03-24 13:22:18 +0100391 struct ns2_sns_bind *sbind;
Alexander Couzens6a161492020-07-12 13:45:50 +0200392 struct osmo_sockaddr remote = { };
393 unsigned int i;
394
Harald Weltee8c61062021-03-24 13:16:27 +0100395 /* iterate over all remote IPv4 endpoints */
Alexander Couzens6a161492020-07-12 13:45:50 +0200396 for (i = 0; i < gss->num_ip4_remote; i++) {
397 const struct gprs_ns_ie_ip4_elem *ip4 = &gss->ip4_remote[i];
398
399 remote.u.sin.sin_family = AF_INET;
400 remote.u.sin.sin_addr.s_addr = ip4->ip_addr;
401 remote.u.sin.sin_port = ip4->udp_port;
402
Harald Welte3053bbb2021-03-24 13:22:18 +0100403 /* iterate over all local binds within this SNS */
404 llist_for_each_entry(sbind, &gss->binds, list) {
405 struct gprs_ns2_vc_bind *bind = sbind->bind;
406
Harald Weltee8c61062021-03-24 13:16:27 +0100407 /* we only care about UDP binds */
Daniel Willmann967e2c12021-01-14 16:58:17 +0100408 if (bind->ll != GPRS_NS2_LL_UDP)
409 continue;
Alexander Couzens6a161492020-07-12 13:45:50 +0200410
Harald Weltee8c61062021-03-24 13:16:27 +0100411 nsvc = nsvc_for_bind_and_remote(nse, bind, &remote);
412 if (!nsvc) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200413 nsvc = gprs_ns2_ip_connect_inactive(bind, &remote, nse, 0);
414 if (!nsvc) {
415 /* TODO: add to a list to send back a NS-STATUS */
416 continue;
417 }
418 }
419
420 /* update data / signalling weight */
421 nsvc->data_weight = ip4->data_weight;
422 nsvc->sig_weight = ip4->sig_weight;
423 nsvc->sns_only = false;
424 }
425 }
426
Harald Weltee8c61062021-03-24 13:16:27 +0100427 /* iterate over all remote IPv4 endpoints */
Alexander Couzens6a161492020-07-12 13:45:50 +0200428 for (i = 0; i < gss->num_ip6_remote; i++) {
429 const struct gprs_ns_ie_ip6_elem *ip6 = &gss->ip6_remote[i];
430
431 remote.u.sin6.sin6_family = AF_INET6;
432 remote.u.sin6.sin6_addr = ip6->ip_addr;
433 remote.u.sin6.sin6_port = ip6->udp_port;
434
Harald Welte3053bbb2021-03-24 13:22:18 +0100435 /* iterate over all local binds within this SNS */
436 llist_for_each_entry(sbind, &gss->binds, list) {
437 struct gprs_ns2_vc_bind *bind = sbind->bind;
438
Daniel Willmann967e2c12021-01-14 16:58:17 +0100439 if (bind->ll != GPRS_NS2_LL_UDP)
440 continue;
Alexander Couzens6a161492020-07-12 13:45:50 +0200441
Harald Weltee8c61062021-03-24 13:16:27 +0100442 /* we only care about UDP binds */
443 nsvc = nsvc_for_bind_and_remote(nse, bind, &remote);
444 if (!nsvc) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200445 nsvc = gprs_ns2_ip_connect_inactive(bind, &remote, nse, 0);
446 if (!nsvc) {
447 /* TODO: add to a list to send back a NS-STATUS */
448 continue;
449 }
450 }
451
452 /* update data / signalling weight */
453 nsvc->data_weight = ip6->data_weight;
454 nsvc->sig_weight = ip6->sig_weight;
455 nsvc->sns_only = false;
456 }
457 }
458
459
460 return 0;
461}
462
463/* Add a given remote IPv4 element to gprs_sns_state */
464static int add_remote_ip4_elem(struct ns2_sns_state *gss, const struct gprs_ns_ie_ip4_elem *ip4)
465{
466 unsigned int i;
467
468 if (gss->num_ip4_remote >= gss->num_max_ip4_remote)
469 return -NS_CAUSE_INVAL_NR_NS_VC;
470
471 /* check for duplicates */
472 for (i = 0; i < gss->num_ip4_remote; i++) {
473 if (memcmp(&gss->ip4_remote[i], ip4, sizeof(*ip4)))
474 continue;
475 /* TODO: log message duplicate */
Alexander Couzens6a161492020-07-12 13:45:50 +0200476 return -NS_CAUSE_PROTO_ERR_UNSPEC;
477 }
478
479 gss->ip4_remote = talloc_realloc(gss, gss->ip4_remote, struct gprs_ns_ie_ip4_elem,
480 gss->num_ip4_remote+1);
481 gss->ip4_remote[gss->num_ip4_remote] = *ip4;
482 gss->num_ip4_remote += 1;
483 return 0;
484}
485
486/* Remove a given remote IPv4 element from gprs_sns_state */
487static int remove_remote_ip4_elem(struct ns2_sns_state *gss, const struct gprs_ns_ie_ip4_elem *ip4)
488{
489 unsigned int i;
490
491 for (i = 0; i < gss->num_ip4_remote; i++) {
492 if (memcmp(&gss->ip4_remote[i], ip4, sizeof(*ip4)))
493 continue;
494 /* all array elements < i remain as they are; all > i are shifted left by one */
495 memmove(&gss->ip4_remote[i], &gss->ip4_remote[i+1], gss->num_ip4_remote-i-1);
496 gss->num_ip4_remote -= 1;
497 return 0;
498 }
499 return -1;
500}
501
502/* update the weights for specified remote IPv4 */
503static int update_remote_ip4_elem(struct ns2_sns_state *gss, const struct gprs_ns_ie_ip4_elem *ip4)
504{
505 unsigned int i;
506
507 for (i = 0; i < gss->num_ip4_remote; i++) {
508 if (gss->ip4_remote[i].ip_addr != ip4->ip_addr ||
509 gss->ip4_remote[i].udp_port != ip4->udp_port)
510 continue;
511
512 gss->ip4_remote[i].sig_weight = ip4->sig_weight;
513 gss->ip4_remote[i].data_weight = ip4->data_weight;
514 return 0;
515 }
516 return -1;
517}
518
519/* Add a given remote IPv6 element to gprs_sns_state */
520static int add_remote_ip6_elem(struct ns2_sns_state *gss, const struct gprs_ns_ie_ip6_elem *ip6)
521{
522 if (gss->num_ip6_remote >= gss->num_max_ip6_remote)
523 return -NS_CAUSE_INVAL_NR_NS_VC;
524
525 gss->ip6_remote = talloc_realloc(gss, gss->ip6_remote, struct gprs_ns_ie_ip6_elem,
526 gss->num_ip6_remote+1);
527 gss->ip6_remote[gss->num_ip6_remote] = *ip6;
528 gss->num_ip6_remote += 1;
529 return 0;
530}
531
532/* Remove a given remote IPv6 element from gprs_sns_state */
533static int remove_remote_ip6_elem(struct ns2_sns_state *gss, const struct gprs_ns_ie_ip6_elem *ip6)
534{
535 unsigned int i;
536
537 for (i = 0; i < gss->num_ip6_remote; i++) {
538 if (memcmp(&gss->ip6_remote[i], ip6, sizeof(*ip6)))
539 continue;
540 /* all array elements < i remain as they are; all > i are shifted left by one */
541 memmove(&gss->ip6_remote[i], &gss->ip6_remote[i+1], gss->num_ip6_remote-i-1);
542 gss->num_ip6_remote -= 1;
543 return 0;
544 }
545 return -1;
546}
547
548/* update the weights for specified remote IPv6 */
549static int update_remote_ip6_elem(struct ns2_sns_state *gss, const struct gprs_ns_ie_ip6_elem *ip6)
550{
551 unsigned int i;
552
553 for (i = 0; i < gss->num_ip6_remote; i++) {
554 if (memcmp(&gss->ip6_remote[i].ip_addr, &ip6->ip_addr, sizeof(ip6->ip_addr)) ||
555 gss->ip6_remote[i].udp_port != ip6->udp_port)
556 continue;
557 gss->ip6_remote[i].sig_weight = ip6->sig_weight;
558 gss->ip6_remote[i].data_weight = ip6->data_weight;
559 return 0;
560 }
561 return -1;
562}
563
564static int do_sns_change_weight(struct osmo_fsm_inst *fi, const struct gprs_ns_ie_ip4_elem *ip4, const struct gprs_ns_ie_ip6_elem *ip6)
565{
566 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
567 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
568 struct gprs_ns2_vc *nsvc;
569 struct osmo_sockaddr sa = {};
Alexander Couzens9a4cf272020-10-11 20:48:04 +0200570 const struct osmo_sockaddr *remote;
Alexander Couzens6a161492020-07-12 13:45:50 +0200571 uint8_t new_signal;
572 uint8_t new_data;
573
574 /* TODO: Upon receiving an SNS-CHANGEWEIGHT PDU, if the resulting sum of the
575 * signalling weights of all the peer IP endpoints configured for this NSE is
576 * equal to zero or if the resulting sum of the data weights of all the peer IP
577 * endpoints configured for this NSE is equal to zero, the BSS/SGSN shall send an
578 * SNS-ACK PDU with a cause code of "Invalid weights". */
579
580 if (ip4) {
581 if (update_remote_ip4_elem(gss, ip4))
582 return -NS_CAUSE_UNKN_IP_EP;
583
584 /* copy over. Both data structures use network byte order */
585 sa.u.sin.sin_addr.s_addr = ip4->ip_addr;
586 sa.u.sin.sin_port = ip4->udp_port;
587 sa.u.sin.sin_family = AF_INET;
588 new_signal = ip4->sig_weight;
589 new_data = ip4->data_weight;
590 } else if (ip6) {
591 if (update_remote_ip6_elem(gss, ip6))
592 return -NS_CAUSE_UNKN_IP_EP;
593
594 /* copy over. Both data structures use network byte order */
595 sa.u.sin6.sin6_addr = ip6->ip_addr;
596 sa.u.sin6.sin6_port = ip6->udp_port;
597 sa.u.sin6.sin6_family = AF_INET6;
598 new_signal = ip6->sig_weight;
599 new_data = ip6->data_weight;
600 } else {
601 OSMO_ASSERT(false);
602 }
603
604 llist_for_each_entry(nsvc, &nse->nsvc, list) {
Alexander Couzensc4229a42020-10-11 20:58:04 +0200605 remote = gprs_ns2_ip_vc_remote(nsvc);
Alexander Couzens6a161492020-07-12 13:45:50 +0200606 /* all nsvc in NSE should be IP/UDP nsvc */
607 OSMO_ASSERT(remote);
608
609 if (osmo_sockaddr_cmp(&sa, remote))
610 continue;
611
612 LOGPFSML(fi, LOGL_INFO, "CHANGE-WEIGHT NS-VC %s data_weight %u->%u, sig_weight %u->%u\n",
613 gprs_ns2_ll_str(nsvc), nsvc->data_weight, new_data,
614 nsvc->sig_weight, new_signal);
615
616 nsvc->data_weight = new_data;
617 nsvc->sig_weight = new_signal;
618 }
619
620 return 0;
621}
622
623static int do_sns_delete(struct osmo_fsm_inst *fi,
624 const struct gprs_ns_ie_ip4_elem *ip4,
625 const struct gprs_ns_ie_ip6_elem *ip6)
626{
627 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
628 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
629 struct gprs_ns2_vc *nsvc, *tmp;
Alexander Couzens9a4cf272020-10-11 20:48:04 +0200630 const struct osmo_sockaddr *remote;
Alexander Couzens6a161492020-07-12 13:45:50 +0200631 struct osmo_sockaddr sa = {};
632
633 if (ip4) {
634 if (remove_remote_ip4_elem(gss, ip4) < 0)
635 return -NS_CAUSE_UNKN_IP_EP;
636 /* copy over. Both data structures use network byte order */
637 sa.u.sin.sin_addr.s_addr = ip4->ip_addr;
638 sa.u.sin.sin_port = ip4->udp_port;
639 sa.u.sin.sin_family = AF_INET;
640 } else if (ip6) {
641 if (remove_remote_ip6_elem(gss, ip6))
642 return -NS_CAUSE_UNKN_IP_EP;
643
644 /* copy over. Both data structures use network byte order */
645 sa.u.sin6.sin6_addr = ip6->ip_addr;
646 sa.u.sin6.sin6_port = ip6->udp_port;
647 sa.u.sin6.sin6_family = AF_INET6;
648 } else {
649 OSMO_ASSERT(false);
650 }
651
652 llist_for_each_entry_safe(nsvc, tmp, &nse->nsvc, list) {
Alexander Couzensc4229a42020-10-11 20:58:04 +0200653 remote = gprs_ns2_ip_vc_remote(nsvc);
Alexander Couzens6a161492020-07-12 13:45:50 +0200654 /* all nsvc in NSE should be IP/UDP nsvc */
655 OSMO_ASSERT(remote);
656 if (osmo_sockaddr_cmp(&sa, remote))
657 continue;
658
659 LOGPFSML(fi, LOGL_INFO, "DELETE NS-VC %s\n", gprs_ns2_ll_str(nsvc));
660 gprs_ns2_free_nsvc(nsvc);
661 }
662
663 return 0;
664}
665
666static int do_sns_add(struct osmo_fsm_inst *fi,
667 const struct gprs_ns_ie_ip4_elem *ip4,
668 const struct gprs_ns_ie_ip6_elem *ip6)
669{
670 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
671 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
672 struct gprs_ns2_vc *nsvc;
673 int rc = 0;
674
675 /* Upon receiving an SNS-ADD PDU, if the consequent number of IPv4 endpoints
676 * exceeds the number of IPv4 endpoints supported by the NSE, the NSE shall send
677 * an SNS-ACK PDU with a cause code set to "Invalid number of IP4 Endpoints". */
678 switch (gss->ip) {
679 case IPv4:
680 rc = add_remote_ip4_elem(gss, ip4);
681 break;
682 case IPv6:
683 rc = add_remote_ip6_elem(gss, ip6);
684 break;
685 default:
686 /* the gss->ip is initialized with the bss */
687 OSMO_ASSERT(false);
688 }
689
690 if (rc)
691 return rc;
692
693 /* Upon receiving an SNS-ADD PDU containing an already configured IP endpoint the
694 * NSE shall send an SNS-ACK PDU with the cause code "Protocol error -
695 * unspecified" */
696 switch (gss->ip) {
697 case IPv4:
698 nsvc = nsvc_by_ip4_elem(nse, ip4);
699 if (nsvc) {
700 /* the nsvc should be already in sync with the ip4 / ip6 elements */
701 return -NS_CAUSE_PROTO_ERR_UNSPEC;
702 }
703
704 /* TODO: failure case */
705 ns2_nsvc_create_ip4(fi, nse, ip4);
706 break;
707 case IPv6:
708 nsvc = nsvc_by_ip6_elem(nse, ip6);
709 if (nsvc) {
710 /* the nsvc should be already in sync with the ip4 / ip6 elements */
711 return -NS_CAUSE_PROTO_ERR_UNSPEC;
712 }
713
714 /* TODO: failure case */
715 ns2_nsvc_create_ip6(fi, nse, ip6);
716 break;
717 }
718
719 gprs_ns2_start_alive_all_nsvcs(nse);
720
721 return 0;
722}
723
724
Harald Welte694dad52021-03-23 15:22:16 +0100725static void ns2_sns_st_bss_unconfigured(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Alexander Couzens6a161492020-07-12 13:45:50 +0200726{
Harald Weltef61a9152021-03-02 22:20:17 +0100727 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
728 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
Alexander Couzense769f522020-12-07 07:37:07 +0100729 /* empty state - SNS Select will start by ns2_sns_st_all_action() */
Alexander Couzens6a161492020-07-12 13:45:50 +0200730}
731
Harald Welte694dad52021-03-23 15:22:16 +0100732static void ns2_sns_st_bss_size(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Alexander Couzens6a161492020-07-12 13:45:50 +0200733{
Harald Weltef61a9152021-03-02 22:20:17 +0100734 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens6a161492020-07-12 13:45:50 +0200735 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
736 struct gprs_ns2_inst *nsi = nse->nsi;
737 struct tlv_parsed *tp = NULL;
738
Harald Weltef61a9152021-03-02 22:20:17 +0100739 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
740
Alexander Couzens6a161492020-07-12 13:45:50 +0200741 switch (event) {
Alexander Couzens67725e22021-02-15 02:37:03 +0100742 case GPRS_SNS_EV_RX_SIZE_ACK:
Alexander Couzens6a161492020-07-12 13:45:50 +0200743 tp = data;
744 if (TLVP_VAL_MINLEN(tp, NS_IE_CAUSE, 1)) {
745 LOGPFSML(fi, LOGL_ERROR, "SNS-SIZE-ACK with cause %s\n",
746 gprs_ns2_cause_str(*TLVP_VAL(tp, NS_IE_CAUSE)));
747 /* TODO: What to do? */
748 } else {
Harald Welte694dad52021-03-23 15:22:16 +0100749 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_BSS_CONFIG_BSS,
Alexander Couzens6a161492020-07-12 13:45:50 +0200750 nsi->timeout[NS_TOUT_TSNS_PROV], 2);
751 }
752 break;
753 default:
754 OSMO_ASSERT(0);
755 }
756}
757
Harald Welte01fa6a32021-03-04 19:49:38 +0100758static int ns2_sns_count_num_local_ep(struct osmo_fsm_inst *fi, enum ns2_sns_type stype)
759{
760 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
761 struct ns2_sns_bind *sbind;
762 int count = 0;
763
764 llist_for_each_entry(sbind, &gss->binds, list) {
765 const struct osmo_sockaddr *sa = gprs_ns2_ip_bind_sockaddr(sbind->bind);
766 if (!sa)
767 continue;
768
769 switch (stype) {
770 case IPv4:
771 if (sa->u.sas.ss_family == AF_INET)
772 count++;
773 break;
774 case IPv6:
775 if (sa->u.sas.ss_family == AF_INET6)
776 count++;
777 break;
778 }
779 }
780 return count;
781}
782
Harald Welte24920e22021-03-04 13:03:27 +0100783static void ns2_sns_compute_local_ep_from_binds(struct osmo_fsm_inst *fi)
Alexander Couzens6a161492020-07-12 13:45:50 +0200784{
785 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzense769f522020-12-07 07:37:07 +0100786 struct gprs_ns_ie_ip4_elem *ip4_elems;
787 struct gprs_ns_ie_ip6_elem *ip6_elems;
788 struct gprs_ns2_vc_bind *bind;
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100789 struct ns2_sns_bind *sbind;
Harald Welte4f127462021-03-02 20:49:10 +0100790 const struct osmo_sockaddr *remote;
Alexander Couzense769f522020-12-07 07:37:07 +0100791 const struct osmo_sockaddr *sa;
792 struct osmo_sockaddr local;
793 int count;
Alexander Couzens6a161492020-07-12 13:45:50 +0200794
Harald Welte46eb7642021-03-04 17:49:59 +0100795 ns2_clear_ipv46_entries_local(gss);
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100796
Alexander Couzense769f522020-12-07 07:37:07 +0100797 /* no initial available */
Harald Welte4f127462021-03-02 20:49:10 +0100798 if (gss->role == GPRS_SNS_ROLE_BSS) {
799 if (!gss->initial)
800 return;
801 remote = &gss->initial->saddr;
802 } else
803 remote = gprs_ns2_ip_vc_remote(gss->sns_nsvc);
Alexander Couzense769f522020-12-07 07:37:07 +0100804
805 /* count how many bindings are available (only UDP binds) */
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100806 count = llist_count(&gss->binds);
Alexander Couzense769f522020-12-07 07:37:07 +0100807 if (count == 0) {
Harald Welte05992872021-03-04 15:49:21 +0100808 LOGPFSML(fi, LOGL_ERROR, "No local binds for this NSE -> cannot determine IP endpoints\n");
Alexander Couzense769f522020-12-07 07:37:07 +0100809 return;
810 }
811
Alexander Couzense769f522020-12-07 07:37:07 +0100812 switch (gss->ip) {
813 case IPv4:
814 ip4_elems = talloc_zero_size(fi, sizeof(struct gprs_ns_ie_ip4_elem) * count);
815 if (!ip4_elems)
816 return;
817
818 gss->ip4_local = ip4_elems;
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100819 llist_for_each_entry(sbind, &gss->binds, list) {
820 bind = sbind->bind;
Alexander Couzense769f522020-12-07 07:37:07 +0100821 sa = gprs_ns2_ip_bind_sockaddr(bind);
822 if (!sa)
823 continue;
824
825 if (sa->u.sas.ss_family != AF_INET)
826 continue;
827
828 /* check if this is an specific bind */
829 if (sa->u.sin.sin_addr.s_addr == 0) {
830 if (osmo_sockaddr_local_ip(&local, remote))
831 continue;
832
833 ip4_elems->ip_addr = local.u.sin.sin_addr.s_addr;
834 } else {
835 ip4_elems->ip_addr = sa->u.sin.sin_addr.s_addr;
836 }
837
838 ip4_elems->udp_port = sa->u.sin.sin_port;
Alexander Couzensc4704762021-02-08 23:13:12 +0100839 ip4_elems->sig_weight = bind->sns_sig_weight;
840 ip4_elems->data_weight = bind->sns_data_weight;
Alexander Couzense769f522020-12-07 07:37:07 +0100841 ip4_elems++;
842 }
843
844 gss->num_ip4_local = count;
Alexander Couzense769f522020-12-07 07:37:07 +0100845 gss->num_max_nsvcs = OSMO_MAX(gss->num_max_ip4_remote * gss->num_ip4_local, 8);
846 break;
847 case IPv6:
848 /* IPv6 */
849 ip6_elems = talloc_zero_size(fi, sizeof(struct gprs_ns_ie_ip6_elem) * count);
850 if (!ip6_elems)
851 return;
852
853 gss->ip6_local = ip6_elems;
854
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100855 llist_for_each_entry(sbind, &gss->binds, list) {
856 bind = sbind->bind;
Alexander Couzense769f522020-12-07 07:37:07 +0100857 sa = gprs_ns2_ip_bind_sockaddr(bind);
858 if (!sa)
859 continue;
860
861 if (sa->u.sas.ss_family != AF_INET6)
862 continue;
863
864 /* check if this is an specific bind */
865 if (IN6_IS_ADDR_UNSPECIFIED(&sa->u.sin6.sin6_addr)) {
866 if (osmo_sockaddr_local_ip(&local, remote))
867 continue;
868
869 ip6_elems->ip_addr = local.u.sin6.sin6_addr;
870 } else {
871 ip6_elems->ip_addr = sa->u.sin6.sin6_addr;
872 }
873
874 ip6_elems->udp_port = sa->u.sin.sin_port;
Alexander Couzensc4704762021-02-08 23:13:12 +0100875 ip6_elems->sig_weight = bind->sns_sig_weight;
876 ip6_elems->data_weight = bind->sns_data_weight;
Alexander Couzense769f522020-12-07 07:37:07 +0100877
878 ip6_elems++;
879 }
880 gss->num_ip6_local = count;
Alexander Couzense769f522020-12-07 07:37:07 +0100881 gss->num_max_nsvcs = OSMO_MAX(gss->num_max_ip6_remote * gss->num_ip6_local, 8);
882 break;
883 }
Harald Welte24920e22021-03-04 13:03:27 +0100884}
885
886/* setup all dynamic SNS settings, create a new nsvc and send the SIZE */
Harald Welte694dad52021-03-23 15:22:16 +0100887static void ns2_sns_st_bss_size_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
Harald Welte24920e22021-03-04 13:03:27 +0100888{
889 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
890
Harald Weltef61a9152021-03-02 22:20:17 +0100891 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
892
Harald Welte24920e22021-03-04 13:03:27 +0100893 /* on a generic failure, the timer callback will recover */
894 if (old_state != GPRS_SNS_ST_UNCONFIGURED)
895 ns2_prim_status_ind(gss->nse, NULL, 0, GPRS_NS2_AFF_CAUSE_SNS_FAILURE);
Harald Welte694dad52021-03-23 15:22:16 +0100896 if (old_state != GPRS_SNS_ST_BSS_SIZE)
Harald Welte24920e22021-03-04 13:03:27 +0100897 gss->N = 0;
898
899 gss->alive = false;
900
901 ns2_sns_compute_local_ep_from_binds(fi);
902
903 /* take the first bind or take the next bind */
904 if (!gss->initial_bind) {
905 gss->initial_bind = llist_first_entry(&gss->binds, struct ns2_sns_bind, list);
906 } else {
907 if (gss->initial_bind->list.next != &gss->binds) {
908 gss->initial_bind = llist_entry(gss->initial_bind->list.next, struct ns2_sns_bind, list);
909 } else {
910 gss->initial_bind = llist_first_entry(&gss->binds, struct ns2_sns_bind, list);
911 }
912 }
913
914
915 /* setup the NSVC */
916 if (!gss->sns_nsvc) {
917 struct gprs_ns2_vc_bind *bind = gss->initial_bind->bind;
918 struct osmo_sockaddr *remote = &gss->initial->saddr;
919 gss->sns_nsvc = ns2_ip_bind_connect(bind, gss->nse, remote);
920 if (!gss->sns_nsvc)
921 return;
Harald Weltec962a2e2021-03-05 08:09:08 +0100922 /* A pre-configured endpoint shall not be used for NSE data or signalling traffic
923 * (with the exception of Size and Configuration procedures) unless it is configured
924 * by the SGSN using the auto-configuration procedures */
Harald Welte24920e22021-03-04 13:03:27 +0100925 gss->sns_nsvc->sns_only = true;
926 }
927
Alexander Couzense769f522020-12-07 07:37:07 +0100928
Alexander Couzens6a161492020-07-12 13:45:50 +0200929 if (gss->num_max_ip4_remote > 0)
Harald Welte4e41acc2021-03-23 11:55:25 +0100930 ns2_tx_sns_size(gss->sns_nsvc, true, gss->num_max_nsvcs, gss->num_ip4_local, -1);
Alexander Couzens6a161492020-07-12 13:45:50 +0200931 else
Harald Welte4e41acc2021-03-23 11:55:25 +0100932 ns2_tx_sns_size(gss->sns_nsvc, true, gss->num_max_nsvcs, -1, gss->num_ip6_local);
Alexander Couzens6a161492020-07-12 13:45:50 +0200933}
934
Harald Welte694dad52021-03-23 15:22:16 +0100935static void ns2_sns_st_bss_config_bss(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Alexander Couzens6a161492020-07-12 13:45:50 +0200936{
Harald Weltef61a9152021-03-02 22:20:17 +0100937 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens3df58862021-02-05 17:18:08 +0100938 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
Harald Weltef61a9152021-03-02 22:20:17 +0100939 struct tlv_parsed *tp = NULL;
940
941 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
Alexander Couzens6a161492020-07-12 13:45:50 +0200942
943 switch (event) {
Alexander Couzens67725e22021-02-15 02:37:03 +0100944 case GPRS_SNS_EV_RX_CONFIG_ACK:
Alexander Couzens6a161492020-07-12 13:45:50 +0200945 tp = (struct tlv_parsed *) data;
946 if (TLVP_VAL_MINLEN(tp, NS_IE_CAUSE, 1)) {
947 LOGPFSML(fi, LOGL_ERROR, "SNS-CONFIG-ACK with cause %s\n",
948 gprs_ns2_cause_str(*TLVP_VAL(tp, NS_IE_CAUSE)));
949 /* TODO: What to do? */
950 } else {
Harald Welte694dad52021-03-23 15:22:16 +0100951 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_BSS_CONFIG_SGSN, nse->nsi->timeout[NS_TOUT_TSNS_PROV], 3);
Alexander Couzens6a161492020-07-12 13:45:50 +0200952 }
953 break;
954 default:
955 OSMO_ASSERT(0);
956 }
957}
958
Harald Welte694dad52021-03-23 15:22:16 +0100959static void ns2_sns_st_bss_config_bss_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
Alexander Couzens6a161492020-07-12 13:45:50 +0200960{
961 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens790a9632021-02-05 17:18:39 +0100962
Harald Weltef61a9152021-03-02 22:20:17 +0100963 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
964
Harald Welte694dad52021-03-23 15:22:16 +0100965 if (old_state != GPRS_SNS_ST_BSS_CONFIG_BSS)
Alexander Couzens790a9632021-02-05 17:18:39 +0100966 gss->N = 0;
967
Alexander Couzens6a161492020-07-12 13:45:50 +0200968 /* Transmit SNS-CONFIG */
Alexander Couzens6a161492020-07-12 13:45:50 +0200969 switch (gss->ip) {
970 case IPv4:
971 ns2_tx_sns_config(gss->sns_nsvc, true,
Alexander Couzense78207f2020-12-07 06:19:29 +0100972 gss->ip4_local, gss->num_ip4_local,
973 NULL, 0);
Alexander Couzens6a161492020-07-12 13:45:50 +0200974 break;
975 case IPv6:
976 ns2_tx_sns_config(gss->sns_nsvc, true,
Alexander Couzense78207f2020-12-07 06:19:29 +0100977 NULL, 0,
978 gss->ip6_local, gss->num_ip6_local);
Alexander Couzens6a161492020-07-12 13:45:50 +0200979 break;
980 }
981}
982
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100983/* calculate the timeout of the configured state. the configured
984 * state will fail if not at least one NS-VC is alive within X second.
985 */
986static inline int ns_sns_configured_timeout(struct osmo_fsm_inst *fi)
987{
988 int secs;
989 struct gprs_ns2_inst *nsi = nse_inst_from_fi(fi)->nsi;
990 secs = nsi->timeout[NS_TOUT_TNS_ALIVE] * nsi->timeout[NS_TOUT_TNS_ALIVE_RETRIES];
991 secs += nsi->timeout[NS_TOUT_TNS_TEST];
992
993 return secs;
994}
Alexander Couzens6a161492020-07-12 13:45:50 +0200995
Harald Weltec1c7e4a2021-03-02 20:47:29 +0100996/* append the remote endpoints from the parsed TLV array to the ns2_sns_state */
997static int ns_sns_append_remote_eps(struct osmo_fsm_inst *fi, const struct tlv_parsed *tp)
Alexander Couzens6a161492020-07-12 13:45:50 +0200998{
999 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens6a161492020-07-12 13:45:50 +02001000
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001001 if (TLVP_PRESENT(tp, NS_IE_IPv4_LIST)) {
1002 const struct gprs_ns_ie_ip4_elem *v4_list;
1003 unsigned int num_v4;
1004 v4_list = (const struct gprs_ns_ie_ip4_elem *) TLVP_VAL(tp, NS_IE_IPv4_LIST);
1005 num_v4 = TLVP_LEN(tp, NS_IE_IPv4_LIST) / sizeof(*v4_list);
Alexander Couzens6a161492020-07-12 13:45:50 +02001006
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001007 if (num_v4 && gss->ip6_remote)
1008 return -NS_CAUSE_INVAL_NR_IPv4_EP;
Alexander Couzens6a161492020-07-12 13:45:50 +02001009
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001010 /* realloc to the new size */
1011 gss->ip4_remote = talloc_realloc(gss, gss->ip4_remote,
1012 struct gprs_ns_ie_ip4_elem,
1013 gss->num_ip4_remote + num_v4);
1014 /* append the new entries to the end of the list */
1015 memcpy(&gss->ip4_remote[gss->num_ip4_remote], v4_list, num_v4*sizeof(*v4_list));
1016 gss->num_ip4_remote += num_v4;
1017
1018 LOGPFSML(fi, LOGL_INFO, "Rx SNS-CONFIG: Remote IPv4 list now %u entries\n",
1019 gss->num_ip4_remote);
Alexander Couzens6a161492020-07-12 13:45:50 +02001020 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001021
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001022 if (TLVP_PRESENT(tp, NS_IE_IPv6_LIST)) {
1023 const struct gprs_ns_ie_ip6_elem *v6_list;
1024 unsigned int num_v6;
1025 v6_list = (const struct gprs_ns_ie_ip6_elem *) TLVP_VAL(tp, NS_IE_IPv6_LIST);
1026 num_v6 = TLVP_LEN(tp, NS_IE_IPv6_LIST) / sizeof(*v6_list);
1027
1028 if (num_v6 && gss->ip4_remote)
1029 return -NS_CAUSE_INVAL_NR_IPv6_EP;
1030
1031 /* realloc to the new size */
1032 gss->ip6_remote = talloc_realloc(gss, gss->ip6_remote,
1033 struct gprs_ns_ie_ip6_elem,
1034 gss->num_ip6_remote + num_v6);
1035 /* append the new entries to the end of the list */
1036 memcpy(&gss->ip6_remote[gss->num_ip6_remote], v6_list, num_v6*sizeof(*v6_list));
1037 gss->num_ip6_remote += num_v6;
1038
1039 LOGPFSML(fi, LOGL_INFO, "Rx SNS-CONFIG: Remote IPv6 list now %u entries\n",
1040 gss->num_ip6_remote);
Alexander Couzens6a161492020-07-12 13:45:50 +02001041 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001042
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001043 return 0;
Alexander Couzens6a161492020-07-12 13:45:50 +02001044}
1045
Harald Welte694dad52021-03-23 15:22:16 +01001046static void ns2_sns_st_bss_config_sgsn_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
Alexander Couzens790a9632021-02-05 17:18:39 +01001047{
1048 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
1049
Harald Weltef61a9152021-03-02 22:20:17 +01001050 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
1051
Harald Welte694dad52021-03-23 15:22:16 +01001052 if (old_state != GPRS_SNS_ST_BSS_CONFIG_SGSN)
Alexander Couzens790a9632021-02-05 17:18:39 +01001053 gss->N = 0;
1054}
1055
Harald Welte694dad52021-03-23 15:22:16 +01001056static void ns2_sns_st_bss_config_sgsn(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Alexander Couzens6a161492020-07-12 13:45:50 +02001057{
1058 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001059 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
1060 uint8_t cause;
1061 int rc;
Alexander Couzens6a161492020-07-12 13:45:50 +02001062
Harald Weltef61a9152021-03-02 22:20:17 +01001063 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
1064
Alexander Couzens6a161492020-07-12 13:45:50 +02001065 switch (event) {
Alexander Couzens67725e22021-02-15 02:37:03 +01001066 case GPRS_SNS_EV_RX_CONFIG_END:
1067 case GPRS_SNS_EV_RX_CONFIG:
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001068 rc = ns_sns_append_remote_eps(fi, data);
1069 if (rc < 0) {
1070 cause = -rc;
1071 ns2_tx_sns_config_ack(gss->sns_nsvc, &cause);
1072 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
1073 return;
Alexander Couzens6a161492020-07-12 13:45:50 +02001074 }
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001075 if (event == GPRS_SNS_EV_RX_CONFIG_END) {
1076 /* check if sum of data / sig weights == 0 */
1077 if (nss_weight_sum_data(gss) == 0 || nss_weight_sum_sig(gss) == 0) {
1078 cause = NS_CAUSE_INVAL_WEIGH;
1079 ns2_tx_sns_config_ack(gss->sns_nsvc, &cause);
1080 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
1081 return;
1082 }
1083 create_missing_nsvcs(fi);
1084 ns2_tx_sns_config_ack(gss->sns_nsvc, NULL);
1085 /* start the test procedure on ALL NSVCs! */
1086 gprs_ns2_start_alive_all_nsvcs(nse);
1087 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_CONFIGURED, 0, 0);
1088 } else {
1089 /* just send CONFIG-ACK */
1090 ns2_tx_sns_config_ack(gss->sns_nsvc, NULL);
1091 osmo_timer_schedule(&fi->timer, nse->nsi->timeout[NS_TOUT_TSNS_PROV], 0);
Alexander Couzens6a161492020-07-12 13:45:50 +02001092 }
1093 break;
1094 default:
1095 OSMO_ASSERT(0);
1096 }
1097}
1098
Alexander Couzens67725e22021-02-15 02:37:03 +01001099/* called when receiving GPRS_SNS_EV_RX_ADD in state configure */
Alexander Couzens6a161492020-07-12 13:45:50 +02001100static void ns2_sns_st_configured_add(struct osmo_fsm_inst *fi,
1101 struct ns2_sns_state *gss,
1102 struct tlv_parsed *tp)
1103{
1104 const struct gprs_ns_ie_ip4_elem *v4_list = NULL;
1105 const struct gprs_ns_ie_ip6_elem *v6_list = NULL;
1106 int num_v4 = 0, num_v6 = 0;
1107 uint8_t trans_id, cause = 0xff;
Harald Welte7da6ace2020-09-18 09:48:05 +02001108 unsigned int i;
Alexander Couzens6a161492020-07-12 13:45:50 +02001109 int rc = 0;
1110
1111 /* TODO: refactor EV_ADD/CHANGE/REMOVE by
1112 * check uniqueness within the lists (no doublicate entries)
1113 * check not-known-by-us and sent back a list of unknown/known values
1114 * (abnormal behaviour according to 48.016)
1115 */
1116
1117 trans_id = *TLVP_VAL(tp, NS_IE_TRANS_ID);
1118 if (gss->ip == IPv4) {
1119 if (!TLVP_PRESENT(tp, NS_IE_IPv4_LIST)) {
1120 cause = NS_CAUSE_INVAL_NR_IPv4_EP;
1121 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1122 return;
1123 }
1124
1125 v4_list = (const struct gprs_ns_ie_ip4_elem *) TLVP_VAL(tp, NS_IE_IPv4_LIST);
1126 num_v4 = TLVP_LEN(tp, NS_IE_IPv4_LIST) / sizeof(*v4_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001127 for (i = 0; i < num_v4; i++) {
1128 unsigned int j;
Alexander Couzens6a161492020-07-12 13:45:50 +02001129 rc = do_sns_add(fi, &v4_list[i], NULL);
1130 if (rc < 0) {
1131 /* rollback/undo to restore previous state */
Harald Welte7da6ace2020-09-18 09:48:05 +02001132 for (j = 0; j < i; j++)
Alexander Couzens6a161492020-07-12 13:45:50 +02001133 do_sns_delete(fi, &v4_list[j], NULL);
1134 cause = -rc;
1135 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1136 break;
1137 }
1138 }
1139 } else { /* IPv6 */
1140 if (!TLVP_PRESENT(tp, NS_IE_IPv6_LIST)) {
1141 cause = NS_CAUSE_INVAL_NR_IPv6_EP;
1142 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1143 return;
1144 }
1145
1146 v6_list = (const struct gprs_ns_ie_ip6_elem *) TLVP_VAL(tp, NS_IE_IPv6_LIST);
1147 num_v6 = TLVP_LEN(tp, NS_IE_IPv6_LIST) / sizeof(*v6_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001148 for (i = 0; i < num_v6; i++) {
1149 unsigned int j;
Alexander Couzens6a161492020-07-12 13:45:50 +02001150 rc = do_sns_add(fi, NULL, &v6_list[i]);
1151 if (rc < 0) {
1152 /* rollback/undo to restore previous state */
Harald Welte7da6ace2020-09-18 09:48:05 +02001153 for (j = 0; j < i; j++)
Alexander Couzens6a161492020-07-12 13:45:50 +02001154 do_sns_delete(fi, NULL, &v6_list[j]);
1155 cause = -rc;
1156 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1157 break;
1158 }
1159 }
1160 }
1161
1162 /* TODO: correct behaviour is to answer to the *same* NSVC from which the SNS_ADD was received */
1163 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, NULL, v4_list, num_v4, v6_list, num_v6);
1164}
1165
1166static void ns2_sns_st_configured_delete(struct osmo_fsm_inst *fi,
1167 struct ns2_sns_state *gss,
1168 struct tlv_parsed *tp)
1169{
1170 const struct gprs_ns_ie_ip4_elem *v4_list = NULL;
1171 const struct gprs_ns_ie_ip6_elem *v6_list = NULL;
1172 int num_v4 = 0, num_v6 = 0;
1173 uint8_t trans_id, cause = 0xff;
Harald Welte7da6ace2020-09-18 09:48:05 +02001174 unsigned int i;
Alexander Couzens6a161492020-07-12 13:45:50 +02001175 int rc = 0;
1176
1177 /* TODO: split up delete into v4 + v6
1178 * TODO: check if IPv4_LIST or IP_ADDR(v4) is present on IPv6 and vice versa
1179 * TODO: check if IPv4_LIST/IPv6_LIST and IP_ADDR is present at the same time
1180 */
1181 trans_id = *TLVP_VAL(tp, NS_IE_TRANS_ID);
1182 if (gss->ip == IPv4) {
1183 if (TLVP_PRESENT(tp, NS_IE_IPv4_LIST)) {
1184 v4_list = (const struct gprs_ns_ie_ip4_elem *) TLVP_VAL(tp, NS_IE_IPv4_LIST);
1185 num_v4 = TLVP_LEN(tp, NS_IE_IPv4_LIST) / sizeof(*v4_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001186 for ( i = 0; i < num_v4; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001187 rc = do_sns_delete(fi, &v4_list[i], NULL);
1188 if (rc < 0) {
1189 cause = -rc;
1190 /* continue to delete others */
1191 }
1192 }
1193 if (cause != 0xff) {
1194 /* TODO: create list of not-deleted and return it */
1195 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1196 return;
1197 }
1198
1199 } else if (TLVP_PRESENT(tp, NS_IE_IP_ADDR) && TLVP_LEN(tp, NS_IE_IP_ADDR) == 5) {
1200 /* delete all NS-VCs for given IPv4 address */
1201 const uint8_t *ie = TLVP_VAL(tp, NS_IE_IP_ADDR);
1202 struct gprs_ns_ie_ip4_elem *ip4_remote;
1203 uint32_t ip_addr = *(uint32_t *)(ie+1);
1204 if (ie[0] != 0x01) { /* Address Type != IPv4 */
1205 cause = NS_CAUSE_UNKN_IP_ADDR;
1206 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1207 return;
1208 }
1209 /* make a copy as do_sns_delete() will change the array underneath us */
1210 ip4_remote = talloc_memdup(fi, gss->ip4_remote,
1211 gss->num_ip4_remote * sizeof(*v4_list));
Harald Welte7da6ace2020-09-18 09:48:05 +02001212 for (i = 0; i < gss->num_ip4_remote; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001213 if (ip4_remote[i].ip_addr == ip_addr) {
1214 rc = do_sns_delete(fi, &ip4_remote[i], NULL);
1215 if (rc < 0) {
1216 cause = -rc;
1217 /* continue to delete others */
1218 }
1219 }
1220 }
1221 talloc_free(ip4_remote);
1222 if (cause != 0xff) {
1223 /* TODO: create list of not-deleted and return it */
1224 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1225 return;
1226 }
1227 } else {
1228 cause = NS_CAUSE_INVAL_NR_IPv4_EP;
1229 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1230 return;
1231 }
1232 } else { /* IPv6 */
1233 if (TLVP_PRESENT(tp, NS_IE_IPv6_LIST)) {
1234 v6_list = (const struct gprs_ns_ie_ip6_elem *) TLVP_VAL(tp, NS_IE_IPv6_LIST);
1235 num_v6 = TLVP_LEN(tp, NS_IE_IPv6_LIST) / sizeof(*v6_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001236 for (i = 0; i < num_v6; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001237 rc = do_sns_delete(fi, NULL, &v6_list[i]);
1238 if (rc < 0) {
1239 cause = -rc;
1240 /* continue to delete others */
1241 }
1242 }
1243 if (cause != 0xff) {
1244 /* TODO: create list of not-deleted and return it */
1245 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1246 return;
1247 }
1248 } else if (TLVP_PRES_LEN(tp, NS_IE_IP_ADDR, 17)) {
1249 /* delete all NS-VCs for given IPv4 address */
1250 const uint8_t *ie = TLVP_VAL(tp, NS_IE_IP_ADDR);
1251 struct gprs_ns_ie_ip6_elem *ip6_remote;
1252 struct in6_addr ip6_addr;
Harald Welte7da6ace2020-09-18 09:48:05 +02001253 unsigned int i;
Alexander Couzens6a161492020-07-12 13:45:50 +02001254 if (ie[0] != 0x02) { /* Address Type != IPv6 */
1255 cause = NS_CAUSE_UNKN_IP_ADDR;
1256 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1257 return;
1258 }
1259 memcpy(&ip6_addr, (ie+1), sizeof(struct in6_addr));
1260 /* make a copy as do_sns_delete() will change the array underneath us */
1261 ip6_remote = talloc_memdup(fi, gss->ip6_remote,
1262 gss->num_ip6_remote * sizeof(*v4_list));
Harald Welte7da6ace2020-09-18 09:48:05 +02001263 for (i = 0; i < gss->num_ip6_remote; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001264 if (!memcmp(&ip6_remote[i].ip_addr, &ip6_addr, sizeof(struct in6_addr))) {
1265 rc = do_sns_delete(fi, NULL, &ip6_remote[i]);
1266 if (rc < 0) {
1267 cause = -rc;
1268 /* continue to delete others */
1269 }
1270 }
1271 }
1272
1273 talloc_free(ip6_remote);
1274 if (cause != 0xff) {
1275 /* TODO: create list of not-deleted and return it */
1276 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1277 return;
1278 }
1279 } else {
1280 cause = NS_CAUSE_INVAL_NR_IPv6_EP;
1281 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1282 return;
1283 }
1284 }
1285 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, NULL, v4_list, num_v4, v6_list, num_v6);
1286}
1287
1288static void ns2_sns_st_configured_change(struct osmo_fsm_inst *fi,
1289 struct ns2_sns_state *gss,
1290 struct tlv_parsed *tp)
1291{
1292 const struct gprs_ns_ie_ip4_elem *v4_list = NULL;
1293 const struct gprs_ns_ie_ip6_elem *v6_list = NULL;
1294 int num_v4 = 0, num_v6 = 0;
1295 uint8_t trans_id, cause = 0xff;
1296 int rc = 0;
Harald Welte7da6ace2020-09-18 09:48:05 +02001297 unsigned int i;
Alexander Couzens6a161492020-07-12 13:45:50 +02001298
1299 trans_id = *TLVP_VAL(tp, NS_IE_TRANS_ID);
1300 if (TLVP_PRESENT(tp, NS_IE_IPv4_LIST)) {
1301 v4_list = (const struct gprs_ns_ie_ip4_elem *) TLVP_VAL(tp, NS_IE_IPv4_LIST);
1302 num_v4 = TLVP_LEN(tp, NS_IE_IPv4_LIST) / sizeof(*v4_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001303 for (i = 0; i < num_v4; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001304 rc = do_sns_change_weight(fi, &v4_list[i], NULL);
1305 if (rc < 0) {
1306 cause = -rc;
1307 /* continue to others */
1308 }
1309 }
1310 if (cause != 0xff) {
1311 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1312 return;
1313 }
1314 } else if (TLVP_PRESENT(tp, NS_IE_IPv6_LIST)) {
1315 v6_list = (const struct gprs_ns_ie_ip6_elem *) TLVP_VAL(tp, NS_IE_IPv6_LIST);
1316 num_v6 = TLVP_LEN(tp, NS_IE_IPv6_LIST) / sizeof(*v6_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001317 for (i = 0; i < num_v6; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001318 rc = do_sns_change_weight(fi, NULL, &v6_list[i]);
1319 if (rc < 0) {
1320 cause = -rc;
1321 /* continue to others */
1322 }
1323 }
1324 if (cause != 0xff) {
1325 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1326 return;
1327 }
1328 } else {
1329 cause = NS_CAUSE_INVAL_NR_IPv4_EP;
1330 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1331 return;
1332 }
1333 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, NULL, v4_list, num_v4, v6_list, num_v6);
1334}
1335
1336static void ns2_sns_st_configured(struct osmo_fsm_inst *fi, uint32_t event, void *data)
1337{
1338 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
1339 struct tlv_parsed *tp = data;
1340
1341 switch (event) {
Alexander Couzens67725e22021-02-15 02:37:03 +01001342 case GPRS_SNS_EV_RX_ADD:
Alexander Couzens6a161492020-07-12 13:45:50 +02001343 ns2_sns_st_configured_add(fi, gss, tp);
1344 break;
Alexander Couzens67725e22021-02-15 02:37:03 +01001345 case GPRS_SNS_EV_RX_DELETE:
Alexander Couzens6a161492020-07-12 13:45:50 +02001346 ns2_sns_st_configured_delete(fi, gss, tp);
1347 break;
Alexander Couzens67725e22021-02-15 02:37:03 +01001348 case GPRS_SNS_EV_RX_CHANGE_WEIGHT:
Alexander Couzens6a161492020-07-12 13:45:50 +02001349 ns2_sns_st_configured_change(fi, gss, tp);
1350 break;
Alexander Couzens67725e22021-02-15 02:37:03 +01001351 case GPRS_SNS_EV_REQ_NSVC_ALIVE:
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001352 osmo_timer_del(&fi->timer);
1353 break;
Alexander Couzens6a161492020-07-12 13:45:50 +02001354 }
1355}
1356
1357static void ns2_sns_st_configured_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
1358{
1359 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
Alexander Couzens138b96f2021-01-25 16:23:29 +01001360 ns2_prim_status_ind(nse, NULL, 0, GPRS_NS2_AFF_CAUSE_SNS_CONFIGURED);
Alexander Couzens6a161492020-07-12 13:45:50 +02001361}
1362
1363static const struct osmo_fsm_state ns2_sns_bss_states[] = {
1364 [GPRS_SNS_ST_UNCONFIGURED] = {
Alexander Couzense769f522020-12-07 07:37:07 +01001365 .in_event_mask = 0, /* handled by all_state_action */
Harald Welte694dad52021-03-23 15:22:16 +01001366 .out_state_mask = S(GPRS_SNS_ST_BSS_SIZE),
Alexander Couzens6a161492020-07-12 13:45:50 +02001367 .name = "UNCONFIGURED",
Harald Welte694dad52021-03-23 15:22:16 +01001368 .action = ns2_sns_st_bss_unconfigured,
Alexander Couzens6a161492020-07-12 13:45:50 +02001369 },
Harald Welte694dad52021-03-23 15:22:16 +01001370 [GPRS_SNS_ST_BSS_SIZE] = {
Alexander Couzens67725e22021-02-15 02:37:03 +01001371 .in_event_mask = S(GPRS_SNS_EV_RX_SIZE_ACK),
Alexander Couzens6a161492020-07-12 13:45:50 +02001372 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
Harald Welte694dad52021-03-23 15:22:16 +01001373 S(GPRS_SNS_ST_BSS_SIZE) |
1374 S(GPRS_SNS_ST_BSS_CONFIG_BSS),
1375 .name = "BSS_SIZE",
1376 .action = ns2_sns_st_bss_size,
1377 .onenter = ns2_sns_st_bss_size_onenter,
Alexander Couzens6a161492020-07-12 13:45:50 +02001378 },
Harald Welte694dad52021-03-23 15:22:16 +01001379 [GPRS_SNS_ST_BSS_CONFIG_BSS] = {
Alexander Couzens67725e22021-02-15 02:37:03 +01001380 .in_event_mask = S(GPRS_SNS_EV_RX_CONFIG_ACK),
Alexander Couzens6a161492020-07-12 13:45:50 +02001381 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
Harald Welte694dad52021-03-23 15:22:16 +01001382 S(GPRS_SNS_ST_BSS_CONFIG_BSS) |
1383 S(GPRS_SNS_ST_BSS_CONFIG_SGSN) |
1384 S(GPRS_SNS_ST_BSS_SIZE),
1385 .name = "BSS_CONFIG_BSS",
1386 .action = ns2_sns_st_bss_config_bss,
1387 .onenter = ns2_sns_st_bss_config_bss_onenter,
Alexander Couzens6a161492020-07-12 13:45:50 +02001388 },
Harald Welte694dad52021-03-23 15:22:16 +01001389 [GPRS_SNS_ST_BSS_CONFIG_SGSN] = {
Alexander Couzens67725e22021-02-15 02:37:03 +01001390 .in_event_mask = S(GPRS_SNS_EV_RX_CONFIG) |
1391 S(GPRS_SNS_EV_RX_CONFIG_END),
Alexander Couzens6a161492020-07-12 13:45:50 +02001392 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
Harald Welte694dad52021-03-23 15:22:16 +01001393 S(GPRS_SNS_ST_BSS_CONFIG_SGSN) |
Alexander Couzens6a161492020-07-12 13:45:50 +02001394 S(GPRS_SNS_ST_CONFIGURED) |
Harald Welte694dad52021-03-23 15:22:16 +01001395 S(GPRS_SNS_ST_BSS_SIZE),
1396 .name = "BSS_CONFIG_SGSN",
1397 .action = ns2_sns_st_bss_config_sgsn,
1398 .onenter = ns2_sns_st_bss_config_sgsn_onenter,
Alexander Couzens6a161492020-07-12 13:45:50 +02001399 },
1400 [GPRS_SNS_ST_CONFIGURED] = {
Alexander Couzens67725e22021-02-15 02:37:03 +01001401 .in_event_mask = S(GPRS_SNS_EV_RX_ADD) |
1402 S(GPRS_SNS_EV_RX_DELETE) |
1403 S(GPRS_SNS_EV_RX_CHANGE_WEIGHT) |
1404 S(GPRS_SNS_EV_REQ_NSVC_ALIVE),
Alexander Couzense03d8632020-12-06 03:31:44 +01001405 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
Harald Welte694dad52021-03-23 15:22:16 +01001406 S(GPRS_SNS_ST_BSS_SIZE),
Alexander Couzens6a161492020-07-12 13:45:50 +02001407 .name = "CONFIGURED",
1408 .action = ns2_sns_st_configured,
1409 .onenter = ns2_sns_st_configured_onenter,
1410 },
1411};
1412
1413static int ns2_sns_fsm_bss_timer_cb(struct osmo_fsm_inst *fi)
1414{
Alexander Couzens90ee9632020-12-07 06:18:32 +01001415 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens6a161492020-07-12 13:45:50 +02001416 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
1417 struct gprs_ns2_inst *nsi = nse->nsi;
1418
Alexander Couzens90ee9632020-12-07 06:18:32 +01001419 gss->N++;
Alexander Couzens6a161492020-07-12 13:45:50 +02001420 switch (fi->T) {
1421 case 1:
Alexander Couzensa367d082020-12-21 14:06:24 +01001422 if (gss->N >= nsi->timeout[NS_TOUT_TSNS_SIZE_RETRIES]) {
1423 LOGPFSML(fi, LOGL_ERROR, "NSE %d: Size retries failed. Selecting next IP-SNS endpoint.\n", nse->nsei);
Alexander Couzens67725e22021-02-15 02:37:03 +01001424 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_REQ_SELECT_ENDPOINT, NULL);
Alexander Couzensa367d082020-12-21 14:06:24 +01001425 } else {
Harald Welte694dad52021-03-23 15:22:16 +01001426 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_BSS_SIZE, nsi->timeout[NS_TOUT_TSNS_PROV], 1);
Alexander Couzensa367d082020-12-21 14:06:24 +01001427 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001428 break;
1429 case 2:
Alexander Couzensa367d082020-12-21 14:06:24 +01001430 if (gss->N >= nsi->timeout[NS_TOUT_TSNS_CONFIG_RETRIES]) {
Alexander Couzens3df58862021-02-05 17:18:08 +01001431 LOGPFSML(fi, LOGL_ERROR, "NSE %d: BSS Config retries failed. Selecting next IP-SNS endpoint.\n", nse->nsei);
Alexander Couzens67725e22021-02-15 02:37:03 +01001432 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_REQ_SELECT_ENDPOINT, NULL);
Alexander Couzensa367d082020-12-21 14:06:24 +01001433 } else {
Harald Welte694dad52021-03-23 15:22:16 +01001434 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_BSS_CONFIG_BSS, nsi->timeout[NS_TOUT_TSNS_PROV], 2);
Alexander Couzensa367d082020-12-21 14:06:24 +01001435 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001436 break;
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001437 case 3:
Alexander Couzens3df58862021-02-05 17:18:08 +01001438 if (gss->N >= nsi->timeout[NS_TOUT_TSNS_CONFIG_RETRIES]) {
1439 LOGPFSML(fi, LOGL_ERROR, "NSE %d: SGSN Config retries failed. Selecting next IP-SNS endpoint.\n", nse->nsei);
Alexander Couzens67725e22021-02-15 02:37:03 +01001440 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_REQ_SELECT_ENDPOINT, NULL);
Alexander Couzens3df58862021-02-05 17:18:08 +01001441 } else {
Harald Welte694dad52021-03-23 15:22:16 +01001442 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_BSS_CONFIG_SGSN, nsi->timeout[NS_TOUT_TSNS_PROV], 3);
Alexander Couzens3df58862021-02-05 17:18:08 +01001443 }
1444 break;
1445 case 4:
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001446 LOGPFSML(fi, LOGL_ERROR, "NSE %d: Config succeeded but no NS-VC came online. Selecting next IP-SNS endpoint.\n", nse->nsei);
Alexander Couzens67725e22021-02-15 02:37:03 +01001447 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_REQ_SELECT_ENDPOINT, NULL);
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001448 break;
Alexander Couzens6a161492020-07-12 13:45:50 +02001449 }
1450 return 0;
1451}
1452
Harald Welte9e37bf42021-03-02 20:48:31 +01001453/* common allstate-action for both roles */
Alexander Couzens6a161492020-07-12 13:45:50 +02001454static void ns2_sns_st_all_action(struct osmo_fsm_inst *fi, uint32_t event, void *data)
1455{
1456 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001457 struct ns2_sns_bind *sbind;
1458 struct gprs_ns2_vc *nsvc, *nsvc2;
Alexander Couzens6a161492020-07-12 13:45:50 +02001459
Alexander Couzense769f522020-12-07 07:37:07 +01001460 switch (event) {
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001461 case GPRS_SNS_EV_REQ_ADD_BIND:
1462 sbind = data;
1463 switch (fi->state) {
1464 case GPRS_SNS_ST_UNCONFIGURED:
Alexander Couzens67725e22021-02-15 02:37:03 +01001465 osmo_fsm_inst_dispatch(nse->bss_sns_fi, GPRS_SNS_EV_REQ_SELECT_ENDPOINT, NULL);
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001466 break;
Harald Welte694dad52021-03-23 15:22:16 +01001467 case GPRS_SNS_ST_BSS_SIZE:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001468 /* TODO: add the ip4 element to the list */
1469 break;
Harald Welte694dad52021-03-23 15:22:16 +01001470 case GPRS_SNS_ST_BSS_CONFIG_BSS:
1471 case GPRS_SNS_ST_BSS_CONFIG_SGSN:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001472 case GPRS_SNS_ST_CONFIGURED:
1473 /* TODO: add to SNS-IP procedure queue & add nsvc() */
1474 break;
1475 }
1476 break;
1477 case GPRS_SNS_EV_REQ_DELETE_BIND:
1478 sbind = data;
1479 switch (fi->state) {
1480 case GPRS_SNS_ST_UNCONFIGURED:
1481 break;
Harald Welte694dad52021-03-23 15:22:16 +01001482 case GPRS_SNS_ST_BSS_SIZE:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001483 /* TODO: remove the ip4 element from the list */
1484 llist_for_each_entry_safe(nsvc, nsvc2, &nse->nsvc, list) {
1485 if (nsvc->bind == sbind->bind) {
1486 gprs_ns2_free_nsvc(nsvc);
1487 }
1488 }
1489 break;
Harald Welte694dad52021-03-23 15:22:16 +01001490 case GPRS_SNS_ST_BSS_CONFIG_BSS:
1491 case GPRS_SNS_ST_BSS_CONFIG_SGSN:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001492 case GPRS_SNS_ST_CONFIGURED:
1493 /* TODO: do an delete SNS-IP procedure */
1494 /* TODO: remove the ip4 element to the list */
1495 llist_for_each_entry_safe(nsvc, nsvc2, &nse->nsvc, list) {
1496 if (nsvc->bind == sbind->bind) {
1497 gprs_ns2_free_nsvc(nsvc);
1498 }
1499 }
1500 break;
1501 }
1502 /* if this is the last bind, the free_nsvc() will trigger a reselection */
1503 talloc_free(sbind);
1504 break;
Alexander Couzense769f522020-12-07 07:37:07 +01001505 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001506}
1507
Harald Welte9e37bf42021-03-02 20:48:31 +01001508/* allstate-action for BSS role */
1509static void ns2_sns_st_all_action_bss(struct osmo_fsm_inst *fi, uint32_t event, void *data)
1510{
1511 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
1512 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
1513
1514 /* reset when receiving GPRS_SNS_EV_REQ_NO_NSVC */
1515 switch (event) {
1516 case GPRS_SNS_EV_REQ_NO_NSVC:
1517 /* ignore reselection running */
1518 if (gss->reselection_running)
1519 break;
1520
1521 LOGPFSML(fi, LOGL_ERROR, "NSE %d: no remaining NSVC, resetting SNS FSM\n", nse->nsei);
1522 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_REQ_SELECT_ENDPOINT, NULL);
1523 break;
1524 case GPRS_SNS_EV_REQ_SELECT_ENDPOINT:
1525 /* tear down previous state
1526 * gprs_ns2_free_nsvcs() will trigger NO_NSVC, prevent this from triggering a reselection */
1527 gss->reselection_running = true;
1528 gprs_ns2_free_nsvcs(nse);
Harald Welte46eb7642021-03-04 17:49:59 +01001529 ns2_clear_ipv46_entries_local(gss);
1530 ns2_clear_ipv46_entries_remote(gss);
Harald Welte9e37bf42021-03-02 20:48:31 +01001531
1532 /* Choose the next sns endpoint. */
1533 if (llist_empty(&gss->sns_endpoints) || llist_empty(&gss->binds)) {
1534 gss->initial = NULL;
1535 ns2_prim_status_ind(gss->nse, NULL, 0, GPRS_NS2_AFF_CAUSE_SNS_NO_ENDPOINTS);
1536 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 3);
1537 return;
1538 } else if (!gss->initial) {
1539 gss->initial = llist_first_entry(&gss->sns_endpoints, struct sns_endpoint, list);
1540 } else if (gss->initial->list.next == &gss->sns_endpoints) {
1541 /* last entry, continue with first */
1542 gss->initial = llist_first_entry(&gss->sns_endpoints, struct sns_endpoint, list);
1543 } else {
1544 /* next element is an entry */
1545 gss->initial = llist_entry(gss->initial->list.next, struct sns_endpoint, list);
1546 }
1547
1548 gss->reselection_running = false;
Harald Welte694dad52021-03-23 15:22:16 +01001549 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_BSS_SIZE, nse->nsi->timeout[NS_TOUT_TSNS_PROV], 1);
Harald Welte9e37bf42021-03-02 20:48:31 +01001550 break;
1551 default:
1552 ns2_sns_st_all_action(fi, event, data);
1553 break;
1554 }
1555}
1556
Alexander Couzens6a161492020-07-12 13:45:50 +02001557static struct osmo_fsm gprs_ns2_sns_bss_fsm = {
1558 .name = "GPRS-NS2-SNS-BSS",
1559 .states = ns2_sns_bss_states,
1560 .num_states = ARRAY_SIZE(ns2_sns_bss_states),
Alexander Couzens67725e22021-02-15 02:37:03 +01001561 .allstate_event_mask = S(GPRS_SNS_EV_REQ_NO_NSVC) |
1562 S(GPRS_SNS_EV_REQ_SELECT_ENDPOINT) |
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001563 S(GPRS_SNS_EV_REQ_ADD_BIND) |
1564 S(GPRS_SNS_EV_REQ_DELETE_BIND),
Harald Welte9e37bf42021-03-02 20:48:31 +01001565 .allstate_action = ns2_sns_st_all_action_bss,
Alexander Couzens6a161492020-07-12 13:45:50 +02001566 .cleanup = NULL,
1567 .timer_cb = ns2_sns_fsm_bss_timer_cb,
Alexander Couzens6a161492020-07-12 13:45:50 +02001568 .event_names = gprs_sns_event_names,
1569 .pre_term = NULL,
1570 .log_subsys = DLNS,
1571};
1572
Harald Welte5bef2cc2020-09-18 22:33:24 +02001573/*! Allocate an IP-SNS FSM for the BSS side.
1574 * \param[in] nse NS Entity in which the FSM runs
1575 * \param[in] id string identifier
Alexander Couzens23aec352021-02-15 05:05:15 +01001576 * \returns FSM instance on success; NULL on error */
Alexander Couzens6a161492020-07-12 13:45:50 +02001577struct osmo_fsm_inst *ns2_sns_bss_fsm_alloc(struct gprs_ns2_nse *nse,
1578 const char *id)
1579{
1580 struct osmo_fsm_inst *fi;
1581 struct ns2_sns_state *gss;
1582
1583 fi = osmo_fsm_inst_alloc(&gprs_ns2_sns_bss_fsm, nse, NULL, LOGL_DEBUG, id);
1584 if (!fi)
1585 return fi;
1586
1587 gss = talloc_zero(fi, struct ns2_sns_state);
1588 if (!gss)
1589 goto err;
1590
1591 fi->priv = gss;
1592 gss->nse = nse;
Harald Welte4f127462021-03-02 20:49:10 +01001593 gss->role = GPRS_SNS_ROLE_BSS;
Harald Welte24f4df52021-03-04 18:02:54 +01001594 /* The SGSN doesn't tell the BSS, so we assume there's always sufficient */
1595 gss->num_max_ip4_remote = 8192;
1596 gss->num_max_ip6_remote = 8192;
Alexander Couzense769f522020-12-07 07:37:07 +01001597 INIT_LLIST_HEAD(&gss->sns_endpoints);
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001598 INIT_LLIST_HEAD(&gss->binds);
Alexander Couzens6a161492020-07-12 13:45:50 +02001599
1600 return fi;
1601err:
1602 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
1603 return NULL;
1604}
1605
Harald Welte5bef2cc2020-09-18 22:33:24 +02001606/*! main entry point for receiving SNS messages from the network.
1607 * \param[in] nsvc NS-VC on which the message was received
1608 * \param[in] msg message buffer of the IP-SNS message
1609 * \param[in] tp parsed TLV structure of message
Alexander Couzens23aec352021-02-15 05:05:15 +01001610 * \returns 0 on success; negative on error */
Alexander Couzens8dfc24c2021-01-25 16:09:23 +01001611int ns2_sns_rx(struct gprs_ns2_vc *nsvc, struct msgb *msg, struct tlv_parsed *tp)
Alexander Couzens6a161492020-07-12 13:45:50 +02001612{
1613 struct gprs_ns2_nse *nse = nsvc->nse;
1614 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
1615 uint16_t nsei = nsvc->nse->nsei;
Harald Welte4f127462021-03-02 20:49:10 +01001616 struct ns2_sns_state *gss;
Alexander Couzens6a161492020-07-12 13:45:50 +02001617 struct osmo_fsm_inst *fi;
1618
1619 if (!nse->bss_sns_fi) {
Harald Weltef2949742021-01-20 14:54:14 +01001620 LOGNSVC(nsvc, LOGL_NOTICE, "Rx %s for NS Instance that has no SNS!\n",
1621 get_value_string(gprs_ns_pdu_strings, nsh->pdu_type));
Alexander Couzens6a161492020-07-12 13:45:50 +02001622 return -EINVAL;
1623 }
1624
Alexander Couzens6a161492020-07-12 13:45:50 +02001625 /* FIXME: how to resolve SNS FSM Instance by NSEI (SGSN)? */
1626 fi = nse->bss_sns_fi;
Harald Welte4f127462021-03-02 20:49:10 +01001627 gss = (struct ns2_sns_state *) fi->priv;
1628 if (!gss->sns_nsvc)
1629 gss->sns_nsvc = nsvc;
Alexander Couzens6a161492020-07-12 13:45:50 +02001630
Harald Weltef2949742021-01-20 14:54:14 +01001631 LOGPFSML(fi, LOGL_DEBUG, "NSEI=%u Rx SNS PDU type %s\n", nsei,
1632 get_value_string(gprs_ns_pdu_strings, nsh->pdu_type));
1633
Alexander Couzens6a161492020-07-12 13:45:50 +02001634 switch (nsh->pdu_type) {
1635 case SNS_PDUT_SIZE:
Alexander Couzens67725e22021-02-15 02:37:03 +01001636 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_RX_SIZE, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001637 break;
1638 case SNS_PDUT_SIZE_ACK:
Alexander Couzens67725e22021-02-15 02:37:03 +01001639 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_RX_SIZE_ACK, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001640 break;
1641 case SNS_PDUT_CONFIG:
1642 if (nsh->data[0] & 0x01)
Alexander Couzens67725e22021-02-15 02:37:03 +01001643 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_RX_CONFIG_END, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001644 else
Alexander Couzens67725e22021-02-15 02:37:03 +01001645 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_RX_CONFIG, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001646 break;
1647 case SNS_PDUT_CONFIG_ACK:
Alexander Couzens67725e22021-02-15 02:37:03 +01001648 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_RX_CONFIG_ACK, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001649 break;
1650 case SNS_PDUT_ADD:
Alexander Couzens67725e22021-02-15 02:37:03 +01001651 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_RX_ADD, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001652 break;
1653 case SNS_PDUT_DELETE:
Alexander Couzens67725e22021-02-15 02:37:03 +01001654 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_RX_DELETE, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001655 break;
1656 case SNS_PDUT_CHANGE_WEIGHT:
Alexander Couzens67725e22021-02-15 02:37:03 +01001657 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_RX_CHANGE_WEIGHT, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001658 break;
1659 case SNS_PDUT_ACK:
Harald Welteb9f23872021-03-02 20:48:54 +01001660 osmo_fsm_inst_dispatch(fi, GPRS_SNS_EV_RX_ACK, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001661 break;
1662 default:
Harald Weltef2949742021-01-20 14:54:14 +01001663 LOGPFSML(fi, LOGL_ERROR, "NSEI=%u Rx unknown SNS PDU type %s\n", nsei,
1664 get_value_string(gprs_ns_pdu_strings, nsh->pdu_type));
Alexander Couzens6a161492020-07-12 13:45:50 +02001665 return -EINVAL;
1666 }
1667
1668 return 0;
1669}
1670
1671#include <osmocom/vty/vty.h>
1672#include <osmocom/vty/misc.h>
1673
Harald Welte1262c4f2021-01-19 20:58:33 +01001674static void vty_dump_sns_ip4(struct vty *vty, const char *prefix, const struct gprs_ns_ie_ip4_elem *ip4)
Alexander Couzens6a161492020-07-12 13:45:50 +02001675{
1676 struct in_addr in = { .s_addr = ip4->ip_addr };
Harald Welte1262c4f2021-01-19 20:58:33 +01001677 vty_out(vty, "%s %s:%u, Signalling Weight: %u, Data Weight: %u%s", prefix,
Alexander Couzens6a161492020-07-12 13:45:50 +02001678 inet_ntoa(in), ntohs(ip4->udp_port), ip4->sig_weight, ip4->data_weight, VTY_NEWLINE);
1679}
1680
Harald Welte1262c4f2021-01-19 20:58:33 +01001681static void vty_dump_sns_ip6(struct vty *vty, const char *prefix, const struct gprs_ns_ie_ip6_elem *ip6)
Alexander Couzens6a161492020-07-12 13:45:50 +02001682{
1683 char ip_addr[INET6_ADDRSTRLEN] = {};
1684 if (!inet_ntop(AF_INET6, &ip6->ip_addr, ip_addr, (INET6_ADDRSTRLEN)))
1685 strcpy(ip_addr, "Invalid IPv6");
1686
Harald Welte1262c4f2021-01-19 20:58:33 +01001687 vty_out(vty, "%s %s:%u, Signalling Weight: %u, Data Weight: %u%s", prefix,
Alexander Couzens6a161492020-07-12 13:45:50 +02001688 ip_addr, ntohs(ip6->udp_port), ip6->sig_weight, ip6->data_weight, VTY_NEWLINE);
1689}
1690
Harald Welte5bef2cc2020-09-18 22:33:24 +02001691/*! Dump the IP-SNS state to a vty.
1692 * \param[in] vty VTY to which the state shall be printed
Harald Welte1262c4f2021-01-19 20:58:33 +01001693 * \param[in] prefix prefix to print at start of each line (typically indenting)
Harald Welte5bef2cc2020-09-18 22:33:24 +02001694 * \param[in] nse NS Entity whose IP-SNS state shall be printed
1695 * \param[in] stats Whether or not statistics shall also be printed */
Alexander Couzens8dfc24c2021-01-25 16:09:23 +01001696void ns2_sns_dump_vty(struct vty *vty, const char *prefix, const struct gprs_ns2_nse *nse, bool stats)
Alexander Couzens6a161492020-07-12 13:45:50 +02001697{
1698 struct ns2_sns_state *gss;
1699 unsigned int i;
1700
1701 if (!nse->bss_sns_fi)
1702 return;
1703
Harald Welte1262c4f2021-01-19 20:58:33 +01001704 vty_out_fsm_inst2(vty, prefix, nse->bss_sns_fi);
Alexander Couzens6a161492020-07-12 13:45:50 +02001705 gss = (struct ns2_sns_state *) nse->bss_sns_fi->priv;
1706
Harald Welte1262c4f2021-01-19 20:58:33 +01001707 vty_out(vty, "%sMaximum number of remote NS-VCs: %zu, IPv4 Endpoints: %zu, IPv6 Endpoints: %zu%s",
1708 prefix, gss->num_max_nsvcs, gss->num_max_ip4_remote, gss->num_max_ip6_remote, VTY_NEWLINE);
Alexander Couzens6a161492020-07-12 13:45:50 +02001709
1710 if (gss->num_ip4_local && gss->num_ip4_remote) {
Harald Welte1262c4f2021-01-19 20:58:33 +01001711 vty_out(vty, "%sLocal IPv4 Endpoints:%s", prefix, VTY_NEWLINE);
Alexander Couzens6a161492020-07-12 13:45:50 +02001712 for (i = 0; i < gss->num_ip4_local; i++)
Harald Welte1262c4f2021-01-19 20:58:33 +01001713 vty_dump_sns_ip4(vty, prefix, &gss->ip4_local[i]);
Alexander Couzens6a161492020-07-12 13:45:50 +02001714
Harald Welte1262c4f2021-01-19 20:58:33 +01001715 vty_out(vty, "%sRemote IPv4 Endpoints:%s", prefix, VTY_NEWLINE);
Alexander Couzens6a161492020-07-12 13:45:50 +02001716 for (i = 0; i < gss->num_ip4_remote; i++)
Harald Welte1262c4f2021-01-19 20:58:33 +01001717 vty_dump_sns_ip4(vty, prefix, &gss->ip4_remote[i]);
Alexander Couzens6a161492020-07-12 13:45:50 +02001718 }
1719
1720 if (gss->num_ip6_local && gss->num_ip6_remote) {
Harald Welte1262c4f2021-01-19 20:58:33 +01001721 vty_out(vty, "%sLocal IPv6 Endpoints:%s", prefix, VTY_NEWLINE);
Alexander Couzens6a161492020-07-12 13:45:50 +02001722 for (i = 0; i < gss->num_ip6_local; i++)
Harald Welte1262c4f2021-01-19 20:58:33 +01001723 vty_dump_sns_ip6(vty, prefix, &gss->ip6_local[i]);
Alexander Couzens6a161492020-07-12 13:45:50 +02001724
Harald Welte1262c4f2021-01-19 20:58:33 +01001725 vty_out(vty, "%sRemote IPv6 Endpoints:%s", prefix, VTY_NEWLINE);
Alexander Couzens6a161492020-07-12 13:45:50 +02001726 for (i = 0; i < gss->num_ip6_remote; i++)
Harald Welte1262c4f2021-01-19 20:58:33 +01001727 vty_dump_sns_ip6(vty, prefix, &gss->ip6_remote[i]);
Alexander Couzens6a161492020-07-12 13:45:50 +02001728 }
1729}
1730
Alexander Couzens412bc342020-11-19 05:24:37 +01001731/*! write IP-SNS to a vty
1732 * \param[in] vty VTY to which the state shall be printed
1733 * \param[in] nse NS Entity whose IP-SNS state shall be printed */
Alexander Couzens8dfc24c2021-01-25 16:09:23 +01001734void ns2_sns_write_vty(struct vty *vty, const struct gprs_ns2_nse *nse)
Alexander Couzens412bc342020-11-19 05:24:37 +01001735{
1736 struct ns2_sns_state *gss;
1737 struct osmo_sockaddr_str addr_str;
1738 struct sns_endpoint *endpoint;
1739
1740 if (!nse->bss_sns_fi)
1741 return;
1742
1743 gss = (struct ns2_sns_state *) nse->bss_sns_fi->priv;
1744 llist_for_each_entry(endpoint, &gss->sns_endpoints, list) {
Vadim Yanitskiyd8b70032021-01-05 14:24:09 +01001745 /* It's unlikely that an error happens, but let's better be safe. */
1746 if (osmo_sockaddr_str_from_sockaddr(&addr_str, &endpoint->saddr.u.sas) != 0)
1747 addr_str = (struct osmo_sockaddr_str) { .ip = "<INVALID>" };
Alexander Couzens5fa431c2021-02-08 23:21:54 +01001748 vty_out(vty, " ip-sns-remote %s %u%s", addr_str.ip, addr_str.port, VTY_NEWLINE);
Alexander Couzens412bc342020-11-19 05:24:37 +01001749 }
1750}
1751
Alexander Couzense769f522020-12-07 07:37:07 +01001752static struct sns_endpoint *ns2_get_sns_endpoint(struct ns2_sns_state *state,
1753 const struct osmo_sockaddr *saddr)
1754{
1755 struct sns_endpoint *endpoint;
1756
1757 llist_for_each_entry(endpoint, &state->sns_endpoints, list) {
1758 if (!osmo_sockaddr_cmp(saddr, &endpoint->saddr))
1759 return endpoint;
1760 }
1761
1762 return NULL;
1763}
1764
1765/*! gprs_ns2_sns_add_endpoint
1766 * \param[in] nse
1767 * \param[in] sockaddr
1768 * \return
1769 */
1770int gprs_ns2_sns_add_endpoint(struct gprs_ns2_nse *nse,
1771 const struct osmo_sockaddr *saddr)
1772{
1773 struct ns2_sns_state *gss;
1774 struct sns_endpoint *endpoint;
1775 bool do_selection = false;
1776
1777 if (nse->ll != GPRS_NS2_LL_UDP) {
1778 return -EINVAL;
1779 }
1780
Alexander Couzens138b96f2021-01-25 16:23:29 +01001781 if (nse->dialect != GPRS_NS2_DIALECT_SNS) {
Alexander Couzense769f522020-12-07 07:37:07 +01001782 return -EINVAL;
1783 }
1784
1785 gss = nse->bss_sns_fi->priv;
1786
1787 if (ns2_get_sns_endpoint(gss, saddr))
1788 return -EADDRINUSE;
1789
1790 endpoint = talloc_zero(nse->bss_sns_fi->priv, struct sns_endpoint);
1791 if (!endpoint)
1792 return -ENOMEM;
1793
1794 endpoint->saddr = *saddr;
1795 if (llist_empty(&gss->sns_endpoints))
1796 do_selection = true;
1797
1798 llist_add_tail(&endpoint->list, &gss->sns_endpoints);
1799 if (do_selection)
Alexander Couzens67725e22021-02-15 02:37:03 +01001800 osmo_fsm_inst_dispatch(nse->bss_sns_fi, GPRS_SNS_EV_REQ_SELECT_ENDPOINT, NULL);
Alexander Couzense769f522020-12-07 07:37:07 +01001801
1802 return 0;
1803}
1804
1805/*! gprs_ns2_sns_del_endpoint
1806 * \param[in] nse
1807 * \param[in] sockaddr
1808 * \return 0 on success, otherwise < 0
1809 */
1810int gprs_ns2_sns_del_endpoint(struct gprs_ns2_nse *nse,
1811 const struct osmo_sockaddr *saddr)
1812{
1813 struct ns2_sns_state *gss;
1814 struct sns_endpoint *endpoint;
1815
1816 if (nse->ll != GPRS_NS2_LL_UDP) {
1817 return -EINVAL;
1818 }
1819
Alexander Couzens138b96f2021-01-25 16:23:29 +01001820 if (nse->dialect != GPRS_NS2_DIALECT_SNS) {
Alexander Couzense769f522020-12-07 07:37:07 +01001821 return -EINVAL;
1822 }
1823
1824 gss = nse->bss_sns_fi->priv;
1825 endpoint = ns2_get_sns_endpoint(gss, saddr);
1826 if (!endpoint)
1827 return -ENOENT;
1828
1829 /* if this is an unused SNS endpoint it's done */
1830 if (gss->initial != endpoint) {
1831 llist_del(&endpoint->list);
1832 talloc_free(endpoint);
1833 return 0;
1834 }
1835
Alexander Couzens67725e22021-02-15 02:37:03 +01001836 /* gprs_ns2_free_nsvcs() will trigger GPRS_SNS_EV_REQ_NO_NSVC on the last NS-VC
Alexander Couzense769f522020-12-07 07:37:07 +01001837 * and restart SNS SIZE procedure which selects a new initial */
Harald Weltef2949742021-01-20 14:54:14 +01001838 LOGNSE(nse, LOGL_INFO, "Current in-use SNS endpoint is being removed."
Alexander Couzense769f522020-12-07 07:37:07 +01001839 "Closing all NS-VC and restart SNS-SIZE procedure"
1840 "with a remaining SNS endpoint.\n");
1841
1842 /* Continue with the next endpoint in the list.
1843 * Special case if the endpoint is at the start or end of the list */
1844 if (endpoint->list.prev == &gss->sns_endpoints ||
1845 endpoint->list.next == &gss->sns_endpoints)
1846 gss->initial = NULL;
1847 else
1848 gss->initial = llist_entry(endpoint->list.next->prev,
1849 struct sns_endpoint,
1850 list);
1851
1852 llist_del(&endpoint->list);
1853 gprs_ns2_free_nsvcs(nse);
1854 talloc_free(endpoint);
1855
1856 return 0;
1857}
1858
1859/*! gprs_ns2_sns_count
1860 * \param[in] nse NS Entity whose IP-SNS endpoints shall be printed
1861 * \return the count of endpoints or < 0 if NSE doesn't contain sns.
1862 */
1863int gprs_ns2_sns_count(struct gprs_ns2_nse *nse)
1864{
1865 struct ns2_sns_state *gss;
1866 struct sns_endpoint *endpoint;
1867 int count = 0;
1868
1869 if (nse->ll != GPRS_NS2_LL_UDP) {
1870 return -EINVAL;
1871 }
1872
Alexander Couzens138b96f2021-01-25 16:23:29 +01001873 if (nse->dialect != GPRS_NS2_DIALECT_SNS) {
Alexander Couzense769f522020-12-07 07:37:07 +01001874 return -EINVAL;
1875 }
1876
1877 gss = nse->bss_sns_fi->priv;
1878 llist_for_each_entry(endpoint, &gss->sns_endpoints, list)
1879 count++;
1880
1881 return count;
1882}
1883
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001884void ns2_sns_notify_alive(struct gprs_ns2_nse *nse, struct gprs_ns2_vc *nsvc, bool alive)
1885{
1886 struct ns2_sns_state *gss;
1887 struct gprs_ns2_vc *tmp;
1888
1889 if (!nse->bss_sns_fi)
1890 return;
1891
1892 gss = nse->bss_sns_fi->priv;
1893 if(nse->bss_sns_fi->state != GPRS_SNS_ST_CONFIGURED)
1894 return;
1895
1896 if (alive == gss->alive)
1897 return;
1898
1899 /* check if this is the current SNS NS-VC */
1900 if (nsvc == gss->sns_nsvc) {
1901 /* only replace the SNS NS-VC if there are other alive NS-VC.
1902 * There aren't any other alive NS-VC when the SNS fsm just reached CONFIGURED
1903 * and couldn't confirm yet if the NS-VC comes up */
1904 if (gss->alive && !alive)
1905 ns2_sns_replace_nsvc(nsvc);
1906 }
1907
1908 if (alive) {
1909 gss->alive = true;
Alexander Couzens67725e22021-02-15 02:37:03 +01001910 osmo_fsm_inst_dispatch(nse->bss_sns_fi, GPRS_SNS_EV_REQ_NSVC_ALIVE, NULL);
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001911 } else {
1912 /* is there at least another alive nsvc? */
1913 llist_for_each_entry(tmp, &nse->nsvc, list) {
1914 if (ns2_vc_is_unblocked(tmp))
1915 return;
1916 }
1917
1918 /* all NS-VC have failed */
1919 gss->alive = false;
Alexander Couzens67725e22021-02-15 02:37:03 +01001920 osmo_fsm_inst_dispatch(nse->bss_sns_fi, GPRS_SNS_EV_REQ_NO_NSVC, NULL);
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001921 }
1922}
1923
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001924int gprs_ns2_sns_add_bind(struct gprs_ns2_nse *nse,
1925 struct gprs_ns2_vc_bind *bind)
1926{
1927 struct ns2_sns_state *gss;
1928 struct ns2_sns_bind *tmp;
1929
1930 OSMO_ASSERT(nse->bss_sns_fi);
1931 gss = nse->bss_sns_fi->priv;
1932
1933 if (!gprs_ns2_is_ip_bind(bind)) {
1934 return -EINVAL;
1935 }
1936
1937 if (!llist_empty(&gss->binds)) {
1938 llist_for_each_entry(tmp, &gss->binds, list) {
1939 if (tmp->bind == bind)
1940 return -EALREADY;
1941 }
1942 }
1943
1944 tmp = talloc_zero(gss, struct ns2_sns_bind);
1945 if (!tmp)
1946 return -ENOMEM;
1947 tmp->bind = bind;
1948 llist_add_tail(&tmp->list, &gss->binds);
1949
1950 osmo_fsm_inst_dispatch(nse->bss_sns_fi, GPRS_SNS_EV_REQ_ADD_BIND, tmp);
1951 return 0;
1952}
1953
1954/* Remove a bind from the SNS. All assosiated NSVC must be removed. */
1955int gprs_ns2_sns_del_bind(struct gprs_ns2_nse *nse,
1956 struct gprs_ns2_vc_bind *bind)
1957{
1958 struct ns2_sns_state *gss;
1959 struct ns2_sns_bind *tmp, *tmp2;
1960 bool found = false;
1961
1962 if (!nse->bss_sns_fi)
1963 return -EINVAL;
1964
1965 gss = nse->bss_sns_fi->priv;
1966 if (gss->initial_bind && gss->initial_bind->bind == bind) {
1967 if (gss->initial_bind->list.prev == &gss->binds)
1968 gss->initial_bind = NULL;
1969 else
1970 gss->initial_bind = llist_entry(gss->initial_bind->list.prev, struct ns2_sns_bind, list);
1971 }
1972
1973 llist_for_each_entry_safe(tmp, tmp2, &gss->binds, list) {
1974 if (tmp->bind == bind) {
1975 llist_del(&tmp->list);
1976 found = true;
1977 }
1978 }
1979
1980 if (!found)
1981 return -ENOENT;
1982
1983 osmo_fsm_inst_dispatch(nse->bss_sns_fi, GPRS_SNS_EV_REQ_DELETE_BIND, tmp);
1984 return 0;
1985}
1986
Alexander Couzensc4704762021-02-08 23:13:12 +01001987/* Update SNS weights
1988 * \param[in] nsvc the NSVC which should be updated
1989 */
1990void ns2_sns_update_weights(struct gprs_ns2_vc_bind *bind)
1991{
1992 /* TODO: implement weights after binds per sns implemented */
1993}
1994
Harald Welte4f127462021-03-02 20:49:10 +01001995
1996
1997
1998/***********************************************************************
1999 * SGSN role
2000 ***********************************************************************/
2001
2002static void ns2_sns_st_sgsn_unconfigured(struct osmo_fsm_inst *fi, uint32_t event, void *data)
2003{
2004 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2005 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2006 /* do nothing; Rx SNS-SIZE handled in ns2_sns_st_all_action_sgsn() */
2007}
2008
2009/* We're waiting for inbound SNS-CONFIG from the BSS */
2010static void ns2_sns_st_sgsn_wait_config(struct osmo_fsm_inst *fi, uint32_t event, void *data)
2011{
2012 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2013 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
2014 struct gprs_ns2_inst *nsi = nse->nsi;
2015 uint8_t cause;
2016 int rc;
2017
2018 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2019
2020 switch (event) {
2021 case GPRS_SNS_EV_RX_CONFIG:
2022 case GPRS_SNS_EV_RX_CONFIG_END:
2023 rc = ns_sns_append_remote_eps(fi, data);
2024 if (rc < 0) {
2025 cause = -rc;
2026 ns2_tx_sns_config_ack(gss->sns_nsvc, &cause);
2027 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
2028 return;
2029 }
2030 /* only change state if last CONFIG was received */
2031 if (event == GPRS_SNS_EV_RX_CONFIG_END) {
2032 /* ensure sum of data weight / sig weights is > 0 */
2033 if (nss_weight_sum_data(gss) == 0 || nss_weight_sum_sig(gss) == 0) {
2034 cause = NS_CAUSE_INVAL_WEIGH;
2035 ns2_tx_sns_config_ack(gss->sns_nsvc, &cause);
2036 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
2037 break;
2038 }
2039 ns2_tx_sns_config_ack(gss->sns_nsvc, NULL);
2040 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK, nsi->timeout[NS_TOUT_TSNS_PROV], 3);
2041 } else {
2042 /* just send CONFIG-ACK */
2043 ns2_tx_sns_config_ack(gss->sns_nsvc, NULL);
2044 osmo_timer_schedule(&fi->timer, nse->nsi->timeout[NS_TOUT_TSNS_PROV], 0);
2045 }
2046 break;
2047 }
2048}
2049
2050static void ns2_sns_st_sgsn_wait_config_ack_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
2051{
2052 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2053 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2054
Harald Welte4f127462021-03-02 20:49:10 +01002055 /* transmit SGSN-oriented SNS-CONFIG */
2056 ns2_tx_sns_config(gss->sns_nsvc, true, gss->ip4_local, gss->num_ip4_local,
2057 gss->ip6_local, gss->num_ip6_local);
2058}
2059
2060/* We're waiting for SNS-CONFIG-ACK from the BSS (in response to our outbound SNS-CONFIG) */
2061static void ns2_sns_st_sgsn_wait_config_ack(struct osmo_fsm_inst *fi, uint32_t event, void *data)
2062{
2063 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2064 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
2065 struct tlv_parsed *tp = NULL;
2066
2067 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2068
2069 switch (event) {
2070 case GPRS_SNS_EV_RX_CONFIG_ACK:
2071 tp = data;
2072 if (TLVP_VAL_MINLEN(tp, NS_IE_CAUSE, 1)) {
2073 LOGPFSML(fi, LOGL_ERROR, "Rx SNS-CONFIG-ACK with cause %s\n",
2074 gprs_ns2_cause_str(*TLVP_VAL(tp, NS_IE_CAUSE)));
2075 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
2076 break;
2077 }
2078 /* we currently only send one SNS-CONFIG with END FLAG */
2079 if (true) {
2080 create_missing_nsvcs(fi);
2081 /* start the test procedure on ALL NSVCs! */
2082 gprs_ns2_start_alive_all_nsvcs(nse);
2083 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_CONFIGURED, ns_sns_configured_timeout(fi), 4);
2084 }
2085 break;
2086 }
2087}
2088
2089/* SGSN-side SNS state machine */
2090static const struct osmo_fsm_state ns2_sns_sgsn_states[] = {
2091 [GPRS_SNS_ST_UNCONFIGURED] = {
2092 .in_event_mask = 0, /* handled by all_state_action */
2093 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
2094 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG),
2095 .name = "UNCONFIGURED",
2096 .action = ns2_sns_st_sgsn_unconfigured,
2097 },
2098 [GPRS_SNS_ST_SGSN_WAIT_CONFIG] = {
2099 .in_event_mask = S(GPRS_SNS_EV_RX_CONFIG) |
2100 S(GPRS_SNS_EV_RX_CONFIG_END),
2101 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
2102 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG) |
2103 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK),
2104 .name = "SGSN_WAIT_CONFIG",
2105 .action = ns2_sns_st_sgsn_wait_config,
2106 },
2107 [GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK] = {
2108 .in_event_mask = S(GPRS_SNS_EV_RX_CONFIG_ACK),
2109 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
2110 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK) |
2111 S(GPRS_SNS_ST_CONFIGURED),
2112 .name = "SGSN_WAIT_CONFIG_ACK",
2113 .action = ns2_sns_st_sgsn_wait_config_ack,
2114 .onenter = ns2_sns_st_sgsn_wait_config_ack_onenter,
2115 },
2116 [GPRS_SNS_ST_CONFIGURED] = {
2117 .in_event_mask = S(GPRS_SNS_EV_RX_ADD) |
2118 S(GPRS_SNS_EV_RX_DELETE) |
2119 S(GPRS_SNS_EV_RX_CHANGE_WEIGHT) |
2120 S(GPRS_SNS_EV_REQ_NSVC_ALIVE),
2121 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED),
2122 .name = "CONFIGURED",
2123 /* shared with BSS side; once configured there's no difference */
2124 .action = ns2_sns_st_configured,
2125 .onenter = ns2_sns_st_configured_onenter,
2126 },
2127};
2128
2129static int ns2_sns_fsm_sgsn_timer_cb(struct osmo_fsm_inst *fi)
2130{
2131 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2132 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
2133 struct gprs_ns2_inst *nsi = nse->nsi;
2134
2135 gss->N++;
2136 switch (fi->T) {
2137 case 3:
2138 if (gss->N >= nsi->timeout[NS_TOUT_TSNS_CONFIG_RETRIES]) {
2139 LOGPFSML(fi, LOGL_ERROR, "NSE %d: SGSN Config retries failed. Giving up.\n", nse->nsei);
2140 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, nsi->timeout[NS_TOUT_TSNS_PROV], 3);
2141 } else {
2142 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK, nsi->timeout[NS_TOUT_TSNS_PROV], 3);
2143 }
2144 break;
2145 case 4:
2146 LOGPFSML(fi, LOGL_ERROR, "NSE %d: Config succeeded but no NS-VC came online.\n", nse->nsei);
2147 break;
2148 }
2149 return 0;
2150}
2151
2152
2153/* allstate-action for SGSN role */
2154static void ns2_sns_st_all_action_sgsn(struct osmo_fsm_inst *fi, uint32_t event, void *data)
2155{
2156 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2157 struct tlv_parsed *tp = NULL;
Harald Welte01fa6a32021-03-04 19:49:38 +01002158 size_t num_local_eps, num_remote_eps;
Harald Welte4f127462021-03-02 20:49:10 +01002159 uint8_t flag;
Harald Weltea2c5af52021-03-04 17:59:35 +01002160 uint8_t cause;
Harald Welte4f127462021-03-02 20:49:10 +01002161
2162 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2163
2164 switch (event) {
2165 case GPRS_SNS_EV_RX_SIZE:
2166 tp = (struct tlv_parsed *) data;
Harald Weltea2c5af52021-03-04 17:59:35 +01002167 /* check for mandatory / conditional IEs */
2168 if (!TLVP_PRES_LEN(tp, NS_IE_RESET_FLAG, 1) ||
2169 !TLVP_PRES_LEN(tp, NS_IE_MAX_NR_NSVC, 2)) {
2170 cause = NS_CAUSE_MISSING_ESSENT_IE;
2171 ns2_tx_sns_size_ack(gss->sns_nsvc, &cause);
2172 break;
2173 }
2174 if (!TLVP_PRES_LEN(tp, NS_IE_IPv4_EP_NR, 2) &&
2175 !TLVP_PRES_LEN(tp, NS_IE_IPv6_EP_NR, 2)) {
2176 cause = NS_CAUSE_MISSING_ESSENT_IE;
Harald Welte4f127462021-03-02 20:49:10 +01002177 ns2_tx_sns_size_ack(gss->sns_nsvc, &cause);
2178 break;
2179 }
Harald Welte01fa6a32021-03-04 19:49:38 +01002180 if (TLVP_PRES_LEN(tp, NS_IE_IPv4_EP_NR, 2))
2181 gss->num_max_ip4_remote = tlvp_val16be(tp, NS_IE_IPv4_EP_NR);
2182 if (TLVP_PRES_LEN(tp, NS_IE_IPv6_EP_NR, 2))
2183 gss->num_max_ip6_remote = tlvp_val16be(tp, NS_IE_IPv6_EP_NR);
2184 /* decide if we go for IPv4 or IPv6 */
2185 if (gss->num_max_ip6_remote && ns2_sns_count_num_local_ep(fi, IPv6)) {
2186 gss->ip = IPv6;
Harald Welte2d807b62021-03-24 01:57:30 +01002187 ns2_sns_compute_local_ep_from_binds(fi);
Harald Welte01fa6a32021-03-04 19:49:38 +01002188 num_local_eps = gss->num_ip6_local;
2189 num_remote_eps = gss->num_max_ip6_remote;
2190 } else if (gss->num_max_ip4_remote && ns2_sns_count_num_local_ep(fi, IPv4)) {
2191 gss->ip = IPv4;
Harald Welte2d807b62021-03-24 01:57:30 +01002192 ns2_sns_compute_local_ep_from_binds(fi);
Harald Welte01fa6a32021-03-04 19:49:38 +01002193 num_local_eps = gss->num_ip4_local;
2194 num_remote_eps = gss->num_max_ip4_remote;
2195 } else {
2196 if (gss->num_ip4_local && !gss->num_max_ip4_remote)
2197 cause = NS_CAUSE_INVAL_NR_IPv4_EP;
2198 else
2199 cause = NS_CAUSE_INVAL_NR_IPv6_EP;
2200 ns2_tx_sns_size_ack(gss->sns_nsvc, &cause);
2201 break;
2202 }
Harald Welte01fa6a32021-03-04 19:49:38 +01002203 /* ensure number of NS-VCs is sufficient for full mesh */
2204 gss->num_max_nsvcs = tlvp_val16be(tp, NS_IE_MAX_NR_NSVC);
2205 if (gss->num_max_nsvcs < num_remote_eps * num_local_eps) {
2206 LOGPFSML(fi, LOGL_ERROR, "%zu local and %zu remote EPs, requires %zu NS-VC, "
2207 "but BSS supports only %zu maximum NS-VCs\n", num_local_eps,
2208 num_remote_eps, num_local_eps * num_remote_eps, gss->num_max_nsvcs);
2209 cause = NS_CAUSE_INVAL_NR_NS_VC;
2210 ns2_tx_sns_size_ack(gss->sns_nsvc, &cause);
2211 break;
2212 }
2213 /* perform state reset, if requested */
Harald Welte4f127462021-03-02 20:49:10 +01002214 flag = *TLVP_VAL(tp, NS_IE_RESET_FLAG);
2215 if (flag & 1) {
2216 struct gprs_ns2_vc *nsvc, *nsvc2;
2217 /* clear all state */
Harald Welte46eb7642021-03-04 17:49:59 +01002218 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
Harald Welte4f127462021-03-02 20:49:10 +01002219 gss->N = 0;
Harald Welte46eb7642021-03-04 17:49:59 +01002220 ns2_clear_ipv46_entries_local(gss);
2221 ns2_clear_ipv46_entries_remote(gss);
Harald Welte4f127462021-03-02 20:49:10 +01002222 llist_for_each_entry_safe(nsvc, nsvc2, &gss->nse->nsvc, list) {
2223 if (nsvc == gss->sns_nsvc) {
2224 /* keep the NSVC we need for SNS, but unconfigure it */
2225 nsvc->sig_weight = 0;
2226 nsvc->data_weight = 0;
2227 ns2_vc_force_unconfigured(nsvc);
2228 } else {
2229 /* free all other NS-VCs */
2230 gprs_ns2_free_nsvc(nsvc);
2231 }
2232 }
Harald Welte2d807b62021-03-24 01:57:30 +01002233 ns2_sns_compute_local_ep_from_binds(fi);
Harald Welte4f127462021-03-02 20:49:10 +01002234 }
2235 /* send SIZE_ACK */
2236 ns2_tx_sns_size_ack(gss->sns_nsvc, NULL);
2237 /* only wait for SNS-CONFIG in case of Reset flag */
2238 if (flag & 1)
2239 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_SGSN_WAIT_CONFIG, 0, 0);
2240 break;
2241 default:
2242 ns2_sns_st_all_action(fi, event, data);
2243 break;
2244 }
2245}
2246
2247static struct osmo_fsm gprs_ns2_sns_sgsn_fsm = {
2248 .name = "GPRS-NS2-SNS-SGSN",
2249 .states = ns2_sns_sgsn_states,
2250 .num_states = ARRAY_SIZE(ns2_sns_sgsn_states),
2251 .allstate_event_mask = S(GPRS_SNS_EV_RX_SIZE) |
2252 S(GPRS_SNS_EV_REQ_NO_NSVC) |
2253 S(GPRS_SNS_EV_REQ_ADD_BIND) |
2254 S(GPRS_SNS_EV_REQ_DELETE_BIND),
2255 .allstate_action = ns2_sns_st_all_action_sgsn,
2256 .cleanup = NULL,
2257 .timer_cb = ns2_sns_fsm_sgsn_timer_cb,
2258 .event_names = gprs_sns_event_names,
2259 .pre_term = NULL,
2260 .log_subsys = DLNS,
2261};
2262
2263/*! Allocate an IP-SNS FSM for the SGSN side.
2264 * \param[in] nse NS Entity in which the FSM runs
2265 * \param[in] id string identifier
2266 * \returns FSM instance on success; NULL on error */
2267struct osmo_fsm_inst *ns2_sns_sgsn_fsm_alloc(struct gprs_ns2_nse *nse, const char *id)
2268{
2269 struct osmo_fsm_inst *fi;
2270 struct ns2_sns_state *gss;
2271
2272 fi = osmo_fsm_inst_alloc(&gprs_ns2_sns_sgsn_fsm, nse, NULL, LOGL_DEBUG, id);
2273 if (!fi)
2274 return fi;
2275
2276 gss = talloc_zero(fi, struct ns2_sns_state);
2277 if (!gss)
2278 goto err;
2279
2280 fi->priv = gss;
2281 gss->nse = nse;
2282 gss->role = GPRS_SNS_ROLE_SGSN;
2283 INIT_LLIST_HEAD(&gss->sns_endpoints);
2284 INIT_LLIST_HEAD(&gss->binds);
2285
2286 return fi;
2287err:
2288 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
2289 return NULL;
2290}
2291
2292
2293
2294
Alexander Couzens6a161492020-07-12 13:45:50 +02002295/* initialize osmo_ctx on main tread */
2296static __attribute__((constructor)) void on_dso_load_ctx(void)
2297{
2298 OSMO_ASSERT(osmo_fsm_register(&gprs_ns2_sns_bss_fsm) == 0);
Harald Welte4f127462021-03-02 20:49:10 +01002299 OSMO_ASSERT(osmo_fsm_register(&gprs_ns2_sns_sgsn_fsm) == 0);
Alexander Couzens6a161492020-07-12 13:45:50 +02002300}