rename gsm_subscriber_connection to ran_conn
In preparation for inter-BSC and inter-MSC handover, we need to separate the
subscriber management logic from the actual RAN connections. What better time
to finally rename gsm_subscriber_connection.
* Name choice:
In 2G, this is a connection to the BSS, but even though 3GPP TS commonly talk
of "BSS-A" and "BSS-B" when explaining handover, it's not good to call it
"bss_conn": in 3G a BSS is called RNS, IIUC.
The overall term for 2G (GERAN) and 3G (UTRAN) is RAN: Radio Access Network.
* Rationale:
A subscriber in the MSC so far has only one RAN connection, but e.g. for
inter-BSC handover, a second one needs to be created to handover to. Most of
the items in the former gsm_subscriber_connection are actually related to the
RAN, with only a few MM and RTP related items. So, as a first step, just rename
it to ran_conn, to cosmetically prepare for moving the not strictly RAN related
items away later.
Also:
- Rename some functions from msc_subscr_conn_* to ran_conn_*
- Rename "Subscr_Conn" FSM instance name to "RAN_conn"
- Rename SUBSCR_CONN_* to RAN_CONN_*
Change-Id: Ic595f7a558d3553c067f77dc67543ab59659707a
diff --git a/include/osmocom/msc/osmo_msc.h b/include/osmocom/msc/osmo_msc.h
index 674de3b..38cb497 100644
--- a/include/osmocom/msc/osmo_msc.h
+++ b/include/osmocom/msc/osmo_msc.h
@@ -11,77 +11,74 @@
#define MSC_HLR_REMOTE_IP_DEFAULT "127.0.0.1"
#define MSC_HLR_REMOTE_PORT_DEFAULT OSMO_GSUP_PORT
-enum subscr_conn_fsm_event {
+enum ran_conn_fsm_event {
/* Accepted the initial Complete Layer 3 (starting to evaluate Authentication and Ciphering) */
- SUBSCR_CONN_E_COMPLETE_LAYER_3,
+ RAN_CONN_E_COMPLETE_LAYER_3,
/* Received Classmark Update, typically neede for Ciphering Mode Command */
- SUBSCR_CONN_E_CLASSMARK_UPDATE,
+ RAN_CONN_E_CLASSMARK_UPDATE,
/* LU or Process Access FSM has determined that this conn is good */
- SUBSCR_CONN_E_ACCEPTED,
+ RAN_CONN_E_ACCEPTED,
/* received first reply from MS in "real" CC, SMS, USSD communication */
- SUBSCR_CONN_E_COMMUNICATING,
+ RAN_CONN_E_COMMUNICATING,
/* Some async action has completed, check again whether all is done */
- SUBSCR_CONN_E_RELEASE_WHEN_UNUSED,
+ RAN_CONN_E_RELEASE_WHEN_UNUSED,
/* MS/BTS/BSC originated close request */
- SUBSCR_CONN_E_MO_CLOSE,
+ RAN_CONN_E_MO_CLOSE,
/* MSC originated close request, e.g. failed authentication */
- SUBSCR_CONN_E_CN_CLOSE,
+ RAN_CONN_E_CN_CLOSE,
/* The usage count for the conn has reached zero */
- SUBSCR_CONN_E_UNUSED,
+ RAN_CONN_E_UNUSED,
};
-enum subscr_conn_fsm_state {
- SUBSCR_CONN_S_NEW,
- SUBSCR_CONN_S_AUTH_CIPH,
- SUBSCR_CONN_S_WAIT_CLASSMARK_UPDATE,
- SUBSCR_CONN_S_ACCEPTED,
- SUBSCR_CONN_S_COMMUNICATING,
- SUBSCR_CONN_S_RELEASING,
- SUBSCR_CONN_S_RELEASED,
+enum ran_conn_fsm_state {
+ RAN_CONN_S_NEW,
+ RAN_CONN_S_AUTH_CIPH,
+ RAN_CONN_S_WAIT_CLASSMARK_UPDATE,
+ RAN_CONN_S_ACCEPTED,
+ RAN_CONN_S_COMMUNICATING,
+ RAN_CONN_S_RELEASING,
+ RAN_CONN_S_RELEASED,
};
-struct gsm_subscriber_connection *msc_subscr_conn_alloc(struct gsm_network *network,
- enum ran_type via_ran, uint16_t lac);
+struct ran_conn *ran_conn_alloc(struct gsm_network *network, enum ran_type via_ran, uint16_t lac);
-void msc_subscr_conn_update_id(struct gsm_subscriber_connection *conn,
- enum complete_layer3_type from, const char *id);
-char *msc_subscr_conn_get_conn_id(struct gsm_subscriber_connection *conn);
+void ran_conn_update_id(struct ran_conn *conn, enum complete_layer3_type from, const char *id);
+char *ran_conn_get_conn_id(struct ran_conn *conn);
-void msc_subscr_conn_complete_layer_3(struct gsm_subscriber_connection *conn);
+void ran_conn_complete_layer_3(struct ran_conn *conn);
int msc_vlr_alloc(struct gsm_network *net);
int msc_vlr_start(struct gsm_network *net);
-void msc_sapi_n_reject(struct gsm_subscriber_connection *conn, int dlci);
-int msc_clear_request(struct gsm_subscriber_connection *conn, uint32_t cause);
-void msc_compl_l3(struct gsm_subscriber_connection *conn,
+void msc_sapi_n_reject(struct ran_conn *conn, int dlci);
+int msc_clear_request(struct ran_conn *conn, uint32_t cause);
+void msc_compl_l3(struct ran_conn *conn,
struct msgb *msg, uint16_t chosen_channel);
-void msc_dtap(struct gsm_subscriber_connection *conn, struct msgb *msg);
-int msc_classmark_request_then_cipher_mode_cmd(struct gsm_subscriber_connection *conn, bool umts_aka,
+void msc_dtap(struct ran_conn *conn, struct msgb *msg);
+int msc_classmark_request_then_cipher_mode_cmd(struct ran_conn *conn, bool umts_aka,
bool retrieve_imeisv);
-int msc_geran_set_cipher_mode(struct gsm_subscriber_connection *conn, bool umts_aka, bool retrieve_imeisv);
-void msc_cipher_mode_compl(struct gsm_subscriber_connection *conn,
+int msc_geran_set_cipher_mode(struct ran_conn *conn, bool umts_aka, bool retrieve_imeisv);
+void msc_cipher_mode_compl(struct ran_conn *conn,
struct msgb *msg, uint8_t alg_id);
-void msc_rx_sec_mode_compl(struct gsm_subscriber_connection *conn);
-void msc_classmark_chg(struct gsm_subscriber_connection *conn,
+void msc_rx_sec_mode_compl(struct ran_conn *conn);
+void msc_classmark_chg(struct ran_conn *conn,
const uint8_t *cm2, uint8_t cm2_len,
const uint8_t *cm3, uint8_t cm3_len);
-void msc_assign_fail(struct gsm_subscriber_connection *conn,
+void msc_assign_fail(struct ran_conn *conn,
uint8_t cause, uint8_t *rr_cause);
-void msc_subscr_conn_init(void);
-bool msc_subscr_conn_is_accepted(const struct gsm_subscriber_connection *conn);
-bool msc_subscr_conn_is_establishing_auth_ciph(const struct gsm_subscriber_connection *conn);
-void msc_subscr_conn_communicating(struct gsm_subscriber_connection *conn);
-void msc_subscr_conn_close(struct gsm_subscriber_connection *conn,
- uint32_t cause);
-void msc_subscr_conn_mo_close(struct gsm_subscriber_connection *conn, uint32_t cause);
-bool msc_subscr_conn_in_release(struct gsm_subscriber_connection *conn);
+void ran_conn_init(void);
+bool ran_conn_is_accepted(const struct ran_conn *conn);
+bool ran_conn_is_establishing_auth_ciph(const struct ran_conn *conn);
+void ran_conn_communicating(struct ran_conn *conn);
+void ran_conn_close(struct ran_conn *conn, uint32_t cause);
+void ran_conn_mo_close(struct ran_conn *conn, uint32_t cause);
+bool ran_conn_in_release(struct ran_conn *conn);
-void msc_subscr_conn_rx_bssmap_clear_complete(struct gsm_subscriber_connection *conn);
-void msc_subscr_conn_rx_iu_release_complete(struct gsm_subscriber_connection *conn);
+void ran_conn_rx_bssmap_clear_complete(struct ran_conn *conn);
+void ran_conn_rx_iu_release_complete(struct ran_conn *conn);
-enum msc_subscr_conn_use {
+enum ran_conn_use {
MSC_CONN_USE_UNTRACKED = -1,
MSC_CONN_USE_COMPL_L3,
MSC_CONN_USE_DTAP,
@@ -94,23 +91,19 @@
MSC_CONN_USE_RELEASE,
};
-extern const struct value_string msc_subscr_conn_use_names[];
-static inline const char *msc_subscr_conn_use_name(enum msc_subscr_conn_use val)
-{ return get_value_string(msc_subscr_conn_use_names, val); }
+extern const struct value_string ran_conn_use_names[];
+static inline const char *ran_conn_use_name(enum ran_conn_use val)
+{ return get_value_string(ran_conn_use_names, val); }
-#define msc_subscr_conn_get(conn, balance_token) \
- _msc_subscr_conn_get(conn, balance_token, __FILE__, __LINE__)
-#define msc_subscr_conn_put(conn, balance_token) \
- _msc_subscr_conn_put(conn, balance_token, __FILE__, __LINE__)
-struct gsm_subscriber_connection *
-_msc_subscr_conn_get(struct gsm_subscriber_connection *conn,
- enum msc_subscr_conn_use balance_token,
- const char *file, int line);
-void _msc_subscr_conn_put(struct gsm_subscriber_connection *conn,
- enum msc_subscr_conn_use balance_token,
- const char *file, int line);
-bool msc_subscr_conn_used_by(struct gsm_subscriber_connection *conn,
- enum msc_subscr_conn_use token);
+#define ran_conn_get(conn, balance_token) \
+ _ran_conn_get(conn, balance_token, __FILE__, __LINE__)
+#define ran_conn_put(conn, balance_token) \
+ _ran_conn_put(conn, balance_token, __FILE__, __LINE__)
+struct ran_conn * _ran_conn_get(struct ran_conn *conn, enum ran_conn_use balance_token,
+ const char *file, int line);
+void _ran_conn_put(struct ran_conn *conn, enum ran_conn_use balance_token,
+ const char *file, int line);
+bool ran_conn_used_by(struct ran_conn *conn, enum ran_conn_use token);
void msc_stop_paging(struct vlr_subscr *vsub);