| #ifndef _GSM_DATA_H |
| #define _GSM_DATA_H |
| |
| #include <stdint.h> |
| #include <regex.h> |
| #include <sys/types.h> |
| #include <stdbool.h> |
| |
| #include <osmocom/core/timer.h> |
| #include <osmocom/core/rate_ctr.h> |
| #include <osmocom/core/select.h> |
| #include <osmocom/core/stats.h> |
| |
| #include <osmocom/crypt/auth.h> |
| |
| #include <openbsc/rest_octets.h> |
| |
| /** annotations for msgb ownership */ |
| #define __uses |
| |
| #define OBSC_NM_W_ACK_CB(__msgb) (__msgb)->cb[3] |
| |
| struct mncc_sock_state; |
| struct gsm_subscriber_group; |
| |
| #define OBSC_LINKID_CB(__msgb) (__msgb)->cb[3] |
| |
| enum gsm_security_event { |
| GSM_SECURITY_NOAVAIL, |
| GSM_SECURITY_AUTH_FAILED, |
| GSM_SECURITY_SUCCEEDED, |
| GSM_SECURITY_ALREADY, |
| }; |
| |
| struct msgb; |
| typedef int gsm_cbfn(unsigned int hooknum, |
| unsigned int event, |
| struct msgb *msg, |
| void *data, void *param); |
| |
| /* Real authentication information containing Ki */ |
| enum gsm_auth_algo { |
| AUTH_ALGO_NONE, |
| AUTH_ALGO_XOR, |
| AUTH_ALGO_COMP128v1, |
| }; |
| |
| struct gsm_auth_info { |
| enum gsm_auth_algo auth_algo; |
| unsigned int a3a8_ki_len; |
| uint8_t a3a8_ki[16]; |
| }; |
| |
| struct gsm_auth_tuple { |
| int use_count; |
| int key_seq; |
| struct osmo_auth_vector vec; |
| }; |
| #define GSM_KEY_SEQ_INVAL 7 /* GSM 04.08 - 10.5.1.2 */ |
| |
| /* |
| * LOCATION UPDATING REQUEST state |
| * |
| * Our current operation is: |
| * - Get imei/tmsi |
| * - Accept/Reject according to global policy |
| */ |
| struct gsm_loc_updating_operation { |
| struct osmo_timer_list updating_timer; |
| unsigned int waiting_for_imsi : 1; |
| unsigned int waiting_for_imei : 1; |
| unsigned int key_seq : 4; |
| }; |
| |
| /* |
| * AUTHENTICATION/CIPHERING state |
| */ |
| struct gsm_security_operation { |
| struct gsm_auth_tuple atuple; |
| gsm_cbfn *cb; |
| void *cb_data; |
| }; |
| |
| /* |
| * A dummy to keep a connection up for at least |
| * a couple of seconds to work around MSC issues. |
| */ |
| struct gsm_anchor_operation { |
| struct osmo_timer_list timeout; |
| }; |
| |
| /* Maximum number of neighbor cells whose average we track */ |
| #define MAX_NEIGH_MEAS 10 |
| /* Maximum size of the averaging window for neighbor cells */ |
| #define MAX_WIN_NEIGH_AVG 10 |
| |
| /* processed neighbor measurements for one cell */ |
| struct neigh_meas_proc { |
| uint16_t arfcn; |
| uint8_t bsic; |
| uint8_t rxlev[MAX_WIN_NEIGH_AVG]; |
| unsigned int rxlev_cnt; |
| uint8_t last_seen_nr; |
| }; |
| |
| /* the per subscriber data for lchan */ |
| struct gsm_subscriber_connection { |
| struct llist_head entry; |
| |
| /* To whom we are allocated at the moment */ |
| struct gsm_subscriber *subscr; |
| |
| /* LU expiration handling */ |
| uint8_t expire_timer_stopped; |
| /* SMS helpers for libmsc */ |
| uint8_t next_rp_ref; |
| |
| /* |
| * Operations that have a state and might be pending |
| */ |
| struct gsm_loc_updating_operation *loc_operation; |
| struct gsm_security_operation *sec_operation; |
| struct gsm_anchor_operation *anch_operation; |
| |
| /* Are we part of a special "silent" call */ |
| int silent_call; |
| |
| /* MNCC rtp bridge markers */ |
| int mncc_rtp_bridge; |
| int mncc_rtp_create_pending; |
| int mncc_rtp_connect_pending; |
| |
| /* bsc structures */ |
| struct osmo_bsc_sccp_con *sccp_con; |
| |
| /* back pointers */ |
| int in_release; |
| struct gsm_lchan *lchan; |
| struct gsm_lchan *ho_lchan; |
| struct gsm_bts *bts; |
| |
| /* for assignment handling */ |
| struct osmo_timer_list T10; |
| struct gsm_lchan *secondary_lchan; |
| |
| }; |
| |
| |
| #define ROLE_BSC |
| #include "gsm_data_shared.h" |
| |
| |
| /* Some statistics of our network */ |
| enum { |
| MSC_CTR_CHREQ_TOTAL, |
| MSC_CTR_CHREQ_NO_CHANNEL, |
| MSC_CTR_HANDOVER_ATTEMPTED, |
| MSC_CTR_HANDOVER_NO_CHANNEL, |
| MSC_CTR_HANDOVER_TIMEOUT, |
| MSC_CTR_HANDOVER_COMPLETED, |
| MSC_CTR_HANDOVER_FAILED, |
| MSC_CTR_LOC_UPDATE_TYPE_ATTACH, |
| MSC_CTR_LOC_UPDATE_TYPE_NORMAL, |
| MSC_CTR_LOC_UPDATE_TYPE_PERIODIC, |
| MSC_CTR_LOC_UPDATE_TYPE_DETACH, |
| MSC_CTR_LOC_UPDATE_RESP_REJECT, |
| MSC_CTR_LOC_UPDATE_RESP_ACCEPT, |
| MSC_CTR_PAGING_ATTEMPTED, |
| MSC_CTR_PAGING_DETACHED, |
| MSC_CTR_PAGING_COMPLETED, |
| MSC_CTR_PAGING_EXPIRED, |
| MSC_CTR_SMS_SUBMITTED, |
| MSC_CTR_SMS_NO_RECEIVER, |
| MSC_CTR_SMS_DELIVERED, |
| MSC_CTR_SMS_RP_ERR_MEM, |
| MSC_CTR_SMS_RP_ERR_OTHER, |
| MSC_CTR_CALL_MO_SETUP, |
| MSC_CTR_CALL_MO_CONNECT_ACK, |
| MSC_CTR_CALL_MT_SETUP, |
| MSC_CTR_CALL_MT_CONNECT, |
| MSC_CTR_CHAN_RF_FAIL, |
| MSC_CTR_CHAN_RLL_ERR, |
| MSC_CTR_BTS_OML_FAIL, |
| MSC_CTR_BTS_RSL_FAIL, |
| }; |
| |
| static const struct rate_ctr_desc msc_ctr_description[] = { |
| [MSC_CTR_CHREQ_TOTAL] = {"chreq.total", "Received channel requests."}, |
| [MSC_CTR_CHREQ_NO_CHANNEL] = {"chreq.no_channel", "Sent to MS no channel available."}, |
| [MSC_CTR_HANDOVER_ATTEMPTED] = {"handover.attempted", "Received handover attempts."}, |
| [MSC_CTR_HANDOVER_NO_CHANNEL] = {"handover.no_channel", "Sent no channel available responses."}, |
| [MSC_CTR_HANDOVER_TIMEOUT] = {"handover.timeout", "Count the amount of timeouts of timer T3103."}, |
| [MSC_CTR_HANDOVER_COMPLETED] = {"handover.completed", "Received handover completed."}, |
| [MSC_CTR_HANDOVER_FAILED] = {"handover.failed", "Receive HO FAIL messages."}, |
| [MSC_CTR_LOC_UPDATE_TYPE_ATTACH] = {"loc_update_type.attach", "Received location update imsi attach requests."}, |
| [MSC_CTR_LOC_UPDATE_TYPE_NORMAL] = {"loc_update_type.normal", "Received location update normal requests."}, |
| [MSC_CTR_LOC_UPDATE_TYPE_PERIODIC] = {"loc_update_type.periodic", "Received location update periodic requests."}, |
| [MSC_CTR_LOC_UPDATE_TYPE_DETACH] = {"loc_update_type.detach", "Received location update detach indication."}, |
| [MSC_CTR_LOC_UPDATE_RESP_REJECT] = {"loc_update_resp.reject", "Sent location update reject responses."}, |
| [MSC_CTR_LOC_UPDATE_RESP_ACCEPT] = {"loc_update_resp.accept", "Sent location update accept responses."}, |
| [MSC_CTR_PAGING_ATTEMPTED] = {"paging.attempted", "Paging attempts for a MS."}, |
| [MSC_CTR_PAGING_DETACHED] = {"paging.detached", "Counts the amount of paging attempts which couldn't sent out any paging request because no responsible bts found."}, |
| [MSC_CTR_PAGING_COMPLETED] = {"paging.completed", "Paging successful completed."}, |
| [MSC_CTR_PAGING_EXPIRED] = {"paging.expired", "Paging Request expired because of timeout T3113."}, |
| [MSC_CTR_SMS_SUBMITTED] = {"sms.submitted", "Received a RPDU from a MS (MO)."}, |
| [MSC_CTR_SMS_NO_RECEIVER] = {"sms.no_receiver", "Counts SMS which couldn't routed because no receiver found."}, |
| [MSC_CTR_SMS_DELIVERED] = {"sms.delivered", "Global SMS Deliver attempts."}, |
| [MSC_CTR_SMS_RP_ERR_MEM] = {"sms.rp_err_mem", "CAUSE_MT_MEM_EXCEEDED errors of MS responses on a sms deliver attempt."}, |
| [MSC_CTR_SMS_RP_ERR_OTHER] = {"sms.rp_err_other", "Other error of MS responses on a sms delive attempt."}, |
| /* FIXME: count also sms delivered */ |
| [MSC_CTR_CALL_MO_SETUP] = {"call.mo_setup", "Received setup requests from a MS to init a MO call."}, |
| [MSC_CTR_CALL_MO_CONNECT_ACK] = {"call.mo_connect_ack", "Received a connect ack from MS of a MO call. Call is now succesful connected up."}, |
| [MSC_CTR_CALL_MT_SETUP] = {"call.mt_setup", "Sent setup requests to the MS (MT)."}, |
| [MSC_CTR_CALL_MT_CONNECT] = {"call.mt_connect", "Sent a connect to the MS (MT)."}, |
| [MSC_CTR_CHAN_RF_FAIL] = {"chan.rf_fail", "Received a RF failure indication from BTS."}, |
| [MSC_CTR_CHAN_RLL_ERR] = {"chan.rll_err", "Received a RLL failure with T200 cause from BTS."}, |
| [MSC_CTR_BTS_OML_FAIL] = {"bts.oml_fail", "Received a TEI down on a OML link."}, |
| [MSC_CTR_BTS_RSL_FAIL] = {"bts.rsl_fail", "Received a TEI down on a OML link."}, |
| }; |
| |
| static const struct rate_ctr_group_desc msc_ctrg_desc = { |
| "msc", |
| "mobile switching center", |
| OSMO_STATS_CLASS_GLOBAL, |
| ARRAY_SIZE(msc_ctr_description), |
| msc_ctr_description, |
| }; |
| |
| enum gsm_auth_policy { |
| GSM_AUTH_POLICY_CLOSED, /* only subscribers authorized in DB */ |
| GSM_AUTH_POLICY_ACCEPT_ALL, /* accept everyone, even if not authorized in DB */ |
| GSM_AUTH_POLICY_TOKEN, /* accept first, send token per sms, then revoke authorization */ |
| GSM_AUTH_POLICY_REGEXP, /* accept IMSIs matching given regexp */ |
| }; |
| |
| #define GSM_T3101_DEFAULT 10 |
| #define GSM_T3105_DEFAULT 40 |
| #define GSM_T3113_DEFAULT 60 |
| #define GSM_T3122_DEFAULT 10 |
| |
| struct gsm_network { |
| /* global parameters */ |
| uint16_t country_code; |
| uint16_t network_code; |
| char *name_long; |
| char *name_short; |
| enum gsm_auth_policy auth_policy; |
| regex_t authorized_regexp; |
| char *authorized_reg_str; |
| enum gsm48_reject_value reject_cause; |
| int a5_encryption; |
| int neci; |
| int send_mm_info; |
| struct { |
| int active; |
| /* Window RXLEV averaging */ |
| unsigned int win_rxlev_avg; /* number of SACCH frames */ |
| /* Window RXQUAL averaging */ |
| unsigned int win_rxqual_avg; /* number of SACCH frames */ |
| /* Window RXLEV neighbouring cells averaging */ |
| unsigned int win_rxlev_avg_neigh; /* number of SACCH frames */ |
| |
| /* how often should we check for power budget HO */ |
| unsigned int pwr_interval; /* SACCH frames */ |
| /* how much better does a neighbor cell have to be ? */ |
| unsigned int pwr_hysteresis; /* dBm */ |
| /* maximum distacne before we try a handover */ |
| unsigned int max_distance; /* TA values */ |
| } handover; |
| |
| struct rate_ctr_group *ratectrs; |
| |
| |
| /* layer 4 */ |
| struct mncc_sock_state *mncc_state; |
| int (*mncc_recv) (struct gsm_network *net, struct msgb *msg); |
| struct llist_head upqueue; |
| struct llist_head trans_list; |
| struct bsc_api *bsc_api; |
| |
| unsigned int num_bts; |
| struct llist_head bts_list; |
| |
| /* timer values */ |
| int T3101; |
| int T3103; |
| int T3105; |
| int T3107; |
| int T3109; |
| int T3111; |
| int T3113; |
| int T3115; |
| int T3117; |
| int T3119; |
| int T3122; |
| int T3141; |
| |
| /* timer to expire old location updates */ |
| struct osmo_timer_list subscr_expire_timer; |
| |
| /* Radio Resource Location Protocol (TS 04.31) */ |
| struct { |
| enum rrlp_mode mode; |
| } rrlp; |
| |
| enum gsm_chan_t ctype_by_chreq[16]; |
| |
| /* Use a TCH for handling requests of type paging any */ |
| int pag_any_tch; |
| |
| /* MSC data in case we are a true BSC */ |
| struct osmo_bsc_data *bsc_data; |
| |
| /* subscriber related features */ |
| bool auto_create_subscr; |
| bool auto_assign_exten; |
| uint64_t ext_min; |
| uint64_t ext_max; |
| struct gsm_subscriber_group *subscr_group; |
| struct gsm_sms_queue *sms_queue; |
| |
| /* nitb related control */ |
| int avoid_tmsi; |
| |
| /* control interface */ |
| struct ctrl_handle *ctrl; |
| |
| /* Allow or disallow TCH/F on dynamic TCH/F_TCH/H_PDCH; OS#1778 */ |
| bool dyn_ts_allow_tch_f; |
| /* TODO: vty for this; related: OS#1781 */ |
| }; |
| |
| struct osmo_esme; |
| |
| enum gsm_sms_source_id { |
| SMS_SOURCE_UNKNOWN = 0, |
| SMS_SOURCE_MS, /* received from MS */ |
| SMS_SOURCE_VTY, /* received from VTY */ |
| SMS_SOURCE_SMPP, /* received via SMPP */ |
| }; |
| |
| #define SMS_HDR_SIZE 128 |
| #define SMS_TEXT_SIZE 256 |
| |
| struct gsm_sms_addr { |
| uint8_t ton; |
| uint8_t npi; |
| char addr[21+1]; |
| }; |
| |
| struct gsm_sms { |
| unsigned long long id; |
| struct gsm_subscriber *receiver; |
| struct gsm_sms_addr src, dst; |
| enum gsm_sms_source_id source; |
| |
| struct { |
| struct osmo_esme *esme; |
| uint32_t sequence_nr; |
| int transaction_mode; |
| char msg_id[16]; |
| } smpp; |
| |
| unsigned long validity_minutes; |
| uint8_t reply_path_req; |
| uint8_t status_rep_req; |
| uint8_t ud_hdr_ind; |
| uint8_t protocol_id; |
| uint8_t data_coding_scheme; |
| uint8_t msg_ref; |
| uint8_t user_data_len; |
| uint8_t user_data[SMS_TEXT_SIZE]; |
| |
| char text[SMS_TEXT_SIZE]; |
| }; |
| |
| struct gsm_network *gsm_network_init(uint16_t country_code, uint16_t network_code, |
| int (*mncc_recv)(struct gsm_network *, struct msgb *)); |
| int gsm_set_bts_type(struct gsm_bts *bts, enum gsm_bts_type type); |
| |
| /* Get reference to a neighbor cell on a given BCCH ARFCN */ |
| struct gsm_bts *gsm_bts_neighbor(const struct gsm_bts *bts, |
| uint16_t arfcn, uint8_t bsic); |
| |
| enum gsm_bts_type parse_btstype(const char *arg); |
| const char *btstype2str(enum gsm_bts_type type); |
| struct gsm_bts *gsm_bts_by_lac(struct gsm_network *net, unsigned int lac, |
| struct gsm_bts *start_bts); |
| |
| extern void *tall_bsc_ctx; |
| extern int ipacc_rtp_direct; |
| |
| /* this actaully refers to the IPA transport, not the BTS model */ |
| static inline int is_ipaccess_bts(struct gsm_bts *bts) |
| { |
| switch (bts->type) { |
| case GSM_BTS_TYPE_NANOBTS: |
| case GSM_BTS_TYPE_OSMO_SYSMO: |
| return 1; |
| default: |
| break; |
| } |
| return 0; |
| } |
| |
| static inline int is_sysmobts_v2(struct gsm_bts *bts) |
| { |
| switch (bts->type) { |
| case GSM_BTS_TYPE_OSMO_SYSMO: |
| return 1; |
| default: |
| break; |
| } |
| return 0; |
| } |
| |
| static inline int is_siemens_bts(struct gsm_bts *bts) |
| { |
| switch (bts->type) { |
| case GSM_BTS_TYPE_BS11: |
| return 1; |
| default: |
| break; |
| } |
| |
| return 0; |
| } |
| |
| static inline int is_nokia_bts(struct gsm_bts *bts) |
| { |
| switch (bts->type) { |
| case GSM_BTS_TYPE_NOKIA_SITE: |
| return 1; |
| default: |
| break; |
| } |
| |
| return 0; |
| } |
| |
| static inline int is_e1_bts(struct gsm_bts *bts) |
| { |
| switch (bts->type) { |
| case GSM_BTS_TYPE_BS11: |
| case GSM_BTS_TYPE_RBS2000: |
| case GSM_BTS_TYPE_NOKIA_SITE: |
| return 1; |
| default: |
| break; |
| } |
| |
| return 0; |
| } |
| |
| enum gsm_auth_policy gsm_auth_policy_parse(const char *arg); |
| const char *gsm_auth_policy_name(enum gsm_auth_policy policy); |
| |
| enum rrlp_mode rrlp_mode_parse(const char *arg); |
| const char *rrlp_mode_name(enum rrlp_mode mode); |
| |
| enum bts_gprs_mode bts_gprs_mode_parse(const char *arg, int *valid); |
| const char *bts_gprs_mode_name(enum bts_gprs_mode mode); |
| int bts_gprs_mode_is_compat(struct gsm_bts *bts, enum bts_gprs_mode mode); |
| |
| int gsm48_ra_id_by_bts(uint8_t *buf, struct gsm_bts *bts); |
| void gprs_ra_id_by_bts(struct gprs_ra_id *raid, struct gsm_bts *bts); |
| struct gsm_meas_rep *lchan_next_meas_rep(struct gsm_lchan *lchan); |
| |
| int gsm_btsmodel_set_feature(struct gsm_bts_model *model, enum gsm_bts_features feat); |
| int gsm_bts_model_register(struct gsm_bts_model *model); |
| |
| struct gsm_subscriber_connection *subscr_con_allocate(struct gsm_lchan *lchan); |
| void subscr_con_free(struct gsm_subscriber_connection *conn); |
| |
| struct gsm_bts *gsm_bts_alloc_register(struct gsm_network *net, |
| enum gsm_bts_type type, |
| uint8_t bsic); |
| |
| void set_ts_e1link(struct gsm_bts_trx_ts *ts, uint8_t e1_nr, |
| uint8_t e1_ts, uint8_t e1_ts_ss); |
| |
| void gsm_trx_lock_rf(struct gsm_bts_trx *trx, int locked); |
| int gsm_bts_has_feature(struct gsm_bts *bts, enum gsm_bts_features feat); |
| struct gsm_bts_trx *gsm_bts_trx_by_nr(struct gsm_bts *bts, int nr); |
| int gsm_bts_trx_set_system_infos(struct gsm_bts_trx *trx); |
| int gsm_bts_set_system_infos(struct gsm_bts *bts); |
| |
| /* generic E1 line operations for all ISDN-based BTS. */ |
| extern struct e1inp_line_ops bts_isdn_e1inp_line_ops; |
| |
| extern const struct value_string bts_type_names[_NUM_GSM_BTS_TYPE+1]; |
| extern const struct value_string bts_type_descs[_NUM_GSM_BTS_TYPE+1]; |
| |
| /* control interface handling */ |
| int bsc_base_ctrl_cmds_install(void); |
| int msc_ctrl_cmds_install(void); |
| |
| /* dependency handling */ |
| void bts_depend_mark(struct gsm_bts *bts, int dep); |
| void bts_depend_clear(struct gsm_bts *bts, int dep); |
| int bts_depend_check(struct gsm_bts *bts); |
| int bts_depend_is_depedency(struct gsm_bts *base, struct gsm_bts *other); |
| |
| #endif /* _GSM_DATA_H */ |