From e3698106befe482eea4c1f3af1597ba56732c894 Mon Sep 17 00:00:00 2001 From: Neels Hofmeyr Date: Fri, 23 Feb 2018 01:37:57 +0100 Subject: trying to get handover_test.c to compile Change-Id: Ic9fdfed86157e044f8809558edaa6dfd9782870b --- src/libbsc/Makefile.am | 1 + src/libbsc/bsc_subscr_conn_fsm.c | 1054 ++++++++++++++++++++++++++++++++++++ src/osmo-bsc/Makefile.am | 1 - src/osmo-bsc/bsc_subscr_conn_fsm.c | 1054 ------------------------------------ tests/handover/Makefile.am | 4 + tests/handover/handover_test.c | 5 +- 6 files changed, 1062 insertions(+), 1057 deletions(-) create mode 100644 src/libbsc/bsc_subscr_conn_fsm.c delete mode 100644 src/osmo-bsc/bsc_subscr_conn_fsm.c diff --git a/src/libbsc/Makefile.am b/src/libbsc/Makefile.am index 805a7ee1f..719ac936f 100644 --- a/src/libbsc/Makefile.am +++ b/src/libbsc/Makefile.am @@ -62,5 +62,6 @@ libbsc_a_SOURCES = \ handover_cfg.c \ penalty_timers.c \ handover_decision_2.c \ + bsc_subscr_conn_fsm.c \ $(NULL) diff --git a/src/libbsc/bsc_subscr_conn_fsm.c b/src/libbsc/bsc_subscr_conn_fsm.c new file mode 100644 index 000000000..569921342 --- /dev/null +++ b/src/libbsc/bsc_subscr_conn_fsm.c @@ -0,0 +1,1054 @@ +/* (C) 2017 by Harald Welte + * All Rights Reserved + * + * 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 . + * + */ + +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define S(x) (1 << (x)) + +#define MGCP_MGW_TIMEOUT 4 /* in seconds */ +#define MGCP_MGW_TIMEOUT_TIMER_NR 1 + +#define MGCP_MGW_HO_TIMEOUT 4 /* in seconds */ +#define MGCP_MGW_HO_TIMEOUT_TIMER_NR 2 + +#define GSM0808_T10_TIMER_NR 10 +#define GSM0808_T10_VALUE 6 + +#define ENDPOINT_ID "rtpbridge/*@mgw" + +enum gscon_fsm_states { + ST_INIT, + /* waiting for CC from MSC */ + ST_WAIT_CC, + /* active connection */ + ST_ACTIVE, + /* during assignment; waiting for ASS_CMPL */ + ST_WAIT_ASS_CMPL, + /* during assignment; waiting for MODE_MODIFY_ACK */ + ST_WAIT_MODE_MODIFY_ACK, + /* BSSMAP CLEAR has been received */ + ST_CLEARING, + +/* MGW handling */ + /* during assignment; waiting for MGW response to CRCX for BTS */ + ST_WAIT_CRCX_BTS, + /* during assignment; waiting for MGW response to MDCX for BTS */ + ST_WAIT_MDCX_BTS, + /* during assignment; waiting for MGW response to CRCX for MSC */ + ST_WAIT_CRCX_MSC, + +/* MT (inbound) handover */ + /* Wait for Handover Access from MS/BTS */ + ST_WAIT_MT_HO_ACC, + /* Wait for RR Handover Complete from MS/BTS */ + ST_WAIT_MT_HO_COMPL, + +/* MO (outbound) handover */ + /* Wait for Handover Command / Handover Required Reject from MSC */ + ST_WAIT_MO_HO_CMD, + /* Wait for Clear Command from MSC */ + ST_MO_HO_PROCEEDING, + +/* Internal HO handling */ + /* Wait for the handover logic to complete the handover */ + ST_WAIT_HO_COMPL, + /* during handover; waiting for MGW response to MDCX for BTS */ + ST_WAIT_MDCX_BTS_HO, +}; + +static const struct value_string gscon_fsm_event_names[] = { + {GSCON_EV_A_CONN_IND, "MT-CONNECT.ind"}, + {GSCON_EV_A_CONN_REQ, "MO-CONNECT.req"}, + {GSCON_EV_A_CONN_CFM, "MO-CONNECT.cfm"}, + {GSCON_EV_A_ASSIGNMENT_CMD, "ASSIGNMENT_CMD"}, + {GSCON_EV_A_CLEAR_CMD, "CLEAR_CMD"}, + {GSCON_EV_A_DISC_IND, "DISCONNET.ind"}, + {GSCON_EV_A_HO_REQ, "HANDOVER_REQUEST"}, + + {GSCON_EV_RR_ASS_COMPL, "RR_ASSIGN_COMPL"}, + {GSCON_EV_RR_ASS_FAIL, "RR_ASSIGN_FAIL"}, + {GSCON_EV_RR_MODE_MODIFY_ACK, "RR_MODE_MODIFY_ACK"}, + {GSCON_EV_RR_HO_ACC, "RR_HO_ACCESS"}, + {GSCON_EV_RR_HO_COMPL, "RR_HO_COMPLETE"}, + {GSCON_EV_RLL_REL_IND, "RLL_RELEASE.ind"}, + {GSCON_EV_RSL_CONN_FAIL, "RSL_CONN_FAIL.ind"}, + {GSCON_EV_RSL_CLEAR_COMPL, "RSL_CLEAR_COMPLETE"}, + + {GSCON_EV_MO_DTAP, "MO-DTAP"}, + {GSCON_EV_MT_DTAP, "MT-DTAP"}, + {GSCON_EV_TX_SCCP, "TX_SCCP"}, + + {GSCON_EV_MGW_FAIL_BTS, "MGW_FAILURE_BTS"}, + {GSCON_EV_MGW_FAIL_MSC, "MGW_FAILURE_MSC"}, + {GSCON_EV_MGW_CRCX_RESP_BTS, "MGW_CRCX_RESPONSE_BTS"}, + {GSCON_EV_MGW_MDCX_RESP_BTS, "MGW_MDCX_RESPONSE_BTS"}, + {GSCON_EV_MGW_CRCX_RESP_MSC, "MGW_CRCX_RESPONSE_MSC"}, + + {GSCON_EV_HO_START, "HO_START"}, + {GSCON_EV_HO_TIMEOUT, "HO_TIMEOUT"}, + {GSCON_EV_HO_FAIL, "HO_FAIL"}, + {GSCON_EV_HO_COMPL, "HO_COMPL"}, + + {0, NULL} +}; + +/* Send data SCCP message through SCCP connection. All sigtran messages + * that are send from this FSM must use this function. Never use + * osmo_bsc_sigtran_send() directly since this would defeat the checks + * provided by this function. */ +static void sigtran_send(struct gsm_subscriber_connection *conn, struct msgb *msg, struct osmo_fsm_inst *fi) +{ + int rc; + + /* Make sure that we only attempt to send SCCP messages if we have + * a life SCCP connection. Otherwise drop the message. */ + if (fi->state == ST_INIT || fi->state == ST_WAIT_CC) { + LOGPFSML(fi, LOGL_ERROR, "No active SCCP connection, dropping message!\n"); + msgb_free(msg); + return; + } + + rc = osmo_bsc_sigtran_send(conn, msg); + if (rc < 0) + LOGPFSML(fi, LOGL_ERROR, "Unable to deliver SCCP message!\n"); +} + +/* Generate and send assignment complete message */ +static void send_ass_compl(struct gsm_lchan *lchan, struct osmo_fsm_inst *fi) +{ + struct msgb *resp; + struct gsm0808_speech_codec sc; + struct gsm_subscriber_connection *conn; + + conn = lchan->conn; + + OSMO_ASSERT(lchan->abis_ip.ass_compl.valid); + OSMO_ASSERT(conn); + + LOGPFSML(fi, LOGL_DEBUG, "Sending assignment complete message... (id=%i)\n", conn->sccp.conn_id); + + /* Extrapolate speech codec from speech mode */ + gsm0808_speech_codec_from_chan_type(&sc, lchan->abis_ip.ass_compl.speech_mode); + + /* Generate message */ + resp = gsm0808_create_ass_compl(lchan->abis_ip.ass_compl.rr_cause, + lchan->abis_ip.ass_compl.chosen_channel, + lchan->abis_ip.ass_compl.encr_alg_id, + lchan->abis_ip.ass_compl.speech_mode, + &conn->user_plane.aoip_rtp_addr_local, &sc, NULL); + + if (!resp) { + LOGPFSML(fi, LOGL_ERROR, "Failed to generate assignment completed message! (id=%i)\n", + conn->sccp.conn_id); + } + + sigtran_send(conn, resp, fi); +} + +/* forward MT DTAP from BSSAP side to RSL side */ +static void submit_dtap(struct gsm_subscriber_connection *conn, struct msgb *msg, struct osmo_fsm_inst *fi) +{ + int rc; + struct msgb *resp = NULL; + + OSMO_ASSERT(fi); + OSMO_ASSERT(msg); + OSMO_ASSERT(conn); + + rc = gsm0808_submit_dtap(conn, msg, OBSC_LINKID_CB(msg), 1); + if (rc != 0) { + LOGPFSML(fi, LOGL_ERROR, "Tx BSSMAP CLEAR REQUEST to MSC\n"); + resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_EQUIPMENT_FAILURE); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + return; + } +} + +/* forward MO DTAP from RSL side to BSSAP side */ +/* FIXME: move fi parameter to the beginning */ +static void forward_dtap(struct msgb *msg, struct gsm_subscriber_connection *conn, struct osmo_fsm_inst *fi) +{ + struct msgb *resp = NULL; + + OSMO_ASSERT(msg); + OSMO_ASSERT(conn); + + resp = gsm0808_create_dtap(msg, OBSC_LINKID_CB(msg)); + sigtran_send(conn, resp, fi); +} + +/* In case there are open MGCP connections, toss + * those connections */ +static void toss_mgcp_conn(struct gsm_subscriber_connection *conn, struct osmo_fsm_inst *fi) +{ + LOGPFSML(fi, LOGL_ERROR, "tossing all MGCP connections...\n"); + + if (conn->user_plane.fi_bts) { + mgcp_conn_delete(conn->user_plane.fi_bts); + conn->user_plane.fi_bts = NULL; + } + + if (conn->user_plane.fi_msc) { + mgcp_conn_delete(conn->user_plane.fi_msc); + conn->user_plane.fi_msc = NULL; + } + + if (conn->user_plane.mgw_endpoint) { + talloc_free(conn->user_plane.mgw_endpoint); + conn->user_plane.mgw_endpoint = NULL; + } +} + +static void gscon_fsm_init(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct osmo_scu_prim *scu_prim = NULL; + struct msgb *msg = NULL; + int rc; + + switch (event) { + case GSCON_EV_A_CONN_REQ: + /* RLL ESTABLISH IND with initial L3 Message */ + msg = data; + /* FIXME: Extract Mobile ID and update FSM using osmo_fsm_inst_set_id() */ + rc = osmo_bsc_sigtran_open_conn(conn, msg); + if (rc < 0) { + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL); + } else { + /* SCCP T(conn est) is 1-2 minutes, way too long. The MS will timeout + * using T3210 (20s), T3220 (5s) or T3230 (10s) */ + osmo_fsm_inst_state_chg(fi, ST_WAIT_CC, 20, 993210); + } + break; + case GSCON_EV_A_CONN_IND: + scu_prim = data; + if (!conn->sccp.msc) { + LOGPFSML(fi, LOGL_NOTICE, "N-CONNECT.ind from unknown MSC %s\n", + osmo_sccp_addr_dump(&scu_prim->u.connect.calling_addr)); + osmo_sccp_tx_disconn(conn->sccp.msc->a.sccp_user, scu_prim->u.connect.conn_id, + &scu_prim->u.connect.called_addr, 0); + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); + } + /* FIXME: Extract optional IMSI and update FSM using osmo_fsm_inst_set_id() */ + LOGPFSML(fi, LOGL_NOTICE, "No support for MSC-originated SCCP Connections yet\n"); + osmo_sccp_tx_disconn(conn->sccp.msc->a.sccp_user, scu_prim->u.connect.conn_id, + &scu_prim->u.connect.called_addr, 0); + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +/* We've sent the CONNECTION.req to the SCCP provider and are waiting for CC from MSC */ +static void gscon_fsm_wait_cc(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + switch (event) { + case GSCON_EV_A_CONN_CFM: + /* MSC has confirmed the connection, we now change into the + * active state and wait there for further operations */ + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + /* if there's user payload, forward it just like EV_MT_DTAP */ + /* FIXME: Question: if there's user payload attached to the CC, forward it like EV_MT_DTAP? */ + break; + default: + OSMO_ASSERT(false); + break; + } +} + +/* We're on an active subscriber connection, passing DTAP back and forth */ +static void gscon_fsm_active(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct msgb *resp = NULL; + struct mgcp_conn_peer conn_peer; + int rc; + + switch (event) { + case GSCON_EV_A_ASSIGNMENT_CMD: + /* MSC requests us to perform assignment, this code section is + * triggered via signal GSCON_EV_A_ASSIGNMENT_CMD from + * bssmap_handle_assignm_req() in osmo_bsc_bssap.c, which does + * the parsing of incoming assignment requests. */ + + LOGPFSML(fi, LOGL_NOTICE, "Channel assignment: chan_mode=%s, full_rate=%i\n", + get_value_string(gsm48_chan_mode_names, conn->user_plane.chan_mode), + conn->user_plane.full_rate); + + /* FIXME: We need to check if current channel is sufficient. If + * yes, do MODIFY. If not, do assignment (see commented lines below) */ + + /* FIXME: At the moment, the FSM is constructed in an + * unfortunate way. In case of a voice channel assignment + * we first go through a couple of MGCP related states, + * then reach the state where the actual channel assignment + * happens and then again we perform some MGCP related + * actions and eventually end up in ST_ACTIVE again. This + * should be restructured */ + + switch (conn->user_plane.chan_mode) { + case GSM48_CMODE_SPEECH_V1: + case GSM48_CMODE_SPEECH_EFR: + case GSM48_CMODE_SPEECH_AMR: + /* A voice channel is requested, so we run down the + * mgcp-ass-mgcp state-chain (see FIXME above) */ + memset(&conn_peer, 0, sizeof(conn_peer)); + conn_peer.call_id = conn->sccp.conn_id; + osmo_strlcpy(conn_peer.endpoint, ENDPOINT_ID, sizeof(conn_peer.endpoint)); + + /* (Pre)Change state and create the connection */ + osmo_fsm_inst_state_chg(fi, ST_WAIT_CRCX_BTS, MGCP_MGW_TIMEOUT, MGCP_MGW_TIMEOUT_TIMER_NR); + conn->user_plane.fi_bts = + mgcp_conn_create(conn->network->mgw.client, fi, GSCON_EV_MGW_FAIL_BTS, + GSCON_EV_MGW_CRCX_RESP_BTS, &conn_peer); + if (!conn->user_plane.fi_bts) { + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + return; + } + break; + case GSM48_CMODE_SIGN: + /* A signalling channel is requested, so we perform the + * channel assignment directly without performing any + * MGCP actions. ST_WAIT_ASS_CMPL will see by the + * conn->user_plane.chan_mode parameter that this + * assignment is for a signalling channel and will then + * change back to ST_ACTIVE (here) immediately. */ + rc = gsm0808_assign_req(conn, conn->user_plane.full_rate, conn->user_plane.chan_mode); + if (rc != 0) { + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); + sigtran_send(conn, resp, fi); + return; + } + + osmo_fsm_inst_state_chg(fi, ST_WAIT_ASS_CMPL, GSM0808_T10_VALUE, GSM0808_T10_TIMER_NR); + break; + default: + /* An unsupported channel is requested, so we have to + * reject this request by sending an assignment failure + * message immediately */ + LOGPFSML(fi, LOGL_ERROR, "Requested channel mode is not supported!\n", + get_value_string(gsm48_chan_mode_names, conn->user_plane.chan_mode), + conn->user_plane.full_rate); + + /* The requested channel mode is not supported */ + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_NOT_SUPP, NULL); + sigtran_send(conn, resp, fi); + break; + } + break; + case GSCON_EV_HO_START: + rc = bsc_handover_start_gscon(conn); + if (rc) { + resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_EQUIPMENT_FAILURE); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_CLEARING, 0, 0); + return; + } + + /* Note: No timeout is set here, T3103 in handover_logic.c + * will generate a GSCON_EV_HO_TIMEOUT event should the + * handover time out, so we do not need another timeout + * here (maybe its worth to think about giving GSCON + * more power over the actual handover process). */ + osmo_fsm_inst_state_chg(fi, ST_WAIT_HO_COMPL, 0, 0); + break; + case GSCON_EV_A_HO_REQ: + /* FIXME: reject any handover requests with HO FAIL until implemented */ + break; + case GSCON_EV_MO_DTAP: + forward_dtap((struct msgb *)data, conn, fi); + break; + case GSCON_EV_MT_DTAP: + submit_dtap(conn, (struct msgb *)data, fi); + break; + case GSCON_EV_TX_SCCP: + sigtran_send(conn, (struct msgb *)data, fi); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +/* Before we may start the channel assignment we need to get an IP/Port for the + * RTP connection from the MGW */ +static void gscon_fsm_wait_crcx_bts(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct mgcp_conn_peer *conn_peer = NULL; + struct msgb *resp = NULL; + int rc; + + switch (event) { + case GSCON_EV_MGW_CRCX_RESP_BTS: + conn_peer = data; + + /* Check if the MGW has assigned an enpoint to us, we can not + * proceed */ + if (strlen(conn_peer->endpoint) <= 0) { + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + return; + } + + /* Memorize the endpoint name we got assigned from the MGW. + * When the BTS sided connection is done, we need to create + * a second connection on that same endpoint, so we need + * to know its ID */ + if (!conn->user_plane.mgw_endpoint) + conn->user_plane.mgw_endpoint = talloc_zero_size(conn, MGCP_ENDPOINT_MAXLEN); + OSMO_ASSERT(conn->user_plane.mgw_endpoint); + osmo_strlcpy(conn->user_plane.mgw_endpoint, conn_peer->endpoint, MGCP_ENDPOINT_MAXLEN); + + /* Store the IP-Address and the port the MGW assigned to us, + * then start the channel assignment. */ + conn->user_plane.rtp_port = conn_peer->port; + conn->user_plane.rtp_ip = osmo_ntohl(inet_addr(conn_peer->addr)); + rc = gsm0808_assign_req(conn, conn->user_plane.full_rate, conn->user_plane.chan_mode); + if (rc != 0) { + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_RQSTED_SPEECH_VERSION_UNAVAILABLE, NULL); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + return; + } + + osmo_fsm_inst_state_chg(fi, ST_WAIT_ASS_CMPL, GSM0808_T10_VALUE, GSM0808_T10_TIMER_NR); + break; + case GSCON_EV_MO_DTAP: + forward_dtap((struct msgb *)data, conn, fi); + break; + case GSCON_EV_MT_DTAP: + submit_dtap(conn, (struct msgb *)data, fi); + break; + case GSCON_EV_TX_SCCP: + sigtran_send(conn, (struct msgb *)data, fi); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +/* We're waiting for an ASSIGNMENT COMPLETE from MS */ +static void gscon_fsm_wait_ass_cmpl(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct gsm_lchan *lchan = conn->lchan; + struct mgcp_conn_peer conn_peer; + struct in_addr addr; + struct msgb *resp = NULL; + int rc; + + switch (event) { + case GSCON_EV_RR_ASS_COMPL: + switch (conn->user_plane.chan_mode) { + case GSM48_CMODE_SPEECH_V1: + case GSM48_CMODE_SPEECH_EFR: + case GSM48_CMODE_SPEECH_AMR: + /* FIXME: What if we are using SCCP-Lite? */ + + /* We are dealing with a voice channel, so we can not + * confirm the assignment directly. We must first do + * some final steps on the MGCP side. */ + + /* Prepare parameters with the information we got during the assignment */ + memset(&conn_peer, 0, sizeof(conn_peer)); + addr.s_addr = osmo_ntohl(lchan->abis_ip.bound_ip); + osmo_strlcpy(conn_peer.addr, inet_ntoa(addr), sizeof(conn_peer.addr)); + conn_peer.port = lchan->abis_ip.bound_port; + + /* (Pre)Change state and modify the connection */ + osmo_fsm_inst_state_chg(fi, ST_WAIT_MDCX_BTS, MGCP_MGW_TIMEOUT, MGCP_MGW_TIMEOUT_TIMER_NR); + rc = mgcp_conn_modify(conn->user_plane.fi_bts, GSCON_EV_MGW_MDCX_RESP_BTS, &conn_peer); + if (rc != 0) { + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + return; + } + break; + case GSM48_CMODE_SIGN: + /* Confirm the successful assignment on BSSMAP and + * change back into active state */ + send_ass_compl(lchan, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + break; + default: + /* Unsupported modes should have been already filtered + * by gscon_fsm_active(). If we reach the default + * section here anyway than some unsupported mode must + * have made it into the FSM, this would be a bug, so + * we fire an assertion here */ + OSMO_ASSERT(false); + break; + } + + break; + case GSCON_EV_RR_ASS_FAIL: + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_RQSTED_TERRESTRIAL_RESOURCE_UNAVAILABLE, NULL); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + break; + case GSCON_EV_MO_DTAP: + forward_dtap((struct msgb *)data, conn, fi); + break; + case GSCON_EV_MT_DTAP: + submit_dtap(conn, (struct msgb *)data, fi); + break; + case GSCON_EV_TX_SCCP: + sigtran_send(conn, (struct msgb *)data, fi); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +/* We are waiting for the MGW response to the MDCX */ +static void gscon_fsm_wait_mdcx_bts(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct mgcp_conn_peer conn_peer; + struct sockaddr_in *sin = NULL; + struct msgb *resp = NULL; + + switch (event) { + case GSCON_EV_MGW_MDCX_RESP_BTS: + + /* Prepare parameters with the connection information we got + * with the assignment command */ + memset(&conn_peer, 0, sizeof(conn_peer)); + conn_peer.call_id = conn->sccp.conn_id; + sin = (struct sockaddr_in *)&conn->user_plane.aoip_rtp_addr_remote; + conn_peer.port = osmo_ntohs(sin->sin_port); + osmo_strlcpy(conn_peer.addr, inet_ntoa(sin->sin_addr), sizeof(conn_peer.addr)); + + /* Make sure we use the same endpoint where we created the + * BTS connection. */ + osmo_strlcpy(conn_peer.endpoint, conn->user_plane.mgw_endpoint, sizeof(conn_peer.endpoint)); + + /* (Pre)Change state and create the connection */ + osmo_fsm_inst_state_chg(fi, ST_WAIT_CRCX_MSC, MGCP_MGW_TIMEOUT, MGCP_MGW_TIMEOUT_TIMER_NR); + conn->user_plane.fi_msc = + mgcp_conn_create(conn->network->mgw.client, fi, GSCON_EV_MGW_FAIL_MSC, GSCON_EV_MGW_CRCX_RESP_MSC, + &conn_peer); + if (!conn->user_plane.fi_bts) { + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + return; + } + + break; + case GSCON_EV_MO_DTAP: + forward_dtap((struct msgb *)data, conn, fi); + break; + case GSCON_EV_MT_DTAP: + submit_dtap(conn, (struct msgb *)data, fi); + break; + case GSCON_EV_TX_SCCP: + sigtran_send(conn, (struct msgb *)data, fi); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +static void gscon_fsm_wait_crcx_msc(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct mgcp_conn_peer *conn_peer = NULL; + struct gsm_lchan *lchan = conn->lchan; + struct sockaddr_in *sin = NULL; + + switch (event) { + case GSCON_EV_MGW_CRCX_RESP_MSC: + conn_peer = data; + + /* Store address information we got in response from the CRCX command. */ + sin = (struct sockaddr_in *)&conn->user_plane.aoip_rtp_addr_local; + sin->sin_family = AF_INET; + sin->sin_addr.s_addr = inet_addr(conn_peer->addr); + sin->sin_port = osmo_ntohs(conn_peer->port); + + /* Send assignment complete message to the MSC */ + send_ass_compl(lchan, fi); + + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + + break; + case GSCON_EV_MO_DTAP: + forward_dtap((struct msgb *)data, conn, fi); + break; + case GSCON_EV_MT_DTAP: + submit_dtap(conn, (struct msgb *)data, fi); + break; + case GSCON_EV_TX_SCCP: + sigtran_send(conn, (struct msgb *)data, fi); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +/* We're waiting for a MODE MODIFY ACK from MS + BTS */ +static void gscon_fsm_wait_mode_modify_ack(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct gsm_lchan *lchan = conn->lchan; + + switch (event) { + case GSCON_EV_RR_MODE_MODIFY_ACK: + /* we assume that not only have we received the RR MODE_MODIFY_ACK, but + * actually that also the BTS side of the channel mode has been changed accordingly */ + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + + /* FIXME: Check if this requires special handling. For now I assume that the send_ass_compl() + * can be used. But I am not sure. */ + send_ass_compl(lchan, fi); + + break; + /* FIXME: Do we need to handle DTAP traffic in this state? Maybe yes? Needs to be checked. */ + case GSCON_EV_MO_DTAP: + forward_dtap((struct msgb *)data, conn, fi); + break; + case GSCON_EV_MT_DTAP: + submit_dtap(conn, (struct msgb *)data, fi); + break; + case GSCON_EV_TX_SCCP: + sigtran_send(conn, (struct msgb *)data, fi); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +static void gscon_fsm_clearing(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct msgb *resp; + + switch (event) { + case GSCON_EV_RSL_CLEAR_COMPL: + resp = gsm0808_create_clear_complete(); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, data); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +/* Wait for the handover logic to tell us whether the handover completed, + * failed or has timed out */ +static void gscon_fsm_wait_ho_compl(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct mgcp_conn_peer conn_peer; + struct gsm_lchan *lchan = conn->lchan; + struct in_addr addr; + struct msgb *resp; + int rc; + + switch (event) { + case GSCON_EV_HO_COMPL: + /* The handover logic informs us that the handover has been + * completet. Now we have to tell the MGW the IP/Port on the + * new BTS so that the uplink RTP traffic can be redirected + * there. */ + + /* Prepare parameters with the information we got during the + * handover procedure (via IPACC) */ + memset(&conn_peer, 0, sizeof(conn_peer)); + addr.s_addr = osmo_ntohl(lchan->abis_ip.bound_ip); + osmo_strlcpy(conn_peer.addr, inet_ntoa(addr), sizeof(conn_peer.addr)); + conn_peer.port = lchan->abis_ip.bound_port; + + /* (Pre)Change state and modify the connection */ + osmo_fsm_inst_state_chg(fi, ST_WAIT_MDCX_BTS_HO, MGCP_MGW_TIMEOUT, MGCP_MGW_TIMEOUT_TIMER_NR); + rc = mgcp_conn_modify(conn->user_plane.fi_bts, GSCON_EV_MGW_MDCX_RESP_BTS, &conn_peer); + if (rc != 0) { + resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_EQUIPMENT_FAILURE); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_CLEARING, 0, 0); + return; + } + break; + + osmo_fsm_inst_state_chg(fi, ST_WAIT_MT_HO_COMPL, MGCP_MGW_HO_TIMEOUT, MGCP_MGW_HO_TIMEOUT_TIMER_NR); + break; + + case GSCON_EV_HO_TIMEOUT: + case GSCON_EV_HO_FAIL: + /* The handover logic informs us that the handover failed for + * some reason. This means the phone stays on the TS/BTS on + * which it currently is. We will change back to the active + * state again as there are no further operations needed */ + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +/* Wait for the MGW to confirm handover related modification of the connection + * parameters */ +static void gscon_fsm_wait_mdcx_bts_ho(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + + switch (event) { + case GSCON_EV_MGW_MDCX_RESP_BTS: + /* The MGW has confirmed the handover MDCX, and the handover + * is now also done on the RTP side. We may now change back + * to the active state. */ + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + break; + case GSCON_EV_MO_DTAP: + forward_dtap((struct msgb *)data, conn, fi); + break; + case GSCON_EV_MT_DTAP: + submit_dtap(conn, (struct msgb *)data, fi); + break; + case GSCON_EV_TX_SCCP: + sigtran_send(conn, (struct msgb *)data, fi); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +#define EV_TRANSPARENT_SCCP S(GSCON_EV_TX_SCCP) | S(GSCON_EV_MO_DTAP) | S(GSCON_EV_MT_DTAP) + +static const struct osmo_fsm_state gscon_fsm_states[] = { + [ST_INIT] = { + .name = OSMO_STRINGIFY(INIT), + .in_event_mask = S(GSCON_EV_A_CONN_REQ) | S(GSCON_EV_A_CONN_IND), + .out_state_mask = S(ST_WAIT_CC), + .action = gscon_fsm_init, + }, + [ST_WAIT_CC] = { + .name = OSMO_STRINGIFY(WAIT_CC), + .in_event_mask = S(GSCON_EV_A_CONN_CFM), + .out_state_mask = S(ST_ACTIVE), + .action = gscon_fsm_wait_cc, + }, + [ST_ACTIVE] = { + .name = OSMO_STRINGIFY(ACTIVE), + .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_A_ASSIGNMENT_CMD) | S(GSCON_EV_A_HO_REQ) | + S(GSCON_EV_HO_START), + .out_state_mask = S(ST_CLEARING) | S(ST_WAIT_CRCX_BTS) | S(ST_WAIT_ASS_CMPL) | + S(ST_WAIT_MODE_MODIFY_ACK) | S(ST_WAIT_MO_HO_CMD) | S(ST_WAIT_HO_COMPL), + .action = gscon_fsm_active, + }, + [ST_WAIT_CRCX_BTS] = { + .name = OSMO_STRINGIFY(WAIT_CRCX_BTS), + .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_MGW_CRCX_RESP_BTS), + .out_state_mask = S(ST_ACTIVE) | S(ST_WAIT_ASS_CMPL), + .action = gscon_fsm_wait_crcx_bts, + }, + [ST_WAIT_ASS_CMPL] = { + .name = OSMO_STRINGIFY(WAIT_ASS_CMPL), + .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_RR_ASS_COMPL) | S(GSCON_EV_RR_ASS_FAIL), + .out_state_mask = S(ST_ACTIVE) | S(ST_WAIT_MDCX_BTS), + .action = gscon_fsm_wait_ass_cmpl, + }, + [ST_WAIT_MDCX_BTS] = { + .name = OSMO_STRINGIFY(WAIT_MDCX_BTS), + .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_MGW_MDCX_RESP_BTS), + .out_state_mask = S(ST_ACTIVE) | S(ST_WAIT_CRCX_MSC), + .action = gscon_fsm_wait_mdcx_bts, + }, + [ST_WAIT_CRCX_MSC] = { + .name = OSMO_STRINGIFY(WAIT_CRCX_MSC), + .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_MGW_CRCX_RESP_MSC), + .out_state_mask = S(ST_ACTIVE), + .action = gscon_fsm_wait_crcx_msc, + }, + [ST_WAIT_MODE_MODIFY_ACK] = { + .name = OSMO_STRINGIFY(WAIT_MODE_MODIFY_ACK), + .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_RR_MODE_MODIFY_ACK), + .out_state_mask = S(ST_ACTIVE) | S(ST_CLEARING), + .action = gscon_fsm_wait_mode_modify_ack, + }, + [ST_CLEARING] = { + .name = OSMO_STRINGIFY(CLEARING), + .in_event_mask = S(GSCON_EV_RSL_CLEAR_COMPL), + .action = gscon_fsm_clearing, + }, + + /* TODO: external handover, probably it makes sense to break up the + * program flow in handover_logic.c a bit and handle some of the logic + * here? */ + [ST_WAIT_MT_HO_ACC] = { + .name = OSMO_STRINGIFY(WAIT_MT_HO_ACC), + }, + [ST_WAIT_MT_HO_COMPL] = { + .name = OSMO_STRINGIFY(WAIT_MT_HO_COMPL), + }, + [ST_WAIT_MO_HO_CMD] = { + .name = OSMO_STRINGIFY(WAIT_MO_HO_CMD), + }, + [ST_MO_HO_PROCEEDING] = { + .name = OSMO_STRINGIFY(MO_HO_PROCEEDING), + }, + + /* Internal handover */ + [ST_WAIT_HO_COMPL] = { + .name = OSMO_STRINGIFY(WAIT_HO_COMPL), + .in_event_mask = S(GSCON_EV_HO_COMPL) | S(GSCON_EV_HO_FAIL) | S(GSCON_EV_HO_TIMEOUT), + .out_state_mask = S(ST_ACTIVE) | S(ST_WAIT_MDCX_BTS_HO), + .action = gscon_fsm_wait_ho_compl, + }, + [ST_WAIT_MDCX_BTS_HO] = { + .name = OSMO_STRINGIFY(WAIT_MDCX_BTS_HO), + .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_MGW_MDCX_RESP_BTS), + .action = gscon_fsm_wait_mdcx_bts_ho, + .out_state_mask = S(ST_ACTIVE), + }, +}; + +static void gscon_fsm_allstate(struct osmo_fsm_inst *fi, uint32_t event, void *data) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct msgb *resp = NULL; + + /* When a connection on the MGW fails, make sure that the reference + * in our book-keeping is erased. */ + switch (event) { + case GSCON_EV_MGW_FAIL_BTS: + conn->user_plane.fi_bts = NULL; + break; + case GSCON_EV_MGW_FAIL_MSC: + conn->user_plane.fi_msc = NULL; + break; + } + + /* Regular allstate event processing */ + switch (event) { + case GSCON_EV_MGW_FAIL_BTS: + case GSCON_EV_MGW_FAIL_MSC: + /* Note: An MGW connection die per definition at any time. + * However, if it dies during the assignment we must return + * with an assignment failure */ + OSMO_ASSERT(fi->state != ST_INIT && fi->state != ST_WAIT_CC) + if (fi->state == ST_WAIT_CRCX_BTS || fi->state == ST_WAIT_ASS_CMPL || fi->state == ST_WAIT_MDCX_BTS + || fi->state == ST_WAIT_CRCX_MSC) { + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + } + break; + case GSCON_EV_A_CLEAR_CMD: + /* MSC tells us to cleanly shut down */ + osmo_fsm_inst_state_chg(fi, ST_CLEARING, 0, 0); + gsm0808_clear(conn); + /* FIXME: Release all terestrial resources in ST_CLEARING */ + /* According to 3GPP 48.008 3.1.9.1. "The BSS need not wait for the radio channel + * release to be completed or for the guard timer to expire before returning the + * CLEAR COMPLETE message" */ + + /* Close MGCP connections */ + toss_mgcp_conn(conn, fi); + + /* FIXME: Question: Is this a hack to force a clear complete from internel? + * nobody seems to send the event from outside? */ + osmo_fsm_inst_dispatch(conn->fi, GSCON_EV_RSL_CLEAR_COMPL, NULL); + break; + case GSCON_EV_A_DISC_IND: + /* MSC or SIGTRAN network has hard-released SCCP connection, + * terminate the FSM now. */ + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, data); + break; + case GSCON_EV_RLL_REL_IND: + /* BTS reports that one of the LAPDm data links was released */ + /* send proper clear request to MSC */ + LOGPFSML(fi, LOGL_DEBUG, "Tx BSSMAP CLEAR REQUEST to MSC\n"); + resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_RADIO_INTERFACE_MESSAGE_FAILURE); + sigtran_send(conn, resp, fi); + break; + case GSCON_EV_RSL_CONN_FAIL: + LOGPFSML(fi, LOGL_DEBUG, "Tx BSSMAP CLEAR REQUEST to MSC\n"); + resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_RADIO_INTERFACE_FAILURE); + sigtran_send(conn, resp, fi); + break; + default: + OSMO_ASSERT(false); + break; + } +} + +void ho_dtap_cache_flush(struct gsm_subscriber_connection *conn, int send); + +static void gscon_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause) +{ + struct gsm_subscriber_connection *conn = fi->priv; + + if (conn->ho) { + LOGPFSML(fi, LOGL_DEBUG, "Releasing handover state\n"); + bsc_clear_handover(conn, 1); + conn->ho = NULL; + } + + if (conn->secondary_lchan) { + LOGPFSML(fi, LOGL_DEBUG, "Releasing secondary_lchan\n"); + lchan_release(conn->secondary_lchan, 0, RSL_REL_LOCAL_END); + conn->secondary_lchan = NULL; + } + if (conn->lchan) { + LOGPFSML(fi, LOGL_DEBUG, "Releasing lchan\n"); + lchan_release(conn->lchan, 0, RSL_REL_LOCAL_END); + conn->lchan = NULL; + } + + if (conn->bsub) { + LOGPFSML(fi, LOGL_DEBUG, "Putting bsc_subscr\n"); + bsc_subscr_put(conn->bsub); + conn->bsub = NULL; + } + + if (conn->sccp.state != SUBSCR_SCCP_ST_NONE) { + LOGPFSML(fi, LOGL_DEBUG, "Disconnecting SCCP\n"); + struct bsc_msc_data *msc = conn->sccp.msc; + /* FIXME: include a proper cause value / error message? */ + osmo_sccp_tx_disconn(msc->a.sccp_user, conn->sccp.conn_id, &msc->a.bsc_addr, 0); + conn->sccp.state = SUBSCR_SCCP_ST_NONE; + } + + /* drop pending messages */ + ho_dtap_cache_flush(conn, 0); + + penalty_timers_free(&conn->hodec2.penalty_timers); + + llist_del(&conn->entry); + talloc_free(conn); + fi->priv = NULL; +} + +static void gscon_pre_term(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause) +{ + struct gsm_subscriber_connection *conn = fi->priv; + + /* Make sure all possibly still open MGCP connections get closed */ + toss_mgcp_conn(conn, fi); +} + +static int gscon_timer_cb(struct osmo_fsm_inst *fi) +{ + struct gsm_subscriber_connection *conn = fi->priv; + struct msgb *resp = NULL; + + switch (fi->T) { + case 993210: + /* MSC has not responded/confirmed connection witH CC */ + /* N-DISCONNET.req is sent in gscon_cleanup() above */ + osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); + break; + case GSM0808_T10_TIMER_NR: /* Assignment Failed */ + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_RADIO_INTERFACE_FAILURE, NULL); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + break; + case MGCP_MGW_TIMEOUT_TIMER_NR: /* Assignment failed (no response from MGW) */ + resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); + sigtran_send(conn, resp, fi); + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + break; + case MGCP_MGW_HO_TIMEOUT_TIMER_NR: /* Handover failed (no response from MGW) */ + osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); + break; + default: + OSMO_ASSERT(false); + } + return 0; +} + +static struct osmo_fsm gscon_fsm = { + .name = "SUBSCR_CONN", + .states = gscon_fsm_states, + .num_states = ARRAY_SIZE(gscon_fsm_states), + .allstate_event_mask = S(GSCON_EV_A_DISC_IND) | S(GSCON_EV_A_CLEAR_CMD) | S(GSCON_EV_RSL_CONN_FAIL) | + S(GSCON_EV_RLL_REL_IND) | S(GSCON_EV_MGW_FAIL_BTS) | S(GSCON_EV_MGW_FAIL_MSC), + .allstate_action = gscon_fsm_allstate, + .cleanup = gscon_cleanup, + .pre_term = gscon_pre_term, + .timer_cb = gscon_timer_cb, + .log_subsys = DMSC, + .event_names = gscon_fsm_event_names, +}; + +/* Allocate a subscriber connection and its associated FSM */ +struct gsm_subscriber_connection *bsc_subscr_con_allocate(struct gsm_network *net) +{ + struct gsm_subscriber_connection *conn; + static bool g_initialized = false; + + if (!g_initialized) { + osmo_fsm_register(&gscon_fsm); + g_initialized = true; + } + + conn = talloc_zero(net, struct gsm_subscriber_connection); + if (!conn) + return NULL; + + conn->network = net; + INIT_LLIST_HEAD(&conn->ho_dtap_cache); + /* BTW, penalty timers will be initialized on-demand. */ + conn->sccp.conn_id = -1; + + /* don't allocate from 'conn' context, as gscon_cleanup() will call talloc_free(conn) before + * libosmocore will call talloc_free(conn->fi), i.e. avoid use-after-free during cleanup */ + conn->fi = osmo_fsm_inst_alloc(&gscon_fsm, net, conn, LOGL_NOTICE, NULL); + if (!conn->fi) { + talloc_free(conn); + return NULL; + } + + llist_add_tail(&conn->entry, &net->subscr_conns); + return conn; +} diff --git a/src/osmo-bsc/Makefile.am b/src/osmo-bsc/Makefile.am index 422546acb..cc9674396 100644 --- a/src/osmo-bsc/Makefile.am +++ b/src/osmo-bsc/Makefile.am @@ -26,7 +26,6 @@ bin_PROGRAMS = \ $(NULL) osmo_bsc_SOURCES = \ - bsc_subscr_conn_fsm.c \ osmo_bsc_main.c \ osmo_bsc_vty.c \ osmo_bsc_api.c \ diff --git a/src/osmo-bsc/bsc_subscr_conn_fsm.c b/src/osmo-bsc/bsc_subscr_conn_fsm.c deleted file mode 100644 index 569921342..000000000 --- a/src/osmo-bsc/bsc_subscr_conn_fsm.c +++ /dev/null @@ -1,1054 +0,0 @@ -/* (C) 2017 by Harald Welte - * All Rights Reserved - * - * 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 . - * - */ - -#include -#include -#include -#include -#include - -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -#define S(x) (1 << (x)) - -#define MGCP_MGW_TIMEOUT 4 /* in seconds */ -#define MGCP_MGW_TIMEOUT_TIMER_NR 1 - -#define MGCP_MGW_HO_TIMEOUT 4 /* in seconds */ -#define MGCP_MGW_HO_TIMEOUT_TIMER_NR 2 - -#define GSM0808_T10_TIMER_NR 10 -#define GSM0808_T10_VALUE 6 - -#define ENDPOINT_ID "rtpbridge/*@mgw" - -enum gscon_fsm_states { - ST_INIT, - /* waiting for CC from MSC */ - ST_WAIT_CC, - /* active connection */ - ST_ACTIVE, - /* during assignment; waiting for ASS_CMPL */ - ST_WAIT_ASS_CMPL, - /* during assignment; waiting for MODE_MODIFY_ACK */ - ST_WAIT_MODE_MODIFY_ACK, - /* BSSMAP CLEAR has been received */ - ST_CLEARING, - -/* MGW handling */ - /* during assignment; waiting for MGW response to CRCX for BTS */ - ST_WAIT_CRCX_BTS, - /* during assignment; waiting for MGW response to MDCX for BTS */ - ST_WAIT_MDCX_BTS, - /* during assignment; waiting for MGW response to CRCX for MSC */ - ST_WAIT_CRCX_MSC, - -/* MT (inbound) handover */ - /* Wait for Handover Access from MS/BTS */ - ST_WAIT_MT_HO_ACC, - /* Wait for RR Handover Complete from MS/BTS */ - ST_WAIT_MT_HO_COMPL, - -/* MO (outbound) handover */ - /* Wait for Handover Command / Handover Required Reject from MSC */ - ST_WAIT_MO_HO_CMD, - /* Wait for Clear Command from MSC */ - ST_MO_HO_PROCEEDING, - -/* Internal HO handling */ - /* Wait for the handover logic to complete the handover */ - ST_WAIT_HO_COMPL, - /* during handover; waiting for MGW response to MDCX for BTS */ - ST_WAIT_MDCX_BTS_HO, -}; - -static const struct value_string gscon_fsm_event_names[] = { - {GSCON_EV_A_CONN_IND, "MT-CONNECT.ind"}, - {GSCON_EV_A_CONN_REQ, "MO-CONNECT.req"}, - {GSCON_EV_A_CONN_CFM, "MO-CONNECT.cfm"}, - {GSCON_EV_A_ASSIGNMENT_CMD, "ASSIGNMENT_CMD"}, - {GSCON_EV_A_CLEAR_CMD, "CLEAR_CMD"}, - {GSCON_EV_A_DISC_IND, "DISCONNET.ind"}, - {GSCON_EV_A_HO_REQ, "HANDOVER_REQUEST"}, - - {GSCON_EV_RR_ASS_COMPL, "RR_ASSIGN_COMPL"}, - {GSCON_EV_RR_ASS_FAIL, "RR_ASSIGN_FAIL"}, - {GSCON_EV_RR_MODE_MODIFY_ACK, "RR_MODE_MODIFY_ACK"}, - {GSCON_EV_RR_HO_ACC, "RR_HO_ACCESS"}, - {GSCON_EV_RR_HO_COMPL, "RR_HO_COMPLETE"}, - {GSCON_EV_RLL_REL_IND, "RLL_RELEASE.ind"}, - {GSCON_EV_RSL_CONN_FAIL, "RSL_CONN_FAIL.ind"}, - {GSCON_EV_RSL_CLEAR_COMPL, "RSL_CLEAR_COMPLETE"}, - - {GSCON_EV_MO_DTAP, "MO-DTAP"}, - {GSCON_EV_MT_DTAP, "MT-DTAP"}, - {GSCON_EV_TX_SCCP, "TX_SCCP"}, - - {GSCON_EV_MGW_FAIL_BTS, "MGW_FAILURE_BTS"}, - {GSCON_EV_MGW_FAIL_MSC, "MGW_FAILURE_MSC"}, - {GSCON_EV_MGW_CRCX_RESP_BTS, "MGW_CRCX_RESPONSE_BTS"}, - {GSCON_EV_MGW_MDCX_RESP_BTS, "MGW_MDCX_RESPONSE_BTS"}, - {GSCON_EV_MGW_CRCX_RESP_MSC, "MGW_CRCX_RESPONSE_MSC"}, - - {GSCON_EV_HO_START, "HO_START"}, - {GSCON_EV_HO_TIMEOUT, "HO_TIMEOUT"}, - {GSCON_EV_HO_FAIL, "HO_FAIL"}, - {GSCON_EV_HO_COMPL, "HO_COMPL"}, - - {0, NULL} -}; - -/* Send data SCCP message through SCCP connection. All sigtran messages - * that are send from this FSM must use this function. Never use - * osmo_bsc_sigtran_send() directly since this would defeat the checks - * provided by this function. */ -static void sigtran_send(struct gsm_subscriber_connection *conn, struct msgb *msg, struct osmo_fsm_inst *fi) -{ - int rc; - - /* Make sure that we only attempt to send SCCP messages if we have - * a life SCCP connection. Otherwise drop the message. */ - if (fi->state == ST_INIT || fi->state == ST_WAIT_CC) { - LOGPFSML(fi, LOGL_ERROR, "No active SCCP connection, dropping message!\n"); - msgb_free(msg); - return; - } - - rc = osmo_bsc_sigtran_send(conn, msg); - if (rc < 0) - LOGPFSML(fi, LOGL_ERROR, "Unable to deliver SCCP message!\n"); -} - -/* Generate and send assignment complete message */ -static void send_ass_compl(struct gsm_lchan *lchan, struct osmo_fsm_inst *fi) -{ - struct msgb *resp; - struct gsm0808_speech_codec sc; - struct gsm_subscriber_connection *conn; - - conn = lchan->conn; - - OSMO_ASSERT(lchan->abis_ip.ass_compl.valid); - OSMO_ASSERT(conn); - - LOGPFSML(fi, LOGL_DEBUG, "Sending assignment complete message... (id=%i)\n", conn->sccp.conn_id); - - /* Extrapolate speech codec from speech mode */ - gsm0808_speech_codec_from_chan_type(&sc, lchan->abis_ip.ass_compl.speech_mode); - - /* Generate message */ - resp = gsm0808_create_ass_compl(lchan->abis_ip.ass_compl.rr_cause, - lchan->abis_ip.ass_compl.chosen_channel, - lchan->abis_ip.ass_compl.encr_alg_id, - lchan->abis_ip.ass_compl.speech_mode, - &conn->user_plane.aoip_rtp_addr_local, &sc, NULL); - - if (!resp) { - LOGPFSML(fi, LOGL_ERROR, "Failed to generate assignment completed message! (id=%i)\n", - conn->sccp.conn_id); - } - - sigtran_send(conn, resp, fi); -} - -/* forward MT DTAP from BSSAP side to RSL side */ -static void submit_dtap(struct gsm_subscriber_connection *conn, struct msgb *msg, struct osmo_fsm_inst *fi) -{ - int rc; - struct msgb *resp = NULL; - - OSMO_ASSERT(fi); - OSMO_ASSERT(msg); - OSMO_ASSERT(conn); - - rc = gsm0808_submit_dtap(conn, msg, OBSC_LINKID_CB(msg), 1); - if (rc != 0) { - LOGPFSML(fi, LOGL_ERROR, "Tx BSSMAP CLEAR REQUEST to MSC\n"); - resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_EQUIPMENT_FAILURE); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - return; - } -} - -/* forward MO DTAP from RSL side to BSSAP side */ -/* FIXME: move fi parameter to the beginning */ -static void forward_dtap(struct msgb *msg, struct gsm_subscriber_connection *conn, struct osmo_fsm_inst *fi) -{ - struct msgb *resp = NULL; - - OSMO_ASSERT(msg); - OSMO_ASSERT(conn); - - resp = gsm0808_create_dtap(msg, OBSC_LINKID_CB(msg)); - sigtran_send(conn, resp, fi); -} - -/* In case there are open MGCP connections, toss - * those connections */ -static void toss_mgcp_conn(struct gsm_subscriber_connection *conn, struct osmo_fsm_inst *fi) -{ - LOGPFSML(fi, LOGL_ERROR, "tossing all MGCP connections...\n"); - - if (conn->user_plane.fi_bts) { - mgcp_conn_delete(conn->user_plane.fi_bts); - conn->user_plane.fi_bts = NULL; - } - - if (conn->user_plane.fi_msc) { - mgcp_conn_delete(conn->user_plane.fi_msc); - conn->user_plane.fi_msc = NULL; - } - - if (conn->user_plane.mgw_endpoint) { - talloc_free(conn->user_plane.mgw_endpoint); - conn->user_plane.mgw_endpoint = NULL; - } -} - -static void gscon_fsm_init(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct osmo_scu_prim *scu_prim = NULL; - struct msgb *msg = NULL; - int rc; - - switch (event) { - case GSCON_EV_A_CONN_REQ: - /* RLL ESTABLISH IND with initial L3 Message */ - msg = data; - /* FIXME: Extract Mobile ID and update FSM using osmo_fsm_inst_set_id() */ - rc = osmo_bsc_sigtran_open_conn(conn, msg); - if (rc < 0) { - osmo_fsm_inst_term(fi, OSMO_FSM_TERM_ERROR, NULL); - } else { - /* SCCP T(conn est) is 1-2 minutes, way too long. The MS will timeout - * using T3210 (20s), T3220 (5s) or T3230 (10s) */ - osmo_fsm_inst_state_chg(fi, ST_WAIT_CC, 20, 993210); - } - break; - case GSCON_EV_A_CONN_IND: - scu_prim = data; - if (!conn->sccp.msc) { - LOGPFSML(fi, LOGL_NOTICE, "N-CONNECT.ind from unknown MSC %s\n", - osmo_sccp_addr_dump(&scu_prim->u.connect.calling_addr)); - osmo_sccp_tx_disconn(conn->sccp.msc->a.sccp_user, scu_prim->u.connect.conn_id, - &scu_prim->u.connect.called_addr, 0); - osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); - } - /* FIXME: Extract optional IMSI and update FSM using osmo_fsm_inst_set_id() */ - LOGPFSML(fi, LOGL_NOTICE, "No support for MSC-originated SCCP Connections yet\n"); - osmo_sccp_tx_disconn(conn->sccp.msc->a.sccp_user, scu_prim->u.connect.conn_id, - &scu_prim->u.connect.called_addr, 0); - osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -/* We've sent the CONNECTION.req to the SCCP provider and are waiting for CC from MSC */ -static void gscon_fsm_wait_cc(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - switch (event) { - case GSCON_EV_A_CONN_CFM: - /* MSC has confirmed the connection, we now change into the - * active state and wait there for further operations */ - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - /* if there's user payload, forward it just like EV_MT_DTAP */ - /* FIXME: Question: if there's user payload attached to the CC, forward it like EV_MT_DTAP? */ - break; - default: - OSMO_ASSERT(false); - break; - } -} - -/* We're on an active subscriber connection, passing DTAP back and forth */ -static void gscon_fsm_active(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct msgb *resp = NULL; - struct mgcp_conn_peer conn_peer; - int rc; - - switch (event) { - case GSCON_EV_A_ASSIGNMENT_CMD: - /* MSC requests us to perform assignment, this code section is - * triggered via signal GSCON_EV_A_ASSIGNMENT_CMD from - * bssmap_handle_assignm_req() in osmo_bsc_bssap.c, which does - * the parsing of incoming assignment requests. */ - - LOGPFSML(fi, LOGL_NOTICE, "Channel assignment: chan_mode=%s, full_rate=%i\n", - get_value_string(gsm48_chan_mode_names, conn->user_plane.chan_mode), - conn->user_plane.full_rate); - - /* FIXME: We need to check if current channel is sufficient. If - * yes, do MODIFY. If not, do assignment (see commented lines below) */ - - /* FIXME: At the moment, the FSM is constructed in an - * unfortunate way. In case of a voice channel assignment - * we first go through a couple of MGCP related states, - * then reach the state where the actual channel assignment - * happens and then again we perform some MGCP related - * actions and eventually end up in ST_ACTIVE again. This - * should be restructured */ - - switch (conn->user_plane.chan_mode) { - case GSM48_CMODE_SPEECH_V1: - case GSM48_CMODE_SPEECH_EFR: - case GSM48_CMODE_SPEECH_AMR: - /* A voice channel is requested, so we run down the - * mgcp-ass-mgcp state-chain (see FIXME above) */ - memset(&conn_peer, 0, sizeof(conn_peer)); - conn_peer.call_id = conn->sccp.conn_id; - osmo_strlcpy(conn_peer.endpoint, ENDPOINT_ID, sizeof(conn_peer.endpoint)); - - /* (Pre)Change state and create the connection */ - osmo_fsm_inst_state_chg(fi, ST_WAIT_CRCX_BTS, MGCP_MGW_TIMEOUT, MGCP_MGW_TIMEOUT_TIMER_NR); - conn->user_plane.fi_bts = - mgcp_conn_create(conn->network->mgw.client, fi, GSCON_EV_MGW_FAIL_BTS, - GSCON_EV_MGW_CRCX_RESP_BTS, &conn_peer); - if (!conn->user_plane.fi_bts) { - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - return; - } - break; - case GSM48_CMODE_SIGN: - /* A signalling channel is requested, so we perform the - * channel assignment directly without performing any - * MGCP actions. ST_WAIT_ASS_CMPL will see by the - * conn->user_plane.chan_mode parameter that this - * assignment is for a signalling channel and will then - * change back to ST_ACTIVE (here) immediately. */ - rc = gsm0808_assign_req(conn, conn->user_plane.full_rate, conn->user_plane.chan_mode); - if (rc != 0) { - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); - sigtran_send(conn, resp, fi); - return; - } - - osmo_fsm_inst_state_chg(fi, ST_WAIT_ASS_CMPL, GSM0808_T10_VALUE, GSM0808_T10_TIMER_NR); - break; - default: - /* An unsupported channel is requested, so we have to - * reject this request by sending an assignment failure - * message immediately */ - LOGPFSML(fi, LOGL_ERROR, "Requested channel mode is not supported!\n", - get_value_string(gsm48_chan_mode_names, conn->user_plane.chan_mode), - conn->user_plane.full_rate); - - /* The requested channel mode is not supported */ - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_REQ_CODEC_TYPE_OR_CONFIG_NOT_SUPP, NULL); - sigtran_send(conn, resp, fi); - break; - } - break; - case GSCON_EV_HO_START: - rc = bsc_handover_start_gscon(conn); - if (rc) { - resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_EQUIPMENT_FAILURE); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_CLEARING, 0, 0); - return; - } - - /* Note: No timeout is set here, T3103 in handover_logic.c - * will generate a GSCON_EV_HO_TIMEOUT event should the - * handover time out, so we do not need another timeout - * here (maybe its worth to think about giving GSCON - * more power over the actual handover process). */ - osmo_fsm_inst_state_chg(fi, ST_WAIT_HO_COMPL, 0, 0); - break; - case GSCON_EV_A_HO_REQ: - /* FIXME: reject any handover requests with HO FAIL until implemented */ - break; - case GSCON_EV_MO_DTAP: - forward_dtap((struct msgb *)data, conn, fi); - break; - case GSCON_EV_MT_DTAP: - submit_dtap(conn, (struct msgb *)data, fi); - break; - case GSCON_EV_TX_SCCP: - sigtran_send(conn, (struct msgb *)data, fi); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -/* Before we may start the channel assignment we need to get an IP/Port for the - * RTP connection from the MGW */ -static void gscon_fsm_wait_crcx_bts(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct mgcp_conn_peer *conn_peer = NULL; - struct msgb *resp = NULL; - int rc; - - switch (event) { - case GSCON_EV_MGW_CRCX_RESP_BTS: - conn_peer = data; - - /* Check if the MGW has assigned an enpoint to us, we can not - * proceed */ - if (strlen(conn_peer->endpoint) <= 0) { - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - return; - } - - /* Memorize the endpoint name we got assigned from the MGW. - * When the BTS sided connection is done, we need to create - * a second connection on that same endpoint, so we need - * to know its ID */ - if (!conn->user_plane.mgw_endpoint) - conn->user_plane.mgw_endpoint = talloc_zero_size(conn, MGCP_ENDPOINT_MAXLEN); - OSMO_ASSERT(conn->user_plane.mgw_endpoint); - osmo_strlcpy(conn->user_plane.mgw_endpoint, conn_peer->endpoint, MGCP_ENDPOINT_MAXLEN); - - /* Store the IP-Address and the port the MGW assigned to us, - * then start the channel assignment. */ - conn->user_plane.rtp_port = conn_peer->port; - conn->user_plane.rtp_ip = osmo_ntohl(inet_addr(conn_peer->addr)); - rc = gsm0808_assign_req(conn, conn->user_plane.full_rate, conn->user_plane.chan_mode); - if (rc != 0) { - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_RQSTED_SPEECH_VERSION_UNAVAILABLE, NULL); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - return; - } - - osmo_fsm_inst_state_chg(fi, ST_WAIT_ASS_CMPL, GSM0808_T10_VALUE, GSM0808_T10_TIMER_NR); - break; - case GSCON_EV_MO_DTAP: - forward_dtap((struct msgb *)data, conn, fi); - break; - case GSCON_EV_MT_DTAP: - submit_dtap(conn, (struct msgb *)data, fi); - break; - case GSCON_EV_TX_SCCP: - sigtran_send(conn, (struct msgb *)data, fi); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -/* We're waiting for an ASSIGNMENT COMPLETE from MS */ -static void gscon_fsm_wait_ass_cmpl(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct gsm_lchan *lchan = conn->lchan; - struct mgcp_conn_peer conn_peer; - struct in_addr addr; - struct msgb *resp = NULL; - int rc; - - switch (event) { - case GSCON_EV_RR_ASS_COMPL: - switch (conn->user_plane.chan_mode) { - case GSM48_CMODE_SPEECH_V1: - case GSM48_CMODE_SPEECH_EFR: - case GSM48_CMODE_SPEECH_AMR: - /* FIXME: What if we are using SCCP-Lite? */ - - /* We are dealing with a voice channel, so we can not - * confirm the assignment directly. We must first do - * some final steps on the MGCP side. */ - - /* Prepare parameters with the information we got during the assignment */ - memset(&conn_peer, 0, sizeof(conn_peer)); - addr.s_addr = osmo_ntohl(lchan->abis_ip.bound_ip); - osmo_strlcpy(conn_peer.addr, inet_ntoa(addr), sizeof(conn_peer.addr)); - conn_peer.port = lchan->abis_ip.bound_port; - - /* (Pre)Change state and modify the connection */ - osmo_fsm_inst_state_chg(fi, ST_WAIT_MDCX_BTS, MGCP_MGW_TIMEOUT, MGCP_MGW_TIMEOUT_TIMER_NR); - rc = mgcp_conn_modify(conn->user_plane.fi_bts, GSCON_EV_MGW_MDCX_RESP_BTS, &conn_peer); - if (rc != 0) { - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - return; - } - break; - case GSM48_CMODE_SIGN: - /* Confirm the successful assignment on BSSMAP and - * change back into active state */ - send_ass_compl(lchan, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - break; - default: - /* Unsupported modes should have been already filtered - * by gscon_fsm_active(). If we reach the default - * section here anyway than some unsupported mode must - * have made it into the FSM, this would be a bug, so - * we fire an assertion here */ - OSMO_ASSERT(false); - break; - } - - break; - case GSCON_EV_RR_ASS_FAIL: - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_RQSTED_TERRESTRIAL_RESOURCE_UNAVAILABLE, NULL); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - break; - case GSCON_EV_MO_DTAP: - forward_dtap((struct msgb *)data, conn, fi); - break; - case GSCON_EV_MT_DTAP: - submit_dtap(conn, (struct msgb *)data, fi); - break; - case GSCON_EV_TX_SCCP: - sigtran_send(conn, (struct msgb *)data, fi); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -/* We are waiting for the MGW response to the MDCX */ -static void gscon_fsm_wait_mdcx_bts(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct mgcp_conn_peer conn_peer; - struct sockaddr_in *sin = NULL; - struct msgb *resp = NULL; - - switch (event) { - case GSCON_EV_MGW_MDCX_RESP_BTS: - - /* Prepare parameters with the connection information we got - * with the assignment command */ - memset(&conn_peer, 0, sizeof(conn_peer)); - conn_peer.call_id = conn->sccp.conn_id; - sin = (struct sockaddr_in *)&conn->user_plane.aoip_rtp_addr_remote; - conn_peer.port = osmo_ntohs(sin->sin_port); - osmo_strlcpy(conn_peer.addr, inet_ntoa(sin->sin_addr), sizeof(conn_peer.addr)); - - /* Make sure we use the same endpoint where we created the - * BTS connection. */ - osmo_strlcpy(conn_peer.endpoint, conn->user_plane.mgw_endpoint, sizeof(conn_peer.endpoint)); - - /* (Pre)Change state and create the connection */ - osmo_fsm_inst_state_chg(fi, ST_WAIT_CRCX_MSC, MGCP_MGW_TIMEOUT, MGCP_MGW_TIMEOUT_TIMER_NR); - conn->user_plane.fi_msc = - mgcp_conn_create(conn->network->mgw.client, fi, GSCON_EV_MGW_FAIL_MSC, GSCON_EV_MGW_CRCX_RESP_MSC, - &conn_peer); - if (!conn->user_plane.fi_bts) { - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - return; - } - - break; - case GSCON_EV_MO_DTAP: - forward_dtap((struct msgb *)data, conn, fi); - break; - case GSCON_EV_MT_DTAP: - submit_dtap(conn, (struct msgb *)data, fi); - break; - case GSCON_EV_TX_SCCP: - sigtran_send(conn, (struct msgb *)data, fi); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -static void gscon_fsm_wait_crcx_msc(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct mgcp_conn_peer *conn_peer = NULL; - struct gsm_lchan *lchan = conn->lchan; - struct sockaddr_in *sin = NULL; - - switch (event) { - case GSCON_EV_MGW_CRCX_RESP_MSC: - conn_peer = data; - - /* Store address information we got in response from the CRCX command. */ - sin = (struct sockaddr_in *)&conn->user_plane.aoip_rtp_addr_local; - sin->sin_family = AF_INET; - sin->sin_addr.s_addr = inet_addr(conn_peer->addr); - sin->sin_port = osmo_ntohs(conn_peer->port); - - /* Send assignment complete message to the MSC */ - send_ass_compl(lchan, fi); - - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - - break; - case GSCON_EV_MO_DTAP: - forward_dtap((struct msgb *)data, conn, fi); - break; - case GSCON_EV_MT_DTAP: - submit_dtap(conn, (struct msgb *)data, fi); - break; - case GSCON_EV_TX_SCCP: - sigtran_send(conn, (struct msgb *)data, fi); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -/* We're waiting for a MODE MODIFY ACK from MS + BTS */ -static void gscon_fsm_wait_mode_modify_ack(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct gsm_lchan *lchan = conn->lchan; - - switch (event) { - case GSCON_EV_RR_MODE_MODIFY_ACK: - /* we assume that not only have we received the RR MODE_MODIFY_ACK, but - * actually that also the BTS side of the channel mode has been changed accordingly */ - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - - /* FIXME: Check if this requires special handling. For now I assume that the send_ass_compl() - * can be used. But I am not sure. */ - send_ass_compl(lchan, fi); - - break; - /* FIXME: Do we need to handle DTAP traffic in this state? Maybe yes? Needs to be checked. */ - case GSCON_EV_MO_DTAP: - forward_dtap((struct msgb *)data, conn, fi); - break; - case GSCON_EV_MT_DTAP: - submit_dtap(conn, (struct msgb *)data, fi); - break; - case GSCON_EV_TX_SCCP: - sigtran_send(conn, (struct msgb *)data, fi); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -static void gscon_fsm_clearing(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct msgb *resp; - - switch (event) { - case GSCON_EV_RSL_CLEAR_COMPL: - resp = gsm0808_create_clear_complete(); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, data); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -/* Wait for the handover logic to tell us whether the handover completed, - * failed or has timed out */ -static void gscon_fsm_wait_ho_compl(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct mgcp_conn_peer conn_peer; - struct gsm_lchan *lchan = conn->lchan; - struct in_addr addr; - struct msgb *resp; - int rc; - - switch (event) { - case GSCON_EV_HO_COMPL: - /* The handover logic informs us that the handover has been - * completet. Now we have to tell the MGW the IP/Port on the - * new BTS so that the uplink RTP traffic can be redirected - * there. */ - - /* Prepare parameters with the information we got during the - * handover procedure (via IPACC) */ - memset(&conn_peer, 0, sizeof(conn_peer)); - addr.s_addr = osmo_ntohl(lchan->abis_ip.bound_ip); - osmo_strlcpy(conn_peer.addr, inet_ntoa(addr), sizeof(conn_peer.addr)); - conn_peer.port = lchan->abis_ip.bound_port; - - /* (Pre)Change state and modify the connection */ - osmo_fsm_inst_state_chg(fi, ST_WAIT_MDCX_BTS_HO, MGCP_MGW_TIMEOUT, MGCP_MGW_TIMEOUT_TIMER_NR); - rc = mgcp_conn_modify(conn->user_plane.fi_bts, GSCON_EV_MGW_MDCX_RESP_BTS, &conn_peer); - if (rc != 0) { - resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_EQUIPMENT_FAILURE); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_CLEARING, 0, 0); - return; - } - break; - - osmo_fsm_inst_state_chg(fi, ST_WAIT_MT_HO_COMPL, MGCP_MGW_HO_TIMEOUT, MGCP_MGW_HO_TIMEOUT_TIMER_NR); - break; - - case GSCON_EV_HO_TIMEOUT: - case GSCON_EV_HO_FAIL: - /* The handover logic informs us that the handover failed for - * some reason. This means the phone stays on the TS/BTS on - * which it currently is. We will change back to the active - * state again as there are no further operations needed */ - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -/* Wait for the MGW to confirm handover related modification of the connection - * parameters */ -static void gscon_fsm_wait_mdcx_bts_ho(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - - switch (event) { - case GSCON_EV_MGW_MDCX_RESP_BTS: - /* The MGW has confirmed the handover MDCX, and the handover - * is now also done on the RTP side. We may now change back - * to the active state. */ - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - break; - case GSCON_EV_MO_DTAP: - forward_dtap((struct msgb *)data, conn, fi); - break; - case GSCON_EV_MT_DTAP: - submit_dtap(conn, (struct msgb *)data, fi); - break; - case GSCON_EV_TX_SCCP: - sigtran_send(conn, (struct msgb *)data, fi); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -#define EV_TRANSPARENT_SCCP S(GSCON_EV_TX_SCCP) | S(GSCON_EV_MO_DTAP) | S(GSCON_EV_MT_DTAP) - -static const struct osmo_fsm_state gscon_fsm_states[] = { - [ST_INIT] = { - .name = OSMO_STRINGIFY(INIT), - .in_event_mask = S(GSCON_EV_A_CONN_REQ) | S(GSCON_EV_A_CONN_IND), - .out_state_mask = S(ST_WAIT_CC), - .action = gscon_fsm_init, - }, - [ST_WAIT_CC] = { - .name = OSMO_STRINGIFY(WAIT_CC), - .in_event_mask = S(GSCON_EV_A_CONN_CFM), - .out_state_mask = S(ST_ACTIVE), - .action = gscon_fsm_wait_cc, - }, - [ST_ACTIVE] = { - .name = OSMO_STRINGIFY(ACTIVE), - .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_A_ASSIGNMENT_CMD) | S(GSCON_EV_A_HO_REQ) | - S(GSCON_EV_HO_START), - .out_state_mask = S(ST_CLEARING) | S(ST_WAIT_CRCX_BTS) | S(ST_WAIT_ASS_CMPL) | - S(ST_WAIT_MODE_MODIFY_ACK) | S(ST_WAIT_MO_HO_CMD) | S(ST_WAIT_HO_COMPL), - .action = gscon_fsm_active, - }, - [ST_WAIT_CRCX_BTS] = { - .name = OSMO_STRINGIFY(WAIT_CRCX_BTS), - .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_MGW_CRCX_RESP_BTS), - .out_state_mask = S(ST_ACTIVE) | S(ST_WAIT_ASS_CMPL), - .action = gscon_fsm_wait_crcx_bts, - }, - [ST_WAIT_ASS_CMPL] = { - .name = OSMO_STRINGIFY(WAIT_ASS_CMPL), - .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_RR_ASS_COMPL) | S(GSCON_EV_RR_ASS_FAIL), - .out_state_mask = S(ST_ACTIVE) | S(ST_WAIT_MDCX_BTS), - .action = gscon_fsm_wait_ass_cmpl, - }, - [ST_WAIT_MDCX_BTS] = { - .name = OSMO_STRINGIFY(WAIT_MDCX_BTS), - .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_MGW_MDCX_RESP_BTS), - .out_state_mask = S(ST_ACTIVE) | S(ST_WAIT_CRCX_MSC), - .action = gscon_fsm_wait_mdcx_bts, - }, - [ST_WAIT_CRCX_MSC] = { - .name = OSMO_STRINGIFY(WAIT_CRCX_MSC), - .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_MGW_CRCX_RESP_MSC), - .out_state_mask = S(ST_ACTIVE), - .action = gscon_fsm_wait_crcx_msc, - }, - [ST_WAIT_MODE_MODIFY_ACK] = { - .name = OSMO_STRINGIFY(WAIT_MODE_MODIFY_ACK), - .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_RR_MODE_MODIFY_ACK), - .out_state_mask = S(ST_ACTIVE) | S(ST_CLEARING), - .action = gscon_fsm_wait_mode_modify_ack, - }, - [ST_CLEARING] = { - .name = OSMO_STRINGIFY(CLEARING), - .in_event_mask = S(GSCON_EV_RSL_CLEAR_COMPL), - .action = gscon_fsm_clearing, - }, - - /* TODO: external handover, probably it makes sense to break up the - * program flow in handover_logic.c a bit and handle some of the logic - * here? */ - [ST_WAIT_MT_HO_ACC] = { - .name = OSMO_STRINGIFY(WAIT_MT_HO_ACC), - }, - [ST_WAIT_MT_HO_COMPL] = { - .name = OSMO_STRINGIFY(WAIT_MT_HO_COMPL), - }, - [ST_WAIT_MO_HO_CMD] = { - .name = OSMO_STRINGIFY(WAIT_MO_HO_CMD), - }, - [ST_MO_HO_PROCEEDING] = { - .name = OSMO_STRINGIFY(MO_HO_PROCEEDING), - }, - - /* Internal handover */ - [ST_WAIT_HO_COMPL] = { - .name = OSMO_STRINGIFY(WAIT_HO_COMPL), - .in_event_mask = S(GSCON_EV_HO_COMPL) | S(GSCON_EV_HO_FAIL) | S(GSCON_EV_HO_TIMEOUT), - .out_state_mask = S(ST_ACTIVE) | S(ST_WAIT_MDCX_BTS_HO), - .action = gscon_fsm_wait_ho_compl, - }, - [ST_WAIT_MDCX_BTS_HO] = { - .name = OSMO_STRINGIFY(WAIT_MDCX_BTS_HO), - .in_event_mask = EV_TRANSPARENT_SCCP | S(GSCON_EV_MGW_MDCX_RESP_BTS), - .action = gscon_fsm_wait_mdcx_bts_ho, - .out_state_mask = S(ST_ACTIVE), - }, -}; - -static void gscon_fsm_allstate(struct osmo_fsm_inst *fi, uint32_t event, void *data) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct msgb *resp = NULL; - - /* When a connection on the MGW fails, make sure that the reference - * in our book-keeping is erased. */ - switch (event) { - case GSCON_EV_MGW_FAIL_BTS: - conn->user_plane.fi_bts = NULL; - break; - case GSCON_EV_MGW_FAIL_MSC: - conn->user_plane.fi_msc = NULL; - break; - } - - /* Regular allstate event processing */ - switch (event) { - case GSCON_EV_MGW_FAIL_BTS: - case GSCON_EV_MGW_FAIL_MSC: - /* Note: An MGW connection die per definition at any time. - * However, if it dies during the assignment we must return - * with an assignment failure */ - OSMO_ASSERT(fi->state != ST_INIT && fi->state != ST_WAIT_CC) - if (fi->state == ST_WAIT_CRCX_BTS || fi->state == ST_WAIT_ASS_CMPL || fi->state == ST_WAIT_MDCX_BTS - || fi->state == ST_WAIT_CRCX_MSC) { - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - } - break; - case GSCON_EV_A_CLEAR_CMD: - /* MSC tells us to cleanly shut down */ - osmo_fsm_inst_state_chg(fi, ST_CLEARING, 0, 0); - gsm0808_clear(conn); - /* FIXME: Release all terestrial resources in ST_CLEARING */ - /* According to 3GPP 48.008 3.1.9.1. "The BSS need not wait for the radio channel - * release to be completed or for the guard timer to expire before returning the - * CLEAR COMPLETE message" */ - - /* Close MGCP connections */ - toss_mgcp_conn(conn, fi); - - /* FIXME: Question: Is this a hack to force a clear complete from internel? - * nobody seems to send the event from outside? */ - osmo_fsm_inst_dispatch(conn->fi, GSCON_EV_RSL_CLEAR_COMPL, NULL); - break; - case GSCON_EV_A_DISC_IND: - /* MSC or SIGTRAN network has hard-released SCCP connection, - * terminate the FSM now. */ - osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, data); - break; - case GSCON_EV_RLL_REL_IND: - /* BTS reports that one of the LAPDm data links was released */ - /* send proper clear request to MSC */ - LOGPFSML(fi, LOGL_DEBUG, "Tx BSSMAP CLEAR REQUEST to MSC\n"); - resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_RADIO_INTERFACE_MESSAGE_FAILURE); - sigtran_send(conn, resp, fi); - break; - case GSCON_EV_RSL_CONN_FAIL: - LOGPFSML(fi, LOGL_DEBUG, "Tx BSSMAP CLEAR REQUEST to MSC\n"); - resp = gsm0808_create_clear_rqst(GSM0808_CAUSE_RADIO_INTERFACE_FAILURE); - sigtran_send(conn, resp, fi); - break; - default: - OSMO_ASSERT(false); - break; - } -} - -void ho_dtap_cache_flush(struct gsm_subscriber_connection *conn, int send); - -static void gscon_cleanup(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause) -{ - struct gsm_subscriber_connection *conn = fi->priv; - - if (conn->ho) { - LOGPFSML(fi, LOGL_DEBUG, "Releasing handover state\n"); - bsc_clear_handover(conn, 1); - conn->ho = NULL; - } - - if (conn->secondary_lchan) { - LOGPFSML(fi, LOGL_DEBUG, "Releasing secondary_lchan\n"); - lchan_release(conn->secondary_lchan, 0, RSL_REL_LOCAL_END); - conn->secondary_lchan = NULL; - } - if (conn->lchan) { - LOGPFSML(fi, LOGL_DEBUG, "Releasing lchan\n"); - lchan_release(conn->lchan, 0, RSL_REL_LOCAL_END); - conn->lchan = NULL; - } - - if (conn->bsub) { - LOGPFSML(fi, LOGL_DEBUG, "Putting bsc_subscr\n"); - bsc_subscr_put(conn->bsub); - conn->bsub = NULL; - } - - if (conn->sccp.state != SUBSCR_SCCP_ST_NONE) { - LOGPFSML(fi, LOGL_DEBUG, "Disconnecting SCCP\n"); - struct bsc_msc_data *msc = conn->sccp.msc; - /* FIXME: include a proper cause value / error message? */ - osmo_sccp_tx_disconn(msc->a.sccp_user, conn->sccp.conn_id, &msc->a.bsc_addr, 0); - conn->sccp.state = SUBSCR_SCCP_ST_NONE; - } - - /* drop pending messages */ - ho_dtap_cache_flush(conn, 0); - - penalty_timers_free(&conn->hodec2.penalty_timers); - - llist_del(&conn->entry); - talloc_free(conn); - fi->priv = NULL; -} - -static void gscon_pre_term(struct osmo_fsm_inst *fi, enum osmo_fsm_term_cause cause) -{ - struct gsm_subscriber_connection *conn = fi->priv; - - /* Make sure all possibly still open MGCP connections get closed */ - toss_mgcp_conn(conn, fi); -} - -static int gscon_timer_cb(struct osmo_fsm_inst *fi) -{ - struct gsm_subscriber_connection *conn = fi->priv; - struct msgb *resp = NULL; - - switch (fi->T) { - case 993210: - /* MSC has not responded/confirmed connection witH CC */ - /* N-DISCONNET.req is sent in gscon_cleanup() above */ - osmo_fsm_inst_term(fi, OSMO_FSM_TERM_REGULAR, NULL); - break; - case GSM0808_T10_TIMER_NR: /* Assignment Failed */ - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_RADIO_INTERFACE_FAILURE, NULL); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - break; - case MGCP_MGW_TIMEOUT_TIMER_NR: /* Assignment failed (no response from MGW) */ - resp = gsm0808_create_assignment_failure(GSM0808_CAUSE_EQUIPMENT_FAILURE, NULL); - sigtran_send(conn, resp, fi); - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - break; - case MGCP_MGW_HO_TIMEOUT_TIMER_NR: /* Handover failed (no response from MGW) */ - osmo_fsm_inst_state_chg(fi, ST_ACTIVE, 0, 0); - break; - default: - OSMO_ASSERT(false); - } - return 0; -} - -static struct osmo_fsm gscon_fsm = { - .name = "SUBSCR_CONN", - .states = gscon_fsm_states, - .num_states = ARRAY_SIZE(gscon_fsm_states), - .allstate_event_mask = S(GSCON_EV_A_DISC_IND) | S(GSCON_EV_A_CLEAR_CMD) | S(GSCON_EV_RSL_CONN_FAIL) | - S(GSCON_EV_RLL_REL_IND) | S(GSCON_EV_MGW_FAIL_BTS) | S(GSCON_EV_MGW_FAIL_MSC), - .allstate_action = gscon_fsm_allstate, - .cleanup = gscon_cleanup, - .pre_term = gscon_pre_term, - .timer_cb = gscon_timer_cb, - .log_subsys = DMSC, - .event_names = gscon_fsm_event_names, -}; - -/* Allocate a subscriber connection and its associated FSM */ -struct gsm_subscriber_connection *bsc_subscr_con_allocate(struct gsm_network *net) -{ - struct gsm_subscriber_connection *conn; - static bool g_initialized = false; - - if (!g_initialized) { - osmo_fsm_register(&gscon_fsm); - g_initialized = true; - } - - conn = talloc_zero(net, struct gsm_subscriber_connection); - if (!conn) - return NULL; - - conn->network = net; - INIT_LLIST_HEAD(&conn->ho_dtap_cache); - /* BTW, penalty timers will be initialized on-demand. */ - conn->sccp.conn_id = -1; - - /* don't allocate from 'conn' context, as gscon_cleanup() will call talloc_free(conn) before - * libosmocore will call talloc_free(conn->fi), i.e. avoid use-after-free during cleanup */ - conn->fi = osmo_fsm_inst_alloc(&gscon_fsm, net, conn, LOGL_NOTICE, NULL); - if (!conn->fi) { - talloc_free(conn); - return NULL; - } - - llist_add_tail(&conn->entry, &net->subscr_conns); - return conn; -} diff --git a/tests/handover/Makefile.am b/tests/handover/Makefile.am index 7133fcddc..e2e1f0a00 100644 --- a/tests/handover/Makefile.am +++ b/tests/handover/Makefile.am @@ -9,6 +9,8 @@ AM_CFLAGS = \ $(LIBOSMOCORE_CFLAGS) \ $(LIBOSMOGSM_CFLAGS) \ $(LIBOSMOABIS_CFLAGS) \ + $(LIBOSMOSIGTRAN_CFLAGS) \ + $(LIBOSMOMGCPCLIENT_CFLAGS) \ $(NULL) AM_LDFLAGS = \ @@ -36,4 +38,6 @@ handover_test_LDADD = \ $(LIBOSMOCORE_LIBS) \ $(LIBOSMOGSM_LIBS) \ $(LIBOSMOABIS_LIBS) \ + $(LIBOSMOSIGTRAN_LIBS) \ + $(LIBOSMOMGCPCLIENT_LIBS) \ $(NULL) diff --git a/tests/handover/handover_test.c b/tests/handover/handover_test.c index bf7350c62..7a2e9645d 100644 --- a/tests/handover/handover_test.c +++ b/tests/handover/handover_test.c @@ -186,7 +186,8 @@ static struct gsm_bts *create_bts(int arfcn) void create_conn(struct gsm_lchan *lchan) { - lchan->conn = bsc_subscr_con_allocate(lchan); + lchan->conn = bsc_subscr_con_allocate(lchan->ts->trx->bts->network); + lchan->conn->lchan = lchan; } /* create lchan */ @@ -1592,7 +1593,7 @@ int main(int argc, char **argv) struct gsm_subscriber_connection *conn = lchan[i]->conn; lchan[i]->conn = NULL; conn->lchan = NULL; - bsc_subscr_con_free(conn); + osmo_fsm_inst_term(conn->fi, OSMO_FSM_TERM_REGULAR, NULL); lchan_free(lchan[i]); } -- cgit v1.2.1