blob: c4d4d79bdbbcdd18d9f3c7a52406a2321d420273 [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 Welte15e8b7f2022-04-27 09:24:21 +020052 LOGPFSML(conn->fi, LOGL_DEBUG, "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;
Harald Weltefb48de82022-04-27 09:15:43 +0200126 char ip_str[INET6_ADDRSTRLEN];
127 char port_str[6];
128
129 /* remote IP and port */
130 osmo_sock_get_ip_and_port(conn->peer->ofd.fd, ip_str, sizeof(ip_str),
131 port_str, sizeof(port_str), false);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100132
133 switch (event) {
134 case CLNTC_E_CLIENT_CONN:
135 cclreq = &pdu->msg.choice.connectClientReq;
136 /* save the [remote] component identity in 'conn' */
137 rspro_comp_id_retrieve(&conn->comp_id, &cclreq->identity);
138 if (conn->comp_id.type != ComponentType_remsimClient) {
Harald Welte15e8b7f2022-04-27 09:24:21 +0200139 LOGPFSML(fi, LOGL_ERROR, "ConnectClientReq from identity != Client ?!?\n");
Harald Weltef5a0fa32019-03-03 15:44:18 +0100140 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
Harald Welte900ee722022-05-03 16:22:21 +0200141 return;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100142 }
Harald Welte4c37f662019-03-31 15:00:00 +0200143
144 /* reparent us from srv->connections to srv->clients */
145 pthread_rwlock_wrlock(&conn->srv->rwlock);
146 llist_del(&conn->list);
147 llist_add_tail(&conn->list, &conn->srv->clients);
148 pthread_rwlock_unlock(&conn->srv->rwlock);
149
Harald Weltee5c77732019-03-07 23:58:24 +0100150 if (!cclreq->clientSlot) {
151#if 0
152 /* FIXME: determine ClientID */
153 resp = rspro_gen_ConnectClientRes(&conn->srv->comp_id, ResultCode_ok);
154 client_conn_send(conn, resp);
155 osmo_fsm_inst_state_chg(fi, CLNTC_ST_WAIT_CL_CONF_RES, 3, 30);
156#else
157 /* FIXME: the original plan was to dynamically assign a ClientID
158 * from server to client here. Send ConfigReq and transition to
159 * CLNTC_ST_WAIT_CONF_RES */
Harald Welte15e8b7f2022-04-27 09:24:21 +0200160 LOGPFSML(fi, LOGL_ERROR, "ConnectClientReq without ClientId not supported yet!\n");
Harald Weltee5c77732019-03-07 23:58:24 +0100161 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
162#endif
163 } else {
164 /* FIXME: check for unique-ness */
165 rspro2client_slot(&conn->client.slot, cclreq->clientSlot);
166 osmo_fsm_inst_update_id_f(fi, "C%u:%u", conn->client.slot.client_id,
167 conn->client.slot.slot_nr);
Harald Welte1c691b12019-03-31 10:58:11 +0200168 osmo_fsm_inst_update_id_f(conn->keepalive_fi, "C%u:%u",
169 conn->client.slot.client_id,
170 conn->client.slot.slot_nr);
Harald Weltefb48de82022-04-27 09:15:43 +0200171 LOGPFSML(fi, LOGL_INFO, "Client connected from %s:%s\n", ip_str, port_str);
Harald Weltee5c77732019-03-07 23:58:24 +0100172 resp = rspro_gen_ConnectClientRes(&conn->srv->comp_id, ResultCode_ok);
173 client_conn_send(conn, resp);
Harald Welte0a64da62019-03-30 17:38:04 +0100174 osmo_fsm_inst_state_chg(fi, CLNTC_ST_CONNECTED_CLIENT, 0, 0);
Harald Weltee5c77732019-03-07 23:58:24 +0100175 }
Harald Weltef5a0fa32019-03-03 15:44:18 +0100176 break;
177 case CLNTC_E_BANK_CONN:
178 cbreq = &pdu->msg.choice.connectBankReq;
179 /* save the [remote] component identity in 'conn' */
180 rspro_comp_id_retrieve(&conn->comp_id, &cbreq->identity);
181 if (conn->comp_id.type != ComponentType_remsimBankd) {
Harald Welte15e8b7f2022-04-27 09:24:21 +0200182 LOGPFSML(fi, LOGL_ERROR, "ConnectBankReq from identity != Bank ?!?\n");
Harald Weltef5a0fa32019-03-03 15:44:18 +0100183 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
Harald Welte900ee722022-05-03 16:22:21 +0200184 return;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100185 }
Harald Weltee5c77732019-03-07 23:58:24 +0100186 /* FIXME: check for unique-ness */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100187 conn->bank.bank_id = cbreq->bankId;
188 conn->bank.num_slots = cbreq->numberOfSlots;
189 osmo_fsm_inst_update_id_f(fi, "B%u", conn->bank.bank_id);
Harald Welte1c691b12019-03-31 10:58:11 +0200190 osmo_fsm_inst_update_id_f(conn->keepalive_fi, "B%u", conn->bank.bank_id);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100191
Harald Weltefb48de82022-04-27 09:15:43 +0200192 LOGPFSML(fi, LOGL_INFO, "Bankd connected from %s:%s\n", ip_str, port_str);
193 if (!strncmp(ip_str, "127.", 4)) {
194 LOGPFSML(fi, LOGL_NOTICE, "Bankd connected from %s (localhost). "
195 "This only works if your clients also all are on localhost, "
196 "as they must be able to reach the bankd!\n", ip_str);
197 }
198
Harald Weltef5a0fa32019-03-03 15:44:18 +0100199 /* reparent us from srv->connections to srv->banks */
200 pthread_rwlock_wrlock(&conn->srv->rwlock);
201 llist_del(&conn->list);
202 llist_add_tail(&conn->list, &conn->srv->banks);
203 pthread_rwlock_unlock(&conn->srv->rwlock);
204
205 /* send response to bank first */
206 resp = rspro_gen_ConnectBankRes(&conn->srv->comp_id, ResultCode_ok);
207 client_conn_send(conn, resp);
208
209 /* the state change will associate any pre-existing slotmaps */
Harald Welte0a64da62019-03-30 17:38:04 +0100210 osmo_fsm_inst_state_chg(fi, CLNTC_ST_CONNECTED_BANKD, 0, 0);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100211
212 osmo_fsm_inst_dispatch(fi, CLNTC_E_PUSH, NULL);
213 break;
214 default:
215 OSMO_ASSERT(0);
216 }
217}
218
Harald Weltee5c77732019-03-07 23:58:24 +0100219static void clnt_st_wait_cl_conf_res(struct osmo_fsm_inst *fi, uint32_t event, void *data)
220{
221 switch (event) {
222 case CLNTC_E_CONFIG_CL_RES:
Harald Welte0a64da62019-03-30 17:38:04 +0100223 osmo_fsm_inst_state_chg(fi, CLNTC_ST_CONNECTED_CLIENT, 0, 0);
Harald Weltee5c77732019-03-07 23:58:24 +0100224 break;
225 default:
226 OSMO_ASSERT(0);
227 }
228}
Harald Weltef5a0fa32019-03-03 15:44:18 +0100229
Harald Welte4c37f662019-03-31 15:00:00 +0200230/*! find a connected client (if any) for given slotmap and update its Bankd configuration.
231 * \param[in] map slotmap whose client connection shall be updated
232 * \param[in] srv rspro_server on which we operate
233 * \param[in] bankd_conn bankd connection serving the map (may be NULL if not known)
234 */
235static void _update_client_for_slotmap(struct slot_mapping *map, struct rspro_server *srv,
236 struct rspro_client_conn *bankd_conn)
237{
Harald Welteea3eefe2020-02-16 15:26:35 +0100238 struct rspro_client_conn *conn;
Harald Welte4c37f662019-03-31 15:00:00 +0200239 char ip_str[INET6_ADDRSTRLEN];
240 char port_str[6];
241 uint32_t bankd_ip;
242 int bankd_port;
243 bool changed = false;
244 int rc;
245
246 OSMO_ASSERT(map);
247 OSMO_ASSERT(srv);
248
Harald Welteea3eefe2020-02-16 15:26:35 +0100249 conn = client_conn_by_slot(srv, &map->client);
Harald Welte4c37f662019-03-31 15:00:00 +0200250 if (!conn)
251 LOGP(DMAIN, LOGL_DEBUG, "%s\n", __func__);
252 else
Harald Welte15e8b7f2022-04-27 09:24:21 +0200253 LOGPFSML(conn->fi, LOGL_DEBUG, "%s\n", __func__);
Harald Welte4c37f662019-03-31 15:00:00 +0200254
255 if (!conn)
256 return;
257
258 if (!bank_slot_equals(&conn->client.bankd.slot, &map->bank)) {
Harald Welte15e8b7f2022-04-27 09:24:21 +0200259 LOGPFSML(conn->fi, LOGL_NOTICE, "BankSlot has changed B%u:%u -> B%u:%u\n",
Harald Welte4c37f662019-03-31 15:00:00 +0200260 conn->client.bankd.slot.bank_id, conn->client.bankd.slot.slot_nr,
261 map->bank.bank_id, map->bank.slot_nr);
262 conn->client.bankd.slot = map->bank;
263 changed = true;
264 }
265
266 /* if caller didn't provide bankd_conn, resolve it from map */
267 if (!bankd_conn)
268 bankd_conn = bankd_conn_by_id(srv, map->bank.bank_id);
Harald Welte3598c582020-02-16 15:30:38 +0100269 if (map->state == SLMAP_S_DELETING || !bankd_conn) {
270 bankd_ip = 0;
271 bankd_port = 0;
272 } else {
273 /* obtain IP and port of bankd */
274 rc = osmo_sock_get_ip_and_port(bankd_conn->peer->ofd.fd, ip_str, sizeof(ip_str),
275 port_str, sizeof(port_str), false);
276 if (rc < 0) {
Harald Welte15e8b7f2022-04-27 09:24:21 +0200277 LOGPFSML(bankd_conn->fi, LOGL_ERROR, "Error during getpeername\n");
Harald Welte3598c582020-02-16 15:30:38 +0100278 return;
279 }
280 bankd_ip = ntohl(inet_addr(ip_str));
281 bankd_port = 9999; /* TODO: configurable */
Harald Welte4c37f662019-03-31 15:00:00 +0200282 }
Harald Welte3598c582020-02-16 15:30:38 +0100283
284 /* determine if IP/port of bankd have changed */
Harald Welte4c37f662019-03-31 15:00:00 +0200285 if (conn->client.bankd.port != bankd_port || conn->client.bankd.ip != bankd_ip) {
Harald Welte3598c582020-02-16 15:30:38 +0100286 struct in_addr ia = { .s_addr = bankd_ip };
Harald Welte15e8b7f2022-04-27 09:24:21 +0200287 LOGPFSML(conn->fi, LOGL_NOTICE, "Bankd IP/Port changed to %s:%u\n", inet_ntoa(ia), bankd_port);
Harald Welte4c37f662019-03-31 15:00:00 +0200288 conn->client.bankd.ip = bankd_ip;
289 conn->client.bankd.port = bankd_port;
290 changed = true;
291 }
292
293 /* update the client with new bankd information, if any changes were made */
294 if (changed)
295 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CL_CFG_BANKD, NULL);
296}
297
Harald Welte0a64da62019-03-30 17:38:04 +0100298static void clnt_st_connected_client_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100299{
Harald Weltef5a0fa32019-03-03 15:44:18 +0100300 struct rspro_client_conn *conn = fi->priv;
Harald Welte4c37f662019-03-31 15:00:00 +0200301 struct slotmaps *slotmaps = conn->srv->slotmaps;
302 struct slot_mapping *map;
303
Harald Welte15e8b7f2022-04-27 09:24:21 +0200304 LOGPFSML(fi, LOGL_DEBUG, "%s\n", __func__);
Harald Welte4c37f662019-03-31 15:00:00 +0200305
306 /* check for an existing slotmap for this client/slot */
307 slotmaps_rdlock(slotmaps);
308 llist_for_each_entry(map, &slotmaps->mappings, list) {
309 if (client_slot_equals(&map->client, &conn->client.slot)) {
310 _update_client_for_slotmap(map, conn->srv, NULL);
311 break;
312 }
313 }
314 slotmaps_unlock(slotmaps);
315#if 0
Harald Weltef5a0fa32019-03-03 15:44:18 +0100316 ClientSlot_t clslot;
317 RsproPDU_t *pdu;
318
319 /* send configuration to this new client */
320 client_slot2rspro(&clslot, FIXME);
321 pdu = rspro_gen_ConfigClientReq(&clslot, bankd_ip, bankd_port);
322 client_conn_send(conn, pdu);
323#endif
324}
325
Harald Welte0a64da62019-03-30 17:38:04 +0100326static void clnt_st_connected_bankd_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100327{
328 struct rspro_client_conn *conn = fi->priv;
329 struct slotmaps *slotmaps = conn->srv->slotmaps;
330 struct slot_mapping *map;
331
Harald Welte15e8b7f2022-04-27 09:24:21 +0200332 LOGPFSML(fi, LOGL_DEBUG, "Associating pre-existing slotmaps (if any)\n");
Harald Weltef5a0fa32019-03-03 15:44:18 +0100333 /* Link all known mappings to this new bank */
334 slotmaps_wrlock(slotmaps);
335 llist_for_each_entry(map, &slotmaps->mappings, list) {
336 if (map->bank.bank_id == conn->bank.bank_id)
337 _slotmap_state_change(map, SLMAP_S_NEW, &conn->bank.maps_new);
338 }
339 slotmaps_unlock(slotmaps);
340}
341
Harald Welte0a64da62019-03-30 17:38:04 +0100342static void clnt_st_connected_client(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100343{
344 struct rspro_client_conn *conn = fi->priv;
Harald Welte4c37f662019-03-31 15:00:00 +0200345 BankSlot_t bslot;
346 RsproPDU_t *tx;
Harald Welte0a64da62019-03-30 17:38:04 +0100347
348 switch (event) {
Harald Welte4c37f662019-03-31 15:00:00 +0200349 case CLNTC_E_CL_CFG_BANKD: /* Send [new] Bankd information to client */
350 bank_slot2rspro(&bslot, &conn->client.bankd.slot);
351 tx = rspro_gen_ConfigClientBankReq(&bslot, conn->client.bankd.ip,
352 conn->client.bankd.port);
353 client_conn_send(conn, tx);
354 break;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100355 default:
356 OSMO_ASSERT(0);
357 }
358}
359
Harald Welte0a64da62019-03-30 17:38:04 +0100360static void clnt_st_connected_bankd(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100361{
362 struct rspro_client_conn *conn = fi->priv;
363 struct slotmaps *slotmaps = conn->srv->slotmaps;
Harald Welte35ded292019-03-31 15:13:09 +0200364 const __attribute__((unused)) RsproPDU_t *rx = NULL;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100365 struct slot_mapping *map, *map2;
366
367 switch (event) {
Harald Welte1b07f7f2019-03-30 17:33:07 +0100368 case CLNTC_E_CREATE_MAP_RES: /* Bankd acknowledges mapping was created */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100369 rx = data;
370 slotmaps_wrlock(slotmaps);
371 /* FIXME: resolve map by pdu->tag */
372 /* as hack use first element of conn->maps_unack */
373 map = llist_first_entry(&conn->bank.maps_unack, struct slot_mapping, bank_list);
374 if (!map) {
375 slotmaps_unlock(slotmaps);
Harald Welte15e8b7f2022-04-27 09:24:21 +0200376 LOGPFSML(fi, LOGL_NOTICE, "CreateMapRes but no unacknowledged map");
Harald Weltef5a0fa32019-03-03 15:44:18 +0100377 break;
378 }
379 _slotmap_state_change(map, SLMAP_S_ACTIVE, &conn->bank.maps_active);
380 slotmaps_unlock(slotmaps);
Harald Welte4c37f662019-03-31 15:00:00 +0200381 _update_client_for_slotmap(map, conn->srv, conn);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100382 break;
Harald Welte1b07f7f2019-03-30 17:33:07 +0100383 case CLNTC_E_REMOVE_MAP_RES: /* Bankd acknowledges mapping was removed */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100384 rx = data;
385 slotmaps_wrlock(slotmaps);
386 /* FIXME: resolve map by pdu->tag */
387 /* as hack use first element of conn->maps_deleting */
388 map = llist_first_entry(&conn->bank.maps_deleting, struct slot_mapping, bank_list);
389 if (!map) {
390 slotmaps_unlock(slotmaps);
Harald Welte15e8b7f2022-04-27 09:24:21 +0200391 LOGPFSML(fi, LOGL_NOTICE, "RemoveMapRes but no unacknowledged map");
Harald Weltef5a0fa32019-03-03 15:44:18 +0100392 break;
393 }
394 slotmaps_unlock(slotmaps);
Harald Welte3598c582020-02-16 15:30:38 +0100395 /* update client! */
396 OSMO_ASSERT(map->state == SLMAP_S_DELETING);
397 _update_client_for_slotmap(map, conn->srv, conn);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100398 /* slotmap_del() will remove it from both global and bank list */
399 slotmap_del(map->maps, map);
400 break;
Harald Welte1b07f7f2019-03-30 17:33:07 +0100401 case CLNTC_E_PUSH: /* check if any create or delete requests are pending */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100402 slotmaps_wrlock(slotmaps);
403 /* send any pending create requests */
404 llist_for_each_entry_safe(map, map2, &conn->bank.maps_new, bank_list) {
405 RsproPDU_t *pdu = slotmap2CreateMappingReq(map);
406 client_conn_send(conn, pdu);
407 _slotmap_state_change(map, SLMAP_S_UNACKNOWLEDGED, &conn->bank.maps_unack);
408 }
409 /* send any pending delete requests */
410 llist_for_each_entry_safe(map, map2, &conn->bank.maps_delreq, bank_list) {
411 RsproPDU_t *pdu = slotmap2RemoveMappingReq(map);
412 client_conn_send(conn, pdu);
413 _slotmap_state_change(map, SLMAP_S_DELETING, &conn->bank.maps_deleting);
414 }
415 slotmaps_unlock(slotmaps);
416 break;
417 default:
418 OSMO_ASSERT(0);
419 }
420}
421
422static void clnt_allstate_action(struct osmo_fsm_inst *fi, uint32_t event, void *data)
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 (event) {
427 case CLNTC_E_TCP_DOWN:
Harald Weltee1590df2022-04-27 09:19:48 +0200428 LOGPFSML(fi, LOGL_NOTICE, "Connection lost; terminating FSM\n");
Harald Weltef5a0fa32019-03-03 15:44:18 +0100429 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL);
430 break;
Harald Welte15b75e12019-03-08 16:55:46 +0100431 case CLNTC_E_KA_TIMEOUT:
Harald Weltee1590df2022-04-27 09:19:48 +0200432 LOGPFSML(fi, LOGL_NOTICE, "IPA keep-alive timeout; terminating FSM\n");
Harald Welte15b75e12019-03-08 16:55:46 +0100433 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL);
434 break;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100435 default:
436 OSMO_ASSERT(0);
437 }
438}
439
440static int server_client_fsm_timer_cb(struct osmo_fsm_inst *fi)
441{
Harald Welte35ded292019-03-31 15:13:09 +0200442 //struct rspro_client_conn *conn = fi->priv;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100443
444 switch (fi->T) {
445 case 1:
446 /* No ClientConnectReq received:disconnect */
447 return 1; /* ask core to terminate FSM */
448 default:
449 OSMO_ASSERT(0);
450 }
451 return 0;
452}
453
454static void server_client_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause)
455{
456 struct rspro_client_conn *conn = fi->priv;
457 /* this call will destroy the IPA connection, which will in turn call closed_cb()
458 * which will try to deliver a E_TCP_DOWN event. Clear conn->fi to avoid that loop */
459 conn->fi = NULL;
460 rspro_client_conn_destroy(conn);
461}
462
463static const struct osmo_fsm_state server_client_fsm_states[] = {
464 [CLNTC_ST_INIT] = {
465 .name = "INIT",
466 .in_event_mask = S(CLNTC_E_TCP_UP),
467 .out_state_mask = S(CLNTC_ST_ESTABLISHED),
468 .action = clnt_st_init,
469 },
470 [CLNTC_ST_ESTABLISHED] = {
471 .name = "ESTABLISHED",
472 .in_event_mask = S(CLNTC_E_CLIENT_CONN) | S(CLNTC_E_BANK_CONN),
Harald Welte0a64da62019-03-30 17:38:04 +0100473 .out_state_mask = S(CLNTC_ST_CONNECTED_CLIENT) | S(CLNTC_ST_WAIT_CONF_RES) |
474 S(CLNTC_ST_CONNECTED_BANKD),
Harald Weltef5a0fa32019-03-03 15:44:18 +0100475 .action = clnt_st_established,
476 },
Harald Weltee5c77732019-03-07 23:58:24 +0100477 [CLNTC_ST_WAIT_CONF_RES] = {
478 .name = "WAIT_CONFIG_RES",
479 .in_event_mask = S(CLNTC_E_CONFIG_CL_RES),
Harald Welte0a64da62019-03-30 17:38:04 +0100480 .out_state_mask = S(CLNTC_ST_CONNECTED_CLIENT),
Harald Weltee5c77732019-03-07 23:58:24 +0100481 .action = clnt_st_wait_cl_conf_res,
482 },
Harald Welte0a64da62019-03-30 17:38:04 +0100483 [CLNTC_ST_CONNECTED_CLIENT] = {
484 .name = "CONNECTED_CLIENT",
Harald Welte4c37f662019-03-31 15:00:00 +0200485 .in_event_mask = S(CLNTC_E_CL_CFG_BANKD),
Harald Welte0a64da62019-03-30 17:38:04 +0100486 .action = clnt_st_connected_client,
487 .onenter = clnt_st_connected_client_onenter,
488 },
489 [CLNTC_ST_CONNECTED_BANKD] = {
490 .name = "CONNECTED_BANKD",
Harald Weltef5a0fa32019-03-03 15:44:18 +0100491 .in_event_mask = S(CLNTC_E_CREATE_MAP_RES) | S(CLNTC_E_REMOVE_MAP_RES) |
492 S(CLNTC_E_PUSH),
Harald Welte0a64da62019-03-30 17:38:04 +0100493 .action = clnt_st_connected_bankd,
494 .onenter = clnt_st_connected_bankd_onenter,
Harald Weltef5a0fa32019-03-03 15:44:18 +0100495 },
Harald Welte0a64da62019-03-30 17:38:04 +0100496
Harald Weltef5a0fa32019-03-03 15:44:18 +0100497};
498
499static struct osmo_fsm remsim_server_client_fsm = {
500 .name = "SERVER_CONN",
501 .states = server_client_fsm_states,
502 .num_states = ARRAY_SIZE(server_client_fsm_states),
Harald Welte10f7a762019-03-31 12:38:47 +0200503 .allstate_event_mask = S(CLNTC_E_TCP_DOWN) | S(CLNTC_E_KA_TIMEOUT),
Harald Weltef5a0fa32019-03-03 15:44:18 +0100504 .allstate_action = clnt_allstate_action,
505 .cleanup = server_client_cleanup,
506 .timer_cb = server_client_fsm_timer_cb,
507 .log_subsys = DMAIN,
508 .event_names = server_client_event_names,
509};
510
511struct osmo_fsm_inst *server_client_fsm_alloc(void *ctx, struct rspro_client_conn *conn)
512{
513 //const char *id = osmo_sock_get_name2(conn->peer->ofd.fd);
514 return osmo_fsm_inst_alloc(&remsim_server_client_fsm, ctx, conn, LOGL_DEBUG, NULL);
515}
516
517
518static __attribute__((constructor)) void on_dso_load(void)
519{
Harald Welte4ccd2fc2019-12-01 13:32:54 +0100520 OSMO_ASSERT(osmo_fsm_register(&remsim_server_client_fsm) == 0);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100521}
522
523
524/***********************************************************************
525 * IPA RSPRO Server
526 ***********************************************************************/
527
Harald Weltef30ff9e2019-03-30 19:17:37 +0100528struct rspro_client_conn *_client_conn_by_slot(struct rspro_server *srv, const struct client_slot *cslot)
529{
530 struct rspro_client_conn *conn;
531 llist_for_each_entry(conn, &srv->clients, list) {
532 if (client_slot_equals(&conn->client.slot, cslot))
533 return conn;
534 }
535 return NULL;
536}
537struct rspro_client_conn *client_conn_by_slot(struct rspro_server *srv, const struct client_slot *cslot)
538{
539 struct rspro_client_conn *conn;
540 pthread_rwlock_rdlock(&srv->rwlock);
541 conn = _client_conn_by_slot(srv, cslot);
542 pthread_rwlock_unlock(&srv->rwlock);
543 return conn;
544}
545
Harald Weltef5a0fa32019-03-03 15:44:18 +0100546struct rspro_client_conn *_bankd_conn_by_id(struct rspro_server *srv, uint16_t bank_id)
547{
548 struct rspro_client_conn *conn;
549 llist_for_each_entry(conn, &srv->banks, list) {
550 if (conn->bank.bank_id == bank_id)
551 return conn;
552 }
553 return NULL;
554}
555struct rspro_client_conn *bankd_conn_by_id(struct rspro_server *srv, uint16_t bank_id)
556{
557 struct rspro_client_conn *conn;
558 pthread_rwlock_rdlock(&srv->rwlock);
559 conn = _bankd_conn_by_id(srv, bank_id);
560 pthread_rwlock_unlock(&srv->rwlock);
561 return conn;
562}
563
564static int handle_rx_rspro(struct rspro_client_conn *conn, const RsproPDU_t *pdu)
565{
Harald Welte15e8b7f2022-04-27 09:24:21 +0200566 LOGPFSML(conn->fi, LOGL_DEBUG, "Rx RSPRO %s\n", rspro_msgt_name(pdu));
Harald Welteb49ac9c2019-03-09 20:36:07 +0100567
Harald Weltef5a0fa32019-03-03 15:44:18 +0100568 switch (pdu->msg.present) {
569 case RsproPDUchoice_PR_connectClientReq:
570 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CLIENT_CONN, (void *)pdu);
571 break;
572 case RsproPDUchoice_PR_connectBankReq:
573 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_BANK_CONN, (void *)pdu);
574 break;
575 case RsproPDUchoice_PR_createMappingRes:
576 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CREATE_MAP_RES, (void *)pdu);
577 break;
578 case RsproPDUchoice_PR_removeMappingRes:
579 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_REMOVE_MAP_RES, (void *)pdu);
580 break;
Harald Welted571a3e2019-03-11 22:09:50 +0100581 case RsproPDUchoice_PR_configClientIdRes:
Harald Weltee5c77732019-03-07 23:58:24 +0100582 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CONFIG_CL_RES, (void *)pdu);
583 break;
Harald Welte19dee082019-03-31 10:53:45 +0200584 case RsproPDUchoice_PR_configClientBankRes:
585 /* TODO: store somewhere that client has ACKed? */
586 break;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100587 default:
Harald Welte19dee082019-03-31 10:53:45 +0200588 LOGPFSML(conn->fi, LOGL_ERROR, "Received unknown/unimplemented RSPRO msg_type %s\n",
589 rspro_msgt_name(pdu));
Harald Weltef5a0fa32019-03-03 15:44:18 +0100590 return -1;
591 }
592 return 0;
593}
594
595/* data was received from one of the client connections to the RSPRO socket */
596static int sock_read_cb(struct ipa_server_conn *peer, struct msgb *msg)
597{
598 struct ipaccess_head *hh = (struct ipaccess_head *) msg->data;
599 struct ipaccess_head_ext *he = (struct ipaccess_head_ext *) msgb_l2(msg);
600 struct rspro_client_conn *conn = peer->data;
601 RsproPDU_t *pdu;
602 int rc;
603
604 if (msgb_length(msg) < sizeof(*hh))
605 goto invalid;
606 msg->l2h = &hh->data[0];
Harald Welte7bfcc652019-03-08 16:55:01 +0100607 switch (hh->proto) {
608 case IPAC_PROTO_IPACCESS:
609 rc = ipa_server_conn_ccm(peer, msg);
Harald Welte15b75e12019-03-08 16:55:46 +0100610 if (rc < 0)
611 break;
612 switch (hh->data[0]) {
613 case IPAC_MSGT_PONG:
614 ipa_keepalive_fsm_pong_received(conn->keepalive_fi);
615 rc = 0;
616 break;
617 default:
618 break;
619 }
Harald Welte7bfcc652019-03-08 16:55:01 +0100620 break;
621 case IPAC_PROTO_OSMO:
622 if (!he || msgb_l2len(msg)< sizeof(*he))
623 goto invalid;
624 msg->l2h = &he->data[0];
Harald Weltef5a0fa32019-03-03 15:44:18 +0100625
Harald Welte7bfcc652019-03-08 16:55:01 +0100626 switch (he->proto) {
627 case IPAC_PROTO_EXT_RSPRO:
628 pdu = rspro_dec_msg(msg);
629 if (!pdu)
630 goto invalid;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100631
Harald Welte7bfcc652019-03-08 16:55:01 +0100632 rc = handle_rx_rspro(conn, pdu);
633 ASN_STRUCT_FREE(asn_DEF_RsproPDU, pdu);
634 break;
635 default:
636 goto invalid;
637 }
638 break;
639 default:
Harald Weltef5a0fa32019-03-03 15:44:18 +0100640 goto invalid;
Harald Welte7bfcc652019-03-08 16:55:01 +0100641 }
Harald Welte6b990f92019-07-18 18:16:33 +0200642 msgb_free(msg);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100643 return rc;
644
645invalid:
646 msgb_free(msg);
647 return -1;
648}
649
650static int sock_closed_cb(struct ipa_server_conn *peer)
651{
652 struct rspro_client_conn *conn = peer->data;
653 if (conn->fi)
654 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_TCP_DOWN, NULL);
655 /* FIXME: who cleans up conn? */
656 /* ipa server code relases 'peer' just after this */
657 return 0;
658}
659
Harald Welte15b75e12019-03-08 16:55:46 +0100660static const struct ipa_keepalive_params ka_params = {
661 .interval = 30,
662 .wait_for_resp = 10,
663};
664
Harald Weltef5a0fa32019-03-03 15:44:18 +0100665/* a new TCP connection was accepted on the RSPRO server socket */
666static int accept_cb(struct ipa_server_link *link, int fd)
667{
668 struct rspro_server *srv = link->data;
669 struct rspro_client_conn *conn;
670
671 conn = talloc_zero(srv, struct rspro_client_conn);
672 OSMO_ASSERT(conn);
673
674 conn->srv = srv;
675 /* don't allocate peer under 'conn', as it must survive 'conn' during teardown */
676 conn->peer = ipa_server_conn_create(link, link, fd, sock_read_cb, sock_closed_cb, conn);
677 if (!conn->peer)
678 goto out_err;
679
680 /* don't allocate 'fi' as slave from 'conn', as 'fi' needs to survive 'conn' during
681 * teardown */
682 conn->fi = server_client_fsm_alloc(srv, conn);
683 if (!conn->fi)
684 goto out_err_conn;
685
Harald Welte15b75e12019-03-08 16:55:46 +0100686 /* use ipa_keepalive_fsm to periodically send an IPA_PING and expect a PONG in response */
687 conn->keepalive_fi = ipa_server_conn_alloc_keepalive_fsm(conn->peer, &ka_params, NULL);
688 if (!conn->keepalive_fi)
689 goto out_err_fi;
690 /* ensure parent is notified once keepalive FSM instance is dying */
691 osmo_fsm_inst_change_parent(conn->keepalive_fi, conn->fi, CLNTC_E_KA_TIMEOUT);
692 ipa_keepalive_fsm_start(conn->keepalive_fi);
693
Harald Weltef5a0fa32019-03-03 15:44:18 +0100694 INIT_LLIST_HEAD(&conn->bank.maps_new);
695 INIT_LLIST_HEAD(&conn->bank.maps_unack);
696 INIT_LLIST_HEAD(&conn->bank.maps_active);
697 INIT_LLIST_HEAD(&conn->bank.maps_delreq);
698 INIT_LLIST_HEAD(&conn->bank.maps_deleting);
699
700 pthread_rwlock_wrlock(&conn->srv->rwlock);
701 llist_add_tail(&conn->list, &srv->connections);
702 pthread_rwlock_unlock(&conn->srv->rwlock);
703
704 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_TCP_UP, NULL);
705 return 0;
706
Harald Welte15b75e12019-03-08 16:55:46 +0100707out_err_fi:
708 osmo_fsm_inst_term(conn->fi, OSMO_FSM_TERM_ERROR, NULL);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100709out_err_conn:
710 ipa_server_conn_destroy(conn->peer);
711 /* the above will free 'conn' down the chain */
712 return -1;
713out_err:
714 talloc_free(conn);
715 return -1;
716}
717
718/* call-back if we were triggered by a rest_api thread */
719int event_fd_cb(struct osmo_fd *ofd, unsigned int what)
720{
721 struct rspro_server *srv = ofd->data;
722 struct rspro_client_conn *conn;
723 bool non_empty_new, non_empty_del;
724 uint64_t value;
725 int rc;
726
727 /* read from the socket to "confirm" the event and make it non-readable again */
728 rc = read(ofd->fd, &value, 8);
729 if (rc < 8) {
Harald Weltea9d7ad12021-12-08 21:09:12 +0100730 LOGP(DMAIN, LOGL_ERROR, "Error reading eventfd: %d\n", rc);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100731 return rc;
732 }
733
Harald Weltea9d7ad12021-12-08 21:09:12 +0100734 LOGP(DMAIN, LOGL_INFO, "Event FD arrived, checking for any pending work\n");
Harald Weltef5a0fa32019-03-03 15:44:18 +0100735
736 pthread_rwlock_rdlock(&srv->rwlock);
737 llist_for_each_entry(conn, &srv->banks, list) {
738 slotmaps_rdlock(srv->slotmaps);
739 non_empty_new = llist_empty(&conn->bank.maps_new);
740 non_empty_del = llist_empty(&conn->bank.maps_delreq);
741 slotmaps_unlock(srv->slotmaps);
742
743 /* trigger FSM to send any pending new/deleted maps */
744 if (non_empty_new || non_empty_del)
745 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_PUSH, NULL);
746 }
747 pthread_rwlock_unlock(&srv->rwlock);
748
749 return 0;
750}
751
752/* unlink all slotmaps from any of the lists of this conn->bank.maps_* */
753static void _unlink_all_slotmaps(struct rspro_client_conn *conn)
754{
755 struct slot_mapping *smap, *smap2;
756
757 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_new, bank_list) {
758 /* unlink from list and keep in state NEW */
759 _slotmap_state_change(smap, SLMAP_S_NEW, NULL);
760 }
761 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_unack, bank_list) {
762 /* unlink from list and change to state NEW */
763 _slotmap_state_change(smap, SLMAP_S_NEW, NULL);
764 }
765 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_active, bank_list) {
766 /* unlink from list and change to state NEW */
767 _slotmap_state_change(smap, SLMAP_S_NEW, NULL);
768 }
769 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_delreq, bank_list) {
770 /* unlink from list and delete */
771 _slotmap_del(smap->maps, smap);
772 }
773 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_deleting, bank_list) {
774 /* unlink from list and delete */
775 _slotmap_del(smap->maps, smap);
776 }
777}
778
779/* only to be used by the FSM cleanup. */
780static void rspro_client_conn_destroy(struct rspro_client_conn *conn)
781{
782 /* this will internally call closed_cb() which will dispatch a TCP_DOWN event */
783 ipa_server_conn_destroy(conn->peer);
784 conn->peer = NULL;
785
786 /* ensure all slotmaps are unlinked + returned to NEW or deleted */
787 slotmaps_wrlock(conn->srv->slotmaps);
788 _unlink_all_slotmaps(conn);
789 slotmaps_unlock(conn->srv->slotmaps);
790
791 pthread_rwlock_wrlock(&conn->srv->rwlock);
792 llist_del(&conn->list);
793 pthread_rwlock_unlock(&conn->srv->rwlock);
794
795 talloc_free(conn);
796}
797
798
799struct rspro_server *rspro_server_create(void *ctx, const char *host, uint16_t port)
800
801{
802 struct rspro_server *srv = talloc_zero(ctx, struct rspro_server);
803 OSMO_ASSERT(srv);
804
805 pthread_rwlock_init(&srv->rwlock, NULL);
806 pthread_rwlock_wrlock(&srv->rwlock);
807 INIT_LLIST_HEAD(&srv->connections);
808 INIT_LLIST_HEAD(&srv->clients);
809 INIT_LLIST_HEAD(&srv->banks);
810 pthread_rwlock_unlock(&srv->rwlock);
811
812 srv->link = ipa_server_link_create(ctx, NULL, host, port, accept_cb, srv);
813 ipa_server_link_open(srv->link);
814
815 return srv;
816}
817
818void rspro_server_destroy(struct rspro_server *srv)
819{
820 /* FIXME: clear all lists */
821
822 ipa_server_link_destroy(srv->link);
823 srv->link = NULL;
824 talloc_free(srv);
825}