blob: e96f6b3f238499d0800594e452f8ad430453cb8f [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
Harald Welte4f127462021-03-02 20:49:10 +010059enum ns2_sns_role {
60 GPRS_SNS_ROLE_BSS,
61 GPRS_SNS_ROLE_SGSN,
62};
63
Harald Welte694dad52021-03-23 15:22:16 +010064/* BSS-side-only states _ST_BSS_; SGSN-side only states _ST_SGSN_; others shared */
Alexander Couzens6a161492020-07-12 13:45:50 +020065enum gprs_sns_bss_state {
66 GPRS_SNS_ST_UNCONFIGURED,
Harald Welte694dad52021-03-23 15:22:16 +010067 GPRS_SNS_ST_BSS_SIZE, /*!< SNS-SIZE procedure ongoing */
68 GPRS_SNS_ST_BSS_CONFIG_BSS, /*!< SNS-CONFIG procedure (BSS->SGSN) ongoing */
69 GPRS_SNS_ST_BSS_CONFIG_SGSN, /*!< SNS-CONFIG procedure (SGSN->BSS) ongoing */
Alexander Couzens6a161492020-07-12 13:45:50 +020070 GPRS_SNS_ST_CONFIGURED,
Harald Welte4f127462021-03-02 20:49:10 +010071 GPRS_SNS_ST_SGSN_WAIT_CONFIG, /* !< SGSN role: Wait for CONFIG from BSS */
72 GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK, /* !< SGSN role: Wait for CONFIG-ACK from BSS */
Alexander Couzens6a161492020-07-12 13:45:50 +020073};
74
Alexander Couzens6a161492020-07-12 13:45:50 +020075static const struct value_string gprs_sns_event_names[] = {
Alexander Couzens175eb7b2021-07-20 18:41:14 +020076 { NS2_SNS_EV_REQ_SELECT_ENDPOINT, "REQ_SELECT_ENDPOINT" },
77 { NS2_SNS_EV_RX_SIZE, "RX_SIZE" },
78 { NS2_SNS_EV_RX_SIZE_ACK, "RX_SIZE_ACK" },
79 { NS2_SNS_EV_RX_CONFIG, "RX_CONFIG" },
80 { NS2_SNS_EV_RX_CONFIG_END, "RX_CONFIG_END" },
81 { NS2_SNS_EV_RX_CONFIG_ACK, "RX_CONFIG_ACK" },
82 { NS2_SNS_EV_RX_ADD, "RX_ADD" },
83 { NS2_SNS_EV_RX_DELETE, "RX_DELETE" },
84 { NS2_SNS_EV_RX_ACK, "RX_ACK" },
85 { NS2_SNS_EV_RX_CHANGE_WEIGHT, "RX_CHANGE_WEIGHT" },
86 { NS2_SNS_EV_REQ_NO_NSVC, "REQ_NO_NSVC" },
Alexander Couzens83f06ce2021-08-06 19:50:09 +020087 { NS2_SNS_EV_REQ_FREE_NSVCS, "REQ_FREE_NSVCS" },
Alexander Couzens175eb7b2021-07-20 18:41:14 +020088 { NS2_SNS_EV_REQ_NSVC_ALIVE, "REQ_NSVC_ALIVE"},
89 { NS2_SNS_EV_REQ_ADD_BIND, "REQ_ADD_BIND"},
90 { NS2_SNS_EV_REQ_DELETE_BIND, "REQ_DELETE_BIND"},
Alexander Couzens6a161492020-07-12 13:45:50 +020091 { 0, NULL }
92};
93
Alexander Couzense769f522020-12-07 07:37:07 +010094struct sns_endpoint {
95 struct llist_head list;
96 struct osmo_sockaddr saddr;
97};
98
Alexander Couzens6b9d2322021-02-12 03:17:59 +010099struct ns2_sns_bind {
100 struct llist_head list;
101 struct gprs_ns2_vc_bind *bind;
102};
103
Alexander Couzens71128672021-06-05 18:44:01 +0200104struct ns2_sns_elems {
105 struct gprs_ns_ie_ip4_elem *ip4;
106 unsigned int num_ip4;
107 struct gprs_ns_ie_ip6_elem *ip6;
108 unsigned int num_ip6;
109};
110
Alexander Couzens6a161492020-07-12 13:45:50 +0200111struct ns2_sns_state {
112 struct gprs_ns2_nse *nse;
113
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200114 /* containing the address family AF_* */
115 int family;
Harald Welte4f127462021-03-02 20:49:10 +0100116 enum ns2_sns_role role; /* local role: BSS or SGSN */
Alexander Couzens6a161492020-07-12 13:45:50 +0200117
Alexander Couzense769f522020-12-07 07:37:07 +0100118 /* holds the list of initial SNS endpoints */
119 struct llist_head sns_endpoints;
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100120 /* list of used struct ns2_sns_bind */
121 struct llist_head binds;
122 /* pointer to the bind which was used to initiate the SNS connection */
123 struct ns2_sns_bind *initial_bind;
Alexander Couzense769f522020-12-07 07:37:07 +0100124 /* prevent recursive reselection */
125 bool reselection_running;
126
127 /* The current initial SNS endpoints.
128 * The initial connection will be moved into the NSE
129 * if configured via SNS. Otherwise it will be removed
130 * in configured state. */
131 struct sns_endpoint *initial;
Alexander Couzens6a161492020-07-12 13:45:50 +0200132 /* all SNS PDU will be sent over this nsvc */
133 struct gprs_ns2_vc *sns_nsvc;
Alexander Couzens90ee9632020-12-07 06:18:32 +0100134 /* timer N */
135 int N;
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100136 /* true if at least one nsvc is alive */
137 bool alive;
Alexander Couzens6a161492020-07-12 13:45:50 +0200138
139 /* local configuration to send to the remote end */
Alexander Couzens71128672021-06-05 18:44:01 +0200140 struct ns2_sns_elems local;
Alexander Couzens6a161492020-07-12 13:45:50 +0200141
Alexander Couzens71128672021-06-05 18:44:01 +0200142 /* remote configuration as received */
143 struct ns2_sns_elems remote;
Alexander Couzens6a161492020-07-12 13:45:50 +0200144
145 /* local configuration about our capabilities in terms of connections to
146 * remote (SGSN) side */
147 size_t num_max_nsvcs;
148 size_t num_max_ip4_remote;
149 size_t num_max_ip6_remote;
Alexander Couzens6a161492020-07-12 13:45:50 +0200150};
151
152static inline struct gprs_ns2_nse *nse_inst_from_fi(struct osmo_fsm_inst *fi)
153{
154 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
155 return gss->nse;
156}
157
Alexander Couzens652ab4d2021-06-12 23:09:46 +0200158/* The SNS has failed. Etither restart the SNS (BSS) or remove the SNS (SGSN) */
159#define sns_failed(fi, reason) \
160 _sns_failed(fi, reason, __FILE__, __LINE__)
161static void _sns_failed(struct osmo_fsm_inst *fi, const char *reason, const char *file, int line)
162{
163 struct ns2_sns_state *gss = fi->priv;
164
165 if (reason)
166 LOGPFSML(fi, LOGL_ERROR, "NSE %d: SNS failed: %s\n", gss->nse->nsei, reason);
167
168 if (gss->role == GPRS_SNS_ROLE_SGSN) {
169 if (!gss->nse->persistent)
170 gprs_ns2_free_nse(gss->nse);
171 else
172 _osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0, file, line);
173 } else {
Alexander Couzens175eb7b2021-07-20 18:41:14 +0200174 _osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_REQ_SELECT_ENDPOINT, NULL, file, line);
Alexander Couzens652ab4d2021-06-12 23:09:46 +0200175 }
176}
177
Alexander Couzens6a161492020-07-12 13:45:50 +0200178/* helper function to compute the sum of all (data or signaling) weights */
Alexander Couzens62310552021-06-06 02:43:14 +0200179static int ip4_weight_sum(const struct ns2_sns_elems *elems, bool data_weight)
Alexander Couzens6a161492020-07-12 13:45:50 +0200180{
181 unsigned int i;
182 int weight_sum = 0;
183
Alexander Couzens62310552021-06-06 02:43:14 +0200184 for (i = 0; i < elems->num_ip4; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200185 if (data_weight)
Alexander Couzens62310552021-06-06 02:43:14 +0200186 weight_sum += elems->ip4[i].data_weight;
Alexander Couzens6a161492020-07-12 13:45:50 +0200187 else
Alexander Couzens62310552021-06-06 02:43:14 +0200188 weight_sum += elems->ip4[i].sig_weight;
Alexander Couzens6a161492020-07-12 13:45:50 +0200189 }
190 return weight_sum;
191}
Alexander Couzens62310552021-06-06 02:43:14 +0200192#define ip4_weight_sum_data(elems) ip4_weight_sum(elems, true)
193#define ip4_weight_sum_sig(elems) ip4_weight_sum(elems, false)
Alexander Couzens6a161492020-07-12 13:45:50 +0200194
195/* helper function to compute the sum of all (data or signaling) weights */
Alexander Couzens62310552021-06-06 02:43:14 +0200196static int ip6_weight_sum(const struct ns2_sns_elems *elems, bool data_weight)
Alexander Couzens6a161492020-07-12 13:45:50 +0200197{
198 unsigned int i;
199 int weight_sum = 0;
200
Alexander Couzens62310552021-06-06 02:43:14 +0200201 for (i = 0; i < elems->num_ip6; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200202 if (data_weight)
Alexander Couzens62310552021-06-06 02:43:14 +0200203 weight_sum += elems->ip6[i].data_weight;
Alexander Couzens6a161492020-07-12 13:45:50 +0200204 else
Alexander Couzens62310552021-06-06 02:43:14 +0200205 weight_sum += elems->ip6[i].sig_weight;
Alexander Couzens6a161492020-07-12 13:45:50 +0200206 }
207 return weight_sum;
208}
Alexander Couzens62310552021-06-06 02:43:14 +0200209#define ip6_weight_sum_data(elems) ip6_weight_sum(elems, true)
210#define ip6_weight_sum_sig(elems) ip6_weight_sum(elems, false)
Alexander Couzens6a161492020-07-12 13:45:50 +0200211
Alexander Couzens019da4b2021-06-06 02:48:18 +0200212static int ip46_weight_sum(const struct ns2_sns_elems *elems, bool data_weight)
Harald Weltec1c7e4a2021-03-02 20:47:29 +0100213{
Alexander Couzens019da4b2021-06-06 02:48:18 +0200214 return ip4_weight_sum(elems, data_weight) +
215 ip6_weight_sum(elems, data_weight);
Harald Weltec1c7e4a2021-03-02 20:47:29 +0100216}
Alexander Couzens019da4b2021-06-06 02:48:18 +0200217#define ip46_weight_sum_data(elems) ip46_weight_sum(elems, true)
218#define ip46_weight_sum_sig(elems) ip46_weight_sum(elems, false)
Harald Weltec1c7e4a2021-03-02 20:47:29 +0100219
Alexander Couzens6a161492020-07-12 13:45:50 +0200220static struct gprs_ns2_vc *nsvc_by_ip4_elem(struct gprs_ns2_nse *nse,
221 const struct gprs_ns_ie_ip4_elem *ip4)
222{
223 struct osmo_sockaddr sa;
224 /* copy over. Both data structures use network byte order */
225 sa.u.sin.sin_addr.s_addr = ip4->ip_addr;
226 sa.u.sin.sin_port = ip4->udp_port;
227 sa.u.sin.sin_family = AF_INET;
228
Alexander Couzens38b19e82020-09-23 23:56:37 +0200229 return gprs_ns2_nsvc_by_sockaddr_nse(nse, &sa);
Alexander Couzens6a161492020-07-12 13:45:50 +0200230}
231
232static struct gprs_ns2_vc *nsvc_by_ip6_elem(struct gprs_ns2_nse *nse,
233 const struct gprs_ns_ie_ip6_elem *ip6)
234{
235 struct osmo_sockaddr sa;
236 /* copy over. Both data structures use network byte order */
237 sa.u.sin6.sin6_addr = ip6->ip_addr;
238 sa.u.sin6.sin6_port = ip6->udp_port;
239 sa.u.sin6.sin6_family = AF_INET;
240
Alexander Couzens38b19e82020-09-23 23:56:37 +0200241 return gprs_ns2_nsvc_by_sockaddr_nse(nse, &sa);
Alexander Couzens6a161492020-07-12 13:45:50 +0200242}
243
Alexander Couzens125298f2020-10-11 21:22:42 +0200244/*! Return the initial SNS remote socket address
245 * \param nse NS Entity
246 * \return address of the initial SNS connection; NULL in case of error
247 */
248const struct osmo_sockaddr *gprs_ns2_nse_sns_remote(struct gprs_ns2_nse *nse)
249{
250 struct ns2_sns_state *gss;
251
252 if (!nse->bss_sns_fi)
253 return NULL;
254
255 gss = (struct ns2_sns_state *) nse->bss_sns_fi->priv;
Alexander Couzense769f522020-12-07 07:37:07 +0100256 return &gss->initial->saddr;
Alexander Couzens125298f2020-10-11 21:22:42 +0200257}
258
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100259/*! called when a nsvc is beeing freed or the nsvc became dead */
260void ns2_sns_replace_nsvc(struct gprs_ns2_vc *nsvc)
Alexander Couzens6a161492020-07-12 13:45:50 +0200261{
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100262 struct gprs_ns2_nse *nse = nsvc->nse;
Alexander Couzens6a161492020-07-12 13:45:50 +0200263 struct gprs_ns2_vc *tmp;
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100264 struct osmo_fsm_inst *fi = nse->bss_sns_fi;
Alexander Couzens6a161492020-07-12 13:45:50 +0200265 struct ns2_sns_state *gss;
Alexander Couzens6a161492020-07-12 13:45:50 +0200266
267 if (!fi)
268 return;
269
270 gss = (struct ns2_sns_state *) fi->priv;
271 if (nsvc != gss->sns_nsvc)
272 return;
273
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100274 gss->sns_nsvc = NULL;
275 if (gss->alive) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200276 llist_for_each_entry(tmp, &nse->nsvc, list) {
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100277 if (ns2_vc_is_unblocked(tmp)) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200278 gss->sns_nsvc = tmp;
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100279 return;
280 }
Alexander Couzens6a161492020-07-12 13:45:50 +0200281 }
282 } else {
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100283 /* the SNS is waiting for its first NS-VC to come up
284 * choose any other nsvc */
285 llist_for_each_entry(tmp, &nse->nsvc, list) {
286 if (nsvc != tmp) {
287 gss->sns_nsvc = tmp;
288 return;
289 }
290 }
Alexander Couzens6a161492020-07-12 13:45:50 +0200291 }
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100292
Alexander Couzens175eb7b2021-07-20 18:41:14 +0200293 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_REQ_NO_NSVC, NULL);
Alexander Couzens6a161492020-07-12 13:45:50 +0200294}
295
Alexander Couzensd2c6c492021-06-06 01:57:52 +0200296static void ns2_clear_elems(struct ns2_sns_elems *elems)
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100297{
Alexander Couzensd2c6c492021-06-06 01:57:52 +0200298 TALLOC_FREE(elems->ip4);
299 TALLOC_FREE(elems->ip6);
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100300
Alexander Couzensd2c6c492021-06-06 01:57:52 +0200301 elems->num_ip4 = 0;
302 elems->num_ip6 = 0;
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100303}
304
Daniel Willmanncf8371a2021-01-16 15:13:51 +0100305static void ns2_vc_create_ip(struct osmo_fsm_inst *fi, struct gprs_ns2_nse *nse, const struct osmo_sockaddr *remote,
306 uint8_t sig_weight, uint8_t data_weight)
Alexander Couzens6a161492020-07-12 13:45:50 +0200307{
308 struct gprs_ns2_inst *nsi = nse->nsi;
309 struct gprs_ns2_vc *nsvc;
310 struct gprs_ns2_vc_bind *bind;
Daniel Willmanncf8371a2021-01-16 15:13:51 +0100311
312 /* for every bind, create a connection if bind type == IP */
313 llist_for_each_entry(bind, &nsi->binding, list) {
314 if (bind->ll != GPRS_NS2_LL_UDP)
315 continue;
316 /* ignore failed connection */
317 nsvc = gprs_ns2_ip_connect_inactive(bind,
318 remote,
319 nse, 0);
320 if (!nsvc) {
321 LOGPFSML(fi, LOGL_ERROR, "SNS-CONFIG: Failed to create NSVC\n");
322 continue;
323 }
324
325 nsvc->sig_weight = sig_weight;
326 nsvc->data_weight = data_weight;
327 }
328}
329
330static void ns2_nsvc_create_ip4(struct osmo_fsm_inst *fi,
331 struct gprs_ns2_nse *nse,
332 const struct gprs_ns_ie_ip4_elem *ip4)
333{
Alexander Couzensc068d862020-10-12 04:11:51 +0200334 struct osmo_sockaddr remote = { };
Alexander Couzens6a161492020-07-12 13:45:50 +0200335 /* copy over. Both data structures use network byte order */
336 remote.u.sin.sin_family = AF_INET;
337 remote.u.sin.sin_addr.s_addr = ip4->ip_addr;
338 remote.u.sin.sin_port = ip4->udp_port;
339
Daniel Willmanncf8371a2021-01-16 15:13:51 +0100340 ns2_vc_create_ip(fi, nse, &remote, ip4->sig_weight, ip4->data_weight);
Alexander Couzens6a161492020-07-12 13:45:50 +0200341}
342
343static void ns2_nsvc_create_ip6(struct osmo_fsm_inst *fi,
344 struct gprs_ns2_nse *nse,
345 const struct gprs_ns_ie_ip6_elem *ip6)
346{
Alexander Couzens6a161492020-07-12 13:45:50 +0200347 struct osmo_sockaddr remote = {};
348 /* copy over. Both data structures use network byte order */
349 remote.u.sin6.sin6_family = AF_INET6;
350 remote.u.sin6.sin6_addr = ip6->ip_addr;
351 remote.u.sin6.sin6_port = ip6->udp_port;
352
Daniel Willmanncf8371a2021-01-16 15:13:51 +0100353 ns2_vc_create_ip(fi, nse, &remote, ip6->sig_weight, ip6->data_weight);
Alexander Couzens6a161492020-07-12 13:45:50 +0200354}
355
Harald Weltee8c61062021-03-24 13:16:27 +0100356static struct gprs_ns2_vc *nsvc_for_bind_and_remote(struct gprs_ns2_nse *nse,
357 struct gprs_ns2_vc_bind *bind,
358 const struct osmo_sockaddr *remote)
359{
360 struct gprs_ns2_vc *nsvc;
361
362 llist_for_each_entry(nsvc, &nse->nsvc, list) {
363 if (nsvc->bind != bind)
364 continue;
365
366 if (!osmo_sockaddr_cmp(remote, gprs_ns2_ip_vc_remote(nsvc)))
367 return nsvc;
368 }
369 return NULL;
370}
Alexander Couzens6a161492020-07-12 13:45:50 +0200371
372static int create_missing_nsvcs(struct osmo_fsm_inst *fi)
373{
374 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
375 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
376 struct gprs_ns2_vc *nsvc;
Harald Welte3053bbb2021-03-24 13:22:18 +0100377 struct ns2_sns_bind *sbind;
Alexander Couzens6a161492020-07-12 13:45:50 +0200378 struct osmo_sockaddr remote = { };
379 unsigned int i;
380
Harald Weltee8c61062021-03-24 13:16:27 +0100381 /* iterate over all remote IPv4 endpoints */
Alexander Couzens71128672021-06-05 18:44:01 +0200382 for (i = 0; i < gss->remote.num_ip4; i++) {
383 const struct gprs_ns_ie_ip4_elem *ip4 = &gss->remote.ip4[i];
Alexander Couzens6a161492020-07-12 13:45:50 +0200384
385 remote.u.sin.sin_family = AF_INET;
386 remote.u.sin.sin_addr.s_addr = ip4->ip_addr;
387 remote.u.sin.sin_port = ip4->udp_port;
388
Harald Welte3053bbb2021-03-24 13:22:18 +0100389 /* iterate over all local binds within this SNS */
390 llist_for_each_entry(sbind, &gss->binds, list) {
391 struct gprs_ns2_vc_bind *bind = sbind->bind;
392
Harald Weltee8c61062021-03-24 13:16:27 +0100393 /* we only care about UDP binds */
Daniel Willmann967e2c12021-01-14 16:58:17 +0100394 if (bind->ll != GPRS_NS2_LL_UDP)
395 continue;
Alexander Couzens6a161492020-07-12 13:45:50 +0200396
Harald Weltee8c61062021-03-24 13:16:27 +0100397 nsvc = nsvc_for_bind_and_remote(nse, bind, &remote);
398 if (!nsvc) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200399 nsvc = gprs_ns2_ip_connect_inactive(bind, &remote, nse, 0);
400 if (!nsvc) {
401 /* TODO: add to a list to send back a NS-STATUS */
402 continue;
403 }
404 }
405
406 /* update data / signalling weight */
407 nsvc->data_weight = ip4->data_weight;
408 nsvc->sig_weight = ip4->sig_weight;
409 nsvc->sns_only = false;
410 }
411 }
412
Harald Weltee8c61062021-03-24 13:16:27 +0100413 /* iterate over all remote IPv4 endpoints */
Alexander Couzens71128672021-06-05 18:44:01 +0200414 for (i = 0; i < gss->remote.num_ip6; i++) {
415 const struct gprs_ns_ie_ip6_elem *ip6 = &gss->remote.ip6[i];
Alexander Couzens6a161492020-07-12 13:45:50 +0200416
417 remote.u.sin6.sin6_family = AF_INET6;
418 remote.u.sin6.sin6_addr = ip6->ip_addr;
419 remote.u.sin6.sin6_port = ip6->udp_port;
420
Harald Welte3053bbb2021-03-24 13:22:18 +0100421 /* iterate over all local binds within this SNS */
422 llist_for_each_entry(sbind, &gss->binds, list) {
423 struct gprs_ns2_vc_bind *bind = sbind->bind;
424
Daniel Willmann967e2c12021-01-14 16:58:17 +0100425 if (bind->ll != GPRS_NS2_LL_UDP)
426 continue;
Alexander Couzens6a161492020-07-12 13:45:50 +0200427
Harald Weltee8c61062021-03-24 13:16:27 +0100428 /* we only care about UDP binds */
429 nsvc = nsvc_for_bind_and_remote(nse, bind, &remote);
430 if (!nsvc) {
Alexander Couzens6a161492020-07-12 13:45:50 +0200431 nsvc = gprs_ns2_ip_connect_inactive(bind, &remote, nse, 0);
432 if (!nsvc) {
433 /* TODO: add to a list to send back a NS-STATUS */
434 continue;
435 }
436 }
437
438 /* update data / signalling weight */
439 nsvc->data_weight = ip6->data_weight;
440 nsvc->sig_weight = ip6->sig_weight;
441 nsvc->sns_only = false;
442 }
443 }
444
445
446 return 0;
447}
448
449/* Add a given remote IPv4 element to gprs_sns_state */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200450static int add_ip4_elem(struct ns2_sns_state *gss, struct ns2_sns_elems *elems,
451 const struct gprs_ns_ie_ip4_elem *ip4)
Alexander Couzens6a161492020-07-12 13:45:50 +0200452{
Alexander Couzens6a161492020-07-12 13:45:50 +0200453 /* check for duplicates */
Alexander Couzenscc56ddc2021-06-06 03:33:35 +0200454 for (unsigned int i = 0; i < elems->num_ip4; i++) {
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200455 if (memcmp(&elems->ip4[i], ip4, sizeof(*ip4)))
Alexander Couzens6a161492020-07-12 13:45:50 +0200456 continue;
Alexander Couzensd3507e82021-06-06 03:32:32 +0200457 return -1;
Alexander Couzens6a161492020-07-12 13:45:50 +0200458 }
459
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200460 elems->ip4 = talloc_realloc(gss, elems->ip4, struct gprs_ns_ie_ip4_elem,
461 elems->num_ip4+1);
462 elems->ip4[elems->num_ip4] = *ip4;
463 elems->num_ip4 += 1;
Alexander Couzens6a161492020-07-12 13:45:50 +0200464 return 0;
465}
466
467/* Remove a given remote IPv4 element from gprs_sns_state */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200468static int remove_ip4_elem(struct ns2_sns_state *gss, struct ns2_sns_elems *elems,
469 const struct gprs_ns_ie_ip4_elem *ip4)
Alexander Couzens6a161492020-07-12 13:45:50 +0200470{
471 unsigned int i;
472
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200473 for (i = 0; i < elems->num_ip4; i++) {
474 if (memcmp(&elems->ip4[i], ip4, sizeof(*ip4)))
Alexander Couzens6a161492020-07-12 13:45:50 +0200475 continue;
476 /* all array elements < i remain as they are; all > i are shifted left by one */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200477 memmove(&elems->ip4[i], &elems->ip4[i+1], elems->num_ip4-i-1);
478 elems->num_ip4 -= 1;
Alexander Couzens6a161492020-07-12 13:45:50 +0200479 return 0;
480 }
481 return -1;
482}
483
484/* update the weights for specified remote IPv4 */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200485static int update_ip4_elem(struct ns2_sns_state *gss, struct ns2_sns_elems *elems,
486 const struct gprs_ns_ie_ip4_elem *ip4)
Alexander Couzens6a161492020-07-12 13:45:50 +0200487{
488 unsigned int i;
489
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200490 for (i = 0; i < elems->num_ip4; i++) {
491 if (elems->ip4[i].ip_addr != ip4->ip_addr ||
492 elems->ip4[i].udp_port != ip4->udp_port)
Alexander Couzens6a161492020-07-12 13:45:50 +0200493 continue;
494
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200495 elems->ip4[i].sig_weight = ip4->sig_weight;
496 elems->ip4[i].data_weight = ip4->data_weight;
Alexander Couzens6a161492020-07-12 13:45:50 +0200497 return 0;
498 }
499 return -1;
500}
501
502/* Add a given remote IPv6 element to gprs_sns_state */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200503static int add_ip6_elem(struct ns2_sns_state *gss, struct ns2_sns_elems *elems,
504 const struct gprs_ns_ie_ip6_elem *ip6)
Alexander Couzens6a161492020-07-12 13:45:50 +0200505{
Alexander Couzenscc56ddc2021-06-06 03:33:35 +0200506 /* check for duplicates */
507 for (unsigned int i = 0; i < elems->num_ip6; i++) {
508 if (memcmp(&elems->ip6[i].ip_addr, &ip6->ip_addr, sizeof(ip6->ip_addr)) ||
509 elems->ip6[i].udp_port != ip6->udp_port)
510 continue;
511 return -1;
512 }
Alexander Couzens6a161492020-07-12 13:45:50 +0200513
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200514 elems->ip6 = talloc_realloc(gss, elems->ip6, struct gprs_ns_ie_ip6_elem,
515 elems->num_ip6+1);
516 elems->ip6[elems->num_ip6] = *ip6;
517 elems->num_ip6 += 1;
Alexander Couzens6a161492020-07-12 13:45:50 +0200518 return 0;
519}
520
521/* Remove a given remote IPv6 element from gprs_sns_state */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200522static int remove_ip6_elem(struct ns2_sns_state *gss, struct ns2_sns_elems *elems,
523 const struct gprs_ns_ie_ip6_elem *ip6)
Alexander Couzens6a161492020-07-12 13:45:50 +0200524{
525 unsigned int i;
526
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200527 for (i = 0; i < elems->num_ip6; i++) {
528 if (memcmp(&elems->ip6[i], ip6, sizeof(*ip6)))
Alexander Couzens6a161492020-07-12 13:45:50 +0200529 continue;
530 /* all array elements < i remain as they are; all > i are shifted left by one */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200531 memmove(&elems->ip6[i], &elems->ip6[i+1], elems->num_ip6-i-1);
532 elems->num_ip6 -= 1;
Alexander Couzens6a161492020-07-12 13:45:50 +0200533 return 0;
534 }
535 return -1;
536}
537
538/* update the weights for specified remote IPv6 */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200539static int update_ip6_elem(struct ns2_sns_state *gss, struct ns2_sns_elems *elems,
540 const struct gprs_ns_ie_ip6_elem *ip6)
Alexander Couzens6a161492020-07-12 13:45:50 +0200541{
542 unsigned int i;
543
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200544 for (i = 0; i < elems->num_ip6; i++) {
545 if (memcmp(&elems->ip6[i].ip_addr, &ip6->ip_addr, sizeof(ip6->ip_addr)) ||
546 elems->ip6[i].udp_port != ip6->udp_port)
Alexander Couzens6a161492020-07-12 13:45:50 +0200547 continue;
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200548 elems->ip6[i].sig_weight = ip6->sig_weight;
549 elems->ip6[i].data_weight = ip6->data_weight;
Alexander Couzens6a161492020-07-12 13:45:50 +0200550 return 0;
551 }
552 return -1;
553}
554
555static 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)
556{
557 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
558 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
559 struct gprs_ns2_vc *nsvc;
560 struct osmo_sockaddr sa = {};
Alexander Couzens9a4cf272020-10-11 20:48:04 +0200561 const struct osmo_sockaddr *remote;
Alexander Couzens6a161492020-07-12 13:45:50 +0200562 uint8_t new_signal;
563 uint8_t new_data;
564
565 /* TODO: Upon receiving an SNS-CHANGEWEIGHT PDU, if the resulting sum of the
566 * signalling weights of all the peer IP endpoints configured for this NSE is
567 * equal to zero or if the resulting sum of the data weights of all the peer IP
568 * endpoints configured for this NSE is equal to zero, the BSS/SGSN shall send an
569 * SNS-ACK PDU with a cause code of "Invalid weights". */
570
571 if (ip4) {
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200572 if (update_ip4_elem(gss, &gss->remote, ip4))
Alexander Couzens6a161492020-07-12 13:45:50 +0200573 return -NS_CAUSE_UNKN_IP_EP;
574
575 /* copy over. Both data structures use network byte order */
576 sa.u.sin.sin_addr.s_addr = ip4->ip_addr;
577 sa.u.sin.sin_port = ip4->udp_port;
578 sa.u.sin.sin_family = AF_INET;
579 new_signal = ip4->sig_weight;
580 new_data = ip4->data_weight;
581 } else if (ip6) {
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200582 if (update_ip6_elem(gss, &gss->remote, ip6))
Alexander Couzens6a161492020-07-12 13:45:50 +0200583 return -NS_CAUSE_UNKN_IP_EP;
584
585 /* copy over. Both data structures use network byte order */
586 sa.u.sin6.sin6_addr = ip6->ip_addr;
587 sa.u.sin6.sin6_port = ip6->udp_port;
588 sa.u.sin6.sin6_family = AF_INET6;
589 new_signal = ip6->sig_weight;
590 new_data = ip6->data_weight;
591 } else {
592 OSMO_ASSERT(false);
593 }
594
595 llist_for_each_entry(nsvc, &nse->nsvc, list) {
Alexander Couzensc4229a42020-10-11 20:58:04 +0200596 remote = gprs_ns2_ip_vc_remote(nsvc);
Alexander Couzens6a161492020-07-12 13:45:50 +0200597 /* all nsvc in NSE should be IP/UDP nsvc */
598 OSMO_ASSERT(remote);
599
600 if (osmo_sockaddr_cmp(&sa, remote))
601 continue;
602
603 LOGPFSML(fi, LOGL_INFO, "CHANGE-WEIGHT NS-VC %s data_weight %u->%u, sig_weight %u->%u\n",
604 gprs_ns2_ll_str(nsvc), nsvc->data_weight, new_data,
605 nsvc->sig_weight, new_signal);
606
607 nsvc->data_weight = new_data;
608 nsvc->sig_weight = new_signal;
609 }
610
611 return 0;
612}
613
614static int do_sns_delete(struct osmo_fsm_inst *fi,
615 const struct gprs_ns_ie_ip4_elem *ip4,
616 const struct gprs_ns_ie_ip6_elem *ip6)
617{
618 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
619 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
620 struct gprs_ns2_vc *nsvc, *tmp;
Alexander Couzens9a4cf272020-10-11 20:48:04 +0200621 const struct osmo_sockaddr *remote;
Alexander Couzens6a161492020-07-12 13:45:50 +0200622 struct osmo_sockaddr sa = {};
623
624 if (ip4) {
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200625 if (remove_ip4_elem(gss, &gss->remote, ip4) < 0)
Alexander Couzens6a161492020-07-12 13:45:50 +0200626 return -NS_CAUSE_UNKN_IP_EP;
627 /* copy over. Both data structures use network byte order */
628 sa.u.sin.sin_addr.s_addr = ip4->ip_addr;
629 sa.u.sin.sin_port = ip4->udp_port;
630 sa.u.sin.sin_family = AF_INET;
631 } else if (ip6) {
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200632 if (remove_ip6_elem(gss, &gss->remote, ip6))
Alexander Couzens6a161492020-07-12 13:45:50 +0200633 return -NS_CAUSE_UNKN_IP_EP;
634
635 /* copy over. Both data structures use network byte order */
636 sa.u.sin6.sin6_addr = ip6->ip_addr;
637 sa.u.sin6.sin6_port = ip6->udp_port;
638 sa.u.sin6.sin6_family = AF_INET6;
639 } else {
640 OSMO_ASSERT(false);
641 }
642
643 llist_for_each_entry_safe(nsvc, tmp, &nse->nsvc, list) {
Alexander Couzensc4229a42020-10-11 20:58:04 +0200644 remote = gprs_ns2_ip_vc_remote(nsvc);
Alexander Couzens6a161492020-07-12 13:45:50 +0200645 /* all nsvc in NSE should be IP/UDP nsvc */
646 OSMO_ASSERT(remote);
647 if (osmo_sockaddr_cmp(&sa, remote))
648 continue;
649
650 LOGPFSML(fi, LOGL_INFO, "DELETE NS-VC %s\n", gprs_ns2_ll_str(nsvc));
651 gprs_ns2_free_nsvc(nsvc);
652 }
653
654 return 0;
655}
656
657static int do_sns_add(struct osmo_fsm_inst *fi,
658 const struct gprs_ns_ie_ip4_elem *ip4,
659 const struct gprs_ns_ie_ip6_elem *ip6)
660{
661 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
662 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
663 struct gprs_ns2_vc *nsvc;
664 int rc = 0;
665
666 /* Upon receiving an SNS-ADD PDU, if the consequent number of IPv4 endpoints
667 * exceeds the number of IPv4 endpoints supported by the NSE, the NSE shall send
668 * an SNS-ACK PDU with a cause code set to "Invalid number of IP4 Endpoints". */
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200669 switch (gss->family) {
670 case AF_INET:
Alexander Couzensd3507e82021-06-06 03:32:32 +0200671 if (gss->remote.num_ip4 >= gss->num_max_ip4_remote)
672 return -NS_CAUSE_INVAL_NR_NS_VC;
673 /* TODO: log message duplicate */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200674 rc = add_ip4_elem(gss, &gss->remote, ip4);
Alexander Couzens6a161492020-07-12 13:45:50 +0200675 break;
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200676 case AF_INET6:
Alexander Couzensd3507e82021-06-06 03:32:32 +0200677 if (gss->remote.num_ip6 >= gss->num_max_ip6_remote)
678 return -NS_CAUSE_INVAL_NR_NS_VC;
679 /* TODO: log message duplicate */
Alexander Couzensc2ba25e2021-06-06 02:26:40 +0200680 rc = add_ip6_elem(gss, &gss->remote, ip6);
Alexander Couzens6a161492020-07-12 13:45:50 +0200681 break;
682 default:
683 /* the gss->ip is initialized with the bss */
684 OSMO_ASSERT(false);
685 }
686
687 if (rc)
Alexander Couzensd3507e82021-06-06 03:32:32 +0200688 return -NS_CAUSE_PROTO_ERR_UNSPEC;
Alexander Couzens6a161492020-07-12 13:45:50 +0200689
690 /* Upon receiving an SNS-ADD PDU containing an already configured IP endpoint the
691 * NSE shall send an SNS-ACK PDU with the cause code "Protocol error -
692 * unspecified" */
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200693 switch (gss->family) {
694 case AF_INET:
Alexander Couzens6a161492020-07-12 13:45:50 +0200695 nsvc = nsvc_by_ip4_elem(nse, ip4);
696 if (nsvc) {
697 /* the nsvc should be already in sync with the ip4 / ip6 elements */
698 return -NS_CAUSE_PROTO_ERR_UNSPEC;
699 }
700
701 /* TODO: failure case */
702 ns2_nsvc_create_ip4(fi, nse, ip4);
703 break;
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200704 case AF_INET6:
Alexander Couzens6a161492020-07-12 13:45:50 +0200705 nsvc = nsvc_by_ip6_elem(nse, ip6);
706 if (nsvc) {
707 /* the nsvc should be already in sync with the ip4 / ip6 elements */
708 return -NS_CAUSE_PROTO_ERR_UNSPEC;
709 }
710
711 /* TODO: failure case */
712 ns2_nsvc_create_ip6(fi, nse, ip6);
713 break;
714 }
715
716 gprs_ns2_start_alive_all_nsvcs(nse);
717
718 return 0;
719}
720
721
Harald Welte694dad52021-03-23 15:22:16 +0100722static void ns2_sns_st_bss_unconfigured(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Alexander Couzens6a161492020-07-12 13:45:50 +0200723{
Harald Weltef61a9152021-03-02 22:20:17 +0100724 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
725 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
Alexander Couzense769f522020-12-07 07:37:07 +0100726 /* empty state - SNS Select will start by ns2_sns_st_all_action() */
Alexander Couzens6a161492020-07-12 13:45:50 +0200727}
728
Harald Welte694dad52021-03-23 15:22:16 +0100729static void ns2_sns_st_bss_size(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Alexander Couzens6a161492020-07-12 13:45:50 +0200730{
Harald Weltef61a9152021-03-02 22:20:17 +0100731 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens6a161492020-07-12 13:45:50 +0200732 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
733 struct gprs_ns2_inst *nsi = nse->nsi;
734 struct tlv_parsed *tp = NULL;
735
Harald Weltef61a9152021-03-02 22:20:17 +0100736 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
737
Alexander Couzens6a161492020-07-12 13:45:50 +0200738 switch (event) {
Alexander Couzens175eb7b2021-07-20 18:41:14 +0200739 case NS2_SNS_EV_RX_SIZE_ACK:
Alexander Couzens6a161492020-07-12 13:45:50 +0200740 tp = data;
741 if (TLVP_VAL_MINLEN(tp, NS_IE_CAUSE, 1)) {
742 LOGPFSML(fi, LOGL_ERROR, "SNS-SIZE-ACK with cause %s\n",
743 gprs_ns2_cause_str(*TLVP_VAL(tp, NS_IE_CAUSE)));
744 /* TODO: What to do? */
745 } else {
Harald Welte694dad52021-03-23 15:22:16 +0100746 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_BSS_CONFIG_BSS,
Alexander Couzens6a161492020-07-12 13:45:50 +0200747 nsi->timeout[NS_TOUT_TSNS_PROV], 2);
748 }
749 break;
750 default:
751 OSMO_ASSERT(0);
752 }
753}
754
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200755static int ns2_sns_count_num_local_ep(struct osmo_fsm_inst *fi, int ip_proto)
Harald Welte01fa6a32021-03-04 19:49:38 +0100756{
757 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
758 struct ns2_sns_bind *sbind;
759 int count = 0;
760
761 llist_for_each_entry(sbind, &gss->binds, list) {
762 const struct osmo_sockaddr *sa = gprs_ns2_ip_bind_sockaddr(sbind->bind);
763 if (!sa)
764 continue;
765
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200766 switch (ip_proto) {
767 case AF_INET:
Harald Welte01fa6a32021-03-04 19:49:38 +0100768 if (sa->u.sas.ss_family == AF_INET)
769 count++;
770 break;
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200771 case AF_INET6:
Harald Welte01fa6a32021-03-04 19:49:38 +0100772 if (sa->u.sas.ss_family == AF_INET6)
773 count++;
774 break;
775 }
776 }
777 return count;
778}
779
Harald Welte24920e22021-03-04 13:03:27 +0100780static void ns2_sns_compute_local_ep_from_binds(struct osmo_fsm_inst *fi)
Alexander Couzens6a161492020-07-12 13:45:50 +0200781{
782 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzense769f522020-12-07 07:37:07 +0100783 struct gprs_ns_ie_ip4_elem *ip4_elems;
784 struct gprs_ns_ie_ip6_elem *ip6_elems;
785 struct gprs_ns2_vc_bind *bind;
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100786 struct ns2_sns_bind *sbind;
Harald Welte4f127462021-03-02 20:49:10 +0100787 const struct osmo_sockaddr *remote;
Alexander Couzense769f522020-12-07 07:37:07 +0100788 const struct osmo_sockaddr *sa;
789 struct osmo_sockaddr local;
790 int count;
Alexander Couzens6a161492020-07-12 13:45:50 +0200791
Alexander Couzensd2c6c492021-06-06 01:57:52 +0200792 ns2_clear_elems(&gss->local);
Alexander Couzens7a7b20b2021-01-18 10:47:33 +0100793
Alexander Couzense769f522020-12-07 07:37:07 +0100794 /* no initial available */
Harald Welte4f127462021-03-02 20:49:10 +0100795 if (gss->role == GPRS_SNS_ROLE_BSS) {
796 if (!gss->initial)
797 return;
798 remote = &gss->initial->saddr;
799 } else
800 remote = gprs_ns2_ip_vc_remote(gss->sns_nsvc);
Alexander Couzense769f522020-12-07 07:37:07 +0100801
802 /* count how many bindings are available (only UDP binds) */
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100803 count = llist_count(&gss->binds);
Alexander Couzense769f522020-12-07 07:37:07 +0100804 if (count == 0) {
Harald Welte05992872021-03-04 15:49:21 +0100805 LOGPFSML(fi, LOGL_ERROR, "No local binds for this NSE -> cannot determine IP endpoints\n");
Alexander Couzense769f522020-12-07 07:37:07 +0100806 return;
807 }
808
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200809 switch (gss->family) {
810 case AF_INET:
Alexander Couzens71128672021-06-05 18:44:01 +0200811 ip4_elems = talloc_realloc(fi, gss->local.ip4, struct gprs_ns_ie_ip4_elem, count);
Alexander Couzense769f522020-12-07 07:37:07 +0100812 if (!ip4_elems)
813 return;
814
Alexander Couzens71128672021-06-05 18:44:01 +0200815 gss->local.ip4 = ip4_elems;
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100816 llist_for_each_entry(sbind, &gss->binds, list) {
817 bind = sbind->bind;
Alexander Couzense769f522020-12-07 07:37:07 +0100818 sa = gprs_ns2_ip_bind_sockaddr(bind);
819 if (!sa)
820 continue;
821
822 if (sa->u.sas.ss_family != AF_INET)
823 continue;
824
825 /* check if this is an specific bind */
826 if (sa->u.sin.sin_addr.s_addr == 0) {
827 if (osmo_sockaddr_local_ip(&local, remote))
828 continue;
829
830 ip4_elems->ip_addr = local.u.sin.sin_addr.s_addr;
831 } else {
832 ip4_elems->ip_addr = sa->u.sin.sin_addr.s_addr;
833 }
834
835 ip4_elems->udp_port = sa->u.sin.sin_port;
Alexander Couzensc4704762021-02-08 23:13:12 +0100836 ip4_elems->sig_weight = bind->sns_sig_weight;
837 ip4_elems->data_weight = bind->sns_data_weight;
Alexander Couzense769f522020-12-07 07:37:07 +0100838 ip4_elems++;
839 }
840
Alexander Couzens71128672021-06-05 18:44:01 +0200841 gss->local.num_ip4 = count;
842 gss->num_max_nsvcs = OSMO_MAX(gss->num_max_ip4_remote * gss->local.num_ip4, 8);
Alexander Couzense769f522020-12-07 07:37:07 +0100843 break;
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200844 case AF_INET6:
Alexander Couzense769f522020-12-07 07:37:07 +0100845 /* IPv6 */
Alexander Couzens71128672021-06-05 18:44:01 +0200846 ip6_elems = talloc_realloc(fi, gss->local.ip6, struct gprs_ns_ie_ip6_elem, count);
Alexander Couzense769f522020-12-07 07:37:07 +0100847 if (!ip6_elems)
848 return;
849
Alexander Couzens71128672021-06-05 18:44:01 +0200850 gss->local.ip6 = ip6_elems;
Alexander Couzense769f522020-12-07 07:37:07 +0100851
Alexander Couzens6b9d2322021-02-12 03:17:59 +0100852 llist_for_each_entry(sbind, &gss->binds, list) {
853 bind = sbind->bind;
Alexander Couzense769f522020-12-07 07:37:07 +0100854 sa = gprs_ns2_ip_bind_sockaddr(bind);
855 if (!sa)
856 continue;
857
858 if (sa->u.sas.ss_family != AF_INET6)
859 continue;
860
861 /* check if this is an specific bind */
862 if (IN6_IS_ADDR_UNSPECIFIED(&sa->u.sin6.sin6_addr)) {
863 if (osmo_sockaddr_local_ip(&local, remote))
864 continue;
865
866 ip6_elems->ip_addr = local.u.sin6.sin6_addr;
867 } else {
868 ip6_elems->ip_addr = sa->u.sin6.sin6_addr;
869 }
870
871 ip6_elems->udp_port = sa->u.sin.sin_port;
Alexander Couzensc4704762021-02-08 23:13:12 +0100872 ip6_elems->sig_weight = bind->sns_sig_weight;
873 ip6_elems->data_weight = bind->sns_data_weight;
Alexander Couzense769f522020-12-07 07:37:07 +0100874
875 ip6_elems++;
876 }
Alexander Couzens71128672021-06-05 18:44:01 +0200877 gss->local.num_ip6 = count;
878 gss->num_max_nsvcs = OSMO_MAX(gss->num_max_ip6_remote * gss->local.num_ip6, 8);
Alexander Couzense769f522020-12-07 07:37:07 +0100879 break;
880 }
Harald Welte24920e22021-03-04 13:03:27 +0100881}
882
Alexander Couzens6608ce92021-04-26 20:39:46 +0200883static void ns2_sns_choose_next_bind(struct ns2_sns_state *gss)
884{
885 /* take the first bind or take the next bind */
886 if (!gss->initial_bind || gss->initial_bind->list.next == &gss->binds)
887 gss->initial_bind = llist_first_entry_or_null(&gss->binds, struct ns2_sns_bind, list);
888 else
889 gss->initial_bind = llist_entry(gss->initial_bind->list.next, struct ns2_sns_bind, list);
890}
891
Harald Welte24920e22021-03-04 13:03:27 +0100892/* setup all dynamic SNS settings, create a new nsvc and send the SIZE */
Harald Welte694dad52021-03-23 15:22:16 +0100893static void ns2_sns_st_bss_size_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
Harald Welte24920e22021-03-04 13:03:27 +0100894{
895 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
896
Harald Weltef61a9152021-03-02 22:20:17 +0100897 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
898
Harald Welte24920e22021-03-04 13:03:27 +0100899 /* on a generic failure, the timer callback will recover */
900 if (old_state != GPRS_SNS_ST_UNCONFIGURED)
901 ns2_prim_status_ind(gss->nse, NULL, 0, GPRS_NS2_AFF_CAUSE_SNS_FAILURE);
Harald Welte694dad52021-03-23 15:22:16 +0100902 if (old_state != GPRS_SNS_ST_BSS_SIZE)
Harald Welte24920e22021-03-04 13:03:27 +0100903 gss->N = 0;
904
905 gss->alive = false;
906
907 ns2_sns_compute_local_ep_from_binds(fi);
Alexander Couzens6608ce92021-04-26 20:39:46 +0200908 ns2_sns_choose_next_bind(gss);
Harald Welte24920e22021-03-04 13:03:27 +0100909
910 /* setup the NSVC */
911 if (!gss->sns_nsvc) {
912 struct gprs_ns2_vc_bind *bind = gss->initial_bind->bind;
913 struct osmo_sockaddr *remote = &gss->initial->saddr;
914 gss->sns_nsvc = ns2_ip_bind_connect(bind, gss->nse, remote);
915 if (!gss->sns_nsvc)
916 return;
Harald Weltec962a2e2021-03-05 08:09:08 +0100917 /* A pre-configured endpoint shall not be used for NSE data or signalling traffic
918 * (with the exception of Size and Configuration procedures) unless it is configured
919 * by the SGSN using the auto-configuration procedures */
Harald Welte24920e22021-03-04 13:03:27 +0100920 gss->sns_nsvc->sns_only = true;
921 }
922
Alexander Couzens6a161492020-07-12 13:45:50 +0200923 if (gss->num_max_ip4_remote > 0)
Alexander Couzens71128672021-06-05 18:44:01 +0200924 ns2_tx_sns_size(gss->sns_nsvc, true, gss->num_max_nsvcs, gss->local.num_ip4, -1);
Alexander Couzens6a161492020-07-12 13:45:50 +0200925 else
Alexander Couzens71128672021-06-05 18:44:01 +0200926 ns2_tx_sns_size(gss->sns_nsvc, true, gss->num_max_nsvcs, -1, gss->local.num_ip6);
Alexander Couzens6a161492020-07-12 13:45:50 +0200927}
928
Harald Welte694dad52021-03-23 15:22:16 +0100929static void ns2_sns_st_bss_config_bss(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Alexander Couzens6a161492020-07-12 13:45:50 +0200930{
Harald Weltef61a9152021-03-02 22:20:17 +0100931 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens3df58862021-02-05 17:18:08 +0100932 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
Harald Weltef61a9152021-03-02 22:20:17 +0100933 struct tlv_parsed *tp = NULL;
934
935 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
Alexander Couzens6a161492020-07-12 13:45:50 +0200936
937 switch (event) {
Alexander Couzens175eb7b2021-07-20 18:41:14 +0200938 case NS2_SNS_EV_RX_CONFIG_ACK:
Alexander Couzens6a161492020-07-12 13:45:50 +0200939 tp = (struct tlv_parsed *) data;
940 if (TLVP_VAL_MINLEN(tp, NS_IE_CAUSE, 1)) {
941 LOGPFSML(fi, LOGL_ERROR, "SNS-CONFIG-ACK with cause %s\n",
942 gprs_ns2_cause_str(*TLVP_VAL(tp, NS_IE_CAUSE)));
943 /* TODO: What to do? */
944 } else {
Harald Welte694dad52021-03-23 15:22:16 +0100945 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 +0200946 }
947 break;
948 default:
949 OSMO_ASSERT(0);
950 }
951}
952
Harald Welte694dad52021-03-23 15:22:16 +0100953static void ns2_sns_st_bss_config_bss_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
Alexander Couzens6a161492020-07-12 13:45:50 +0200954{
955 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens790a9632021-02-05 17:18:39 +0100956
Harald Weltef61a9152021-03-02 22:20:17 +0100957 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
958
Harald Welte694dad52021-03-23 15:22:16 +0100959 if (old_state != GPRS_SNS_ST_BSS_CONFIG_BSS)
Alexander Couzens790a9632021-02-05 17:18:39 +0100960 gss->N = 0;
961
Alexander Couzens6a161492020-07-12 13:45:50 +0200962 /* Transmit SNS-CONFIG */
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200963 switch (gss->family) {
964 case AF_INET:
Alexander Couzens6a161492020-07-12 13:45:50 +0200965 ns2_tx_sns_config(gss->sns_nsvc, true,
Alexander Couzens71128672021-06-05 18:44:01 +0200966 gss->local.ip4, gss->local.num_ip4,
Alexander Couzense78207f2020-12-07 06:19:29 +0100967 NULL, 0);
Alexander Couzens6a161492020-07-12 13:45:50 +0200968 break;
Alexander Couzens077ce5a2021-06-06 01:32:45 +0200969 case AF_INET6:
Alexander Couzens6a161492020-07-12 13:45:50 +0200970 ns2_tx_sns_config(gss->sns_nsvc, true,
Alexander Couzense78207f2020-12-07 06:19:29 +0100971 NULL, 0,
Alexander Couzens71128672021-06-05 18:44:01 +0200972 gss->local.ip6, gss->local.num_ip6);
Alexander Couzens6a161492020-07-12 13:45:50 +0200973 break;
974 }
975}
976
Alexander Couzensbe7cecc2021-02-03 18:25:27 +0100977/* calculate the timeout of the configured state. the configured
978 * state will fail if not at least one NS-VC is alive within X second.
979 */
980static inline int ns_sns_configured_timeout(struct osmo_fsm_inst *fi)
981{
982 int secs;
983 struct gprs_ns2_inst *nsi = nse_inst_from_fi(fi)->nsi;
984 secs = nsi->timeout[NS_TOUT_TNS_ALIVE] * nsi->timeout[NS_TOUT_TNS_ALIVE_RETRIES];
985 secs += nsi->timeout[NS_TOUT_TNS_TEST];
986
987 return secs;
988}
Alexander Couzens6a161492020-07-12 13:45:50 +0200989
Harald Weltec1c7e4a2021-03-02 20:47:29 +0100990/* append the remote endpoints from the parsed TLV array to the ns2_sns_state */
991static int ns_sns_append_remote_eps(struct osmo_fsm_inst *fi, const struct tlv_parsed *tp)
Alexander Couzens6a161492020-07-12 13:45:50 +0200992{
993 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens6a161492020-07-12 13:45:50 +0200994
Harald Weltec1c7e4a2021-03-02 20:47:29 +0100995 if (TLVP_PRESENT(tp, NS_IE_IPv4_LIST)) {
996 const struct gprs_ns_ie_ip4_elem *v4_list;
997 unsigned int num_v4;
998 v4_list = (const struct gprs_ns_ie_ip4_elem *) TLVP_VAL(tp, NS_IE_IPv4_LIST);
999 num_v4 = TLVP_LEN(tp, NS_IE_IPv4_LIST) / sizeof(*v4_list);
Alexander Couzens6a161492020-07-12 13:45:50 +02001000
Alexander Couzens71128672021-06-05 18:44:01 +02001001 if (num_v4 && gss->remote.ip6)
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001002 return -NS_CAUSE_INVAL_NR_IPv4_EP;
Alexander Couzens6a161492020-07-12 13:45:50 +02001003
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001004 /* realloc to the new size */
Alexander Couzens71128672021-06-05 18:44:01 +02001005 gss->remote.ip4 = talloc_realloc(gss, gss->remote.ip4,
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001006 struct gprs_ns_ie_ip4_elem,
Alexander Couzens71128672021-06-05 18:44:01 +02001007 gss->remote.num_ip4 + num_v4);
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001008 /* append the new entries to the end of the list */
Alexander Couzens71128672021-06-05 18:44:01 +02001009 memcpy(&gss->remote.ip4[gss->remote.num_ip4], v4_list, num_v4*sizeof(*v4_list));
1010 gss->remote.num_ip4 += num_v4;
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001011
1012 LOGPFSML(fi, LOGL_INFO, "Rx SNS-CONFIG: Remote IPv4 list now %u entries\n",
Alexander Couzens71128672021-06-05 18:44:01 +02001013 gss->remote.num_ip4);
Alexander Couzens6a161492020-07-12 13:45:50 +02001014 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001015
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001016 if (TLVP_PRESENT(tp, NS_IE_IPv6_LIST)) {
1017 const struct gprs_ns_ie_ip6_elem *v6_list;
1018 unsigned int num_v6;
1019 v6_list = (const struct gprs_ns_ie_ip6_elem *) TLVP_VAL(tp, NS_IE_IPv6_LIST);
1020 num_v6 = TLVP_LEN(tp, NS_IE_IPv6_LIST) / sizeof(*v6_list);
1021
Alexander Couzens71128672021-06-05 18:44:01 +02001022 if (num_v6 && gss->remote.ip4)
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001023 return -NS_CAUSE_INVAL_NR_IPv6_EP;
1024
1025 /* realloc to the new size */
Alexander Couzens71128672021-06-05 18:44:01 +02001026 gss->remote.ip6 = talloc_realloc(gss, gss->remote.ip6,
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001027 struct gprs_ns_ie_ip6_elem,
Alexander Couzens71128672021-06-05 18:44:01 +02001028 gss->remote.num_ip6 + num_v6);
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001029 /* append the new entries to the end of the list */
Alexander Couzens71128672021-06-05 18:44:01 +02001030 memcpy(&gss->remote.ip6[gss->remote.num_ip6], v6_list, num_v6*sizeof(*v6_list));
1031 gss->remote.num_ip6 += num_v6;
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001032
Alexander Couzens71128672021-06-05 18:44:01 +02001033 LOGPFSML(fi, LOGL_INFO, "Rx SNS-CONFIG: Remote IPv6 list now %d entries\n",
1034 gss->remote.num_ip6);
Alexander Couzens6a161492020-07-12 13:45:50 +02001035 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001036
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001037 return 0;
Alexander Couzens6a161492020-07-12 13:45:50 +02001038}
1039
Harald Welte694dad52021-03-23 15:22:16 +01001040static void ns2_sns_st_bss_config_sgsn_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
Alexander Couzens790a9632021-02-05 17:18:39 +01001041{
1042 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
1043
Harald Weltef61a9152021-03-02 22:20:17 +01001044 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
1045
Harald Welte694dad52021-03-23 15:22:16 +01001046 if (old_state != GPRS_SNS_ST_BSS_CONFIG_SGSN)
Alexander Couzens790a9632021-02-05 17:18:39 +01001047 gss->N = 0;
1048}
1049
Harald Welte694dad52021-03-23 15:22:16 +01001050static void ns2_sns_st_bss_config_sgsn(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Alexander Couzens6a161492020-07-12 13:45:50 +02001051{
1052 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001053 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
1054 uint8_t cause;
1055 int rc;
Alexander Couzens6a161492020-07-12 13:45:50 +02001056
Harald Weltef61a9152021-03-02 22:20:17 +01001057 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_BSS);
1058
Alexander Couzens6a161492020-07-12 13:45:50 +02001059 switch (event) {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001060 case NS2_SNS_EV_RX_CONFIG_END:
1061 case NS2_SNS_EV_RX_CONFIG:
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001062 rc = ns_sns_append_remote_eps(fi, data);
1063 if (rc < 0) {
1064 cause = -rc;
1065 ns2_tx_sns_config_ack(gss->sns_nsvc, &cause);
1066 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
1067 return;
Alexander Couzens6a161492020-07-12 13:45:50 +02001068 }
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001069 if (event == NS2_SNS_EV_RX_CONFIG_END) {
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001070 /* check if sum of data / sig weights == 0 */
Alexander Couzens019da4b2021-06-06 02:48:18 +02001071 if (ip46_weight_sum_data(&gss->remote) == 0 || ip46_weight_sum_sig(&gss->remote) == 0) {
Harald Weltec1c7e4a2021-03-02 20:47:29 +01001072 cause = NS_CAUSE_INVAL_WEIGH;
1073 ns2_tx_sns_config_ack(gss->sns_nsvc, &cause);
1074 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
1075 return;
1076 }
1077 create_missing_nsvcs(fi);
1078 ns2_tx_sns_config_ack(gss->sns_nsvc, NULL);
1079 /* start the test procedure on ALL NSVCs! */
1080 gprs_ns2_start_alive_all_nsvcs(nse);
1081 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_CONFIGURED, 0, 0);
1082 } else {
1083 /* just send CONFIG-ACK */
1084 ns2_tx_sns_config_ack(gss->sns_nsvc, NULL);
1085 osmo_timer_schedule(&fi->timer, nse->nsi->timeout[NS_TOUT_TSNS_PROV], 0);
Alexander Couzens6a161492020-07-12 13:45:50 +02001086 }
1087 break;
1088 default:
1089 OSMO_ASSERT(0);
1090 }
1091}
1092
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001093/* called when receiving NS2_SNS_EV_RX_ADD in state configure */
Alexander Couzens6a161492020-07-12 13:45:50 +02001094static void ns2_sns_st_configured_add(struct osmo_fsm_inst *fi,
1095 struct ns2_sns_state *gss,
1096 struct tlv_parsed *tp)
1097{
1098 const struct gprs_ns_ie_ip4_elem *v4_list = NULL;
1099 const struct gprs_ns_ie_ip6_elem *v6_list = NULL;
1100 int num_v4 = 0, num_v6 = 0;
1101 uint8_t trans_id, cause = 0xff;
Harald Welte7da6ace2020-09-18 09:48:05 +02001102 unsigned int i;
Alexander Couzens6a161492020-07-12 13:45:50 +02001103 int rc = 0;
1104
1105 /* TODO: refactor EV_ADD/CHANGE/REMOVE by
1106 * check uniqueness within the lists (no doublicate entries)
1107 * check not-known-by-us and sent back a list of unknown/known values
1108 * (abnormal behaviour according to 48.016)
1109 */
1110
1111 trans_id = *TLVP_VAL(tp, NS_IE_TRANS_ID);
Alexander Couzens077ce5a2021-06-06 01:32:45 +02001112 if (gss->family == AF_INET) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001113 if (!TLVP_PRESENT(tp, NS_IE_IPv4_LIST)) {
1114 cause = NS_CAUSE_INVAL_NR_IPv4_EP;
1115 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1116 return;
1117 }
1118
1119 v4_list = (const struct gprs_ns_ie_ip4_elem *) TLVP_VAL(tp, NS_IE_IPv4_LIST);
1120 num_v4 = TLVP_LEN(tp, NS_IE_IPv4_LIST) / sizeof(*v4_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001121 for (i = 0; i < num_v4; i++) {
1122 unsigned int j;
Alexander Couzens6a161492020-07-12 13:45:50 +02001123 rc = do_sns_add(fi, &v4_list[i], NULL);
1124 if (rc < 0) {
1125 /* rollback/undo to restore previous state */
Harald Welte7da6ace2020-09-18 09:48:05 +02001126 for (j = 0; j < i; j++)
Alexander Couzens6a161492020-07-12 13:45:50 +02001127 do_sns_delete(fi, &v4_list[j], NULL);
1128 cause = -rc;
1129 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1130 break;
1131 }
1132 }
1133 } else { /* IPv6 */
1134 if (!TLVP_PRESENT(tp, NS_IE_IPv6_LIST)) {
1135 cause = NS_CAUSE_INVAL_NR_IPv6_EP;
1136 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1137 return;
1138 }
1139
1140 v6_list = (const struct gprs_ns_ie_ip6_elem *) TLVP_VAL(tp, NS_IE_IPv6_LIST);
1141 num_v6 = TLVP_LEN(tp, NS_IE_IPv6_LIST) / sizeof(*v6_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001142 for (i = 0; i < num_v6; i++) {
1143 unsigned int j;
Alexander Couzens6a161492020-07-12 13:45:50 +02001144 rc = do_sns_add(fi, NULL, &v6_list[i]);
1145 if (rc < 0) {
1146 /* rollback/undo to restore previous state */
Harald Welte7da6ace2020-09-18 09:48:05 +02001147 for (j = 0; j < i; j++)
Alexander Couzens6a161492020-07-12 13:45:50 +02001148 do_sns_delete(fi, NULL, &v6_list[j]);
1149 cause = -rc;
1150 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1151 break;
1152 }
1153 }
1154 }
1155
1156 /* TODO: correct behaviour is to answer to the *same* NSVC from which the SNS_ADD was received */
1157 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, NULL, v4_list, num_v4, v6_list, num_v6);
1158}
1159
1160static void ns2_sns_st_configured_delete(struct osmo_fsm_inst *fi,
1161 struct ns2_sns_state *gss,
1162 struct tlv_parsed *tp)
1163{
1164 const struct gprs_ns_ie_ip4_elem *v4_list = NULL;
1165 const struct gprs_ns_ie_ip6_elem *v6_list = NULL;
1166 int num_v4 = 0, num_v6 = 0;
1167 uint8_t trans_id, cause = 0xff;
Harald Welte7da6ace2020-09-18 09:48:05 +02001168 unsigned int i;
Alexander Couzens6a161492020-07-12 13:45:50 +02001169 int rc = 0;
1170
1171 /* TODO: split up delete into v4 + v6
1172 * TODO: check if IPv4_LIST or IP_ADDR(v4) is present on IPv6 and vice versa
1173 * TODO: check if IPv4_LIST/IPv6_LIST and IP_ADDR is present at the same time
1174 */
1175 trans_id = *TLVP_VAL(tp, NS_IE_TRANS_ID);
Alexander Couzens077ce5a2021-06-06 01:32:45 +02001176 if (gss->family == AF_INET) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001177 if (TLVP_PRESENT(tp, NS_IE_IPv4_LIST)) {
1178 v4_list = (const struct gprs_ns_ie_ip4_elem *) TLVP_VAL(tp, NS_IE_IPv4_LIST);
1179 num_v4 = TLVP_LEN(tp, NS_IE_IPv4_LIST) / sizeof(*v4_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001180 for ( i = 0; i < num_v4; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001181 rc = do_sns_delete(fi, &v4_list[i], NULL);
1182 if (rc < 0) {
1183 cause = -rc;
1184 /* continue to delete others */
1185 }
1186 }
1187 if (cause != 0xff) {
1188 /* TODO: create list of not-deleted and return it */
1189 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1190 return;
1191 }
1192
1193 } else if (TLVP_PRESENT(tp, NS_IE_IP_ADDR) && TLVP_LEN(tp, NS_IE_IP_ADDR) == 5) {
1194 /* delete all NS-VCs for given IPv4 address */
1195 const uint8_t *ie = TLVP_VAL(tp, NS_IE_IP_ADDR);
1196 struct gprs_ns_ie_ip4_elem *ip4_remote;
1197 uint32_t ip_addr = *(uint32_t *)(ie+1);
1198 if (ie[0] != 0x01) { /* Address Type != IPv4 */
1199 cause = NS_CAUSE_UNKN_IP_ADDR;
1200 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1201 return;
1202 }
1203 /* make a copy as do_sns_delete() will change the array underneath us */
Alexander Couzens71128672021-06-05 18:44:01 +02001204 ip4_remote = talloc_memdup(fi, gss->remote.ip4,
1205 gss->remote.num_ip4 * sizeof(*v4_list));
1206 for (i = 0; i < gss->remote.num_ip4; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001207 if (ip4_remote[i].ip_addr == ip_addr) {
1208 rc = do_sns_delete(fi, &ip4_remote[i], NULL);
1209 if (rc < 0) {
1210 cause = -rc;
1211 /* continue to delete others */
1212 }
1213 }
1214 }
1215 talloc_free(ip4_remote);
1216 if (cause != 0xff) {
1217 /* TODO: create list of not-deleted and return it */
1218 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1219 return;
1220 }
1221 } else {
1222 cause = NS_CAUSE_INVAL_NR_IPv4_EP;
1223 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1224 return;
1225 }
1226 } else { /* IPv6 */
1227 if (TLVP_PRESENT(tp, NS_IE_IPv6_LIST)) {
1228 v6_list = (const struct gprs_ns_ie_ip6_elem *) TLVP_VAL(tp, NS_IE_IPv6_LIST);
1229 num_v6 = TLVP_LEN(tp, NS_IE_IPv6_LIST) / sizeof(*v6_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001230 for (i = 0; i < num_v6; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001231 rc = do_sns_delete(fi, NULL, &v6_list[i]);
1232 if (rc < 0) {
1233 cause = -rc;
1234 /* continue to delete others */
1235 }
1236 }
1237 if (cause != 0xff) {
1238 /* TODO: create list of not-deleted and return it */
1239 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1240 return;
1241 }
1242 } else if (TLVP_PRES_LEN(tp, NS_IE_IP_ADDR, 17)) {
1243 /* delete all NS-VCs for given IPv4 address */
1244 const uint8_t *ie = TLVP_VAL(tp, NS_IE_IP_ADDR);
1245 struct gprs_ns_ie_ip6_elem *ip6_remote;
1246 struct in6_addr ip6_addr;
Harald Welte7da6ace2020-09-18 09:48:05 +02001247 unsigned int i;
Alexander Couzens6a161492020-07-12 13:45:50 +02001248 if (ie[0] != 0x02) { /* Address Type != IPv6 */
1249 cause = NS_CAUSE_UNKN_IP_ADDR;
1250 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1251 return;
1252 }
1253 memcpy(&ip6_addr, (ie+1), sizeof(struct in6_addr));
1254 /* make a copy as do_sns_delete() will change the array underneath us */
Alexander Couzens71128672021-06-05 18:44:01 +02001255 ip6_remote = talloc_memdup(fi, gss->remote.ip6,
1256 gss->remote.num_ip6 * sizeof(*v4_list));
1257 for (i = 0; i < gss->remote.num_ip6; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001258 if (!memcmp(&ip6_remote[i].ip_addr, &ip6_addr, sizeof(struct in6_addr))) {
1259 rc = do_sns_delete(fi, NULL, &ip6_remote[i]);
1260 if (rc < 0) {
1261 cause = -rc;
1262 /* continue to delete others */
1263 }
1264 }
1265 }
1266
1267 talloc_free(ip6_remote);
1268 if (cause != 0xff) {
1269 /* TODO: create list of not-deleted and return it */
1270 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1271 return;
1272 }
1273 } else {
1274 cause = NS_CAUSE_INVAL_NR_IPv6_EP;
1275 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1276 return;
1277 }
1278 }
1279 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, NULL, v4_list, num_v4, v6_list, num_v6);
1280}
1281
1282static void ns2_sns_st_configured_change(struct osmo_fsm_inst *fi,
1283 struct ns2_sns_state *gss,
1284 struct tlv_parsed *tp)
1285{
1286 const struct gprs_ns_ie_ip4_elem *v4_list = NULL;
1287 const struct gprs_ns_ie_ip6_elem *v6_list = NULL;
1288 int num_v4 = 0, num_v6 = 0;
1289 uint8_t trans_id, cause = 0xff;
1290 int rc = 0;
Harald Welte7da6ace2020-09-18 09:48:05 +02001291 unsigned int i;
Alexander Couzens6a161492020-07-12 13:45:50 +02001292
1293 trans_id = *TLVP_VAL(tp, NS_IE_TRANS_ID);
1294 if (TLVP_PRESENT(tp, NS_IE_IPv4_LIST)) {
1295 v4_list = (const struct gprs_ns_ie_ip4_elem *) TLVP_VAL(tp, NS_IE_IPv4_LIST);
1296 num_v4 = TLVP_LEN(tp, NS_IE_IPv4_LIST) / sizeof(*v4_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001297 for (i = 0; i < num_v4; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001298 rc = do_sns_change_weight(fi, &v4_list[i], NULL);
1299 if (rc < 0) {
1300 cause = -rc;
1301 /* continue to others */
1302 }
1303 }
1304 if (cause != 0xff) {
1305 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1306 return;
1307 }
1308 } else if (TLVP_PRESENT(tp, NS_IE_IPv6_LIST)) {
1309 v6_list = (const struct gprs_ns_ie_ip6_elem *) TLVP_VAL(tp, NS_IE_IPv6_LIST);
1310 num_v6 = TLVP_LEN(tp, NS_IE_IPv6_LIST) / sizeof(*v6_list);
Harald Welte7da6ace2020-09-18 09:48:05 +02001311 for (i = 0; i < num_v6; i++) {
Alexander Couzens6a161492020-07-12 13:45:50 +02001312 rc = do_sns_change_weight(fi, NULL, &v6_list[i]);
1313 if (rc < 0) {
1314 cause = -rc;
1315 /* continue to others */
1316 }
1317 }
1318 if (cause != 0xff) {
1319 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1320 return;
1321 }
1322 } else {
1323 cause = NS_CAUSE_INVAL_NR_IPv4_EP;
1324 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, &cause, NULL, 0, NULL, 0);
1325 return;
1326 }
1327 ns2_tx_sns_ack(gss->sns_nsvc, trans_id, NULL, v4_list, num_v4, v6_list, num_v6);
1328}
1329
1330static void ns2_sns_st_configured(struct osmo_fsm_inst *fi, uint32_t event, void *data)
1331{
1332 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
1333 struct tlv_parsed *tp = data;
1334
1335 switch (event) {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001336 case NS2_SNS_EV_RX_ADD:
Alexander Couzens6a161492020-07-12 13:45:50 +02001337 ns2_sns_st_configured_add(fi, gss, tp);
1338 break;
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001339 case NS2_SNS_EV_RX_DELETE:
Alexander Couzens6a161492020-07-12 13:45:50 +02001340 ns2_sns_st_configured_delete(fi, gss, tp);
1341 break;
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001342 case NS2_SNS_EV_RX_CHANGE_WEIGHT:
Alexander Couzens6a161492020-07-12 13:45:50 +02001343 ns2_sns_st_configured_change(fi, gss, tp);
1344 break;
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001345 case NS2_SNS_EV_REQ_NSVC_ALIVE:
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001346 osmo_timer_del(&fi->timer);
1347 break;
Alexander Couzens6a161492020-07-12 13:45:50 +02001348 }
1349}
1350
1351static void ns2_sns_st_configured_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
1352{
Alexander Couzenscdb2baa2021-04-01 15:29:16 +02001353 struct gprs_ns2_vc *nsvc;
1354 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens6a161492020-07-12 13:45:50 +02001355 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
Alexander Couzenscdb2baa2021-04-01 15:29:16 +02001356 /* NS-VC status updates are only parsed in ST_CONFIGURED.
1357 * Do an initial check if there are any nsvc alive atm */
1358 llist_for_each_entry(nsvc, &nse->nsvc, list) {
1359 if (ns2_vc_is_unblocked(nsvc)) {
1360 gss->alive = true;
1361 osmo_timer_del(&fi->timer);
1362 break;
1363 }
1364 }
1365
Alexander Couzens53e70092021-04-06 15:45:47 +02001366 /* remove the initial NSVC if the NSVC isn't part of the configuration */
1367 if (gss->sns_nsvc->sns_only)
1368 gprs_ns2_free_nsvc(gss->sns_nsvc);
1369
Alexander Couzens138b96f2021-01-25 16:23:29 +01001370 ns2_prim_status_ind(nse, NULL, 0, GPRS_NS2_AFF_CAUSE_SNS_CONFIGURED);
Alexander Couzens6a161492020-07-12 13:45:50 +02001371}
1372
1373static const struct osmo_fsm_state ns2_sns_bss_states[] = {
1374 [GPRS_SNS_ST_UNCONFIGURED] = {
Alexander Couzense769f522020-12-07 07:37:07 +01001375 .in_event_mask = 0, /* handled by all_state_action */
Alexander Couzens0a7c5ee2021-04-10 18:20:21 +02001376 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
1377 S(GPRS_SNS_ST_BSS_SIZE),
Alexander Couzens6a161492020-07-12 13:45:50 +02001378 .name = "UNCONFIGURED",
Harald Welte694dad52021-03-23 15:22:16 +01001379 .action = ns2_sns_st_bss_unconfigured,
Alexander Couzens6a161492020-07-12 13:45:50 +02001380 },
Harald Welte694dad52021-03-23 15:22:16 +01001381 [GPRS_SNS_ST_BSS_SIZE] = {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001382 .in_event_mask = S(NS2_SNS_EV_RX_SIZE_ACK),
Alexander Couzens6a161492020-07-12 13:45:50 +02001383 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
Harald Welte694dad52021-03-23 15:22:16 +01001384 S(GPRS_SNS_ST_BSS_SIZE) |
1385 S(GPRS_SNS_ST_BSS_CONFIG_BSS),
1386 .name = "BSS_SIZE",
1387 .action = ns2_sns_st_bss_size,
1388 .onenter = ns2_sns_st_bss_size_onenter,
Alexander Couzens6a161492020-07-12 13:45:50 +02001389 },
Harald Welte694dad52021-03-23 15:22:16 +01001390 [GPRS_SNS_ST_BSS_CONFIG_BSS] = {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001391 .in_event_mask = S(NS2_SNS_EV_RX_CONFIG_ACK),
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_BSS) |
1394 S(GPRS_SNS_ST_BSS_CONFIG_SGSN) |
1395 S(GPRS_SNS_ST_BSS_SIZE),
1396 .name = "BSS_CONFIG_BSS",
1397 .action = ns2_sns_st_bss_config_bss,
1398 .onenter = ns2_sns_st_bss_config_bss_onenter,
Alexander Couzens6a161492020-07-12 13:45:50 +02001399 },
Harald Welte694dad52021-03-23 15:22:16 +01001400 [GPRS_SNS_ST_BSS_CONFIG_SGSN] = {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001401 .in_event_mask = S(NS2_SNS_EV_RX_CONFIG) |
1402 S(NS2_SNS_EV_RX_CONFIG_END),
Alexander Couzens6a161492020-07-12 13:45:50 +02001403 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
Harald Welte694dad52021-03-23 15:22:16 +01001404 S(GPRS_SNS_ST_BSS_CONFIG_SGSN) |
Alexander Couzens6a161492020-07-12 13:45:50 +02001405 S(GPRS_SNS_ST_CONFIGURED) |
Harald Welte694dad52021-03-23 15:22:16 +01001406 S(GPRS_SNS_ST_BSS_SIZE),
1407 .name = "BSS_CONFIG_SGSN",
1408 .action = ns2_sns_st_bss_config_sgsn,
1409 .onenter = ns2_sns_st_bss_config_sgsn_onenter,
Alexander Couzens6a161492020-07-12 13:45:50 +02001410 },
1411 [GPRS_SNS_ST_CONFIGURED] = {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001412 .in_event_mask = S(NS2_SNS_EV_RX_ADD) |
1413 S(NS2_SNS_EV_RX_DELETE) |
1414 S(NS2_SNS_EV_RX_CHANGE_WEIGHT) |
1415 S(NS2_SNS_EV_REQ_NSVC_ALIVE),
Alexander Couzense03d8632020-12-06 03:31:44 +01001416 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
Harald Welte694dad52021-03-23 15:22:16 +01001417 S(GPRS_SNS_ST_BSS_SIZE),
Alexander Couzens6a161492020-07-12 13:45:50 +02001418 .name = "CONFIGURED",
1419 .action = ns2_sns_st_configured,
1420 .onenter = ns2_sns_st_configured_onenter,
1421 },
1422};
1423
1424static int ns2_sns_fsm_bss_timer_cb(struct osmo_fsm_inst *fi)
1425{
Alexander Couzens90ee9632020-12-07 06:18:32 +01001426 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
Alexander Couzens6a161492020-07-12 13:45:50 +02001427 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
1428 struct gprs_ns2_inst *nsi = nse->nsi;
1429
Alexander Couzens90ee9632020-12-07 06:18:32 +01001430 gss->N++;
Alexander Couzens6a161492020-07-12 13:45:50 +02001431 switch (fi->T) {
1432 case 1:
Alexander Couzensa367d082020-12-21 14:06:24 +01001433 if (gss->N >= nsi->timeout[NS_TOUT_TSNS_SIZE_RETRIES]) {
Alexander Couzens652ab4d2021-06-12 23:09:46 +02001434 sns_failed(fi, "Size retries failed. Selecting next IP-SNS endpoint.");
Alexander Couzensa367d082020-12-21 14:06:24 +01001435 } else {
Harald Welte694dad52021-03-23 15:22:16 +01001436 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 +01001437 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001438 break;
1439 case 2:
Alexander Couzensa367d082020-12-21 14:06:24 +01001440 if (gss->N >= nsi->timeout[NS_TOUT_TSNS_CONFIG_RETRIES]) {
Alexander Couzens652ab4d2021-06-12 23:09:46 +02001441 sns_failed(fi, "BSS Config retries failed. Selecting next IP-SNS endpoint");
Alexander Couzensa367d082020-12-21 14:06:24 +01001442 } else {
Harald Welte694dad52021-03-23 15:22:16 +01001443 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 +01001444 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001445 break;
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001446 case 3:
Alexander Couzens3df58862021-02-05 17:18:08 +01001447 if (gss->N >= nsi->timeout[NS_TOUT_TSNS_CONFIG_RETRIES]) {
Alexander Couzens652ab4d2021-06-12 23:09:46 +02001448 sns_failed(fi, "SGSN Config retries failed. Selecting next IP-SNS endpoint.");
Alexander Couzens3df58862021-02-05 17:18:08 +01001449 } else {
Harald Welte694dad52021-03-23 15:22:16 +01001450 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 +01001451 }
1452 break;
1453 case 4:
Alexander Couzens652ab4d2021-06-12 23:09:46 +02001454 sns_failed(fi, "Config succeeded but no NS-VC came online. Selecting next IP-SNS endpoint.");
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001455 break;
Alexander Couzens6a161492020-07-12 13:45:50 +02001456 }
1457 return 0;
1458}
1459
Harald Welte9e37bf42021-03-02 20:48:31 +01001460/* common allstate-action for both roles */
Alexander Couzens6a161492020-07-12 13:45:50 +02001461static void ns2_sns_st_all_action(struct osmo_fsm_inst *fi, uint32_t event, void *data)
1462{
1463 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001464 struct ns2_sns_bind *sbind;
1465 struct gprs_ns2_vc *nsvc, *nsvc2;
Alexander Couzens6a161492020-07-12 13:45:50 +02001466
Alexander Couzense769f522020-12-07 07:37:07 +01001467 switch (event) {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001468 case NS2_SNS_EV_REQ_ADD_BIND:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001469 sbind = data;
1470 switch (fi->state) {
1471 case GPRS_SNS_ST_UNCONFIGURED:
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001472 osmo_fsm_inst_dispatch(nse->bss_sns_fi, NS2_SNS_EV_REQ_SELECT_ENDPOINT, NULL);
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001473 break;
Harald Welte694dad52021-03-23 15:22:16 +01001474 case GPRS_SNS_ST_BSS_SIZE:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001475 /* TODO: add the ip4 element to the list */
1476 break;
Harald Welte694dad52021-03-23 15:22:16 +01001477 case GPRS_SNS_ST_BSS_CONFIG_BSS:
1478 case GPRS_SNS_ST_BSS_CONFIG_SGSN:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001479 case GPRS_SNS_ST_CONFIGURED:
1480 /* TODO: add to SNS-IP procedure queue & add nsvc() */
1481 break;
1482 }
1483 break;
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001484 case NS2_SNS_EV_REQ_DELETE_BIND:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001485 sbind = data;
1486 switch (fi->state) {
1487 case GPRS_SNS_ST_UNCONFIGURED:
1488 break;
Harald Welte694dad52021-03-23 15:22:16 +01001489 case GPRS_SNS_ST_BSS_SIZE:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001490 /* TODO: remove the ip4 element from the list */
1491 llist_for_each_entry_safe(nsvc, nsvc2, &nse->nsvc, list) {
1492 if (nsvc->bind == sbind->bind) {
1493 gprs_ns2_free_nsvc(nsvc);
1494 }
1495 }
1496 break;
Harald Welte694dad52021-03-23 15:22:16 +01001497 case GPRS_SNS_ST_BSS_CONFIG_BSS:
1498 case GPRS_SNS_ST_BSS_CONFIG_SGSN:
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001499 case GPRS_SNS_ST_CONFIGURED:
1500 /* TODO: do an delete SNS-IP procedure */
1501 /* TODO: remove the ip4 element to the list */
1502 llist_for_each_entry_safe(nsvc, nsvc2, &nse->nsvc, list) {
1503 if (nsvc->bind == sbind->bind) {
1504 gprs_ns2_free_nsvc(nsvc);
1505 }
1506 }
1507 break;
1508 }
1509 /* if this is the last bind, the free_nsvc() will trigger a reselection */
1510 talloc_free(sbind);
1511 break;
Alexander Couzense769f522020-12-07 07:37:07 +01001512 }
Alexander Couzens6a161492020-07-12 13:45:50 +02001513}
1514
Alexander Couzens31d52e12021-06-05 20:04:04 +02001515/* validate the bss configuration (sns endpoint and binds)
1516 * - no endpoints -> invalid
1517 * - no binds -> invalid
1518 * - only v4 sns endpoints, only v6 binds -> invalid
1519 * - only v4 sns endpoints, but v4 sig weights == 0 -> invalid ...
1520 */
1521static int ns2_sns_bss_valid_configuration(struct ns2_sns_state *gss)
1522{
1523 struct ns2_sns_bind *sbind;
1524 struct sns_endpoint *endpoint;
1525 const struct osmo_sockaddr *addr;
1526 int v4_sig = 0, v4_data = 0, v6_sig = 0, v6_data = 0;
1527 bool v4_endpoints = false;
1528 bool v6_endpoints = false;
1529
1530 if (llist_empty(&gss->sns_endpoints) || llist_empty(&gss->binds))
1531 return 0;
1532
1533 llist_for_each_entry(sbind, &gss->binds, list) {
1534 addr = gprs_ns2_ip_bind_sockaddr(sbind->bind);
1535 if (!addr)
1536 continue;
1537 switch (addr->u.sa.sa_family) {
1538 case AF_INET:
1539 v4_sig += sbind->bind->sns_sig_weight;
1540 v4_data += sbind->bind->sns_data_weight;
1541 break;
1542 case AF_INET6:
1543 v6_sig += sbind->bind->sns_sig_weight;
1544 v6_data += sbind->bind->sns_data_weight;
1545 break;
1546 }
1547 }
1548
1549 llist_for_each_entry(endpoint, &gss->sns_endpoints, list) {
1550 switch (endpoint->saddr.u.sa.sa_family) {
1551 case AF_INET:
1552 v4_endpoints = true;
1553 break;
1554 case AF_INET6:
1555 v6_endpoints = true;
1556 break;
1557 }
1558 }
1559
1560 return (v4_endpoints && v4_sig && v4_data) || (v6_endpoints && v6_sig && v6_data);
1561}
1562
Harald Welte9e37bf42021-03-02 20:48:31 +01001563/* allstate-action for BSS role */
1564static void ns2_sns_st_all_action_bss(struct osmo_fsm_inst *fi, uint32_t event, void *data)
1565{
1566 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
1567 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
Alexander Couzens83f06ce2021-08-06 19:50:09 +02001568 struct gprs_ns2_vc *nsvc, *nsvc2;
Harald Welte9e37bf42021-03-02 20:48:31 +01001569
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001570 /* reset when receiving NS2_SNS_EV_REQ_NO_NSVC */
Harald Welte9e37bf42021-03-02 20:48:31 +01001571 switch (event) {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001572 case NS2_SNS_EV_REQ_NO_NSVC:
Harald Welte9e37bf42021-03-02 20:48:31 +01001573 /* ignore reselection running */
1574 if (gss->reselection_running)
1575 break;
1576
Alexander Couzens652ab4d2021-06-12 23:09:46 +02001577 sns_failed(fi, "no remaining NSVC, resetting SNS FSM");
Harald Welte9e37bf42021-03-02 20:48:31 +01001578 break;
Alexander Couzens83f06ce2021-08-06 19:50:09 +02001579 case NS2_SNS_EV_REQ_FREE_NSVCS:
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001580 case NS2_SNS_EV_REQ_SELECT_ENDPOINT:
Harald Welte9e37bf42021-03-02 20:48:31 +01001581 /* tear down previous state
1582 * gprs_ns2_free_nsvcs() will trigger NO_NSVC, prevent this from triggering a reselection */
1583 gss->reselection_running = true;
Alexander Couzens83f06ce2021-08-06 19:50:09 +02001584 llist_for_each_entry_safe(nsvc, nsvc2, &nse->nsvc, list) {
1585 gprs_ns2_free_nsvc(nsvc);
1586 }
Alexander Couzensd2c6c492021-06-06 01:57:52 +02001587 ns2_clear_elems(&gss->local);
1588 ns2_clear_elems(&gss->remote);
Harald Welte9e37bf42021-03-02 20:48:31 +01001589
1590 /* Choose the next sns endpoint. */
Alexander Couzens31d52e12021-06-05 20:04:04 +02001591 if (!ns2_sns_bss_valid_configuration(gss)) {
Harald Welte9e37bf42021-03-02 20:48:31 +01001592 gss->initial = NULL;
1593 ns2_prim_status_ind(gss->nse, NULL, 0, GPRS_NS2_AFF_CAUSE_SNS_NO_ENDPOINTS);
1594 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 3);
1595 return;
1596 } else if (!gss->initial) {
1597 gss->initial = llist_first_entry(&gss->sns_endpoints, struct sns_endpoint, list);
1598 } else if (gss->initial->list.next == &gss->sns_endpoints) {
1599 /* last entry, continue with first */
1600 gss->initial = llist_first_entry(&gss->sns_endpoints, struct sns_endpoint, list);
1601 } else {
1602 /* next element is an entry */
1603 gss->initial = llist_entry(gss->initial->list.next, struct sns_endpoint, list);
1604 }
1605
Alexander Couzens68ab9c42021-06-06 03:03:40 +02001606 gss->family = gss->initial->saddr.u.sa.sa_family;
Harald Welte9e37bf42021-03-02 20:48:31 +01001607 gss->reselection_running = false;
Harald Welte694dad52021-03-23 15:22:16 +01001608 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 +01001609 break;
1610 default:
1611 ns2_sns_st_all_action(fi, event, data);
1612 break;
1613 }
1614}
1615
Alexander Couzens6a161492020-07-12 13:45:50 +02001616static struct osmo_fsm gprs_ns2_sns_bss_fsm = {
1617 .name = "GPRS-NS2-SNS-BSS",
1618 .states = ns2_sns_bss_states,
1619 .num_states = ARRAY_SIZE(ns2_sns_bss_states),
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001620 .allstate_event_mask = S(NS2_SNS_EV_REQ_NO_NSVC) |
Alexander Couzens83f06ce2021-08-06 19:50:09 +02001621 S(NS2_SNS_EV_REQ_FREE_NSVCS) |
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001622 S(NS2_SNS_EV_REQ_SELECT_ENDPOINT) |
1623 S(NS2_SNS_EV_REQ_ADD_BIND) |
1624 S(NS2_SNS_EV_REQ_DELETE_BIND),
Harald Welte9e37bf42021-03-02 20:48:31 +01001625 .allstate_action = ns2_sns_st_all_action_bss,
Alexander Couzens6a161492020-07-12 13:45:50 +02001626 .cleanup = NULL,
1627 .timer_cb = ns2_sns_fsm_bss_timer_cb,
Alexander Couzens6a161492020-07-12 13:45:50 +02001628 .event_names = gprs_sns_event_names,
1629 .pre_term = NULL,
1630 .log_subsys = DLNS,
1631};
1632
Harald Welte5bef2cc2020-09-18 22:33:24 +02001633/*! Allocate an IP-SNS FSM for the BSS side.
1634 * \param[in] nse NS Entity in which the FSM runs
1635 * \param[in] id string identifier
Alexander Couzens23aec352021-02-15 05:05:15 +01001636 * \returns FSM instance on success; NULL on error */
Alexander Couzens6a161492020-07-12 13:45:50 +02001637struct osmo_fsm_inst *ns2_sns_bss_fsm_alloc(struct gprs_ns2_nse *nse,
1638 const char *id)
1639{
1640 struct osmo_fsm_inst *fi;
1641 struct ns2_sns_state *gss;
1642
1643 fi = osmo_fsm_inst_alloc(&gprs_ns2_sns_bss_fsm, nse, NULL, LOGL_DEBUG, id);
1644 if (!fi)
1645 return fi;
1646
1647 gss = talloc_zero(fi, struct ns2_sns_state);
1648 if (!gss)
1649 goto err;
1650
1651 fi->priv = gss;
1652 gss->nse = nse;
Harald Welte4f127462021-03-02 20:49:10 +01001653 gss->role = GPRS_SNS_ROLE_BSS;
Harald Welte24f4df52021-03-04 18:02:54 +01001654 /* The SGSN doesn't tell the BSS, so we assume there's always sufficient */
1655 gss->num_max_ip4_remote = 8192;
1656 gss->num_max_ip6_remote = 8192;
Alexander Couzense769f522020-12-07 07:37:07 +01001657 INIT_LLIST_HEAD(&gss->sns_endpoints);
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001658 INIT_LLIST_HEAD(&gss->binds);
Alexander Couzens6a161492020-07-12 13:45:50 +02001659
1660 return fi;
1661err:
1662 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
1663 return NULL;
1664}
1665
Harald Welte5bef2cc2020-09-18 22:33:24 +02001666/*! main entry point for receiving SNS messages from the network.
1667 * \param[in] nsvc NS-VC on which the message was received
1668 * \param[in] msg message buffer of the IP-SNS message
1669 * \param[in] tp parsed TLV structure of message
Alexander Couzens23aec352021-02-15 05:05:15 +01001670 * \returns 0 on success; negative on error */
Alexander Couzens8dfc24c2021-01-25 16:09:23 +01001671int ns2_sns_rx(struct gprs_ns2_vc *nsvc, struct msgb *msg, struct tlv_parsed *tp)
Alexander Couzens6a161492020-07-12 13:45:50 +02001672{
1673 struct gprs_ns2_nse *nse = nsvc->nse;
1674 struct gprs_ns_hdr *nsh = (struct gprs_ns_hdr *) msg->l2h;
1675 uint16_t nsei = nsvc->nse->nsei;
Harald Welte4f127462021-03-02 20:49:10 +01001676 struct ns2_sns_state *gss;
Alexander Couzens6a161492020-07-12 13:45:50 +02001677 struct osmo_fsm_inst *fi;
Alexander Couzens7619ed42021-03-24 17:44:03 +01001678 int rc = 0;
Alexander Couzens6a161492020-07-12 13:45:50 +02001679
1680 if (!nse->bss_sns_fi) {
Harald Weltef2949742021-01-20 14:54:14 +01001681 LOGNSVC(nsvc, LOGL_NOTICE, "Rx %s for NS Instance that has no SNS!\n",
1682 get_value_string(gprs_ns_pdu_strings, nsh->pdu_type));
Alexander Couzens7619ed42021-03-24 17:44:03 +01001683 rc = -EINVAL;
1684 goto out;
Alexander Couzens6a161492020-07-12 13:45:50 +02001685 }
1686
Alexander Couzens6a161492020-07-12 13:45:50 +02001687 /* FIXME: how to resolve SNS FSM Instance by NSEI (SGSN)? */
1688 fi = nse->bss_sns_fi;
Harald Welte4f127462021-03-02 20:49:10 +01001689 gss = (struct ns2_sns_state *) fi->priv;
1690 if (!gss->sns_nsvc)
1691 gss->sns_nsvc = nsvc;
Alexander Couzens6a161492020-07-12 13:45:50 +02001692
Harald Weltef2949742021-01-20 14:54:14 +01001693 LOGPFSML(fi, LOGL_DEBUG, "NSEI=%u Rx SNS PDU type %s\n", nsei,
1694 get_value_string(gprs_ns_pdu_strings, nsh->pdu_type));
1695
Alexander Couzens6a161492020-07-12 13:45:50 +02001696 switch (nsh->pdu_type) {
1697 case SNS_PDUT_SIZE:
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001698 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_RX_SIZE, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001699 break;
1700 case SNS_PDUT_SIZE_ACK:
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001701 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_RX_SIZE_ACK, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001702 break;
1703 case SNS_PDUT_CONFIG:
1704 if (nsh->data[0] & 0x01)
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001705 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_RX_CONFIG_END, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001706 else
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001707 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_RX_CONFIG, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001708 break;
1709 case SNS_PDUT_CONFIG_ACK:
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001710 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_RX_CONFIG_ACK, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001711 break;
1712 case SNS_PDUT_ADD:
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001713 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_RX_ADD, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001714 break;
1715 case SNS_PDUT_DELETE:
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001716 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_RX_DELETE, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001717 break;
1718 case SNS_PDUT_CHANGE_WEIGHT:
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001719 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_RX_CHANGE_WEIGHT, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001720 break;
1721 case SNS_PDUT_ACK:
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001722 osmo_fsm_inst_dispatch(fi, NS2_SNS_EV_RX_ACK, tp);
Alexander Couzens6a161492020-07-12 13:45:50 +02001723 break;
1724 default:
Harald Weltef2949742021-01-20 14:54:14 +01001725 LOGPFSML(fi, LOGL_ERROR, "NSEI=%u Rx unknown SNS PDU type %s\n", nsei,
1726 get_value_string(gprs_ns_pdu_strings, nsh->pdu_type));
Alexander Couzens7619ed42021-03-24 17:44:03 +01001727 rc = -EINVAL;
Alexander Couzens6a161492020-07-12 13:45:50 +02001728 }
1729
Alexander Couzens7619ed42021-03-24 17:44:03 +01001730out:
1731 msgb_free(msg);
1732
1733 return rc;
Alexander Couzens6a161492020-07-12 13:45:50 +02001734}
1735
1736#include <osmocom/vty/vty.h>
1737#include <osmocom/vty/misc.h>
1738
Harald Welte1262c4f2021-01-19 20:58:33 +01001739static 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 +02001740{
1741 struct in_addr in = { .s_addr = ip4->ip_addr };
Harald Welte1262c4f2021-01-19 20:58:33 +01001742 vty_out(vty, "%s %s:%u, Signalling Weight: %u, Data Weight: %u%s", prefix,
Alexander Couzens6a161492020-07-12 13:45:50 +02001743 inet_ntoa(in), ntohs(ip4->udp_port), ip4->sig_weight, ip4->data_weight, VTY_NEWLINE);
1744}
1745
Harald Welte1262c4f2021-01-19 20:58:33 +01001746static 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 +02001747{
1748 char ip_addr[INET6_ADDRSTRLEN] = {};
1749 if (!inet_ntop(AF_INET6, &ip6->ip_addr, ip_addr, (INET6_ADDRSTRLEN)))
1750 strcpy(ip_addr, "Invalid IPv6");
1751
Harald Welte1262c4f2021-01-19 20:58:33 +01001752 vty_out(vty, "%s %s:%u, Signalling Weight: %u, Data Weight: %u%s", prefix,
Alexander Couzens6a161492020-07-12 13:45:50 +02001753 ip_addr, ntohs(ip6->udp_port), ip6->sig_weight, ip6->data_weight, VTY_NEWLINE);
1754}
1755
Harald Welte5bef2cc2020-09-18 22:33:24 +02001756/*! Dump the IP-SNS state to a vty.
1757 * \param[in] vty VTY to which the state shall be printed
Harald Welte1262c4f2021-01-19 20:58:33 +01001758 * \param[in] prefix prefix to print at start of each line (typically indenting)
Harald Welte5bef2cc2020-09-18 22:33:24 +02001759 * \param[in] nse NS Entity whose IP-SNS state shall be printed
1760 * \param[in] stats Whether or not statistics shall also be printed */
Alexander Couzens8dfc24c2021-01-25 16:09:23 +01001761void 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 +02001762{
1763 struct ns2_sns_state *gss;
1764 unsigned int i;
1765
1766 if (!nse->bss_sns_fi)
1767 return;
1768
Harald Welte1262c4f2021-01-19 20:58:33 +01001769 vty_out_fsm_inst2(vty, prefix, nse->bss_sns_fi);
Alexander Couzens6a161492020-07-12 13:45:50 +02001770 gss = (struct ns2_sns_state *) nse->bss_sns_fi->priv;
1771
Harald Welte1262c4f2021-01-19 20:58:33 +01001772 vty_out(vty, "%sMaximum number of remote NS-VCs: %zu, IPv4 Endpoints: %zu, IPv6 Endpoints: %zu%s",
1773 prefix, gss->num_max_nsvcs, gss->num_max_ip4_remote, gss->num_max_ip6_remote, VTY_NEWLINE);
Alexander Couzens6a161492020-07-12 13:45:50 +02001774
Alexander Couzens71128672021-06-05 18:44:01 +02001775 if (gss->local.num_ip4 && gss->remote.num_ip4) {
Harald Welte1262c4f2021-01-19 20:58:33 +01001776 vty_out(vty, "%sLocal IPv4 Endpoints:%s", prefix, VTY_NEWLINE);
Alexander Couzens71128672021-06-05 18:44:01 +02001777 for (i = 0; i < gss->local.num_ip4; i++)
1778 vty_dump_sns_ip4(vty, prefix, &gss->local.ip4[i]);
Alexander Couzens6a161492020-07-12 13:45:50 +02001779
Harald Welte1262c4f2021-01-19 20:58:33 +01001780 vty_out(vty, "%sRemote IPv4 Endpoints:%s", prefix, VTY_NEWLINE);
Alexander Couzens71128672021-06-05 18:44:01 +02001781 for (i = 0; i < gss->remote.num_ip4; i++)
1782 vty_dump_sns_ip4(vty, prefix, &gss->remote.ip4[i]);
Alexander Couzens6a161492020-07-12 13:45:50 +02001783 }
1784
Alexander Couzens71128672021-06-05 18:44:01 +02001785 if (gss->local.num_ip6 && gss->remote.num_ip6) {
Harald Welte1262c4f2021-01-19 20:58:33 +01001786 vty_out(vty, "%sLocal IPv6 Endpoints:%s", prefix, VTY_NEWLINE);
Alexander Couzens71128672021-06-05 18:44:01 +02001787 for (i = 0; i < gss->local.num_ip6; i++)
1788 vty_dump_sns_ip6(vty, prefix, &gss->local.ip6[i]);
Alexander Couzens6a161492020-07-12 13:45:50 +02001789
Harald Welte1262c4f2021-01-19 20:58:33 +01001790 vty_out(vty, "%sRemote IPv6 Endpoints:%s", prefix, VTY_NEWLINE);
Alexander Couzens71128672021-06-05 18:44:01 +02001791 for (i = 0; i < gss->remote.num_ip6; i++)
1792 vty_dump_sns_ip6(vty, prefix, &gss->remote.ip6[i]);
Alexander Couzens6a161492020-07-12 13:45:50 +02001793 }
1794}
1795
Alexander Couzens412bc342020-11-19 05:24:37 +01001796/*! write IP-SNS to a vty
1797 * \param[in] vty VTY to which the state shall be printed
1798 * \param[in] nse NS Entity whose IP-SNS state shall be printed */
Alexander Couzens8dfc24c2021-01-25 16:09:23 +01001799void ns2_sns_write_vty(struct vty *vty, const struct gprs_ns2_nse *nse)
Alexander Couzens412bc342020-11-19 05:24:37 +01001800{
1801 struct ns2_sns_state *gss;
1802 struct osmo_sockaddr_str addr_str;
1803 struct sns_endpoint *endpoint;
1804
1805 if (!nse->bss_sns_fi)
1806 return;
1807
1808 gss = (struct ns2_sns_state *) nse->bss_sns_fi->priv;
1809 llist_for_each_entry(endpoint, &gss->sns_endpoints, list) {
Vadim Yanitskiyd8b70032021-01-05 14:24:09 +01001810 /* It's unlikely that an error happens, but let's better be safe. */
1811 if (osmo_sockaddr_str_from_sockaddr(&addr_str, &endpoint->saddr.u.sas) != 0)
1812 addr_str = (struct osmo_sockaddr_str) { .ip = "<INVALID>" };
Alexander Couzens5fa431c2021-02-08 23:21:54 +01001813 vty_out(vty, " ip-sns-remote %s %u%s", addr_str.ip, addr_str.port, VTY_NEWLINE);
Alexander Couzens412bc342020-11-19 05:24:37 +01001814 }
1815}
1816
Alexander Couzense769f522020-12-07 07:37:07 +01001817static struct sns_endpoint *ns2_get_sns_endpoint(struct ns2_sns_state *state,
1818 const struct osmo_sockaddr *saddr)
1819{
1820 struct sns_endpoint *endpoint;
1821
1822 llist_for_each_entry(endpoint, &state->sns_endpoints, list) {
1823 if (!osmo_sockaddr_cmp(saddr, &endpoint->saddr))
1824 return endpoint;
1825 }
1826
1827 return NULL;
1828}
1829
1830/*! gprs_ns2_sns_add_endpoint
1831 * \param[in] nse
1832 * \param[in] sockaddr
1833 * \return
1834 */
1835int gprs_ns2_sns_add_endpoint(struct gprs_ns2_nse *nse,
1836 const struct osmo_sockaddr *saddr)
1837{
1838 struct ns2_sns_state *gss;
1839 struct sns_endpoint *endpoint;
1840 bool do_selection = false;
1841
1842 if (nse->ll != GPRS_NS2_LL_UDP) {
1843 return -EINVAL;
1844 }
1845
Alexander Couzens138b96f2021-01-25 16:23:29 +01001846 if (nse->dialect != GPRS_NS2_DIALECT_SNS) {
Alexander Couzense769f522020-12-07 07:37:07 +01001847 return -EINVAL;
1848 }
1849
1850 gss = nse->bss_sns_fi->priv;
1851
1852 if (ns2_get_sns_endpoint(gss, saddr))
1853 return -EADDRINUSE;
1854
1855 endpoint = talloc_zero(nse->bss_sns_fi->priv, struct sns_endpoint);
1856 if (!endpoint)
1857 return -ENOMEM;
1858
1859 endpoint->saddr = *saddr;
1860 if (llist_empty(&gss->sns_endpoints))
1861 do_selection = true;
1862
1863 llist_add_tail(&endpoint->list, &gss->sns_endpoints);
1864 if (do_selection)
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001865 osmo_fsm_inst_dispatch(nse->bss_sns_fi, NS2_SNS_EV_REQ_SELECT_ENDPOINT, NULL);
Alexander Couzense769f522020-12-07 07:37:07 +01001866
1867 return 0;
1868}
1869
1870/*! gprs_ns2_sns_del_endpoint
1871 * \param[in] nse
1872 * \param[in] sockaddr
1873 * \return 0 on success, otherwise < 0
1874 */
1875int gprs_ns2_sns_del_endpoint(struct gprs_ns2_nse *nse,
1876 const struct osmo_sockaddr *saddr)
1877{
1878 struct ns2_sns_state *gss;
1879 struct sns_endpoint *endpoint;
1880
1881 if (nse->ll != GPRS_NS2_LL_UDP) {
1882 return -EINVAL;
1883 }
1884
Alexander Couzens138b96f2021-01-25 16:23:29 +01001885 if (nse->dialect != GPRS_NS2_DIALECT_SNS) {
Alexander Couzense769f522020-12-07 07:37:07 +01001886 return -EINVAL;
1887 }
1888
1889 gss = nse->bss_sns_fi->priv;
1890 endpoint = ns2_get_sns_endpoint(gss, saddr);
1891 if (!endpoint)
1892 return -ENOENT;
1893
1894 /* if this is an unused SNS endpoint it's done */
1895 if (gss->initial != endpoint) {
1896 llist_del(&endpoint->list);
1897 talloc_free(endpoint);
1898 return 0;
1899 }
1900
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001901 /* gprs_ns2_free_nsvcs() will trigger NS2_SNS_EV_REQ_NO_NSVC on the last NS-VC
Alexander Couzense769f522020-12-07 07:37:07 +01001902 * and restart SNS SIZE procedure which selects a new initial */
Harald Weltef2949742021-01-20 14:54:14 +01001903 LOGNSE(nse, LOGL_INFO, "Current in-use SNS endpoint is being removed."
Alexander Couzense769f522020-12-07 07:37:07 +01001904 "Closing all NS-VC and restart SNS-SIZE procedure"
1905 "with a remaining SNS endpoint.\n");
1906
1907 /* Continue with the next endpoint in the list.
1908 * Special case if the endpoint is at the start or end of the list */
1909 if (endpoint->list.prev == &gss->sns_endpoints ||
1910 endpoint->list.next == &gss->sns_endpoints)
1911 gss->initial = NULL;
1912 else
1913 gss->initial = llist_entry(endpoint->list.next->prev,
1914 struct sns_endpoint,
1915 list);
1916
1917 llist_del(&endpoint->list);
1918 gprs_ns2_free_nsvcs(nse);
1919 talloc_free(endpoint);
1920
1921 return 0;
1922}
1923
1924/*! gprs_ns2_sns_count
1925 * \param[in] nse NS Entity whose IP-SNS endpoints shall be printed
1926 * \return the count of endpoints or < 0 if NSE doesn't contain sns.
1927 */
1928int gprs_ns2_sns_count(struct gprs_ns2_nse *nse)
1929{
1930 struct ns2_sns_state *gss;
1931 struct sns_endpoint *endpoint;
1932 int count = 0;
1933
1934 if (nse->ll != GPRS_NS2_LL_UDP) {
1935 return -EINVAL;
1936 }
1937
Alexander Couzens138b96f2021-01-25 16:23:29 +01001938 if (nse->dialect != GPRS_NS2_DIALECT_SNS) {
Alexander Couzense769f522020-12-07 07:37:07 +01001939 return -EINVAL;
1940 }
1941
1942 gss = nse->bss_sns_fi->priv;
1943 llist_for_each_entry(endpoint, &gss->sns_endpoints, list)
1944 count++;
1945
1946 return count;
1947}
1948
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001949void ns2_sns_notify_alive(struct gprs_ns2_nse *nse, struct gprs_ns2_vc *nsvc, bool alive)
1950{
1951 struct ns2_sns_state *gss;
1952 struct gprs_ns2_vc *tmp;
1953
1954 if (!nse->bss_sns_fi)
1955 return;
1956
1957 gss = nse->bss_sns_fi->priv;
1958 if(nse->bss_sns_fi->state != GPRS_SNS_ST_CONFIGURED)
1959 return;
1960
1961 if (alive == gss->alive)
1962 return;
1963
1964 /* check if this is the current SNS NS-VC */
1965 if (nsvc == gss->sns_nsvc) {
1966 /* only replace the SNS NS-VC if there are other alive NS-VC.
1967 * There aren't any other alive NS-VC when the SNS fsm just reached CONFIGURED
1968 * and couldn't confirm yet if the NS-VC comes up */
1969 if (gss->alive && !alive)
1970 ns2_sns_replace_nsvc(nsvc);
1971 }
1972
1973 if (alive) {
1974 gss->alive = true;
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001975 osmo_fsm_inst_dispatch(nse->bss_sns_fi, NS2_SNS_EV_REQ_NSVC_ALIVE, NULL);
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001976 } else {
1977 /* is there at least another alive nsvc? */
1978 llist_for_each_entry(tmp, &nse->nsvc, list) {
1979 if (ns2_vc_is_unblocked(tmp))
1980 return;
1981 }
1982
1983 /* all NS-VC have failed */
1984 gss->alive = false;
Alexander Couzens175eb7b2021-07-20 18:41:14 +02001985 osmo_fsm_inst_dispatch(nse->bss_sns_fi, NS2_SNS_EV_REQ_NO_NSVC, NULL);
Alexander Couzensbe7cecc2021-02-03 18:25:27 +01001986 }
1987}
1988
Alexander Couzens6b9d2322021-02-12 03:17:59 +01001989int gprs_ns2_sns_add_bind(struct gprs_ns2_nse *nse,
1990 struct gprs_ns2_vc_bind *bind)
1991{
1992 struct ns2_sns_state *gss;
1993 struct ns2_sns_bind *tmp;
1994
1995 OSMO_ASSERT(nse->bss_sns_fi);
1996 gss = nse->bss_sns_fi->priv;
1997
1998 if (!gprs_ns2_is_ip_bind(bind)) {
1999 return -EINVAL;
2000 }
2001
2002 if (!llist_empty(&gss->binds)) {
2003 llist_for_each_entry(tmp, &gss->binds, list) {
2004 if (tmp->bind == bind)
2005 return -EALREADY;
2006 }
2007 }
2008
2009 tmp = talloc_zero(gss, struct ns2_sns_bind);
2010 if (!tmp)
2011 return -ENOMEM;
2012 tmp->bind = bind;
2013 llist_add_tail(&tmp->list, &gss->binds);
2014
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002015 osmo_fsm_inst_dispatch(nse->bss_sns_fi, NS2_SNS_EV_REQ_ADD_BIND, tmp);
Alexander Couzens6b9d2322021-02-12 03:17:59 +01002016 return 0;
2017}
2018
2019/* Remove a bind from the SNS. All assosiated NSVC must be removed. */
2020int gprs_ns2_sns_del_bind(struct gprs_ns2_nse *nse,
2021 struct gprs_ns2_vc_bind *bind)
2022{
2023 struct ns2_sns_state *gss;
2024 struct ns2_sns_bind *tmp, *tmp2;
2025 bool found = false;
2026
2027 if (!nse->bss_sns_fi)
2028 return -EINVAL;
2029
2030 gss = nse->bss_sns_fi->priv;
2031 if (gss->initial_bind && gss->initial_bind->bind == bind) {
2032 if (gss->initial_bind->list.prev == &gss->binds)
2033 gss->initial_bind = NULL;
2034 else
2035 gss->initial_bind = llist_entry(gss->initial_bind->list.prev, struct ns2_sns_bind, list);
2036 }
2037
2038 llist_for_each_entry_safe(tmp, tmp2, &gss->binds, list) {
2039 if (tmp->bind == bind) {
2040 llist_del(&tmp->list);
2041 found = true;
Alexander Couzensa35c2962021-04-19 03:30:15 +02002042 break;
Alexander Couzens6b9d2322021-02-12 03:17:59 +01002043 }
2044 }
2045
2046 if (!found)
2047 return -ENOENT;
2048
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002049 osmo_fsm_inst_dispatch(nse->bss_sns_fi, NS2_SNS_EV_REQ_DELETE_BIND, tmp);
Alexander Couzens6b9d2322021-02-12 03:17:59 +01002050 return 0;
2051}
2052
Alexander Couzens71128672021-06-05 18:44:01 +02002053/* Update SNS weights for a bind (local endpoint).
2054 * \param[in] bind the bind which has been updated
Alexander Couzensc4704762021-02-08 23:13:12 +01002055 */
2056void ns2_sns_update_weights(struct gprs_ns2_vc_bind *bind)
2057{
2058 /* TODO: implement weights after binds per sns implemented */
2059}
2060
Harald Welte4f127462021-03-02 20:49:10 +01002061
2062
2063
2064/***********************************************************************
2065 * SGSN role
2066 ***********************************************************************/
2067
Alexander Couzensa2707822021-07-20 18:59:40 +02002068/* cleanup all state. If nsvc is given, don't remove this nsvc. (nsvc is given when a SIZE PDU received) */
2069static void ns2_clear_sgsn(struct ns2_sns_state *gss, struct gprs_ns2_vc *size_nsvc)
2070{
2071 struct gprs_ns2_vc *nsvc, *nsvc2;
2072
2073 ns2_clear_elems(&gss->local);
2074 ns2_clear_elems(&gss->remote);
2075 llist_for_each_entry_safe(nsvc, nsvc2, &gss->nse->nsvc, list) {
2076 /* Ignore the NSVC over which the SIZE PDU got received */
2077 if (size_nsvc && size_nsvc == nsvc)
2078 continue;
2079
2080 gprs_ns2_free_nsvc(nsvc);
2081 }
2082}
2083
2084static void ns2_sns_st_sgsn_unconfigured_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
2085{
2086 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2087
2088 ns2_clear_sgsn(gss, NULL);
2089}
2090
Harald Welte4f127462021-03-02 20:49:10 +01002091static void ns2_sns_st_sgsn_unconfigured(struct osmo_fsm_inst *fi, uint32_t event, void *data)
2092{
2093 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2094 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2095 /* do nothing; Rx SNS-SIZE handled in ns2_sns_st_all_action_sgsn() */
2096}
2097
2098/* We're waiting for inbound SNS-CONFIG from the BSS */
2099static void ns2_sns_st_sgsn_wait_config(struct osmo_fsm_inst *fi, uint32_t event, void *data)
2100{
2101 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2102 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
2103 struct gprs_ns2_inst *nsi = nse->nsi;
2104 uint8_t cause;
2105 int rc;
2106
2107 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2108
2109 switch (event) {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002110 case NS2_SNS_EV_RX_CONFIG:
2111 case NS2_SNS_EV_RX_CONFIG_END:
Harald Welte4f127462021-03-02 20:49:10 +01002112 rc = ns_sns_append_remote_eps(fi, data);
2113 if (rc < 0) {
2114 cause = -rc;
2115 ns2_tx_sns_config_ack(gss->sns_nsvc, &cause);
2116 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
2117 return;
2118 }
2119 /* only change state if last CONFIG was received */
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002120 if (event == NS2_SNS_EV_RX_CONFIG_END) {
Harald Welte4f127462021-03-02 20:49:10 +01002121 /* ensure sum of data weight / sig weights is > 0 */
Alexander Couzens019da4b2021-06-06 02:48:18 +02002122 if (ip46_weight_sum_data(&gss->remote) == 0 || ip46_weight_sum_sig(&gss->remote) == 0) {
Harald Welte4f127462021-03-02 20:49:10 +01002123 cause = NS_CAUSE_INVAL_WEIGH;
2124 ns2_tx_sns_config_ack(gss->sns_nsvc, &cause);
2125 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
2126 break;
2127 }
2128 ns2_tx_sns_config_ack(gss->sns_nsvc, NULL);
2129 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK, nsi->timeout[NS_TOUT_TSNS_PROV], 3);
2130 } else {
2131 /* just send CONFIG-ACK */
2132 ns2_tx_sns_config_ack(gss->sns_nsvc, NULL);
2133 osmo_timer_schedule(&fi->timer, nse->nsi->timeout[NS_TOUT_TSNS_PROV], 0);
2134 }
2135 break;
2136 }
2137}
2138
2139static void ns2_sns_st_sgsn_wait_config_ack_onenter(struct osmo_fsm_inst *fi, uint32_t old_state)
2140{
2141 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2142 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2143
Harald Welte4f127462021-03-02 20:49:10 +01002144 /* transmit SGSN-oriented SNS-CONFIG */
Alexander Couzens71128672021-06-05 18:44:01 +02002145 ns2_tx_sns_config(gss->sns_nsvc, true, gss->local.ip4, gss->local.num_ip4,
2146 gss->local.ip6, gss->local.num_ip6);
Harald Welte4f127462021-03-02 20:49:10 +01002147}
2148
2149/* We're waiting for SNS-CONFIG-ACK from the BSS (in response to our outbound SNS-CONFIG) */
2150static void ns2_sns_st_sgsn_wait_config_ack(struct osmo_fsm_inst *fi, uint32_t event, void *data)
2151{
2152 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2153 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
2154 struct tlv_parsed *tp = NULL;
2155
2156 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2157
2158 switch (event) {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002159 case NS2_SNS_EV_RX_CONFIG_ACK:
Harald Welte4f127462021-03-02 20:49:10 +01002160 tp = data;
2161 if (TLVP_VAL_MINLEN(tp, NS_IE_CAUSE, 1)) {
2162 LOGPFSML(fi, LOGL_ERROR, "Rx SNS-CONFIG-ACK with cause %s\n",
2163 gprs_ns2_cause_str(*TLVP_VAL(tp, NS_IE_CAUSE)));
2164 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, 0, 0);
2165 break;
2166 }
2167 /* we currently only send one SNS-CONFIG with END FLAG */
2168 if (true) {
2169 create_missing_nsvcs(fi);
2170 /* start the test procedure on ALL NSVCs! */
2171 gprs_ns2_start_alive_all_nsvcs(nse);
2172 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_CONFIGURED, ns_sns_configured_timeout(fi), 4);
2173 }
2174 break;
2175 }
2176}
2177
2178/* SGSN-side SNS state machine */
2179static const struct osmo_fsm_state ns2_sns_sgsn_states[] = {
2180 [GPRS_SNS_ST_UNCONFIGURED] = {
2181 .in_event_mask = 0, /* handled by all_state_action */
2182 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
2183 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG),
2184 .name = "UNCONFIGURED",
2185 .action = ns2_sns_st_sgsn_unconfigured,
Alexander Couzensa2707822021-07-20 18:59:40 +02002186 .onenter = ns2_sns_st_sgsn_unconfigured_onenter,
Harald Welte4f127462021-03-02 20:49:10 +01002187 },
2188 [GPRS_SNS_ST_SGSN_WAIT_CONFIG] = {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002189 .in_event_mask = S(NS2_SNS_EV_RX_CONFIG) |
2190 S(NS2_SNS_EV_RX_CONFIG_END),
Harald Welte4f127462021-03-02 20:49:10 +01002191 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
2192 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG) |
2193 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK),
2194 .name = "SGSN_WAIT_CONFIG",
2195 .action = ns2_sns_st_sgsn_wait_config,
2196 },
2197 [GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK] = {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002198 .in_event_mask = S(NS2_SNS_EV_RX_CONFIG_ACK),
Harald Welte4f127462021-03-02 20:49:10 +01002199 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
Alexander Couzensa2707822021-07-20 18:59:40 +02002200 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG) |
Harald Welte4f127462021-03-02 20:49:10 +01002201 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK) |
2202 S(GPRS_SNS_ST_CONFIGURED),
2203 .name = "SGSN_WAIT_CONFIG_ACK",
2204 .action = ns2_sns_st_sgsn_wait_config_ack,
2205 .onenter = ns2_sns_st_sgsn_wait_config_ack_onenter,
2206 },
2207 [GPRS_SNS_ST_CONFIGURED] = {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002208 .in_event_mask = S(NS2_SNS_EV_RX_ADD) |
2209 S(NS2_SNS_EV_RX_DELETE) |
2210 S(NS2_SNS_EV_RX_CHANGE_WEIGHT) |
2211 S(NS2_SNS_EV_REQ_NSVC_ALIVE),
Alexander Couzensa2707822021-07-20 18:59:40 +02002212 .out_state_mask = S(GPRS_SNS_ST_UNCONFIGURED) |
2213 S(GPRS_SNS_ST_SGSN_WAIT_CONFIG),
Harald Welte4f127462021-03-02 20:49:10 +01002214 .name = "CONFIGURED",
2215 /* shared with BSS side; once configured there's no difference */
2216 .action = ns2_sns_st_configured,
2217 .onenter = ns2_sns_st_configured_onenter,
2218 },
2219};
2220
2221static int ns2_sns_fsm_sgsn_timer_cb(struct osmo_fsm_inst *fi)
2222{
2223 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2224 struct gprs_ns2_nse *nse = nse_inst_from_fi(fi);
2225 struct gprs_ns2_inst *nsi = nse->nsi;
2226
2227 gss->N++;
2228 switch (fi->T) {
2229 case 3:
2230 if (gss->N >= nsi->timeout[NS_TOUT_TSNS_CONFIG_RETRIES]) {
2231 LOGPFSML(fi, LOGL_ERROR, "NSE %d: SGSN Config retries failed. Giving up.\n", nse->nsei);
2232 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_UNCONFIGURED, nsi->timeout[NS_TOUT_TSNS_PROV], 3);
2233 } else {
2234 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_SGSN_WAIT_CONFIG_ACK, nsi->timeout[NS_TOUT_TSNS_PROV], 3);
2235 }
2236 break;
2237 case 4:
2238 LOGPFSML(fi, LOGL_ERROR, "NSE %d: Config succeeded but no NS-VC came online.\n", nse->nsei);
2239 break;
2240 }
2241 return 0;
2242}
2243
2244
2245/* allstate-action for SGSN role */
2246static void ns2_sns_st_all_action_sgsn(struct osmo_fsm_inst *fi, uint32_t event, void *data)
2247{
2248 struct ns2_sns_state *gss = (struct ns2_sns_state *) fi->priv;
2249 struct tlv_parsed *tp = NULL;
Harald Welte01fa6a32021-03-04 19:49:38 +01002250 size_t num_local_eps, num_remote_eps;
Harald Welte4f127462021-03-02 20:49:10 +01002251 uint8_t flag;
Harald Weltea2c5af52021-03-04 17:59:35 +01002252 uint8_t cause;
Harald Welte4f127462021-03-02 20:49:10 +01002253
2254 OSMO_ASSERT(gss->role == GPRS_SNS_ROLE_SGSN);
2255
2256 switch (event) {
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002257 case NS2_SNS_EV_RX_SIZE:
Harald Welte4f127462021-03-02 20:49:10 +01002258 tp = (struct tlv_parsed *) data;
Harald Weltea2c5af52021-03-04 17:59:35 +01002259 /* check for mandatory / conditional IEs */
2260 if (!TLVP_PRES_LEN(tp, NS_IE_RESET_FLAG, 1) ||
2261 !TLVP_PRES_LEN(tp, NS_IE_MAX_NR_NSVC, 2)) {
2262 cause = NS_CAUSE_MISSING_ESSENT_IE;
2263 ns2_tx_sns_size_ack(gss->sns_nsvc, &cause);
Alexander Couzens1c405252021-06-13 00:14:48 +02002264 if (fi->state == GPRS_SNS_ST_UNCONFIGURED)
2265 sns_failed(fi, "Rx Size: Missing essential IE");
Harald Weltea2c5af52021-03-04 17:59:35 +01002266 break;
2267 }
2268 if (!TLVP_PRES_LEN(tp, NS_IE_IPv4_EP_NR, 2) &&
2269 !TLVP_PRES_LEN(tp, NS_IE_IPv6_EP_NR, 2)) {
2270 cause = NS_CAUSE_MISSING_ESSENT_IE;
Harald Welte4f127462021-03-02 20:49:10 +01002271 ns2_tx_sns_size_ack(gss->sns_nsvc, &cause);
Alexander Couzens1c405252021-06-13 00:14:48 +02002272 if (fi->state == GPRS_SNS_ST_UNCONFIGURED)
2273 sns_failed(fi, "Rx Size: Missing essential IE");
Harald Welte4f127462021-03-02 20:49:10 +01002274 break;
2275 }
Harald Welte01fa6a32021-03-04 19:49:38 +01002276 if (TLVP_PRES_LEN(tp, NS_IE_IPv4_EP_NR, 2))
2277 gss->num_max_ip4_remote = tlvp_val16be(tp, NS_IE_IPv4_EP_NR);
2278 if (TLVP_PRES_LEN(tp, NS_IE_IPv6_EP_NR, 2))
2279 gss->num_max_ip6_remote = tlvp_val16be(tp, NS_IE_IPv6_EP_NR);
2280 /* decide if we go for IPv4 or IPv6 */
Alexander Couzens077ce5a2021-06-06 01:32:45 +02002281 if (gss->num_max_ip6_remote && ns2_sns_count_num_local_ep(fi, AF_INET6)) {
2282 gss->family = AF_INET6;
Harald Welte2d807b62021-03-24 01:57:30 +01002283 ns2_sns_compute_local_ep_from_binds(fi);
Alexander Couzens71128672021-06-05 18:44:01 +02002284 num_local_eps = gss->local.num_ip6;
Harald Welte01fa6a32021-03-04 19:49:38 +01002285 num_remote_eps = gss->num_max_ip6_remote;
Alexander Couzens077ce5a2021-06-06 01:32:45 +02002286 } else if (gss->num_max_ip4_remote && ns2_sns_count_num_local_ep(fi, AF_INET)) {
2287 gss->family = AF_INET;
Harald Welte2d807b62021-03-24 01:57:30 +01002288 ns2_sns_compute_local_ep_from_binds(fi);
Alexander Couzens71128672021-06-05 18:44:01 +02002289 num_local_eps = gss->local.num_ip4;
Harald Welte01fa6a32021-03-04 19:49:38 +01002290 num_remote_eps = gss->num_max_ip4_remote;
2291 } else {
Alexander Couzens71128672021-06-05 18:44:01 +02002292 if (gss->local.num_ip4 && !gss->num_max_ip4_remote)
Harald Welte01fa6a32021-03-04 19:49:38 +01002293 cause = NS_CAUSE_INVAL_NR_IPv4_EP;
2294 else
2295 cause = NS_CAUSE_INVAL_NR_IPv6_EP;
2296 ns2_tx_sns_size_ack(gss->sns_nsvc, &cause);
Alexander Couzens1c405252021-06-13 00:14:48 +02002297 if (fi->state == GPRS_SNS_ST_UNCONFIGURED)
2298 sns_failed(fi, "Rx Size: Invalid Nr of IPv4/IPv6 EPs");
Harald Welte01fa6a32021-03-04 19:49:38 +01002299 break;
2300 }
Harald Welte01fa6a32021-03-04 19:49:38 +01002301 /* ensure number of NS-VCs is sufficient for full mesh */
2302 gss->num_max_nsvcs = tlvp_val16be(tp, NS_IE_MAX_NR_NSVC);
2303 if (gss->num_max_nsvcs < num_remote_eps * num_local_eps) {
2304 LOGPFSML(fi, LOGL_ERROR, "%zu local and %zu remote EPs, requires %zu NS-VC, "
2305 "but BSS supports only %zu maximum NS-VCs\n", num_local_eps,
2306 num_remote_eps, num_local_eps * num_remote_eps, gss->num_max_nsvcs);
2307 cause = NS_CAUSE_INVAL_NR_NS_VC;
2308 ns2_tx_sns_size_ack(gss->sns_nsvc, &cause);
Alexander Couzens1c405252021-06-13 00:14:48 +02002309 if (fi->state == GPRS_SNS_ST_UNCONFIGURED)
2310 sns_failed(fi, NULL);
Harald Welte01fa6a32021-03-04 19:49:38 +01002311 break;
2312 }
2313 /* perform state reset, if requested */
Harald Welte4f127462021-03-02 20:49:10 +01002314 flag = *TLVP_VAL(tp, NS_IE_RESET_FLAG);
2315 if (flag & 1) {
Harald Welte4f127462021-03-02 20:49:10 +01002316 /* clear all state */
Alexander Couzensa2707822021-07-20 18:59:40 +02002317 /* TODO: ensure gss->sns_nsvc is always the NSVC on which we received the SIZE PDU */
Harald Welte4f127462021-03-02 20:49:10 +01002318 gss->N = 0;
Alexander Couzensa2707822021-07-20 18:59:40 +02002319 ns2_clear_sgsn(gss, gss->sns_nsvc);
2320 /* keep the NSVC we need for SNS, but unconfigure it */
2321 gss->sns_nsvc->sig_weight = 0;
2322 gss->sns_nsvc->data_weight = 0;
2323 ns2_vc_force_unconfigured(gss->sns_nsvc);
Harald Welte2d807b62021-03-24 01:57:30 +01002324 ns2_sns_compute_local_ep_from_binds(fi);
Harald Welte4f127462021-03-02 20:49:10 +01002325 }
Alexander Couzens1c405252021-06-13 00:14:48 +02002326
2327 if (fi->state == GPRS_SNS_ST_UNCONFIGURED && !(flag & 1)) {
2328 sns_failed(fi, "Rx Size without Reset flag, but NSE is unknown");
2329 break;
2330 }
2331
Harald Welte4f127462021-03-02 20:49:10 +01002332 /* send SIZE_ACK */
2333 ns2_tx_sns_size_ack(gss->sns_nsvc, NULL);
2334 /* only wait for SNS-CONFIG in case of Reset flag */
2335 if (flag & 1)
2336 osmo_fsm_inst_state_chg(fi, GPRS_SNS_ST_SGSN_WAIT_CONFIG, 0, 0);
2337 break;
Alexander Couzens83f06ce2021-08-06 19:50:09 +02002338 case NS2_SNS_EV_REQ_FREE_NSVCS:
2339 sns_failed(fi, "On user request to free all NSVCs");
2340 break;
Harald Welte4f127462021-03-02 20:49:10 +01002341 default:
2342 ns2_sns_st_all_action(fi, event, data);
2343 break;
2344 }
2345}
2346
2347static struct osmo_fsm gprs_ns2_sns_sgsn_fsm = {
2348 .name = "GPRS-NS2-SNS-SGSN",
2349 .states = ns2_sns_sgsn_states,
2350 .num_states = ARRAY_SIZE(ns2_sns_sgsn_states),
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002351 .allstate_event_mask = S(NS2_SNS_EV_RX_SIZE) |
2352 S(NS2_SNS_EV_REQ_NO_NSVC) |
Alexander Couzens83f06ce2021-08-06 19:50:09 +02002353 S(NS2_SNS_EV_REQ_FREE_NSVCS) |
Alexander Couzens175eb7b2021-07-20 18:41:14 +02002354 S(NS2_SNS_EV_REQ_ADD_BIND) |
2355 S(NS2_SNS_EV_REQ_DELETE_BIND),
Harald Welte4f127462021-03-02 20:49:10 +01002356 .allstate_action = ns2_sns_st_all_action_sgsn,
2357 .cleanup = NULL,
2358 .timer_cb = ns2_sns_fsm_sgsn_timer_cb,
2359 .event_names = gprs_sns_event_names,
2360 .pre_term = NULL,
2361 .log_subsys = DLNS,
2362};
2363
2364/*! Allocate an IP-SNS FSM for the SGSN side.
2365 * \param[in] nse NS Entity in which the FSM runs
2366 * \param[in] id string identifier
2367 * \returns FSM instance on success; NULL on error */
2368struct osmo_fsm_inst *ns2_sns_sgsn_fsm_alloc(struct gprs_ns2_nse *nse, const char *id)
2369{
2370 struct osmo_fsm_inst *fi;
2371 struct ns2_sns_state *gss;
2372
2373 fi = osmo_fsm_inst_alloc(&gprs_ns2_sns_sgsn_fsm, nse, NULL, LOGL_DEBUG, id);
2374 if (!fi)
2375 return fi;
2376
2377 gss = talloc_zero(fi, struct ns2_sns_state);
2378 if (!gss)
2379 goto err;
2380
2381 fi->priv = gss;
2382 gss->nse = nse;
2383 gss->role = GPRS_SNS_ROLE_SGSN;
2384 INIT_LLIST_HEAD(&gss->sns_endpoints);
2385 INIT_LLIST_HEAD(&gss->binds);
2386
2387 return fi;
2388err:
2389 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
2390 return NULL;
2391}
2392
2393
2394
2395
Alexander Couzens6a161492020-07-12 13:45:50 +02002396/* initialize osmo_ctx on main tread */
2397static __attribute__((constructor)) void on_dso_load_ctx(void)
2398{
2399 OSMO_ASSERT(osmo_fsm_register(&gprs_ns2_sns_bss_fsm) == 0);
Harald Welte4f127462021-03-02 20:49:10 +01002400 OSMO_ASSERT(osmo_fsm_register(&gprs_ns2_sns_sgsn_fsm) == 0);
Alexander Couzens6a161492020-07-12 13:45:50 +02002401}