Move vlr.h & vlr_sgs.h into osmocom/vlr/
Prepare libvlr to be independent, start by moving the vlr headers
into its own directory.
Change-Id: I8b18b05091b35e744b3234d1ce0d537f56bccf07
diff --git a/include/osmocom/msc/Makefile.am b/include/osmocom/msc/Makefile.am
index a940056..b6901b9 100644
--- a/include/osmocom/msc/Makefile.am
+++ b/include/osmocom/msc/Makefile.am
@@ -53,8 +53,6 @@
sms_queue.h \
transaction.h \
transaction_cc.h \
- vlr.h \
- vlr_sgs.h \
vty.h \
asci_gcr.h \
asci_vty.h \
diff --git a/include/osmocom/msc/sgs_iface.h b/include/osmocom/msc/sgs_iface.h
index b5ff489..00e7ebc 100644
--- a/include/osmocom/msc/sgs_iface.h
+++ b/include/osmocom/msc/sgs_iface.h
@@ -22,8 +22,8 @@
#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/vlr/vlr.h>
+#include <osmocom/vlr/vlr_sgs.h>
#include <osmocom/msc/paging.h>
#include <osmocom/core/socket.h>
diff --git a/include/osmocom/msc/transaction_cc.h b/include/osmocom/msc/transaction_cc.h
index 963cb45..c19c033 100644
--- a/include/osmocom/msc/transaction_cc.h
+++ b/include/osmocom/msc/transaction_cc.h
@@ -28,7 +28,7 @@
#include <osmocom/msc/codec_mapping.h>
#include <osmocom/msc/transaction.h>
-#include <osmocom/msc/vlr.h>
+#include <osmocom/vlr/vlr.h>
void trans_cc_filter_init(struct gsm_trans *trans);
void trans_cc_filter_set_ran(struct gsm_trans *trans, enum osmo_rat_type ran_type);
diff --git a/include/osmocom/msc/vlr.h b/include/osmocom/msc/vlr.h
deleted file mode 100644
index 562b30f..0000000
--- a/include/osmocom/msc/vlr.h
+++ /dev/null
@@ -1,495 +0,0 @@
-#pragma once
-
-#include <stdint.h>
-#include <osmocom/core/linuxlist.h>
-#include <osmocom/core/fsm.h>
-#include <osmocom/core/logging.h>
-#include <osmocom/core/use_count.h>
-#include <osmocom/core/stat_item.h>
-#include <osmocom/core/rate_ctr.h>
-#include <osmocom/gsm/protocol/gsm_23_003.h>
-#include <osmocom/gsm/protocol/gsm_04_08_gprs.h>
-#include <osmocom/gsm/gsm23003.h>
-#include <osmocom/gsm/gsm0808.h>
-#include <osmocom/gsm/gsup.h>
-#include <osmocom/gsm/ipa.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)
-
-#define LOGVSUBP(level, vsub, fmt, args...) \
- LOGP(DVLR, level, "SUBSCR(%s) " fmt, vlr_subscr_name(vsub), ## args)
-
-struct log_target;
-struct osmo_mobile_identity;
-
-#define VLR_SUBSCRIBER_NO_EXPIRATION 0
-#define VLR_SUBSCRIBER_LU_EXPIRATION_INTERVAL 60 /* in seconds */
-
-#define VSUB_USE_ATTACHED "attached"
-
-/* from 3s to 10s */
-#define GSM_29002_TIMER_S 10
-/* from 15s to 30s */
-#define GSM_29002_TIMER_M 30
-/* from 1min to 10min */
-#define GSM_29002_TIMER_ML (10*60)
-/* from 28h to 38h */
-#define GSM_29002_TIMER_L (32*60*60)
-
-/* VLR subscriber authentication state */
-enum vlr_subscr_auth_state {
- /* subscriber needs to be authenticated */
- VLR_SUB_AS_NEEDS_AUTH,
- /* waiting for AuthInfo from HLR/AUC */
- VLR_SUB_AS_NEEDS_AUTH_WAIT_AI,
- /* waiting for response from subscriber */
- VLR_SUB_AS_WAIT_RESP,
- /* successfully authenticated */
- VLR_SUB_AS_AUTHENTICATED,
- /* subscriber needs re-sync */
- VLR_SUB_AS_NEEDS_RESYNC,
- /* waiting for AuthInfo with ReSync */
- VLR_SUB_AS_NEEDS_AUTH_WAIT_SAI_RESYNC,
- /* waiting for response from subscr, resync case */
- VLR_SUB_AS_WAIT_RESP_RESYNC,
- /* waiting for IMSI from subscriber */
- VLR_SUB_AS_WAIT_ID_IMSI,
- /* authentication has failed */
- VLR_SUB_AS_AUTH_FAILED,
-};
-
-enum vlr_lu_event {
- VLR_ULA_E_UPDATE_LA, /* Initial trigger (LU from MS) */
- VLR_ULA_E_SEND_ID_ACK, /* Result of Send-ID from PVLR */
- VLR_ULA_E_SEND_ID_NACK, /* Result of Send-ID from PVLR */
- VLR_ULA_E_AUTH_SUCCESS, /* Successful result of auth procedure */
- VLR_ULA_E_AUTH_NO_INFO, /* HLR returned SAI NACK, possibly continue without auth */
- VLR_ULA_E_AUTH_FAILURE, /* Auth procedure failed */
- VLR_ULA_E_CIPH_RES, /* Result of Ciphering Mode Command */
- VLR_ULA_E_ID_IMSI, /* IMSI received from MS */
- VLR_ULA_E_ID_IMEI, /* IMEI received from MS */
- VLR_ULA_E_ID_IMEISV, /* IMEISV received from MS */
- VLR_ULA_E_HLR_IMEI_ACK, /* Check_IMEI_VLR result from HLR */
- VLR_ULA_E_HLR_IMEI_NACK,/* Check_IMEI_VLR result from HLR */
- VLR_ULA_E_HLR_LU_RES, /* HLR UpdateLocation result */
- VLR_ULA_E_UPD_HLR_COMPL,/* UpdatE_HLR_VLR result */
- VLR_ULA_E_LU_COMPL_SUCCESS,/* Location_Update_Completion_VLR result */
- VLR_ULA_E_LU_COMPL_FAILURE,/* Location_Update_Completion_VLR result */
- VLR_ULA_E_NEW_TMSI_ACK, /* TMSI Reallocation Complete */
-};
-
-enum vlr_ciph_result_cause {
- VLR_CIPH_REJECT, /* ? */
- VLR_CIPH_COMPL,
-};
-
-struct vlr_auth_tuple {
- int use_count;
- int key_seq;
- struct osmo_auth_vector vec;
-};
-#define VLR_KEY_SEQ_INVAL 7 /* GSM 04.08 - 10.5.1.2 */
-
-
-enum vlr_subscr_security_context {
- VLR_SEC_CTX_NONE,
- VLR_SEC_CTX_GSM,
- VLR_SEC_CTX_UMTS,
-};
-
-enum vlr_lu_type {
- VLR_LU_TYPE_PERIODIC,
- VLR_LU_TYPE_IMSI_ATTACH,
- VLR_LU_TYPE_REGULAR,
-};
-
-#define OSMO_LBUF_DECL(name, xlen) \
- struct { \
- uint8_t buf[xlen]; \
- size_t len; \
- } name
-
-struct sgsn_mm_ctx;
-struct vlr_instance;
-
-#define VLR_NAME_LENGTH 160
-
-/* The VLR subscriber is the part of the GSM subscriber state in VLR (CS) or
- * SGSN (PS), particularly while interacting with the HLR via GSUP */
-struct vlr_subscr {
- struct llist_head list;
- struct vlr_instance *vlr;
-
- /* TODO either populate from HLR or drop this completely? */
- long long unsigned int id;
-
- /* Data from HLR */ /* 3GPP TS 23.008 */
- /* Always use vlr_subscr_set_imsi() to write to imsi[] */
- char imsi[GSM23003_IMSI_MAX_DIGITS+1]; /* 2.1.1.1 */
- char msisdn[GSM23003_MSISDN_MAX_DIGITS+1]; /* 2.1.2 */
- char name[VLR_NAME_LENGTH+1]; /* proprietary */
- OSMO_LBUF_DECL(hlr, 16); /* 2.4.7 */
- uint32_t age_indicator; /* 2.17.1 */
-
- /* Authentication Data */
- struct vlr_auth_tuple auth_tuples[5]; /* 2.3.1-2.3.4 */
- struct vlr_auth_tuple *last_tuple;
- enum vlr_subscr_security_context sec_ctx;
-
- /* Data local to VLR is below */
- uint32_t tmsi; /* 2.1.4 */
- /* Newly allocated TMSI that was not yet acked by MS */
- uint32_t tmsi_new;
-
- struct osmo_cell_global_id cgi; /* 2.4.16 */
-
- char imeisv[GSM23003_IMEISV_NUM_DIGITS+1]; /* 2.2.3 */
- char imei[GSM23003_IMEI_NUM_DIGITS_NO_CHK+1]; /* 2.1.9 */
- bool imsi_detached_flag; /* 2.7.1 */
- bool conf_by_radio_contact_ind; /* 2.7.4.1 */
- bool sub_dataconf_by_hlr_ind; /* 2.7.4.2 */
- bool loc_conf_in_hlr_ind; /* 2.7.4.3 */
- bool dormant_ind; /* 2.7.8 */
- bool cancel_loc_rx; /* 2.7.8A */
- bool ms_not_reachable_flag; /* 2.10.2 (MNRF) */
- bool la_allowed;
-
- struct osmo_use_count use_count;
- struct osmo_use_count_entry use_count_buf[8];
- int32_t max_total_use_count;
-
- 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;
-
- void *msc_conn_ref;
-
- /* PS (SGSN) specific parts */
- struct {
- struct llist_head pdp_list;
- } ps;
- /* CS (NITB/CSCN) specific parts */
- struct {
- /* pending requests */
- bool is_paging;
- struct osmo_timer_list paging_response_timer;
- /* list of struct subscr_request */
- struct llist_head requests;
- 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;
- bool last_eutran_plmn_present;
- struct osmo_plmn_id last_eutran_plmn;
- } sgs;
-
- struct osmo_gsm48_classmark classmark;
-};
-
-enum vlr_ciph {
- VLR_CIPH_NONE = 0, /*< A5/0, no encryption */
- VLR_CIPH_A5_1 = 1, /*< A5/1, encryption */
- VLR_CIPH_A5_2 = 2, /*< A5/2, deprecated export-grade encryption */
- VLR_CIPH_A5_3 = 3, /*< A5/3, 'new secure' encryption */
-};
-
-static inline uint8_t vlr_ciph_to_gsm0808_alg_id(enum vlr_ciph ciph)
-{
- switch (ciph) {
- case VLR_CIPH_NONE:
- return GSM0808_ALG_ID_A5_0;
- case VLR_CIPH_A5_1:
- return GSM0808_ALG_ID_A5_1;
- case VLR_CIPH_A5_2:
- return GSM0808_ALG_ID_A5_2;
- case VLR_CIPH_A5_3:
- return GSM0808_ALG_ID_A5_3;
- default:
- return GSM0808_ALG_ID_A5_7;
- }
-}
-
-struct vlr_ops {
- /* encode + transmit an AUTH REQ towards the MS.
- * \param[in] at auth tuple providing rand, key_seq and autn.
- * \param[in] send_autn True to send AUTN, for r99 UMTS auth.
- */
- int (*tx_auth_req)(void *msc_conn_ref, struct vlr_auth_tuple *at,
- bool send_autn);
- /* encode + transmit an AUTH REJECT towards the MS */
- int (*tx_auth_rej)(void *msc_conn_ref);
-
- /* encode + transmit an IDENTITY REQUEST towards the MS */
- int (*tx_id_req)(void *msc_conn_ref, uint8_t mi_type);
-
- int (*tx_lu_acc)(void *msc_conn_ref, uint32_t send_tmsi);
- int (*tx_lu_rej)(void *msc_conn_ref, enum gsm48_reject_value cause);
- int (*tx_cm_serv_acc)(void *msc_conn_ref, enum osmo_cm_service_type cm_service_type);
- int (*tx_cm_serv_rej)(void *msc_conn_ref, enum osmo_cm_service_type cm_service_type,
- enum gsm48_reject_value cause);
-
- int (*set_ciph_mode)(void *msc_conn_ref, bool umts_aka, bool retrieve_imeisv);
-
- int (*tx_common_id)(void *msc_conn_ref);
-
- int (*tx_mm_info)(void *msc_conn_ref);
-
- /* notify MSC/SGSN that the subscriber data in VLR has been updated */
- void (*subscr_update)(struct vlr_subscr *vsub);
- /* notify MSC/SGSN that the given subscriber has been associated
- * with this msc_conn_ref */
- int (*subscr_assoc)(void *msc_conn_ref, struct vlr_subscr *vsub);
- /* notify MSC that the given subscriber is no longer valid */
- void (*subscr_inval)(void *msc_conn_ref, struct vlr_subscr *vsub);
-};
-
-/* An instance of the VLR codebase */
-struct vlr_instance {
- struct llist_head subscribers;
- struct llist_head operations;
- struct gsup_client_mux *gcm;
- struct vlr_ops ops;
- struct osmo_timer_list lu_expire_timer;
- struct {
- bool retrieve_imeisv_early;
- bool retrieve_imeisv_ciphered;
- bool assign_tmsi;
- bool check_imei_rqd;
- int auth_tuple_max_reuse_count;
- bool auth_reuse_old_sets_on_error;
- bool parq_retrieve_imsi;
- bool is_ps;
- uint8_t nri_bitlen;
- struct osmo_nri_ranges *nri_ranges;
- } cfg;
- struct osmo_stat_item_group *statg;
- struct rate_ctr_group *ctrg;
- /* A free-form pointer for use by the caller */
- void *user_ctx;
-};
-
-extern const struct value_string vlr_ciph_names[];
-static inline const char *vlr_ciph_name(enum vlr_ciph val)
-{
- return get_value_string(vlr_ciph_names, val);
-}
-
-/* Location Updating request */
-struct osmo_fsm_inst *
-vlr_loc_update(struct osmo_fsm_inst *parent,
- uint32_t parent_event_success,
- uint32_t parent_event_failure,
- void *parent_event_data,
- struct vlr_instance *vlr, void *msc_conn_ref,
- enum vlr_lu_type type, uint32_t tmsi, const char *imsi,
- const struct osmo_location_area_id *old_lai,
- const struct osmo_location_area_id *new_lai,
- bool authentication_required,
- bool is_ciphering_to_be_attempted,
- bool is_ciphering_required,
- uint8_t key_seq,
- bool is_r99, bool is_utran,
- bool assign_tmsi);
-
-void vlr_loc_update_cancel(struct osmo_fsm_inst *fi,
- enum osmo_fsm_term_cause fsm_cause,
- uint8_t gsm48_cause);
-
-/* tell the VLR that the RAN connection is gone */
-int vlr_subscr_disconnected(struct vlr_subscr *vsub);
-bool vlr_subscr_expire(struct vlr_subscr *vsub);
-int vlr_subscr_rx_id_resp(struct vlr_subscr *vsub, const struct osmo_mobile_identity *mi);
-int vlr_subscr_rx_auth_resp(struct vlr_subscr *vsub, bool is_r99, bool is_utran,
- const uint8_t *res, uint8_t res_len);
-int vlr_subscr_rx_auth_fail(struct vlr_subscr *vsub, const uint8_t *auts);
-int vlr_subscr_tx_auth_fail_rep(const struct vlr_subscr *vsub) __attribute__((warn_unused_result));
-void vlr_subscr_rx_ciph_res(struct vlr_subscr *vsub, enum vlr_ciph_result_cause result);
-int vlr_subscr_rx_tmsi_reall_compl(struct vlr_subscr *vsub);
-int vlr_subscr_rx_imsi_detach(struct vlr_subscr *vsub);
-
-struct vlr_instance *vlr_alloc(void *ctx, const struct vlr_ops *ops);
-int vlr_start(struct vlr_instance *vlr, struct gsup_client_mux *gcm);
-int vlr_gsup_rx(struct gsup_client_mux *gcm, void *data, const struct osmo_gsup_message *gsup_msg);
-
-/* internal use only */
-
-void sub_pres_vlr_fsm_start(struct osmo_fsm_inst **fsm,
- struct osmo_fsm_inst *parent,
- struct vlr_subscr *vsub,
- uint32_t term_event);
-struct osmo_fsm_inst *
-upd_hlr_vlr_proc_start(struct osmo_fsm_inst *parent,
- struct vlr_subscr *vsub,
- uint32_t parent_event);
-
-struct osmo_fsm_inst *
-lu_compl_vlr_proc_start(struct osmo_fsm_inst *parent,
- struct vlr_subscr *vsub,
- void *msc_conn_ref,
- uint32_t parent_event_success,
- uint32_t parent_event_failure);
-
-
-const char *vlr_subscr_name(const struct vlr_subscr *vsub);
-const char *vlr_subscr_short_name(const struct vlr_subscr *vsub, unsigned int maxlen);
-const char *vlr_subscr_msisdn_or_name(const struct vlr_subscr *vsub);
-
-#define vlr_subscr_find_by_imsi(vlr, imsi, USE) \
- _vlr_subscr_find_by_imsi(vlr, imsi, USE, __FILE__, __LINE__)
-#define vlr_subscr_find_or_create_by_imsi(vlr, imsi, USE, created) \
- _vlr_subscr_find_or_create_by_imsi(vlr, imsi, USE, created, \
- __FILE__, __LINE__)
-
-#define vlr_subscr_find_by_tmsi(vlr, tmsi, USE) \
- _vlr_subscr_find_by_tmsi(vlr, tmsi, USE, __FILE__, __LINE__)
-#define vlr_subscr_find_or_create_by_tmsi(vlr, tmsi, USE, created) \
- _vlr_subscr_find_or_create_by_tmsi(vlr, tmsi, USE, created, \
- __FILE__, __LINE__)
-
-#define vlr_subscr_find_by_msisdn(vlr, msisdn, USE) \
- _vlr_subscr_find_by_msisdn(vlr, msisdn, USE, __FILE__, __LINE__)
-
-#define vlr_subscr_find_by_mi(vlr, mi, USE) \
- _vlr_subscr_find_by_mi(vlr, mi, USE, __FILE__, __LINE__)
-
-struct vlr_subscr *_vlr_subscr_find_by_imsi(struct vlr_instance *vlr,
- const char *imsi,
- const char *use,
- const char *file, int line);
-struct vlr_subscr *_vlr_subscr_find_or_create_by_imsi(struct vlr_instance *vlr,
- const char *imsi,
- const char *use,
- bool *created,
- const char *file,
- int line);
-
-struct vlr_subscr *_vlr_subscr_find_by_tmsi(struct vlr_instance *vlr,
- uint32_t tmsi,
- const char *use,
- const char *file, int line);
-struct vlr_subscr *_vlr_subscr_find_or_create_by_tmsi(struct vlr_instance *vlr,
- uint32_t tmsi,
- const char *use,
- bool *created,
- const char *file,
- int line);
-
-struct vlr_subscr *_vlr_subscr_find_by_msisdn(struct vlr_instance *vlr,
- const char *msisdn,
- const char *use,
- const char *file, int line);
-
-struct vlr_subscr *_vlr_subscr_find_by_mi(struct vlr_instance *vlr,
- const struct osmo_mobile_identity *mi,
- const char *use,
- const char *file, int line);
-
-#define vlr_subscr_get(VSUB, USE) vlr_subscr_get_src(VSUB, USE, __FILE__, __LINE__)
-#define vlr_subscr_put(VSUB, USE) vlr_subscr_put_src(VSUB, USE, __FILE__, __LINE__)
-
-#define vlr_subscr_get_src(VSUB, USE, SRCFILE, SRCLINE) \
- OSMO_ASSERT((VSUB) && _osmo_use_count_get_put(&(VSUB)->use_count, USE, 1, SRCFILE, SRCLINE) == 0)
-#define vlr_subscr_put_src(VSUB, USE, SRCFILE, SRCLINE) \
- OSMO_ASSERT((VSUB) && _osmo_use_count_get_put(&(VSUB)->use_count, USE, -1, SRCFILE, SRCLINE) == 0)
-
-void vlr_subscr_free(struct vlr_subscr *vsub);
-int vlr_subscr_alloc_tmsi(struct vlr_subscr *vsub);
-
-void vlr_subscr_set_imsi(struct vlr_subscr *vsub, const char *imsi);
-void vlr_subscr_set_imei(struct vlr_subscr *vsub, const char *imei);
-void vlr_subscr_set_imeisv(struct vlr_subscr *vsub, const char *imeisv);
-void vlr_subscr_set_msisdn(struct vlr_subscr *vsub, const char *msisdn);
-void vlr_subscr_set_last_used_eutran_plmn_id(struct vlr_subscr *vsub,
- const struct osmo_plmn_id *last_eutran_plmn);
-
-bool vlr_subscr_matches_imsi(struct vlr_subscr *vsub, const char *imsi);
-bool vlr_subscr_matches_tmsi(struct vlr_subscr *vsub, uint32_t tmsi);
-bool vlr_subscr_matches_msisdn(struct vlr_subscr *vsub, const char *msisdn);
-bool vlr_subscr_matches_imei(struct vlr_subscr *vsub, const char *imei);
-
-uint32_t vlr_timer(struct vlr_instance *vlr, uint32_t timer);
-
-int vlr_subscr_changed(struct vlr_subscr *vsub);
-int vlr_subscr_purge(struct vlr_subscr *vsub) __attribute__((warn_unused_result));
-void vlr_subscr_cancel_attach_fsm(struct vlr_subscr *vsub,
- enum osmo_fsm_term_cause fsm_cause,
- uint8_t gsm48_cause);
-
-void vlr_subscr_enable_expire_lu(struct vlr_subscr *vsub);
-
-/* Process Access Request FSM */
-
-enum proc_arq_vlr_event {
- PR_ARQ_E_START,
- PR_ARQ_E_ID_IMSI,
- PR_ARQ_E_AUTH_RES,
- PR_ARQ_E_AUTH_NO_INFO,
- PR_ARQ_E_AUTH_FAILURE,
- PR_ARQ_E_CIPH_RES,
- PR_ARQ_E_UPD_LOC_RES,
- PR_ARQ_E_TRACE_RES,
- PR_ARQ_E_IMEI_RES,
- PR_ARQ_E_PRES_RES,
- PR_ARQ_E_TMSI_ACK,
-};
-
-enum vlr_parq_type {
- VLR_PR_ARQ_T_INVALID = 0, /* to guard against unset vars */
- VLR_PR_ARQ_T_CM_SERV_REQ,
- VLR_PR_ARQ_T_PAGING_RESP,
- VLR_PR_ARQ_T_CM_RE_ESTABLISH_REQ,
- /* FIXME: differentiate between services of 24.008 10.5.3.3 */
-};
-
-/* Process Access Request (CM SERV REQ / PAGING RESP) */
-void
-vlr_proc_acc_req(struct osmo_fsm_inst *parent,
- uint32_t parent_event_success,
- uint32_t parent_event_failure,
- void *parent_event_data,
- struct vlr_instance *vlr, void *msc_conn_ref,
- enum vlr_parq_type type, enum osmo_cm_service_type cm_service_type,
- const struct osmo_mobile_identity *mi,
- const struct osmo_location_area_id *lai,
- bool authentication_required,
- bool is_ciphering_to_be_attempted,
- bool is_ciphering_required,
- uint8_t key_seq,
- bool is_r99, bool is_utran);
-
-void vlr_parq_cancel(struct osmo_fsm_inst *fi,
- enum osmo_fsm_term_cause fsm_cause,
- enum gsm48_reject_value gsm48_cause);
-
-void vlr_parq_fsm_init(void);
-
-int vlr_set_ciph_mode(struct vlr_instance *vlr,
- struct osmo_fsm_inst *fi,
- void *msc_conn_ref,
- bool umts_aka,
- bool retrieve_imeisv);
-
-bool vlr_use_umts_aka(struct osmo_auth_vector *vec, bool is_r99);
-
-void log_set_filter_vlr_subscr(struct log_target *target,
- struct vlr_subscr *vlr_subscr);
-
-void vlr_gmm_cause_to_mm_cause(enum gsm48_gmm_cause gmm_cause,
- enum gsm48_reject_value *gsm48_rej_p);
diff --git a/include/osmocom/msc/vlr_sgs.h b/include/osmocom/msc/vlr_sgs.h
deleted file mode 100644
index 7193fa5..0000000
--- a/include/osmocom/msc/vlr_sgs.h
+++ /dev/null
@@ -1,111 +0,0 @@
-/* (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;
-
-#define VSUB_USE_SGS_LU "SGs-lu"
-#define VSUB_USE_SGS_PAGING_REQ "SGs-paging-req"
-
-/* 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_LA_UPD_PRES,
- SGS_UE_ST_ASSOCIATED,
-};
-
-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_counter_names, Ns);
-}
-
-/* This callback function is called when an SGs location update is complete */
-struct sgs_lu_response {
- bool accepted;
- bool error;
- 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 or when a paging expired */
-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, struct osmo_plmn_id *last_eutran_plmn);
-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);