blob: f9dea98e4fb738b10408d8bbb2e40f5cc3402c50 [file] [log] [blame]
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +01001/* nacc_fsm.c
2 *
3 * Copyright (C) 2021 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
4 * Author: Pau Espin Pedrol <pespin@sysmocom.de>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
21#include <unistd.h>
22
23#include <talloc.h>
24
25#include <osmocom/core/rate_ctr.h>
26#include <osmocom/ctrl/control_cmd.h>
27#include <osmocom/ctrl/control_if.h>
28
29#include <osmocom/gsm/gsm48.h>
30#include <osmocom/gprs/gprs_bssgp.h>
31#include <osmocom/gprs/gprs_bssgp_rim.h>
32
33#include <nacc_fsm.h>
34#include <gprs_rlcmac.h>
35#include <gprs_debug.h>
36#include <gprs_ms.h>
37#include <encoding.h>
38#include <bts.h>
39#include <neigh_cache.h>
40
41#define X(s) (1 << (s))
42
Pau Espin Pedrol41a22a72021-01-26 19:00:37 +010043static const struct osmo_tdef_state_timeout nacc_fsm_timeouts[32] = {
44 [NACC_ST_INITIAL] = {},
45 [NACC_ST_WAIT_RESOLVE_RAC_CI] = { .T = PCU_TDEF_NEIGH_RESOLVE_TO },
46 [NACC_ST_WAIT_REQUEST_SI] = { .T = PCU_TDEF_SI_RESOLVE_TO },
47 [NACC_ST_TX_NEIGHBOUR_DATA] = {},
48 [NACC_ST_TX_CELL_CHG_CONTINUE] = {},
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +010049 [NACC_ST_WAIT_CELL_CHG_CONTINUE_ACK] = {}, /* Timeout through event controlled by tbf::poll_timeout() */
Pau Espin Pedrol41a22a72021-01-26 19:00:37 +010050 [NACC_ST_DONE] = {},
51};
52
53/* Transition to a state, using the T timer defined in assignment_fsm_timeouts.
54 * The actual timeout value is in turn obtained from conn->T_defs.
55 * Assumes local variable fi exists. */
56
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +010057#define nacc_fsm_state_chg(fi, NEXT_STATE) \
Pau Espin Pedrol41a22a72021-01-26 19:00:37 +010058 osmo_tdef_fsm_inst_state_chg(fi, NEXT_STATE, \
59 nacc_fsm_timeouts, \
60 ((struct nacc_fsm_ctx*)(fi->priv))->ms->bts->pcu->T_defs, \
61 -1)
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +010062
63const struct value_string nacc_fsm_event_names[] = {
64 { NACC_EV_RX_CELL_CHG_NOTIFICATION, "RX_CELL_CHG_NOTIFICATION" },
65 { NACC_EV_RX_RAC_CI, "RX_RAC_CI" },
66 { NACC_EV_RX_SI, "RX_SI" },
67 { NACC_EV_CREATE_RLCMAC_MSG, "CREATE_RLCMAC_MSG" },
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +010068 { NACC_EV_RX_CELL_CHG_CONTINUE_ACK, "RX_CELL_CHG_CONTINUE_ACK"},
69 { NACC_EV_TIMEOUT_CELL_CHG_CONTINUE, "TIMEOUT_CELL_CHG_CONTINUE" },
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +010070 { 0, NULL }
71};
72
73/* TS 44 060 11.2.9e Packet Neighbour Cell Data */
74static struct msgb *create_packet_neighbour_cell_data(struct nacc_fsm_ctx *ctx,
75 const struct gprs_rlcmac_tbf *tbf,
76 bool *all_si_info_sent)
77{
78 struct msgb *msg;
79 int rc;
80 RlcMacDownlink_t *mac_control_block;
81 struct GprsMs *ms = tbf_ms(tbf);
82 OSMO_ASSERT(tbf_is_tfi_assigned(tbf));
83 uint8_t tfi_is_dl = tbf_direction(tbf) == GPRS_RLCMAC_DL_TBF;
84 uint8_t tfi = tbf_tfi(tbf);
85 uint8_t container_id = 0;
86 PNCDContainer_t container;
87 size_t max_len, len_to_write;
88 uint8_t *cont_buf;
89 uint8_t si_type = ctx->si_info.type_psi ? 0x01 : 0x0;
90
91 memset(&container, 0, sizeof(container));
92 if (ctx->container_idx == 0) {
93 container.UnionType = 1; /* with ID */
94 container.u.PNCD_Container_With_ID.ARFCN = ctx->neigh_key.tgt_arfcn;
95 container.u.PNCD_Container_With_ID.BSIC = ctx->neigh_key.tgt_bsic;
96 cont_buf = &container.u.PNCD_Container_With_ID.CONTAINER[0];
97 max_len = sizeof(container.u.PNCD_Container_With_ID.CONTAINER) - 1;
98 } else {
99 container.UnionType = 0; /* without ID */
100 cont_buf = &container.u.PNCD_Container_Without_ID.CONTAINER[0];
101 max_len = sizeof(container.u.PNCD_Container_Without_ID.CONTAINER) - 1;
102 }
103
104 len_to_write = ctx->si_info.si_len - ctx->si_info_bytes_sent;
105
106 if (len_to_write == 0) {
107 /* We sent all info on last message filing it exactly, we now send a zeroed one to finish */
108 *all_si_info_sent = true;
109 *cont_buf = (si_type << 5) | 0x00;
110 } else if (len_to_write >= max_len) {
111 /* We fill the rlcmac block, we'll need more messages */
112 *all_si_info_sent = false;
113 *cont_buf = (si_type << 5) | 0x1F;
114 memcpy(cont_buf + 1, &ctx->si_info.si_buf[ctx->si_info_bytes_sent], max_len);
115 ctx->si_info_bytes_sent += max_len;
116 } else {
117 /* Last block, we don't fill it exactly */
118 *all_si_info_sent = true;
119 *cont_buf = (si_type << 5) | (len_to_write & 0x1F);
120 memcpy(cont_buf + 1, &ctx->si_info.si_buf[ctx->si_info_bytes_sent], len_to_write);
121 ctx->si_info_bytes_sent += len_to_write;
122 }
123
124 msg = msgb_alloc(GSM_MACBLOCK_LEN, "neighbour_cell_data");
125 if (!msg)
126 return NULL;
127
128 /* Initialize a bit vector that uses allocated msgb as the data buffer. */
129 struct bitvec bv = {
130 .data = msgb_put(msg, GSM_MACBLOCK_LEN),
131 .data_len = GSM_MACBLOCK_LEN,
132 };
133 bitvec_unhex(&bv, DUMMY_VEC);
134
135 mac_control_block = (RlcMacDownlink_t *)talloc_zero(ctx->ms, RlcMacDownlink_t);
136
137 write_packet_neighbour_cell_data(mac_control_block,
138 tfi_is_dl, tfi, container_id,
139 ctx->container_idx, &container);
140 LOGP(DNACC, LOGL_DEBUG, "+++++++++++++++++++++++++ TX : Packet Neighbour Cell Data +++++++++++++++++++++++++\n");
141 rc = encode_gsm_rlcmac_downlink(&bv, mac_control_block);
142 if (rc < 0) {
143 LOGP(DTBF, LOGL_ERROR, "Encoding of Packet Neighbour Cell Data failed (%d)\n", rc);
144 goto free_ret;
145 }
146 LOGP(DNACC, LOGL_DEBUG, "------------------------- TX : Packet Neighbour Cell Data -------------------------\n");
147 rate_ctr_inc(&bts_rate_counters(ms->bts)->ctr[CTR_PKT_NEIGH_CELL_DATA]);
148 talloc_free(mac_control_block);
149
150 ctx->container_idx++;
151
152 return msg;
153
154free_ret:
155 talloc_free(mac_control_block);
156 msgb_free(msg);
157 return NULL;
158}
159
160/* TS 44 060 11.2.2a Packet Cell Change Continue */
161static struct msgb *create_packet_cell_chg_continue(const struct nacc_fsm_ctx *ctx,
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +0100162 const struct nacc_ev_create_rlcmac_msg_ctx *data,
163 uint32_t *new_poll_fn)
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100164{
165 struct msgb *msg;
166 int rc;
167 RlcMacDownlink_t *mac_control_block;
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +0100168 struct gprs_rlcmac_tbf *tbf = data->tbf;
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100169 struct GprsMs *ms = tbf_ms(tbf);
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +0100170 unsigned int rrbp;
171
172 rc = tbf_check_polling(tbf, data->fn, data->ts, new_poll_fn, &rrbp);
173 if (rc < 0) {
174 LOGP(DTBF, LOGL_ERROR, "Failed registering poll for Pkt Cell Chg Continue (%d)\n", rc);
175 return NULL;
176 }
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100177
178 msg = msgb_alloc(GSM_MACBLOCK_LEN, "pkt_cell_chg_continue");
179 if (!msg)
180 return NULL;
181
182 /* Initialize a bit vector that uses allocated msgb as the data buffer. */
183 struct bitvec bv = {
184 .data = msgb_put(msg, GSM_MACBLOCK_LEN),
185 .data_len = GSM_MACBLOCK_LEN,
186 };
187 bitvec_unhex(&bv, DUMMY_VEC);
188
189 mac_control_block = (RlcMacDownlink_t *)talloc_zero(ctx->ms, RlcMacDownlink_t);
190
191 OSMO_ASSERT(tbf_is_tfi_assigned(tbf));
192 uint8_t tfi_is_dl = tbf_direction(tbf) == GPRS_RLCMAC_DL_TBF;
193 uint8_t tfi = tbf_tfi(tbf);
194 uint8_t container_id = 0;
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +0100195 write_packet_cell_change_continue(mac_control_block, 1, rrbp, tfi_is_dl, tfi, true,
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100196 ctx->neigh_key.tgt_arfcn, ctx->neigh_key.tgt_bsic, container_id);
197 LOGP(DNACC, LOGL_DEBUG, "+++++++++++++++++++++++++ TX : Packet Cell Change Continue +++++++++++++++++++++++++\n");
198 rc = encode_gsm_rlcmac_downlink(&bv, mac_control_block);
199 if (rc < 0) {
200 LOGP(DTBF, LOGL_ERROR, "Encoding of Packet Cell Change Continue failed (%d)\n", rc);
201 goto free_ret;
202 }
203 LOGP(DNACC, LOGL_DEBUG, "------------------------- TX : Packet Cell Change Continue -------------------------\n");
204 rate_ctr_inc(&bts_rate_counters(ms->bts)->ctr[CTR_PKT_CELL_CHG_CONTINUE]);
205 talloc_free(mac_control_block);
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +0100206 tbf_set_polling(tbf, *new_poll_fn, data->ts, GPRS_RLCMAC_POLL_CELL_CHG_CONTINUE);
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100207 return msg;
208
209free_ret:
210 talloc_free(mac_control_block);
211 msgb_free(msg);
212 return NULL;
213}
214
215static int fill_rim_ran_info_req(const struct nacc_fsm_ctx *ctx, struct bssgp_ran_information_pdu *pdu)
216{
217 struct gprs_rlcmac_bts *bts = ctx->ms->bts;
218
219 *pdu = (struct bssgp_ran_information_pdu){
220 .routing_info_dest = {
221 .discr = BSSGP_RIM_ROUTING_INFO_GERAN,
222 .geran = {
223 .raid = {
224 .mcc = ctx->cgi_ps.rai.lac.plmn.mcc,
225 .mnc = ctx->cgi_ps.rai.lac.plmn.mnc,
226 .mnc_3_digits = ctx->cgi_ps.rai.lac.plmn.mnc_3_digits,
227 .lac = ctx->cgi_ps.rai.lac.lac,
228 .rac = ctx->cgi_ps.rai.rac,
229 },
230 .cid = ctx->cgi_ps.cell_identity,
231 },
232 },
233 .routing_info_src = {
234 .discr = BSSGP_RIM_ROUTING_INFO_GERAN,
235 .geran = {
236 .raid = {
237 .mcc = bts->cgi_ps.rai.lac.plmn.mcc,
238 .mnc = bts->cgi_ps.rai.lac.plmn.mnc,
239 .mnc_3_digits = bts->cgi_ps.rai.lac.plmn.mnc_3_digits,
240 .lac = bts->cgi_ps.rai.lac.lac,
241 .rac = bts->cgi_ps.rai.rac,
242 },
243 .cid = bts->cgi_ps.cell_identity,
244 },
245 },
246 .rim_cont_iei = BSSGP_IE_RI_REQ_RIM_CONTAINER,
247 .decoded_present = true,
248 .decoded = {
249 .req_rim_cont = {
250 .app_id = BSSGP_RAN_INF_APP_ID_NACC,
251 .seq_num = 1,
252 .pdu_ind = {
253 .ack_requested = 0,
254 .pdu_type_ext = RIM_PDU_TYPE_SING_REP,
255 },
256 .prot_ver = 1,
257 .son_trans_app_id = NULL,
258 .son_trans_app_id_len = 0,
259 .u = {
260 .app_cont_nacc = {
261 .reprt_cell = ctx->cgi_ps,
262 },
263 },
264 },
265 },
266 };
267
268 return 0;
269}
270
Pau Espin Pedrol0c10b3c2021-02-10 17:12:02 +0100271static int fill_neigh_key_from_bts_pkt_cell_chg_not(struct neigh_cache_entry_key *neigh_key,
272 const struct gprs_rlcmac_bts *bts,
273 const Packet_Cell_Change_Notification_t *notif)
274{
275 switch (notif->Target_Cell.UnionType) {
276 case 0: /* GSM */
277 neigh_key->local_lac = bts->cgi_ps.rai.lac.lac;
278 neigh_key->local_ci = bts->cgi_ps.cell_identity;
279 neigh_key->tgt_arfcn = notif->Target_Cell.u.Target_Cell_GSM_Notif.ARFCN;
280 neigh_key->tgt_bsic = notif->Target_Cell.u.Target_Cell_GSM_Notif.BSIC;
281 return 0;
282 default:
283 return -ENOTSUP;
284 }
285}
286
Pau Espin Pedrol44768f22021-02-02 13:11:30 +0100287#define SI_HDR_LEN 2
288static void bts_fill_si_cache_value(const struct gprs_rlcmac_bts *bts, struct si_cache_value *val)
289{
290 val->type_psi = false;
291 val->si_len = 0;
292 if (bts->si1_is_set) {
293 osmo_static_assert(sizeof(bts->si1) - SI_HDR_LEN == BSSGP_RIM_SI_LEN, _si1_header_size);
294 memcpy(&val->si_buf[val->si_len], bts->si1 + SI_HDR_LEN, BSSGP_RIM_SI_LEN);
295 val->si_len += BSSGP_RIM_SI_LEN;
296 }
297 if (bts->si3_is_set) {
298 osmo_static_assert(sizeof(bts->si3) - SI_HDR_LEN == BSSGP_RIM_SI_LEN, _si3_header_size);
299 memcpy(&val->si_buf[val->si_len], bts->si3 + SI_HDR_LEN, BSSGP_RIM_SI_LEN);
300 val->si_len += BSSGP_RIM_SI_LEN;
301 }
302 if (bts->si13_is_set) {
303 osmo_static_assert(sizeof(bts->si13) - SI_HDR_LEN == BSSGP_RIM_SI_LEN, _si13_header_size);
304 memcpy(&val->si_buf[val->si_len], bts->si13 + SI_HDR_LEN, BSSGP_RIM_SI_LEN);
305 val->si_len += BSSGP_RIM_SI_LEN;
306 }
307}
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100308
309////////////////
310// FSM states //
311////////////////
312
313static void st_initial(struct osmo_fsm_inst *fi, uint32_t event, void *data)
314{
315 struct nacc_fsm_ctx *ctx = (struct nacc_fsm_ctx *)fi->priv;
316 struct gprs_rlcmac_bts *bts = ctx->ms->bts;
317 Packet_Cell_Change_Notification_t *notif;
318
319 switch (event) {
320 case NACC_EV_RX_CELL_CHG_NOTIFICATION:
321 notif = (Packet_Cell_Change_Notification_t *)data;
Pau Espin Pedrol0c10b3c2021-02-10 17:12:02 +0100322 if (fill_neigh_key_from_bts_pkt_cell_chg_not(&ctx->neigh_key, bts, notif) < 0) {
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100323 LOGPFSML(fi, LOGL_NOTICE, "TargetCell type=0x%x not supported\n",
324 notif->Target_Cell.UnionType);
325 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
Pau Espin Pedrol0c10b3c2021-02-10 17:12:02 +0100326 } else {
327 nacc_fsm_state_chg(fi, NACC_ST_WAIT_RESOLVE_RAC_CI);
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100328 }
329 break;
330 default:
331 OSMO_ASSERT(0);
332 }
333}
334
335static void st_wait_resolve_rac_ci_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state)
336{
337 struct nacc_fsm_ctx *ctx = (struct nacc_fsm_ctx *)fi->priv;
338 struct gprs_rlcmac_bts *bts = ctx->ms->bts;
339 struct gprs_pcu *pcu = bts->pcu;
340 const struct osmo_cell_global_id_ps *cgi_ps;
Pau Espin Pedrolc0805e62021-01-27 17:16:59 +0100341 struct ctrl_cmd *cmd = NULL;
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100342 int rc;
343
344 /* First try to find the value in the cache */
345 cgi_ps = neigh_cache_lookup_value(pcu->neigh_cache, &ctx->neigh_key);
346 if (cgi_ps) {
347 ctx->cgi_ps = *cgi_ps;
348 nacc_fsm_state_chg(fi, NACC_ST_WAIT_REQUEST_SI);
349 return;
350 }
351
352 /* CGI-PS not in cache, resolve it using BSC Neighbor Resolution CTRL interface */
353
354 LOGPFSML(fi, LOGL_DEBUG, "No CGI-PS found in cache, resolving " NEIGH_CACHE_ENTRY_KEY_FMT "...\n",
355 NEIGH_CACHE_ENTRY_KEY_ARGS(&ctx->neigh_key));
356
Pau Espin Pedrolc0805e62021-01-27 17:16:59 +0100357 rc = osmo_sock_init2_ofd(&ctx->neigh_ctrl_conn->write_queue.bfd,
358 AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP,
359 NULL, 0, pcu->vty.neigh_ctrl_addr, pcu->vty.neigh_ctrl_port,
360 OSMO_SOCK_F_CONNECT);
361 if (rc < 0) {
Pau Espin Pedrolf7e1df02021-01-29 16:48:54 +0100362 LOGPFSML(fi, LOGL_ERROR,
363 "Failed to establish CTRL (neighbor resolution) connection to BSC r=%s:%u\n\n",
364 pcu->vty.neigh_ctrl_addr, pcu->vty.neigh_ctrl_port);
Pau Espin Pedrolc0805e62021-01-27 17:16:59 +0100365 goto err_term;
366 }
367
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100368 cmd = ctrl_cmd_create(ctx, CTRL_TYPE_GET);
369 if (!cmd) {
370 LOGPFSML(fi, LOGL_ERROR, "CTRL msg creation failed\n");
371 goto err_term;
372 }
373
374 cmd->id = talloc_asprintf(cmd, "1");
375 cmd->variable = talloc_asprintf(cmd, "neighbor_resolve_cgi_ps_from_lac_ci.%d.%d.%d.%d",
376 ctx->neigh_key.local_lac, ctx->neigh_key.local_ci,
377 ctx->neigh_key.tgt_arfcn, ctx->neigh_key.tgt_bsic);
378 rc = ctrl_cmd_send(&ctx->neigh_ctrl_conn->write_queue, cmd);
379 if (rc) {
380 LOGPFSML(fi, LOGL_ERROR, "CTRL msg sent failed: %d\n", rc);
381 goto err_term;
382 }
383
384 talloc_free(cmd);
385 return;
386
387err_term:
388 talloc_free(cmd);
Pau Espin Pedrola06ac182021-01-26 19:13:43 +0100389 nacc_fsm_state_chg(fi, NACC_ST_TX_CELL_CHG_CONTINUE);
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100390}
391
392
393static void st_wait_resolve_rac_ci(struct osmo_fsm_inst *fi, uint32_t event, void *data)
394{
395 switch (event) {
396 case NACC_EV_RX_CELL_CHG_NOTIFICATION:
397 break;
398 case NACC_EV_RX_RAC_CI:
399 /* Assumption: ctx->cgi_ps has been filled by caller of the event */
400 nacc_fsm_state_chg(fi, NACC_ST_WAIT_REQUEST_SI);
401 break;
402 default:
403 OSMO_ASSERT(0);
404 }
405}
406
407/* At this point, we expect correct tgt cell info to be already in ctx->cgi_ps */
408static void st_wait_request_si_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state)
409{
410 struct nacc_fsm_ctx *ctx = (struct nacc_fsm_ctx *)fi->priv;
411 struct gprs_rlcmac_bts *bts = ctx->ms->bts;
412 struct gprs_pcu *pcu = bts->pcu;
413 struct bssgp_ran_information_pdu pdu;
414 const struct si_cache_value *si;
Pau Espin Pedrol44768f22021-02-02 13:11:30 +0100415 struct gprs_rlcmac_bts *bts_i;
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100416 int rc;
417
Pau Espin Pedrol44768f22021-02-02 13:11:30 +0100418 /* First check if the CGI-PS addresses a cell managed by this PCU. If
419 * that's the case, we already have the info and there's no need to go
420 * the RIM way since we'd end up to this same PCU on the other end anyway.
421 */
422 llist_for_each_entry(bts_i, &the_pcu->bts_list, list) {
423 if (bts_i == bts) /* Makes no sense targeting the same cell */
424 continue;
425 if (osmo_cgi_ps_cmp(&ctx->cgi_ps, &bts_i->cgi_ps) != 0)
426 continue;
427
428 LOGPFSML(fi, LOGL_DEBUG, "neighbor CGI-PS %s addresses local BTS %d\n",
429 osmo_cgi_ps_name(&ctx->cgi_ps), bts_i->nr);
430 bts_fill_si_cache_value(bts, &ctx->si_info);
431 /* Tell the PCU scheduler we are ready to go, from here one we
432 * are polled/driven by the scheduler */
433 nacc_fsm_state_chg(fi, NACC_ST_TX_NEIGHBOUR_DATA);
434 return;
435 }
436
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100437 /* First check if we have SI info for the target cell in cache */
438 si = si_cache_lookup_value(pcu->si_cache, &ctx->cgi_ps);
439 if (si) {
440 /* Copy info since cache can be deleted at any point */
441 memcpy(&ctx->si_info, si, sizeof(ctx->si_info));
442 /* Tell the PCU scheduler we are ready to go, from here one we
443 * are polled/driven by the scheduler */
444 nacc_fsm_state_chg(fi, NACC_ST_TX_NEIGHBOUR_DATA);
445 return;
446 }
447
448 /* SI info not in cache, resolve it using RIM procedure against SGSN */
449 if (fill_rim_ran_info_req(ctx, &pdu) < 0) {
Pau Espin Pedrola06ac182021-01-26 19:13:43 +0100450 nacc_fsm_state_chg(fi, NACC_ST_TX_CELL_CHG_CONTINUE);
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100451 return;
452 }
453
454 rc = bssgp_tx_rim(&pdu, gprs_ns2_nse_nsei(ctx->ms->bts->nse));
455 if (rc < 0) {
456 LOGPFSML(fi, LOGL_ERROR, "Failed transmitting RIM PDU: %d\n", rc);
Pau Espin Pedrola06ac182021-01-26 19:13:43 +0100457 nacc_fsm_state_chg(fi, NACC_ST_TX_CELL_CHG_CONTINUE);
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100458 return;
459 }
460}
461
462
463static void st_wait_request_si(struct osmo_fsm_inst *fi, uint32_t event, void *data)
464{
465 struct nacc_fsm_ctx *ctx = (struct nacc_fsm_ctx *)fi->priv;
466 struct si_cache_entry *entry;
467
468 switch (event) {
469 case NACC_EV_RX_SI:
470 entry = (struct si_cache_entry *)data;
471 /* Copy info since cache can be deleted at any point */
472 memcpy(&ctx->si_info, &entry->value, sizeof(ctx->si_info));
473 /* Tell the PCU scheduler we are ready to go, from here one we
474 * are polled/driven by the scheduler */
475 nacc_fsm_state_chg(fi, NACC_ST_TX_NEIGHBOUR_DATA);
476 break;
477 default:
478 OSMO_ASSERT(0);
479 }
480}
481
482/* st_tx_neighbour_data_on_enter:
483 * At this point, we already received all required SI information to send stored
484 * in struct nacc_fsm_ctx. We now wait for scheduler to ask us to construct
485 * RLCMAC DL CTRL messages to move FSM states forward
486 */
487
488static void st_tx_neighbour_data(struct osmo_fsm_inst *fi, uint32_t event, void *data)
489{
490 struct nacc_fsm_ctx *ctx = (struct nacc_fsm_ctx *)fi->priv;
491 struct nacc_ev_create_rlcmac_msg_ctx *data_ctx;
492 bool all_si_info_sent;
493
494 switch (event) {
495 case NACC_EV_CREATE_RLCMAC_MSG:
496 data_ctx = (struct nacc_ev_create_rlcmac_msg_ctx *)data;
497 data_ctx->msg = create_packet_neighbour_cell_data(ctx, data_ctx->tbf, &all_si_info_sent);
498 if (!data_ctx->msg) {
499 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
500 return;
501 }
502 if (all_si_info_sent) /* DONE */
503 nacc_fsm_state_chg(fi, NACC_ST_TX_CELL_CHG_CONTINUE);
504 break;
505 default:
506 OSMO_ASSERT(0);
507 }
508}
509
Pau Espin Pedrol1aef1132021-02-01 19:33:59 +0100510/* st_cell_chg_continue_on_enter:
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100511 * At this point, we already sent all Pkt Cell Neighbour Change rlcmac
512 * blocks, and we only need to wait to be scheduled again to send PKT
513 * CELL CHANGE NOTIFICATION and then we are done
514 */
515
Pau Espin Pedrol1aef1132021-02-01 19:33:59 +0100516static void st_cell_chg_continue(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100517{
518 struct nacc_fsm_ctx *ctx = (struct nacc_fsm_ctx *)fi->priv;
519 struct nacc_ev_create_rlcmac_msg_ctx *data_ctx;
520
521 switch (event) {
522 case NACC_EV_CREATE_RLCMAC_MSG:
523 data_ctx = (struct nacc_ev_create_rlcmac_msg_ctx *)data;
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +0100524 data_ctx->msg = create_packet_cell_chg_continue(ctx, data_ctx, &ctx->continue_poll_fn);
525 if (data_ctx->msg) {
526 ctx->continue_poll_ts = data_ctx->ts;
527 nacc_fsm_state_chg(fi, NACC_ST_WAIT_CELL_CHG_CONTINUE_ACK);
528 }
529 break;
530 default:
531 OSMO_ASSERT(0);
532 }
533}
534
535static void st_wait_cell_chg_continue_ack(struct osmo_fsm_inst *fi, uint32_t event, void *data)
536{
537 switch (event) {
538 case NACC_EV_TIMEOUT_CELL_CHG_CONTINUE:
539 nacc_fsm_state_chg(fi, NACC_ST_TX_CELL_CHG_CONTINUE);
540 break;
541 case NACC_EV_RX_CELL_CHG_CONTINUE_ACK:
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100542 nacc_fsm_state_chg(fi, NACC_ST_DONE);
543 break;
544 default:
545 OSMO_ASSERT(0);
546 }
547}
548
549
550static void st_done_on_enter(struct osmo_fsm_inst *fi, uint32_t prev_state)
551{
552 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL);
553}
554
555static void nacc_fsm_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause)
556{
557 struct nacc_fsm_ctx *ctx = (struct nacc_fsm_ctx *)fi->priv;
558 /* after cleanup() finishes, FSM termination calls osmo_fsm_inst_free,
559 so we need to avoid double-freeing it during ctx talloc free
560 destructor */
561 talloc_reparent(ctx, ctx->ms, ctx->fi);
562 ctx->fi = NULL;
563
564 /* remove references from owning MS and free entire ctx */
565 ctx->ms->nacc = NULL;
566 talloc_free(ctx);
567}
568
Pau Espin Pedrol41a22a72021-01-26 19:00:37 +0100569static int nacc_fsm_timer_cb(struct osmo_fsm_inst *fi)
570{
571 switch (fi->T) {
572 case PCU_TDEF_NEIGH_RESOLVE_TO:
573 case PCU_TDEF_SI_RESOLVE_TO:
574 nacc_fsm_state_chg(fi, NACC_ST_TX_CELL_CHG_CONTINUE);
575 break;
576 }
577 return 0;
578}
579
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100580static struct osmo_fsm_state nacc_fsm_states[] = {
581 [NACC_ST_INITIAL] = {
582 .in_event_mask =
583 X(NACC_EV_RX_CELL_CHG_NOTIFICATION),
584 .out_state_mask =
585 X(NACC_ST_WAIT_RESOLVE_RAC_CI),
586 .name = "INITIAL",
587 .action = st_initial,
588 },
589 [NACC_ST_WAIT_RESOLVE_RAC_CI] = {
590 .in_event_mask =
591 X(NACC_EV_RX_RAC_CI),
592 .out_state_mask =
Pau Espin Pedrol41a22a72021-01-26 19:00:37 +0100593 X(NACC_ST_WAIT_REQUEST_SI) |
594 X(NACC_ST_TX_CELL_CHG_CONTINUE),
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100595 .name = "WAIT_RESOLVE_RAC_CI",
596 .onenter = st_wait_resolve_rac_ci_on_enter,
597 .action = st_wait_resolve_rac_ci,
598 },
599 [NACC_ST_WAIT_REQUEST_SI] = {
600 .in_event_mask =
601 X(NACC_EV_RX_CELL_CHG_NOTIFICATION) |
602 X(NACC_EV_RX_SI),
603 .out_state_mask =
Pau Espin Pedrol41a22a72021-01-26 19:00:37 +0100604 X(NACC_ST_TX_NEIGHBOUR_DATA) |
605 X(NACC_ST_TX_CELL_CHG_CONTINUE),
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100606 .name = "WAIT_REQUEST_SI",
607 .onenter = st_wait_request_si_on_enter,
608 .action = st_wait_request_si,
609 },
610 [NACC_ST_TX_NEIGHBOUR_DATA] = {
611 .in_event_mask =
612 X(NACC_EV_RX_CELL_CHG_NOTIFICATION) |
613 X(NACC_EV_RX_SI) |
614 X(NACC_EV_CREATE_RLCMAC_MSG),
615 .out_state_mask =
616 X(NACC_ST_TX_CELL_CHG_CONTINUE),
617 .name = "TX_NEIGHBOUR_DATA",
618 .action = st_tx_neighbour_data,
619 },
620 [NACC_ST_TX_CELL_CHG_CONTINUE] = {
621 .in_event_mask =
622 X(NACC_EV_RX_CELL_CHG_NOTIFICATION) |
623 X(NACC_EV_RX_SI) |
624 X(NACC_EV_CREATE_RLCMAC_MSG),
625 .out_state_mask =
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +0100626 X(NACC_ST_WAIT_CELL_CHG_CONTINUE_ACK),
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100627 .name = "TX_CELL_CHG_CONTINUE",
Pau Espin Pedrol1aef1132021-02-01 19:33:59 +0100628 .action = st_cell_chg_continue,
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100629 },
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +0100630 [NACC_ST_WAIT_CELL_CHG_CONTINUE_ACK] = {
631 .in_event_mask =
632 X(NACC_EV_RX_CELL_CHG_CONTINUE_ACK) |
633 X(NACC_EV_TIMEOUT_CELL_CHG_CONTINUE),
634 .out_state_mask =
635 X(NACC_ST_TX_CELL_CHG_CONTINUE) |
636 X(NACC_ST_DONE),
637 .name = "WAIT_CELL_CHG_CONTINUE_ACK",
638 .action = st_wait_cell_chg_continue_ack,
639 },
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100640 [NACC_ST_DONE] = {
641 .in_event_mask = 0,
642 .out_state_mask = 0,
643 .name = "DONE",
644 .onenter = st_done_on_enter,
645 },
646};
647
648static struct osmo_fsm nacc_fsm = {
649 .name = "NACC",
650 .states = nacc_fsm_states,
651 .num_states = ARRAY_SIZE(nacc_fsm_states),
Pau Espin Pedrol41a22a72021-01-26 19:00:37 +0100652 .timer_cb = nacc_fsm_timer_cb,
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100653 .cleanup = nacc_fsm_cleanup,
654 .log_subsys = DNACC,
655 .event_names = nacc_fsm_event_names,
656};
657
658static __attribute__((constructor)) void nacc_fsm_init(void)
659{
660 OSMO_ASSERT(osmo_fsm_register(&nacc_fsm) == 0);
661}
662
663void nacc_fsm_ctrl_reply_cb(struct ctrl_handle *ctrl, struct ctrl_cmd *cmd, void *data)
664{
665 struct nacc_fsm_ctx *ctx = (struct nacc_fsm_ctx *)data;
666 char *tmp = NULL, *tok, *saveptr;
667
668 LOGPFSML(ctx->fi, LOGL_NOTICE, "Received CTRL message: type=%d %s: %s\n",
669 cmd->type, cmd->variable, osmo_escape_str(cmd->reply, -1));
670
671 if (cmd->type != CTRL_TYPE_GET_REPLY || !cmd->reply) {
Pau Espin Pedrola06ac182021-01-26 19:13:43 +0100672 nacc_fsm_state_chg(ctx->fi, NACC_ST_TX_CELL_CHG_CONTINUE);
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100673 return;
674 }
675
676 /* TODO: Potentially validate cmd->variable contains same params as we
677 sent, and that cmd->id matches the original set. We may want to keep
678 the original cmd around by setting cmd->defer=1 when sending it. */
679
680 tmp = talloc_strdup(cmd, cmd->reply);
681 if (!tmp)
682 goto free_ret;
683
684 if (!(tok = strtok_r(tmp, "-", &saveptr)))
685 goto free_ret;
686 ctx->cgi_ps.rai.lac.plmn.mcc = atoi(tok);
687
688 if (!(tok = strtok_r(NULL, "-", &saveptr)))
689 goto free_ret;
690 ctx->cgi_ps.rai.lac.plmn.mnc = atoi(tok);
691
692 if (!(tok = strtok_r(NULL, "-", &saveptr)))
693 goto free_ret;
694 ctx->cgi_ps.rai.lac.lac = atoi(tok);
695
696 if (!(tok = strtok_r(NULL, "-", &saveptr)))
697 goto free_ret;
698 ctx->cgi_ps.rai.rac = atoi(tok);
699
700 if (!(tok = strtok_r(NULL, "\0", &saveptr)))
701 goto free_ret;
702 ctx->cgi_ps.cell_identity = atoi(tok);
703
704 /* Cache the cgi_ps so we can avoid requesting again same resolution for a while */
705 neigh_cache_add(ctx->ms->bts->pcu->neigh_cache, &ctx->neigh_key, &ctx->cgi_ps);
706
707 osmo_fsm_inst_dispatch(ctx->fi, NACC_EV_RX_RAC_CI, NULL);
708 return;
709
710free_ret:
711 talloc_free(tmp);
Pau Espin Pedrola06ac182021-01-26 19:13:43 +0100712 nacc_fsm_state_chg(ctx->fi, NACC_ST_TX_CELL_CHG_CONTINUE);
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100713 return;
714}
715
716static int nacc_fsm_ctx_talloc_destructor(struct nacc_fsm_ctx *ctx)
717{
718 if (ctx->fi) {
719 osmo_fsm_inst_free(ctx->fi);
720 ctx->fi = NULL;
721 }
722
723 if (ctx->neigh_ctrl_conn) {
724 if (ctx->neigh_ctrl_conn->write_queue.bfd.fd != -1) {
725 osmo_wqueue_clear(&ctx->neigh_ctrl_conn->write_queue);
726 osmo_fd_unregister(&ctx->neigh_ctrl_conn->write_queue.bfd);
727 close(ctx->neigh_ctrl_conn->write_queue.bfd.fd);
728 ctx->neigh_ctrl_conn->write_queue.bfd.fd = -1;
729 }
730 }
731
732 return 0;
733}
734
735struct nacc_fsm_ctx *nacc_fsm_alloc(struct GprsMs* ms)
736{
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100737 struct nacc_fsm_ctx *ctx = talloc_zero(ms, struct nacc_fsm_ctx);
738 char buf[64];
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100739
740 talloc_set_destructor(ctx, nacc_fsm_ctx_talloc_destructor);
741
742 ctx->ms = ms;
743
744 snprintf(buf, sizeof(buf), "TLLI-0x%08x", ms_tlli(ms));
745 ctx->fi = osmo_fsm_inst_alloc(&nacc_fsm, ctx, ctx, LOGL_INFO, buf);
746 if (!ctx->fi)
747 goto free_ret;
748
749 ctx->neigh_ctrl = ctrl_handle_alloc(ctx, ctx, NULL);
750 ctx->neigh_ctrl->reply_cb = nacc_fsm_ctrl_reply_cb;
751 ctx->neigh_ctrl_conn = osmo_ctrl_conn_alloc(ctx, ctx->neigh_ctrl);
752 if (!ctx->neigh_ctrl_conn)
753 goto free_ret;
Pau Espin Pedrol202a4782021-01-27 17:05:12 +0100754 /* Older versions of osmo_ctrl_conn_alloc didn't properly initialize fd to -1,
755 * so make sure to do it here otherwise fd may be valid fd 0 and cause trouble */
756 ctx->neigh_ctrl_conn->write_queue.bfd.fd = -1;
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100757 llist_add(&ctx->neigh_ctrl_conn->list_entry, &ctx->neigh_ctrl->ccon_list);
758
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100759 return ctx;
760free_ret:
761 talloc_free(ctx);
762 return NULL;
763}