Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 1 | #ifndef _SGSN_H |
| 2 | #define _SGSN_H |
| 3 | |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 4 | |
Pablo Neira Ayuso | 136f453 | 2011-03-22 16:47:59 +0100 | [diff] [blame] | 5 | #include <osmocom/core/msgb.h> |
Alexander Couzens | f23e2db | 2020-07-27 22:39:58 +0200 | [diff] [blame] | 6 | #include <osmocom/core/select.h> |
Max | 93408ae | 2016-06-28 14:10:16 +0200 | [diff] [blame] | 7 | #include <osmocom/crypt/gprs_cipher.h> |
Alexander Couzens | f23e2db | 2020-07-27 22:39:58 +0200 | [diff] [blame] | 8 | #include <osmocom/gprs/gprs_ns2.h> |
Pau Espin Pedrol | e5c8998 | 2021-05-03 18:16:42 +0200 | [diff] [blame] | 9 | #include <osmocom/gprs/gprs_bssgp.h> |
| 10 | |
Neels Hofmeyr | 396f2e6 | 2017-09-04 15:13:25 +0200 | [diff] [blame] | 11 | #include <osmocom/sgsn/gprs_sgsn.h> |
Pau Espin Pedrol | e5c8998 | 2021-05-03 18:16:42 +0200 | [diff] [blame] | 12 | #include <osmocom/sgsn/gtp_mme.h> |
Harald Welte | 0b588be | 2018-07-30 18:25:31 +0200 | [diff] [blame] | 13 | #include <osmocom/gsm/oap_client.h> |
Harald Welte | f4b2c4c | 2018-09-16 07:53:41 +0200 | [diff] [blame] | 14 | #include <osmocom/gsupclient/gsup_client.h> |
Neels Hofmeyr | 396f2e6 | 2017-09-04 15:13:25 +0200 | [diff] [blame] | 15 | #include <osmocom/sgsn/common.h> |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 16 | |
Neels Hofmeyr | 69e356b | 2018-03-15 13:00:35 +0100 | [diff] [blame] | 17 | #include "../../bscconfig.h" |
| 18 | |
| 19 | #if BUILD_IU |
| 20 | #include <osmocom/ranap/iu_client.h> |
| 21 | #endif |
| 22 | |
Holger Hans Peter Freyther | 66e7106 | 2015-05-25 01:21:50 +0800 | [diff] [blame] | 23 | #include <ares.h> |
Max | c005db7 | 2017-10-27 18:43:29 +0200 | [diff] [blame] | 24 | #include <gtp.h> |
Holger Hans Peter Freyther | 66e7106 | 2015-05-25 01:21:50 +0800 | [diff] [blame] | 25 | |
Holger Hans Peter Freyther | 39c430e | 2015-05-25 12:26:49 +0800 | [diff] [blame] | 26 | struct hostent; |
Jacob Erlbeck | 39f040d | 2014-12-18 12:46:47 +0100 | [diff] [blame] | 27 | |
Jacob Erlbeck | 106f547 | 2014-11-04 10:08:37 +0100 | [diff] [blame] | 28 | enum sgsn_auth_policy { |
| 29 | SGSN_AUTH_POLICY_OPEN, |
| 30 | SGSN_AUTH_POLICY_CLOSED, |
Jacob Erlbeck | be2c8d9 | 2014-11-12 10:18:09 +0100 | [diff] [blame] | 31 | SGSN_AUTH_POLICY_ACL_ONLY, |
| 32 | SGSN_AUTH_POLICY_REMOTE |
Jacob Erlbeck | 106f547 | 2014-11-04 10:08:37 +0100 | [diff] [blame] | 33 | }; |
| 34 | |
Alexander Couzens | 14314bd | 2016-07-05 09:52:52 +0200 | [diff] [blame] | 35 | |
| 36 | enum sgsn_rate_ctr_keys { |
Alexander Couzens | 4e699a9 | 2016-07-05 11:04:27 +0200 | [diff] [blame] | 37 | CTR_LLC_DL_BYTES, |
| 38 | CTR_LLC_UL_BYTES, |
| 39 | CTR_LLC_DL_PACKETS, |
| 40 | CTR_LLC_UL_PACKETS, |
Alexander Couzens | 14314bd | 2016-07-05 09:52:52 +0200 | [diff] [blame] | 41 | CTR_GPRS_ATTACH_REQUEST, |
| 42 | CTR_GPRS_ATTACH_ACKED, |
| 43 | CTR_GPRS_ATTACH_REJECTED, |
| 44 | CTR_GPRS_DETACH_REQUEST, |
| 45 | CTR_GPRS_DETACH_ACKED, |
| 46 | CTR_GPRS_ROUTING_AREA_REQUEST, |
| 47 | CTR_GPRS_ROUTING_AREA_ACKED, |
| 48 | CTR_GPRS_ROUTING_AREA_REJECT, |
| 49 | /* PDP single packet counter / GSM 04.08 9.5.1 - 9.5.9 */ |
| 50 | CTR_PDP_ACTIVATE_REQUEST, |
| 51 | CTR_PDP_ACTIVATE_REJECT, |
| 52 | CTR_PDP_ACTIVATE_ACCEPT, |
| 53 | CTR_PDP_REQUEST_ACTIVATE, /* unused */ |
| 54 | CTR_PDP_REQUEST_ACTIVATE_REJ, /* unused */ |
| 55 | CTR_PDP_MODIFY_REQUEST, /* unsued */ |
| 56 | CTR_PDP_MODIFY_ACCEPT, /* unused */ |
| 57 | CTR_PDP_DL_DEACTIVATE_REQUEST, |
| 58 | CTR_PDP_DL_DEACTIVATE_ACCEPT, |
| 59 | CTR_PDP_UL_DEACTIVATE_REQUEST, |
| 60 | CTR_PDP_UL_DEACTIVATE_ACCEPT, |
| 61 | }; |
| 62 | |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 63 | struct sgsn_cdr { |
| 64 | char *filename; |
Pau Espin Pedrol | 2e9ea50 | 2017-11-29 14:01:35 +0100 | [diff] [blame] | 65 | bool trap; |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 66 | int interval; |
| 67 | }; |
| 68 | |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 69 | struct sgsn_config { |
| 70 | /* parsed from config file */ |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 71 | |
Harald Welte | 2720e73 | 2010-05-17 00:44:57 +0200 | [diff] [blame] | 72 | char *gtp_statedir; |
| 73 | struct sockaddr_in gtp_listenaddr; |
| 74 | |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 75 | /* misc */ |
Alexander Couzens | f23e2db | 2020-07-27 22:39:58 +0200 | [diff] [blame] | 76 | struct gprs_ns2_inst *nsi; |
Harald Welte | 7f6da48 | 2013-03-19 11:00:13 +0100 | [diff] [blame] | 77 | |
Jacob Erlbeck | 106f547 | 2014-11-04 10:08:37 +0100 | [diff] [blame] | 78 | enum sgsn_auth_policy auth_policy; |
Neels Hofmeyr | 340a7e9 | 2022-03-07 15:37:24 +0100 | [diff] [blame] | 79 | uint8_t gea_encryption_mask; |
Neels Hofmeyr | 3c7656a | 2022-03-07 15:38:59 +0100 | [diff] [blame] | 80 | uint8_t uea_encryption_mask; |
Harald Welte | 7f6da48 | 2013-03-19 11:00:13 +0100 | [diff] [blame] | 81 | struct llist_head imsi_acl; |
Jacob Erlbeck | 39f040d | 2014-12-18 12:46:47 +0100 | [diff] [blame] | 82 | |
| 83 | struct sockaddr_in gsup_server_addr; |
| 84 | int gsup_server_port; |
Jacob Erlbeck | 9d4f46c | 2014-12-17 13:20:08 +0100 | [diff] [blame] | 85 | |
Pau Espin Pedrol | d1463bc | 2019-06-13 19:03:25 +0200 | [diff] [blame] | 86 | /* Only meaningful if auth_policy is SGSN_AUTH_POLICY_REMOTE */ |
Jacob Erlbeck | 9d4f46c | 2014-12-17 13:20:08 +0100 | [diff] [blame] | 87 | int require_authentication; |
Pau Espin Pedrol | d1463bc | 2019-06-13 19:03:25 +0200 | [diff] [blame] | 88 | |
Jacob Erlbeck | 771573c | 2014-12-19 18:08:48 +0100 | [diff] [blame] | 89 | int require_update_location; |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 90 | |
| 91 | /* CDR configuration */ |
| 92 | struct sgsn_cdr cdr; |
Holger Hans Peter Freyther | 39c430e | 2015-05-25 12:26:49 +0800 | [diff] [blame] | 93 | |
Pau Espin Pedrol | a299d65 | 2019-08-14 19:11:10 +0200 | [diff] [blame] | 94 | /* Timer defintions */ |
| 95 | struct osmo_tdef *T_defs; |
Pau Espin Pedrol | 8501126 | 2022-11-02 20:23:09 +0100 | [diff] [blame] | 96 | struct osmo_tdef *T_defs_gtp; |
Harald Welte | 9450882 | 2015-08-15 19:08:21 +0200 | [diff] [blame] | 97 | |
Holger Hans Peter Freyther | 39c430e | 2015-05-25 12:26:49 +0800 | [diff] [blame] | 98 | int dynamic_lookup; |
Neels Hofmeyr | 9c534fd | 2015-10-12 11:57:37 +0200 | [diff] [blame] | 99 | |
Harald Welte | 0b588be | 2018-07-30 18:25:31 +0200 | [diff] [blame] | 100 | struct osmo_oap_client_config oap; |
Philipp | f1f3436 | 2016-08-26 17:00:21 +0200 | [diff] [blame] | 101 | |
| 102 | /* RFC1144 TCP/IP header compression */ |
| 103 | struct { |
| 104 | int active; |
| 105 | int passive; |
| 106 | int s01; |
| 107 | } pcomp_rfc1144; |
Philipp | 73f83d5 | 2016-09-02 13:38:01 +0200 | [diff] [blame] | 108 | |
| 109 | /* V.42vis data compression */ |
| 110 | struct { |
| 111 | int active; |
| 112 | int passive; |
| 113 | int p0; |
| 114 | int p1; |
| 115 | int p2; |
| 116 | } dcomp_v42bis; |
Neels Hofmeyr | 2188a77 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 117 | |
Neels Hofmeyr | 69e356b | 2018-03-15 13:00:35 +0100 | [diff] [blame] | 118 | #if BUILD_IU |
Neels Hofmeyr | 2188a77 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 119 | struct { |
Neels Hofmeyr | 69e356b | 2018-03-15 13:00:35 +0100 | [diff] [blame] | 120 | enum ranap_nsap_addr_enc rab_assign_addr_enc; |
Pau Espin Pedrol | 2c90899 | 2019-08-19 19:06:06 +0200 | [diff] [blame] | 121 | uint32_t cs7_instance; |
Neels Hofmeyr | 2188a77 | 2016-05-20 21:59:55 +0200 | [diff] [blame] | 122 | } iu; |
Neels Hofmeyr | 69e356b | 2018-03-15 13:00:35 +0100 | [diff] [blame] | 123 | #endif |
Stefan Sperling | 8822009 | 2018-12-11 14:42:00 +0100 | [diff] [blame] | 124 | |
| 125 | /* This is transmitted as IPA Serial Number tag, which is used for GSUP routing (e.g. in OsmoHLR). |
| 126 | * This name must be set in a multi-SGSN network, and it must be unique to each SGSN. |
| 127 | * If no name is set, the IPA Serial Number will be the same as the Unit Name, |
| 128 | * and will be of the form 'SGSN-00-00-00-00-00-00' */ |
| 129 | char *sgsn_ipa_name; |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 130 | }; |
| 131 | |
Harald Welte | 2720e73 | 2010-05-17 00:44:57 +0200 | [diff] [blame] | 132 | struct sgsn_instance { |
| 133 | char *config_file; |
| 134 | struct sgsn_config cfg; |
| 135 | /* File descriptor wrappers for LibGTP */ |
Pablo Neira Ayuso | 4db9299 | 2011-05-06 12:11:23 +0200 | [diff] [blame] | 136 | struct osmo_fd gtp_fd0; |
| 137 | struct osmo_fd gtp_fd1c; |
| 138 | struct osmo_fd gtp_fd1u; |
Harald Welte | 2720e73 | 2010-05-17 00:44:57 +0200 | [diff] [blame] | 139 | /* GSN instance for libgtp */ |
| 140 | struct gsn_t *gsn; |
Jacob Erlbeck | 39f040d | 2014-12-18 12:46:47 +0100 | [diff] [blame] | 141 | /* Subscriber */ |
Harald Welte | f4b2c4c | 2018-09-16 07:53:41 +0200 | [diff] [blame] | 142 | struct osmo_gsup_client *gsup_client; |
Jacob Erlbeck | 81ffb74 | 2015-01-23 11:33:51 +0100 | [diff] [blame] | 143 | /* LLME inactivity timer */ |
| 144 | struct osmo_timer_list llme_timer; |
Holger Hans Peter Freyther | 66e7106 | 2015-05-25 01:21:50 +0800 | [diff] [blame] | 145 | |
| 146 | /* c-ares event loop integration */ |
| 147 | struct osmo_timer_list ares_timer; |
| 148 | struct llist_head ares_fds; |
| 149 | ares_channel ares_channel; |
Holger Hans Peter Freyther | a5a6da4 | 2015-05-25 15:20:27 +0800 | [diff] [blame] | 150 | struct ares_addr_node *ares_servers; |
Alexander Couzens | 14314bd | 2016-07-05 09:52:52 +0200 | [diff] [blame] | 151 | |
| 152 | struct rate_ctr_group *rate_ctrs; |
Pau Espin Pedrol | e5c8998 | 2021-05-03 18:16:42 +0200 | [diff] [blame] | 153 | |
Pau Espin Pedrol | 44bde6b | 2023-01-05 17:23:26 +0100 | [diff] [blame] | 154 | struct llist_head ggsn_list; /* list of struct sgsn_ggsn_ctx */ |
Pau Espin Pedrol | e5c8998 | 2021-05-03 18:16:42 +0200 | [diff] [blame] | 155 | struct llist_head mme_list; /* list of struct sgsn_mme_ctx */ |
Pau Espin Pedrol | e659f75 | 2023-01-05 17:20:37 +0100 | [diff] [blame] | 156 | |
| 157 | struct ctrl_handle *ctrlh; |
Harald Welte | 2720e73 | 2010-05-17 00:44:57 +0200 | [diff] [blame] | 158 | }; |
| 159 | |
Harald Welte | 8fc1a46 | 2010-05-17 00:53:10 +0200 | [diff] [blame] | 160 | extern struct sgsn_instance *sgsn; |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 161 | |
| 162 | /* sgsn_vty.c */ |
| 163 | |
Neels Hofmeyr | c9a352f | 2017-07-20 14:41:20 +0200 | [diff] [blame] | 164 | int sgsn_vty_init(struct sgsn_config *cfg); |
| 165 | int sgsn_parse_config(const char *config_file); |
Max | c005db7 | 2017-10-27 18:43:29 +0200 | [diff] [blame] | 166 | char *sgsn_gtp_ntoa(struct ul16_t *ul); |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 167 | |
| 168 | /* sgsn.c */ |
Pau Espin Pedrol | e659f75 | 2023-01-05 17:20:37 +0100 | [diff] [blame] | 169 | struct sgsn_instance *sgsn_instance_alloc(void *talloc_ctx); |
| 170 | int sgsn_inst_init(struct sgsn_instance *sgsn); |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 171 | |
Pau Espin Pedrol | 6dfb5fe | 2019-08-29 17:21:00 +0200 | [diff] [blame] | 172 | /* sgsn_libgtp.c */ |
Harald Welte | 77289c2 | 2010-05-18 14:32:29 +0200 | [diff] [blame] | 173 | struct sgsn_pdp_ctx *sgsn_create_pdp_ctx(struct sgsn_ggsn_ctx *ggsn, |
Harald Welte | 6abf94e | 2010-05-18 10:35:06 +0200 | [diff] [blame] | 174 | struct sgsn_mm_ctx *mmctx, |
| 175 | uint16_t nsapi, |
| 176 | struct tlv_parsed *tp); |
Harald Welte | 77289c2 | 2010-05-18 14:32:29 +0200 | [diff] [blame] | 177 | int sgsn_delete_pdp_ctx(struct sgsn_pdp_ctx *pctx); |
Daniel Willmann | 21b269f | 2016-05-11 12:43:47 +0200 | [diff] [blame] | 178 | void sgsn_pdp_upd_gtp_u(struct sgsn_pdp_ctx *pdp, void *addr, size_t alen); |
Pau Espin Pedrol | fa12010 | 2018-07-09 20:37:47 +0200 | [diff] [blame] | 179 | void sgsn_ggsn_echo_req(struct sgsn_ggsn_ctx *ggc); |
Pau Espin Pedrol | 6dfb5fe | 2019-08-29 17:21:00 +0200 | [diff] [blame] | 180 | int send_act_pdp_cont_acc(struct sgsn_pdp_ctx *pctx); |
Pau Espin Pedrol | e5c8998 | 2021-05-03 18:16:42 +0200 | [diff] [blame] | 181 | int sgsn_mme_ran_info_req(struct sgsn_mme_ctx *mme, const struct bssgp_ran_information_pdu *pdu); |
Harald Welte | 77289c2 | 2010-05-18 14:32:29 +0200 | [diff] [blame] | 182 | |
Harald Welte | ebabdea | 2010-06-01 18:28:10 +0200 | [diff] [blame] | 183 | /* gprs_sndcp.c */ |
| 184 | |
| 185 | /* Entry point for the SNSM-ACTIVATE.indication */ |
| 186 | int sndcp_sm_activate_ind(struct gprs_llc_lle *lle, uint8_t nsapi); |
Harald Welte | ce22f92 | 2010-06-03 21:21:21 +0200 | [diff] [blame] | 187 | /* Entry point for the SNSM-DEACTIVATE.indication */ |
Max | caff83e | 2022-10-09 13:32:09 +0300 | [diff] [blame] | 188 | int sndcp_sm_deactivate_ind(const struct gprs_llc_lle *lle, uint8_t nsapi); |
Harald Welte | bb1c805 | 2010-06-03 06:38:38 +0200 | [diff] [blame] | 189 | int sndcp_unitdata_req(struct msgb *msg, struct gprs_llc_lle *lle, uint8_t nsapi, |
| 190 | void *mmcontext); |
Holger Hans Peter Freyther | 3dccda5 | 2011-10-14 23:42:13 +0200 | [diff] [blame] | 191 | int sndcp_llunitdata_ind(struct msgb *msg, struct gprs_llc_lle *lle, |
| 192 | uint8_t *hdr, uint16_t len); |
Harald Welte | ebabdea | 2010-06-01 18:28:10 +0200 | [diff] [blame] | 193 | |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 194 | |
| 195 | /* |
| 196 | * CDR related functionality |
| 197 | */ |
| 198 | int sgsn_cdr_init(struct sgsn_instance *sgsn); |
Pau Espin Pedrol | e659f75 | 2023-01-05 17:20:37 +0100 | [diff] [blame] | 199 | void sgsn_cdr_release(struct sgsn_instance *sgsn); |
Holger Hans Peter Freyther | 4f5b823 | 2015-05-05 22:25:48 +0200 | [diff] [blame] | 200 | |
Holger Hans Peter Freyther | 66e7106 | 2015-05-25 01:21:50 +0800 | [diff] [blame] | 201 | |
| 202 | /* |
| 203 | * C-ARES related functionality |
| 204 | */ |
| 205 | int sgsn_ares_init(struct sgsn_instance *sgsn); |
| 206 | int sgsn_ares_query(struct sgsn_instance *sgsm, const char *name, ares_host_callback cb, void *data); |
| 207 | |
Harald Welte | 288be16 | 2010-05-01 16:48:27 +0200 | [diff] [blame] | 208 | #endif |