blob: 1ca3bc96783a6f01b354fcc87abbbd9d033224ef [file] [log] [blame]
Harald Welte52b1f982008-12-23 20:25:15 +00001#ifndef _GSM_DATA_H
2#define _GSM_DATA_H
3
Harald Weltef142c972011-05-24 13:25:38 +02004#include <stdint.h>
Maxddee01f2016-05-24 14:23:27 +02005#include <regex.h>
6#include <sys/types.h>
Maxe6052c42016-06-30 10:25:49 +02007#include <stdbool.h>
Harald Weltef142c972011-05-24 13:25:38 +02008
9#include <osmocom/core/timer.h>
Alexander Couzens20423ea2016-07-12 15:42:02 +020010#include <osmocom/core/rate_ctr.h>
Harald Welte6be350c2011-05-25 13:10:08 +020011#include <osmocom/core/select.h>
Alexander Couzens20423ea2016-07-12 15:42:02 +020012#include <osmocom/core/stats.h>
13
Harald Welte121e9a42016-04-20 13:13:19 +020014#include <osmocom/crypt/auth.h>
Philipp Maier39f62bb2017-04-09 12:32:51 +020015#include <osmocom/sigtran/sccp_sap.h>
Harald Weltef142c972011-05-24 13:25:38 +020016
Neels Hofmeyrc0164792017-09-04 15:15:32 +020017#include <osmocom/bsc/common.h>
18#include <osmocom/bsc/rest_octets.h>
19#include <osmocom/bsc/common_cs.h>
Harald Welteb96be392011-05-25 12:33:33 +020020
Philipp Maier39f62bb2017-04-09 12:32:51 +020021
Holger Hans Peter Freytherd7b22c62013-04-29 09:11:02 +020022/** annotations for msgb ownership */
23#define __uses
24
Holger Hans Peter Freyther6f615552010-11-15 20:50:42 +010025#define OBSC_NM_W_ACK_CB(__msgb) (__msgb)->cb[3]
26
Holger Hans Peter Freyther694c82d2011-10-26 18:37:09 +020027struct mncc_sock_state;
Jacob Erlbeck1e30a282014-12-03 09:28:24 +010028struct gsm_subscriber_group;
Neels Hofmeyr6d804b12017-02-18 22:20:46 +010029struct bsc_subscr;
Harald Weltea43e0b42016-06-19 18:06:02 +020030struct vlr_instance;
31struct vlr_subscr;
Neels Hofmeyr7b656882017-07-09 22:09:18 +020032struct gprs_ra_id;
Holger Hans Peter Freyther694c82d2011-10-26 18:37:09 +020033
Holger Hans Peter Freyther9c595b72010-06-15 11:20:52 +080034#define OBSC_LINKID_CB(__msgb) (__msgb)->cb[3]
35
Neels Hofmeyr0e5d8072017-01-10 00:49:56 +010036#define tmsi_from_string(str) strtoul(str, NULL, 10)
37
Max70fdd242017-06-15 15:10:53 +020038/* 3-bit long values */
39#define EARFCN_PRIO_INVALID 8
40#define EARFCN_MEAS_BW_INVALID 8
41/* 5-bit long values */
42#define EARFCN_QRXLV_INVALID 32
43#define EARFCN_THRESH_LOW_INVALID 32
44
Sylvain Munaut30a15382009-12-24 00:27:26 +010045enum gsm_security_event {
46 GSM_SECURITY_NOAVAIL,
47 GSM_SECURITY_AUTH_FAILED,
48 GSM_SECURITY_SUCCEEDED,
Andreas Eversberg641475c2013-07-10 08:58:03 +020049 GSM_SECURITY_ALREADY,
Sylvain Munaut30a15382009-12-24 00:27:26 +010050};
51
Harald Welte8e1e3ee2009-02-01 13:32:45 +000052struct msgb;
53typedef int gsm_cbfn(unsigned int hooknum,
54 unsigned int event,
55 struct msgb *msg,
56 void *data, void *param);
57
Holger Hans Peter Freyther02d39b22010-07-05 15:34:16 +080058/*
59 * A dummy to keep a connection up for at least
60 * a couple of seconds to work around MSC issues.
61 */
62struct gsm_anchor_operation {
Pablo Neira Ayusobf540cb2011-05-06 12:11:06 +020063 struct osmo_timer_list timeout;
Holger Hans Peter Freyther02d39b22010-07-05 15:34:16 +080064};
65
Harald Weltef7c28b02009-12-21 13:30:17 +010066/* Maximum number of neighbor cells whose average we track */
67#define MAX_NEIGH_MEAS 10
68/* Maximum size of the averaging window for neighbor cells */
69#define MAX_WIN_NEIGH_AVG 10
70
71/* processed neighbor measurements for one cell */
72struct neigh_meas_proc {
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +020073 uint16_t arfcn;
74 uint8_t bsic;
75 uint8_t rxlev[MAX_WIN_NEIGH_AVG];
Harald Weltef7c28b02009-12-21 13:30:17 +010076 unsigned int rxlev_cnt;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +020077 uint8_t last_seen_nr;
Harald Weltef7c28b02009-12-21 13:30:17 +010078};
79
Neels Hofmeyrd3270a92017-02-02 01:07:28 +010080enum ran_type {
81 RAN_UNKNOWN,
82 RAN_GERAN_A, /* 2G / A-interface */
83 RAN_UTRAN_IU, /* 3G / Iu-interface (IuCS or IuPS) */
84};
85
Neels Hofmeyrc29505e2016-05-20 21:59:55 +020086extern const struct value_string ran_type_names[];
87static inline const char *ran_type_name(enum ran_type val)
88{ return get_value_string(ran_type_names, val); }
89
Harald Weltea43e0b42016-06-19 18:06:02 +020090struct gsm_classmark {
91 bool classmark1_set;
92 struct gsm48_classmark1 classmark1;
93 uint8_t classmark2_len;
94 uint8_t classmark2[3];
95 uint8_t classmark3_len;
96 uint8_t classmark3[14]; /* if cm3 gets extended by spec, it will be truncated */
97};
98
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +020099enum integrity_protection_state {
100 INTEGRITY_PROTECTION_NONE = 0,
101 INTEGRITY_PROTECTION_IK = 1,
102 INTEGRITY_PROTECTION_IK_CK = 2,
103};
104
Neels Hofmeyr378a4922016-05-09 21:07:43 +0200105/* active radio connection of a mobile subscriber */
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100106struct gsm_subscriber_connection {
Harald Weltea43e0b42016-06-19 18:06:02 +0200107 /* global linked list of subscriber_connections */
Holger Hans Peter Freyther79f763f2010-09-16 00:53:37 +0800108 struct llist_head entry;
109
Harald Weltea43e0b42016-06-19 18:06:02 +0200110 /* usage count. If this drops to zero, we start the release
111 * towards A/Iu */
112 uint32_t use_count;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100113
Harald Weltea43e0b42016-06-19 18:06:02 +0200114 /* The MS has opened the conn with a CM Service Request, and we shall
115 * keep it open for an actual request (or until timeout). */
116 bool received_cm_service_request;
117
118 /* libbsc subscriber information (if available) */
Neels Hofmeyr6d804b12017-02-18 22:20:46 +0100119 struct bsc_subscr *bsub;
120
Harald Weltea43e0b42016-06-19 18:06:02 +0200121 /* libmsc/libvlr subscriber information (if available) */
122 struct vlr_subscr *vsub;
123
Holger Hans Peter Freythere7bd8632013-06-30 15:30:47 +0200124 /* LU expiration handling */
125 uint8_t expire_timer_stopped;
Holger Hans Peter Freytherca114432014-02-08 15:20:48 +0100126 /* SMS helpers for libmsc */
127 uint8_t next_rp_ref;
Holger Hans Peter Freythere7bd8632013-06-30 15:30:47 +0200128
Harald Weltea43e0b42016-06-19 18:06:02 +0200129 struct osmo_fsm_inst *conn_fsm;
130
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100131 /* Are we part of a special "silent" call */
132 int silent_call;
133
Holger Hans Peter Freytherc8a6c132015-08-04 13:32:09 +0200134 /* MNCC rtp bridge markers */
135 int mncc_rtp_bridge;
136 int mncc_rtp_create_pending;
Holger Hans Peter Freytherc21dcb22015-08-04 14:41:21 +0200137 int mncc_rtp_connect_pending;
Holger Hans Peter Freytherc8a6c132015-08-04 13:32:09 +0200138
Holger Hans Peter Freyther2f9d1ef2010-09-16 20:14:01 +0800139 /* bsc structures */
Neels Hofmeyrce090f82016-05-30 15:00:23 +0200140 struct osmo_bsc_sccp_con *sccp_con; /* BSC */
Holger Hans Peter Freyther2f9d1ef2010-09-16 20:14:01 +0800141
Holger Hans Peter Freyther18b63f42010-03-23 07:52:17 +0100142 /* back pointers */
Neels Hofmeyr5e0b0a62016-05-09 22:33:01 +0200143 struct gsm_network *network;
144
Harald Weltea43e0b42016-06-19 18:06:02 +0200145 bool in_release;
Neels Hofmeyrce090f82016-05-30 15:00:23 +0200146 struct gsm_lchan *lchan; /* BSC */
147 struct gsm_lchan *ho_lchan; /* BSC */
148 struct gsm_bts *bts; /* BSC */
Holger Hans Peter Freyther77cd95d2010-11-14 16:19:48 +0100149
150 /* for assignment handling */
Neels Hofmeyrce090f82016-05-30 15:00:23 +0200151 struct osmo_timer_list T10; /* BSC */
152 struct gsm_lchan *secondary_lchan; /* BSC */
Holger Hans Peter Freyther77cd95d2010-11-14 16:19:48 +0100153
Neels Hofmeyrd3270a92017-02-02 01:07:28 +0100154 /* connected via 2G or 3G? */
155 enum ran_type via_ran;
Harald Weltea43e0b42016-06-19 18:06:02 +0200156
157 struct gsm_classmark classmark;
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200158
159 uint16_t lac;
160 struct gsm_encr encr;
161
Philipp Maier39f62bb2017-04-09 12:32:51 +0200162 struct {
163 unsigned int mgcp_rtp_endpoint;
164 uint16_t port_subscr;
165 uint16_t port_cn;
166 } rtp;
167
Philipp Maier39f62bb2017-04-09 12:32:51 +0200168 struct {
169 /* A pointer to the SCCP user that handles
170 * the SCCP connections for this subscriber
171 * connection */
172 struct osmo_sccp_user *scu;
173
174 /* The address of the BSC that is associated
175 * with this subscriber connection */
176 struct osmo_sccp_addr bsc_addr;
177
178 /* The connection identifier that is used
179 * to reference the SCCP connection that is
180 * associated with this subscriber connection */
181 int conn_id;
182 } a;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100183};
184
Harald Weltef142c972011-05-24 13:25:38 +0200185
Harald Welte6be350c2011-05-25 13:10:08 +0200186#include "gsm_data_shared.h"
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100187
Holger Hans Peter Freyther5ba6f482009-10-28 14:23:39 +0100188
Alexander Couzens20423ea2016-07-12 15:42:02 +0200189enum {
Alexander Couzensb847a212016-08-02 11:34:11 +0200190 BSC_CTR_CHREQ_TOTAL,
191 BSC_CTR_CHREQ_NO_CHANNEL,
192 BSC_CTR_HANDOVER_ATTEMPTED,
193 BSC_CTR_HANDOVER_NO_CHANNEL,
194 BSC_CTR_HANDOVER_TIMEOUT,
195 BSC_CTR_HANDOVER_COMPLETED,
196 BSC_CTR_HANDOVER_FAILED,
197 BSC_CTR_PAGING_ATTEMPTED,
198 BSC_CTR_PAGING_DETACHED,
199 BSC_CTR_PAGING_COMPLETED,
200 BSC_CTR_PAGING_EXPIRED,
201 BSC_CTR_CHAN_RF_FAIL,
202 BSC_CTR_CHAN_RLL_ERR,
203 BSC_CTR_BTS_OML_FAIL,
204 BSC_CTR_BTS_RSL_FAIL,
Alexander Couzens8c53c592016-08-23 06:27:19 +0200205 BSC_CTR_CODEC_AMR_F,
206 BSC_CTR_CODEC_AMR_H,
207 BSC_CTR_CODEC_EFR,
208 BSC_CTR_CODEC_V1_FR,
209 BSC_CTR_CODEC_V1_HR,
Alexander Couzensb847a212016-08-02 11:34:11 +0200210};
211
212static const struct rate_ctr_desc bsc_ctr_description[] = {
213 [BSC_CTR_CHREQ_TOTAL] = {"chreq.total", "Received channel requests."},
214 [BSC_CTR_CHREQ_NO_CHANNEL] = {"chreq.no_channel", "Sent to MS no channel available."},
215 [BSC_CTR_HANDOVER_ATTEMPTED] = {"handover.attempted", "Received handover attempts."},
216 [BSC_CTR_HANDOVER_NO_CHANNEL] = {"handover.no_channel", "Sent no channel available responses."},
217 [BSC_CTR_HANDOVER_TIMEOUT] = {"handover.timeout", "Count the amount of timeouts of timer T3103."},
218 [BSC_CTR_HANDOVER_COMPLETED] = {"handover.completed", "Received handover completed."},
219 [BSC_CTR_HANDOVER_FAILED] = {"handover.failed", "Receive HO FAIL messages."},
220 [BSC_CTR_PAGING_ATTEMPTED] = {"paging.attempted", "Paging attempts for a MS."},
221 [BSC_CTR_PAGING_DETACHED] = {"paging.detached", "Counts the amount of paging attempts which couldn't sent out any paging request because no responsible bts found."},
222 [BSC_CTR_PAGING_COMPLETED] = {"paging.completed", "Paging successful completed."},
223 [BSC_CTR_PAGING_EXPIRED] = {"paging.expired", "Paging Request expired because of timeout T3113."},
224 [BSC_CTR_CHAN_RF_FAIL] = {"chan.rf_fail", "Received a RF failure indication from BTS."},
225 [BSC_CTR_CHAN_RLL_ERR] = {"chan.rll_err", "Received a RLL failure with T200 cause from BTS."},
226 [BSC_CTR_BTS_OML_FAIL] = {"bts.oml_fail", "Received a TEI down on a OML link."},
227 [BSC_CTR_BTS_RSL_FAIL] = {"bts.rsl_fail", "Received a TEI down on a OML link."},
Alexander Couzens8c53c592016-08-23 06:27:19 +0200228 [BSC_CTR_CODEC_AMR_F] = {"bts.codec_amr_f", "Count the usage of AMR/F codec by channel mode requested."},
229 [BSC_CTR_CODEC_AMR_H] = {"bts.codec_amr_h", "Count the usage of AMR/H codec by channel mode requested."},
230 [BSC_CTR_CODEC_EFR] = {"bts.codec_efr", "Count the usage of EFR codec by channel mode requested."},
231 [BSC_CTR_CODEC_V1_FR] = {"bts.codec_fr", "Count the usage of FR codec by channel mode requested."},
232 [BSC_CTR_CODEC_V1_HR] = {"bts.codec_hr", "Count the usage of HR codec by channel mode requested."},
Alexander Couzensb847a212016-08-02 11:34:11 +0200233};
234
235enum {
Alexander Couzens20423ea2016-07-12 15:42:02 +0200236 MSC_CTR_LOC_UPDATE_TYPE_ATTACH,
237 MSC_CTR_LOC_UPDATE_TYPE_NORMAL,
238 MSC_CTR_LOC_UPDATE_TYPE_PERIODIC,
239 MSC_CTR_LOC_UPDATE_TYPE_DETACH,
Neels Hofmeyr36891a72016-05-09 13:18:03 +0200240 MSC_CTR_LOC_UPDATE_FAILED,
241 MSC_CTR_LOC_UPDATE_COMPLETED,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200242 MSC_CTR_SMS_SUBMITTED,
243 MSC_CTR_SMS_NO_RECEIVER,
244 MSC_CTR_SMS_DELIVERED,
245 MSC_CTR_SMS_RP_ERR_MEM,
246 MSC_CTR_SMS_RP_ERR_OTHER,
Alexander Couzensaa386d22016-08-21 20:16:33 +0200247 MSC_CTR_SMS_DELIVER_UNKNOWN_ERROR,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200248 MSC_CTR_CALL_MO_SETUP,
249 MSC_CTR_CALL_MO_CONNECT_ACK,
250 MSC_CTR_CALL_MT_SETUP,
251 MSC_CTR_CALL_MT_CONNECT,
Alexander Couzens92f552f2016-08-23 07:32:27 +0200252 MSC_CTR_CALL_ACTIVE,
253 MSC_CTR_CALL_COMPLETE,
254 MSC_CTR_CALL_INCOMPLETE,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200255};
256
257static const struct rate_ctr_desc msc_ctr_description[] = {
Alexander Couzens20423ea2016-07-12 15:42:02 +0200258 [MSC_CTR_LOC_UPDATE_TYPE_ATTACH] = {"loc_update_type.attach", "Received location update imsi attach requests."},
259 [MSC_CTR_LOC_UPDATE_TYPE_NORMAL] = {"loc_update_type.normal", "Received location update normal requests."},
260 [MSC_CTR_LOC_UPDATE_TYPE_PERIODIC] = {"loc_update_type.periodic", "Received location update periodic requests."},
261 [MSC_CTR_LOC_UPDATE_TYPE_DETACH] = {"loc_update_type.detach", "Received location update detach indication."},
Neels Hofmeyr36891a72016-05-09 13:18:03 +0200262 [MSC_CTR_LOC_UPDATE_FAILED] = {"loc_update_resp.failed", "Rejected location updates."},
263 [MSC_CTR_LOC_UPDATE_COMPLETED] = {"loc_update_resp.completed", "Successful location updates."},
Alexander Couzens20423ea2016-07-12 15:42:02 +0200264 [MSC_CTR_SMS_SUBMITTED] = {"sms.submitted", "Received a RPDU from a MS (MO)."},
265 [MSC_CTR_SMS_NO_RECEIVER] = {"sms.no_receiver", "Counts SMS which couldn't routed because no receiver found."},
266 [MSC_CTR_SMS_DELIVERED] = {"sms.delivered", "Global SMS Deliver attempts."},
267 [MSC_CTR_SMS_RP_ERR_MEM] = {"sms.rp_err_mem", "CAUSE_MT_MEM_EXCEEDED errors of MS responses on a sms deliver attempt."},
268 [MSC_CTR_SMS_RP_ERR_OTHER] = {"sms.rp_err_other", "Other error of MS responses on a sms delive attempt."},
Alexander Couzensaa386d22016-08-21 20:16:33 +0200269 [MSC_CTR_SMS_DELIVER_UNKNOWN_ERROR] = {"sms.deliver_unknown_error", "Unknown error occured during sms delivery."},
Alexander Couzens20423ea2016-07-12 15:42:02 +0200270 /* FIXME: count also sms delivered */
271 [MSC_CTR_CALL_MO_SETUP] = {"call.mo_setup", "Received setup requests from a MS to init a MO call."},
272 [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."},
273 [MSC_CTR_CALL_MT_SETUP] = {"call.mt_setup", "Sent setup requests to the MS (MT)."},
274 [MSC_CTR_CALL_MT_CONNECT] = {"call.mt_connect", "Sent a connect to the MS (MT)."},
Alexander Couzens92f552f2016-08-23 07:32:27 +0200275 [MSC_CTR_CALL_ACTIVE] = {"call.active", "Count total amount of calls that ever reached active state."},
276 [MSC_CTR_CALL_COMPLETE] = {"call.complete", "Count total amount of calls which got terminated by disconnect req or ind after reaching active state."},
277 [MSC_CTR_CALL_INCOMPLETE] = {"call.incomplete", "Count total amount of call which got terminated by any other reason after reaching active state."},
Alexander Couzensb847a212016-08-02 11:34:11 +0200278};
279
280
281static const struct rate_ctr_group_desc bsc_ctrg_desc = {
282 "bsc",
283 "base station controller",
284 OSMO_STATS_CLASS_GLOBAL,
285 ARRAY_SIZE(bsc_ctr_description),
286 bsc_ctr_description,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200287};
288
289static const struct rate_ctr_group_desc msc_ctrg_desc = {
290 "msc",
291 "mobile switching center",
292 OSMO_STATS_CLASS_GLOBAL,
293 ARRAY_SIZE(msc_ctr_description),
294 msc_ctr_description,
Harald Welte24ff6ee2009-12-22 00:41:05 +0100295};
296
Harald Welte (local)69de3972009-08-12 14:42:23 +0200297enum gsm_auth_policy {
298 GSM_AUTH_POLICY_CLOSED, /* only subscribers authorized in DB */
299 GSM_AUTH_POLICY_ACCEPT_ALL, /* accept everyone, even if not authorized in DB */
300 GSM_AUTH_POLICY_TOKEN, /* accept first, send token per sms, then revoke authorization */
Maxddee01f2016-05-24 14:23:27 +0200301 GSM_AUTH_POLICY_REGEXP, /* accept IMSIs matching given regexp */
Harald Welte (local)69de3972009-08-12 14:42:23 +0200302};
303
Harald Weltea0d324b2017-07-20 01:47:39 +0200304#define GSM_T3101_DEFAULT 10 /* s */
305#define GSM_T3103_DEFAULT 5 /* s */
306#define GSM_T3105_DEFAULT 100 /* ms */
307#define GSM_T3107_DEFAULT 5 /* s */
308#define GSM_T3109_DEFAULT 19 /* s, must be 2s + radio_link_timeout*0.48 */
309#define GSM_T3111_DEFAULT 2 /* s */
Harald Welteb84ddfc2009-12-01 17:36:54 +0530310#define GSM_T3113_DEFAULT 60
Harald Weltea0d324b2017-07-20 01:47:39 +0200311#define GSM_T3115_DEFAULT 10
312#define GSM_T3117_DEFAULT 10
313#define GSM_T3119_DEFAULT 10
Andreas Eversberg75e13a42013-02-07 11:51:16 +0100314#define GSM_T3122_DEFAULT 10
Harald Weltea0d324b2017-07-20 01:47:39 +0200315#define GSM_T3141_DEFAULT 10
Harald Welteb84ddfc2009-12-01 17:36:54 +0530316
Neels Hofmeyr73983952016-05-10 13:29:33 +0200317struct gsm_tz {
318 int override; /* if 0, use system's time zone instead. */
319 int hr; /* hour */
320 int mn; /* minute */
321 int dst; /* daylight savings */
322};
323
Harald Welte52b1f982008-12-23 20:25:15 +0000324struct gsm_network {
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200325 /* TODO MSCSPLIT the gsm_network struct is basically a kitchen sink for
326 * global settings and variables, "madly" mixing BSC and MSC stuff. Split
327 * this in e.g. struct osmo_bsc and struct osmo_msc, with the things
328 * these have in common, like country and network code, put in yet
329 * separate structs and placed as members in osmo_bsc and osmo_msc. */
330
Harald Welte52b1f982008-12-23 20:25:15 +0000331 /* global parameters */
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200332 uint16_t country_code;
333 uint16_t network_code;
Harald Weltec6ba9c22008-12-30 18:01:02 +0000334 char *name_long;
335 char *name_short;
Harald Welte1085c092009-11-18 20:33:19 +0100336 enum gsm48_reject_value reject_cause;
Harald Welte4381cfe2009-08-30 15:47:06 +0900337 int a5_encryption;
Holger Hans Peter Freytherf7d752f2009-11-16 17:12:38 +0100338 int neci;
Harald Welte648b6ce2009-12-14 09:00:24 +0100339 int send_mm_info;
Harald Weltebc814502009-12-19 21:41:52 +0100340 struct {
341 int active;
Harald Weltef7c28b02009-12-21 13:30:17 +0100342 /* Window RXLEV averaging */
343 unsigned int win_rxlev_avg; /* number of SACCH frames */
344 /* Window RXQUAL averaging */
345 unsigned int win_rxqual_avg; /* number of SACCH frames */
346 /* Window RXLEV neighbouring cells averaging */
347 unsigned int win_rxlev_avg_neigh; /* number of SACCH frames */
348
349 /* how often should we check for power budget HO */
350 unsigned int pwr_interval; /* SACCH frames */
351 /* how much better does a neighbor cell have to be ? */
352 unsigned int pwr_hysteresis; /* dBm */
353 /* maximum distacne before we try a handover */
354 unsigned int max_distance; /* TA values */
Harald Weltebc814502009-12-19 21:41:52 +0100355 } handover;
Harald Welte52b1f982008-12-23 20:25:15 +0000356
Alexander Couzensb847a212016-08-02 11:34:11 +0200357 struct rate_ctr_group *bsc_ctrs;
358 struct rate_ctr_group *msc_ctrs;
Alexander Couzens92f552f2016-08-23 07:32:27 +0200359 struct osmo_counter *active_calls;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100360
Harald Welte4bfdfe72009-06-10 23:11:52 +0800361 /* layer 4 */
Holger Hans Peter Freyther694c82d2011-10-26 18:37:09 +0200362 struct mncc_sock_state *mncc_state;
Neels Hofmeyr402006d2016-05-11 14:28:25 +0200363 mncc_recv_cb_t mncc_recv;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800364 struct llist_head upqueue;
Neels Hofmeyrc29505e2016-05-20 21:59:55 +0200365 /*
366 * TODO: Move the trans_list into the subscriber connection and
367 * create a pending list for MT transactions. These exist before
368 * we have a subscriber connection.
369 */
Harald Welte4bfdfe72009-06-10 23:11:52 +0800370 struct llist_head trans_list;
Holger Hans Peter Freytherabcddf12010-06-14 18:20:15 +0800371 struct bsc_api *bsc_api;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800372
Harald Welte52b1f982008-12-23 20:25:15 +0000373 unsigned int num_bts;
Harald Weltee441d9c2009-06-21 16:17:15 +0200374 struct llist_head bts_list;
Holger Hans Peter Freytherc4d88ad2009-11-21 21:18:38 +0100375
376 /* timer values */
377 int T3101;
Holger Hans Peter Freyther23975e72009-11-21 21:42:26 +0100378 int T3103;
379 int T3105;
380 int T3107;
381 int T3109;
382 int T3111;
383 int T3113;
384 int T3115;
385 int T3117;
386 int T3119;
Harald Welte2862dca2010-12-23 14:39:29 +0100387 int T3122;
Holger Hans Peter Freyther23975e72009-11-21 21:42:26 +0100388 int T3141;
Harald Welteeab84a12009-12-13 10:53:12 +0100389
Jan Luebbebfbdeec2012-12-27 00:27:16 +0100390 /* timer to expire old location updates */
391 struct osmo_timer_list subscr_expire_timer;
392
Harald Welteeab84a12009-12-13 10:53:12 +0100393 /* Radio Resource Location Protocol (TS 04.31) */
394 struct {
395 enum rrlp_mode mode;
396 } rrlp;
Holger Hans Peter Freyther5a3a61d2010-09-06 09:25:48 +0800397
Alexander Couzens547c2072017-11-21 12:03:04 +0100398 enum gsm_chan_t ctype_by_chreq[_NUM_CHREQ_T];
Holger Hans Peter Freyther78891072010-09-06 09:36:02 +0800399
Holger Hans Peter Freyther76fc4a32010-09-06 09:41:50 +0800400 /* Use a TCH for handling requests of type paging any */
401 int pag_any_tch;
402
Holger Hans Peter Freyther3e8e0462010-09-15 22:29:25 +0800403 /* MSC data in case we are a true BSC */
Holger Hans Peter Freyther8ec49522011-08-15 15:53:00 +0200404 struct osmo_bsc_data *bsc_data;
Holger Hans Peter Freytherdaee5ca2010-12-22 12:34:39 +0100405
Holger Hans Peter Freyther11b28f92010-12-24 13:48:27 +0100406 struct gsm_sms_queue *sms_queue;
Daniel Willmann6fc4a982011-07-22 17:55:42 +0200407
408 /* control interface */
409 struct ctrl_handle *ctrl;
Neels Hofmeyr5f0c71b2016-07-23 20:15:28 +0200410
411 /* Allow or disallow TCH/F on dynamic TCH/F_TCH/H_PDCH; OS#1778 */
412 bool dyn_ts_allow_tch_f;
Neels Hofmeyrd90fa422016-05-09 21:03:12 +0200413
414 /* all active subscriber connections. */
415 struct llist_head subscr_conns;
Neels Hofmeyr73983952016-05-10 13:29:33 +0200416
417 /* if override is nonzero, this timezone data is used for all MM
418 * contexts. */
419 /* TODO: in OsmoNITB, tz-override used to be BTS-specific. To enable
420 * BTS|RNC specific timezone overrides for multi-tz networks in
Neels Hofmeyrfe291de2017-02-23 21:06:12 +0100421 * OsmoMSC, this should be tied to the location area code (LAC). */
Neels Hofmeyr73983952016-05-10 13:29:33 +0200422 struct gsm_tz tz;
Neels Hofmeyr6d804b12017-02-18 22:20:46 +0100423
424 /* List of all struct bsc_subscr used in libbsc. This llist_head is
425 * allocated so that the llist_head pointer itself can serve as a
426 * talloc context (useful to not have to pass the entire gsm_network
427 * struct to the bsc_subscr_* API, and for bsc_susbscr unit tests to
428 * not require gsm_data.h). In an MSC-without-BSC environment, this
429 * pointer is NULL to indicate absence of a bsc_subscribers list. */
430 struct llist_head *bsc_subscribers;
Harald Weltea43e0b42016-06-19 18:06:02 +0200431
432 /* MSC: GSUP server address of the HLR */
433 const char *gsup_server_addr_str;
434 uint16_t gsup_server_port;
435
436 struct vlr_instance *vlr;
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200437
438 /* Periodic location update default value */
439 uint8_t t3212;
Neels Hofmeyrc29505e2016-05-20 21:59:55 +0200440
441 struct {
Philipp Maier39c609b2017-09-27 15:51:34 +0200442 struct mgcp_client_conf *conf;
443 struct mgcp_client *client;
444 } mgw;
445
446 struct {
Philipp Maier39f62bb2017-04-09 12:32:51 +0200447 /* CS7 instance id number (set via VTY) */
448 uint32_t cs7_instance;
Philipp Maier39f62bb2017-04-09 12:32:51 +0200449 /* A list with the context information about
450 * all BSCs we have connections with */
451 struct llist_head bscs;
452 struct osmo_sccp_instance *sccp;
453 } a;
Harald Welte52b1f982008-12-23 20:25:15 +0000454};
455
Harald Welted4bdee72012-11-08 19:44:08 +0100456struct osmo_esme;
457
458enum gsm_sms_source_id {
459 SMS_SOURCE_UNKNOWN = 0,
460 SMS_SOURCE_MS, /* received from MS */
461 SMS_SOURCE_VTY, /* received from VTY */
462 SMS_SOURCE_SMPP, /* received via SMPP */
463};
464
Harald Welte7e310b12009-03-30 20:56:32 +0000465#define SMS_HDR_SIZE 128
466#define SMS_TEXT_SIZE 256
Harald Weltee07b6a72012-11-23 19:02:37 +0100467
468struct gsm_sms_addr {
469 uint8_t ton;
470 uint8_t npi;
471 char addr[21+1];
472};
473
Harald Welte7e310b12009-03-30 20:56:32 +0000474struct gsm_sms {
Harald Welted409be72009-11-07 00:06:19 +0900475 unsigned long long id;
Harald Weltea43e0b42016-06-19 18:06:02 +0200476 struct vlr_subscr *receiver;
Harald Weltec0de14d2012-11-23 23:35:01 +0100477 struct gsm_sms_addr src, dst;
Harald Welted4bdee72012-11-08 19:44:08 +0100478 enum gsm_sms_source_id source;
479
480 struct {
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200481 uint8_t transaction_id;
482 uint32_t msg_ref;
483 } gsm411;
484
485 struct {
Harald Welted4bdee72012-11-08 19:44:08 +0100486 struct osmo_esme *esme;
487 uint32_t sequence_nr;
488 int transaction_mode;
489 char msg_id[16];
490 } smpp;
Harald Welte7e310b12009-03-30 20:56:32 +0000491
Harald Welteb9c758b2009-07-05 14:02:46 +0200492 unsigned long validity_minutes;
Keith5f9d0bd2017-08-16 22:45:07 +0200493 time_t created;
Pablo Neira Ayusoe1cdc322017-08-07 14:01:30 +0100494 bool is_report;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200495 uint8_t reply_path_req;
496 uint8_t status_rep_req;
497 uint8_t ud_hdr_ind;
498 uint8_t protocol_id;
499 uint8_t data_coding_scheme;
500 uint8_t msg_ref;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200501 uint8_t user_data_len;
502 uint8_t user_data[SMS_TEXT_SIZE];
Harald Weltef3efc592009-07-27 20:11:35 +0200503
Harald Welte7e310b12009-03-30 20:56:32 +0000504 char text[SMS_TEXT_SIZE];
505};
506
Neels Hofmeyrc13e6872016-05-11 13:53:47 +0200507extern void talloc_ctx_init(void *ctx_root);
508
Harald Welte39315c42010-01-10 18:01:52 +0100509int gsm_set_bts_type(struct gsm_bts *bts, enum gsm_bts_type type);
Harald Weltee441d9c2009-06-21 16:17:15 +0200510
Harald Welte1d014a52009-08-08 15:38:29 +0200511enum gsm_bts_type parse_btstype(const char *arg);
Holger Hans Peter Freyther2dceae62009-06-12 17:39:38 +0200512const char *btstype2str(enum gsm_bts_type type);
Harald Weltebe991492009-05-23 13:56:40 +0000513struct gsm_bts *gsm_bts_by_lac(struct gsm_network *net, unsigned int lac,
514 struct gsm_bts *start_bts);
Harald Welte32201c12009-03-10 12:15:10 +0000515
Andreas Eversberg8226fa72009-06-29 15:19:38 +0200516extern void *tall_bsc_ctx;
Harald Weltef88c8a02009-12-20 13:48:15 +0100517extern int ipacc_rtp_direct;
Harald Welte2cf161b2009-06-20 22:36:41 +0200518
Harald Weltef383aa12012-07-02 19:51:55 +0200519/* this actaully refers to the IPA transport, not the BTS model */
Harald Welte32201c12009-03-10 12:15:10 +0000520static inline int is_ipaccess_bts(struct gsm_bts *bts)
521{
522 switch (bts->type) {
Mike Habene2d82272009-10-02 12:19:34 +0100523 case GSM_BTS_TYPE_NANOBTS:
Maxf9685c12017-03-23 12:01:07 +0100524 case GSM_BTS_TYPE_OSMOBTS:
Harald Welte32201c12009-03-10 12:15:10 +0000525 return 1;
526 default:
527 break;
528 }
529 return 0;
530}
531
Holger Hans Peter Freyther6f6cbf72015-04-04 19:35:22 +0200532static inline int is_sysmobts_v2(struct gsm_bts *bts)
533{
534 switch (bts->type) {
Maxf9685c12017-03-23 12:01:07 +0100535 case GSM_BTS_TYPE_OSMOBTS:
Holger Hans Peter Freyther6f6cbf72015-04-04 19:35:22 +0200536 return 1;
537 default:
538 break;
539 }
540 return 0;
541}
542
Harald Welte5b570672009-08-10 10:08:01 +0200543static inline int is_siemens_bts(struct gsm_bts *bts)
544{
545 switch (bts->type) {
546 case GSM_BTS_TYPE_BS11:
547 return 1;
548 default:
549 break;
550 }
551
552 return 0;
553}
554
Andreas Eversberg7d8fa342013-12-05 13:25:06 +0100555static inline int is_nokia_bts(struct gsm_bts *bts)
556{
557 switch (bts->type) {
558 case GSM_BTS_TYPE_NOKIA_SITE:
559 return 1;
560 default:
561 break;
562 }
563
564 return 0;
565}
566
Andreas Eversbergdcf38e12013-12-05 14:37:11 +0100567static inline int is_e1_bts(struct gsm_bts *bts)
568{
569 switch (bts->type) {
570 case GSM_BTS_TYPE_BS11:
571 case GSM_BTS_TYPE_RBS2000:
572 case GSM_BTS_TYPE_NOKIA_SITE:
573 return 1;
574 default:
575 break;
576 }
577
578 return 0;
579}
580
Harald Welte (local)69de3972009-08-12 14:42:23 +0200581enum gsm_auth_policy gsm_auth_policy_parse(const char *arg);
582const char *gsm_auth_policy_name(enum gsm_auth_policy policy);
583
Harald Welteeab84a12009-12-13 10:53:12 +0100584enum rrlp_mode rrlp_mode_parse(const char *arg);
585const char *rrlp_mode_name(enum rrlp_mode mode);
586
Holger Hans Peter Freyther4e13a8f2015-01-31 22:16:00 +0100587enum bts_gprs_mode bts_gprs_mode_parse(const char *arg, int *valid);
Harald Welte4511d892010-04-18 15:51:20 +0200588const char *bts_gprs_mode_name(enum bts_gprs_mode mode);
Holger Hans Peter Freyther4e13a8f2015-01-31 22:16:00 +0100589int bts_gprs_mode_is_compat(struct gsm_bts *bts, enum bts_gprs_mode mode);
Harald Welte4511d892010-04-18 15:51:20 +0200590
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200591int gsm48_ra_id_by_bts(uint8_t *buf, struct gsm_bts *bts);
Harald Welte97a282b2010-03-14 15:37:43 +0800592void gprs_ra_id_by_bts(struct gprs_ra_id *raid, struct gsm_bts *bts);
Harald Welted12b0fd2009-12-15 21:36:05 +0100593
Harald Weltef3d8e922010-06-14 22:44:42 +0200594int gsm_btsmodel_set_feature(struct gsm_bts_model *model, enum gsm_bts_features feat);
Harald Weltefbda4e12010-03-04 11:04:52 +0100595int gsm_bts_model_register(struct gsm_bts_model *model);
596
Neels Hofmeyr42eb0142016-05-20 17:15:44 +0200597struct gsm_subscriber_connection *bsc_subscr_con_allocate(struct gsm_lchan *lchan);
598void bsc_subscr_con_free(struct gsm_subscriber_connection *conn);
599
600struct gsm_subscriber_connection *msc_subscr_con_allocate(struct gsm_network *network);
601void msc_subscr_con_free(struct gsm_subscriber_connection *conn);
Holger Hans Peter Freyther2412a072010-06-28 15:47:12 +0800602
Harald Welte3300c012011-06-05 13:31:33 +0200603struct gsm_bts *gsm_bts_alloc_register(struct gsm_network *net,
604 enum gsm_bts_type type,
Harald Weltea2bbc5e2015-11-20 10:43:31 +0100605 uint8_t bsic);
Harald Welte142d12d2014-12-29 17:47:08 +0100606
Harald Welte3300c012011-06-05 13:31:33 +0200607void set_ts_e1link(struct gsm_bts_trx_ts *ts, uint8_t e1_nr,
608 uint8_t e1_ts, uint8_t e1_ts_ss);
609
Maxbe356ed2017-09-07 19:10:09 +0200610void gsm_trx_lock_rf(struct gsm_bts_trx *trx, bool locked, const char *reason);
Max71d082b2017-05-30 15:03:38 +0200611bool gsm_btsmodel_has_feature(struct gsm_bts_model *model, enum gsm_bts_features feat);
Harald Welte3300c012011-06-05 13:31:33 +0200612struct gsm_bts_trx *gsm_bts_trx_by_nr(struct gsm_bts *bts, int nr);
Holger Hans Peter Freythera49b2c02014-11-21 11:18:45 +0100613int gsm_bts_trx_set_system_infos(struct gsm_bts_trx *trx);
Alexander Chemerisc36a13b2015-05-30 14:40:54 -0400614int gsm_bts_set_system_infos(struct gsm_bts *bts);
Harald Welte3300c012011-06-05 13:31:33 +0200615
Pablo Neira Ayusoed5cacb2011-08-17 22:44:07 +0200616/* generic E1 line operations for all ISDN-based BTS. */
617extern struct e1inp_line_ops bts_isdn_e1inp_line_ops;
618
Harald Weltee555c2b2012-08-17 13:02:12 +0200619extern const struct value_string bts_type_names[_NUM_GSM_BTS_TYPE+1];
620extern const struct value_string bts_type_descs[_NUM_GSM_BTS_TYPE+1];
621
Max3d049d22017-10-09 17:12:53 +0200622char *get_model_oml_status(const struct gsm_bts *bts);
623
Max25cc4072017-10-10 14:50:35 +0200624unsigned long long bts_uptime(const struct gsm_bts *bts);
625
Holger Hans Peter Freytherf8c42192013-01-09 17:03:27 +0100626/* control interface handling */
627int bsc_base_ctrl_cmds_install(void);
628
Holger Hans Peter Freytherc22930e2014-12-17 14:46:17 +0100629/* dependency handling */
630void bts_depend_mark(struct gsm_bts *bts, int dep);
631void bts_depend_clear(struct gsm_bts *bts, int dep);
632int bts_depend_check(struct gsm_bts *bts);
Holger Hans Peter Freytherf7e23c52014-12-17 15:44:32 +0100633int bts_depend_is_depedency(struct gsm_bts *base, struct gsm_bts *other);
Holger Hans Peter Freytherc22930e2014-12-17 14:46:17 +0100634
Harald Welte2f8b9d22017-06-18 11:12:13 +0300635int gsm_bts_get_radio_link_timeout(const struct gsm_bts *bts);
636void gsm_bts_set_radio_link_timeout(struct gsm_bts *bts, int value);
637
Harald Weltea43e0b42016-06-19 18:06:02 +0200638bool classmark_is_r99(struct gsm_classmark *cm);
639
Harald Welte6be350c2011-05-25 13:10:08 +0200640#endif /* _GSM_DATA_H */