blob: 7b7aa23b5d19739576a15bd0fc032345b31c21ef [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
Harald Welted82101e2017-12-09 23:07:38 +0100188enum {
189 BTS_CTR_CHREQ_TOTAL,
190 BTS_CTR_CHREQ_NO_CHANNEL,
191 BTS_CTR_CHAN_RF_FAIL,
192 BTS_CTR_CHAN_RLL_ERR,
193 BTS_CTR_BTS_OML_FAIL,
194 BTS_CTR_BTS_RSL_FAIL,
195 BTS_CTR_CODEC_AMR_F,
196 BTS_CTR_CODEC_AMR_H,
197 BTS_CTR_CODEC_EFR,
198 BTS_CTR_CODEC_V1_FR,
199 BTS_CTR_CODEC_V1_HR,
200};
201
202static const struct rate_ctr_desc bts_ctr_description[] = {
Harald Welte1ef46d92017-12-09 23:10:46 +0100203 [BTS_CTR_CHREQ_TOTAL] = {"chreq:total", "Received channel requests."},
204 [BTS_CTR_CHREQ_NO_CHANNEL] = {"chreq:no_channel", "Sent to MS no channel available."},
205 [BTS_CTR_CHAN_RF_FAIL] = {"chan:rf_fail", "Received a RF failure indication from BTS."},
206 [BTS_CTR_CHAN_RLL_ERR] = {"chan:rll_err", "Received a RLL failure with T200 cause from BTS."},
Harald Welted82101e2017-12-09 23:07:38 +0100207 [BTS_CTR_BTS_OML_FAIL] = {"oml_fail", "Received a TEI down on a OML link."},
208 [BTS_CTR_BTS_RSL_FAIL] = {"rsl_fail", "Received a TEI down on a OML link."},
Harald Welte1ef46d92017-12-09 23:10:46 +0100209 [BTS_CTR_CODEC_AMR_F] = {"codec:amr_f", "Count the usage of AMR/F codec by channel mode requested."},
210 [BTS_CTR_CODEC_AMR_H] = {"codec:amr_h", "Count the usage of AMR/H codec by channel mode requested."},
211 [BTS_CTR_CODEC_EFR] = {"codec:efr", "Count the usage of EFR codec by channel mode requested."},
212 [BTS_CTR_CODEC_V1_FR] = {"codec:fr", "Count the usage of FR codec by channel mode requested."},
213 [BTS_CTR_CODEC_V1_HR] = {"codec:hr", "Count the usage of HR codec by channel mode requested."},
Harald Welted82101e2017-12-09 23:07:38 +0100214};
215
216static const struct rate_ctr_group_desc bts_ctrg_desc = {
217 "bts",
218 "base transceiver station",
219 OSMO_STATS_CLASS_GLOBAL,
220 ARRAY_SIZE(bts_ctr_description),
221 bts_ctr_description,
222};
Holger Hans Peter Freyther5ba6f482009-10-28 14:23:39 +0100223
Alexander Couzens20423ea2016-07-12 15:42:02 +0200224enum {
Alexander Couzensb847a212016-08-02 11:34:11 +0200225 BSC_CTR_HANDOVER_ATTEMPTED,
226 BSC_CTR_HANDOVER_NO_CHANNEL,
227 BSC_CTR_HANDOVER_TIMEOUT,
228 BSC_CTR_HANDOVER_COMPLETED,
229 BSC_CTR_HANDOVER_FAILED,
230 BSC_CTR_PAGING_ATTEMPTED,
231 BSC_CTR_PAGING_DETACHED,
232 BSC_CTR_PAGING_COMPLETED,
233 BSC_CTR_PAGING_EXPIRED,
Alexander Couzensb847a212016-08-02 11:34:11 +0200234};
235
236static const struct rate_ctr_desc bsc_ctr_description[] = {
Harald Welte1ef46d92017-12-09 23:10:46 +0100237 [BSC_CTR_HANDOVER_ATTEMPTED] = {"handover:attempted", "Received handover attempts."},
238 [BSC_CTR_HANDOVER_NO_CHANNEL] = {"handover:no_channel", "Sent no channel available responses."},
239 [BSC_CTR_HANDOVER_TIMEOUT] = {"handover:timeout", "Count the amount of timeouts of timer T3103."},
240 [BSC_CTR_HANDOVER_COMPLETED] = {"handover:completed", "Received handover completed."},
241 [BSC_CTR_HANDOVER_FAILED] = {"handover:failed", "Receive HO FAIL messages."},
242 [BSC_CTR_PAGING_ATTEMPTED] = {"paging:attempted", "Paging attempts for a MS."},
243 [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."},
244 [BSC_CTR_PAGING_COMPLETED] = {"paging:completed", "Paging successful completed."},
245 [BSC_CTR_PAGING_EXPIRED] = {"paging:expired", "Paging Request expired because of timeout T3113."},
Alexander Couzensb847a212016-08-02 11:34:11 +0200246};
247
248enum {
Alexander Couzens20423ea2016-07-12 15:42:02 +0200249 MSC_CTR_LOC_UPDATE_TYPE_ATTACH,
250 MSC_CTR_LOC_UPDATE_TYPE_NORMAL,
251 MSC_CTR_LOC_UPDATE_TYPE_PERIODIC,
252 MSC_CTR_LOC_UPDATE_TYPE_DETACH,
Neels Hofmeyr36891a72016-05-09 13:18:03 +0200253 MSC_CTR_LOC_UPDATE_FAILED,
254 MSC_CTR_LOC_UPDATE_COMPLETED,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200255 MSC_CTR_SMS_SUBMITTED,
256 MSC_CTR_SMS_NO_RECEIVER,
257 MSC_CTR_SMS_DELIVERED,
258 MSC_CTR_SMS_RP_ERR_MEM,
259 MSC_CTR_SMS_RP_ERR_OTHER,
Alexander Couzensaa386d22016-08-21 20:16:33 +0200260 MSC_CTR_SMS_DELIVER_UNKNOWN_ERROR,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200261 MSC_CTR_CALL_MO_SETUP,
262 MSC_CTR_CALL_MO_CONNECT_ACK,
263 MSC_CTR_CALL_MT_SETUP,
264 MSC_CTR_CALL_MT_CONNECT,
Alexander Couzens92f552f2016-08-23 07:32:27 +0200265 MSC_CTR_CALL_ACTIVE,
266 MSC_CTR_CALL_COMPLETE,
267 MSC_CTR_CALL_INCOMPLETE,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200268};
269
270static const struct rate_ctr_desc msc_ctr_description[] = {
Alexander Couzens20423ea2016-07-12 15:42:02 +0200271 [MSC_CTR_LOC_UPDATE_TYPE_ATTACH] = {"loc_update_type.attach", "Received location update imsi attach requests."},
272 [MSC_CTR_LOC_UPDATE_TYPE_NORMAL] = {"loc_update_type.normal", "Received location update normal requests."},
273 [MSC_CTR_LOC_UPDATE_TYPE_PERIODIC] = {"loc_update_type.periodic", "Received location update periodic requests."},
274 [MSC_CTR_LOC_UPDATE_TYPE_DETACH] = {"loc_update_type.detach", "Received location update detach indication."},
Neels Hofmeyr36891a72016-05-09 13:18:03 +0200275 [MSC_CTR_LOC_UPDATE_FAILED] = {"loc_update_resp.failed", "Rejected location updates."},
276 [MSC_CTR_LOC_UPDATE_COMPLETED] = {"loc_update_resp.completed", "Successful location updates."},
Alexander Couzens20423ea2016-07-12 15:42:02 +0200277 [MSC_CTR_SMS_SUBMITTED] = {"sms.submitted", "Received a RPDU from a MS (MO)."},
278 [MSC_CTR_SMS_NO_RECEIVER] = {"sms.no_receiver", "Counts SMS which couldn't routed because no receiver found."},
279 [MSC_CTR_SMS_DELIVERED] = {"sms.delivered", "Global SMS Deliver attempts."},
280 [MSC_CTR_SMS_RP_ERR_MEM] = {"sms.rp_err_mem", "CAUSE_MT_MEM_EXCEEDED errors of MS responses on a sms deliver attempt."},
281 [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 +0200282 [MSC_CTR_SMS_DELIVER_UNKNOWN_ERROR] = {"sms.deliver_unknown_error", "Unknown error occured during sms delivery."},
Alexander Couzens20423ea2016-07-12 15:42:02 +0200283 /* FIXME: count also sms delivered */
284 [MSC_CTR_CALL_MO_SETUP] = {"call.mo_setup", "Received setup requests from a MS to init a MO call."},
285 [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."},
286 [MSC_CTR_CALL_MT_SETUP] = {"call.mt_setup", "Sent setup requests to the MS (MT)."},
287 [MSC_CTR_CALL_MT_CONNECT] = {"call.mt_connect", "Sent a connect to the MS (MT)."},
Alexander Couzens92f552f2016-08-23 07:32:27 +0200288 [MSC_CTR_CALL_ACTIVE] = {"call.active", "Count total amount of calls that ever reached active state."},
289 [MSC_CTR_CALL_COMPLETE] = {"call.complete", "Count total amount of calls which got terminated by disconnect req or ind after reaching active state."},
290 [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 +0200291};
292
293
294static const struct rate_ctr_group_desc bsc_ctrg_desc = {
295 "bsc",
296 "base station controller",
297 OSMO_STATS_CLASS_GLOBAL,
298 ARRAY_SIZE(bsc_ctr_description),
299 bsc_ctr_description,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200300};
301
302static const struct rate_ctr_group_desc msc_ctrg_desc = {
303 "msc",
304 "mobile switching center",
305 OSMO_STATS_CLASS_GLOBAL,
306 ARRAY_SIZE(msc_ctr_description),
307 msc_ctr_description,
Harald Welte24ff6ee2009-12-22 00:41:05 +0100308};
309
Harald Welte (local)69de3972009-08-12 14:42:23 +0200310enum gsm_auth_policy {
311 GSM_AUTH_POLICY_CLOSED, /* only subscribers authorized in DB */
312 GSM_AUTH_POLICY_ACCEPT_ALL, /* accept everyone, even if not authorized in DB */
313 GSM_AUTH_POLICY_TOKEN, /* accept first, send token per sms, then revoke authorization */
Maxddee01f2016-05-24 14:23:27 +0200314 GSM_AUTH_POLICY_REGEXP, /* accept IMSIs matching given regexp */
Harald Welte (local)69de3972009-08-12 14:42:23 +0200315};
316
Harald Weltea0d324b2017-07-20 01:47:39 +0200317#define GSM_T3101_DEFAULT 10 /* s */
318#define GSM_T3103_DEFAULT 5 /* s */
319#define GSM_T3105_DEFAULT 100 /* ms */
320#define GSM_T3107_DEFAULT 5 /* s */
321#define GSM_T3109_DEFAULT 19 /* s, must be 2s + radio_link_timeout*0.48 */
322#define GSM_T3111_DEFAULT 2 /* s */
Harald Welteb84ddfc2009-12-01 17:36:54 +0530323#define GSM_T3113_DEFAULT 60
Harald Weltea0d324b2017-07-20 01:47:39 +0200324#define GSM_T3115_DEFAULT 10
325#define GSM_T3117_DEFAULT 10
326#define GSM_T3119_DEFAULT 10
Andreas Eversberg75e13a42013-02-07 11:51:16 +0100327#define GSM_T3122_DEFAULT 10
Harald Weltea0d324b2017-07-20 01:47:39 +0200328#define GSM_T3141_DEFAULT 10
Harald Welteb84ddfc2009-12-01 17:36:54 +0530329
Neels Hofmeyr73983952016-05-10 13:29:33 +0200330struct gsm_tz {
331 int override; /* if 0, use system's time zone instead. */
332 int hr; /* hour */
333 int mn; /* minute */
334 int dst; /* daylight savings */
335};
336
Harald Welte52b1f982008-12-23 20:25:15 +0000337struct gsm_network {
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200338 /* TODO MSCSPLIT the gsm_network struct is basically a kitchen sink for
339 * global settings and variables, "madly" mixing BSC and MSC stuff. Split
340 * this in e.g. struct osmo_bsc and struct osmo_msc, with the things
341 * these have in common, like country and network code, put in yet
342 * separate structs and placed as members in osmo_bsc and osmo_msc. */
343
Harald Welte52b1f982008-12-23 20:25:15 +0000344 /* global parameters */
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200345 uint16_t country_code;
346 uint16_t network_code;
Harald Weltec6ba9c22008-12-30 18:01:02 +0000347 char *name_long;
348 char *name_short;
Harald Welte1085c092009-11-18 20:33:19 +0100349 enum gsm48_reject_value reject_cause;
Harald Welte4381cfe2009-08-30 15:47:06 +0900350 int a5_encryption;
Holger Hans Peter Freytherf7d752f2009-11-16 17:12:38 +0100351 int neci;
Harald Welte648b6ce2009-12-14 09:00:24 +0100352 int send_mm_info;
Harald Weltebc814502009-12-19 21:41:52 +0100353 struct {
354 int active;
Harald Weltef7c28b02009-12-21 13:30:17 +0100355 /* Window RXLEV averaging */
356 unsigned int win_rxlev_avg; /* number of SACCH frames */
357 /* Window RXQUAL averaging */
358 unsigned int win_rxqual_avg; /* number of SACCH frames */
359 /* Window RXLEV neighbouring cells averaging */
360 unsigned int win_rxlev_avg_neigh; /* number of SACCH frames */
361
362 /* how often should we check for power budget HO */
363 unsigned int pwr_interval; /* SACCH frames */
364 /* how much better does a neighbor cell have to be ? */
365 unsigned int pwr_hysteresis; /* dBm */
366 /* maximum distacne before we try a handover */
367 unsigned int max_distance; /* TA values */
Harald Weltebc814502009-12-19 21:41:52 +0100368 } handover;
Harald Welte52b1f982008-12-23 20:25:15 +0000369
Alexander Couzensb847a212016-08-02 11:34:11 +0200370 struct rate_ctr_group *bsc_ctrs;
371 struct rate_ctr_group *msc_ctrs;
Alexander Couzens92f552f2016-08-23 07:32:27 +0200372 struct osmo_counter *active_calls;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100373
Harald Welte4bfdfe72009-06-10 23:11:52 +0800374 /* layer 4 */
Holger Hans Peter Freyther694c82d2011-10-26 18:37:09 +0200375 struct mncc_sock_state *mncc_state;
Neels Hofmeyr402006d2016-05-11 14:28:25 +0200376 mncc_recv_cb_t mncc_recv;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800377 struct llist_head upqueue;
Neels Hofmeyrc29505e2016-05-20 21:59:55 +0200378 /*
379 * TODO: Move the trans_list into the subscriber connection and
380 * create a pending list for MT transactions. These exist before
381 * we have a subscriber connection.
382 */
Harald Welte4bfdfe72009-06-10 23:11:52 +0800383 struct llist_head trans_list;
Holger Hans Peter Freytherabcddf12010-06-14 18:20:15 +0800384 struct bsc_api *bsc_api;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800385
Harald Welte52b1f982008-12-23 20:25:15 +0000386 unsigned int num_bts;
Harald Weltee441d9c2009-06-21 16:17:15 +0200387 struct llist_head bts_list;
Holger Hans Peter Freytherc4d88ad2009-11-21 21:18:38 +0100388
389 /* timer values */
390 int T3101;
Holger Hans Peter Freyther23975e72009-11-21 21:42:26 +0100391 int T3103;
392 int T3105;
393 int T3107;
394 int T3109;
395 int T3111;
396 int T3113;
397 int T3115;
398 int T3117;
399 int T3119;
Harald Welte2862dca2010-12-23 14:39:29 +0100400 int T3122;
Holger Hans Peter Freyther23975e72009-11-21 21:42:26 +0100401 int T3141;
Harald Welteeab84a12009-12-13 10:53:12 +0100402
Jan Luebbebfbdeec2012-12-27 00:27:16 +0100403 /* timer to expire old location updates */
404 struct osmo_timer_list subscr_expire_timer;
405
Harald Welteeab84a12009-12-13 10:53:12 +0100406 /* Radio Resource Location Protocol (TS 04.31) */
407 struct {
408 enum rrlp_mode mode;
409 } rrlp;
Holger Hans Peter Freyther5a3a61d2010-09-06 09:25:48 +0800410
Alexander Couzens547c2072017-11-21 12:03:04 +0100411 enum gsm_chan_t ctype_by_chreq[_NUM_CHREQ_T];
Holger Hans Peter Freyther78891072010-09-06 09:36:02 +0800412
Holger Hans Peter Freyther76fc4a32010-09-06 09:41:50 +0800413 /* Use a TCH for handling requests of type paging any */
414 int pag_any_tch;
415
Holger Hans Peter Freyther3e8e0462010-09-15 22:29:25 +0800416 /* MSC data in case we are a true BSC */
Holger Hans Peter Freyther8ec49522011-08-15 15:53:00 +0200417 struct osmo_bsc_data *bsc_data;
Holger Hans Peter Freytherdaee5ca2010-12-22 12:34:39 +0100418
Holger Hans Peter Freyther11b28f92010-12-24 13:48:27 +0100419 struct gsm_sms_queue *sms_queue;
Daniel Willmann6fc4a982011-07-22 17:55:42 +0200420
421 /* control interface */
422 struct ctrl_handle *ctrl;
Neels Hofmeyr5f0c71b2016-07-23 20:15:28 +0200423
424 /* Allow or disallow TCH/F on dynamic TCH/F_TCH/H_PDCH; OS#1778 */
425 bool dyn_ts_allow_tch_f;
Neels Hofmeyrd90fa422016-05-09 21:03:12 +0200426
427 /* all active subscriber connections. */
428 struct llist_head subscr_conns;
Neels Hofmeyr73983952016-05-10 13:29:33 +0200429
430 /* if override is nonzero, this timezone data is used for all MM
431 * contexts. */
432 /* TODO: in OsmoNITB, tz-override used to be BTS-specific. To enable
433 * BTS|RNC specific timezone overrides for multi-tz networks in
Neels Hofmeyrfe291de2017-02-23 21:06:12 +0100434 * OsmoMSC, this should be tied to the location area code (LAC). */
Neels Hofmeyr73983952016-05-10 13:29:33 +0200435 struct gsm_tz tz;
Neels Hofmeyr6d804b12017-02-18 22:20:46 +0100436
437 /* List of all struct bsc_subscr used in libbsc. This llist_head is
438 * allocated so that the llist_head pointer itself can serve as a
439 * talloc context (useful to not have to pass the entire gsm_network
440 * struct to the bsc_subscr_* API, and for bsc_susbscr unit tests to
441 * not require gsm_data.h). In an MSC-without-BSC environment, this
442 * pointer is NULL to indicate absence of a bsc_subscribers list. */
443 struct llist_head *bsc_subscribers;
Harald Weltea43e0b42016-06-19 18:06:02 +0200444
445 /* MSC: GSUP server address of the HLR */
446 const char *gsup_server_addr_str;
447 uint16_t gsup_server_port;
448
449 struct vlr_instance *vlr;
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200450
451 /* Periodic location update default value */
452 uint8_t t3212;
Neels Hofmeyrc29505e2016-05-20 21:59:55 +0200453
454 struct {
Philipp Maier39c609b2017-09-27 15:51:34 +0200455 struct mgcp_client_conf *conf;
456 struct mgcp_client *client;
457 } mgw;
458
459 struct {
Philipp Maier39f62bb2017-04-09 12:32:51 +0200460 /* CS7 instance id number (set via VTY) */
461 uint32_t cs7_instance;
Philipp Maier39f62bb2017-04-09 12:32:51 +0200462 /* A list with the context information about
463 * all BSCs we have connections with */
464 struct llist_head bscs;
465 struct osmo_sccp_instance *sccp;
466 } a;
Harald Welte52b1f982008-12-23 20:25:15 +0000467};
468
Harald Welted4bdee72012-11-08 19:44:08 +0100469struct osmo_esme;
470
471enum gsm_sms_source_id {
472 SMS_SOURCE_UNKNOWN = 0,
473 SMS_SOURCE_MS, /* received from MS */
474 SMS_SOURCE_VTY, /* received from VTY */
475 SMS_SOURCE_SMPP, /* received via SMPP */
476};
477
Harald Welte7e310b12009-03-30 20:56:32 +0000478#define SMS_HDR_SIZE 128
479#define SMS_TEXT_SIZE 256
Harald Weltee07b6a72012-11-23 19:02:37 +0100480
481struct gsm_sms_addr {
482 uint8_t ton;
483 uint8_t npi;
484 char addr[21+1];
485};
486
Harald Welte7e310b12009-03-30 20:56:32 +0000487struct gsm_sms {
Harald Welted409be72009-11-07 00:06:19 +0900488 unsigned long long id;
Harald Weltea43e0b42016-06-19 18:06:02 +0200489 struct vlr_subscr *receiver;
Harald Weltec0de14d2012-11-23 23:35:01 +0100490 struct gsm_sms_addr src, dst;
Harald Welted4bdee72012-11-08 19:44:08 +0100491 enum gsm_sms_source_id source;
492
493 struct {
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200494 uint8_t transaction_id;
495 uint32_t msg_ref;
496 } gsm411;
497
498 struct {
Harald Welted4bdee72012-11-08 19:44:08 +0100499 struct osmo_esme *esme;
500 uint32_t sequence_nr;
501 int transaction_mode;
502 char msg_id[16];
503 } smpp;
Harald Welte7e310b12009-03-30 20:56:32 +0000504
Harald Welteb9c758b2009-07-05 14:02:46 +0200505 unsigned long validity_minutes;
Keith5f9d0bd2017-08-16 22:45:07 +0200506 time_t created;
Pablo Neira Ayusoe1cdc322017-08-07 14:01:30 +0100507 bool is_report;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200508 uint8_t reply_path_req;
509 uint8_t status_rep_req;
510 uint8_t ud_hdr_ind;
511 uint8_t protocol_id;
512 uint8_t data_coding_scheme;
513 uint8_t msg_ref;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200514 uint8_t user_data_len;
515 uint8_t user_data[SMS_TEXT_SIZE];
Harald Weltef3efc592009-07-27 20:11:35 +0200516
Harald Welte7e310b12009-03-30 20:56:32 +0000517 char text[SMS_TEXT_SIZE];
518};
519
Neels Hofmeyrc13e6872016-05-11 13:53:47 +0200520extern void talloc_ctx_init(void *ctx_root);
521
Harald Welte39315c42010-01-10 18:01:52 +0100522int gsm_set_bts_type(struct gsm_bts *bts, enum gsm_bts_type type);
Harald Weltee441d9c2009-06-21 16:17:15 +0200523
Harald Welte1d014a52009-08-08 15:38:29 +0200524enum gsm_bts_type parse_btstype(const char *arg);
Holger Hans Peter Freyther2dceae62009-06-12 17:39:38 +0200525const char *btstype2str(enum gsm_bts_type type);
Harald Weltebe991492009-05-23 13:56:40 +0000526struct gsm_bts *gsm_bts_by_lac(struct gsm_network *net, unsigned int lac,
527 struct gsm_bts *start_bts);
Harald Welte32201c12009-03-10 12:15:10 +0000528
Andreas Eversberg8226fa72009-06-29 15:19:38 +0200529extern void *tall_bsc_ctx;
Harald Weltef88c8a02009-12-20 13:48:15 +0100530extern int ipacc_rtp_direct;
Harald Welte2cf161b2009-06-20 22:36:41 +0200531
Harald Weltef383aa12012-07-02 19:51:55 +0200532/* this actaully refers to the IPA transport, not the BTS model */
Harald Welte32201c12009-03-10 12:15:10 +0000533static inline int is_ipaccess_bts(struct gsm_bts *bts)
534{
535 switch (bts->type) {
Mike Habene2d82272009-10-02 12:19:34 +0100536 case GSM_BTS_TYPE_NANOBTS:
Maxf9685c12017-03-23 12:01:07 +0100537 case GSM_BTS_TYPE_OSMOBTS:
Harald Welte32201c12009-03-10 12:15:10 +0000538 return 1;
539 default:
540 break;
541 }
542 return 0;
543}
544
Holger Hans Peter Freyther6f6cbf72015-04-04 19:35:22 +0200545static inline int is_sysmobts_v2(struct gsm_bts *bts)
546{
547 switch (bts->type) {
Maxf9685c12017-03-23 12:01:07 +0100548 case GSM_BTS_TYPE_OSMOBTS:
Holger Hans Peter Freyther6f6cbf72015-04-04 19:35:22 +0200549 return 1;
550 default:
551 break;
552 }
553 return 0;
554}
555
Harald Welte5b570672009-08-10 10:08:01 +0200556static inline int is_siemens_bts(struct gsm_bts *bts)
557{
558 switch (bts->type) {
559 case GSM_BTS_TYPE_BS11:
560 return 1;
561 default:
562 break;
563 }
564
565 return 0;
566}
567
Andreas Eversberg7d8fa342013-12-05 13:25:06 +0100568static inline int is_nokia_bts(struct gsm_bts *bts)
569{
570 switch (bts->type) {
571 case GSM_BTS_TYPE_NOKIA_SITE:
572 return 1;
573 default:
574 break;
575 }
576
577 return 0;
578}
579
Andreas Eversbergdcf38e12013-12-05 14:37:11 +0100580static inline int is_e1_bts(struct gsm_bts *bts)
581{
582 switch (bts->type) {
583 case GSM_BTS_TYPE_BS11:
584 case GSM_BTS_TYPE_RBS2000:
585 case GSM_BTS_TYPE_NOKIA_SITE:
586 return 1;
587 default:
588 break;
589 }
590
591 return 0;
592}
593
Harald Welte (local)69de3972009-08-12 14:42:23 +0200594enum gsm_auth_policy gsm_auth_policy_parse(const char *arg);
595const char *gsm_auth_policy_name(enum gsm_auth_policy policy);
596
Harald Welteeab84a12009-12-13 10:53:12 +0100597enum rrlp_mode rrlp_mode_parse(const char *arg);
598const char *rrlp_mode_name(enum rrlp_mode mode);
599
Holger Hans Peter Freyther4e13a8f2015-01-31 22:16:00 +0100600enum bts_gprs_mode bts_gprs_mode_parse(const char *arg, int *valid);
Harald Welte4511d892010-04-18 15:51:20 +0200601const char *bts_gprs_mode_name(enum bts_gprs_mode mode);
Holger Hans Peter Freyther4e13a8f2015-01-31 22:16:00 +0100602int bts_gprs_mode_is_compat(struct gsm_bts *bts, enum bts_gprs_mode mode);
Harald Welte4511d892010-04-18 15:51:20 +0200603
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200604int gsm48_ra_id_by_bts(uint8_t *buf, struct gsm_bts *bts);
Harald Welte97a282b2010-03-14 15:37:43 +0800605void gprs_ra_id_by_bts(struct gprs_ra_id *raid, struct gsm_bts *bts);
Harald Welted12b0fd2009-12-15 21:36:05 +0100606
Harald Weltef3d8e922010-06-14 22:44:42 +0200607int gsm_btsmodel_set_feature(struct gsm_bts_model *model, enum gsm_bts_features feat);
Harald Weltefbda4e12010-03-04 11:04:52 +0100608int gsm_bts_model_register(struct gsm_bts_model *model);
609
Neels Hofmeyr42eb0142016-05-20 17:15:44 +0200610struct gsm_subscriber_connection *bsc_subscr_con_allocate(struct gsm_lchan *lchan);
611void bsc_subscr_con_free(struct gsm_subscriber_connection *conn);
612
613struct gsm_subscriber_connection *msc_subscr_con_allocate(struct gsm_network *network);
614void msc_subscr_con_free(struct gsm_subscriber_connection *conn);
Holger Hans Peter Freyther2412a072010-06-28 15:47:12 +0800615
Harald Welte3300c012011-06-05 13:31:33 +0200616struct gsm_bts *gsm_bts_alloc_register(struct gsm_network *net,
617 enum gsm_bts_type type,
Harald Weltea2bbc5e2015-11-20 10:43:31 +0100618 uint8_t bsic);
Harald Welte142d12d2014-12-29 17:47:08 +0100619
Harald Welte3300c012011-06-05 13:31:33 +0200620void set_ts_e1link(struct gsm_bts_trx_ts *ts, uint8_t e1_nr,
621 uint8_t e1_ts, uint8_t e1_ts_ss);
622
Maxbe356ed2017-09-07 19:10:09 +0200623void gsm_trx_lock_rf(struct gsm_bts_trx *trx, bool locked, const char *reason);
Max71d082b2017-05-30 15:03:38 +0200624bool gsm_btsmodel_has_feature(struct gsm_bts_model *model, enum gsm_bts_features feat);
Harald Welte3300c012011-06-05 13:31:33 +0200625struct gsm_bts_trx *gsm_bts_trx_by_nr(struct gsm_bts *bts, int nr);
Holger Hans Peter Freythera49b2c02014-11-21 11:18:45 +0100626int gsm_bts_trx_set_system_infos(struct gsm_bts_trx *trx);
Alexander Chemerisc36a13b2015-05-30 14:40:54 -0400627int gsm_bts_set_system_infos(struct gsm_bts *bts);
Harald Welte3300c012011-06-05 13:31:33 +0200628
Pablo Neira Ayusoed5cacb2011-08-17 22:44:07 +0200629/* generic E1 line operations for all ISDN-based BTS. */
630extern struct e1inp_line_ops bts_isdn_e1inp_line_ops;
631
Harald Weltee555c2b2012-08-17 13:02:12 +0200632extern const struct value_string bts_type_names[_NUM_GSM_BTS_TYPE+1];
633extern const struct value_string bts_type_descs[_NUM_GSM_BTS_TYPE+1];
634
Max3d049d22017-10-09 17:12:53 +0200635char *get_model_oml_status(const struct gsm_bts *bts);
636
Max25cc4072017-10-10 14:50:35 +0200637unsigned long long bts_uptime(const struct gsm_bts *bts);
638
Holger Hans Peter Freytherf8c42192013-01-09 17:03:27 +0100639/* control interface handling */
640int bsc_base_ctrl_cmds_install(void);
641
Holger Hans Peter Freytherc22930e2014-12-17 14:46:17 +0100642/* dependency handling */
643void bts_depend_mark(struct gsm_bts *bts, int dep);
644void bts_depend_clear(struct gsm_bts *bts, int dep);
645int bts_depend_check(struct gsm_bts *bts);
Holger Hans Peter Freytherf7e23c52014-12-17 15:44:32 +0100646int bts_depend_is_depedency(struct gsm_bts *base, struct gsm_bts *other);
Holger Hans Peter Freytherc22930e2014-12-17 14:46:17 +0100647
Harald Welte2f8b9d22017-06-18 11:12:13 +0300648int gsm_bts_get_radio_link_timeout(const struct gsm_bts *bts);
649void gsm_bts_set_radio_link_timeout(struct gsm_bts *bts, int value);
650
Harald Weltea43e0b42016-06-19 18:06:02 +0200651bool classmark_is_r99(struct gsm_classmark *cm);
652
Harald Welte6be350c2011-05-25 13:10:08 +0200653#endif /* _GSM_DATA_H */