Add SGs Interface

Add an SGs interface (3GPP TS 29.118) to osmo-msc in order to support
SMS tunneling and Circuit Switched Fallback (CSFB)

Change-Id: I73359925fc1ca72b33a1466e6ac41307f2f0b11d
Related: OS#3615
This commit is contained in:
Harald Welte 2018-12-03 11:00:04 +01:00 committed by Philipp Maier
parent c7de62cc53
commit 0df904dea9
48 changed files with 2939 additions and 22 deletions

View File

@ -23,11 +23,15 @@ noinst_HEADERS = \
a_reset.h \
ran_conn.h \
rrlp.h \
sgs_iface.h \
sgs_server.h \
sgs_vty.h \
signal.h \
silent_call.h \
smpp.h \
sms_queue.h \
transaction.h \
vlr.h \
vlr_sgs.h \
vty.h \
$(NULL)

View File

@ -21,5 +21,6 @@ enum {
DVLR,
DIUCS,
DBSSAP,
DSGS,
Debug_LastEntry,
};

View File

@ -77,5 +77,6 @@ int gsm48_multirate_config(uint8_t *lv, const struct amr_multirate_conf *mr, con
int gsm48_tch_rtp_create(struct gsm_trans *trans);
int gsm48_conn_sendmsg(struct msgb *msg, struct ran_conn *conn, struct gsm_trans *trans);
struct msgb *gsm48_create_mm_info(struct gsm_network *net);
#endif

View File

@ -5,6 +5,7 @@
#include <osmocom/core/linuxlist.h>
#include <osmocom/gsm/protocol/gsm_23_003.h>
#include <osmocom/gsm/protocol/gsm_29_118.h>
#include <osmocom/msc/gsm_data.h>
@ -36,8 +37,8 @@ struct subscr_request {
*/
struct subscr_request *subscr_request_conn(struct vlr_subscr *vsub,
gsm_cbfn *cbfn, void *param,
const char *label);
const char *label,
enum sgsap_service_ind serv_ind);
void subscr_remove_request(struct subscr_request *req);
void subscr_paging_cancel(struct vlr_subscr *vsub, enum gsm_paging_event event);

View File

@ -208,6 +208,7 @@ bool ran_conn_in_release(struct ran_conn *conn);
void ran_conn_rx_bssmap_clear_complete(struct ran_conn *conn);
void ran_conn_rx_iu_release_complete(struct ran_conn *conn);
void ran_conn_sgs_release_sent(struct ran_conn *conn);
enum ran_conn_use {
RAN_CONN_USE_UNTRACKED = -1,

View File

@ -0,0 +1,87 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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/>.
*
*/
#pragma once
#include <osmocom/gsm/protocol/gsm_23_003.h>
#include <osmocom/gsm/protocol/gsm_29_118.h>
#include <osmocom/msc/vlr.h>
#include <osmocom/msc/vlr_sgs.h>
#include <osmocom/core/socket.h>
static const unsigned int sgs_state_timer_defaults[_NUM_SGS_STATE_TIMERS] = {
[SGS_STATE_TS5] = SGS_TS5_DEFAULT,
[SGS_STATE_TS6_2] = SGS_TS6_2_DEFAULT,
[SGS_STATE_TS7] = SGS_TS7_DEFAULT,
[SGS_STATE_TS11] = SGS_TS11_DEFAULT,
[SGS_STATE_TS14] = SGS_TS14_DEFAULT,
[SGS_STATE_TS15] = SGS_TS15_DEFAULT,
};
static const unsigned int sgs_state_counter_defaults[_NUM_SGS_STATE_COUNTERS] = {
[SGS_STATE_NS7] = SGS_NS7_DEFAULT,
[SGS_STATE_NS11] = SGS_NS11_DEFAULT,
};
struct sgs_connection {
/* global list of SGs connections */
struct llist_head entry;
/* back-pointer */
struct sgs_state *sgs;
/* Socket name from osmo_sock_get_name() */
char sockname[OSMO_SOCK_NAME_MAXLEN];
/* MME for this connection, if any. This field is NULL until we
* receive the first "MME name" IE from the MME, which could be part
* of the RESET procedure, but also just a normal LU request. */
struct sgs_mme_ctx *mme;
/* represents the SCTP connection we accept()ed from this MME */
struct osmo_stream_srv *srv;
};
struct sgs_mme_ctx {
/* global list of MME contexts */
struct llist_head entry;
/* back-pointer */
struct sgs_state *sgs;
/* MME name as string representation */
char fqdn[GSM23003_MME_DOMAIN_LEN + 1];
/* current connection for this MME, if any. Can be NULL if the SCTP
* connection to the MME was lost and hasn't been re-established yet */
struct sgs_connection *conn;
/* FSM for the "VLR reset" procedure" */
struct osmo_fsm_inst *fi;
unsigned int ns11_remaining;
};
extern struct sgs_state *g_sgs;
struct sgs_state *sgs_iface_init(void *ctx, struct gsm_network *network);
int sgs_iface_rx(struct sgs_connection *sgc, struct msgb *msg);
int sgs_iface_tx_paging(struct vlr_subscr *vsub, enum sgsap_service_ind serv_ind);
int sgs_iface_tx_dtap_ud(struct msgb *msg);
void sgs_iface_tx_release(struct ran_conn *conn);

View File

@ -0,0 +1,53 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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/>.
*
*/
#pragma once
#include <arpa/inet.h>
#include <osmocom/gsm/protocol/gsm_29_118.h>
#define DEFAULT_SGS_SERVER_IP "0.0.0.0"
#define DEFAULT_SGS_SERVER_VLR_NAME "vlr.example.net"
/* global SGs state */
struct sgs_state {
/* list of MMEs (sgs_mme_ctx) */
struct llist_head mme_list;
/* list of SCTP client connections */
struct llist_head conn_list;
/* SCTP server for inbound SGs connections */
struct osmo_stream_srv_link *srv_link;
struct {
char local_addr[INET6_ADDRSTRLEN];
uint16_t local_port;
/* user-configured VLR name (FQDN) */
char vlr_name[SGS_VLR_NAME_MAXLEN];
/* timers on VLR side */
unsigned int timer[_NUM_SGS_STATE_TIMERS];
/* countrs on VLR side */
unsigned int counter[_NUM_SGS_STATE_COUNTERS];
} cfg;
};
struct sgs_state *sgs_server_alloc(void *ctx);
int sgs_server_open(struct sgs_state *sgs);

View File

@ -0,0 +1,23 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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/>.
*
*/
#pragma once
void sgs_vty_init(void);

View File

@ -13,6 +13,7 @@
#include <osmocom/msc/ran_conn.h>
#include <osmocom/msc/msc_common.h>
#include <osmocom/gsupclient/gsup_client.h>
#include <osmocom/msc/vlr_sgs.h>
#define LOGGSUPP(level, gsup, fmt, args...) \
LOGP(DVLR, level, "GSUP(%s) " fmt, (gsup)->imsi, ## args)
@ -162,6 +163,7 @@ struct vlr_subscr {
struct osmo_fsm_inst *lu_fsm;
struct osmo_fsm_inst *auth_fsm;
struct osmo_fsm_inst *proc_arq_fsm;
struct osmo_fsm_inst *sgs_fsm;
bool lu_complete;
time_t expire_lu;
@ -182,6 +184,17 @@ struct vlr_subscr {
uint8_t lac;
enum osmo_rat_type attached_via_ran;
} cs;
/* SGs (MME) specific parts */
struct {
struct vlr_sgs_cfg cfg;
char mme_name[SGS_MME_NAME_LEN + 1];
struct osmo_location_area_id lai;
vlr_sgs_lu_response_cb_t response_cb;
vlr_sgs_lu_paging_cb_t paging_cb;
vlr_sgs_lu_mminfo_cb_t mminfo_cb;
enum sgsap_service_ind paging_serv_ind;
struct osmo_timer_list Ts5;
} sgs;
struct gsm_classmark classmark;
};

View File

@ -0,0 +1,107 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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/>.
*
*/
#pragma once
#include <osmocom/gsm/gsm29118.h>
enum vlr_lu_type;
struct vlr_subscr;
struct vlr_instance;
/* See also 3GPP TS 29.118, chapter 4.2.2 States at the VLR */
enum sgs_ue_fsm_state {
SGS_UE_ST_NULL,
SGS_UE_ST_ASSOCIATED,
SGS_UE_ST_LA_UPD_PRES,
};
enum vlr_sgs_state_tmr {
/* Started when sending the SGsAP-PAGING-REQUEST, implemented in vlr_sgs.c */
SGS_STATE_TS5,
/* TMSI reallocation, 5.2.3.5, implemented by fsm in vlr_sgs_fsm.c */
SGS_STATE_TS6_2,
/* Started when SGsAP-ALERT-REQUEST is sent 5.3.2.1, not implemented yet */
SGS_STATE_TS7,
/* Reset ack timeout, implemnted in sgs_iface.c */
SGS_STATE_TS11,
/* Started when SGsAP-SERVICE-REQUEST is received 5.15.1, not implemented yet */
SGS_STATE_TS14,
/* Started when SGsAP-MO-CSFB-INDICATION is received 5.16.3 (UE fallback, not implemented yet) */
SGS_STATE_TS15,
_NUM_SGS_STATE_TIMERS
};
enum vlr_sgs_state_ctr {
/* Alert request retransmit count */
SGS_STATE_NS7,
/* Reset repeat count */
SGS_STATE_NS11,
_NUM_SGS_STATE_COUNTERS
};
extern const struct value_string sgs_state_timer_names[];
static inline const char *vlr_sgs_state_timer_name(enum vlr_sgs_state_tmr Ts)
{
return get_value_string(sgs_state_timer_names, Ts);
}
extern const struct value_string sgs_state_counter_names[];
static inline const char *vlr_sgs_state_counter_name(enum vlr_sgs_state_ctr Ns)
{
return get_value_string(sgs_state_timer_names, Ns);
}
/* This callback function is called when an SGs location update is complete */
struct sgs_lu_response {
bool accepted;
struct vlr_subscr *vsub;
};
typedef void (*vlr_sgs_lu_response_cb_t) (struct sgs_lu_response *response);
/* This callback function is called in cases where a paging request is required
* after the LU is completed */
typedef int (*vlr_sgs_lu_paging_cb_t) (struct vlr_subscr *vsub, enum sgsap_service_ind serv_ind);
/* This callback function is called to send the MM info to the UE. */
typedef void (*vlr_sgs_lu_mminfo_cb_t) (struct vlr_subscr *vsub);
/* Configuration parameters for the SGs FSM */
struct vlr_sgs_cfg {
unsigned int timer[_NUM_SGS_STATE_TIMERS];
unsigned int counter[_NUM_SGS_STATE_COUNTERS];
};
void vlr_sgs_reset(struct vlr_instance *vlr);
int vlr_sgs_loc_update(struct vlr_instance *vlr, struct vlr_sgs_cfg *cfg,
vlr_sgs_lu_response_cb_t response_cb, vlr_sgs_lu_paging_cb_t paging_cb,
vlr_sgs_lu_mminfo_cb_t mminfo_cb, char *mme_name, enum vlr_lu_type type, const char *imsi,
struct osmo_location_area_id *new_lai);
void vlr_sgs_loc_update_acc_sent(struct vlr_subscr *vsub);
void vlr_sgs_loc_update_rej_sent(struct vlr_subscr *vsub);
void vlr_sgs_detach(struct vlr_instance *vlr, const char *imsi, bool eps);
void vlr_sgs_imsi_detach(struct vlr_instance *vlr, const char *imsi, enum sgsap_imsi_det_noneps_type type);
void vlr_sgs_eps_detach(struct vlr_instance *vlr, const char *imsi, enum sgsap_imsi_det_eps_type type);
void vlr_sgs_tmsi_reall_compl(struct vlr_instance *vlr, const char *imsi);
void vlr_sgs_pag_rej(struct vlr_instance *vlr, const char *imsi, enum sgsap_sgs_cause cause);
void vlr_sgs_pag_ack(struct vlr_instance *vlr, const char *imsi);
void vlr_sgs_ue_unr(struct vlr_instance *vlr, const char *imsi, enum sgsap_sgs_cause cause);
void vlr_sgs_pag(struct vlr_subscr *vsub, enum sgsap_service_ind serv_ind);
bool vlr_sgs_pag_pend(struct vlr_subscr *vsub);

View File

@ -23,6 +23,7 @@ enum bsc_vty_node {
SMPP_NODE,
SMPP_ESME_NODE,
HLR_NODE,
CFG_SGS_NODE,
};
int bsc_vty_init_extra(void);

View File

@ -17,6 +17,7 @@ AM_CFLAGS = \
$(LIBOSMOMGCPCLIENT_CFLAGS) \
$(LIBOSMOGSUPCLIENT_CFLAGS) \
$(LIBOSMORANAP_CFLAGS) \
$(LIBOSMONETIF_CFLAGS) \
$(NULL)
noinst_HEADERS = \
@ -52,6 +53,9 @@ libmsc_a_SOURCES = \
transaction.c \
osmo_msc.c \
ctrl_commands.c \
sgs_iface.c \
sgs_server.c \
sgs_vty.c \
$(NULL)
if BUILD_IU
libmsc_a_SOURCES += \

View File

@ -469,13 +469,12 @@ static uint8_t bcdify(uint8_t value)
return ret;
}
/* Section 9.2.15a */
int gsm48_tx_mm_info(struct ran_conn *conn)
/* Generate a message buffer that contains a valid MM info message,
* See also 3GPP TS 24.008, chapter 9.2.15a */
struct msgb *gsm48_create_mm_info(struct gsm_network *net)
{
struct msgb *msg = gsm48_msgb_alloc_name("GSM 04.08 MM INF");
struct gsm48_hdr *gh;
struct gsm_network *net = conn->network;
uint8_t *ptr8;
int name_len, name_pad;
@ -617,8 +616,18 @@ int gsm48_tx_mm_info(struct ran_conn *conn)
ptr8[2] = dst;
}
LOG_RAN_CONN(conn, LOGL_DEBUG, "Tx MM INFO\n");
return msg;
}
/* Section 9.2.15a */
int gsm48_tx_mm_info(struct ran_conn *conn)
{
struct gsm_network *net = conn->network;
struct msgb *msg;
msg = gsm48_create_mm_info(net);
LOG_RAN_CONN(conn, LOGL_DEBUG, "Tx MM INFO\n");
return gsm48_conn_sendmsg(msg, conn, NULL);
}

View File

@ -1969,7 +1969,8 @@ int mncc_tx_to_cc(struct gsm_network *net, int msg_type, void *arg)
vsub,
setup_trig_pag_evt,
trans,
"MNCC: establish call");
"MNCC: establish call",
SGSAP_SERV_IND_CS_CALL);
if (!trans->paging_request) {
LOGP(DCC, LOGL_ERROR, "Failed to allocate paging token.\n");
vlr_subscr_put(vsub);

View File

@ -193,7 +193,9 @@ static int gsm411_mmsms_est_req(struct gsm_trans *trans)
LOGP(DLSMS, LOGL_DEBUG, "Initiating Paging procedure "
"for %s due to MMSMS_EST_REQ\n", vlr_subscr_name(trans->vsub));
trans->paging_request = subscr_request_conn(trans->vsub,
paging_cb_mmsms_est_req, trans, "MT SMS");
paging_cb_mmsms_est_req,
trans, "MT SMS",
SGSAP_SERV_IND_SMS);
if (!trans->paging_request) {
LOGP(DLSMS, LOGL_ERROR, "Failed to initiate Paging "
"procedure for %s\n", vlr_subscr_name(trans->vsub));

View File

@ -343,7 +343,8 @@ static struct gsm_trans *establish_nc_ss_trans(struct gsm_network *net,
/* Trigger Paging Request */
trans->paging_request = subscr_request_conn(vsub,
&handle_paging_event, trans, "GSM 09.11 SS/USSD");
&handle_paging_event, trans, "GSM 09.11 SS/USSD",
SGSAP_SERV_IND_CS_CALL);
if (!trans->paging_request) {
LOGP(DMM, LOGL_ERROR, "Failed to allocate paging token\n");
trans_free(trans);

View File

@ -48,6 +48,7 @@
#include <osmocom/msc/vlr.h>
#include <osmocom/msc/msc_ifaces.h>
#include <osmocom/msc/a_iface.h>
#include <osmocom/msc/sgs_iface.h>
void subscr_paging_cancel(struct vlr_subscr *vsub, enum gsm_paging_event event)
{
@ -109,7 +110,9 @@ int subscr_paging_dispatch(unsigned int hooknum, unsigned int event,
return 0;
}
static int msc_paging_request(struct vlr_subscr *vsub)
/* Execute a paging on the currently active RAN. Returns the number of
* delivered paging requests or -EINVAL in case of failure. */
static int msc_paging_request(struct vlr_subscr *vsub, enum sgsap_service_ind serv_ind)
{
/* The subscriber was last seen in subscr->lac. Find out which
* BSCs/RNCs are responsible and send them a paging request via open
@ -122,6 +125,8 @@ static int msc_paging_request(struct vlr_subscr *vsub)
vsub->tmsi == GSM_RESERVED_TMSI?
NULL : &vsub->tmsi,
vsub->cgi.lai.lac);
case OSMO_RAT_EUTRAN_SGS:
return sgs_iface_tx_paging(vsub, serv_ind);
default:
break;
}
@ -142,10 +147,11 @@ static void paging_response_timer_cb(void *data)
* \param cbfn function to call when the conn is established.
* \param param caller defined param to pass to cbfn().
* \param label human readable label of the request kind used for logging.
* \param serv_ind sgsap service indicator (in case SGs interface is used to page).
*/
struct subscr_request *subscr_request_conn(struct vlr_subscr *vsub,
gsm_cbfn *cbfn, void *param,
const char *label)
const char *label, enum sgsap_service_ind serv_ind)
{
int rc;
struct subscr_request *request;
@ -155,7 +161,7 @@ struct subscr_request *subscr_request_conn(struct vlr_subscr *vsub,
if (!vsub->cs.is_paging) {
LOGP(DMM, LOGL_DEBUG, "Subscriber %s not paged yet, start paging.\n",
vlr_subscr_name(vsub));
rc = msc_paging_request(vsub);
rc = msc_paging_request(vsub, serv_ind);
if (rc <= 0) {
LOGP(DMM, LOGL_ERROR, "Subscriber %s paging failed: %d\n",
vlr_subscr_name(vsub), rc);

View File

@ -28,6 +28,7 @@
#include <osmocom/mgcp_client/mgcp_client.h>
#include <osmocom/msc/vlr.h>
#include <osmocom/msc/a_iface.h>
#include <osmocom/msc/sgs_iface.h>
#include <osmocom/msc/gsm_04_08.h>
#include <osmocom/msc/msc_mgcp.h>
@ -60,6 +61,10 @@ static int msc_tx(struct ran_conn *conn, struct msgb *msg)
msg->dst = conn->iu.ue_ctx;
return ranap_iu_tx(msg, 0);
case OSMO_RAT_EUTRAN_SGS:
msg->dst = conn;
return sgs_iface_tx_dtap_ud(msg);
default:
LOGP(DMSC, LOGL_ERROR,
"msc_tx(): conn->via_ran invalid (%d)\n",

View File

@ -56,6 +56,8 @@
#include <osmocom/msc/signal.h>
#include <osmocom/msc/mncc_int.h>
#include <osmocom/msc/rrlp.h>
#include <osmocom/msc/vlr_sgs.h>
#include <osmocom/msc/sgs_vty.h>
static struct gsm_network *gsmnet = NULL;
@ -565,7 +567,7 @@ static void vty_dump_one_conn(struct vty *vty, const struct ran_conn *conn)
{
vty_out(vty, "%08x %3s %5u %3u %08x %c /%1u %27s %22s%s",
conn->a.conn_id,
conn->via_ran == OSMO_RAT_UTRAN_IU ? "Iu" : "A",
osmo_rat_type_name(conn->via_ran),
conn->lac,
conn->use_count,
conn->use_tokens,
@ -729,6 +731,15 @@ static void subscr_dump_full_vty(struct vty *vty, struct vlr_subscr *vsub)
reqs += 1;
vty_out(vty, " Paging: %s paging for %d requests%s",
vsub->cs.is_paging ? "is" : "not", reqs, VTY_NEWLINE);
/* SGs related */
vty_out(vty, " SGs-state: %s%s",
osmo_fsm_inst_state_name(vsub->sgs_fsm), VTY_NEWLINE);
if (vsub->sgs.mme_name && strlen(vsub->sgs.mme_name))
vty_out(vty, " SGs-MME: %s%s", vsub->sgs.mme_name, VTY_NEWLINE);
else
vty_out(vty, " SGs-MME: (none)%s", VTY_NEWLINE);
vty_out(vty, " Use count: %u%s", vsub->use_count, VTY_NEWLINE);
/* Connection */
@ -1159,7 +1170,7 @@ DEFUN(subscriber_paging,
return CMD_WARNING;
}
req = subscr_request_conn(vsub, NULL, NULL, "manual Paging from VTY");
req = subscr_request_conn(vsub, NULL, NULL, "manual Paging from VTY", SGSAP_SERV_IND_CS_CALL);
if (req)
vty_out(vty, "%% paging subscriber%s", VTY_NEWLINE);
else
@ -1590,6 +1601,7 @@ void msc_vty_init(struct gsm_network *msc_network)
#ifdef BUILD_IU
ranap_iu_vty_init(MSC_NODE, &msc_network->iu.rab_assign_addr_enc);
#endif
sgs_vty_init();
osmo_fsm_vty_add_cmds();
osmo_signal_register_handler(SS_SCALL, scall_cbfn, NULL);

View File

@ -31,6 +31,7 @@
#include <osmocom/msc/transaction.h>
#include <osmocom/msc/signal.h>
#include <osmocom/msc/a_iface.h>
#include <osmocom/msc/sgs_iface.h>
#include <osmocom/msc/iucs.h>
#include "../../bscconfig.h"
@ -338,6 +339,13 @@ static void ran_conn_fsm_releasing_onenter(struct osmo_fsm_inst *fi, uint32_t pr
{
struct ran_conn *conn = fi->priv;
/* The SGs interface needs to access vsub struct members to send the
* release message, however the following release procedures will
* remove conn->vsub, so we need to send the release right now. */
if (conn->via_ran == OSMO_RAT_EUTRAN_SGS) {
sgs_iface_tx_release(conn);
}
/* Use count for either conn->a.waiting_for_clear_complete or
* conn->iu.waiting_for_release_complete. 'get' it early, so we don't deallocate after tearing
* down active transactions. Safeguard against double-get (though it shouldn't happen). */
@ -381,6 +389,12 @@ static void ran_conn_fsm_releasing_onenter(struct osmo_fsm_inst *fi, uint32_t pr
}
conn->iu.waiting_for_release_complete = true;
break;
case OSMO_RAT_EUTRAN_SGS:
/* Release message is already sent at the beginning of this
* functions (see above), but we still need to notify the
* conn that a release has been sent / is in progress. */
ran_conn_sgs_release_sent(conn);
break;
default:
LOGP(DMM, LOGL_ERROR, "%s: Unknown RAN type, cannot tx release/clear\n",
vlr_subscr_name(conn->vsub));
@ -667,6 +681,8 @@ struct ran_conn *ran_conn_alloc(struct gsm_network *network,
case OSMO_RAT_UTRAN_IU:
conn->log_subsys = DRANAP;
break;
case OSMO_RAT_EUTRAN_SGS:
conn->log_subsys = DSGS;
default:
conn->log_subsys = DMSC;
break;
@ -772,3 +788,11 @@ void ran_conn_rx_iu_release_complete(struct ran_conn *conn)
{
rx_close_complete(conn, "Iu Release Complete", &conn->iu.waiting_for_release_complete);
}
void ran_conn_sgs_release_sent(struct ran_conn *conn)
{
bool dummy_waiting_for_release_complete = true;
/* Note: In SGsAP there is no confirmation of a release. */
rx_close_complete(conn, "SGs Release Complete", &dummy_waiting_for_release_complete);
}

1265
src/libmsc/sgs_iface.c Normal file

File diff suppressed because it is too large Load Diff

187
src/libmsc/sgs_server.c Normal file
View File

@ -0,0 +1,187 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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 <osmocom/msc/sgs_iface.h>
#include <osmocom/msc/debug.h>
#include <osmocom/msc/sgs_server.h>
#include <osmocom/core/utils.h>
#include <osmocom/core/socket.h>
#include <osmocom/core/select.h>
#include <osmocom/netif/stream.h>
#include <netinet/sctp.h>
#define LOGSGC(sgc, lvl, fmt, args...) \
LOGP(DSGS, lvl, "%s: " fmt, (sgc)->sockname, ## args)
/* call-back when data arrives on SGs */
static int sgs_conn_readable_cb(struct osmo_stream_srv *conn)
{
struct osmo_fd *ofd = osmo_stream_srv_get_ofd(conn);
struct sgs_connection *sgc = osmo_stream_srv_get_data(conn);
struct msgb *msg = gsm29118_msgb_alloc();
struct sctp_sndrcvinfo sinfo;
int flags = 0;
int rc;
/* we cannot use osmo_stream_srv_recv() here, as we might get some out-of-band info from
* SCTP. FIXME: add something like osmo_stream_srv_recv_sctp() to libosmo-netif and use
* it here as well as in libosmo-sigtran */
rc = sctp_recvmsg(ofd->fd, msgb_data(msg), msgb_tailroom(msg), NULL, NULL, &sinfo, &flags);
if (rc < 0) {
osmo_stream_srv_destroy(conn);
rc = -EBADF;
goto out;
} else if (rc == 0) {
osmo_stream_srv_destroy(conn);
rc = -EBADF;
goto out;
} else {
msgb_put(msg, rc);
}
if (flags & MSG_NOTIFICATION) {
union sctp_notification *notif = (union sctp_notification *)msgb_data(msg);
switch (notif->sn_header.sn_type) {
case SCTP_SHUTDOWN_EVENT:
osmo_stream_srv_destroy(conn);
rc = -EBADF;
break;
case SCTP_ASSOC_CHANGE:
/* FIXME: do we have to notify the SGs code about this? */
break;
default:
break;
}
rc = 0;
goto out;
}
/* set l2 header, as that's what we use in SGs code */
msg->l2h = msgb_data(msg);
if (msgb_sctp_ppid(msg) != 0) {
LOGSGC(sgc, LOGL_NOTICE, "Ignoring SCTP PPID %ld (spec violation)\n", msgb_sctp_ppid(msg));
msgb_free(msg);
return 0;
}
/* handle message */
sgs_iface_rx(sgc, msg);
return 0;
out:
msgb_free(msg);
return rc;
}
/* call-back when new connection is closed ed on SGs */
static int sgs_conn_closed_cb(struct osmo_stream_srv *conn)
{
struct sgs_connection *sgc = osmo_stream_srv_get_data(conn);
LOGSGC(sgc, LOGL_NOTICE, "Connection lost\n");
if (sgc->mme) {
/* unlink ourselves from the MME context */
if (sgc->mme->conn == sgc)
sgc->mme->conn = NULL;
}
llist_del(&sgc->entry);
return 0;
}
/* call-back when new connection is accept() ed on SGs */
static int sgs_accept_cb(struct osmo_stream_srv_link *link, int fd)
{
struct sgs_state *sgs = osmo_stream_srv_link_get_data(link);
struct sgs_connection *sgc = talloc_zero(link, struct sgs_connection);
OSMO_ASSERT(sgc);
sgc->sgs = sgs;
osmo_sock_get_name_buf(sgc->sockname, sizeof(sgc->sockname), fd);
sgc->srv = osmo_stream_srv_create(sgc, link, fd, sgs_conn_readable_cb, sgs_conn_closed_cb, sgc);
if (!sgc->srv) {
talloc_free(sgc);
return -1;
}
LOGSGC(sgc, LOGL_INFO, "Accepted new SGs connection\n");
llist_add_tail(&sgc->entry, &sgs->conn_list);
return 0;
}
static struct sgs_state *sgs_state_alloc(void *ctx)
{
struct sgs_state *sgs = talloc_zero(ctx, struct sgs_state);
INIT_LLIST_HEAD(&sgs->mme_list);
INIT_LLIST_HEAD(&sgs->conn_list);
memcpy(sgs->cfg.timer, sgs_state_timer_defaults, sizeof(sgs->cfg.timer));
memcpy(sgs->cfg.counter, sgs_state_counter_defaults, sizeof(sgs->cfg.counter));
sgs->cfg.local_port = SGS_PORT_DEFAULT;
osmo_strlcpy(sgs->cfg.local_addr, DEFAULT_SGS_SERVER_IP, sizeof(sgs->cfg.local_addr));
osmo_strlcpy(sgs->cfg.vlr_name, DEFAULT_SGS_SERVER_VLR_NAME, sizeof(sgs->cfg.vlr_name));
return sgs;
}
/*! allocate SGs new sgs state
* \param[in] ctx talloc context
* \returns returns allocated sgs state, NULL in case of error. */
struct sgs_state *sgs_server_alloc(void *ctx)
{
struct sgs_state *sgs;
struct osmo_stream_srv_link *link;
sgs = sgs_state_alloc(ctx);
if (!sgs)
return NULL;
sgs->srv_link = link = osmo_stream_srv_link_create(ctx);
if (!sgs->srv_link)
return NULL;
osmo_stream_srv_link_set_nodelay(link, true);
osmo_stream_srv_link_set_addr(link, sgs->cfg.local_addr);
osmo_stream_srv_link_set_port(link, sgs->cfg.local_port);
osmo_stream_srv_link_set_proto(link, IPPROTO_SCTP);
osmo_stream_srv_link_set_data(link, sgs);
osmo_stream_srv_link_set_accept_cb(link, sgs_accept_cb);
return sgs;
}
/*! (re)open SGs interface (SCTP)
* \param[in] sgs associated sgs state
* \returns 0 in case of success, -EINVAL in case of error. */
int sgs_server_open(struct sgs_state *sgs)
{
int rc;
struct osmo_fd *ofd = osmo_stream_srv_link_get_ofd(sgs->srv_link);
rc = osmo_stream_srv_link_open(sgs->srv_link);
if (rc < 0) {
LOGP(DSGS, LOGL_ERROR, "SGs socket cannot be opened: %s\n", strerror(errno));
return -EINVAL;
}
LOGP(DSGS, LOGL_NOTICE, "SGs socket bound to %s\n", osmo_sock_get_name2(ofd->fd));
return 0;
}

197
src/libmsc/sgs_vty.c Normal file
View File

@ -0,0 +1,197 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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 <string.h>
#include <errno.h>
#include <osmocom/core/utils.h>
#include <osmocom/core/msgb.h>
#include <osmocom/msc/vty.h>
#include <osmocom/netif/stream.h>
#include <osmocom/msc/sgs_iface.h>
#include <osmocom/msc/sgs_server.h>
#include <osmocom/msc/debug.h>
#include <osmocom/gsm/tlv.h>
struct cmd_node cfg_sgs_node = {
CFG_SGS_NODE,
"%s(config-sgs)# ",
1
};
DEFUN(cfg_sgs, cfg_sgs_cmd,
"sgs",
"Configure the SGs interface\n")
{
vty->index = g_sgs;
vty->node = CFG_SGS_NODE;
return CMD_SUCCESS;
}
DEFUN(cfg_sgs_local_ip, cfg_sgs_local_ip_cmd,
"local-ip A.B.C.D",
"Set the Local IP Address of the SGs interface\n"
"Local IP Address of the SGs interface\n")
{
struct sgs_state *sgs = vty->index;
int rc;
osmo_strlcpy(sgs->cfg.local_addr, argv[0], sizeof(sgs->cfg.local_addr));
osmo_stream_srv_link_set_addr(sgs->srv_link, sgs->cfg.local_addr);
rc = sgs_server_open(sgs);
if (rc < 0) {
vty_out(vty, "%% SGs socket cannot be opened: %s%s", strerror(errno), VTY_NEWLINE);
return CMD_WARNING;
}
return CMD_SUCCESS;
}
DEFUN(cfg_sgs_local_port, cfg_sgs_local_port_cmd,
"local-port <0-65535>",
"Set the local SCTP port of the SGs interface\n"
"Local SCTP port of the SGs interface\n")
{
struct sgs_state *sgs = vty->index;
int rc;
sgs->cfg.local_port = atoi(argv[0]);
osmo_stream_srv_link_set_port(sgs->srv_link, sgs->cfg.local_port);
rc = sgs_server_open(sgs);
if (rc < 0) {
vty_out(vty, "%% SGs socket cannot be opened: %s%s", strerror(errno), VTY_NEWLINE);
return CMD_WARNING;
}
return CMD_SUCCESS;
}
DEFUN(cfg_sgs_vlr_name, cfg_sgs_vlr_name_cmd,
"vlr-name FQDN",
"Set the SGs VLR Name as per TS 29.118 9.4.22\n"
"Fully-Qualified Domain Name of this VLR\n")
{
struct sgs_state *sgs = vty->index;
osmo_strlcpy(sgs->cfg.vlr_name, argv[0], sizeof(sgs->cfg.vlr_name));
return CMD_SUCCESS;
}
DEFUN(cfg_sgs_timer, cfg_sgs_timer_cmd,
"timer (ts5|ts6-2|ts7|ts11|ts14|ts15) <1-120>",
"Configure SGs Timer\n"
"Paging procedure guard timer\n"
"TMSI reallocation guard timer\n"
"Non-EPS alert procedure guard timer\n"
"VLR reset guard timer\n"
"UE fallback prcoedure timer\n"
"MO UE fallback procedure guard timer\n"
"Time in seconds\n")
{
struct sgs_state *sgs = vty->index;
unsigned int i;
for (i = 0; i < ARRAY_SIZE(sgs->cfg.timer); i++) {
if (!strcasecmp(argv[0], vlr_sgs_state_timer_name(i))) {
sgs->cfg.timer[i] = atoi(argv[1]);
return CMD_SUCCESS;
}
}
return CMD_WARNING;
}
DEFUN(cfg_sgs_counter, cfg_sgs_counter_cmd,
"counter (ns7|ns11) <0-255>",
"Configure SGs Counter\n"
"Non-EPS alert request retry counter\n"
"VLR reset retry counter\n" "Counter value\n")
{
struct sgs_state *sgs = vty->index;
unsigned int i = 0;
for (i = 0; i < ARRAY_SIZE(sgs->cfg.counter); i++) {
if (!strcasecmp(argv[0], vlr_sgs_state_counter_name(i))) {
sgs->cfg.counter[i] = atoi(argv[1]);
return CMD_SUCCESS;
}
}
return CMD_WARNING;
}
DEFUN(show_sgs_conn, show_sgs_conn_cmd,
"show sgs-connections", SHOW_STR
"Show SGs interface connections / MMEs\n")
{
struct sgs_connection *sgc;
llist_for_each_entry(sgc, &g_sgs->conn_list, entry) {
vty_out(vty, " %s %s%s", sgc->sockname, sgc->mme ? sgc->mme->fqdn : "", VTY_NEWLINE);
}
return CMD_SUCCESS;
}
static int config_write_sgs(struct vty *vty)
{
struct sgs_state *sgs = g_sgs;
unsigned int i;
char str_buf[256];
vty_out(vty, "sgs%s", VTY_NEWLINE);
if (sgs->cfg.local_port != SGS_PORT_DEFAULT)
vty_out(vty, " local-port %u%s", sgs->cfg.local_port, VTY_NEWLINE);
if (sgs->cfg.local_addr)
vty_out(vty, " local-ip %s%s", sgs->cfg.local_addr, VTY_NEWLINE);
if (sgs->cfg.vlr_name)
vty_out(vty, " vlr-name %s%s", sgs->cfg.vlr_name, VTY_NEWLINE);
for (i = 0; i < ARRAY_SIZE(sgs->cfg.timer); i++) {
if (sgs->cfg.timer[i] == sgs_state_timer_defaults[i])
continue;
osmo_str_tolower_buf(str_buf, sizeof(str_buf), vlr_sgs_state_timer_name(i));
vty_out(vty, " timer %s %u%s", str_buf, sgs->cfg.timer[i], VTY_NEWLINE);
}
for (i = 0; i < ARRAY_SIZE(sgs->cfg.counter); i++) {
if (sgs->cfg.counter[i] == sgs_state_counter_defaults[i])
continue;
osmo_str_tolower_buf(str_buf, sizeof(str_buf), vlr_sgs_state_counter_name(i));
vty_out(vty, " counter %s %u%s", str_buf, sgs->cfg.counter[i], VTY_NEWLINE);
}
return CMD_SUCCESS;
}
void sgs_vty_init(void)
{
/* configuration commands / nodes */
install_element(CONFIG_NODE, &cfg_sgs_cmd);
install_node(&cfg_sgs_node, config_write_sgs);
install_element(CFG_SGS_NODE, &cfg_sgs_local_ip_cmd);
install_element(CFG_SGS_NODE, &cfg_sgs_local_port_cmd);
install_element(CFG_SGS_NODE, &cfg_sgs_timer_cmd);
install_element(CFG_SGS_NODE, &cfg_sgs_counter_cmd);
install_element(CFG_SGS_NODE, &cfg_sgs_vlr_name_cmd);
install_element_ve(&show_sgs_conn_cmd);
}

View File

@ -128,7 +128,8 @@ int gsm_silent_call_start(struct vlr_subscr *vsub, void *data, int type)
* This doesn't apply to the situation after MSCSPLIT with an
* A-interface. */
req = subscr_request_conn(vsub, paging_cb_silent, data,
"establish silent call");
"establish silent call",
SGSAP_SERV_IND_CS_CALL);
if (!req)
return -ENODEV;
return 0;

View File

@ -8,6 +8,7 @@ AM_CFLAGS= \
$(LIBOSMOGSUPCLIENT_CFLAGS) \
$(LIBOSMOABIS_CFLAGS) \
$(LIBOSMORANAP_CFLAGS) \
$(LIBOSMOGSM_CFLAGS) \
$(COVERAGE_CFLAGS) \
$(NULL)
@ -16,6 +17,7 @@ noinst_HEADERS = \
vlr_auth_fsm.h \
vlr_core.h \
vlr_lu_fsm.h \
vlr_sgs_fsm.h \
$(NULL)
noinst_LIBRARIES = libvlr.a
@ -25,4 +27,6 @@ libvlr_a_SOURCES = \
vlr_access_req_fsm.c \
vlr_auth_fsm.c \
vlr_lu_fsm.c \
vlr_sgs.c \
vlr_sgs_fsm.c \
$(NULL)

View File

@ -30,6 +30,7 @@
#include <osmocom/gsm/ipa.h>
#include <osmocom/msc/gsm_subscriber.h>
#include <osmocom/gsupclient/gsup_client.h>
#include <osmocom/msc/vlr_sgs.h>
#include <osmocom/msc/vlr.h>
#include <osmocom/msc/debug.h>
@ -42,6 +43,7 @@
#include "vlr_auth_fsm.h"
#include "vlr_lu_fsm.h"
#include "vlr_access_req_fsm.h"
#include "vlr_sgs_fsm.h"
#define SGSN_SUBSCR_MAX_RETRIES 3
#define SGSN_SUBSCR_RETRY_INTERVAL 10
@ -262,6 +264,11 @@ static struct vlr_subscr *_vlr_subscr_alloc(struct vlr_instance *vlr)
INIT_LLIST_HEAD(&vsub->cs.requests);
INIT_LLIST_HEAD(&vsub->ps.pdp_list);
/* Create an SGs FSM, which is needed to control CSFB,
* in cases where CSFB/SGs is not in use, this FSM will
* just do nothing. (see also: sgs_iface.c) */
vlr_sgs_fsm_create(vsub);
llist_add_tail(&vsub->list, &vlr->subscribers);
return vsub;
}
@ -307,6 +314,13 @@ void vlr_subscr_free(struct vlr_subscr *vsub)
{
llist_del(&vsub->list);
DEBUGP(DREF, "freeing VLR subscr %s\n", vlr_subscr_name(vsub));
/* Make sure SGs timer Ts5 is removed */
osmo_timer_del(&vsub->sgs.Ts5);
/* Remove SGs FSM (see also: sgs_iface.c) */
vlr_sgs_fsm_remove(vsub);
talloc_free(vsub);
}
@ -854,7 +868,13 @@ static int vlr_subscr_handle_isd_req(struct vlr_subscr *vsub,
static int vlr_subscr_handle_lu_res(struct vlr_subscr *vsub,
const struct osmo_gsup_message *gsup)
{
if (!vsub->lu_fsm) {
struct sgs_lu_response sgs_lu_response;
bool sgs_lu_in_progress = false;
if (vsub->sgs_fsm->state == SGS_UE_ST_LA_UPD_PRES)
sgs_lu_in_progress = true;
if (!vsub->lu_fsm && !sgs_lu_in_progress) {
LOGVSUBP(LOGL_ERROR, vsub, "Rx GSUP LU Result "
"without LU in progress\n");
return -ENODEV;
@ -865,7 +885,12 @@ static int vlr_subscr_handle_lu_res(struct vlr_subscr *vsub,
* nested INSERT SUBSCRIBER DATA transaction */
vlr_subscr_gsup_insert_data(vsub, gsup);
osmo_fsm_inst_dispatch(vsub->lu_fsm, VLR_ULA_E_HLR_LU_RES, NULL);
if (sgs_lu_in_progress) {
sgs_lu_response.accepted = true;
sgs_lu_response.vsub = vsub;
vsub->sgs.response_cb(&sgs_lu_response);
} else
osmo_fsm_inst_dispatch(vsub->lu_fsm, VLR_ULA_E_HLR_LU_RES, NULL);
return 0;
}
@ -874,7 +899,13 @@ static int vlr_subscr_handle_lu_res(struct vlr_subscr *vsub,
static int vlr_subscr_handle_lu_err(struct vlr_subscr *vsub,
const struct osmo_gsup_message *gsup)
{
if (!vsub->lu_fsm) {
struct sgs_lu_response sgs_lu_response;
bool sgs_lu_in_progress = false;
if (vsub->sgs_fsm->state == SGS_UE_ST_LA_UPD_PRES)
sgs_lu_in_progress = true;
if (!vsub->lu_fsm && !sgs_lu_in_progress) {
LOGVSUBP(LOGL_ERROR, vsub, "Rx GSUP LU Error "
"without LU in progress\n");
return -ENODEV;
@ -883,9 +914,13 @@ static int vlr_subscr_handle_lu_err(struct vlr_subscr *vsub,
LOGVSUBP(LOGL_DEBUG, vsub, "UpdateLocation failed; gmm_cause: %s\n",
get_value_string(gsm48_gmm_cause_names, gsup->cause));
osmo_fsm_inst_dispatch(vsub->lu_fsm, VLR_ULA_E_HLR_LU_RES,
(void *)&gsup->cause);
if (sgs_lu_in_progress) {
sgs_lu_response.accepted = false;
sgs_lu_response.vsub = vsub;
vsub->sgs.response_cb(&sgs_lu_response);
} else
osmo_fsm_inst_dispatch(vsub->lu_fsm, VLR_ULA_E_HLR_LU_RES,
(void *)&gsup->cause);
return 0;
}
@ -1225,6 +1260,9 @@ int vlr_subscr_rx_imsi_detach(struct vlr_subscr *vsub)
vsub->imsi_detached_flag = true;
vsub->expire_lu = VLR_SUBSCRIBER_NO_EXPIRATION;
/* Inform the UE-SGs FSM that the subscriber has been detached */
osmo_fsm_inst_dispatch(vsub->sgs_fsm, SGS_UE_E_RX_DETACH_IND_FROM_UE, NULL);
vlr_subscr_expire(vsub);
return 0;
@ -1273,6 +1311,8 @@ struct vlr_instance *vlr_alloc(void *ctx, const struct vlr_ops *ops)
vlr_lu_fsm_init();
/* vlr_access_request_fsm.c */
vlr_parq_fsm_init();
/* vlr_sgs_fsm.c */
vlr_sgs_fsm_init();
return vlr;
}

View File

@ -27,6 +27,7 @@
#include "vlr_core.h"
#include "vlr_auth_fsm.h"
#include "vlr_lu_fsm.h"
#include "vlr_sgs_fsm.h"
#define S(x) (1 << (x))
@ -362,6 +363,7 @@ static void vlr_lu_compl_fsm_success(struct osmo_fsm_inst *fi)
vlr_subscr_get(vsub);
}
_vlr_lu_compl_fsm_done(fi, VLR_FSM_RESULT_SUCCESS, 0);
vlr_sgs_fsm_update_id(vsub);
}
static void vlr_lu_compl_fsm_failure(struct osmo_fsm_inst *fi, uint8_t cause)
@ -1055,6 +1057,11 @@ static void lu_fsm_idle(struct osmo_fsm_inst *fi, uint32_t event,
OSMO_ASSERT(lfp->vsub);
/* At this point we know for which subscriber the location update is,
* we now must inform SGs-UE FSM that we received a location update
* via A, IU or Gs interface. */
osmo_fsm_inst_dispatch(lfp->vsub->sgs_fsm, SGS_UE_E_RX_LU_FROM_A_IU_GS, NULL);
/* See 3GPP TS 23.012, procedure Retrieve_IMEISV_If_Required */
if ((!vlr->cfg.retrieve_imeisv_early)
|| (lfp->type == VLR_LU_TYPE_PERIODIC && lfp->vsub->imeisv[0])) {

331
src/libvlr/vlr_sgs.c Normal file
View File

@ -0,0 +1,331 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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 <osmocom/core/utils.h>
#include <osmocom/core/fsm.h>
#include <osmocom/msc/debug.h>
#include <osmocom/msc/vlr.h>
#include <osmocom/msc/vlr_sgs.h>
#include "vlr_sgs_fsm.h"
const struct value_string sgs_state_timer_names[] = {
{SGS_STATE_TS5, "Ts5"},
{SGS_STATE_TS6_2, "Ts6-2"},
{SGS_STATE_TS7, "Ts7"},
{SGS_STATE_TS11, "Ts11"},
{SGS_STATE_TS14, "Ts14"},
{SGS_STATE_TS15, "Ts15"},
{0, NULL}
};
const struct value_string sgs_state_counter_names[] = {
{SGS_STATE_NS7, "Ns7"},
{SGS_STATE_NS11, "Ns11"},
{0, NULL}
};
/* Reset all SGs-Associations back to zero.
* \param[in] vlr VLR instace. */
void vlr_sgs_reset(struct vlr_instance *vlr)
{
struct vlr_subscr *vsub;
OSMO_ASSERT(vlr);
LOGP(DVLR, LOGL_INFO, "dropping all SGs associations.\n");
llist_for_each_entry(vsub, &vlr->subscribers, list) {
osmo_fsm_inst_dispatch(vsub->sgs_fsm, SGS_UE_E_RX_RESET_FROM_MME, NULL);
}
}
/*! Perform an SGs location update.
* \param[in] vlr VLR instace.
* \param[in] cfg SGs interface configuration parameters.
* \param[in] response_cb calback function that is called when LU is done.
* \param[in] paging_cb calback function that is called when LU needs to page.
* \param[in] mminfo_cb calback function that is called to provide MM info to the UE.
* \param[in] mme_name fqdn of the requesting MME (mme-name).
* \param[in] type location update type (normal or IMSI attach).
* \param[in] imsi mobile identity (IMSI).
* \param[in] new_lai identifier of the new location area.
* \returns 0 in case of success, -EINVAL in case of error. */
int vlr_sgs_loc_update(struct vlr_instance *vlr, struct vlr_sgs_cfg *cfg,
vlr_sgs_lu_response_cb_t response_cb, vlr_sgs_lu_paging_cb_t paging_cb,
vlr_sgs_lu_mminfo_cb_t mminfo_cb, char *mme_name, enum vlr_lu_type type, const char *imsi,
struct osmo_location_area_id *new_lai)
{
struct vlr_subscr *vsub = NULL;
OSMO_ASSERT(response_cb);
OSMO_ASSERT(paging_cb);
OSMO_ASSERT(mminfo_cb);
OSMO_ASSERT(cfg);
OSMO_ASSERT(imsi);
vsub = vlr_subscr_find_or_create_by_imsi(vlr, imsi, NULL);
if (!vsub) {
LOGP(DSGS, LOGL_ERROR, "VLR subscriber allocation failed\n");
return -EINVAL;
}
vsub->sgs.cfg = *cfg;
vsub->sgs.response_cb = response_cb;
vsub->sgs.paging_cb = paging_cb;
vsub->sgs.mminfo_cb = mminfo_cb;
vlr_subscr_set_imsi(vsub, imsi);
osmo_strlcpy(vsub->sgs.mme_name, mme_name, sizeof(vsub->sgs.mme_name));
osmo_fsm_inst_dispatch(vsub->sgs_fsm, SGS_UE_E_RX_LU_FROM_MME, NULL);
/* FIXME: Use the "type" type parameter (for what is it useful?) */
vsub->sgs.lai = *new_lai;
vsub->cgi.lai = *new_lai;
vsub->cs.lac = vsub->sgs.lai.lac;
return 0;
}
/*! Notify that the SGs Location Update accept message has been sent to MME.
* \param[in] vsub VLR subscriber. */
void vlr_sgs_loc_update_acc_sent(struct vlr_subscr *vsub)
{
osmo_fsm_inst_dispatch(vsub->sgs_fsm, SGS_UE_E_TX_LU_ACCEPT, NULL);
/* FIXME: At this point we need to check the status of Ts5 and if
* it is still running this means the LU has interrupted the paging,
* and we need to start paging again. 3GPP TS 29.118,
* chapter 5.2.3.2 */
}
/*! Notify that the SGs Location Update reject message has been sent to MME.
* \param[in] vsub VLR subscriber. */
void vlr_sgs_loc_update_rej_sent(struct vlr_subscr *vsub)
{
osmo_fsm_inst_dispatch(vsub->sgs_fsm, SGS_UE_E_TX_LU_REJECT, NULL);
}
/*! Perform an SGs IMSI detach.
* \param[in] vsub VLR subscriber.
* \param[in] imsi mobile identity (IMSI).
* \param[in] type datach type. */
void vlr_sgs_imsi_detach(struct vlr_instance *vlr, const char *imsi, enum sgsap_imsi_det_noneps_type type)
{
struct vlr_subscr *vsub;
enum sgs_ue_fsm_event evt;
vsub = vlr_subscr_find_by_imsi(vlr, imsi);
if (!vsub)
return;
switch (type) {
case SGSAP_ID_NONEPS_T_EXPLICIT_UE_NONEPS:
evt = SGS_UE_E_RX_DETACH_IND_FROM_UE;
break;
case SGSAP_ID_NONEPS_T_COMBINED_UE_EPS_NONEPS:
case SGSAP_ID_NONEPS_T_IMPLICIT_UE_EPS_NONEPS:
/* FIXME: Is that right? */
evt = SGS_UE_E_RX_DETACH_IND_FROM_MME;
break;
default:
LOGP(DSGS, LOGL_ERROR, "(sub %s) invalid SGS IMSI detach type, detaching anyway...\n",
vlr_subscr_msisdn_or_name(vsub));
evt = SGS_UE_E_RX_DETACH_IND_FROM_MME;
break;
}
osmo_fsm_inst_dispatch(vsub->sgs_fsm, evt, NULL);
vlr_subscr_put(vsub);
}
/*! Perform an SGs EPS detach.
* \param[in] vsub VLR subscriber.
* \param[in] imsi mobile identity (IMSI).
* \param[in] type datach type. */
void vlr_sgs_eps_detach(struct vlr_instance *vlr, const char *imsi, enum sgsap_imsi_det_eps_type type)
{
struct vlr_subscr *vsub;
enum sgs_ue_fsm_event evt;
vsub = vlr_subscr_find_by_imsi(vlr, imsi);
if (!vsub)
return;
switch (type) {
case SGSAP_ID_EPS_T_NETWORK_INITIATED:
evt = SGS_UE_E_RX_DETACH_IND_FROM_MME;
break;
case SGSAP_ID_EPS_T_UE_INITIATED:
evt = SGS_UE_E_RX_DETACH_IND_FROM_UE;
break;
case SGSAP_ID_EPS_T_EPS_NOT_ALLOWED:
evt = SGS_UE_E_RX_DETACH_IND_FROM_MME;
break;
default:
LOGP(DSGS, LOGL_ERROR, "(sub %s) invalid SGS IMSI detach type, detaching anyway...\n",
vlr_subscr_msisdn_or_name(vsub));
evt = SGS_UE_E_RX_DETACH_IND_FROM_MME;
break;
}
osmo_fsm_inst_dispatch(vsub->sgs_fsm, evt, NULL);
vlr_subscr_put(vsub);
}
/*! Perform an SGs TMSI reallocation complete.
* \param[in] vsub VLR subscriber.
* \param[in] imsi mobile identity (IMSI). */
void vlr_sgs_tmsi_reall_compl(struct vlr_instance *vlr, const char *imsi)
{
struct vlr_subscr *vsub;
vsub = vlr_subscr_find_by_imsi(vlr, imsi);
if (!vsub)
return;
osmo_fsm_inst_dispatch(vsub->sgs_fsm, SGS_UE_E_RX_TMSI_REALLOC, NULL);
vlr_subscr_put(vsub);
}
/*! Notify that an SGs paging has been rejected by the MME.
* \param[in] vsub VLR subscriber.
* \param[in] imsi mobile identity (IMSI).
* \param[in] cause SGs cause code. */
void vlr_sgs_pag_rej(struct vlr_instance *vlr, const char *imsi, enum sgsap_sgs_cause cause)
{
struct vlr_subscr *vsub;
vsub = vlr_subscr_find_by_imsi(vlr, imsi);
if (!vsub)
return;
/* On the reception of a paging rej the VLR is supposed to stop Ts5,
also 3GPP TS 29.118, chapter 5.1.2.4 */
osmo_timer_del(&vsub->sgs.Ts5);
LOGP(DSGS, LOGL_DEBUG, "(sub %s) Paging via SGs interface rejected by MME, %s stopped, cause: %s!\n",
vlr_subscr_msisdn_or_name(vsub), vlr_sgs_state_timer_name(SGS_STATE_TS5), sgsap_sgs_cause_name(cause));
osmo_fsm_inst_dispatch(vsub->sgs_fsm, SGS_UE_E_RX_PAGING_FAILURE, &cause);
vlr_subscr_put(vsub);
/* Balance ref count increment from vlr_sgs_pag() */
vlr_subscr_put(vsub);
}
/*! Notify that an SGs paging has been accepted by the MME.
* \param[in] vsub VLR subscriber.
* \param[in] imsi mobile identity (IMSI). */
void vlr_sgs_pag_ack(struct vlr_instance *vlr, const char *imsi)
{
struct vlr_subscr *vsub;
vsub = vlr_subscr_find_by_imsi(vlr, imsi);
if (!vsub)
return;
/* Stop Ts5 and and consider the paging as successful */
osmo_timer_del(&vsub->sgs.Ts5);
vlr_subscr_put(vsub);
/* Balance ref count increment from vlr_sgs_pag() */
vlr_subscr_put(vsub);
}
/*! Notify that the UE has been marked as unreachable by the MME.
* \param[in] vsub VLR subscriber.
* \param[in] imsi mobile identity (IMSI).
* \param[in] cause SGs cause code. */
void vlr_sgs_ue_unr(struct vlr_instance *vlr, const char *imsi, enum sgsap_sgs_cause cause)
{
struct vlr_subscr *vsub;
vsub = vlr_subscr_find_by_imsi(vlr, imsi);
if (!vsub)
return;
/* On the reception of an UE unreachable the VLR is supposed to stop
* Ts5, also 3GPP TS 29.118, chapter 5.1.2.5 */
osmo_timer_del(&vsub->sgs.Ts5);
LOGP(DSGS, LOGL_DEBUG,
"(sub %s) Paging via SGs interface not possible, UE unreachable, %s stopped, cause: %s\n",
vlr_subscr_msisdn_or_name(vsub), vlr_sgs_state_timer_name(SGS_STATE_TS5), sgsap_sgs_cause_name(cause));
osmo_fsm_inst_dispatch(vsub->sgs_fsm, SGS_UE_E_RX_SGSAP_UE_UNREACHABLE, &cause);
vlr_subscr_put(vsub);
}
/* Callback function that is called when an SGs paging request times out */
static void Ts5_timeout_cb(void *arg)
{
struct vlr_subscr *vsub = arg;
/* 3GPP TS 29.118 does not specify a specif action that has to happen
* in case Ts5 times out. The timeout just indicates that the paging
* failed. Other actions may check the status of Ts5 to see if a paging
* is still ongoing or not. */
LOGP(DSGS, LOGL_ERROR, "(sub %s) Paging via SGs interface timed out (%s expired)!\n",
vlr_subscr_msisdn_or_name(vsub), vlr_sgs_state_timer_name(SGS_STATE_TS5));
/* Balance ref count increment from vlr_sgs_pag() */
vlr_subscr_put(vsub);
return;
}
/*! Notify that a paging message has been sent and a paging is now in progress.
* \param[in] vsub VLR subscriber. */
void vlr_sgs_pag(struct vlr_subscr *vsub, enum sgsap_service_ind serv_ind)
{
/* In cases where we have to respawn a paging after an intermitted LU,
* there may e a Ts5 still running. In those cases we have to remove
* the old timer first */
if (osmo_timer_pending(&vsub->sgs.Ts5))
osmo_timer_del(&vsub->sgs.Ts5);
/* Note: 3GPP TS 29.118, chapter 4.2.2 mentions paging in the FSM
* diagram, but paging never causes a state transition except when
* an explicit failure is indicated (MME actively rejects paging).
* Apparantly it is also possible that an LU happens while the paging
* is still ongoing and Ts5 is running. (chapter 5.1.2.3). This means
* that the paging procedure is intended to run in parallel to the
* SGs FSM and given that the benaviour around Ts5 must be implemented
* also separately, to emphasize this separation Ts5 is implemented
* here in and not in vlr_sgs_fsm.c. */
osmo_timer_setup(&vsub->sgs.Ts5, Ts5_timeout_cb, vsub);
osmo_timer_schedule(&vsub->sgs.Ts5, vsub->sgs.cfg.timer[SGS_STATE_TS5], 0);
/* Formally 3GPP TS 29.118 defines the sending of a paging request
* as an event, but as far as the VLR is concerned only Ts5 is
* started. */
osmo_fsm_inst_dispatch(vsub->sgs_fsm, SGS_UE_E_TX_PAGING, NULL);
/* Memorize service type in for the case that the paging must be
* respawned after an LU */
vsub->sgs.paging_serv_ind = serv_ind;
/* Ensure that the reference count is increased by one while the
* paging is happening. We will balance this again in vlr_sgs_pag_rej()
* and vlr_sgs_pag_ack(); */
vlr_subscr_get(vsub);
}
/*! Check if the SGs interface is currently paging
* \param[in] vsub VLR subscriber. */
bool vlr_sgs_pag_pend(struct vlr_subscr *vsub)
{
return osmo_timer_pending(&vsub->sgs.Ts5);
}

386
src/libvlr/vlr_sgs_fsm.c Normal file
View File

@ -0,0 +1,386 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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 <osmocom/core/utils.h>
#include <osmocom/core/fsm.h>
#include <osmocom/gsm/gsm48.h>
#include <osmocom/msc/debug.h>
#include <osmocom/msc/vlr.h>
#include <osmocom/msc/vlr_sgs.h>
#include "vlr_sgs_fsm.h"
#include "vlr_core.h"
#define S(x) (1 << (x))
static const struct value_string sgs_ue_fsm_event_names[] = {
{SGS_UE_E_VLR_FAILURE, "VLR_FAILURE"},
{SGS_UE_E_RX_RESET_FROM_MME, "RX_RESET_FROM_MME"},
{SGS_UE_E_RX_DETACH_IND_FROM_MME, "RX_DETACH_IND_FROM_MME"},
{SGS_UE_E_RX_DETACH_IND_FROM_UE, "RX_DETACH_IND_FROM_UE"}, /* vlr.c */
{SGS_UE_E_RX_LU_FROM_A_IU_GS, "RX_LU_FROM_A_Iu_Gs"}, /* vlr_lu_fsm.c */
{SGS_UE_E_RX_PAGING_FAILURE, "RX_PAGING_FAILURE"},
{SGS_UE_E_RX_ALERT_FAILURE, "RX_ALERT_FAILURE"},
{SGS_UE_E_RX_LU_FROM_MME, "RX_LU_FROM_MME"},
{SGS_UE_E_TX_LU_REJECT, "TX_LU_REJECT"},
{SGS_UE_E_TX_LU_ACCEPT, "TX_LU_ACCEPT"},
{SGS_UE_E_TX_PAGING, "TX_PAGING"},
{SGS_UE_E_RX_SGSAP_UE_UNREACHABLE, "RX_SGSAP_UE_UNREACH"},
{SGS_UE_E_RX_TMSI_REALLOC, "RX_TMSI_REALLOC"},
{0, NULL}
};
/* Initiate location update and change to SGS_UE_ST_LA_UPD_PRES state */
static void perform_lu(struct osmo_fsm_inst *fi)
{
struct vlr_subscr *vsub = fi->priv;
int rc;
osmo_fsm_inst_state_chg(fi, SGS_UE_ST_LA_UPD_PRES, 0, 0);
vsub->ms_not_reachable_flag = false;
/* Note: At the moment we allocate a new TMSI on each LU. */
rc = vlr_subscr_alloc_tmsi(vsub);
if (rc != 0)
LOGPFSML(fi, LOGL_ERROR, "(sub %s) VLR LU tmsi allocation failed\n", vlr_subscr_name(vsub));
rc = vlr_subscr_req_lu(vsub);
if (rc != 0)
LOGPFSML(fi, LOGL_ERROR, "(sub %s) HLR LU request failed\n", vlr_subscr_name(vsub));
}
/* Send the SGs Association to NULL state immediately */
static void to_null(struct osmo_fsm_inst *fi)
{
struct vlr_subscr *vsub = fi->priv;
osmo_fsm_inst_state_chg(fi, SGS_UE_ST_NULL, 0, 0);
/* Note: This is only relevent for cases where we are in the middle
* of an TMSI reallocation procedure. Should a failure of some sort
* put us to NULL state, we have to free the pending TMSI */
vsub->tmsi_new = GSM_RESERVED_TMSI;
/* Make sure any ongoing paging is aborted. */
vsub->cs.is_paging = false;
/* Ensure that Ts5 (pending paging via SGs) is deleted */
if (vlr_sgs_pag_pend(vsub))
osmo_timer_del(&vsub->sgs.Ts5);
}
/* Respawn a pending paging (Timer is reset and a new paging request is sent) */
static void respawn_paging(struct vlr_subscr *vsub)
{
if (vlr_sgs_pag_pend(vsub)) {
/* Delete the old paging timer first. */
osmo_timer_del(&vsub->sgs.Ts5);
/* Issue a fresh paging request */
vsub->sgs.paging_cb(vsub, vsub->sgs.paging_serv_ind);
}
}
/* Figure 4.2.2.1 SGs-NULL */
static void sgs_ue_fsm_null(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
switch (event) {
case SGS_UE_E_RX_LU_FROM_MME:
perform_lu(fi);
break;
case SGS_UE_E_TX_PAGING:
/* do nothing */
break;
case SGS_UE_E_RX_PAGING_FAILURE:
/* do nothing */
break;
default:
OSMO_ASSERT(0);
}
}
/* Figure 4.2.2.1 SGs-LA-UPDATE-PRESENT */
static void sgs_ue_fsm_lau_present(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
struct vlr_subscr *vsub = fi->priv;
enum sgsap_sgs_cause *cause = NULL;
switch (event) {
case SGS_UE_E_TX_LU_ACCEPT:
vsub->conf_by_radio_contact_ind = true;
vsub->sub_dataconf_by_hlr_ind = true;
vsub->loc_conf_in_hlr_ind = true;
vsub->la_allowed = true;
vsub->imsi_detached_flag = false;
vsub->lu_complete = true;
vlr_sgs_fsm_update_id(vsub);
vsub->cs.attached_via_ran = OSMO_RAT_EUTRAN_SGS;
/* Check if we expect a TMSI REALLOCATION COMPLETE message from the MME
* by checking the tmsi_new flag. If this flag is not GSM_RESERVED_TMSI
* we know that we have a TMSI pending and need to wait for the MME
* to acknowlege first */
if (vsub->tmsi_new != GSM_RESERVED_TMSI) {
osmo_fsm_inst_state_chg(fi, SGS_UE_ST_ASSOCIATED, vsub->sgs.cfg.timer[SGS_STATE_TS6_2],
SGS_STATE_TS6_2);
} else {
/* Trigger sending of an MM information request */
vsub->sgs.mminfo_cb(vsub);
/* In cases where the LU has interrupted the paging, respawn the paging now,
* See also: 3GPP TS 29.118, chapter 5.2.3.2 Location update response */
if (vlr_sgs_pag_pend(vsub))
respawn_paging(vsub);
osmo_fsm_inst_state_chg(fi, SGS_UE_ST_ASSOCIATED, 0, 0);
}
break;
case SGS_UE_E_RX_PAGING_FAILURE:
cause = data;
if (*cause == SGSAP_SGS_CAUSE_MT_CSFB_REJ_USER)
break;
to_null(fi);
break;
case SGS_UE_E_TX_LU_REJECT:
case SGS_UE_E_RX_ALERT_FAILURE:
to_null(fi);
break;
case SGS_UE_E_TX_PAGING:
/* do nothing */
break;
default:
OSMO_ASSERT(0);
break;
}
}
/* Figure 4.2.2.1 SGs-ASSOCIATED */
static void sgs_ue_fsm_associated(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
struct vlr_subscr *vsub = fi->priv;
enum sgsap_sgs_cause *cause = NULL;
switch (event) {
case SGS_UE_E_TX_PAGING:
/* do nothing */
break;
case SGS_UE_E_RX_TMSI_REALLOC:
if (vsub->tmsi_new == GSM_RESERVED_TMSI) {
LOGPFSML(fi, LOGL_ERROR,
"(sub %s) TMSI reallocation completed at the MME, but no TMSI reallocation ordered.\n",
vlr_subscr_msisdn_or_name(vsub));
}
vsub->tmsi = vsub->tmsi_new;
vsub->tmsi_new = GSM_RESERVED_TMSI;
/* Trigger sending of MM information */
vsub->sgs.mminfo_cb(vsub);
/* In cases where the LU has interrupted the paging, respawn the paging now,
* See also: 3GPP TS 29.118, chapter 5.2.3.2 Location update response */
if (vlr_sgs_pag_pend(vsub))
respawn_paging(vsub);
/* Note: We are already in SGS_UE_ST_ASSOCIATED but the
* transition that lead us here had is guarded with Ts6-1,
* wo we change the state now once more without timeout
* to ensure the timer is stopped */
osmo_fsm_inst_state_chg(fi, SGS_UE_ST_ASSOCIATED, 0, 0);
break;
case SGS_UE_E_RX_SGSAP_UE_UNREACHABLE:
/* do nothing */
break;
case SGS_UE_E_RX_PAGING_FAILURE:
cause = data;
if (*cause == SGSAP_SGS_CAUSE_MT_CSFB_REJ_USER)
break;
to_null(fi);
case SGS_UE_E_RX_ALERT_FAILURE:
to_null(fi);
break;
case SGS_UE_E_RX_LU_FROM_MME:
perform_lu(fi);
break;
default:
OSMO_ASSERT(0);
break;
}
}
/* Figure 4.2.2.1 From any of the three states (at the VLR) */
static void sgs_ue_fsm_allstate(struct osmo_fsm_inst *fi, uint32_t event, void *data)
{
struct vlr_subscr *vsub = fi->priv;
switch (event) {
case SGS_UE_E_RX_DETACH_IND_FROM_MME:
case SGS_UE_E_RX_DETACH_IND_FROM_UE:
vsub->imsi_detached_flag = true;
vsub->expire_lu = VLR_SUBSCRIBER_NO_EXPIRATION;
/* See 5.4.3 and 5.5.3 */
to_null(fi);
break;
case SGS_UE_E_RX_RESET_FROM_MME:
/* See also 3GPP TS 29.118, chapter 5.7.2.1 VLR Reset Initiation */
vsub->conf_by_radio_contact_ind = false;
to_null(fi);
break;
case SGS_UE_E_VLR_FAILURE:
case SGS_UE_E_RX_LU_FROM_A_IU_GS:
to_null(fi);
break;
default:
OSMO_ASSERT(0);
break;
}
}
static int sgs_ue_fsm_timer_cb(struct osmo_fsm_inst *fi)
{
struct vlr_subscr *vsub = fi->priv;
switch (fi->T) {
case SGS_STATE_TS6_2:
/* Failed TMSI reallocation procedure, deallocate all TMSI
* information, but don't change the SGs association state. */
vsub->tmsi_new = GSM_RESERVED_TMSI;
vsub->tmsi = GSM_RESERVED_TMSI;
break;
default:
/* Unhandled timer */
OSMO_ASSERT(false);
break;
}
return 0;
}
static const struct osmo_fsm_state sgs_ue_fsm_states[] = {
[SGS_UE_ST_NULL] = {
.name = "SGs-NULL",
.action = sgs_ue_fsm_null,
.in_event_mask = 0
| S(SGS_UE_E_RX_LU_FROM_MME)
| S(SGS_UE_E_TX_PAGING)
| S(SGS_UE_E_RX_PAGING_FAILURE)
,
.out_state_mask = 0
| S(SGS_UE_ST_NULL)
| S(SGS_UE_ST_LA_UPD_PRES)
,
},
[SGS_UE_ST_LA_UPD_PRES] = {
.name = "SGs-LA-UPDATE-PRESENT",
.action = sgs_ue_fsm_lau_present,
.in_event_mask = 0
| S(SGS_UE_E_TX_LU_ACCEPT)
| S(SGS_UE_E_TX_LU_REJECT)
| S(SGS_UE_E_TX_PAGING)
| S(SGS_UE_E_RX_PAGING_FAILURE)
| S(SGS_UE_E_RX_ALERT_FAILURE)
,
.out_state_mask = 0
| S(SGS_UE_ST_NULL)
| S(SGS_UE_ST_ASSOCIATED)
| S(SGS_UE_ST_LA_UPD_PRES)
,
},
[SGS_UE_ST_ASSOCIATED] = {
.name = "SGs-ASSOCIATED",
.action = sgs_ue_fsm_associated,
.in_event_mask = 0
| S(SGS_UE_E_TX_PAGING)
| S(SGS_UE_E_RX_TMSI_REALLOC)
| S(SGS_UE_E_RX_SGSAP_UE_UNREACHABLE)
| S(SGS_UE_E_RX_PAGING_FAILURE)
| S(SGS_UE_E_RX_ALERT_FAILURE)
| S(SGS_UE_E_RX_LU_FROM_MME)
,
.out_state_mask = 0
| S(SGS_UE_ST_NULL)
| S(SGS_UE_ST_ASSOCIATED)
| S(SGS_UE_ST_LA_UPD_PRES)
,
},
};
static struct osmo_fsm sgs_ue_fsm = {
.name = "SGs-UE",
.states = sgs_ue_fsm_states,
.num_states = ARRAY_SIZE(sgs_ue_fsm_states),
.allstate_event_mask = S(SGS_UE_E_RX_RESET_FROM_MME) |
S(SGS_UE_E_VLR_FAILURE) | S(SGS_UE_E_RX_DETACH_IND_FROM_MME) | S(SGS_UE_E_RX_DETACH_IND_FROM_UE) |
S(SGS_UE_E_RX_LU_FROM_A_IU_GS),
.allstate_action = sgs_ue_fsm_allstate,
.timer_cb = sgs_ue_fsm_timer_cb,
.log_subsys = DSGS,
.event_names = sgs_ue_fsm_event_names,
};
/*! Initalize/Register SGs FSM in osmo-fsm subsystem */
void vlr_sgs_fsm_init(void)
{
if (osmo_fsm_find_by_name(sgs_ue_fsm.name) != &sgs_ue_fsm)
osmo_fsm_register(&sgs_ue_fsm);
}
/*! Crate SGs FSM in struct vlr_subscr.
* \param[in] vsub VLR subscriber for which the SGs FSM should be created. */
void vlr_sgs_fsm_create(struct vlr_subscr *vsub)
{
char interim_fsm_id[256];
static unsigned int fsm_id_num = 0;
/* An SGSs FSM must not be created twice! */
OSMO_ASSERT(!vsub->sgs_fsm);
snprintf(interim_fsm_id, sizeof(interim_fsm_id), "num:%u", fsm_id_num);
vsub->sgs_fsm = osmo_fsm_inst_alloc(&sgs_ue_fsm, vsub, vsub, LOGL_INFO, interim_fsm_id);
OSMO_ASSERT(vsub->sgs_fsm);
osmo_fsm_inst_state_chg(vsub->sgs_fsm, SGS_UE_ST_NULL, 0, 0);
fsm_id_num++;
}
/*! Remove SGs FSM from struct vlr_subscr.
* \param[in] vsub VLR subscriber from which the SGs FSM should be removed. */
void vlr_sgs_fsm_remove(struct vlr_subscr *vsub)
{
/* An SGSs FSM must exist! */
OSMO_ASSERT(vsub->sgs_fsm);
osmo_fsm_inst_state_chg(vsub->sgs_fsm, SGS_UE_ST_NULL, 0, 0);
osmo_fsm_inst_term(vsub->sgs_fsm, OSMO_FSM_TERM_REGULAR, NULL);
vsub->sgs_fsm = NULL;
}
/*! Update the ID of the SGs FSM with the subscriber IMSI
* \param[in] vsub VLR subscriber to update. */
void vlr_sgs_fsm_update_id(struct vlr_subscr *vsub)
{
char fsm_id[256];
if (strlen(vsub->imsi) > 0) {
snprintf(fsm_id, sizeof(fsm_id), "imsi:%s", vsub->imsi);
osmo_fsm_inst_update_id(vsub->sgs_fsm, fsm_id);
}
}

42
src/libvlr/vlr_sgs_fsm.h Normal file
View File

@ -0,0 +1,42 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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/>.
*
*/
#pragma once
enum sgs_ue_fsm_event {
SGS_UE_E_VLR_FAILURE,
SGS_UE_E_RX_RESET_FROM_MME,
SGS_UE_E_RX_DETACH_IND_FROM_MME,
SGS_UE_E_RX_DETACH_IND_FROM_UE,
SGS_UE_E_RX_LU_FROM_A_IU_GS,
SGS_UE_E_RX_PAGING_FAILURE,
SGS_UE_E_RX_ALERT_FAILURE,
SGS_UE_E_RX_LU_FROM_MME,
SGS_UE_E_TX_LU_REJECT,
SGS_UE_E_TX_LU_ACCEPT,
SGS_UE_E_TX_PAGING,
SGS_UE_E_RX_SGSAP_UE_UNREACHABLE,
SGS_UE_E_RX_TMSI_REALLOC,
};
void vlr_sgs_fsm_init(void);
void vlr_sgs_fsm_create(struct vlr_subscr *vsub);
void vlr_sgs_fsm_remove(struct vlr_subscr *vsub);
void vlr_sgs_fsm_update_id(struct vlr_subscr *vsub);

View File

@ -12,6 +12,7 @@ AM_CFLAGS = \
$(LIBOSMOVTY_CFLAGS) \
$(LIBOSMOCTRL_CFLAGS) \
$(LIBOSMOABIS_CFLAGS) \
$(LIBOSMONETIF_CFLAGS) \
$(LIBSMPP34_CFLAGS) \
$(LIBOSMORANAP_CFLAGS) \
$(LIBASN1C_CFLAGS) \
@ -40,11 +41,13 @@ osmo_msc_LDADD = \
$(LIBOSMOCORE_LIBS) \
$(LIBOSMOCTRL_LIBS) \
$(LIBOSMOABIS_LIBS) \
$(LIBOSMONETIF_LIBS) \
$(LIBSMPP34_LIBS) \
$(LIBOSMOSIGTRAN_LIBS) \
$(LIBOSMOMGCPCLIENT_LIBS) \
$(LIBOSMOGSUPCLIENT_LIBS) \
-ldbi \
-lsctp \
$(NULL)
if BUILD_IU
osmo_msc_LDADD += \

View File

@ -61,6 +61,7 @@
#include <osmocom/msc/smpp.h>
#include <osmocom/sigtran/osmo_ss7.h>
#include <osmocom/mgcp_client/mgcp_client.h>
#include <osmocom/msc/sgs_iface.h>
#ifdef BUILD_IU
#include <osmocom/ranap/iu_client.h>
@ -491,6 +492,12 @@ static const struct log_info_cat msc_default_categories[] = {
.description = "BSSAP Protocol (A Interface)",
.enabled = 1, .loglevel = LOGL_NOTICE,
},
[DSGS] = {
.name = "DSGS",
.description = "SGs Interface (SGsAP)",
.enabled = 1, .loglevel = LOGL_NOTICE,
},
};
@ -566,6 +573,7 @@ int main(int argc, char **argv)
if (smpp_openbsc_alloc_init(tall_msc_ctx) < 0)
return -1;
#endif
sgs_iface_init(tall_msc_ctx, msc_network);
rc = vty_read_config_file(msc_cmdline_config.config_file, NULL);
if (rc < 0) {

View File

@ -57,6 +57,7 @@ LDADD = \
noinst_HEADERS = \
msc_vlr_tests.h \
stubs.h \
$(NULL)
EXTRA_DIST = \

View File

@ -24,6 +24,7 @@
/* NOTE that further auth re-use tests exist in msc_vlr_test_hlr_reject.c */
#include "msc_vlr_tests.h"
#include "stubs.h"
static void _test_auth_reuse(enum osmo_rat_type via_ran,
int set_max_reuse_count,

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
#include <osmocom/msc/gsm_04_08.h>

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
static void test_gsm_authen()
{

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
static void test_ciph()
{

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
static void test_hlr_rej_auth_info_unknown_imsi()
{

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
#include <osmocom/core/logging.h>

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
static void test_ms_timeout_lu_auth_resp()
{

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
static void test_no_authen()
{

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
static void test_reject_2nd_conn()
{

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
static void test_early_stage()
{

View File

@ -21,6 +21,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
#define IMSI "901700000004620"

View File

@ -22,6 +22,7 @@
*/
#include "msc_vlr_tests.h"
#include "stubs.h"
static void _test_umts_authen(enum osmo_rat_type via_ran)
{

40
tests/msc_vlr/stubs.h Normal file
View File

@ -0,0 +1,40 @@
/* (C) 2018-2019 by sysmocom s.f.m.c. GmbH
* All Rights Reserved
*
* Author: Harald Welte, Philipp Maier
*
* 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/>.
*
*/
void osmo_stream_srv_link_set_data(struct osmo_stream_srv_link *link, void *data) {}
struct osmo_fd *osmo_stream_srv_get_ofd(struct osmo_stream_srv *srv) { return NULL; }
void osmo_stream_srv_destroy(struct osmo_stream_srv *conn) {}
struct osmo_stream_srv *osmo_stream_srv_create(void *ctx, struct osmo_stream_srv_link *link,
int fd, int (*cb)(struct osmo_stream_srv *conn),
int (*closed_cb)(struct osmo_stream_srv *conn),
void *data) { return NULL; }
void osmo_stream_srv_send(struct osmo_stream_srv *conn, struct msgb *msg) {}
void osmo_stream_srv_link_set_proto(struct osmo_stream_srv_link *link, uint16_t proto) {}
struct osmo_fd *osmo_stream_srv_link_get_ofd(struct osmo_stream_srv_link *link) { return NULL; }
struct osmo_stream_srv_link *osmo_stream_srv_link_create(void *ctx) { return NULL; }
void *osmo_stream_srv_get_data(struct osmo_stream_srv *conn) { return NULL; }
void osmo_stream_srv_link_set_nodelay(struct osmo_stream_srv_link *link, bool nodelay) {}
void osmo_stream_srv_link_set_accept_cb(struct osmo_stream_srv_link *link, int (*accept_cb)
(struct osmo_stream_srv_link *link, int fd)) {}
int osmo_stream_srv_link_open(struct osmo_stream_srv_link *link) { return 0; }
void *osmo_stream_srv_link_get_data(struct osmo_stream_srv_link *link) { return NULL; }
void osmo_stream_srv_link_set_port(struct osmo_stream_srv_link *link, uint16_t port) {}
void osmo_stream_srv_link_set_addr(struct osmo_stream_srv_link *link, const char *addr) {}
int sctp_recvmsg(int sd, void *msg, size_t len, void *from, void *fromlen, void *info, int *msg_flags) { return 0; }

View File

@ -237,3 +237,24 @@ int main(int argc, char **argv)
return 0;
}
void osmo_stream_srv_link_set_data(struct osmo_stream_srv_link *link, void *data) {}
struct osmo_fd *osmo_stream_srv_get_ofd(struct osmo_stream_srv *srv) { return NULL; }
void osmo_stream_srv_destroy(struct osmo_stream_srv *conn) {}
struct osmo_stream_srv *osmo_stream_srv_create(void *ctx, struct osmo_stream_srv_link *link,
int fd, int (*cb)(struct osmo_stream_srv *conn),
int (*closed_cb)(struct osmo_stream_srv *conn),
void *data) { return NULL; }
void osmo_stream_srv_send(struct osmo_stream_srv *conn, struct msgb *msg) {}
void osmo_stream_srv_link_set_proto(struct osmo_stream_srv_link *link, uint16_t proto) {}
struct osmo_fd *osmo_stream_srv_link_get_ofd(struct osmo_stream_srv_link *link) { return NULL; }
struct osmo_stream_srv_link *osmo_stream_srv_link_create(void *ctx) { return NULL; }
void *osmo_stream_srv_get_data(struct osmo_stream_srv *conn) { return NULL; }
void osmo_stream_srv_link_set_nodelay(struct osmo_stream_srv_link *link, bool nodelay) {}
void osmo_stream_srv_link_set_accept_cb(struct osmo_stream_srv_link *link, int (*accept_cb)
(struct osmo_stream_srv_link *link, int fd)) {}
int osmo_stream_srv_link_open(struct osmo_stream_srv_link *link) { return 0; }
void *osmo_stream_srv_link_get_data(struct osmo_stream_srv_link *link) { return NULL; }
void osmo_stream_srv_link_set_port(struct osmo_stream_srv_link *link, uint16_t port) {}
void osmo_stream_srv_link_set_addr(struct osmo_stream_srv_link *link, const char *addr) {}
int sctp_recvmsg(int sd, void *msg, size_t len, void *from, void *fromlen, void *info, int *msg_flags) { return 0; }

View File

@ -4,6 +4,7 @@ OsmoMSC(config)# list
...
network
msc
sgs
mncc-int
hlr
...
@ -92,6 +93,18 @@ OsmoMSC(config)# exit
OsmoMSC# configure terminal
OsmoMSC(config)# network
OsmoMSC(config-net)# end
OsmoMSC# configure terminal
OsmoMSC(config)# sgs
OsmoMSC(config-sgs)# list
...
local-ip A.B.C.D
local-port <0-65535>
timer (ts5|ts6-2|ts7|ts11|ts14|ts15) <1-120>
counter (ns7|ns11) <0-255>
vlr-name FQDN
OsmoMSC(config-sgs)# end
OsmoMSC# disable
OsmoMSC> enable
@ -125,4 +138,7 @@ mncc-int
hlr
remote-ip 127.0.0.1
remote-port 4222
sgs
local-ip 0.0.0.0
vlr-name vlr.example.net
end