blob: 6514f80479c75ed110fcda81cba6ba0524de6a3f [file] [log] [blame]
Harald Weltef5a0fa32019-03-03 15:44:18 +01001#include <stdint.h>
2#include <string.h>
3#include <unistd.h>
4#include <pthread.h>
5
6#include <osmocom/core/linuxlist.h>
7#include <osmocom/core/select.h>
8#include <osmocom/core/fsm.h>
9#include <osmocom/core/logging.h>
10#include <osmocom/core/socket.h>
11#include <osmocom/gsm/protocol/ipaccess.h>
12#include <osmocom/abis/ipa.h>
13
14#include <osmocom/rspro/RsproPDU.h>
15
16#include "debug.h"
17#include "rspro_util.h"
18#include "rspro_server.h"
19
20#define S(x) (1 << (x))
21
Harald Weltef5a0fa32019-03-03 15:44:18 +010022static RsproPDU_t *slotmap2CreateMappingReq(const struct slot_mapping *slotmap)
23{
24 ClientSlot_t clslot;
25 BankSlot_t bslot;
26
27 client_slot2rspro(&clslot, &slotmap->client);
28 bank_slot2rspro(&bslot, &slotmap->bank);
29
30 return rspro_gen_CreateMappingReq(&clslot, &bslot);
31}
32
33static RsproPDU_t *slotmap2RemoveMappingReq(const struct slot_mapping *slotmap)
34{
35 ClientSlot_t clslot;
36 BankSlot_t bslot;
37
38 client_slot2rspro(&clslot, &slotmap->client);
39 bank_slot2rspro(&bslot, &slotmap->bank);
40
41 return rspro_gen_RemoveMappingReq(&clslot, &bslot);
42}
43
44
45static void client_conn_send(struct rspro_client_conn *conn, RsproPDU_t *pdu)
46{
Harald Weltea8b86ce2019-03-31 14:59:20 +020047 if (!pdu) {
48 LOGPFSML(conn->fi, LOGL_ERROR, "Attempt to transmit NULL\n");
49 osmo_log_backtrace(DMAIN, LOGL_ERROR);
Harald Weltef5a0fa32019-03-03 15:44:18 +010050 return;
51 }
Harald Welteba781c02019-03-30 17:32:53 +010052 LOGPFSM(conn->fi, "Tx RSPRO %s\n", rspro_msgt_name(pdu));
Harald Weltea8b86ce2019-03-31 14:59:20 +020053
54 struct msgb *msg_tx = rspro_enc_msg(pdu);
55 if (!msg_tx) {
56 LOGPFSML(conn->fi, LOGL_ERROR, "Error encdoing RSPRO %s\n", rspro_msgt_name(pdu));
57 osmo_log_backtrace(DMAIN, LOGL_ERROR);
58 ASN_STRUCT_FREE(asn_DEF_RsproPDU, pdu);
59 return;
60 }
Harald Weltef5a0fa32019-03-03 15:44:18 +010061 ipa_prepend_header_ext(msg_tx, IPAC_PROTO_EXT_RSPRO);
62 ipa_msg_push_header(msg_tx, IPAC_PROTO_OSMO);
63 ipa_server_conn_send(conn->peer, msg_tx);
64}
65
66
67/***********************************************************************
68 * per-client connection FSM
69 ***********************************************************************/
70
71static void rspro_client_conn_destroy(struct rspro_client_conn *conn);
72
73enum remsim_server_client_fsm_state {
74 CLNTC_ST_INIT,
75 CLNTC_ST_ESTABLISHED,
Harald Weltee5c77732019-03-07 23:58:24 +010076 CLNTC_ST_WAIT_CONF_RES, /* waiting for ConfigClientRes */
Harald Welte0a64da62019-03-30 17:38:04 +010077 CLNTC_ST_CONNECTED_BANKD,
78 CLNTC_ST_CONNECTED_CLIENT,
Harald Weltef5a0fa32019-03-03 15:44:18 +010079};
80
81enum remsim_server_client_event {
82 CLNTC_E_TCP_UP,
83 CLNTC_E_CLIENT_CONN, /* Connect{Client,Bank}Req received */
84 CLNTC_E_BANK_CONN,
85 CLNTC_E_TCP_DOWN,
Harald Welte15b75e12019-03-08 16:55:46 +010086 CLNTC_E_KA_TIMEOUT,
Harald Weltef5a0fa32019-03-03 15:44:18 +010087 CLNTC_E_CREATE_MAP_RES, /* CreateMappingRes received */
88 CLNTC_E_REMOVE_MAP_RES, /* RemoveMappingRes received */
Harald Weltee5c77732019-03-07 23:58:24 +010089 CLNTC_E_CONFIG_CL_RES, /* ConfigClientRes received */
Harald Weltef5a0fa32019-03-03 15:44:18 +010090 CLNTC_E_PUSH, /* drain maps_new or maps_delreq */
Harald Welte4c37f662019-03-31 15:00:00 +020091 CLNTC_E_CL_CFG_BANKD, /* send [new] ConfigConfigBankReq */
Harald Weltef5a0fa32019-03-03 15:44:18 +010092};
93
94static const struct value_string server_client_event_names[] = {
95 OSMO_VALUE_STRING(CLNTC_E_TCP_UP),
96 OSMO_VALUE_STRING(CLNTC_E_CLIENT_CONN),
97 OSMO_VALUE_STRING(CLNTC_E_BANK_CONN),
98 OSMO_VALUE_STRING(CLNTC_E_TCP_DOWN),
Harald Welte15b75e12019-03-08 16:55:46 +010099 OSMO_VALUE_STRING(CLNTC_E_KA_TIMEOUT),
Harald Weltef5a0fa32019-03-03 15:44:18 +0100100 OSMO_VALUE_STRING(CLNTC_E_CREATE_MAP_RES),
101 OSMO_VALUE_STRING(CLNTC_E_REMOVE_MAP_RES),
Harald Weltee5c77732019-03-07 23:58:24 +0100102 OSMO_VALUE_STRING(CLNTC_E_CONFIG_CL_RES),
Harald Weltef5a0fa32019-03-03 15:44:18 +0100103 OSMO_VALUE_STRING(CLNTC_E_PUSH),
Harald Welte4c37f662019-03-31 15:00:00 +0200104 OSMO_VALUE_STRING(CLNTC_E_CL_CFG_BANKD),
Harald Weltef5a0fa32019-03-03 15:44:18 +0100105 { 0, NULL }
106};
107
108static void clnt_st_init(struct osmo_fsm_inst *fi, uint32_t event, void *data)
109{
110 switch (event) {
111 case CLNTC_E_TCP_UP:
112 osmo_fsm_inst_state_chg(fi, CLNTC_ST_ESTABLISHED, 10, 1);
113 break;
114 default:
115 OSMO_ASSERT(0);
116 }
117}
118
119static void clnt_st_established(struct osmo_fsm_inst *fi, uint32_t event, void *data)
120{
121 struct rspro_client_conn *conn = fi->priv;
122 const RsproPDU_t *pdu = data;
123 const ConnectClientReq_t *cclreq = NULL;
124 const ConnectBankReq_t *cbreq = NULL;
125 RsproPDU_t *resp = NULL;
126
127 switch (event) {
128 case CLNTC_E_CLIENT_CONN:
129 cclreq = &pdu->msg.choice.connectClientReq;
130 /* save the [remote] component identity in 'conn' */
131 rspro_comp_id_retrieve(&conn->comp_id, &cclreq->identity);
132 if (conn->comp_id.type != ComponentType_remsimClient) {
133 LOGPFSM(fi, "ConnectClientReq from identity != Client ?!?\n");
134 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
135 }
Harald Welte4c37f662019-03-31 15:00:00 +0200136
137 /* reparent us from srv->connections to srv->clients */
138 pthread_rwlock_wrlock(&conn->srv->rwlock);
139 llist_del(&conn->list);
140 llist_add_tail(&conn->list, &conn->srv->clients);
141 pthread_rwlock_unlock(&conn->srv->rwlock);
142
Harald Weltee5c77732019-03-07 23:58:24 +0100143 if (!cclreq->clientSlot) {
144#if 0
145 /* FIXME: determine ClientID */
146 resp = rspro_gen_ConnectClientRes(&conn->srv->comp_id, ResultCode_ok);
147 client_conn_send(conn, resp);
148 osmo_fsm_inst_state_chg(fi, CLNTC_ST_WAIT_CL_CONF_RES, 3, 30);
149#else
150 /* FIXME: the original plan was to dynamically assign a ClientID
151 * from server to client here. Send ConfigReq and transition to
152 * CLNTC_ST_WAIT_CONF_RES */
153 LOGPFSM(fi, "ConnectClientReq without ClientId not supported yet!\n");
154 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
155#endif
156 } else {
157 /* FIXME: check for unique-ness */
158 rspro2client_slot(&conn->client.slot, cclreq->clientSlot);
159 osmo_fsm_inst_update_id_f(fi, "C%u:%u", conn->client.slot.client_id,
160 conn->client.slot.slot_nr);
Harald Welte1c691b12019-03-31 10:58:11 +0200161 osmo_fsm_inst_update_id_f(conn->keepalive_fi, "C%u:%u",
162 conn->client.slot.client_id,
163 conn->client.slot.slot_nr);
Harald Weltee5c77732019-03-07 23:58:24 +0100164 resp = rspro_gen_ConnectClientRes(&conn->srv->comp_id, ResultCode_ok);
165 client_conn_send(conn, resp);
Harald Welte0a64da62019-03-30 17:38:04 +0100166 osmo_fsm_inst_state_chg(fi, CLNTC_ST_CONNECTED_CLIENT, 0, 0);
Harald Weltee5c77732019-03-07 23:58:24 +0100167 }
Harald Weltef5a0fa32019-03-03 15:44:18 +0100168 break;
169 case CLNTC_E_BANK_CONN:
170 cbreq = &pdu->msg.choice.connectBankReq;
171 /* save the [remote] component identity in 'conn' */
172 rspro_comp_id_retrieve(&conn->comp_id, &cbreq->identity);
173 if (conn->comp_id.type != ComponentType_remsimBankd) {
174 LOGPFSM(fi, "ConnectBankReq from identity != Bank ?!?\n");
175 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
176 }
Harald Weltee5c77732019-03-07 23:58:24 +0100177 /* FIXME: check for unique-ness */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100178 conn->bank.bank_id = cbreq->bankId;
179 conn->bank.num_slots = cbreq->numberOfSlots;
180 osmo_fsm_inst_update_id_f(fi, "B%u", conn->bank.bank_id);
Harald Welte1c691b12019-03-31 10:58:11 +0200181 osmo_fsm_inst_update_id_f(conn->keepalive_fi, "B%u", conn->bank.bank_id);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100182
183 /* reparent us from srv->connections to srv->banks */
184 pthread_rwlock_wrlock(&conn->srv->rwlock);
185 llist_del(&conn->list);
186 llist_add_tail(&conn->list, &conn->srv->banks);
187 pthread_rwlock_unlock(&conn->srv->rwlock);
188
189 /* send response to bank first */
190 resp = rspro_gen_ConnectBankRes(&conn->srv->comp_id, ResultCode_ok);
191 client_conn_send(conn, resp);
192
193 /* the state change will associate any pre-existing slotmaps */
Harald Welte0a64da62019-03-30 17:38:04 +0100194 osmo_fsm_inst_state_chg(fi, CLNTC_ST_CONNECTED_BANKD, 0, 0);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100195
196 osmo_fsm_inst_dispatch(fi, CLNTC_E_PUSH, NULL);
197 break;
198 default:
199 OSMO_ASSERT(0);
200 }
201}
202
Harald Weltee5c77732019-03-07 23:58:24 +0100203static void clnt_st_wait_cl_conf_res(struct osmo_fsm_inst *fi, uint32_t event, void *data)
204{
205 switch (event) {
206 case CLNTC_E_CONFIG_CL_RES:
Harald Welte0a64da62019-03-30 17:38:04 +0100207 osmo_fsm_inst_state_chg(fi, CLNTC_ST_CONNECTED_CLIENT, 0, 0);
Harald Weltee5c77732019-03-07 23:58:24 +0100208 break;
209 default:
210 OSMO_ASSERT(0);
211 }
212}
Harald Weltef5a0fa32019-03-03 15:44:18 +0100213
Harald Welte4c37f662019-03-31 15:00:00 +0200214/*! find a connected client (if any) for given slotmap and update its Bankd configuration.
215 * \param[in] map slotmap whose client connection shall be updated
216 * \param[in] srv rspro_server on which we operate
217 * \param[in] bankd_conn bankd connection serving the map (may be NULL if not known)
218 */
219static void _update_client_for_slotmap(struct slot_mapping *map, struct rspro_server *srv,
220 struct rspro_client_conn *bankd_conn)
221{
Harald Welteea3eefe2020-02-16 15:26:35 +0100222 struct rspro_client_conn *conn;
Harald Welte4c37f662019-03-31 15:00:00 +0200223 char ip_str[INET6_ADDRSTRLEN];
224 char port_str[6];
225 uint32_t bankd_ip;
226 int bankd_port;
227 bool changed = false;
228 int rc;
229
230 OSMO_ASSERT(map);
231 OSMO_ASSERT(srv);
232
Harald Welteea3eefe2020-02-16 15:26:35 +0100233 conn = client_conn_by_slot(srv, &map->client);
Harald Welte4c37f662019-03-31 15:00:00 +0200234 if (!conn)
235 LOGP(DMAIN, LOGL_DEBUG, "%s\n", __func__);
236 else
237 LOGPFSM(conn->fi, "%s\n", __func__);
238
239 if (!conn)
240 return;
241
242 if (!bank_slot_equals(&conn->client.bankd.slot, &map->bank)) {
243 LOGPFSM(conn->fi, "BankSlot has changed B%u:%u -> B%u:%u\n",
244 conn->client.bankd.slot.bank_id, conn->client.bankd.slot.slot_nr,
245 map->bank.bank_id, map->bank.slot_nr);
246 conn->client.bankd.slot = map->bank;
247 changed = true;
248 }
249
250 /* if caller didn't provide bankd_conn, resolve it from map */
251 if (!bankd_conn)
252 bankd_conn = bankd_conn_by_id(srv, map->bank.bank_id);
Harald Welte3598c582020-02-16 15:30:38 +0100253 if (map->state == SLMAP_S_DELETING || !bankd_conn) {
254 bankd_ip = 0;
255 bankd_port = 0;
256 } else {
257 /* obtain IP and port of bankd */
258 rc = osmo_sock_get_ip_and_port(bankd_conn->peer->ofd.fd, ip_str, sizeof(ip_str),
259 port_str, sizeof(port_str), false);
260 if (rc < 0) {
261 LOGPFSM(bankd_conn->fi, "Error during getpeername\n");
262 return;
263 }
264 bankd_ip = ntohl(inet_addr(ip_str));
265 bankd_port = 9999; /* TODO: configurable */
Harald Welte4c37f662019-03-31 15:00:00 +0200266 }
Harald Welte3598c582020-02-16 15:30:38 +0100267
268 /* determine if IP/port of bankd have changed */
Harald Welte4c37f662019-03-31 15:00:00 +0200269 if (conn->client.bankd.port != bankd_port || conn->client.bankd.ip != bankd_ip) {
Harald Welte3598c582020-02-16 15:30:38 +0100270 struct in_addr ia = { .s_addr = bankd_ip };
271 LOGPFSM(conn->fi, "Bankd IP/Port changed to %s:%u\n", inet_ntoa(ia), bankd_port);
Harald Welte4c37f662019-03-31 15:00:00 +0200272 conn->client.bankd.ip = bankd_ip;
273 conn->client.bankd.port = bankd_port;
274 changed = true;
275 }
276
277 /* update the client with new bankd information, if any changes were made */
278 if (changed)
279 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CL_CFG_BANKD, NULL);
280}
281
Harald Welte0a64da62019-03-30 17:38:04 +0100282static void clnt_st_connected_client_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100283{
Harald Weltef5a0fa32019-03-03 15:44:18 +0100284 struct rspro_client_conn *conn = fi->priv;
Harald Welte4c37f662019-03-31 15:00:00 +0200285 struct slotmaps *slotmaps = conn->srv->slotmaps;
286 struct slot_mapping *map;
287
288 LOGPFSM(fi, "%s\n", __func__);
289
290 /* check for an existing slotmap for this client/slot */
291 slotmaps_rdlock(slotmaps);
292 llist_for_each_entry(map, &slotmaps->mappings, list) {
293 if (client_slot_equals(&map->client, &conn->client.slot)) {
294 _update_client_for_slotmap(map, conn->srv, NULL);
295 break;
296 }
297 }
298 slotmaps_unlock(slotmaps);
299#if 0
Harald Weltef5a0fa32019-03-03 15:44:18 +0100300 ClientSlot_t clslot;
301 RsproPDU_t *pdu;
302
303 /* send configuration to this new client */
304 client_slot2rspro(&clslot, FIXME);
305 pdu = rspro_gen_ConfigClientReq(&clslot, bankd_ip, bankd_port);
306 client_conn_send(conn, pdu);
307#endif
308}
309
Harald Welte0a64da62019-03-30 17:38:04 +0100310static void clnt_st_connected_bankd_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100311{
312 struct rspro_client_conn *conn = fi->priv;
313 struct slotmaps *slotmaps = conn->srv->slotmaps;
314 struct slot_mapping *map;
315
316 LOGPFSM(fi, "Associating pre-existing slotmaps (if any)\n");
317 /* Link all known mappings to this new bank */
318 slotmaps_wrlock(slotmaps);
319 llist_for_each_entry(map, &slotmaps->mappings, list) {
320 if (map->bank.bank_id == conn->bank.bank_id)
321 _slotmap_state_change(map, SLMAP_S_NEW, &conn->bank.maps_new);
322 }
323 slotmaps_unlock(slotmaps);
324}
325
Harald Welte0a64da62019-03-30 17:38:04 +0100326static void clnt_st_connected_client(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100327{
328 struct rspro_client_conn *conn = fi->priv;
Harald Welte4c37f662019-03-31 15:00:00 +0200329 BankSlot_t bslot;
330 RsproPDU_t *tx;
Harald Welte0a64da62019-03-30 17:38:04 +0100331
332 switch (event) {
Harald Welte4c37f662019-03-31 15:00:00 +0200333 case CLNTC_E_CL_CFG_BANKD: /* Send [new] Bankd information to client */
334 bank_slot2rspro(&bslot, &conn->client.bankd.slot);
335 tx = rspro_gen_ConfigClientBankReq(&bslot, conn->client.bankd.ip,
336 conn->client.bankd.port);
337 client_conn_send(conn, tx);
338 break;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100339 default:
340 OSMO_ASSERT(0);
341 }
342}
343
Harald Welte0a64da62019-03-30 17:38:04 +0100344static void clnt_st_connected_bankd(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100345{
346 struct rspro_client_conn *conn = fi->priv;
347 struct slotmaps *slotmaps = conn->srv->slotmaps;
Harald Welte35ded292019-03-31 15:13:09 +0200348 const __attribute__((unused)) RsproPDU_t *rx = NULL;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100349 struct slot_mapping *map, *map2;
350
351 switch (event) {
Harald Welte1b07f7f2019-03-30 17:33:07 +0100352 case CLNTC_E_CREATE_MAP_RES: /* Bankd acknowledges mapping was created */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100353 rx = data;
354 slotmaps_wrlock(slotmaps);
355 /* FIXME: resolve map by pdu->tag */
356 /* as hack use first element of conn->maps_unack */
357 map = llist_first_entry(&conn->bank.maps_unack, struct slot_mapping, bank_list);
358 if (!map) {
359 slotmaps_unlock(slotmaps);
360 LOGPFSM(fi, "CreateMapRes but no unacknowledged map");
361 break;
362 }
363 _slotmap_state_change(map, SLMAP_S_ACTIVE, &conn->bank.maps_active);
364 slotmaps_unlock(slotmaps);
Harald Welte4c37f662019-03-31 15:00:00 +0200365 _update_client_for_slotmap(map, conn->srv, conn);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100366 break;
Harald Welte1b07f7f2019-03-30 17:33:07 +0100367 case CLNTC_E_REMOVE_MAP_RES: /* Bankd acknowledges mapping was removed */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100368 rx = data;
369 slotmaps_wrlock(slotmaps);
370 /* FIXME: resolve map by pdu->tag */
371 /* as hack use first element of conn->maps_deleting */
372 map = llist_first_entry(&conn->bank.maps_deleting, struct slot_mapping, bank_list);
373 if (!map) {
374 slotmaps_unlock(slotmaps);
375 LOGPFSM(fi, "RemoveMapRes but no unacknowledged map");
376 break;
377 }
378 slotmaps_unlock(slotmaps);
Harald Welte3598c582020-02-16 15:30:38 +0100379 /* update client! */
380 OSMO_ASSERT(map->state == SLMAP_S_DELETING);
381 _update_client_for_slotmap(map, conn->srv, conn);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100382 /* slotmap_del() will remove it from both global and bank list */
383 slotmap_del(map->maps, map);
384 break;
Harald Welte1b07f7f2019-03-30 17:33:07 +0100385 case CLNTC_E_PUSH: /* check if any create or delete requests are pending */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100386 slotmaps_wrlock(slotmaps);
387 /* send any pending create requests */
388 llist_for_each_entry_safe(map, map2, &conn->bank.maps_new, bank_list) {
389 RsproPDU_t *pdu = slotmap2CreateMappingReq(map);
390 client_conn_send(conn, pdu);
391 _slotmap_state_change(map, SLMAP_S_UNACKNOWLEDGED, &conn->bank.maps_unack);
392 }
393 /* send any pending delete requests */
394 llist_for_each_entry_safe(map, map2, &conn->bank.maps_delreq, bank_list) {
395 RsproPDU_t *pdu = slotmap2RemoveMappingReq(map);
396 client_conn_send(conn, pdu);
397 _slotmap_state_change(map, SLMAP_S_DELETING, &conn->bank.maps_deleting);
398 }
399 slotmaps_unlock(slotmaps);
400 break;
401 default:
402 OSMO_ASSERT(0);
403 }
404}
405
406static void clnt_allstate_action(struct osmo_fsm_inst *fi, uint32_t event, void *data)
407{
Harald Welte35ded292019-03-31 15:13:09 +0200408 //struct rspro_client_conn *conn = fi->priv;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100409
410 switch (event) {
411 case CLNTC_E_TCP_DOWN:
412 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL);
413 break;
Harald Welte15b75e12019-03-08 16:55:46 +0100414 case CLNTC_E_KA_TIMEOUT:
415 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL);
416 break;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100417 default:
418 OSMO_ASSERT(0);
419 }
420}
421
422static int server_client_fsm_timer_cb(struct osmo_fsm_inst *fi)
423{
Harald Welte35ded292019-03-31 15:13:09 +0200424 //struct rspro_client_conn *conn = fi->priv;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100425
426 switch (fi->T) {
427 case 1:
428 /* No ClientConnectReq received:disconnect */
429 return 1; /* ask core to terminate FSM */
430 default:
431 OSMO_ASSERT(0);
432 }
433 return 0;
434}
435
436static void server_client_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause)
437{
438 struct rspro_client_conn *conn = fi->priv;
439 /* this call will destroy the IPA connection, which will in turn call closed_cb()
440 * which will try to deliver a E_TCP_DOWN event. Clear conn->fi to avoid that loop */
441 conn->fi = NULL;
442 rspro_client_conn_destroy(conn);
443}
444
445static const struct osmo_fsm_state server_client_fsm_states[] = {
446 [CLNTC_ST_INIT] = {
447 .name = "INIT",
448 .in_event_mask = S(CLNTC_E_TCP_UP),
449 .out_state_mask = S(CLNTC_ST_ESTABLISHED),
450 .action = clnt_st_init,
451 },
452 [CLNTC_ST_ESTABLISHED] = {
453 .name = "ESTABLISHED",
454 .in_event_mask = S(CLNTC_E_CLIENT_CONN) | S(CLNTC_E_BANK_CONN),
Harald Welte0a64da62019-03-30 17:38:04 +0100455 .out_state_mask = S(CLNTC_ST_CONNECTED_CLIENT) | S(CLNTC_ST_WAIT_CONF_RES) |
456 S(CLNTC_ST_CONNECTED_BANKD),
Harald Weltef5a0fa32019-03-03 15:44:18 +0100457 .action = clnt_st_established,
458 },
Harald Weltee5c77732019-03-07 23:58:24 +0100459 [CLNTC_ST_WAIT_CONF_RES] = {
460 .name = "WAIT_CONFIG_RES",
461 .in_event_mask = S(CLNTC_E_CONFIG_CL_RES),
Harald Welte0a64da62019-03-30 17:38:04 +0100462 .out_state_mask = S(CLNTC_ST_CONNECTED_CLIENT),
Harald Weltee5c77732019-03-07 23:58:24 +0100463 .action = clnt_st_wait_cl_conf_res,
464 },
Harald Welte0a64da62019-03-30 17:38:04 +0100465 [CLNTC_ST_CONNECTED_CLIENT] = {
466 .name = "CONNECTED_CLIENT",
Harald Welte4c37f662019-03-31 15:00:00 +0200467 .in_event_mask = S(CLNTC_E_CL_CFG_BANKD),
Harald Welte0a64da62019-03-30 17:38:04 +0100468 .action = clnt_st_connected_client,
469 .onenter = clnt_st_connected_client_onenter,
470 },
471 [CLNTC_ST_CONNECTED_BANKD] = {
472 .name = "CONNECTED_BANKD",
Harald Weltef5a0fa32019-03-03 15:44:18 +0100473 .in_event_mask = S(CLNTC_E_CREATE_MAP_RES) | S(CLNTC_E_REMOVE_MAP_RES) |
474 S(CLNTC_E_PUSH),
Harald Welte0a64da62019-03-30 17:38:04 +0100475 .action = clnt_st_connected_bankd,
476 .onenter = clnt_st_connected_bankd_onenter,
Harald Weltef5a0fa32019-03-03 15:44:18 +0100477 },
Harald Welte0a64da62019-03-30 17:38:04 +0100478
Harald Weltef5a0fa32019-03-03 15:44:18 +0100479};
480
481static struct osmo_fsm remsim_server_client_fsm = {
482 .name = "SERVER_CONN",
483 .states = server_client_fsm_states,
484 .num_states = ARRAY_SIZE(server_client_fsm_states),
Harald Welte10f7a762019-03-31 12:38:47 +0200485 .allstate_event_mask = S(CLNTC_E_TCP_DOWN) | S(CLNTC_E_KA_TIMEOUT),
Harald Weltef5a0fa32019-03-03 15:44:18 +0100486 .allstate_action = clnt_allstate_action,
487 .cleanup = server_client_cleanup,
488 .timer_cb = server_client_fsm_timer_cb,
489 .log_subsys = DMAIN,
490 .event_names = server_client_event_names,
491};
492
493struct osmo_fsm_inst *server_client_fsm_alloc(void *ctx, struct rspro_client_conn *conn)
494{
495 //const char *id = osmo_sock_get_name2(conn->peer->ofd.fd);
496 return osmo_fsm_inst_alloc(&remsim_server_client_fsm, ctx, conn, LOGL_DEBUG, NULL);
497}
498
499
500static __attribute__((constructor)) void on_dso_load(void)
501{
Harald Welte4ccd2fc2019-12-01 13:32:54 +0100502 OSMO_ASSERT(osmo_fsm_register(&remsim_server_client_fsm) == 0);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100503}
504
505
506/***********************************************************************
507 * IPA RSPRO Server
508 ***********************************************************************/
509
Harald Weltef30ff9e2019-03-30 19:17:37 +0100510struct rspro_client_conn *_client_conn_by_slot(struct rspro_server *srv, const struct client_slot *cslot)
511{
512 struct rspro_client_conn *conn;
513 llist_for_each_entry(conn, &srv->clients, list) {
514 if (client_slot_equals(&conn->client.slot, cslot))
515 return conn;
516 }
517 return NULL;
518}
519struct rspro_client_conn *client_conn_by_slot(struct rspro_server *srv, const struct client_slot *cslot)
520{
521 struct rspro_client_conn *conn;
522 pthread_rwlock_rdlock(&srv->rwlock);
523 conn = _client_conn_by_slot(srv, cslot);
524 pthread_rwlock_unlock(&srv->rwlock);
525 return conn;
526}
527
Harald Weltef5a0fa32019-03-03 15:44:18 +0100528struct rspro_client_conn *_bankd_conn_by_id(struct rspro_server *srv, uint16_t bank_id)
529{
530 struct rspro_client_conn *conn;
531 llist_for_each_entry(conn, &srv->banks, list) {
532 if (conn->bank.bank_id == bank_id)
533 return conn;
534 }
535 return NULL;
536}
537struct rspro_client_conn *bankd_conn_by_id(struct rspro_server *srv, uint16_t bank_id)
538{
539 struct rspro_client_conn *conn;
540 pthread_rwlock_rdlock(&srv->rwlock);
541 conn = _bankd_conn_by_id(srv, bank_id);
542 pthread_rwlock_unlock(&srv->rwlock);
543 return conn;
544}
545
546static int handle_rx_rspro(struct rspro_client_conn *conn, const RsproPDU_t *pdu)
547{
Harald Welteb49ac9c2019-03-09 20:36:07 +0100548 LOGPFSM(conn->fi, "Rx RSPRO %s\n", rspro_msgt_name(pdu));
549
Harald Weltef5a0fa32019-03-03 15:44:18 +0100550 switch (pdu->msg.present) {
551 case RsproPDUchoice_PR_connectClientReq:
552 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CLIENT_CONN, (void *)pdu);
553 break;
554 case RsproPDUchoice_PR_connectBankReq:
555 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_BANK_CONN, (void *)pdu);
556 break;
557 case RsproPDUchoice_PR_createMappingRes:
558 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CREATE_MAP_RES, (void *)pdu);
559 break;
560 case RsproPDUchoice_PR_removeMappingRes:
561 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_REMOVE_MAP_RES, (void *)pdu);
562 break;
Harald Welted571a3e2019-03-11 22:09:50 +0100563 case RsproPDUchoice_PR_configClientIdRes:
Harald Weltee5c77732019-03-07 23:58:24 +0100564 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CONFIG_CL_RES, (void *)pdu);
565 break;
Harald Welte19dee082019-03-31 10:53:45 +0200566 case RsproPDUchoice_PR_configClientBankRes:
567 /* TODO: store somewhere that client has ACKed? */
568 break;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100569 default:
Harald Welte19dee082019-03-31 10:53:45 +0200570 LOGPFSML(conn->fi, LOGL_ERROR, "Received unknown/unimplemented RSPRO msg_type %s\n",
571 rspro_msgt_name(pdu));
Harald Weltef5a0fa32019-03-03 15:44:18 +0100572 return -1;
573 }
574 return 0;
575}
576
577/* data was received from one of the client connections to the RSPRO socket */
578static int sock_read_cb(struct ipa_server_conn *peer, struct msgb *msg)
579{
580 struct ipaccess_head *hh = (struct ipaccess_head *) msg->data;
581 struct ipaccess_head_ext *he = (struct ipaccess_head_ext *) msgb_l2(msg);
582 struct rspro_client_conn *conn = peer->data;
583 RsproPDU_t *pdu;
584 int rc;
585
586 if (msgb_length(msg) < sizeof(*hh))
587 goto invalid;
588 msg->l2h = &hh->data[0];
Harald Welte7bfcc652019-03-08 16:55:01 +0100589 switch (hh->proto) {
590 case IPAC_PROTO_IPACCESS:
591 rc = ipa_server_conn_ccm(peer, msg);
Harald Welte15b75e12019-03-08 16:55:46 +0100592 if (rc < 0)
593 break;
594 switch (hh->data[0]) {
595 case IPAC_MSGT_PONG:
596 ipa_keepalive_fsm_pong_received(conn->keepalive_fi);
597 rc = 0;
598 break;
599 default:
600 break;
601 }
Harald Welte7bfcc652019-03-08 16:55:01 +0100602 break;
603 case IPAC_PROTO_OSMO:
604 if (!he || msgb_l2len(msg)< sizeof(*he))
605 goto invalid;
606 msg->l2h = &he->data[0];
Harald Weltef5a0fa32019-03-03 15:44:18 +0100607
Harald Welte7bfcc652019-03-08 16:55:01 +0100608 switch (he->proto) {
609 case IPAC_PROTO_EXT_RSPRO:
610 pdu = rspro_dec_msg(msg);
611 if (!pdu)
612 goto invalid;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100613
Harald Welte7bfcc652019-03-08 16:55:01 +0100614 rc = handle_rx_rspro(conn, pdu);
615 ASN_STRUCT_FREE(asn_DEF_RsproPDU, pdu);
616 break;
617 default:
618 goto invalid;
619 }
620 break;
621 default:
Harald Weltef5a0fa32019-03-03 15:44:18 +0100622 goto invalid;
Harald Welte7bfcc652019-03-08 16:55:01 +0100623 }
Harald Welte6b990f92019-07-18 18:16:33 +0200624 msgb_free(msg);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100625 return rc;
626
627invalid:
628 msgb_free(msg);
629 return -1;
630}
631
632static int sock_closed_cb(struct ipa_server_conn *peer)
633{
634 struct rspro_client_conn *conn = peer->data;
635 if (conn->fi)
636 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_TCP_DOWN, NULL);
637 /* FIXME: who cleans up conn? */
638 /* ipa server code relases 'peer' just after this */
639 return 0;
640}
641
Harald Welte15b75e12019-03-08 16:55:46 +0100642static const struct ipa_keepalive_params ka_params = {
643 .interval = 30,
644 .wait_for_resp = 10,
645};
646
Harald Weltef5a0fa32019-03-03 15:44:18 +0100647/* a new TCP connection was accepted on the RSPRO server socket */
648static int accept_cb(struct ipa_server_link *link, int fd)
649{
650 struct rspro_server *srv = link->data;
651 struct rspro_client_conn *conn;
652
653 conn = talloc_zero(srv, struct rspro_client_conn);
654 OSMO_ASSERT(conn);
655
656 conn->srv = srv;
657 /* don't allocate peer under 'conn', as it must survive 'conn' during teardown */
658 conn->peer = ipa_server_conn_create(link, link, fd, sock_read_cb, sock_closed_cb, conn);
659 if (!conn->peer)
660 goto out_err;
661
662 /* don't allocate 'fi' as slave from 'conn', as 'fi' needs to survive 'conn' during
663 * teardown */
664 conn->fi = server_client_fsm_alloc(srv, conn);
665 if (!conn->fi)
666 goto out_err_conn;
667
Harald Welte15b75e12019-03-08 16:55:46 +0100668 /* use ipa_keepalive_fsm to periodically send an IPA_PING and expect a PONG in response */
669 conn->keepalive_fi = ipa_server_conn_alloc_keepalive_fsm(conn->peer, &ka_params, NULL);
670 if (!conn->keepalive_fi)
671 goto out_err_fi;
672 /* ensure parent is notified once keepalive FSM instance is dying */
673 osmo_fsm_inst_change_parent(conn->keepalive_fi, conn->fi, CLNTC_E_KA_TIMEOUT);
674 ipa_keepalive_fsm_start(conn->keepalive_fi);
675
Harald Weltef5a0fa32019-03-03 15:44:18 +0100676 INIT_LLIST_HEAD(&conn->bank.maps_new);
677 INIT_LLIST_HEAD(&conn->bank.maps_unack);
678 INIT_LLIST_HEAD(&conn->bank.maps_active);
679 INIT_LLIST_HEAD(&conn->bank.maps_delreq);
680 INIT_LLIST_HEAD(&conn->bank.maps_deleting);
681
682 pthread_rwlock_wrlock(&conn->srv->rwlock);
683 llist_add_tail(&conn->list, &srv->connections);
684 pthread_rwlock_unlock(&conn->srv->rwlock);
685
686 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_TCP_UP, NULL);
687 return 0;
688
Harald Welte15b75e12019-03-08 16:55:46 +0100689out_err_fi:
690 osmo_fsm_inst_term(conn->fi, OSMO_FSM_TERM_ERROR, NULL);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100691out_err_conn:
692 ipa_server_conn_destroy(conn->peer);
693 /* the above will free 'conn' down the chain */
694 return -1;
695out_err:
696 talloc_free(conn);
697 return -1;
698}
699
700/* call-back if we were triggered by a rest_api thread */
701int event_fd_cb(struct osmo_fd *ofd, unsigned int what)
702{
703 struct rspro_server *srv = ofd->data;
704 struct rspro_client_conn *conn;
705 bool non_empty_new, non_empty_del;
706 uint64_t value;
707 int rc;
708
709 /* read from the socket to "confirm" the event and make it non-readable again */
710 rc = read(ofd->fd, &value, 8);
711 if (rc < 8) {
Harald Weltea9d7ad12021-12-08 21:09:12 +0100712 LOGP(DMAIN, LOGL_ERROR, "Error reading eventfd: %d\n", rc);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100713 return rc;
714 }
715
Harald Weltea9d7ad12021-12-08 21:09:12 +0100716 LOGP(DMAIN, LOGL_INFO, "Event FD arrived, checking for any pending work\n");
Harald Weltef5a0fa32019-03-03 15:44:18 +0100717
718 pthread_rwlock_rdlock(&srv->rwlock);
719 llist_for_each_entry(conn, &srv->banks, list) {
720 slotmaps_rdlock(srv->slotmaps);
721 non_empty_new = llist_empty(&conn->bank.maps_new);
722 non_empty_del = llist_empty(&conn->bank.maps_delreq);
723 slotmaps_unlock(srv->slotmaps);
724
725 /* trigger FSM to send any pending new/deleted maps */
726 if (non_empty_new || non_empty_del)
727 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_PUSH, NULL);
728 }
729 pthread_rwlock_unlock(&srv->rwlock);
730
731 return 0;
732}
733
734/* unlink all slotmaps from any of the lists of this conn->bank.maps_* */
735static void _unlink_all_slotmaps(struct rspro_client_conn *conn)
736{
737 struct slot_mapping *smap, *smap2;
738
739 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_new, bank_list) {
740 /* unlink from list and keep in state NEW */
741 _slotmap_state_change(smap, SLMAP_S_NEW, NULL);
742 }
743 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_unack, bank_list) {
744 /* unlink from list and change to state NEW */
745 _slotmap_state_change(smap, SLMAP_S_NEW, NULL);
746 }
747 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_active, bank_list) {
748 /* unlink from list and change to state NEW */
749 _slotmap_state_change(smap, SLMAP_S_NEW, NULL);
750 }
751 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_delreq, bank_list) {
752 /* unlink from list and delete */
753 _slotmap_del(smap->maps, smap);
754 }
755 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_deleting, bank_list) {
756 /* unlink from list and delete */
757 _slotmap_del(smap->maps, smap);
758 }
759}
760
761/* only to be used by the FSM cleanup. */
762static void rspro_client_conn_destroy(struct rspro_client_conn *conn)
763{
764 /* this will internally call closed_cb() which will dispatch a TCP_DOWN event */
765 ipa_server_conn_destroy(conn->peer);
766 conn->peer = NULL;
767
768 /* ensure all slotmaps are unlinked + returned to NEW or deleted */
769 slotmaps_wrlock(conn->srv->slotmaps);
770 _unlink_all_slotmaps(conn);
771 slotmaps_unlock(conn->srv->slotmaps);
772
773 pthread_rwlock_wrlock(&conn->srv->rwlock);
774 llist_del(&conn->list);
775 pthread_rwlock_unlock(&conn->srv->rwlock);
776
777 talloc_free(conn);
778}
779
780
781struct rspro_server *rspro_server_create(void *ctx, const char *host, uint16_t port)
782
783{
784 struct rspro_server *srv = talloc_zero(ctx, struct rspro_server);
785 OSMO_ASSERT(srv);
786
787 pthread_rwlock_init(&srv->rwlock, NULL);
788 pthread_rwlock_wrlock(&srv->rwlock);
789 INIT_LLIST_HEAD(&srv->connections);
790 INIT_LLIST_HEAD(&srv->clients);
791 INIT_LLIST_HEAD(&srv->banks);
792 pthread_rwlock_unlock(&srv->rwlock);
793
794 srv->link = ipa_server_link_create(ctx, NULL, host, port, accept_cb, srv);
795 ipa_server_link_open(srv->link);
796
797 return srv;
798}
799
800void rspro_server_destroy(struct rspro_server *srv)
801{
802 /* FIXME: clear all lists */
803
804 ipa_server_link_destroy(srv->link);
805 srv->link = NULL;
806 talloc_free(srv);
807}