blob: 6c01c0a2f2bb67b56d787c1dfbac52dbe38d828a [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;
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) {
139 LOGPFSM(fi, "ConnectClientReq from identity != Client ?!?\n");
140 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
141 }
Harald Welte4c37f662019-03-31 15:00:00 +0200142
143 /* reparent us from srv->connections to srv->clients */
144 pthread_rwlock_wrlock(&conn->srv->rwlock);
145 llist_del(&conn->list);
146 llist_add_tail(&conn->list, &conn->srv->clients);
147 pthread_rwlock_unlock(&conn->srv->rwlock);
148
Harald Weltee5c77732019-03-07 23:58:24 +0100149 if (!cclreq->clientSlot) {
150#if 0
151 /* FIXME: determine ClientID */
152 resp = rspro_gen_ConnectClientRes(&conn->srv->comp_id, ResultCode_ok);
153 client_conn_send(conn, resp);
154 osmo_fsm_inst_state_chg(fi, CLNTC_ST_WAIT_CL_CONF_RES, 3, 30);
155#else
156 /* FIXME: the original plan was to dynamically assign a ClientID
157 * from server to client here. Send ConfigReq and transition to
158 * CLNTC_ST_WAIT_CONF_RES */
159 LOGPFSM(fi, "ConnectClientReq without ClientId not supported yet!\n");
160 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
161#endif
162 } else {
163 /* FIXME: check for unique-ness */
164 rspro2client_slot(&conn->client.slot, cclreq->clientSlot);
165 osmo_fsm_inst_update_id_f(fi, "C%u:%u", conn->client.slot.client_id,
166 conn->client.slot.slot_nr);
Harald Welte1c691b12019-03-31 10:58:11 +0200167 osmo_fsm_inst_update_id_f(conn->keepalive_fi, "C%u:%u",
168 conn->client.slot.client_id,
169 conn->client.slot.slot_nr);
Harald Weltefb48de82022-04-27 09:15:43 +0200170 LOGPFSML(fi, LOGL_INFO, "Client connected from %s:%s\n", ip_str, port_str);
Harald Weltee5c77732019-03-07 23:58:24 +0100171 resp = rspro_gen_ConnectClientRes(&conn->srv->comp_id, ResultCode_ok);
172 client_conn_send(conn, resp);
Harald Welte0a64da62019-03-30 17:38:04 +0100173 osmo_fsm_inst_state_chg(fi, CLNTC_ST_CONNECTED_CLIENT, 0, 0);
Harald Weltee5c77732019-03-07 23:58:24 +0100174 }
Harald Weltef5a0fa32019-03-03 15:44:18 +0100175 break;
176 case CLNTC_E_BANK_CONN:
177 cbreq = &pdu->msg.choice.connectBankReq;
178 /* save the [remote] component identity in 'conn' */
179 rspro_comp_id_retrieve(&conn->comp_id, &cbreq->identity);
180 if (conn->comp_id.type != ComponentType_remsimBankd) {
181 LOGPFSM(fi, "ConnectBankReq from identity != Bank ?!?\n");
182 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL);
183 }
Harald Weltee5c77732019-03-07 23:58:24 +0100184 /* FIXME: check for unique-ness */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100185 conn->bank.bank_id = cbreq->bankId;
186 conn->bank.num_slots = cbreq->numberOfSlots;
187 osmo_fsm_inst_update_id_f(fi, "B%u", conn->bank.bank_id);
Harald Welte1c691b12019-03-31 10:58:11 +0200188 osmo_fsm_inst_update_id_f(conn->keepalive_fi, "B%u", conn->bank.bank_id);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100189
Harald Weltefb48de82022-04-27 09:15:43 +0200190 LOGPFSML(fi, LOGL_INFO, "Bankd connected from %s:%s\n", ip_str, port_str);
191 if (!strncmp(ip_str, "127.", 4)) {
192 LOGPFSML(fi, LOGL_NOTICE, "Bankd connected from %s (localhost). "
193 "This only works if your clients also all are on localhost, "
194 "as they must be able to reach the bankd!\n", ip_str);
195 }
196
Harald Weltef5a0fa32019-03-03 15:44:18 +0100197 /* reparent us from srv->connections to srv->banks */
198 pthread_rwlock_wrlock(&conn->srv->rwlock);
199 llist_del(&conn->list);
200 llist_add_tail(&conn->list, &conn->srv->banks);
201 pthread_rwlock_unlock(&conn->srv->rwlock);
202
203 /* send response to bank first */
204 resp = rspro_gen_ConnectBankRes(&conn->srv->comp_id, ResultCode_ok);
205 client_conn_send(conn, resp);
206
207 /* the state change will associate any pre-existing slotmaps */
Harald Welte0a64da62019-03-30 17:38:04 +0100208 osmo_fsm_inst_state_chg(fi, CLNTC_ST_CONNECTED_BANKD, 0, 0);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100209
210 osmo_fsm_inst_dispatch(fi, CLNTC_E_PUSH, NULL);
211 break;
212 default:
213 OSMO_ASSERT(0);
214 }
215}
216
Harald Weltee5c77732019-03-07 23:58:24 +0100217static void clnt_st_wait_cl_conf_res(struct osmo_fsm_inst *fi, uint32_t event, void *data)
218{
219 switch (event) {
220 case CLNTC_E_CONFIG_CL_RES:
Harald Welte0a64da62019-03-30 17:38:04 +0100221 osmo_fsm_inst_state_chg(fi, CLNTC_ST_CONNECTED_CLIENT, 0, 0);
Harald Weltee5c77732019-03-07 23:58:24 +0100222 break;
223 default:
224 OSMO_ASSERT(0);
225 }
226}
Harald Weltef5a0fa32019-03-03 15:44:18 +0100227
Harald Welte4c37f662019-03-31 15:00:00 +0200228/*! find a connected client (if any) for given slotmap and update its Bankd configuration.
229 * \param[in] map slotmap whose client connection shall be updated
230 * \param[in] srv rspro_server on which we operate
231 * \param[in] bankd_conn bankd connection serving the map (may be NULL if not known)
232 */
233static void _update_client_for_slotmap(struct slot_mapping *map, struct rspro_server *srv,
234 struct rspro_client_conn *bankd_conn)
235{
Harald Welteea3eefe2020-02-16 15:26:35 +0100236 struct rspro_client_conn *conn;
Harald Welte4c37f662019-03-31 15:00:00 +0200237 char ip_str[INET6_ADDRSTRLEN];
238 char port_str[6];
239 uint32_t bankd_ip;
240 int bankd_port;
241 bool changed = false;
242 int rc;
243
244 OSMO_ASSERT(map);
245 OSMO_ASSERT(srv);
246
Harald Welteea3eefe2020-02-16 15:26:35 +0100247 conn = client_conn_by_slot(srv, &map->client);
Harald Welte4c37f662019-03-31 15:00:00 +0200248 if (!conn)
249 LOGP(DMAIN, LOGL_DEBUG, "%s\n", __func__);
250 else
251 LOGPFSM(conn->fi, "%s\n", __func__);
252
253 if (!conn)
254 return;
255
256 if (!bank_slot_equals(&conn->client.bankd.slot, &map->bank)) {
257 LOGPFSM(conn->fi, "BankSlot has changed B%u:%u -> B%u:%u\n",
258 conn->client.bankd.slot.bank_id, conn->client.bankd.slot.slot_nr,
259 map->bank.bank_id, map->bank.slot_nr);
260 conn->client.bankd.slot = map->bank;
261 changed = true;
262 }
263
264 /* if caller didn't provide bankd_conn, resolve it from map */
265 if (!bankd_conn)
266 bankd_conn = bankd_conn_by_id(srv, map->bank.bank_id);
Harald Welte3598c582020-02-16 15:30:38 +0100267 if (map->state == SLMAP_S_DELETING || !bankd_conn) {
268 bankd_ip = 0;
269 bankd_port = 0;
270 } else {
271 /* obtain IP and port of bankd */
272 rc = osmo_sock_get_ip_and_port(bankd_conn->peer->ofd.fd, ip_str, sizeof(ip_str),
273 port_str, sizeof(port_str), false);
274 if (rc < 0) {
275 LOGPFSM(bankd_conn->fi, "Error during getpeername\n");
276 return;
277 }
278 bankd_ip = ntohl(inet_addr(ip_str));
279 bankd_port = 9999; /* TODO: configurable */
Harald Welte4c37f662019-03-31 15:00:00 +0200280 }
Harald Welte3598c582020-02-16 15:30:38 +0100281
282 /* determine if IP/port of bankd have changed */
Harald Welte4c37f662019-03-31 15:00:00 +0200283 if (conn->client.bankd.port != bankd_port || conn->client.bankd.ip != bankd_ip) {
Harald Welte3598c582020-02-16 15:30:38 +0100284 struct in_addr ia = { .s_addr = bankd_ip };
285 LOGPFSM(conn->fi, "Bankd IP/Port changed to %s:%u\n", inet_ntoa(ia), bankd_port);
Harald Welte4c37f662019-03-31 15:00:00 +0200286 conn->client.bankd.ip = bankd_ip;
287 conn->client.bankd.port = bankd_port;
288 changed = true;
289 }
290
291 /* update the client with new bankd information, if any changes were made */
292 if (changed)
293 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CL_CFG_BANKD, NULL);
294}
295
Harald Welte0a64da62019-03-30 17:38:04 +0100296static void clnt_st_connected_client_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100297{
Harald Weltef5a0fa32019-03-03 15:44:18 +0100298 struct rspro_client_conn *conn = fi->priv;
Harald Welte4c37f662019-03-31 15:00:00 +0200299 struct slotmaps *slotmaps = conn->srv->slotmaps;
300 struct slot_mapping *map;
301
302 LOGPFSM(fi, "%s\n", __func__);
303
304 /* check for an existing slotmap for this client/slot */
305 slotmaps_rdlock(slotmaps);
306 llist_for_each_entry(map, &slotmaps->mappings, list) {
307 if (client_slot_equals(&map->client, &conn->client.slot)) {
308 _update_client_for_slotmap(map, conn->srv, NULL);
309 break;
310 }
311 }
312 slotmaps_unlock(slotmaps);
313#if 0
Harald Weltef5a0fa32019-03-03 15:44:18 +0100314 ClientSlot_t clslot;
315 RsproPDU_t *pdu;
316
317 /* send configuration to this new client */
318 client_slot2rspro(&clslot, FIXME);
319 pdu = rspro_gen_ConfigClientReq(&clslot, bankd_ip, bankd_port);
320 client_conn_send(conn, pdu);
321#endif
322}
323
Harald Welte0a64da62019-03-30 17:38:04 +0100324static void clnt_st_connected_bankd_onenter(struct osmo_fsm_inst *fi, uint32_t prev_state)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100325{
326 struct rspro_client_conn *conn = fi->priv;
327 struct slotmaps *slotmaps = conn->srv->slotmaps;
328 struct slot_mapping *map;
329
330 LOGPFSM(fi, "Associating pre-existing slotmaps (if any)\n");
331 /* Link all known mappings to this new bank */
332 slotmaps_wrlock(slotmaps);
333 llist_for_each_entry(map, &slotmaps->mappings, list) {
334 if (map->bank.bank_id == conn->bank.bank_id)
335 _slotmap_state_change(map, SLMAP_S_NEW, &conn->bank.maps_new);
336 }
337 slotmaps_unlock(slotmaps);
338}
339
Harald Welte0a64da62019-03-30 17:38:04 +0100340static void clnt_st_connected_client(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100341{
342 struct rspro_client_conn *conn = fi->priv;
Harald Welte4c37f662019-03-31 15:00:00 +0200343 BankSlot_t bslot;
344 RsproPDU_t *tx;
Harald Welte0a64da62019-03-30 17:38:04 +0100345
346 switch (event) {
Harald Welte4c37f662019-03-31 15:00:00 +0200347 case CLNTC_E_CL_CFG_BANKD: /* Send [new] Bankd information to client */
348 bank_slot2rspro(&bslot, &conn->client.bankd.slot);
349 tx = rspro_gen_ConfigClientBankReq(&bslot, conn->client.bankd.ip,
350 conn->client.bankd.port);
351 client_conn_send(conn, tx);
352 break;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100353 default:
354 OSMO_ASSERT(0);
355 }
356}
357
Harald Welte0a64da62019-03-30 17:38:04 +0100358static void clnt_st_connected_bankd(struct osmo_fsm_inst *fi, uint32_t event, void *data)
Harald Weltef5a0fa32019-03-03 15:44:18 +0100359{
360 struct rspro_client_conn *conn = fi->priv;
361 struct slotmaps *slotmaps = conn->srv->slotmaps;
Harald Welte35ded292019-03-31 15:13:09 +0200362 const __attribute__((unused)) RsproPDU_t *rx = NULL;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100363 struct slot_mapping *map, *map2;
364
365 switch (event) {
Harald Welte1b07f7f2019-03-30 17:33:07 +0100366 case CLNTC_E_CREATE_MAP_RES: /* Bankd acknowledges mapping was created */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100367 rx = data;
368 slotmaps_wrlock(slotmaps);
369 /* FIXME: resolve map by pdu->tag */
370 /* as hack use first element of conn->maps_unack */
371 map = llist_first_entry(&conn->bank.maps_unack, struct slot_mapping, bank_list);
372 if (!map) {
373 slotmaps_unlock(slotmaps);
374 LOGPFSM(fi, "CreateMapRes but no unacknowledged map");
375 break;
376 }
377 _slotmap_state_change(map, SLMAP_S_ACTIVE, &conn->bank.maps_active);
378 slotmaps_unlock(slotmaps);
Harald Welte4c37f662019-03-31 15:00:00 +0200379 _update_client_for_slotmap(map, conn->srv, conn);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100380 break;
Harald Welte1b07f7f2019-03-30 17:33:07 +0100381 case CLNTC_E_REMOVE_MAP_RES: /* Bankd acknowledges mapping was removed */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100382 rx = data;
383 slotmaps_wrlock(slotmaps);
384 /* FIXME: resolve map by pdu->tag */
385 /* as hack use first element of conn->maps_deleting */
386 map = llist_first_entry(&conn->bank.maps_deleting, struct slot_mapping, bank_list);
387 if (!map) {
388 slotmaps_unlock(slotmaps);
389 LOGPFSM(fi, "RemoveMapRes but no unacknowledged map");
390 break;
391 }
392 slotmaps_unlock(slotmaps);
Harald Welte3598c582020-02-16 15:30:38 +0100393 /* update client! */
394 OSMO_ASSERT(map->state == SLMAP_S_DELETING);
395 _update_client_for_slotmap(map, conn->srv, conn);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100396 /* slotmap_del() will remove it from both global and bank list */
397 slotmap_del(map->maps, map);
398 break;
Harald Welte1b07f7f2019-03-30 17:33:07 +0100399 case CLNTC_E_PUSH: /* check if any create or delete requests are pending */
Harald Weltef5a0fa32019-03-03 15:44:18 +0100400 slotmaps_wrlock(slotmaps);
401 /* send any pending create requests */
402 llist_for_each_entry_safe(map, map2, &conn->bank.maps_new, bank_list) {
403 RsproPDU_t *pdu = slotmap2CreateMappingReq(map);
404 client_conn_send(conn, pdu);
405 _slotmap_state_change(map, SLMAP_S_UNACKNOWLEDGED, &conn->bank.maps_unack);
406 }
407 /* send any pending delete requests */
408 llist_for_each_entry_safe(map, map2, &conn->bank.maps_delreq, bank_list) {
409 RsproPDU_t *pdu = slotmap2RemoveMappingReq(map);
410 client_conn_send(conn, pdu);
411 _slotmap_state_change(map, SLMAP_S_DELETING, &conn->bank.maps_deleting);
412 }
413 slotmaps_unlock(slotmaps);
414 break;
415 default:
416 OSMO_ASSERT(0);
417 }
418}
419
420static void clnt_allstate_action(struct osmo_fsm_inst *fi, uint32_t event, void *data)
421{
Harald Welte35ded292019-03-31 15:13:09 +0200422 //struct rspro_client_conn *conn = fi->priv;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100423
424 switch (event) {
425 case CLNTC_E_TCP_DOWN:
426 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL);
427 break;
Harald Welte15b75e12019-03-08 16:55:46 +0100428 case CLNTC_E_KA_TIMEOUT:
429 osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL);
430 break;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100431 default:
432 OSMO_ASSERT(0);
433 }
434}
435
436static int server_client_fsm_timer_cb(struct osmo_fsm_inst *fi)
437{
Harald Welte35ded292019-03-31 15:13:09 +0200438 //struct rspro_client_conn *conn = fi->priv;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100439
440 switch (fi->T) {
441 case 1:
442 /* No ClientConnectReq received:disconnect */
443 return 1; /* ask core to terminate FSM */
444 default:
445 OSMO_ASSERT(0);
446 }
447 return 0;
448}
449
450static void server_client_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause)
451{
452 struct rspro_client_conn *conn = fi->priv;
453 /* this call will destroy the IPA connection, which will in turn call closed_cb()
454 * which will try to deliver a E_TCP_DOWN event. Clear conn->fi to avoid that loop */
455 conn->fi = NULL;
456 rspro_client_conn_destroy(conn);
457}
458
459static const struct osmo_fsm_state server_client_fsm_states[] = {
460 [CLNTC_ST_INIT] = {
461 .name = "INIT",
462 .in_event_mask = S(CLNTC_E_TCP_UP),
463 .out_state_mask = S(CLNTC_ST_ESTABLISHED),
464 .action = clnt_st_init,
465 },
466 [CLNTC_ST_ESTABLISHED] = {
467 .name = "ESTABLISHED",
468 .in_event_mask = S(CLNTC_E_CLIENT_CONN) | S(CLNTC_E_BANK_CONN),
Harald Welte0a64da62019-03-30 17:38:04 +0100469 .out_state_mask = S(CLNTC_ST_CONNECTED_CLIENT) | S(CLNTC_ST_WAIT_CONF_RES) |
470 S(CLNTC_ST_CONNECTED_BANKD),
Harald Weltef5a0fa32019-03-03 15:44:18 +0100471 .action = clnt_st_established,
472 },
Harald Weltee5c77732019-03-07 23:58:24 +0100473 [CLNTC_ST_WAIT_CONF_RES] = {
474 .name = "WAIT_CONFIG_RES",
475 .in_event_mask = S(CLNTC_E_CONFIG_CL_RES),
Harald Welte0a64da62019-03-30 17:38:04 +0100476 .out_state_mask = S(CLNTC_ST_CONNECTED_CLIENT),
Harald Weltee5c77732019-03-07 23:58:24 +0100477 .action = clnt_st_wait_cl_conf_res,
478 },
Harald Welte0a64da62019-03-30 17:38:04 +0100479 [CLNTC_ST_CONNECTED_CLIENT] = {
480 .name = "CONNECTED_CLIENT",
Harald Welte4c37f662019-03-31 15:00:00 +0200481 .in_event_mask = S(CLNTC_E_CL_CFG_BANKD),
Harald Welte0a64da62019-03-30 17:38:04 +0100482 .action = clnt_st_connected_client,
483 .onenter = clnt_st_connected_client_onenter,
484 },
485 [CLNTC_ST_CONNECTED_BANKD] = {
486 .name = "CONNECTED_BANKD",
Harald Weltef5a0fa32019-03-03 15:44:18 +0100487 .in_event_mask = S(CLNTC_E_CREATE_MAP_RES) | S(CLNTC_E_REMOVE_MAP_RES) |
488 S(CLNTC_E_PUSH),
Harald Welte0a64da62019-03-30 17:38:04 +0100489 .action = clnt_st_connected_bankd,
490 .onenter = clnt_st_connected_bankd_onenter,
Harald Weltef5a0fa32019-03-03 15:44:18 +0100491 },
Harald Welte0a64da62019-03-30 17:38:04 +0100492
Harald Weltef5a0fa32019-03-03 15:44:18 +0100493};
494
495static struct osmo_fsm remsim_server_client_fsm = {
496 .name = "SERVER_CONN",
497 .states = server_client_fsm_states,
498 .num_states = ARRAY_SIZE(server_client_fsm_states),
Harald Welte10f7a762019-03-31 12:38:47 +0200499 .allstate_event_mask = S(CLNTC_E_TCP_DOWN) | S(CLNTC_E_KA_TIMEOUT),
Harald Weltef5a0fa32019-03-03 15:44:18 +0100500 .allstate_action = clnt_allstate_action,
501 .cleanup = server_client_cleanup,
502 .timer_cb = server_client_fsm_timer_cb,
503 .log_subsys = DMAIN,
504 .event_names = server_client_event_names,
505};
506
507struct osmo_fsm_inst *server_client_fsm_alloc(void *ctx, struct rspro_client_conn *conn)
508{
509 //const char *id = osmo_sock_get_name2(conn->peer->ofd.fd);
510 return osmo_fsm_inst_alloc(&remsim_server_client_fsm, ctx, conn, LOGL_DEBUG, NULL);
511}
512
513
514static __attribute__((constructor)) void on_dso_load(void)
515{
Harald Welte4ccd2fc2019-12-01 13:32:54 +0100516 OSMO_ASSERT(osmo_fsm_register(&remsim_server_client_fsm) == 0);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100517}
518
519
520/***********************************************************************
521 * IPA RSPRO Server
522 ***********************************************************************/
523
Harald Weltef30ff9e2019-03-30 19:17:37 +0100524struct rspro_client_conn *_client_conn_by_slot(struct rspro_server *srv, const struct client_slot *cslot)
525{
526 struct rspro_client_conn *conn;
527 llist_for_each_entry(conn, &srv->clients, list) {
528 if (client_slot_equals(&conn->client.slot, cslot))
529 return conn;
530 }
531 return NULL;
532}
533struct rspro_client_conn *client_conn_by_slot(struct rspro_server *srv, const struct client_slot *cslot)
534{
535 struct rspro_client_conn *conn;
536 pthread_rwlock_rdlock(&srv->rwlock);
537 conn = _client_conn_by_slot(srv, cslot);
538 pthread_rwlock_unlock(&srv->rwlock);
539 return conn;
540}
541
Harald Weltef5a0fa32019-03-03 15:44:18 +0100542struct rspro_client_conn *_bankd_conn_by_id(struct rspro_server *srv, uint16_t bank_id)
543{
544 struct rspro_client_conn *conn;
545 llist_for_each_entry(conn, &srv->banks, list) {
546 if (conn->bank.bank_id == bank_id)
547 return conn;
548 }
549 return NULL;
550}
551struct rspro_client_conn *bankd_conn_by_id(struct rspro_server *srv, uint16_t bank_id)
552{
553 struct rspro_client_conn *conn;
554 pthread_rwlock_rdlock(&srv->rwlock);
555 conn = _bankd_conn_by_id(srv, bank_id);
556 pthread_rwlock_unlock(&srv->rwlock);
557 return conn;
558}
559
560static int handle_rx_rspro(struct rspro_client_conn *conn, const RsproPDU_t *pdu)
561{
Harald Welteb49ac9c2019-03-09 20:36:07 +0100562 LOGPFSM(conn->fi, "Rx RSPRO %s\n", rspro_msgt_name(pdu));
563
Harald Weltef5a0fa32019-03-03 15:44:18 +0100564 switch (pdu->msg.present) {
565 case RsproPDUchoice_PR_connectClientReq:
566 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CLIENT_CONN, (void *)pdu);
567 break;
568 case RsproPDUchoice_PR_connectBankReq:
569 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_BANK_CONN, (void *)pdu);
570 break;
571 case RsproPDUchoice_PR_createMappingRes:
572 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CREATE_MAP_RES, (void *)pdu);
573 break;
574 case RsproPDUchoice_PR_removeMappingRes:
575 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_REMOVE_MAP_RES, (void *)pdu);
576 break;
Harald Welted571a3e2019-03-11 22:09:50 +0100577 case RsproPDUchoice_PR_configClientIdRes:
Harald Weltee5c77732019-03-07 23:58:24 +0100578 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_CONFIG_CL_RES, (void *)pdu);
579 break;
Harald Welte19dee082019-03-31 10:53:45 +0200580 case RsproPDUchoice_PR_configClientBankRes:
581 /* TODO: store somewhere that client has ACKed? */
582 break;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100583 default:
Harald Welte19dee082019-03-31 10:53:45 +0200584 LOGPFSML(conn->fi, LOGL_ERROR, "Received unknown/unimplemented RSPRO msg_type %s\n",
585 rspro_msgt_name(pdu));
Harald Weltef5a0fa32019-03-03 15:44:18 +0100586 return -1;
587 }
588 return 0;
589}
590
591/* data was received from one of the client connections to the RSPRO socket */
592static int sock_read_cb(struct ipa_server_conn *peer, struct msgb *msg)
593{
594 struct ipaccess_head *hh = (struct ipaccess_head *) msg->data;
595 struct ipaccess_head_ext *he = (struct ipaccess_head_ext *) msgb_l2(msg);
596 struct rspro_client_conn *conn = peer->data;
597 RsproPDU_t *pdu;
598 int rc;
599
600 if (msgb_length(msg) < sizeof(*hh))
601 goto invalid;
602 msg->l2h = &hh->data[0];
Harald Welte7bfcc652019-03-08 16:55:01 +0100603 switch (hh->proto) {
604 case IPAC_PROTO_IPACCESS:
605 rc = ipa_server_conn_ccm(peer, msg);
Harald Welte15b75e12019-03-08 16:55:46 +0100606 if (rc < 0)
607 break;
608 switch (hh->data[0]) {
609 case IPAC_MSGT_PONG:
610 ipa_keepalive_fsm_pong_received(conn->keepalive_fi);
611 rc = 0;
612 break;
613 default:
614 break;
615 }
Harald Welte7bfcc652019-03-08 16:55:01 +0100616 break;
617 case IPAC_PROTO_OSMO:
618 if (!he || msgb_l2len(msg)< sizeof(*he))
619 goto invalid;
620 msg->l2h = &he->data[0];
Harald Weltef5a0fa32019-03-03 15:44:18 +0100621
Harald Welte7bfcc652019-03-08 16:55:01 +0100622 switch (he->proto) {
623 case IPAC_PROTO_EXT_RSPRO:
624 pdu = rspro_dec_msg(msg);
625 if (!pdu)
626 goto invalid;
Harald Weltef5a0fa32019-03-03 15:44:18 +0100627
Harald Welte7bfcc652019-03-08 16:55:01 +0100628 rc = handle_rx_rspro(conn, pdu);
629 ASN_STRUCT_FREE(asn_DEF_RsproPDU, pdu);
630 break;
631 default:
632 goto invalid;
633 }
634 break;
635 default:
Harald Weltef5a0fa32019-03-03 15:44:18 +0100636 goto invalid;
Harald Welte7bfcc652019-03-08 16:55:01 +0100637 }
Harald Welte6b990f92019-07-18 18:16:33 +0200638 msgb_free(msg);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100639 return rc;
640
641invalid:
642 msgb_free(msg);
643 return -1;
644}
645
646static int sock_closed_cb(struct ipa_server_conn *peer)
647{
648 struct rspro_client_conn *conn = peer->data;
649 if (conn->fi)
650 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_TCP_DOWN, NULL);
651 /* FIXME: who cleans up conn? */
652 /* ipa server code relases 'peer' just after this */
653 return 0;
654}
655
Harald Welte15b75e12019-03-08 16:55:46 +0100656static const struct ipa_keepalive_params ka_params = {
657 .interval = 30,
658 .wait_for_resp = 10,
659};
660
Harald Weltef5a0fa32019-03-03 15:44:18 +0100661/* a new TCP connection was accepted on the RSPRO server socket */
662static int accept_cb(struct ipa_server_link *link, int fd)
663{
664 struct rspro_server *srv = link->data;
665 struct rspro_client_conn *conn;
666
667 conn = talloc_zero(srv, struct rspro_client_conn);
668 OSMO_ASSERT(conn);
669
670 conn->srv = srv;
671 /* don't allocate peer under 'conn', as it must survive 'conn' during teardown */
672 conn->peer = ipa_server_conn_create(link, link, fd, sock_read_cb, sock_closed_cb, conn);
673 if (!conn->peer)
674 goto out_err;
675
676 /* don't allocate 'fi' as slave from 'conn', as 'fi' needs to survive 'conn' during
677 * teardown */
678 conn->fi = server_client_fsm_alloc(srv, conn);
679 if (!conn->fi)
680 goto out_err_conn;
681
Harald Welte15b75e12019-03-08 16:55:46 +0100682 /* use ipa_keepalive_fsm to periodically send an IPA_PING and expect a PONG in response */
683 conn->keepalive_fi = ipa_server_conn_alloc_keepalive_fsm(conn->peer, &ka_params, NULL);
684 if (!conn->keepalive_fi)
685 goto out_err_fi;
686 /* ensure parent is notified once keepalive FSM instance is dying */
687 osmo_fsm_inst_change_parent(conn->keepalive_fi, conn->fi, CLNTC_E_KA_TIMEOUT);
688 ipa_keepalive_fsm_start(conn->keepalive_fi);
689
Harald Weltef5a0fa32019-03-03 15:44:18 +0100690 INIT_LLIST_HEAD(&conn->bank.maps_new);
691 INIT_LLIST_HEAD(&conn->bank.maps_unack);
692 INIT_LLIST_HEAD(&conn->bank.maps_active);
693 INIT_LLIST_HEAD(&conn->bank.maps_delreq);
694 INIT_LLIST_HEAD(&conn->bank.maps_deleting);
695
696 pthread_rwlock_wrlock(&conn->srv->rwlock);
697 llist_add_tail(&conn->list, &srv->connections);
698 pthread_rwlock_unlock(&conn->srv->rwlock);
699
700 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_TCP_UP, NULL);
701 return 0;
702
Harald Welte15b75e12019-03-08 16:55:46 +0100703out_err_fi:
704 osmo_fsm_inst_term(conn->fi, OSMO_FSM_TERM_ERROR, NULL);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100705out_err_conn:
706 ipa_server_conn_destroy(conn->peer);
707 /* the above will free 'conn' down the chain */
708 return -1;
709out_err:
710 talloc_free(conn);
711 return -1;
712}
713
714/* call-back if we were triggered by a rest_api thread */
715int event_fd_cb(struct osmo_fd *ofd, unsigned int what)
716{
717 struct rspro_server *srv = ofd->data;
718 struct rspro_client_conn *conn;
719 bool non_empty_new, non_empty_del;
720 uint64_t value;
721 int rc;
722
723 /* read from the socket to "confirm" the event and make it non-readable again */
724 rc = read(ofd->fd, &value, 8);
725 if (rc < 8) {
Harald Weltea9d7ad12021-12-08 21:09:12 +0100726 LOGP(DMAIN, LOGL_ERROR, "Error reading eventfd: %d\n", rc);
Harald Weltef5a0fa32019-03-03 15:44:18 +0100727 return rc;
728 }
729
Harald Weltea9d7ad12021-12-08 21:09:12 +0100730 LOGP(DMAIN, LOGL_INFO, "Event FD arrived, checking for any pending work\n");
Harald Weltef5a0fa32019-03-03 15:44:18 +0100731
732 pthread_rwlock_rdlock(&srv->rwlock);
733 llist_for_each_entry(conn, &srv->banks, list) {
734 slotmaps_rdlock(srv->slotmaps);
735 non_empty_new = llist_empty(&conn->bank.maps_new);
736 non_empty_del = llist_empty(&conn->bank.maps_delreq);
737 slotmaps_unlock(srv->slotmaps);
738
739 /* trigger FSM to send any pending new/deleted maps */
740 if (non_empty_new || non_empty_del)
741 osmo_fsm_inst_dispatch(conn->fi, CLNTC_E_PUSH, NULL);
742 }
743 pthread_rwlock_unlock(&srv->rwlock);
744
745 return 0;
746}
747
748/* unlink all slotmaps from any of the lists of this conn->bank.maps_* */
749static void _unlink_all_slotmaps(struct rspro_client_conn *conn)
750{
751 struct slot_mapping *smap, *smap2;
752
753 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_new, bank_list) {
754 /* unlink from list and keep in state NEW */
755 _slotmap_state_change(smap, SLMAP_S_NEW, NULL);
756 }
757 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_unack, bank_list) {
758 /* unlink from list and change to state NEW */
759 _slotmap_state_change(smap, SLMAP_S_NEW, NULL);
760 }
761 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_active, 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_delreq, bank_list) {
766 /* unlink from list and delete */
767 _slotmap_del(smap->maps, smap);
768 }
769 llist_for_each_entry_safe(smap, smap2, &conn->bank.maps_deleting, bank_list) {
770 /* unlink from list and delete */
771 _slotmap_del(smap->maps, smap);
772 }
773}
774
775/* only to be used by the FSM cleanup. */
776static void rspro_client_conn_destroy(struct rspro_client_conn *conn)
777{
778 /* this will internally call closed_cb() which will dispatch a TCP_DOWN event */
779 ipa_server_conn_destroy(conn->peer);
780 conn->peer = NULL;
781
782 /* ensure all slotmaps are unlinked + returned to NEW or deleted */
783 slotmaps_wrlock(conn->srv->slotmaps);
784 _unlink_all_slotmaps(conn);
785 slotmaps_unlock(conn->srv->slotmaps);
786
787 pthread_rwlock_wrlock(&conn->srv->rwlock);
788 llist_del(&conn->list);
789 pthread_rwlock_unlock(&conn->srv->rwlock);
790
791 talloc_free(conn);
792}
793
794
795struct rspro_server *rspro_server_create(void *ctx, const char *host, uint16_t port)
796
797{
798 struct rspro_server *srv = talloc_zero(ctx, struct rspro_server);
799 OSMO_ASSERT(srv);
800
801 pthread_rwlock_init(&srv->rwlock, NULL);
802 pthread_rwlock_wrlock(&srv->rwlock);
803 INIT_LLIST_HEAD(&srv->connections);
804 INIT_LLIST_HEAD(&srv->clients);
805 INIT_LLIST_HEAD(&srv->banks);
806 pthread_rwlock_unlock(&srv->rwlock);
807
808 srv->link = ipa_server_link_create(ctx, NULL, host, port, accept_cb, srv);
809 ipa_server_link_open(srv->link);
810
811 return srv;
812}
813
814void rspro_server_destroy(struct rspro_server *srv)
815{
816 /* FIXME: clear all lists */
817
818 ipa_server_link_destroy(srv->link);
819 srv->link = NULL;
820 talloc_free(srv);
821}