blob: 74970b92e7db8c56d2590af6ea61fb9eef1e8194 [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 Hofmeyrc29505e2016-05-20 21:59:55 +020017#include <openbsc/common.h>
Harald Welteb96be392011-05-25 12:33:33 +020018#include <openbsc/rest_octets.h>
Neels Hofmeyr402006d2016-05-11 14:28:25 +020019#include <openbsc/common_cs.h>
Neels Hofmeyrbecfc4c2017-07-19 16:48:42 +020020#include <osmocom/legacy_mgcp/mgcpgw_client.h>
Harald Welteb96be392011-05-25 12:33:33 +020021
Philipp Maier39f62bb2017-04-09 12:32:51 +020022
Holger Hans Peter Freytherd7b22c62013-04-29 09:11:02 +020023/** annotations for msgb ownership */
24#define __uses
25
Holger Hans Peter Freyther6f615552010-11-15 20:50:42 +010026#define OBSC_NM_W_ACK_CB(__msgb) (__msgb)->cb[3]
27
Holger Hans Peter Freyther694c82d2011-10-26 18:37:09 +020028struct mncc_sock_state;
Jacob Erlbeck1e30a282014-12-03 09:28:24 +010029struct gsm_subscriber_group;
Neels Hofmeyr6d804b12017-02-18 22:20:46 +010030struct bsc_subscr;
Harald Weltea43e0b42016-06-19 18:06:02 +020031struct vlr_instance;
32struct vlr_subscr;
Neels Hofmeyreb228bd2017-07-05 15:19:52 +020033struct ranap_ue_conn_ctx;
Neels Hofmeyr7b656882017-07-09 22:09:18 +020034struct gprs_ra_id;
Holger Hans Peter Freyther694c82d2011-10-26 18:37:09 +020035
Holger Hans Peter Freyther9c595b72010-06-15 11:20:52 +080036#define OBSC_LINKID_CB(__msgb) (__msgb)->cb[3]
37
Neels Hofmeyr0e5d8072017-01-10 00:49:56 +010038#define tmsi_from_string(str) strtoul(str, NULL, 10)
39
Max70fdd242017-06-15 15:10:53 +020040/* 3-bit long values */
41#define EARFCN_PRIO_INVALID 8
42#define EARFCN_MEAS_BW_INVALID 8
43/* 5-bit long values */
44#define EARFCN_QRXLV_INVALID 32
45#define EARFCN_THRESH_LOW_INVALID 32
46
Sylvain Munaut30a15382009-12-24 00:27:26 +010047enum gsm_security_event {
48 GSM_SECURITY_NOAVAIL,
49 GSM_SECURITY_AUTH_FAILED,
50 GSM_SECURITY_SUCCEEDED,
Andreas Eversberg641475c2013-07-10 08:58:03 +020051 GSM_SECURITY_ALREADY,
Sylvain Munaut30a15382009-12-24 00:27:26 +010052};
53
Harald Welte8e1e3ee2009-02-01 13:32:45 +000054struct msgb;
55typedef int gsm_cbfn(unsigned int hooknum,
56 unsigned int event,
57 struct msgb *msg,
58 void *data, void *param);
59
Sylvain Munaut47193072009-12-27 21:56:14 +010060/* Real authentication information containing Ki */
61enum gsm_auth_algo {
62 AUTH_ALGO_NONE,
63 AUTH_ALGO_XOR,
64 AUTH_ALGO_COMP128v1,
65};
66
67struct gsm_auth_info {
68 enum gsm_auth_algo auth_algo;
69 unsigned int a3a8_ki_len;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +020070 uint8_t a3a8_ki[16];
Sylvain Munaut47193072009-12-27 21:56:14 +010071};
72
73struct gsm_auth_tuple {
74 int use_count;
75 int key_seq;
Harald Welte121e9a42016-04-20 13:13:19 +020076 struct osmo_auth_vector vec;
Sylvain Munaut47193072009-12-27 21:56:14 +010077};
Sylvain Munautb48216f2010-06-09 12:45:37 +020078#define GSM_KEY_SEQ_INVAL 7 /* GSM 04.08 - 10.5.1.2 */
Sylvain Munaut47193072009-12-27 21:56:14 +010079
Holger Freyther73487a22008-12-31 18:53:57 +000080/*
Sylvain Munaut30a15382009-12-24 00:27:26 +010081 * AUTHENTICATION/CIPHERING state
82 */
83struct gsm_security_operation {
84 struct gsm_auth_tuple atuple;
85 gsm_cbfn *cb;
86 void *cb_data;
87};
88
Holger Hans Peter Freyther02d39b22010-07-05 15:34:16 +080089/*
90 * A dummy to keep a connection up for at least
91 * a couple of seconds to work around MSC issues.
92 */
93struct gsm_anchor_operation {
Pablo Neira Ayusobf540cb2011-05-06 12:11:06 +020094 struct osmo_timer_list timeout;
Holger Hans Peter Freyther02d39b22010-07-05 15:34:16 +080095};
96
Harald Weltef7c28b02009-12-21 13:30:17 +010097/* Maximum number of neighbor cells whose average we track */
98#define MAX_NEIGH_MEAS 10
99/* Maximum size of the averaging window for neighbor cells */
100#define MAX_WIN_NEIGH_AVG 10
101
102/* processed neighbor measurements for one cell */
103struct neigh_meas_proc {
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200104 uint16_t arfcn;
105 uint8_t bsic;
106 uint8_t rxlev[MAX_WIN_NEIGH_AVG];
Harald Weltef7c28b02009-12-21 13:30:17 +0100107 unsigned int rxlev_cnt;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200108 uint8_t last_seen_nr;
Harald Weltef7c28b02009-12-21 13:30:17 +0100109};
110
Neels Hofmeyrd3270a92017-02-02 01:07:28 +0100111enum ran_type {
112 RAN_UNKNOWN,
113 RAN_GERAN_A, /* 2G / A-interface */
114 RAN_UTRAN_IU, /* 3G / Iu-interface (IuCS or IuPS) */
115};
116
Neels Hofmeyrc29505e2016-05-20 21:59:55 +0200117extern const struct value_string ran_type_names[];
118static inline const char *ran_type_name(enum ran_type val)
119{ return get_value_string(ran_type_names, val); }
120
Harald Weltea43e0b42016-06-19 18:06:02 +0200121struct gsm_classmark {
122 bool classmark1_set;
123 struct gsm48_classmark1 classmark1;
124 uint8_t classmark2_len;
125 uint8_t classmark2[3];
126 uint8_t classmark3_len;
127 uint8_t classmark3[14]; /* if cm3 gets extended by spec, it will be truncated */
128};
129
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200130enum integrity_protection_state {
131 INTEGRITY_PROTECTION_NONE = 0,
132 INTEGRITY_PROTECTION_IK = 1,
133 INTEGRITY_PROTECTION_IK_CK = 2,
134};
135
Neels Hofmeyr378a4922016-05-09 21:07:43 +0200136/* active radio connection of a mobile subscriber */
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100137struct gsm_subscriber_connection {
Harald Weltea43e0b42016-06-19 18:06:02 +0200138 /* global linked list of subscriber_connections */
Holger Hans Peter Freyther79f763f2010-09-16 00:53:37 +0800139 struct llist_head entry;
140
Harald Weltea43e0b42016-06-19 18:06:02 +0200141 /* usage count. If this drops to zero, we start the release
142 * towards A/Iu */
143 uint32_t use_count;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100144
Harald Weltea43e0b42016-06-19 18:06:02 +0200145 /* The MS has opened the conn with a CM Service Request, and we shall
146 * keep it open for an actual request (or until timeout). */
147 bool received_cm_service_request;
148
149 /* libbsc subscriber information (if available) */
Neels Hofmeyr6d804b12017-02-18 22:20:46 +0100150 struct bsc_subscr *bsub;
151
Harald Weltea43e0b42016-06-19 18:06:02 +0200152 /* libmsc/libvlr subscriber information (if available) */
153 struct vlr_subscr *vsub;
154
Holger Hans Peter Freythere7bd8632013-06-30 15:30:47 +0200155 /* LU expiration handling */
156 uint8_t expire_timer_stopped;
Holger Hans Peter Freytherca114432014-02-08 15:20:48 +0100157 /* SMS helpers for libmsc */
158 uint8_t next_rp_ref;
Holger Hans Peter Freythere7bd8632013-06-30 15:30:47 +0200159
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100160 /*
161 * Operations that have a state and might be pending
162 */
Sylvain Munaut30a15382009-12-24 00:27:26 +0100163 struct gsm_security_operation *sec_operation;
Holger Hans Peter Freyther02d39b22010-07-05 15:34:16 +0800164 struct gsm_anchor_operation *anch_operation;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100165
Harald Weltea43e0b42016-06-19 18:06:02 +0200166 struct osmo_fsm_inst *conn_fsm;
167
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100168 /* Are we part of a special "silent" call */
169 int silent_call;
170
Holger Hans Peter Freytherc8a6c132015-08-04 13:32:09 +0200171 /* MNCC rtp bridge markers */
172 int mncc_rtp_bridge;
173 int mncc_rtp_create_pending;
Holger Hans Peter Freytherc21dcb22015-08-04 14:41:21 +0200174 int mncc_rtp_connect_pending;
Holger Hans Peter Freytherc8a6c132015-08-04 13:32:09 +0200175
Holger Hans Peter Freyther2f9d1ef2010-09-16 20:14:01 +0800176 /* bsc structures */
Neels Hofmeyrce090f82016-05-30 15:00:23 +0200177 struct osmo_bsc_sccp_con *sccp_con; /* BSC */
Holger Hans Peter Freyther2f9d1ef2010-09-16 20:14:01 +0800178
Holger Hans Peter Freyther18b63f42010-03-23 07:52:17 +0100179 /* back pointers */
Neels Hofmeyr5e0b0a62016-05-09 22:33:01 +0200180 struct gsm_network *network;
181
Harald Weltea43e0b42016-06-19 18:06:02 +0200182 bool in_release;
Neels Hofmeyrce090f82016-05-30 15:00:23 +0200183 struct gsm_lchan *lchan; /* BSC */
184 struct gsm_lchan *ho_lchan; /* BSC */
185 struct gsm_bts *bts; /* BSC */
Holger Hans Peter Freyther77cd95d2010-11-14 16:19:48 +0100186
187 /* for assignment handling */
Neels Hofmeyrce090f82016-05-30 15:00:23 +0200188 struct osmo_timer_list T10; /* BSC */
189 struct gsm_lchan *secondary_lchan; /* BSC */
Holger Hans Peter Freyther77cd95d2010-11-14 16:19:48 +0100190
Neels Hofmeyrd3270a92017-02-02 01:07:28 +0100191 /* connected via 2G or 3G? */
192 enum ran_type via_ran;
Harald Weltea43e0b42016-06-19 18:06:02 +0200193
194 struct gsm_classmark classmark;
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200195
196 uint16_t lac;
197 struct gsm_encr encr;
198
Philipp Maier39f62bb2017-04-09 12:32:51 +0200199 struct {
200 unsigned int mgcp_rtp_endpoint;
201 uint16_t port_subscr;
202 uint16_t port_cn;
203 } rtp;
204
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200205 /* which Iu-CS connection, if any. */
206 struct {
Neels Hofmeyreb228bd2017-07-05 15:19:52 +0200207 struct ranap_ue_conn_ctx *ue_ctx;
Neels Hofmeyrc29505e2016-05-20 21:59:55 +0200208 uint8_t rab_id;
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200209 } iu;
Philipp Maier39f62bb2017-04-09 12:32:51 +0200210
211 struct {
212 /* A pointer to the SCCP user that handles
213 * the SCCP connections for this subscriber
214 * connection */
215 struct osmo_sccp_user *scu;
216
217 /* The address of the BSC that is associated
218 * with this subscriber connection */
219 struct osmo_sccp_addr bsc_addr;
220
221 /* The connection identifier that is used
222 * to reference the SCCP connection that is
223 * associated with this subscriber connection */
224 int conn_id;
225 } a;
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100226};
227
Harald Weltef142c972011-05-24 13:25:38 +0200228
Harald Welte6be350c2011-05-25 13:10:08 +0200229#define ROLE_BSC
230#include "gsm_data_shared.h"
Holger Hans Peter Freyther68884aa2010-03-23 06:41:45 +0100231
Holger Hans Peter Freyther5ba6f482009-10-28 14:23:39 +0100232
Alexander Couzens20423ea2016-07-12 15:42:02 +0200233enum {
Alexander Couzensb847a212016-08-02 11:34:11 +0200234 BSC_CTR_CHREQ_TOTAL,
235 BSC_CTR_CHREQ_NO_CHANNEL,
236 BSC_CTR_HANDOVER_ATTEMPTED,
237 BSC_CTR_HANDOVER_NO_CHANNEL,
238 BSC_CTR_HANDOVER_TIMEOUT,
239 BSC_CTR_HANDOVER_COMPLETED,
240 BSC_CTR_HANDOVER_FAILED,
241 BSC_CTR_PAGING_ATTEMPTED,
242 BSC_CTR_PAGING_DETACHED,
243 BSC_CTR_PAGING_COMPLETED,
244 BSC_CTR_PAGING_EXPIRED,
245 BSC_CTR_CHAN_RF_FAIL,
246 BSC_CTR_CHAN_RLL_ERR,
247 BSC_CTR_BTS_OML_FAIL,
248 BSC_CTR_BTS_RSL_FAIL,
Alexander Couzens8c53c592016-08-23 06:27:19 +0200249 BSC_CTR_CODEC_AMR_F,
250 BSC_CTR_CODEC_AMR_H,
251 BSC_CTR_CODEC_EFR,
252 BSC_CTR_CODEC_V1_FR,
253 BSC_CTR_CODEC_V1_HR,
Alexander Couzensb847a212016-08-02 11:34:11 +0200254};
255
256static const struct rate_ctr_desc bsc_ctr_description[] = {
257 [BSC_CTR_CHREQ_TOTAL] = {"chreq.total", "Received channel requests."},
258 [BSC_CTR_CHREQ_NO_CHANNEL] = {"chreq.no_channel", "Sent to MS no channel available."},
259 [BSC_CTR_HANDOVER_ATTEMPTED] = {"handover.attempted", "Received handover attempts."},
260 [BSC_CTR_HANDOVER_NO_CHANNEL] = {"handover.no_channel", "Sent no channel available responses."},
261 [BSC_CTR_HANDOVER_TIMEOUT] = {"handover.timeout", "Count the amount of timeouts of timer T3103."},
262 [BSC_CTR_HANDOVER_COMPLETED] = {"handover.completed", "Received handover completed."},
263 [BSC_CTR_HANDOVER_FAILED] = {"handover.failed", "Receive HO FAIL messages."},
264 [BSC_CTR_PAGING_ATTEMPTED] = {"paging.attempted", "Paging attempts for a MS."},
265 [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."},
266 [BSC_CTR_PAGING_COMPLETED] = {"paging.completed", "Paging successful completed."},
267 [BSC_CTR_PAGING_EXPIRED] = {"paging.expired", "Paging Request expired because of timeout T3113."},
268 [BSC_CTR_CHAN_RF_FAIL] = {"chan.rf_fail", "Received a RF failure indication from BTS."},
269 [BSC_CTR_CHAN_RLL_ERR] = {"chan.rll_err", "Received a RLL failure with T200 cause from BTS."},
270 [BSC_CTR_BTS_OML_FAIL] = {"bts.oml_fail", "Received a TEI down on a OML link."},
271 [BSC_CTR_BTS_RSL_FAIL] = {"bts.rsl_fail", "Received a TEI down on a OML link."},
Alexander Couzens8c53c592016-08-23 06:27:19 +0200272 [BSC_CTR_CODEC_AMR_F] = {"bts.codec_amr_f", "Count the usage of AMR/F codec by channel mode requested."},
273 [BSC_CTR_CODEC_AMR_H] = {"bts.codec_amr_h", "Count the usage of AMR/H codec by channel mode requested."},
274 [BSC_CTR_CODEC_EFR] = {"bts.codec_efr", "Count the usage of EFR codec by channel mode requested."},
275 [BSC_CTR_CODEC_V1_FR] = {"bts.codec_fr", "Count the usage of FR codec by channel mode requested."},
276 [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 +0200277};
278
279enum {
Alexander Couzens20423ea2016-07-12 15:42:02 +0200280 MSC_CTR_LOC_UPDATE_TYPE_ATTACH,
281 MSC_CTR_LOC_UPDATE_TYPE_NORMAL,
282 MSC_CTR_LOC_UPDATE_TYPE_PERIODIC,
283 MSC_CTR_LOC_UPDATE_TYPE_DETACH,
Neels Hofmeyr36891a72016-05-09 13:18:03 +0200284 MSC_CTR_LOC_UPDATE_FAILED,
285 MSC_CTR_LOC_UPDATE_COMPLETED,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200286 MSC_CTR_SMS_SUBMITTED,
287 MSC_CTR_SMS_NO_RECEIVER,
288 MSC_CTR_SMS_DELIVERED,
289 MSC_CTR_SMS_RP_ERR_MEM,
290 MSC_CTR_SMS_RP_ERR_OTHER,
Alexander Couzensaa386d22016-08-21 20:16:33 +0200291 MSC_CTR_SMS_DELIVER_UNKNOWN_ERROR,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200292 MSC_CTR_CALL_MO_SETUP,
293 MSC_CTR_CALL_MO_CONNECT_ACK,
294 MSC_CTR_CALL_MT_SETUP,
295 MSC_CTR_CALL_MT_CONNECT,
Alexander Couzens92f552f2016-08-23 07:32:27 +0200296 MSC_CTR_CALL_ACTIVE,
297 MSC_CTR_CALL_COMPLETE,
298 MSC_CTR_CALL_INCOMPLETE,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200299};
300
301static const struct rate_ctr_desc msc_ctr_description[] = {
Alexander Couzens20423ea2016-07-12 15:42:02 +0200302 [MSC_CTR_LOC_UPDATE_TYPE_ATTACH] = {"loc_update_type.attach", "Received location update imsi attach requests."},
303 [MSC_CTR_LOC_UPDATE_TYPE_NORMAL] = {"loc_update_type.normal", "Received location update normal requests."},
304 [MSC_CTR_LOC_UPDATE_TYPE_PERIODIC] = {"loc_update_type.periodic", "Received location update periodic requests."},
305 [MSC_CTR_LOC_UPDATE_TYPE_DETACH] = {"loc_update_type.detach", "Received location update detach indication."},
Neels Hofmeyr36891a72016-05-09 13:18:03 +0200306 [MSC_CTR_LOC_UPDATE_FAILED] = {"loc_update_resp.failed", "Rejected location updates."},
307 [MSC_CTR_LOC_UPDATE_COMPLETED] = {"loc_update_resp.completed", "Successful location updates."},
Alexander Couzens20423ea2016-07-12 15:42:02 +0200308 [MSC_CTR_SMS_SUBMITTED] = {"sms.submitted", "Received a RPDU from a MS (MO)."},
309 [MSC_CTR_SMS_NO_RECEIVER] = {"sms.no_receiver", "Counts SMS which couldn't routed because no receiver found."},
310 [MSC_CTR_SMS_DELIVERED] = {"sms.delivered", "Global SMS Deliver attempts."},
311 [MSC_CTR_SMS_RP_ERR_MEM] = {"sms.rp_err_mem", "CAUSE_MT_MEM_EXCEEDED errors of MS responses on a sms deliver attempt."},
312 [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 +0200313 [MSC_CTR_SMS_DELIVER_UNKNOWN_ERROR] = {"sms.deliver_unknown_error", "Unknown error occured during sms delivery."},
Alexander Couzens20423ea2016-07-12 15:42:02 +0200314 /* FIXME: count also sms delivered */
315 [MSC_CTR_CALL_MO_SETUP] = {"call.mo_setup", "Received setup requests from a MS to init a MO call."},
316 [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."},
317 [MSC_CTR_CALL_MT_SETUP] = {"call.mt_setup", "Sent setup requests to the MS (MT)."},
318 [MSC_CTR_CALL_MT_CONNECT] = {"call.mt_connect", "Sent a connect to the MS (MT)."},
Alexander Couzens92f552f2016-08-23 07:32:27 +0200319 [MSC_CTR_CALL_ACTIVE] = {"call.active", "Count total amount of calls that ever reached active state."},
320 [MSC_CTR_CALL_COMPLETE] = {"call.complete", "Count total amount of calls which got terminated by disconnect req or ind after reaching active state."},
321 [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 +0200322};
323
324
325static const struct rate_ctr_group_desc bsc_ctrg_desc = {
326 "bsc",
327 "base station controller",
328 OSMO_STATS_CLASS_GLOBAL,
329 ARRAY_SIZE(bsc_ctr_description),
330 bsc_ctr_description,
Alexander Couzens20423ea2016-07-12 15:42:02 +0200331};
332
333static const struct rate_ctr_group_desc msc_ctrg_desc = {
334 "msc",
335 "mobile switching center",
336 OSMO_STATS_CLASS_GLOBAL,
337 ARRAY_SIZE(msc_ctr_description),
338 msc_ctr_description,
Harald Welte24ff6ee2009-12-22 00:41:05 +0100339};
340
Harald Welte (local)69de3972009-08-12 14:42:23 +0200341enum gsm_auth_policy {
342 GSM_AUTH_POLICY_CLOSED, /* only subscribers authorized in DB */
343 GSM_AUTH_POLICY_ACCEPT_ALL, /* accept everyone, even if not authorized in DB */
344 GSM_AUTH_POLICY_TOKEN, /* accept first, send token per sms, then revoke authorization */
Maxddee01f2016-05-24 14:23:27 +0200345 GSM_AUTH_POLICY_REGEXP, /* accept IMSIs matching given regexp */
Harald Welte (local)69de3972009-08-12 14:42:23 +0200346};
347
Harald Weltea0d324b2017-07-20 01:47:39 +0200348#define GSM_T3101_DEFAULT 10 /* s */
349#define GSM_T3103_DEFAULT 5 /* s */
350#define GSM_T3105_DEFAULT 100 /* ms */
351#define GSM_T3107_DEFAULT 5 /* s */
352#define GSM_T3109_DEFAULT 19 /* s, must be 2s + radio_link_timeout*0.48 */
353#define GSM_T3111_DEFAULT 2 /* s */
Harald Welteb84ddfc2009-12-01 17:36:54 +0530354#define GSM_T3113_DEFAULT 60
Harald Weltea0d324b2017-07-20 01:47:39 +0200355#define GSM_T3115_DEFAULT 10
356#define GSM_T3117_DEFAULT 10
357#define GSM_T3119_DEFAULT 10
Andreas Eversberg75e13a42013-02-07 11:51:16 +0100358#define GSM_T3122_DEFAULT 10
Harald Weltea0d324b2017-07-20 01:47:39 +0200359#define GSM_T3141_DEFAULT 10
Harald Welteb84ddfc2009-12-01 17:36:54 +0530360
Neels Hofmeyr73983952016-05-10 13:29:33 +0200361struct gsm_tz {
362 int override; /* if 0, use system's time zone instead. */
363 int hr; /* hour */
364 int mn; /* minute */
365 int dst; /* daylight savings */
366};
367
Harald Welte52b1f982008-12-23 20:25:15 +0000368struct gsm_network {
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200369 /* TODO MSCSPLIT the gsm_network struct is basically a kitchen sink for
370 * global settings and variables, "madly" mixing BSC and MSC stuff. Split
371 * this in e.g. struct osmo_bsc and struct osmo_msc, with the things
372 * these have in common, like country and network code, put in yet
373 * separate structs and placed as members in osmo_bsc and osmo_msc. */
374
Harald Welte52b1f982008-12-23 20:25:15 +0000375 /* global parameters */
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200376 uint16_t country_code;
377 uint16_t network_code;
Harald Weltec6ba9c22008-12-30 18:01:02 +0000378 char *name_long;
379 char *name_short;
Harald Welte (local)69de3972009-08-12 14:42:23 +0200380 enum gsm_auth_policy auth_policy;
Maxddee01f2016-05-24 14:23:27 +0200381 regex_t authorized_regexp;
382 char *authorized_reg_str;
Harald Welte1085c092009-11-18 20:33:19 +0100383 enum gsm48_reject_value reject_cause;
Harald Welte4381cfe2009-08-30 15:47:06 +0900384 int a5_encryption;
Harald Weltea43e0b42016-06-19 18:06:02 +0200385 bool authentication_required;
Holger Hans Peter Freytherf7d752f2009-11-16 17:12:38 +0100386 int neci;
Harald Welte648b6ce2009-12-14 09:00:24 +0100387 int send_mm_info;
Harald Weltebc814502009-12-19 21:41:52 +0100388 struct {
389 int active;
Harald Weltef7c28b02009-12-21 13:30:17 +0100390 /* Window RXLEV averaging */
391 unsigned int win_rxlev_avg; /* number of SACCH frames */
392 /* Window RXQUAL averaging */
393 unsigned int win_rxqual_avg; /* number of SACCH frames */
394 /* Window RXLEV neighbouring cells averaging */
395 unsigned int win_rxlev_avg_neigh; /* number of SACCH frames */
396
397 /* how often should we check for power budget HO */
398 unsigned int pwr_interval; /* SACCH frames */
399 /* how much better does a neighbor cell have to be ? */
400 unsigned int pwr_hysteresis; /* dBm */
401 /* maximum distacne before we try a handover */
402 unsigned int max_distance; /* TA values */
Harald Weltebc814502009-12-19 21:41:52 +0100403 } handover;
Harald Welte52b1f982008-12-23 20:25:15 +0000404
Alexander Couzensb847a212016-08-02 11:34:11 +0200405 struct rate_ctr_group *bsc_ctrs;
406 struct rate_ctr_group *msc_ctrs;
Alexander Couzens92f552f2016-08-23 07:32:27 +0200407 struct osmo_counter *active_calls;
Harald Welte24ff6ee2009-12-22 00:41:05 +0100408
Harald Welte4bfdfe72009-06-10 23:11:52 +0800409 /* layer 4 */
Holger Hans Peter Freyther694c82d2011-10-26 18:37:09 +0200410 struct mncc_sock_state *mncc_state;
Neels Hofmeyr402006d2016-05-11 14:28:25 +0200411 mncc_recv_cb_t mncc_recv;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800412 struct llist_head upqueue;
Neels Hofmeyrc29505e2016-05-20 21:59:55 +0200413 /*
414 * TODO: Move the trans_list into the subscriber connection and
415 * create a pending list for MT transactions. These exist before
416 * we have a subscriber connection.
417 */
Harald Welte4bfdfe72009-06-10 23:11:52 +0800418 struct llist_head trans_list;
Holger Hans Peter Freytherabcddf12010-06-14 18:20:15 +0800419 struct bsc_api *bsc_api;
Harald Welte4bfdfe72009-06-10 23:11:52 +0800420
Harald Welte52b1f982008-12-23 20:25:15 +0000421 unsigned int num_bts;
Harald Weltee441d9c2009-06-21 16:17:15 +0200422 struct llist_head bts_list;
Holger Hans Peter Freytherc4d88ad2009-11-21 21:18:38 +0100423
424 /* timer values */
425 int T3101;
Holger Hans Peter Freyther23975e72009-11-21 21:42:26 +0100426 int T3103;
427 int T3105;
428 int T3107;
429 int T3109;
430 int T3111;
431 int T3113;
432 int T3115;
433 int T3117;
434 int T3119;
Harald Welte2862dca2010-12-23 14:39:29 +0100435 int T3122;
Holger Hans Peter Freyther23975e72009-11-21 21:42:26 +0100436 int T3141;
Harald Welteeab84a12009-12-13 10:53:12 +0100437
Jan Luebbebfbdeec2012-12-27 00:27:16 +0100438 /* timer to expire old location updates */
439 struct osmo_timer_list subscr_expire_timer;
440
Harald Welteeab84a12009-12-13 10:53:12 +0100441 /* Radio Resource Location Protocol (TS 04.31) */
442 struct {
443 enum rrlp_mode mode;
444 } rrlp;
Holger Hans Peter Freyther5a3a61d2010-09-06 09:25:48 +0800445
Alexander Couzens11368112016-11-28 23:26:50 +0100446 enum gsm_chan_t ctype_by_chreq[18];
Holger Hans Peter Freyther78891072010-09-06 09:36:02 +0800447
Holger Hans Peter Freyther76fc4a32010-09-06 09:41:50 +0800448 /* Use a TCH for handling requests of type paging any */
449 int pag_any_tch;
450
Holger Hans Peter Freyther3e8e0462010-09-15 22:29:25 +0800451 /* MSC data in case we are a true BSC */
Holger Hans Peter Freyther8ec49522011-08-15 15:53:00 +0200452 struct osmo_bsc_data *bsc_data;
Holger Hans Peter Freytherdaee5ca2010-12-22 12:34:39 +0100453
Holger Hans Peter Freyther11b28f92010-12-24 13:48:27 +0100454 struct gsm_sms_queue *sms_queue;
Daniel Willmann6fc4a982011-07-22 17:55:42 +0200455
456 /* control interface */
457 struct ctrl_handle *ctrl;
Neels Hofmeyr5f0c71b2016-07-23 20:15:28 +0200458
459 /* Allow or disallow TCH/F on dynamic TCH/F_TCH/H_PDCH; OS#1778 */
460 bool dyn_ts_allow_tch_f;
Neels Hofmeyrd90fa422016-05-09 21:03:12 +0200461
462 /* all active subscriber connections. */
463 struct llist_head subscr_conns;
Neels Hofmeyr73983952016-05-10 13:29:33 +0200464
465 /* if override is nonzero, this timezone data is used for all MM
466 * contexts. */
467 /* TODO: in OsmoNITB, tz-override used to be BTS-specific. To enable
468 * BTS|RNC specific timezone overrides for multi-tz networks in
Neels Hofmeyrfe291de2017-02-23 21:06:12 +0100469 * OsmoMSC, this should be tied to the location area code (LAC). */
Neels Hofmeyr73983952016-05-10 13:29:33 +0200470 struct gsm_tz tz;
Neels Hofmeyr6d804b12017-02-18 22:20:46 +0100471
472 /* List of all struct bsc_subscr used in libbsc. This llist_head is
473 * allocated so that the llist_head pointer itself can serve as a
474 * talloc context (useful to not have to pass the entire gsm_network
475 * struct to the bsc_subscr_* API, and for bsc_susbscr unit tests to
476 * not require gsm_data.h). In an MSC-without-BSC environment, this
477 * pointer is NULL to indicate absence of a bsc_subscribers list. */
478 struct llist_head *bsc_subscribers;
Harald Weltea43e0b42016-06-19 18:06:02 +0200479
480 /* MSC: GSUP server address of the HLR */
481 const char *gsup_server_addr_str;
482 uint16_t gsup_server_port;
483
484 struct vlr_instance *vlr;
Neels Hofmeyrce4d88b2017-05-08 15:12:20 +0200485
486 /* Periodic location update default value */
487 uint8_t t3212;
Neels Hofmeyrc29505e2016-05-20 21:59:55 +0200488
489 struct {
490 struct mgcpgw_client_conf conf;
491 struct mgcpgw_client *client;
492 } mgcpgw;
493
494 struct {
Philipp Maier39f62bb2017-04-09 12:32:51 +0200495 /* CS7 instance id number (set via VTY) */
496 uint32_t cs7_instance;
Neels Hofmeyreb228bd2017-07-05 15:19:52 +0200497 int rab_assign_addr_enc;
Philipp Maier39f62bb2017-04-09 12:32:51 +0200498 struct osmo_sccp_instance *sccp;
Neels Hofmeyrc29505e2016-05-20 21:59:55 +0200499 } iu;
Philipp Maier39f62bb2017-04-09 12:32:51 +0200500
501 struct {
502 /* CS7 instance id number (set via VTY) */
503 uint32_t cs7_instance;
504 /* A list with the context information about
505 * all BSCs we have connections with */
506 struct llist_head bscs;
507 struct osmo_sccp_instance *sccp;
508 } a;
Harald Welte52b1f982008-12-23 20:25:15 +0000509};
510
Harald Welted4bdee72012-11-08 19:44:08 +0100511struct osmo_esme;
512
513enum gsm_sms_source_id {
514 SMS_SOURCE_UNKNOWN = 0,
515 SMS_SOURCE_MS, /* received from MS */
516 SMS_SOURCE_VTY, /* received from VTY */
517 SMS_SOURCE_SMPP, /* received via SMPP */
518};
519
Harald Welte7e310b12009-03-30 20:56:32 +0000520#define SMS_HDR_SIZE 128
521#define SMS_TEXT_SIZE 256
Harald Weltee07b6a72012-11-23 19:02:37 +0100522
523struct gsm_sms_addr {
524 uint8_t ton;
525 uint8_t npi;
526 char addr[21+1];
527};
528
Harald Welte7e310b12009-03-30 20:56:32 +0000529struct gsm_sms {
Harald Welted409be72009-11-07 00:06:19 +0900530 unsigned long long id;
Harald Weltea43e0b42016-06-19 18:06:02 +0200531 struct vlr_subscr *receiver;
Harald Weltec0de14d2012-11-23 23:35:01 +0100532 struct gsm_sms_addr src, dst;
Harald Welted4bdee72012-11-08 19:44:08 +0100533 enum gsm_sms_source_id source;
534
535 struct {
Pablo Neira Ayuso93ffbd02017-05-04 18:44:22 +0200536 uint8_t transaction_id;
537 uint32_t msg_ref;
538 } gsm411;
539
540 struct {
Harald Welted4bdee72012-11-08 19:44:08 +0100541 struct osmo_esme *esme;
542 uint32_t sequence_nr;
543 int transaction_mode;
544 char msg_id[16];
545 } smpp;
Harald Welte7e310b12009-03-30 20:56:32 +0000546
Harald Welteb9c758b2009-07-05 14:02:46 +0200547 unsigned long validity_minutes;
Keith5f9d0bd2017-08-16 22:45:07 +0200548 time_t created;
Pablo Neira Ayusoe1cdc322017-08-07 14:01:30 +0100549 bool is_report;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200550 uint8_t reply_path_req;
551 uint8_t status_rep_req;
552 uint8_t ud_hdr_ind;
553 uint8_t protocol_id;
554 uint8_t data_coding_scheme;
555 uint8_t msg_ref;
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200556 uint8_t user_data_len;
557 uint8_t user_data[SMS_TEXT_SIZE];
Harald Weltef3efc592009-07-27 20:11:35 +0200558
Harald Welte7e310b12009-03-30 20:56:32 +0000559 char text[SMS_TEXT_SIZE];
560};
561
Neels Hofmeyrc13e6872016-05-11 13:53:47 +0200562extern void talloc_ctx_init(void *ctx_root);
563
Harald Welte39315c42010-01-10 18:01:52 +0100564int gsm_set_bts_type(struct gsm_bts *bts, enum gsm_bts_type type);
Harald Weltee441d9c2009-06-21 16:17:15 +0200565
Harald Welte1d014a52009-08-08 15:38:29 +0200566enum gsm_bts_type parse_btstype(const char *arg);
Holger Hans Peter Freyther2dceae62009-06-12 17:39:38 +0200567const char *btstype2str(enum gsm_bts_type type);
Harald Weltebe991492009-05-23 13:56:40 +0000568struct gsm_bts *gsm_bts_by_lac(struct gsm_network *net, unsigned int lac,
569 struct gsm_bts *start_bts);
Harald Welte32201c12009-03-10 12:15:10 +0000570
Andreas Eversberg8226fa72009-06-29 15:19:38 +0200571extern void *tall_bsc_ctx;
Harald Weltef88c8a02009-12-20 13:48:15 +0100572extern int ipacc_rtp_direct;
Harald Welte2cf161b2009-06-20 22:36:41 +0200573
Harald Weltef383aa12012-07-02 19:51:55 +0200574/* this actaully refers to the IPA transport, not the BTS model */
Harald Welte32201c12009-03-10 12:15:10 +0000575static inline int is_ipaccess_bts(struct gsm_bts *bts)
576{
577 switch (bts->type) {
Mike Habene2d82272009-10-02 12:19:34 +0100578 case GSM_BTS_TYPE_NANOBTS:
Maxf9685c12017-03-23 12:01:07 +0100579 case GSM_BTS_TYPE_OSMOBTS:
Harald Welte32201c12009-03-10 12:15:10 +0000580 return 1;
581 default:
582 break;
583 }
584 return 0;
585}
586
Holger Hans Peter Freyther6f6cbf72015-04-04 19:35:22 +0200587static inline int is_sysmobts_v2(struct gsm_bts *bts)
588{
589 switch (bts->type) {
Maxf9685c12017-03-23 12:01:07 +0100590 case GSM_BTS_TYPE_OSMOBTS:
Holger Hans Peter Freyther6f6cbf72015-04-04 19:35:22 +0200591 return 1;
592 default:
593 break;
594 }
595 return 0;
596}
597
Harald Welte5b570672009-08-10 10:08:01 +0200598static inline int is_siemens_bts(struct gsm_bts *bts)
599{
600 switch (bts->type) {
601 case GSM_BTS_TYPE_BS11:
602 return 1;
603 default:
604 break;
605 }
606
607 return 0;
608}
609
Andreas Eversberg7d8fa342013-12-05 13:25:06 +0100610static inline int is_nokia_bts(struct gsm_bts *bts)
611{
612 switch (bts->type) {
613 case GSM_BTS_TYPE_NOKIA_SITE:
614 return 1;
615 default:
616 break;
617 }
618
619 return 0;
620}
621
Andreas Eversbergdcf38e12013-12-05 14:37:11 +0100622static inline int is_e1_bts(struct gsm_bts *bts)
623{
624 switch (bts->type) {
625 case GSM_BTS_TYPE_BS11:
626 case GSM_BTS_TYPE_RBS2000:
627 case GSM_BTS_TYPE_NOKIA_SITE:
628 return 1;
629 default:
630 break;
631 }
632
633 return 0;
634}
635
Harald Welte (local)69de3972009-08-12 14:42:23 +0200636enum gsm_auth_policy gsm_auth_policy_parse(const char *arg);
637const char *gsm_auth_policy_name(enum gsm_auth_policy policy);
638
Harald Welteeab84a12009-12-13 10:53:12 +0100639enum rrlp_mode rrlp_mode_parse(const char *arg);
640const char *rrlp_mode_name(enum rrlp_mode mode);
641
Holger Hans Peter Freyther4e13a8f2015-01-31 22:16:00 +0100642enum bts_gprs_mode bts_gprs_mode_parse(const char *arg, int *valid);
Harald Welte4511d892010-04-18 15:51:20 +0200643const char *bts_gprs_mode_name(enum bts_gprs_mode mode);
Holger Hans Peter Freyther4e13a8f2015-01-31 22:16:00 +0100644int bts_gprs_mode_is_compat(struct gsm_bts *bts, enum bts_gprs_mode mode);
Harald Welte4511d892010-04-18 15:51:20 +0200645
Holger Hans Peter Freytherc42ad8b2011-04-18 17:04:00 +0200646int gsm48_ra_id_by_bts(uint8_t *buf, struct gsm_bts *bts);
Harald Welte97a282b2010-03-14 15:37:43 +0800647void gprs_ra_id_by_bts(struct gprs_ra_id *raid, struct gsm_bts *bts);
Harald Welted12b0fd2009-12-15 21:36:05 +0100648
Harald Weltef3d8e922010-06-14 22:44:42 +0200649int gsm_btsmodel_set_feature(struct gsm_bts_model *model, enum gsm_bts_features feat);
Harald Weltefbda4e12010-03-04 11:04:52 +0100650int gsm_bts_model_register(struct gsm_bts_model *model);
651
Neels Hofmeyr42eb0142016-05-20 17:15:44 +0200652struct gsm_subscriber_connection *bsc_subscr_con_allocate(struct gsm_lchan *lchan);
653void bsc_subscr_con_free(struct gsm_subscriber_connection *conn);
654
655struct gsm_subscriber_connection *msc_subscr_con_allocate(struct gsm_network *network);
656void msc_subscr_con_free(struct gsm_subscriber_connection *conn);
Holger Hans Peter Freyther2412a072010-06-28 15:47:12 +0800657
Harald Welte3300c012011-06-05 13:31:33 +0200658struct gsm_bts *gsm_bts_alloc_register(struct gsm_network *net,
659 enum gsm_bts_type type,
Harald Weltea2bbc5e2015-11-20 10:43:31 +0100660 uint8_t bsic);
Harald Welte142d12d2014-12-29 17:47:08 +0100661
Harald Welte3300c012011-06-05 13:31:33 +0200662void set_ts_e1link(struct gsm_bts_trx_ts *ts, uint8_t e1_nr,
663 uint8_t e1_ts, uint8_t e1_ts_ss);
664
665void gsm_trx_lock_rf(struct gsm_bts_trx *trx, int locked);
Max71d082b2017-05-30 15:03:38 +0200666bool gsm_btsmodel_has_feature(struct gsm_bts_model *model, enum gsm_bts_features feat);
Harald Welte3300c012011-06-05 13:31:33 +0200667struct gsm_bts_trx *gsm_bts_trx_by_nr(struct gsm_bts *bts, int nr);
Holger Hans Peter Freythera49b2c02014-11-21 11:18:45 +0100668int gsm_bts_trx_set_system_infos(struct gsm_bts_trx *trx);
Alexander Chemerisc36a13b2015-05-30 14:40:54 -0400669int gsm_bts_set_system_infos(struct gsm_bts *bts);
Harald Welte3300c012011-06-05 13:31:33 +0200670
Pablo Neira Ayusoed5cacb2011-08-17 22:44:07 +0200671/* generic E1 line operations for all ISDN-based BTS. */
672extern struct e1inp_line_ops bts_isdn_e1inp_line_ops;
673
Harald Weltee555c2b2012-08-17 13:02:12 +0200674extern const struct value_string bts_type_names[_NUM_GSM_BTS_TYPE+1];
675extern const struct value_string bts_type_descs[_NUM_GSM_BTS_TYPE+1];
676
Holger Hans Peter Freytherf8c42192013-01-09 17:03:27 +0100677/* control interface handling */
678int bsc_base_ctrl_cmds_install(void);
Harald Weltea43e0b42016-06-19 18:06:02 +0200679int msc_ctrl_cmds_install(struct gsm_network *net);
Holger Hans Peter Freytherf8c42192013-01-09 17:03:27 +0100680
Holger Hans Peter Freytherc22930e2014-12-17 14:46:17 +0100681/* dependency handling */
682void bts_depend_mark(struct gsm_bts *bts, int dep);
683void bts_depend_clear(struct gsm_bts *bts, int dep);
684int bts_depend_check(struct gsm_bts *bts);
Holger Hans Peter Freytherf7e23c52014-12-17 15:44:32 +0100685int bts_depend_is_depedency(struct gsm_bts *base, struct gsm_bts *other);
Holger Hans Peter Freytherc22930e2014-12-17 14:46:17 +0100686
Harald Welte2f8b9d22017-06-18 11:12:13 +0300687int gsm_bts_get_radio_link_timeout(const struct gsm_bts *bts);
688void gsm_bts_set_radio_link_timeout(struct gsm_bts *bts, int value);
689
Harald Weltea43e0b42016-06-19 18:06:02 +0200690bool classmark_is_r99(struct gsm_classmark *cm);
691
Harald Welte6be350c2011-05-25 13:10:08 +0200692#endif /* _GSM_DATA_H */