blob: 880619dc5567b10659a522199e7b935ec971609a [file] [log] [blame]
Neels Hofmeyrc4628a32018-12-07 14:47:34 +01001/*
Vadim Yanitskiy999a5932023-05-18 17:22:26 +07002 * (C) 2019 by sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
Neels Hofmeyrc4628a32018-12-07 14:47:34 +01003 * All Rights Reserved
4 *
5 * SPDX-License-Identifier: AGPL-3.0+
6 *
7 * Author: Neels Hofmeyr
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation; either version 3 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
18 *
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 */
22
23#include <osmocom/core/linuxlist.h>
24#include <osmocom/core/logging.h>
25#include <osmocom/core/fsm.h>
26#include <osmocom/sigtran/sccp_helpers.h>
27
28#include <osmocom/msc/ran_peer.h>
29#include <osmocom/msc/sccp_ran.h>
30#include <osmocom/msc/msub.h>
31#include <osmocom/msc/msc_i.h>
32#include <osmocom/msc/msc_a.h>
33#include <osmocom/msc/vlr.h>
34#include <osmocom/msc/ran_conn.h>
35#include <osmocom/msc/cell_id_list.h>
Andreas Eversberg6c8db1d2023-04-23 12:00:16 +020036#include <osmocom/msc/msc_vgcs.h>
Neels Hofmeyrc4628a32018-12-07 14:47:34 +010037
38static struct osmo_fsm ran_peer_fsm;
39
40static __attribute__((constructor)) void ran_peer_init()
41{
42 OSMO_ASSERT( osmo_fsm_register(&ran_peer_fsm) == 0);
43}
44
45/* Allocate a RAN peer with FSM instance. To deallocate, call osmo_fsm_inst_term(ran_peer->fi). */
46static struct ran_peer *ran_peer_alloc(struct sccp_ran_inst *sri, const struct osmo_sccp_addr *peer_addr)
47{
48 struct ran_peer *rp;
49 struct osmo_fsm_inst *fi;
50 char *sccp_addr;
51 char *pos;
52
53 fi = osmo_fsm_inst_alloc(&ran_peer_fsm, sri, NULL, LOGL_DEBUG, NULL);
54 OSMO_ASSERT(fi);
55
56 /* Unfortunately, osmo_sccp_inst_addr_name() returns "RI=SSN_PC,PC=0.24.1,SSN=BSSAP" but neither commas nor
57 * full-stops are allowed as FSM inst id. Make it "RI=SSN_PC:PC-0-24-1:SSN-BSSAP". */
58 sccp_addr = osmo_sccp_inst_addr_name(sri->sccp, peer_addr);
59 for (pos = sccp_addr; *pos; pos++) {
60 if (*pos == ',')
61 *pos = ':';
62 else if (*pos == '.' || *pos == '=')
63 *pos = '-';
64 }
65 osmo_fsm_inst_update_id_f(fi, "%s:%s", osmo_rat_type_name(sri->ran->type), sccp_addr);
66
67 rp = talloc_zero(fi, struct ran_peer);
68 OSMO_ASSERT(rp);
69 *rp = (struct ran_peer){
70 .sri = sri,
71 .peer_addr = *peer_addr,
72 .fi = fi,
73 };
74 INIT_LLIST_HEAD(&rp->cells_seen);
75 fi->priv = rp;
76
77 llist_add(&rp->entry, &sri->ran_peers);
78
79 return rp;
80}
81
82struct ran_peer *ran_peer_find_or_create(struct sccp_ran_inst *sri, const struct osmo_sccp_addr *peer_addr)
83{
Neels Hofmeyrcbcfe992020-09-23 01:32:11 +020084 struct ran_peer *rp = ran_peer_find_by_addr(sri, peer_addr);
Neels Hofmeyrc4628a32018-12-07 14:47:34 +010085 if (rp)
86 return rp;
87 return ran_peer_alloc(sri, peer_addr);
88}
89
Neels Hofmeyrcbcfe992020-09-23 01:32:11 +020090struct ran_peer *ran_peer_find_by_addr(struct sccp_ran_inst *sri, const struct osmo_sccp_addr *peer_addr)
Neels Hofmeyrc4628a32018-12-07 14:47:34 +010091{
92 struct ran_peer *rp;
93 llist_for_each_entry(rp, &sri->ran_peers, entry) {
94 if (osmo_sccp_addr_ri_cmp(peer_addr, &rp->peer_addr))
95 continue;
96 return rp;
97 }
98 return NULL;
99}
100
101void ran_peer_cells_seen_add(struct ran_peer *ran_peer, const struct gsm0808_cell_id *cid)
102{
103 if (!cell_id_list_add_cell(ran_peer, &ran_peer->cells_seen, cid))
104 return;
105 LOG_RAN_PEER_CAT(ran_peer, DPAG, LOGL_NOTICE, "Added seen cell to this RAN peer: %s\n",
106 gsm0808_cell_id_name(cid));
107}
108
109static const struct osmo_tdef_state_timeout ran_peer_fsm_timeouts[32] = {
110 [RAN_PEER_ST_WAIT_RX_RESET_ACK] = { .T = -1 },
111 [RAN_PEER_ST_DISCARDING] = { .T = -2 },
112};
113
114#define ran_peer_state_chg(RAN_PEER, NEXT_STATE) \
115 osmo_tdef_fsm_inst_state_chg((RAN_PEER)->fi, NEXT_STATE, ran_peer_fsm_timeouts, g_sccp_tdefs, 5)
116
117void ran_peer_discard_all_conns(struct ran_peer *rp)
118{
119 struct ran_conn *conn, *next;
120
121 ran_peer_for_each_ran_conn_safe(conn, next, rp) {
122 ran_conn_discard(conn);
123 }
124}
125
Neels Hofmeyrb6972742020-06-26 15:20:51 +0200126static void ran_peer_update_osmux_support(struct ran_peer *rp, int supports_osmux)
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200127{
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200128 bool old_value = rp->remote_supports_osmux;
129
Neels Hofmeyrb6972742020-06-26 15:20:51 +0200130 switch (supports_osmux) {
131 case 1:
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200132 rp->remote_supports_osmux = true;
Neels Hofmeyrb6972742020-06-26 15:20:51 +0200133 break;
134 case -1:
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200135 rp->remote_supports_osmux = false;
Neels Hofmeyrb6972742020-06-26 15:20:51 +0200136 break;
137 default:
138 return;
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200139 }
140
141 if (old_value != rp->remote_supports_osmux)
142 LOG_RAN_PEER(rp, LOGL_INFO, "BSC detected AoIP Osmux support changed: %d->%d\n",
143 old_value, rp->remote_supports_osmux);
144}
145
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100146/* Drop all SCCP connections for this ran_peer, respond with RESET ACKNOWLEDGE and move to READY state. */
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200147static void ran_peer_rx_reset(struct ran_peer *rp, struct msgb* msg)
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100148{
149 struct msgb *reset_ack;
150
151 ran_peer_discard_all_conns(rp);
152
153 reset_ack = rp->sri->ran->sccp_ran_ops.make_reset_msg(rp->sri, SCCP_RAN_MSG_RESET_ACK);
154
155 if (!reset_ack) {
156 LOG_RAN_PEER(rp, LOGL_ERROR, "Failed to compose RESET ACKNOWLEDGE message\n");
157 ran_peer_state_chg(rp, RAN_PEER_ST_WAIT_RX_RESET);
158 return;
159 }
160
161 if (sccp_ran_down_l2_cl(rp->sri, &rp->peer_addr, reset_ack)) {
162 LOG_RAN_PEER(rp, LOGL_ERROR, "Failed to send RESET ACKNOWLEDGE message\n");
163 ran_peer_state_chg(rp, RAN_PEER_ST_WAIT_RX_RESET);
Vadim Yanitskiy53d3e0e2019-05-10 02:44:57 +0700164 msgb_free(reset_ack);
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100165 return;
166 }
167
168 LOG_RAN_PEER(rp, LOGL_INFO, "Sent RESET ACKNOWLEDGE\n");
169
Vadim Yanitskiy53d3e0e2019-05-10 02:44:57 +0700170 /* sccp_ran_down_l2_cl() doesn't free msgb */
171 msgb_free(reset_ack);
172
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100173 ran_peer_state_chg(rp, RAN_PEER_ST_READY);
174}
175
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200176static void ran_peer_rx_reset_ack(struct ran_peer *rp, struct msgb* msg)
Pau Espin Pedrolf15852b2019-05-13 19:54:02 +0200177{
178 ran_peer_state_chg(rp, RAN_PEER_ST_READY);
179}
180
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100181void ran_peer_reset(struct ran_peer *rp)
182{
183 struct msgb *reset;
184
185 ran_peer_state_chg(rp, RAN_PEER_ST_WAIT_RX_RESET_ACK);
186 ran_peer_discard_all_conns(rp);
187
188 reset = rp->sri->ran->sccp_ran_ops.make_reset_msg(rp->sri, SCCP_RAN_MSG_RESET);
189
190 if (!reset) {
191 LOG_RAN_PEER(rp, LOGL_ERROR, "Failed to compose RESET message\n");
192 ran_peer_state_chg(rp, RAN_PEER_ST_WAIT_RX_RESET);
193 return;
194 }
195
196 if (sccp_ran_down_l2_cl(rp->sri, &rp->peer_addr, reset)) {
197 LOG_RAN_PEER(rp, LOGL_ERROR, "Failed to send RESET message\n");
198 ran_peer_state_chg(rp, RAN_PEER_ST_WAIT_RX_RESET);
199 return;
200 }
201}
202
203void ran_peer_allstate_action(struct osmo_fsm_inst *fi, uint32_t event, void *data)
204{
205 struct ran_peer *rp = fi->priv;
206 struct ran_peer_ev_ctx *ctx = data;
207 struct msgb *msg = ctx->msg;
Neels Hofmeyr59de1562020-07-04 01:49:10 +0200208 enum reset_msg_type is_reset;
Neels Hofmeyrb6972742020-06-26 15:20:51 +0200209 int supports_osmux;
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100210
211 switch (event) {
212 case RAN_PEER_EV_MSG_UP_CL:
Neels Hofmeyr59de1562020-07-04 01:49:10 +0200213 is_reset = rp->sri->ran->sccp_ran_ops.is_reset_msg(rp->sri, fi, msg, &supports_osmux);
Neels Hofmeyrb6972742020-06-26 15:20:51 +0200214 ran_peer_update_osmux_support(rp, supports_osmux);
Neels Hofmeyr59de1562020-07-04 01:49:10 +0200215 switch (is_reset) {
216 case SCCP_RAN_MSG_RESET:
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100217 osmo_fsm_inst_dispatch(fi, RAN_PEER_EV_RX_RESET, msg);
218 return;
Neels Hofmeyr59de1562020-07-04 01:49:10 +0200219 case SCCP_RAN_MSG_RESET_ACK:
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100220 osmo_fsm_inst_dispatch(fi, RAN_PEER_EV_RX_RESET_ACK, msg);
221 return;
222 default:
223 LOG_RAN_PEER(rp, LOGL_ERROR, "Unhandled ConnectionLess message received: %s\n",
224 rp->sri->ran->sccp_ran_ops.msg_name(rp->sri, msg));
225 return;
226 }
227
228 default:
229 LOG_RAN_PEER(rp, LOGL_ERROR, "Unhandled event: %s\n", osmo_fsm_event_name(&ran_peer_fsm, event));
230 return;
231 }
232}
233
234void clear_and_disconnect(struct ran_peer *rp, uint32_t conn_id)
235{
236 struct msgb *clear;
237 struct ran_msg ran_enc_msg = {
238 .msg_type = RAN_MSG_CLEAR_COMMAND,
239 .clear_command = {
240 .gsm0808_cause = GSM0808_CAUSE_EQUIPMENT_FAILURE,
241 },
242 };
243
244 clear = rp->sri->ran->ran_encode(rp->fi, &ran_enc_msg);
245 if (!clear
246 || sccp_ran_down_l2_co(rp->sri, conn_id, clear))
247 LOG_RAN_PEER(rp, LOGL_ERROR, "Cannot sent Clear command\n");
248
249 sccp_ran_disconnect(rp->sri, conn_id, 0);
250}
251
252void ran_peer_st_wait_rx_reset(struct osmo_fsm_inst *fi, uint32_t event, void *data)
253{
254 struct ran_peer *rp = fi->priv;
255 struct ran_peer_ev_ctx *ctx;
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200256 struct msgb *msg;
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100257
258 switch (event) {
259
260 case RAN_PEER_EV_MSG_UP_CO:
261 case RAN_PEER_EV_MSG_UP_CO_INITIAL:
262 ctx = data;
263 OSMO_ASSERT(ctx);
264
265 if (rp->sri->ignore_missing_reset) {
266 LOG_RAN_PEER(rp, LOGL_ERROR, "Receiving CO message on RAN peer that has not done a proper RESET yet."
267 " Accepting RAN peer implicitly (legacy compat)\n");
268 ran_peer_state_chg(rp, RAN_PEER_ST_READY);
269 osmo_fsm_inst_dispatch(rp->fi, event, data);
270 return;
271 }
272
273 LOG_RAN_PEER(rp, LOGL_ERROR, "Receiving CO message on RAN peer that has not done a proper RESET yet."
274 " Disconnecting on incoming message, sending RESET to RAN peer.\n");
275 /* No valid RESET procedure has happened here yet. Usually, we're expecting the RAN peer (BSC,
276 * RNC) to first send a RESET message before sending Connection Oriented messages. So if we're
277 * getting a CO message, likely we've just restarted or something. Send a RESET to the peer. */
278
279 /* Make sure the MS / UE properly disconnects. */
280 clear_and_disconnect(rp, ctx->conn_id);
281
282 ran_peer_reset(rp);
283 return;
284
285 case RAN_PEER_EV_RX_RESET:
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200286 msg = (struct msgb*)data;
287 ran_peer_rx_reset(rp, msg);
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100288 return;
289
290 default:
291 LOG_RAN_PEER(rp, LOGL_ERROR, "Unhandled event: %s\n", osmo_fsm_event_name(&ran_peer_fsm, event));
292 return;
293 }
294}
295
296void ran_peer_st_wait_rx_reset_ack(struct osmo_fsm_inst *fi, uint32_t event, void *data)
297{
298 struct ran_peer *rp = fi->priv;
299 struct ran_peer_ev_ctx *ctx;
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200300 struct msgb *msg;
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100301
302 switch (event) {
303
304 case RAN_PEER_EV_RX_RESET_ACK:
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200305 msg = (struct msgb*)data;
306 ran_peer_rx_reset_ack(rp, msg);
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100307 return;
308
309 case RAN_PEER_EV_MSG_UP_CO:
310 case RAN_PEER_EV_MSG_UP_CO_INITIAL:
311 ctx = data;
312 OSMO_ASSERT(ctx);
313 LOG_RAN_PEER(rp, LOGL_ERROR, "Receiving CO message on RAN peer that has not done a proper RESET yet."
314 " Disconnecting on incoming message, sending RESET to RAN peer.\n");
315 sccp_ran_disconnect(rp->sri, ctx->conn_id, 0);
316 /* No valid RESET procedure has happened here yet. */
317 ran_peer_reset(rp);
318 return;
319
320 case RAN_PEER_EV_RX_RESET:
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200321 msg = (struct msgb*)data;
322 ran_peer_rx_reset(rp, msg);
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100323 return;
324
325 default:
326 LOG_RAN_PEER(rp, LOGL_ERROR, "Unhandled event: %s\n", osmo_fsm_event_name(&ran_peer_fsm, event));
327 return;
328 }
329}
330
331static struct ran_conn *new_incoming_conn(struct ran_peer *rp, uint32_t conn_id)
332{
333 struct gsm_network *net = rp->sri->user_data;
334 struct msub *msub;
335 struct msc_i *msc_i;
336 struct msc_a *msc_a;
337 struct ran_conn *ran_conn;
338
339 msub = msub_alloc(net);
340 OSMO_ASSERT(msub);
341 msc_i = msc_i_alloc(msub, rp->sri->ran);
342 OSMO_ASSERT(msc_i);
343
344 ran_conn = ran_conn_create_incoming(rp, conn_id);
345 if (!ran_conn) {
346 LOG_RAN_PEER(rp, LOGL_ERROR, "Cannot allocate ran_conn\n");
347 return NULL;
348 }
349 msc_i_set_ran_conn(msc_i, ran_conn);
350
351 msc_a = msc_a_alloc(msub, rp->sri->ran);
352 OSMO_ASSERT(msc_a);
353
354 return msc_i->ran_conn;
355}
356
357void ran_peer_st_ready(struct osmo_fsm_inst *fi, uint32_t event, void *data)
358{
359 struct ran_peer *rp = fi->priv;
360 struct ran_peer_ev_ctx *ctx;
361 struct ran_conn *conn;
362 struct an_apdu an_apdu;
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200363 struct msgb *msg;
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100364
365 switch (event) {
366
367 case RAN_PEER_EV_MSG_UP_CO_INITIAL:
368 ctx = data;
Vadim Yanitskiyd14422a2019-07-09 00:37:49 +0700369 OSMO_ASSERT(ctx);
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100370 OSMO_ASSERT(!ctx->conn);
371 OSMO_ASSERT(ctx->msg);
372
373 conn = new_incoming_conn(rp, ctx->conn_id);
374 if (!conn)
375 return;
376 if (!conn->msc_role) {
377 LOG_RAN_PEER(rp, LOGL_ERROR,
378 "Rx CO Initial message on conn that is not associated with any MSC role\n");
379 return;
380 }
381
382
383 an_apdu = (struct an_apdu){
384 .an_proto = rp->sri->ran->an_proto,
385 .msg = ctx->msg,
386 };
387
388 osmo_fsm_inst_dispatch(conn->msc_role, MSC_EV_FROM_RAN_COMPLETE_LAYER_3, &an_apdu);
389 return;
390
391 case RAN_PEER_EV_MSG_UP_CO:
392 ctx = data;
393 OSMO_ASSERT(ctx);
394 OSMO_ASSERT(ctx->conn);
395 OSMO_ASSERT(ctx->msg);
396
Andreas Eversberg6c8db1d2023-04-23 12:00:16 +0200397 if (ctx->conn->msc_role) {
398 /* "normal" A connection, dispatch to MSC-I or MSC-T */
399 an_apdu = (struct an_apdu){
400 .an_proto = rp->sri->ran->an_proto,
401 .msg = ctx->msg,
402 };
403 osmo_fsm_inst_dispatch(ctx->conn->msc_role, MSC_EV_FROM_RAN_UP_L2, &an_apdu);
404 } else if (ctx->conn->vgcs.bss) {
405 /* VGCS call related */
406 msc_a_rx_vgcs_bss(ctx->conn->vgcs.bss, ctx->conn, ctx->msg);
407 } else if (ctx->conn->vgcs.cell) {
408 /* VGCS channel related */
409 msc_a_rx_vgcs_cell(ctx->conn->vgcs.cell, ctx->conn, ctx->msg);
410 } else
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100411 LOG_RAN_PEER(rp, LOGL_ERROR,
412 "Rx CO message on conn that is not associated with any MSC role\n");
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100413 return;
414
415 case RAN_PEER_EV_MSG_DOWN_CO_INITIAL:
416 ctx = data;
417 OSMO_ASSERT(ctx);
418 OSMO_ASSERT(ctx->msg);
419 sccp_ran_down_l2_co_initial(rp->sri, &rp->peer_addr, ctx->conn_id, ctx->msg);
420 return;
421
422 case RAN_PEER_EV_MSG_DOWN_CO:
423 ctx = data;
424 OSMO_ASSERT(ctx);
425 OSMO_ASSERT(ctx->msg);
426 sccp_ran_down_l2_co(rp->sri, ctx->conn_id, ctx->msg);
427 return;
428
429 case RAN_PEER_EV_MSG_DOWN_CL:
430 OSMO_ASSERT(data);
431 sccp_ran_down_l2_cl(rp->sri, &rp->peer_addr, (struct msgb*)data);
432 return;
433
434 case RAN_PEER_EV_RX_RESET:
Pau Espin Pedrolf9f38b52019-05-07 11:48:16 +0200435 msg = (struct msgb*)data;
436 ran_peer_rx_reset(rp, msg);
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100437 return;
438
439 default:
440 LOG_RAN_PEER(rp, LOGL_ERROR, "Unhandled event: %s\n", osmo_fsm_event_name(&ran_peer_fsm, event));
441 return;
442 }
443}
444
445static int ran_peer_fsm_timer_cb(struct osmo_fsm_inst *fi)
446{
447 struct ran_peer *rp = fi->priv;
448 ran_peer_state_chg(rp, RAN_PEER_ST_WAIT_RX_RESET);
449 return 0;
450}
451
452void ran_peer_fsm_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause)
453{
454 struct ran_peer *rp = fi->priv;
455 ran_peer_discard_all_conns(rp);
456 llist_del(&rp->entry);
457}
458
459static const struct value_string ran_peer_fsm_event_names[] = {
460 OSMO_VALUE_STRING(RAN_PEER_EV_MSG_UP_CL),
461 OSMO_VALUE_STRING(RAN_PEER_EV_MSG_UP_CO_INITIAL),
462 OSMO_VALUE_STRING(RAN_PEER_EV_MSG_UP_CO),
463 OSMO_VALUE_STRING(RAN_PEER_EV_MSG_DOWN_CL),
464 OSMO_VALUE_STRING(RAN_PEER_EV_MSG_DOWN_CO_INITIAL),
465 OSMO_VALUE_STRING(RAN_PEER_EV_MSG_DOWN_CO),
466 OSMO_VALUE_STRING(RAN_PEER_EV_RX_RESET),
467 OSMO_VALUE_STRING(RAN_PEER_EV_RX_RESET_ACK),
468 OSMO_VALUE_STRING(RAN_PEER_EV_CONNECTION_SUCCESS),
469 OSMO_VALUE_STRING(RAN_PEER_EV_CONNECTION_TIMEOUT),
470 {}
471};
472
473#define S(x) (1 << (x))
474
475static const struct osmo_fsm_state ran_peer_fsm_states[] = {
476 [RAN_PEER_ST_WAIT_RX_RESET] = {
477 .name = "WAIT_RX_RESET",
478 .action = ran_peer_st_wait_rx_reset,
479 .in_event_mask = 0
480 | S(RAN_PEER_EV_RX_RESET)
481 | S(RAN_PEER_EV_MSG_UP_CO_INITIAL)
482 | S(RAN_PEER_EV_MSG_UP_CO)
483 | S(RAN_PEER_EV_CONNECTION_TIMEOUT)
484 ,
485 .out_state_mask = 0
486 | S(RAN_PEER_ST_WAIT_RX_RESET)
487 | S(RAN_PEER_ST_WAIT_RX_RESET_ACK)
488 | S(RAN_PEER_ST_READY)
489 | S(RAN_PEER_ST_DISCARDING)
490 ,
491 },
492 [RAN_PEER_ST_WAIT_RX_RESET_ACK] = {
493 .name = "WAIT_RX_RESET_ACK",
494 .action = ran_peer_st_wait_rx_reset_ack,
495 .in_event_mask = 0
496 | S(RAN_PEER_EV_RX_RESET)
497 | S(RAN_PEER_EV_RX_RESET_ACK)
498 | S(RAN_PEER_EV_MSG_UP_CO_INITIAL)
499 | S(RAN_PEER_EV_MSG_UP_CO)
500 | S(RAN_PEER_EV_CONNECTION_TIMEOUT)
501 ,
502 .out_state_mask = 0
503 | S(RAN_PEER_ST_WAIT_RX_RESET)
504 | S(RAN_PEER_ST_WAIT_RX_RESET_ACK)
505 | S(RAN_PEER_ST_READY)
506 | S(RAN_PEER_ST_DISCARDING)
507 ,
508 },
509 [RAN_PEER_ST_READY] = {
510 .name = "READY",
511 .action = ran_peer_st_ready,
512 .in_event_mask = 0
513 | S(RAN_PEER_EV_RX_RESET)
514 | S(RAN_PEER_EV_MSG_UP_CO_INITIAL)
515 | S(RAN_PEER_EV_MSG_UP_CO)
516 | S(RAN_PEER_EV_MSG_DOWN_CO_INITIAL)
517 | S(RAN_PEER_EV_MSG_DOWN_CO)
518 | S(RAN_PEER_EV_MSG_DOWN_CL)
519 ,
520 .out_state_mask = 0
521 | S(RAN_PEER_ST_WAIT_RX_RESET)
522 | S(RAN_PEER_ST_WAIT_RX_RESET_ACK)
523 | S(RAN_PEER_ST_READY)
524 | S(RAN_PEER_ST_DISCARDING)
525 ,
526 },
527 [RAN_PEER_ST_DISCARDING] = {
528 .name = "DISCARDING",
529 },
530};
531
532static struct osmo_fsm ran_peer_fsm = {
533 .name = "ran_peer",
534 .states = ran_peer_fsm_states,
535 .num_states = ARRAY_SIZE(ran_peer_fsm_states),
536 .log_subsys = DRR,
537 .event_names = ran_peer_fsm_event_names,
538 .timer_cb = ran_peer_fsm_timer_cb,
539 .cleanup = ran_peer_fsm_cleanup,
540 .allstate_action = ran_peer_allstate_action,
541 .allstate_event_mask = 0
542 | S(RAN_PEER_EV_MSG_UP_CL)
543 ,
544};
545
546int ran_peer_up_l2(struct sccp_ran_inst *sri, const struct osmo_sccp_addr *calling_addr, bool co, uint32_t conn_id,
547 struct msgb *l2)
548{
549 struct ran_peer *ran_peer = NULL;
550 uint32_t event;
551 struct ran_peer_ev_ctx ctx = {
552 .conn_id = conn_id,
553 .msg = l2,
554 };
555
556 if (co) {
557 struct ran_conn *conn;
558 llist_for_each_entry(conn, &sri->ran_conns, entry) {
559 if (conn->sccp_conn_id == conn_id) {
560 ran_peer = conn->ran_peer;
561 ctx.conn = conn;
562 break;
563 }
564 }
565
566 if (ran_peer && calling_addr) {
567 LOG_SCCP_RAN_CO(sri, calling_addr, conn_id, LOGL_ERROR,
568 "Connection-Oriented Initial message for already existing conn_id."
569 " Dropping message.\n");
570 return -EINVAL;
571 }
572
573 if (!ran_peer && !calling_addr) {
574 LOG_SCCP_RAN_CO(sri, calling_addr, conn_id, LOGL_ERROR,
575 "Connection-Oriented non-Initial message for unknown conn_id %u."
576 " Dropping message.\n", conn_id);
577 return -EINVAL;
578 }
579 }
580
581 if (calling_addr) {
582 ran_peer = ran_peer_find_or_create(sri, calling_addr);
583 if (!ran_peer) {
584 LOG_SCCP_RAN_CL(sri, calling_addr, LOGL_ERROR, "Cannot register RAN peer\n");
585 return -EIO;
586 }
587 }
588
589 OSMO_ASSERT(ran_peer && ran_peer->fi);
590
591 if (co)
592 event = calling_addr ? RAN_PEER_EV_MSG_UP_CO_INITIAL : RAN_PEER_EV_MSG_UP_CO;
593 else
594 event = RAN_PEER_EV_MSG_UP_CL;
595
596 return osmo_fsm_inst_dispatch(ran_peer->fi, event, &ctx);
597}
598
599void ran_peer_disconnect(struct sccp_ran_inst *sri, uint32_t conn_id)
600{
601 struct ran_conn *conn;
602 llist_for_each_entry(conn, &sri->ran_conns, entry) {
603 if (conn->sccp_conn_id == conn_id) {
604 ran_conn_discard(conn);
605 return;
606 }
607 }
608}
609
610struct ran_peer *ran_peer_find_by_cell_id(struct sccp_ran_inst *sri, const struct gsm0808_cell_id *cid,
611 bool expecting_single_match)
612{
613 struct ran_peer *rp;
614 struct ran_peer *found = NULL;
615
616 llist_for_each_entry(rp, &sri->ran_peers, entry) {
617 if (cell_id_list_find(&rp->cells_seen, cid, 0, false)) {
618 if (!expecting_single_match)
619 return rp;
620 /* Otherwise continue iterating and log errors for multiple matches... */
621 if (found) {
622 LOG_RAN_PEER(found, LOGL_ERROR, "Cell appears in more than one RAN peer:"
623 " %s also appears in %s\n",
624 gsm0808_cell_id_name(cid), rp->fi->id);
625 } else
626 found = rp;
627 }
628 }
629 return found;
630}
631
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100632int ran_peers_down_paging(struct sccp_ran_inst *sri, enum CELL_IDENT page_where, struct vlr_subscr *vsub,
633 enum paging_cause cause)
634{
635 struct ran_peer *rp;
636 int ret = 0;
637 struct gsm0808_cell_id page_id;
638 gsm0808_cell_id_from_cgi(&page_id, page_where, &vsub->cgi);
639
640 switch (page_where) {
641 case CELL_IDENT_NO_CELL:
Martin Hauke3f07dac2019-11-14 17:49:08 +0100642 LOG_SCCP_RAN_CAT(sri, DPAG, LOGL_ERROR, "Asked to page on NO_CELL, which doesn't make sense.\n");
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100643 return 0;
644
645 case CELL_IDENT_UTRAN_PLMN_LAC_RNC:
646 case CELL_IDENT_UTRAN_RNC:
647 case CELL_IDENT_UTRAN_LAC_RNC:
648 LOG_SCCP_RAN_CAT(sri, DPAG, LOGL_ERROR, "Don't know how to page on %s\n",
649 gsm0808_cell_id_name(&page_id));
650 return 0;
651
652 default:
653 break;
654 };
655
656 llist_for_each_entry(rp, &sri->ran_peers, entry) {
657 ret += ran_peer_down_paging(rp, &page_id, vsub, cause);
658 }
659
660 if (!ret)
661 LOG_SCCP_RAN_CAT(sri, DPAG, LOGL_ERROR, "Paging failed, no RAN peers found for %s\n",
662 gsm0808_cell_id_name(&page_id));
663 return ret;
664}
665
666/* If the given vsub->cgi matches this ran_peer with respect to page_where, page and return 1.
667 * Otherwise return 0. (Return value: number of pagings sent) */
668int ran_peer_down_paging(struct ran_peer *rp, const struct gsm0808_cell_id *page_id, struct vlr_subscr *vsub,
669 enum paging_cause cause)
670{
671 struct msgb *l2;
672
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100673 /* There are also the RAN peers that are configured in the neighbor ident for Handover, but if those aren't
674 * connected, then we can't Page there. */
Vadim Yanitskiyd24c46a2019-05-14 21:49:47 +0700675 if (!cell_id_list_find(&rp->cells_seen, page_id, 0, false))
676 return 0;
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100677
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100678 LOG_RAN_PEER_CAT(rp, DPAG, LOGL_DEBUG, "Paging for %s on %s\n", vlr_subscr_name(vsub),
679 gsm0808_cell_id_name(page_id));
680 l2 = rp->sri->ran->sccp_ran_ops.make_paging_msg(rp->sri, page_id, vsub->imsi, vsub->tmsi, cause);
681 if (osmo_fsm_inst_dispatch(rp->fi, RAN_PEER_EV_MSG_DOWN_CL, l2)) {
682 /* Not allowed to send messages, the peer is not properly connected yet/anymore */
683 LOG_RAN_PEER_CAT(rp, DPAG, LOGL_ERROR,
684 "Paging for %s matched this RAN peer, but emitting a Paging failed\n",
685 gsm0808_cell_id_name(page_id));
Vadim Yanitskiyede95d12019-05-14 21:41:06 +0700686 msgb_free(l2);
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100687 return 0;
688 }
Vadim Yanitskiyede95d12019-05-14 21:41:06 +0700689
690 /* The RAN_PEER_EV_MSG_DOWN_CL handler calls sccp_ran_down_l2_cl(),
691 * which doesn't free msgb. We have to do this ourselves. */
692 msgb_free(l2);
693
Neels Hofmeyrc4628a32018-12-07 14:47:34 +0100694 return 1;
695}