Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 1 | #ifndef _GPRS_SGSN_H |
| 2 | #define _GPRS_SGSN_H |
| 3 | |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 4 | #include <stdint.h> |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 5 | #include <netinet/in.h> |
| 6 | |
Holger Hans Peter Freyther | 26d0fe3 | 2012-01-06 17:29:06 +0100 | [diff] [blame] | 7 | #include <osmocom/core/timer.h> |
| 8 | |
Pablo Neira Ayuso | 136f453 | 2011-03-22 16:47:59 +0100 | [diff] [blame] | 9 | #include <osmocom/gsm/gsm48.h> |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 10 | |
Harald Welte | 496aee4 | 2010-06-30 19:59:55 +0200 | [diff] [blame] | 11 | #include <osmocom/crypt/gprs_cipher.h> |
| 12 | |
Harald Welte | 2720e73 | 2010-05-17 00:44:57 +0200 | [diff] [blame] | 13 | #define GSM_IMSI_LENGTH 17 |
| 14 | #define GSM_IMEI_LENGTH 17 |
| 15 | #define GSM_EXTENSION_LENGTH 15 |
| 16 | |
Harald Welte | 807a5d8 | 2010-06-01 11:53:01 +0200 | [diff] [blame] | 17 | struct gprs_llc_lle; |
Holger Hans Peter Freyther | a273030 | 2014-03-23 18:08:26 +0100 | [diff] [blame] | 18 | struct ctrl_handle; |
Harald Welte | 807a5d8 | 2010-06-01 11:53:01 +0200 | [diff] [blame] | 19 | |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 20 | /* TS 04.08 4.1.3.3 GMM mobility management states on the network side */ |
| 21 | enum gprs_mm_state { |
| 22 | GMM_DEREGISTERED, /* 4.1.3.3.1.1 */ |
| 23 | GMM_COMMON_PROC_INIT, /* 4.1.3.3.1.2 */ |
| 24 | GMM_REGISTERED_NORMAL, /* 4.1.3.3.2.1 */ |
| 25 | GMM_REGISTERED_SUSPENDED, /* 4.1.3.3.2.2 */ |
| 26 | GMM_DEREGISTERED_INIT, /* 4.1.3.3.1.4 */ |
| 27 | }; |
| 28 | |
Harald Welte | c2e8cc4 | 2010-05-31 20:23:38 +0200 | [diff] [blame] | 29 | enum gprs_mm_ctr { |
Harald Welte | 8acd88f | 2010-05-18 10:57:45 +0200 | [diff] [blame] | 30 | GMM_CTR_PKTS_SIG_IN, |
| 31 | GMM_CTR_PKTS_SIG_OUT, |
| 32 | GMM_CTR_PKTS_UDATA_IN, |
| 33 | GMM_CTR_PKTS_UDATA_OUT, |
| 34 | GMM_CTR_BYTES_UDATA_IN, |
| 35 | GMM_CTR_BYTES_UDATA_OUT, |
| 36 | GMM_CTR_PDP_CTX_ACT, |
| 37 | GMM_CTR_SUSPEND, |
| 38 | GMM_CTR_PAGING_PS, |
| 39 | GMM_CTR_PAGING_CS, |
| 40 | GMM_CTR_RA_UPDATE, |
| 41 | }; |
| 42 | |
Harald Welte | efbdee9 | 2010-06-10 00:20:12 +0200 | [diff] [blame] | 43 | enum gprs_pdp_ctx { |
| 44 | PDP_CTR_PKTS_UDATA_IN, |
| 45 | PDP_CTR_PKTS_UDATA_OUT, |
| 46 | PDP_CTR_BYTES_UDATA_IN, |
| 47 | PDP_CTR_BYTES_UDATA_OUT, |
| 48 | }; |
| 49 | |
Harald Welte | c2e8cc4 | 2010-05-31 20:23:38 +0200 | [diff] [blame] | 50 | enum gprs_t3350_mode { |
| 51 | GMM_T3350_MODE_ATT, |
| 52 | GMM_T3350_MODE_RAU, |
| 53 | GMM_T3350_MODE_PTMSI_REALL, |
| 54 | }; |
| 55 | |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 56 | #define MS_RADIO_ACCESS_CAPA |
| 57 | |
| 58 | /* According to TS 03.60, Table 5: SGSN MM and PDP Contexts */ |
Harald Welte | f533e13 | 2010-05-01 16:45:46 +0200 | [diff] [blame] | 59 | /* Extended by 3GPP TS 23.060, Table 6: SGSN MM and PDP Contexts */ |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 60 | struct sgsn_mm_ctx { |
| 61 | struct llist_head list; |
| 62 | |
| 63 | char imsi[GSM_IMSI_LENGTH]; |
| 64 | enum gprs_mm_state mm_state; |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 65 | uint32_t p_tmsi; |
Harald Welte | c2e8cc4 | 2010-05-31 20:23:38 +0200 | [diff] [blame] | 66 | uint32_t p_tmsi_old; /* old P-TMSI before new is confirmed */ |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 67 | uint32_t p_tmsi_sig; |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 68 | char imei[GSM_IMEI_LENGTH]; |
Harald Welte | f533e13 | 2010-05-01 16:45:46 +0200 | [diff] [blame] | 69 | /* Opt: Software Version Numbber / TS 23.195 */ |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 70 | char msisdn[GSM_EXTENSION_LENGTH]; |
| 71 | struct gprs_ra_id ra; |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 72 | uint16_t cell_id; |
| 73 | uint32_t cell_id_age; |
| 74 | uint16_t sac; /* Iu: Service Area Code */ |
| 75 | uint32_t sac_age;/* Iu: Service Area Code age */ |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 76 | /* VLR number */ |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 77 | uint32_t new_sgsn_addr; |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 78 | /* Authentication Triplets */ |
| 79 | /* Kc */ |
Harald Welte | f533e13 | 2010-05-01 16:45:46 +0200 | [diff] [blame] | 80 | /* Iu: CK, IK, KSI */ |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 81 | /* CKSN */ |
| 82 | enum gprs_ciph_algo ciph_algo; |
| 83 | struct { |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 84 | uint8_t len; |
Alexander Chemeris | 84402c0 | 2013-07-03 10:12:23 +0400 | [diff] [blame] | 85 | uint8_t buf[50]; /* GSM 04.08 10.5.5.12a, extended in TS 24.008 */ |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 86 | } ms_radio_access_capa; |
| 87 | struct { |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 88 | uint8_t len; |
Alexander Chemeris | 84402c0 | 2013-07-03 10:12:23 +0400 | [diff] [blame] | 89 | uint8_t buf[8]; /* GSM 04.08 10.5.5.12, extended in TS 24.008 */ |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 90 | } ms_network_capa; |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 91 | uint16_t drx_parms; |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 92 | int mnrg; /* MS reported to HLR? */ |
| 93 | int ngaf; /* MS reported to MSC/VLR? */ |
| 94 | int ppf; /* paging for GPRS + non-GPRS? */ |
| 95 | /* SMS Parameters */ |
| 96 | int recovery; |
Harald Welte | ba850c5 | 2010-05-02 14:40:32 +0200 | [diff] [blame] | 97 | uint8_t radio_prio_sms; |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 98 | |
| 99 | struct llist_head pdp_list; |
| 100 | |
| 101 | /* Additional bits not present in the GSM TS */ |
Harald Welte | 807a5d8 | 2010-06-01 11:53:01 +0200 | [diff] [blame] | 102 | struct gprs_llc_llme *llme; |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 103 | uint32_t tlli; |
Harald Welte | 807a5d8 | 2010-06-01 11:53:01 +0200 | [diff] [blame] | 104 | uint32_t tlli_new; |
Harald Welte | 6abf94e | 2010-05-18 10:35:06 +0200 | [diff] [blame] | 105 | uint16_t nsei; |
| 106 | uint16_t bvci; |
Harald Welte | 8acd88f | 2010-05-18 10:57:45 +0200 | [diff] [blame] | 107 | struct rate_ctr_group *ctrg; |
Pablo Neira Ayuso | bf540cb | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 108 | struct osmo_timer_list timer; |
Harald Welte | c2e8cc4 | 2010-05-31 20:23:38 +0200 | [diff] [blame] | 109 | unsigned int T; /* Txxxx number */ |
| 110 | unsigned int num_T_exp; /* number of consecutive T expirations */ |
| 111 | |
| 112 | enum gprs_t3350_mode t3350_mode; |
| 113 | uint8_t t3370_id_type; |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 114 | }; |
| 115 | |
Daniel Willmann | b15ceec | 2014-09-03 15:57:49 +0200 | [diff] [blame] | 116 | #define LOGMMCTXP(level, mm, fmt, args...) \ |
| 117 | LOGP(DMM, level, "MM(%s/%08x) " fmt, (mm)->imsi, (mm)->p_tmsi, ## args) |
| 118 | |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 119 | /* look-up a SGSN MM context based on TLLI + RAI */ |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 120 | struct sgsn_mm_ctx *sgsn_mm_ctx_by_tlli(uint32_t tlli, |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 121 | const struct gprs_ra_id *raid); |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 122 | struct sgsn_mm_ctx *sgsn_mm_ctx_by_ptmsi(uint32_t tmsi); |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 123 | struct sgsn_mm_ctx *sgsn_mm_ctx_by_imsi(const char *imsi); |
| 124 | |
| 125 | /* Allocate a new SGSN MM context */ |
Harald Welte | eaa614c | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 126 | struct sgsn_mm_ctx *sgsn_mm_ctx_alloc(uint32_t tlli, |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 127 | const struct gprs_ra_id *raid); |
Harald Welte | c728eea | 2010-12-24 23:07:18 +0100 | [diff] [blame] | 128 | void sgsn_mm_ctx_free(struct sgsn_mm_ctx *mm); |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 129 | |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 130 | |
| 131 | enum pdp_ctx_state { |
| 132 | PDP_STATE_NONE, |
Harald Welte | 6abf94e | 2010-05-18 10:35:06 +0200 | [diff] [blame] | 133 | PDP_STATE_CR_REQ, |
| 134 | PDP_STATE_CR_CONF, |
Harald Welte | a9b473a | 2010-12-24 21:13:26 +0100 | [diff] [blame] | 135 | |
| 136 | /* 04.08 / Figure 6.2 / 6.1.2.2 */ |
| 137 | PDP_STATE_INACT_PEND, |
| 138 | PDP_STATE_INACTIVE = PDP_STATE_NONE, |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 139 | }; |
| 140 | |
| 141 | enum pdp_type { |
| 142 | PDP_TYPE_NONE, |
Harald Welte | 6abf94e | 2010-05-18 10:35:06 +0200 | [diff] [blame] | 143 | PDP_TYPE_ETSI_PPP, |
| 144 | PDP_TYPE_IANA_IPv4, |
| 145 | PDP_TYPE_IANA_IPv6, |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 146 | }; |
| 147 | |
| 148 | struct sgsn_pdp_ctx { |
| 149 | struct llist_head list; /* list_head for mmctx->pdp_list */ |
| 150 | struct llist_head g_list; /* list_head for global list */ |
| 151 | struct sgsn_mm_ctx *mm; /* back pointer to MM CTX */ |
| 152 | struct sgsn_ggsn_ctx *ggsn; /* which GGSN serves this PDP */ |
Harald Welte | efbdee9 | 2010-06-10 00:20:12 +0200 | [diff] [blame] | 153 | struct rate_ctr_group *ctrg; |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 154 | |
| 155 | //unsigned int id; |
| 156 | struct pdp_t *lib; /* pointer to libgtp PDP ctx */ |
| 157 | enum pdp_ctx_state state; |
| 158 | enum pdp_type type; |
| 159 | uint32_t address; |
| 160 | char *apn_subscribed; |
| 161 | //char *apn_used; |
Harald Welte | 6abf94e | 2010-05-18 10:35:06 +0200 | [diff] [blame] | 162 | uint16_t nsapi; /* SNDCP */ |
| 163 | uint16_t sapi; /* LLC */ |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 164 | uint8_t ti; /* transaction identifier */ |
| 165 | int vplmn_allowed; |
| 166 | uint32_t qos_profile_subscr; |
| 167 | //uint32_t qos_profile_req; |
| 168 | //uint32_t qos_profile_neg; |
| 169 | uint8_t radio_prio; |
| 170 | uint32_t tx_npdu_nr; |
| 171 | uint32_t rx_npdu_nr; |
| 172 | uint32_t tx_gtp_snd; |
| 173 | uint32_t rx_gtp_snu; |
| 174 | //uint32_t charging_id; |
| 175 | int reordering_reqd; |
Harald Welte | a9b473a | 2010-12-24 21:13:26 +0100 | [diff] [blame] | 176 | |
Pablo Neira Ayuso | bf540cb | 2011-05-06 12:11:06 +0200 | [diff] [blame] | 177 | struct osmo_timer_list timer; |
Harald Welte | a9b473a | 2010-12-24 21:13:26 +0100 | [diff] [blame] | 178 | unsigned int T; /* Txxxx number */ |
| 179 | unsigned int num_T_exp; /* number of consecutive T expirations */ |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 180 | }; |
| 181 | |
Daniel Willmann | b15ceec | 2014-09-03 15:57:49 +0200 | [diff] [blame] | 182 | #define LOGPDPCTXP(level, pdp, fmt, args...) \ |
Jacob Erlbeck | 99985b5 | 2014-10-13 10:32:00 +0200 | [diff] [blame] | 183 | LOGP(DGPRS, level, "PDP(%s/%u) " \ |
| 184 | fmt, (pdp)->mm ? (pdp)->mm->imsi : "---", (pdp)->ti, ## args) |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 185 | |
Harald Welte | 96df606 | 2010-06-03 06:37:26 +0200 | [diff] [blame] | 186 | /* look up PDP context by MM context and NSAPI */ |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 187 | struct sgsn_pdp_ctx *sgsn_pdp_ctx_by_nsapi(const struct sgsn_mm_ctx *mm, |
| 188 | uint8_t nsapi); |
Harald Welte | 96df606 | 2010-06-03 06:37:26 +0200 | [diff] [blame] | 189 | /* look up PDP context by MM context and transaction ID */ |
Harald Welte | 77289c2 | 2010-05-18 14:32:29 +0200 | [diff] [blame] | 190 | struct sgsn_pdp_ctx *sgsn_pdp_ctx_by_tid(const struct sgsn_mm_ctx *mm, |
| 191 | uint8_t tid); |
Harald Welte | 96df606 | 2010-06-03 06:37:26 +0200 | [diff] [blame] | 192 | |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 193 | struct sgsn_pdp_ctx *sgsn_pdp_ctx_alloc(struct sgsn_mm_ctx *mm, |
| 194 | uint8_t nsapi); |
Jacob Erlbeck | 99985b5 | 2014-10-13 10:32:00 +0200 | [diff] [blame] | 195 | void sgsn_pdp_ctx_terminate(struct sgsn_pdp_ctx *pdp); |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 196 | void sgsn_pdp_ctx_free(struct sgsn_pdp_ctx *pdp); |
| 197 | |
| 198 | |
Harald Welte | 77289c2 | 2010-05-18 14:32:29 +0200 | [diff] [blame] | 199 | struct sgsn_ggsn_ctx { |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 200 | struct llist_head list; |
| 201 | uint32_t id; |
| 202 | unsigned int gtp_version; |
| 203 | struct in_addr remote_addr; |
Harald Welte | a9b473a | 2010-12-24 21:13:26 +0100 | [diff] [blame] | 204 | int remote_restart_ctr; |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 205 | struct gsn_t *gsn; |
| 206 | }; |
Harald Welte | cd4dd4d | 2010-05-18 17:20:49 +0200 | [diff] [blame] | 207 | struct sgsn_ggsn_ctx *sgsn_ggsn_ctx_alloc(uint32_t id); |
| 208 | struct sgsn_ggsn_ctx *sgsn_ggsn_ctx_by_id(uint32_t id); |
Harald Welte | a9b473a | 2010-12-24 21:13:26 +0100 | [diff] [blame] | 209 | struct sgsn_ggsn_ctx *sgsn_ggsn_ctx_by_addr(struct in_addr *addr); |
Harald Welte | cd4dd4d | 2010-05-18 17:20:49 +0200 | [diff] [blame] | 210 | struct sgsn_ggsn_ctx *sgsn_ggsn_ctx_find_alloc(uint32_t id); |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 211 | |
| 212 | struct apn_ctx { |
| 213 | struct llist_head list; |
Harald Welte | 77289c2 | 2010-05-18 14:32:29 +0200 | [diff] [blame] | 214 | struct sgsn_ggsn_ctx *ggsn; |
Harald Welte | d193cb3 | 2010-05-17 22:58:03 +0200 | [diff] [blame] | 215 | char *name; |
| 216 | char *description; |
| 217 | }; |
| 218 | |
| 219 | extern struct llist_head sgsn_mm_ctxts; |
| 220 | extern struct llist_head sgsn_ggsn_ctxts; |
| 221 | extern struct llist_head sgsn_apn_ctxts; |
| 222 | extern struct llist_head sgsn_pdp_ctxts; |
| 223 | |
Harald Welte | 6463c07 | 2010-05-18 17:04:55 +0200 | [diff] [blame] | 224 | uint32_t sgsn_alloc_ptmsi(void); |
| 225 | |
Harald Welte | a9b473a | 2010-12-24 21:13:26 +0100 | [diff] [blame] | 226 | /* High-level function to be called in case a GGSN has disappeared or |
| 227 | * ottherwise lost state (recovery procedure) */ |
| 228 | int drop_all_pdp_for_ggsn(struct sgsn_ggsn_ctx *ggsn); |
| 229 | |
Holger Hans Peter Freyther | a273030 | 2014-03-23 18:08:26 +0100 | [diff] [blame] | 230 | char *gprs_pdpaddr2str(uint8_t *pdpa, uint8_t len); |
| 231 | |
Jacob Erlbeck | 78ecaf0 | 2014-09-05 14:32:36 +0200 | [diff] [blame] | 232 | /* Force re-attachment based on msgb meta data */ |
| 233 | int sgsn_force_reattach_oldmsg(struct msgb *oldmsg); |
| 234 | |
Holger Hans Peter Freyther | a273030 | 2014-03-23 18:08:26 +0100 | [diff] [blame] | 235 | /* |
| 236 | * ctrl interface related work |
| 237 | */ |
| 238 | struct gsm_network; |
| 239 | struct ctrl_handle *sgsn_controlif_setup(struct gsm_network *, uint16_t port); |
| 240 | int sgsn_ctrl_cmds_install(void); |
| 241 | |
Holger Hans Peter Freyther | 1768a57 | 2014-04-04 12:40:34 +0200 | [diff] [blame] | 242 | /* |
| 243 | * ACL handling |
| 244 | */ |
Jacob Erlbeck | 3b5d407 | 2014-10-24 15:11:03 +0200 | [diff] [blame^] | 245 | struct imsi_acl_entry { |
| 246 | struct llist_head list; |
| 247 | char imsi[16+1]; |
| 248 | }; |
| 249 | struct sgsn_config; |
| 250 | struct sgsn_instance; |
| 251 | |
| 252 | void sgsn_auth_init(struct sgsn_instance *sgi); |
| 253 | struct imsi_acl_entry *sgsn_acl_lookup(const char *imsi, struct sgsn_config *cfg); |
| 254 | int sgsn_acl_add(const char *imsi, struct sgsn_config *cfg); |
| 255 | int sgsn_acl_del(const char *imsi, struct sgsn_config *cfg); |
Holger Hans Peter Freyther | 1768a57 | 2014-04-04 12:40:34 +0200 | [diff] [blame] | 256 | |
Holger Hans Peter Freyther | 90e9a44 | 2014-04-04 12:51:28 +0200 | [diff] [blame] | 257 | int gprs_sndcp_vty_init(void); |
| 258 | struct sgsn_instance; |
| 259 | int sgsn_gtp_init(struct sgsn_instance *sgi); |
| 260 | |
Harald Welte | 9b455bf | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 261 | #endif /* _GPRS_SGSN_H */ |