laforge has submitted this change. ( https://gerrit.osmocom.org/c/osmo-cbc/+/28797 ) Change subject: Rearrange cbc_message and cbsp message code ...................................................................... Rearrange cbc_message and cbsp message code Move code from message_handling containing both code for generic cbc_message and specific cbsp_message into thers files. The former are moved to cbc_message.c and the later to cbsp_msg.c, similar to what's already done for SBc-AP messages. Change-Id: Ie4082e40f23170cfd6c573fbbb7beb8c6226b6e6 --- M include/osmocom/cbc/Makefile.am A include/osmocom/cbc/cbsp_msg.h M src/Makefile.am M src/cbc_message.c A src/cbsp_msg.c D src/message_handling.c 6 files changed, 256 insertions(+), 248 deletions(-) Approvals: Jenkins Builder: Verified laforge: Looks good to me, approved; Verified fixeria: Looks good to me, but someone else must approve diff --git a/include/osmocom/cbc/Makefile.am b/include/osmocom/cbc/Makefile.am index b345434..dc3a21f 100644 --- a/include/osmocom/cbc/Makefile.am +++ b/include/osmocom/cbc/Makefile.am @@ -5,6 +5,7 @@ cbc_vty.h \ cbsp_link.h \ cbsp_link_fsm.h \ + cbsp_msg.h \ charset.h \ debug.h \ sbcap_msg.h \ diff --git a/include/osmocom/cbc/cbsp_msg.h b/include/osmocom/cbc/cbsp_msg.h new file mode 100644 index 0000000..d64d355 --- /dev/null +++ b/include/osmocom/cbc/cbsp_msg.h @@ -0,0 +1,5 @@ +#pragma once +#include <osmocom/gsm/cbsp.h> + +struct cbc_message; +struct osmo_cbsp_decoded *cbcmsg_to_cbsp(void *ctx, const struct cbc_message *cbcmsg); diff --git a/src/Makefile.am b/src/Makefile.am index e72b20b..de40dea 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -17,9 +17,9 @@ cbc_vty.c \ cbsp_link.c \ cbsp_link_fsm.c \ + cbsp_msg.c \ rest_api.c \ charset.c \ - message_handling.c \ rest_it_op.c \ sbcap_msg.c \ sbcap_link.c \ diff --git a/src/cbc_message.c b/src/cbc_message.c index c88e907..8884b6c 100644 --- a/src/cbc_message.c +++ b/src/cbc_message.c @@ -27,8 +27,147 @@ #include <osmocom/core/linuxlist.h> #include <osmocom/core/talloc.h> #include <osmocom/core/utils.h> +#include <osmocom/core/logging.h> +#include <osmocom/cbc/cbsp_msg.h> +#include <osmocom/cbc/cbsp_link.h> +#include <osmocom/cbc/sbcap_msg.h> +#include <osmocom/cbc/sbcap_link.h> #include <osmocom/cbc/cbc_message.h> +#include <osmocom/cbc/cbc_peer.h> +#include <osmocom/cbc/debug.h> +#include <osmocom/cbc/rest_it_op.h> +#include <osmocom/cbc/smscb_message_fsm.h> + +/* determine if peer is within scope of cbc_msg */ +static bool is_peer_in_scope(const struct cbc_peer *peer, const struct cbc_message *cbcmsg) +{ + switch (cbcmsg->scope) { + case CBC_MSG_SCOPE_PLMN: + return true; + /* FIXME: differnt scopes */ + default: + OSMO_ASSERT(0); + } +} + +/* send given new message to given peer */ +int peer_new_cbc_message(struct cbc_peer *peer, struct cbc_message *cbcmsg) +{ + struct osmo_cbsp_decoded *cbsp; + SBcAP_SBC_AP_PDU_t *sbcap; + + switch (peer->proto) { + case CBC_PEER_PROTO_CBSP: + /* skip peers without any current CBSP connection */ + if (!peer->link.cbsp) { + LOGP(DCBSP, LOGL_NOTICE, "[%s] Tx CBSP: not connected\n", + peer->name); + return -ENOTCONN; + } + if (!(cbsp = cbcmsg_to_cbsp(peer, cbcmsg))) { + LOGP(DCBSP, LOGL_ERROR, "[%s] Tx CBSP: msg gen failed\n", + peer->name); + return -EINVAL; + } + cbc_cbsp_link_tx(peer->link.cbsp, cbsp); + break; + case CBC_PEER_PROTO_SBcAP: + /* skip peers without any current SBc-AP connection */ + if (!peer->link.sbcap) { + LOGP(DSBcAP, LOGL_NOTICE, "[%s] Tx SBc-AP: not connected\n", + peer->name); + return -ENOTCONN; + } + if (!(sbcap = cbcmsg_to_sbcap(peer, cbcmsg))) { + LOGP(DSBcAP, LOGL_ERROR, "[%s] Tx SBc-AP: msg gen failed\n", + peer->name); + return -EINVAL; + } + cbc_sbcap_link_tx(peer->link.sbcap, sbcap); + break; + case CBC_PEER_PROTO_SABP: + LOGP(DLGLOBAL, LOGL_ERROR, "Sending message to peer proto %s not implemented!\n", + get_value_string(cbc_peer_proto_name, peer->proto)); + return -1; + default: + OSMO_ASSERT(0); + } + + return 0; +} + +/* receive a new CBC message from the user (REST). Allocates new memory, + * a FSM, copies data from 'orig', routes to all peers and starts FSMs. + * Once the operation is complete (success, error, timeout) we must + * notify osmo_it_q of the completion */ +int cbc_message_new(const struct cbc_message *orig, struct rest_it_op *op) +{ + struct cbc_message *cbcmsg = cbc_message_alloc(g_cbc, orig); + struct cbc_peer *peer; + + if (!cbcmsg) { + rest_it_op_set_http_result(op, 409, "Could not allocate"); + rest_it_op_complete(op); + return -ENOMEM; + } + + OSMO_ASSERT(llist_empty(&cbcmsg->peers)); + + /* iterate over all peers */ + llist_for_each_entry(peer, &g_cbc->peers, list) { + struct cbc_message_peer *mp; + + if (!is_peer_in_scope(peer, cbcmsg)) + continue; + + /* allocate new cbc_mesage_peer + related FSM */ + mp = smscb_peer_fsm_alloc(peer, cbcmsg); + if (!mp) { + LOGP(DCBSP, LOGL_ERROR, "Cannot allocate cbc_message_peer\n"); + continue; + } + } + + /* kick off the state machine[s] */ + if (osmo_fsm_inst_dispatch(cbcmsg->fi, SMSCB_E_CREATE, op) < 0) { + rest_it_op_set_http_result(op, 500, "Illegal FSM event"); + rest_it_op_complete(op); + } + + /* we continue in the FSM after the WRITE_ACK event was received */ + + return 0; +} + +void cbc_message_delete(struct cbc_message *cbcmsg, struct rest_it_op *op) +{ + if (osmo_fsm_inst_dispatch(cbcmsg->fi, SMSCB_E_DELETE, op) < 0) { + rest_it_op_set_http_result(op, 500, "Illegal FSM event"); + rest_it_op_complete(op); + } + /* we continue in the FSM after the DELETE_ACK event was received */ +} + +struct cbc_message *cbc_message_by_id(uint16_t message_id) +{ + struct cbc_message *cbc_msg; + llist_for_each_entry(cbc_msg, &g_cbc->messages, list) { + if (cbc_msg->msg.message_id == message_id) + return cbc_msg; + } + return NULL; +} + +struct cbc_message *cbc_message_expired_by_id(uint16_t message_id) +{ + struct cbc_message *cbc_msg; + llist_for_each_entry(cbc_msg, &g_cbc->expired_messages, list) { + if (cbc_msg->msg.message_id == message_id) + return cbc_msg; + } + return NULL; +} /* remove a peer from the message */ int cbc_message_del_peer(struct cbc_message *cbcmsg, struct cbc_peer *peer) diff --git a/src/cbsp_msg.c b/src/cbsp_msg.c new file mode 100644 index 0000000..4d0f8d3 --- /dev/null +++ b/src/cbsp_msg.c @@ -0,0 +1,110 @@ +/* Osmocom CBC (Cell Broacast Centre) */ + +/* (C) 2019 by Harald Welte &lt;laforge(a)gnumonks.org&gt; + * All Rights Reserved + * + * SPDX-License-Identifier: AGPL-3.0+ + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as published by + * the Free Software Foundation; either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + * + */ + + +#include <errno.h> + +#include <osmocom/core/linuxlist.h> +#include <osmocom/core/utils.h> +#include <osmocom/gsm/cbsp.h> +#include <osmocom/cbc/cbsp_msg.h> +#include <osmocom/cbc/cbc_message.h> + +/* convert cbc_message to osmo_cbsp_cell_list */ +static int cbcmsg_to_cbsp_cell_list(const void *ctx, struct osmo_cbsp_cell_list *list, + const struct cbc_message *cbcmsg) +{ + struct osmo_cbsp_cell_ent *ent; + + switch (cbcmsg->scope) { + case CBC_MSG_SCOPE_PLMN: + list->id_discr = CELL_IDENT_BSS; + ent = talloc_zero(ctx, struct osmo_cbsp_cell_ent); + if (!ent) + return -ENOMEM; + //ent->cell_id = ? + llist_add_tail(&ent->list, &list->list); + return 0; + default: + OSMO_ASSERT(0); + } +} + +/* generate a CBSP WRITE-REPLACE from our internal representation */ +struct osmo_cbsp_decoded *cbcmsg_to_cbsp(void *ctx, const struct cbc_message *cbcmsg) +{ + struct osmo_cbsp_write_replace *wrepl; + const struct smscb_message *smscb = &cbcmsg->msg; + struct osmo_cbsp_decoded *cbsp = osmo_cbsp_decoded_alloc(ctx, CBSP_MSGT_WRITE_REPLACE); + unsigned int i; + int rc; + + if (!cbsp) + return NULL; + wrepl = &cbsp->u.write_replace; + + wrepl->msg_id = smscb->message_id; + wrepl->new_serial_nr = smscb->serial_nr; + /* FIXME: old? */ + /* Cell list */ + rc = cbcmsg_to_cbsp_cell_list(cbcmsg, &wrepl->cell_list, cbcmsg); + if (rc < 0) { + talloc_free(cbsp); + return NULL; + } + if (!smscb->is_etws) + wrepl->is_cbs = true; + if (wrepl->is_cbs) { + if (cbcmsg->extended_cbch) + wrepl->u.cbs.channel_ind = CBSP_CHAN_IND_EXTENDED; + else + wrepl->u.cbs.channel_ind = CBSP_CHAN_IND_BASIC; + wrepl->u.cbs.category = cbcmsg->priority; + wrepl->u.cbs.rep_period = cbcmsg->rep_period; + wrepl->u.cbs.num_bcast_req = cbcmsg->num_bcast; + wrepl->u.cbs.dcs = smscb->cbs.dcs; + INIT_LLIST_HEAD(&wrepl->u.cbs.msg_content); + for (i = 0; i < smscb->cbs.num_pages; i++) { + struct osmo_cbsp_content *ce = talloc_zero(cbsp, struct osmo_cbsp_content); + if (i == smscb->cbs.num_pages - 1) + ce->user_len = smscb->cbs.data_user_len - (i * SMSCB_RAW_PAGE_LEN); + else + ce->user_len = SMSCB_RAW_PAGE_LEN; + memcpy(ce->data, smscb->cbs.data[i], SMSCB_RAW_PAGE_LEN); + llist_add_tail(&ce->list, &wrepl->u.cbs.msg_content); + } + } else { + wrepl->u.emergency.indicator = 1; + wrepl->u.emergency.warning_type = (smscb->etws.warning_type & 0x7f) << 9; + if (smscb->etws.user_alert) + wrepl->u.emergency.warning_type |= 0x0100; + if (smscb->etws.popup_on_display) + wrepl->u.emergency.warning_type |= 0x0080; + memcpy(wrepl->u.emergency.warning_sec_info, smscb->etws.warning_sec_info, + sizeof(wrepl->u.emergency.warning_sec_info)); + if (cbcmsg->warning_period_sec == 0xffffffff) + wrepl->u.emergency.warning_period = 0; + else + wrepl->u.emergency.warning_period = cbcmsg->warning_period_sec; + } + return cbsp; +} diff --git a/src/message_handling.c b/src/message_handling.c deleted file mode 100644 index 76739c3..0000000 --- a/src/message_handling.c +++ /dev/null @@ -1,247 +0,0 @@ -/* Osmocom CBC (Cell Broacast Centre) */ - -/* (C) 2019 by Harald Welte &lt;laforge(a)gnumonks.org&gt; - * All Rights Reserved - * - * SPDX-License-Identifier: AGPL-3.0+ - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU Affero General Public License as published by - * the Free Software Foundation; either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Affero General Public License for more details. - * - * You should have received a copy of the GNU Affero General Public License - * along with this program. If not, see <http://www.gnu.org/licenses/>. - * - */ - - -#include <errno.h> - -#include <osmocom/core/linuxlist.h> -#include <osmocom/core/utils.h> -#include <osmocom/gsm/cbsp.h> - -#include <osmocom/cbc/cbc_data.h> -#include <osmocom/cbc/cbsp_link.h> -#include <osmocom/cbc/sbcap_link.h> -#include <osmocom/cbc/sbcap_msg.h> -#include <osmocom/cbc/rest_it_op.h> -#include <osmocom/cbc/debug.h> -#include <osmocom/cbc/cbc_peer.h> -#include <osmocom/cbc/smscb_message_fsm.h> - -/* convert cbc_message to osmo_cbsp_cell_list */ -static int cbcmsg_to_cbsp_cell_list(const void *ctx, struct osmo_cbsp_cell_list *list, - const struct cbc_message *cbcmsg) -{ - struct osmo_cbsp_cell_ent *ent; - - switch (cbcmsg->scope) { - case CBC_MSG_SCOPE_PLMN: - list->id_discr = CELL_IDENT_BSS; - ent = talloc_zero(ctx, struct osmo_cbsp_cell_ent); - if (!ent) - return -ENOMEM; - //ent->cell_id = ? - llist_add_tail(&ent->list, &list->list); - return 0; - default: - OSMO_ASSERT(0); - } -} - -/* generate a CBSP WRITE-REPLACE from our internal representation */ -struct osmo_cbsp_decoded *cbcmsg_to_cbsp(void *ctx, const struct cbc_message *cbcmsg) -{ - struct osmo_cbsp_write_replace *wrepl; - const struct smscb_message *smscb = &cbcmsg->msg; - struct osmo_cbsp_decoded *cbsp = osmo_cbsp_decoded_alloc(ctx, CBSP_MSGT_WRITE_REPLACE); - unsigned int i; - int rc; - - if (!cbsp) - return NULL; - wrepl = &cbsp->u.write_replace; - - wrepl->msg_id = smscb->message_id; - wrepl->new_serial_nr = smscb->serial_nr; - /* FIXME: old? */ - /* Cell list */ - rc = cbcmsg_to_cbsp_cell_list(cbcmsg, &wrepl->cell_list, cbcmsg); - if (rc < 0) { - talloc_free(cbsp); - return NULL; - } - if (!smscb->is_etws) - wrepl->is_cbs = true; - if (wrepl->is_cbs) { - if (cbcmsg->extended_cbch) - wrepl->u.cbs.channel_ind = CBSP_CHAN_IND_EXTENDED; - else - wrepl->u.cbs.channel_ind = CBSP_CHAN_IND_BASIC; - wrepl->u.cbs.category = cbcmsg->priority; - wrepl->u.cbs.rep_period = cbcmsg->rep_period; - wrepl->u.cbs.num_bcast_req = cbcmsg->num_bcast; - wrepl->u.cbs.dcs = smscb->cbs.dcs; - INIT_LLIST_HEAD(&wrepl->u.cbs.msg_content); - for (i = 0; i < smscb->cbs.num_pages; i++) { - struct osmo_cbsp_content *ce = talloc_zero(cbsp, struct osmo_cbsp_content); - if (i == smscb->cbs.num_pages - 1) - ce->user_len = smscb->cbs.data_user_len - (i * SMSCB_RAW_PAGE_LEN); - else - ce->user_len = SMSCB_RAW_PAGE_LEN; - memcpy(ce->data, smscb->cbs.data[i], SMSCB_RAW_PAGE_LEN); - llist_add_tail(&ce->list, &wrepl->u.cbs.msg_content); - } - } else { - wrepl->u.emergency.indicator = 1; - wrepl->u.emergency.warning_type = (smscb->etws.warning_type & 0x7f) << 9; - if (smscb->etws.user_alert) - wrepl->u.emergency.warning_type |= 0x0100; - if (smscb->etws.popup_on_display) - wrepl->u.emergency.warning_type |= 0x0080; - memcpy(wrepl->u.emergency.warning_sec_info, smscb->etws.warning_sec_info, - sizeof(wrepl->u.emergency.warning_sec_info)); - if (cbcmsg->warning_period_sec == 0xffffffff) - wrepl->u.emergency.warning_period = 0; - else - wrepl->u.emergency.warning_period = cbcmsg->warning_period_sec; - } - return cbsp; -} - -/* determine if peer is within scope of cbc_msg */ -static bool is_peer_in_scope(const struct cbc_peer *peer, const struct cbc_message *cbcmsg) -{ - switch (cbcmsg->scope) { - case CBC_MSG_SCOPE_PLMN: - return true; - /* FIXME: differnt scopes */ - default: - OSMO_ASSERT(0); - } -} - -/* send given new message to given peer */ -int peer_new_cbc_message(struct cbc_peer *peer, struct cbc_message *cbcmsg) -{ - struct osmo_cbsp_decoded *cbsp; - SBcAP_SBC_AP_PDU_t *sbcap; - - switch (peer->proto) { - case CBC_PEER_PROTO_CBSP: - /* skip peers without any current CBSP connection */ - if (!peer->link.cbsp) { - LOGP(DCBSP, LOGL_NOTICE, "[%s] Tx CBSP: not connected\n", - peer->name); - return -ENOTCONN; - } - if (!(cbsp = cbcmsg_to_cbsp(peer, cbcmsg))) { - LOGP(DCBSP, LOGL_ERROR, "[%s] Tx CBSP: msg gen failed\n", - peer->name); - return -EINVAL; - } - cbc_cbsp_link_tx(peer->link.cbsp, cbsp); - break; - case CBC_PEER_PROTO_SBcAP: - /* skip peers without any current SBc-AP connection */ - if (!peer->link.sbcap) { - LOGP(DSBcAP, LOGL_NOTICE, "[%s] Tx SBc-AP: not connected\n", - peer->name); - return -ENOTCONN; - } - if (!(sbcap = cbcmsg_to_sbcap(peer, cbcmsg))) { - LOGP(DSBcAP, LOGL_ERROR, "[%s] Tx SBc-AP: msg gen failed\n", - peer->name); - return -EINVAL; - } - cbc_sbcap_link_tx(peer->link.sbcap, sbcap); - break; - case CBC_PEER_PROTO_SABP: - LOGP(DLGLOBAL, LOGL_ERROR, "Sending message to peer proto %s not implemented!\n", - get_value_string(cbc_peer_proto_name, peer->proto)); - return -1; - default: - OSMO_ASSERT(0); - } - - return 0; -} - -/* receive a new CBC message from the user (REST). Allocates new memory, - * a FSM, copies data from 'orig', routes to all peers and starts FSMs. - * Once the operation is complete (success, error, timeout) we must - * notify osmo_it_q of the completion */ -int cbc_message_new(const struct cbc_message *orig, struct rest_it_op *op) -{ - struct cbc_message *cbcmsg = cbc_message_alloc(g_cbc, orig); - struct cbc_peer *peer; - - if (!cbcmsg) { - rest_it_op_set_http_result(op, 409, "Could not allocate"); - rest_it_op_complete(op); - return -ENOMEM; - } - - OSMO_ASSERT(llist_empty(&cbcmsg->peers)); - - /* iterate over all peers */ - llist_for_each_entry(peer, &g_cbc->peers, list) { - struct cbc_message_peer *mp; - - if (!is_peer_in_scope(peer, cbcmsg)) - continue; - - /* allocate new cbc_mesage_peer + related FSM */ - mp = smscb_peer_fsm_alloc(peer, cbcmsg); - if (!mp) { - LOGP(DCBSP, LOGL_ERROR, "Cannot allocate cbc_message_peer\n"); - continue; - } - } - - /* kick off the state machine[s] */ - if (osmo_fsm_inst_dispatch(cbcmsg->fi, SMSCB_E_CREATE, op) < 0) { - rest_it_op_set_http_result(op, 500, "Illegal FSM event"); - rest_it_op_complete(op); - } - - /* we continue in the FSM after the WRITE_ACK event was received */ - - return 0; -} - -void cbc_message_delete(struct cbc_message *cbcmsg, struct rest_it_op *op) -{ - if (osmo_fsm_inst_dispatch(cbcmsg->fi, SMSCB_E_DELETE, op) < 0) { - rest_it_op_set_http_result(op, 500, "Illegal FSM event"); - rest_it_op_complete(op); - } - /* we continue in the FSM after the DELETE_ACK event was received */ -} - -struct cbc_message *cbc_message_by_id(uint16_t message_id) -{ - struct cbc_message *cbc_msg; - llist_for_each_entry(cbc_msg, &g_cbc->messages, list) { - if (cbc_msg->msg.message_id == message_id) - return cbc_msg; - } - return NULL; -} - -struct cbc_message *cbc_message_expired_by_id(uint16_t message_id) -{ - struct cbc_message *cbc_msg; - llist_for_each_entry(cbc_msg, &g_cbc->expired_messages, list) { - if (cbc_msg->msg.message_id == message_id) - return cbc_msg; - } - return NULL; -} -- To view, visit https://gerrit.osmocom.org/c/osmo-cbc/+/28797 To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings Gerrit-Project: osmo-cbc Gerrit-Branch: master Gerrit-Change-Id: Ie4082e40f23170cfd6c573fbbb7beb8c6226b6e6 Gerrit-Change-Number: 28797 Gerrit-PatchSet: 1 Gerrit-Owner: pespin &lt;pespin(a)sysmocom.de&gt; Gerrit-Reviewer: Jenkins Builder Gerrit-Reviewer: fixeria &lt;vyanitskiy(a)sysmocom.de&gt; Gerrit-Reviewer: laforge &lt;laforge(a)osmocom.org&gt; Gerrit-MessageType: merged