Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file gprs_bssgp.h */ |
| 2 | |
Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 3 | #pragma once |
Harald Welte | 9ba5005 | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 4 | |
Harald Welte | 8f9a3ee | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 5 | #include <stdint.h> |
Harald Welte | d11c059 | 2012-09-06 21:57:11 +0200 | [diff] [blame] | 6 | #include <osmocom/core/timer.h> |
| 7 | #include <osmocom/core/linuxlist.h> |
Harald Welte | 8f9a3ee | 2010-05-02 11:26:34 +0200 | [diff] [blame] | 8 | |
Harald Welte | 73952e3 | 2012-06-16 14:59:56 +0800 | [diff] [blame] | 9 | #include <osmocom/gsm/gsm48.h> |
Harald Welte | 15a3643 | 2012-06-17 12:16:31 +0800 | [diff] [blame] | 10 | #include <osmocom/gsm/prim.h> |
Harald Welte | 73952e3 | 2012-06-16 14:59:56 +0800 | [diff] [blame] | 11 | |
Harald Welte | 8648e49 | 2012-06-17 13:12:51 +0800 | [diff] [blame] | 12 | #include <osmocom/gprs/protocol/gsm_08_18.h> |
Philipp Maier | bd10c21 | 2020-12-14 22:28:19 +0100 | [diff] [blame] | 13 | #include <osmocom/gprs/protocol/gsm_24_301.h> |
Philipp Maier | 7741bc3 | 2021-01-07 21:55:48 +0100 | [diff] [blame] | 14 | #include <osmocom/gprs/gprs_bssgp_rim.h> |
Harald Welte | 8648e49 | 2012-06-17 13:12:51 +0800 | [diff] [blame] | 15 | |
Harald Welte | af08678 | 2010-05-11 10:01:17 +0200 | [diff] [blame] | 16 | /* gprs_bssgp_util.c */ |
Alexander Couzens | 85a8fd3 | 2020-07-18 15:57:07 +0200 | [diff] [blame] | 17 | |
Harald Welte | 8f82528 | 2020-12-04 18:50:11 +0100 | [diff] [blame] | 18 | #define BSSGP_PDUF_UL 0x0001 /* PDU may occur in uplink */ |
| 19 | #define BSSGP_PDUF_DL 0x0002 /* PDU may occur in downlink */ |
| 20 | #define BSSGP_PDUF_SIG 0x0004 /* PDU may occur on Signaling BVC */ |
| 21 | #define BSSGP_PDUF_PTP 0x0008 /* PDU may occur on PTP BVC */ |
| 22 | #define BSSGP_PDUF_PTM 0x0010 /* PDU may occur on PTM BVC */ |
| 23 | |
| 24 | extern const struct osmo_tlv_prot_def osmo_pdef_bssgp; |
| 25 | |
| 26 | /*! return the PDU type flags (UL/DL/SIG/PTP/PTM) of specified PDU type */ |
| 27 | static inline uint32_t bssgp_pdu_type_flags(uint8_t pdu_type) { |
| 28 | return osmo_tlv_prot_msgt_flags(&osmo_pdef_bssgp, pdu_type); |
| 29 | } |
| 30 | |
| 31 | typedef int (*bssgp_bvc_send)(void *ctx, struct msgb *msg); |
Harald Welte | af08678 | 2010-05-11 10:01:17 +0200 | [diff] [blame] | 32 | extern struct gprs_ns_inst *bssgp_nsi; |
Alexander Couzens | 85a8fd3 | 2020-07-18 15:57:07 +0200 | [diff] [blame] | 33 | void bssgp_set_bssgp_callback(bssgp_bvc_send ns_send, void *data); |
Harald Welte | af08678 | 2010-05-11 10:01:17 +0200 | [diff] [blame] | 34 | struct msgb *bssgp_msgb_alloc(void); |
Jacob Erlbeck | f78ec5c | 2015-11-17 09:53:23 +0100 | [diff] [blame] | 35 | struct msgb *bssgp_msgb_copy(const struct msgb *msg, const char *name); |
Harald Welte | af08678 | 2010-05-11 10:01:17 +0200 | [diff] [blame] | 36 | const char *bssgp_cause_str(enum gprs_bssgp_cause cause); |
Max | c0d9a6c | 2016-03-09 12:29:23 +0100 | [diff] [blame] | 37 | const char *bssgp_pdu_str(enum bssgp_pdu_type pdu); |
Daniel Willmann | 2d42b90 | 2020-09-26 09:11:05 +0200 | [diff] [blame] | 38 | int bssgp_tx_bvc_reset_nsei_bvci(uint16_t nsei, uint16_t bvci, enum gprs_bssgp_cause cause, const struct gprs_ra_id *ra_id, uint16_t cell_id); |
Harald Welte | af08678 | 2010-05-11 10:01:17 +0200 | [diff] [blame] | 39 | /* Transmit a simple response such as BLOCK/UNBLOCK/RESET ACK/NACK */ |
| 40 | int bssgp_tx_simple_bvci(uint8_t pdu_type, uint16_t nsei, |
| 41 | uint16_t bvci, uint16_t ns_bvci); |
| 42 | /* Chapter 10.4.14: Status */ |
| 43 | int bssgp_tx_status(uint8_t cause, uint16_t *bvci, struct msgb *orig_msg); |
| 44 | |
Harald Welte | 15a3643 | 2012-06-17 12:16:31 +0800 | [diff] [blame] | 45 | enum bssgp_prim { |
| 46 | PRIM_BSSGP_DL_UD, |
| 47 | PRIM_BSSGP_UL_UD, |
| 48 | PRIM_BSSGP_PTM_UD, |
| 49 | |
| 50 | PRIM_BSSGP_GMM_SUSPEND, |
| 51 | PRIM_BSSGP_GMM_RESUME, |
| 52 | PRIM_BSSGP_GMM_PAGING, |
| 53 | |
| 54 | PRIM_NM_FLUSH_LL, |
| 55 | PRIM_NM_LLC_DISCARDED, |
| 56 | PRIM_NM_BVC_RESET, |
| 57 | PRIM_NM_BVC_BLOCK, |
| 58 | PRIM_NM_BVC_UNBLOCK, |
Jacob Erlbeck | 36153dc | 2015-03-17 10:21:17 +0100 | [diff] [blame] | 59 | PRIM_NM_STATUS, |
Philipp Maier | 1eaa7bc | 2020-12-16 21:07:04 +0100 | [diff] [blame] | 60 | |
| 61 | PRIM_BSSGP_RIM_PDU_TRANSFER, |
Harald Welte | 15a3643 | 2012-06-17 12:16:31 +0800 | [diff] [blame] | 62 | }; |
| 63 | |
| 64 | struct osmo_bssgp_prim { |
| 65 | struct osmo_prim_hdr oph; |
| 66 | |
| 67 | /* common fields */ |
| 68 | uint16_t nsei; |
| 69 | uint16_t bvci; |
| 70 | uint32_t tlli; |
| 71 | struct tlv_parsed *tp; |
| 72 | struct gprs_ra_id *ra_id; |
| 73 | |
| 74 | /* specific fields */ |
| 75 | union { |
| 76 | struct { |
Holger Hans Peter Freyther | d296f42 | 2012-08-03 09:59:20 +0200 | [diff] [blame] | 77 | uint8_t suspend_ref; |
Harald Welte | 15a3643 | 2012-06-17 12:16:31 +0800 | [diff] [blame] | 78 | } resume; |
Philipp Maier | 7741bc3 | 2021-01-07 21:55:48 +0100 | [diff] [blame] | 79 | struct bssgp_ran_information_pdu rim_pdu; |
Harald Welte | 15a3643 | 2012-06-17 12:16:31 +0800 | [diff] [blame] | 80 | } u; |
| 81 | }; |
| 82 | |
Harald Welte | af08678 | 2010-05-11 10:01:17 +0200 | [diff] [blame] | 83 | /* gprs_bssgp.c */ |
| 84 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 85 | /*! BSSGP flow control (SGSN side) According to Section 8.2 */ |
Harald Welte | d11c059 | 2012-09-06 21:57:11 +0200 | [diff] [blame] | 86 | struct bssgp_flow_control { |
Harald Welte | bb82622 | 2012-09-07 10:22:01 +0200 | [diff] [blame] | 87 | uint32_t bucket_size_max; /*!< maximum size of the bucket (octets) */ |
| 88 | uint32_t bucket_leak_rate; /*!< leak rate of the bucket (octets/sec) */ |
Harald Welte | d11c059 | 2012-09-06 21:57:11 +0200 | [diff] [blame] | 89 | |
| 90 | uint32_t bucket_counter; /*!< number of tokens in the bucket */ |
| 91 | struct timeval time_last_pdu; /*!< timestamp of last PDU sent */ |
| 92 | |
| 93 | /* the built-in queue */ |
Harald Welte | bb82622 | 2012-09-07 10:22:01 +0200 | [diff] [blame] | 94 | uint32_t max_queue_depth; /*!< how many packets to queue (mgs) */ |
| 95 | uint32_t queue_depth; /*!< current length of queue (msgs) */ |
Harald Welte | d11c059 | 2012-09-06 21:57:11 +0200 | [diff] [blame] | 96 | struct llist_head queue; /*!< linked list of msgb's */ |
| 97 | struct osmo_timer_list timer; /*!< timer-based dequeueing */ |
| 98 | |
| 99 | /*! callback to be called at output of flow control */ |
| 100 | int (*out_cb)(struct bssgp_flow_control *fc, struct msgb *msg, |
| 101 | uint32_t llc_pdu_len, void *priv); |
| 102 | }; |
| 103 | |
Harald Welte | a78b9c2 | 2010-05-17 23:02:42 +0200 | [diff] [blame] | 104 | #define BVC_S_BLOCKED 0x0001 |
| 105 | |
| 106 | /* The per-BTS context that we keep on the SGSN side of the BSSGP link */ |
| 107 | struct bssgp_bvc_ctx { |
| 108 | struct llist_head list; |
| 109 | |
Harald Welte | eb3ccf6 | 2011-11-25 08:15:42 +0100 | [diff] [blame] | 110 | struct gprs_ra_id ra_id; /*!< parsed RA ID of the remote BTS */ |
| 111 | uint16_t cell_id; /*!< Cell ID of the remote BTS */ |
Harald Welte | a78b9c2 | 2010-05-17 23:02:42 +0200 | [diff] [blame] | 112 | |
| 113 | /* NSEI and BVCI of underlying Gb link. Together they |
| 114 | * uniquely identify a link to a BTS (5.4.4) */ |
| 115 | uint16_t bvci; |
| 116 | uint16_t nsei; |
| 117 | |
| 118 | uint32_t state; |
| 119 | |
| 120 | struct rate_ctr_group *ctrg; |
| 121 | |
Harald Welte | d8b4769 | 2012-09-07 11:29:32 +0200 | [diff] [blame] | 122 | struct bssgp_flow_control *fc; |
Harald Welte | bb82622 | 2012-09-07 10:22:01 +0200 | [diff] [blame] | 123 | /*! default maximum size of per-MS bucket in octets */ |
Harald Welte | d11c059 | 2012-09-06 21:57:11 +0200 | [diff] [blame] | 124 | uint32_t bmax_default_ms; |
Harald Welte | bb82622 | 2012-09-07 10:22:01 +0200 | [diff] [blame] | 125 | /*! default bucket leak rate of per-MS bucket in octests/s */ |
Harald Welte | d11c059 | 2012-09-06 21:57:11 +0200 | [diff] [blame] | 126 | uint32_t r_default_ms; |
| 127 | |
Alexander Couzens | 7819ff6 | 2021-02-17 02:30:33 +0100 | [diff] [blame] | 128 | /*! BSS or SGSN. This defines the local state. */ |
| 129 | bool is_sgsn; |
Harald Welte | a78b9c2 | 2010-05-17 23:02:42 +0200 | [diff] [blame] | 130 | /* we might want to add this as a shortcut later, avoiding the NSVC |
| 131 | * lookup for every packet, similar to a routing cache */ |
| 132 | //struct gprs_nsvc *nsvc; |
| 133 | }; |
| 134 | extern struct llist_head bssgp_bvc_ctxts; |
Daniel Willmann | 07a923f | 2020-10-16 16:34:54 +0200 | [diff] [blame] | 135 | /* Create a BTS Context with BVCI+NSEI */ |
| 136 | struct bssgp_bvc_ctx *btsctx_alloc(uint16_t bvci, uint16_t nsei); |
Harald Welte | a78b9c2 | 2010-05-17 23:02:42 +0200 | [diff] [blame] | 137 | /* Find a BTS Context based on parsed RA ID and Cell ID */ |
| 138 | struct bssgp_bvc_ctx *btsctx_by_raid_cid(const struct gprs_ra_id *raid, uint16_t cid); |
| 139 | /* Find a BTS context based on BVCI+NSEI tuple */ |
| 140 | struct bssgp_bvc_ctx *btsctx_by_bvci_nsei(uint16_t bvci, uint16_t nsei); |
Vadim Yanitskiy | 8eae2fc | 2019-11-09 01:45:11 +0700 | [diff] [blame] | 141 | /* Free a given BTS context */ |
| 142 | void bssgp_bvc_ctx_free(struct bssgp_bvc_ctx *ctx); |
Harald Welte | a78b9c2 | 2010-05-17 23:02:42 +0200 | [diff] [blame] | 143 | |
Harald Welte | 85fc314 | 2011-11-25 08:58:40 +0100 | [diff] [blame] | 144 | #define BVC_F_BLOCKED 0x0001 |
| 145 | |
| 146 | enum bssgp_ctr { |
| 147 | BSSGP_CTR_PKTS_IN, |
| 148 | BSSGP_CTR_PKTS_OUT, |
| 149 | BSSGP_CTR_BYTES_IN, |
| 150 | BSSGP_CTR_BYTES_OUT, |
| 151 | BSSGP_CTR_BLOCKED, |
| 152 | BSSGP_CTR_DISCARDED, |
Jacob Erlbeck | 36153dc | 2015-03-17 10:21:17 +0100 | [diff] [blame] | 153 | BSSGP_CTR_STATUS, |
Harald Welte | 85fc314 | 2011-11-25 08:58:40 +0100 | [diff] [blame] | 154 | }; |
| 155 | |
| 156 | |
Pablo Neira Ayuso | ff66323 | 2011-03-22 16:47:59 +0100 | [diff] [blame] | 157 | #include <osmocom/gsm/tlv.h> |
Harald Welte | 605ac5d | 2012-06-16 16:09:52 +0800 | [diff] [blame] | 158 | #include <osmocom/gprs/gprs_msgb.h> |
Harald Welte | 3771d09 | 2010-04-30 20:26:32 +0200 | [diff] [blame] | 159 | |
Harald Welte | 6111234 | 2010-05-13 19:25:59 +0200 | [diff] [blame] | 160 | /* BSSGP-UL-UNITDATA.ind */ |
Harald Welte | de4599c | 2012-06-17 13:04:02 +0800 | [diff] [blame] | 161 | int bssgp_rcvmsg(struct msgb *msg); |
Harald Welte | 6111234 | 2010-05-13 19:25:59 +0200 | [diff] [blame] | 162 | |
| 163 | /* BSSGP-DL-UNITDATA.req */ |
Harald Welte | 8ef54d1 | 2012-06-17 09:31:16 +0800 | [diff] [blame] | 164 | struct bssgp_lv { |
| 165 | uint16_t len; |
| 166 | uint8_t *v; |
| 167 | }; |
| 168 | /* parameters for BSSGP downlink userdata transmission */ |
| 169 | struct bssgp_dl_ud_par { |
| 170 | uint32_t *tlli; |
| 171 | char *imsi; |
Harald Welte | d11c059 | 2012-09-06 21:57:11 +0200 | [diff] [blame] | 172 | struct bssgp_flow_control *fc; |
Harald Welte | 8ef54d1 | 2012-06-17 09:31:16 +0800 | [diff] [blame] | 173 | uint16_t drx_parms; |
| 174 | /* FIXME: priority */ |
| 175 | struct bssgp_lv ms_ra_cap; |
| 176 | uint8_t qos_profile[3]; |
| 177 | }; |
Harald Welte | de4599c | 2012-06-17 13:04:02 +0800 | [diff] [blame] | 178 | int bssgp_tx_dl_ud(struct msgb *msg, uint16_t pdu_lifetime, |
| 179 | struct bssgp_dl_ud_par *dup); |
Harald Welte | 6111234 | 2010-05-13 19:25:59 +0200 | [diff] [blame] | 180 | |
Harald Welte | a2ca4ed | 2010-05-02 11:54:55 +0200 | [diff] [blame] | 181 | uint16_t bssgp_parse_cell_id(struct gprs_ra_id *raid, const uint8_t *buf); |
Harald Welte | 85fc314 | 2011-11-25 08:58:40 +0100 | [diff] [blame] | 182 | int bssgp_create_cell_id(uint8_t *buf, const struct gprs_ra_id *raid, |
| 183 | uint16_t cid); |
Harald Welte | 9ba5005 | 2010-03-14 15:45:01 +0800 | [diff] [blame] | 184 | |
Harald Welte | 3771d09 | 2010-04-30 20:26:32 +0200 | [diff] [blame] | 185 | /* Wrapper around TLV parser to parse BSSGP IEs */ |
Harald Welte | 465c9a5 | 2020-11-18 11:52:14 +0100 | [diff] [blame] | 186 | static inline int bssgp_tlv_parse(struct tlv_parsed *tp, const uint8_t *buf, int len) |
Harald Welte | 3771d09 | 2010-04-30 20:26:32 +0200 | [diff] [blame] | 187 | { |
| 188 | return tlv_parse(tp, &tvlv_att_def, buf, len, 0, 0); |
| 189 | } |
| 190 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 191 | /*! BSSGP Paging mode */ |
Harald Welte | 68b4f03 | 2010-06-09 16:22:28 +0200 | [diff] [blame] | 192 | enum bssgp_paging_mode { |
| 193 | BSSGP_PAGING_PS, |
| 194 | BSSGP_PAGING_CS, |
| 195 | }; |
| 196 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 197 | /*! BSSGP Paging scope */ |
Harald Welte | 68b4f03 | 2010-06-09 16:22:28 +0200 | [diff] [blame] | 198 | enum bssgp_paging_scope { |
Harald Welte | eb3ccf6 | 2011-11-25 08:15:42 +0100 | [diff] [blame] | 199 | BSSGP_PAGING_BSS_AREA, /*!< all cells in BSS */ |
| 200 | BSSGP_PAGING_LOCATION_AREA, /*!< all cells in LA */ |
| 201 | BSSGP_PAGING_ROUTEING_AREA, /*!< all cells in RA */ |
| 202 | BSSGP_PAGING_BVCI, /*!< one cell */ |
Harald Welte | 68b4f03 | 2010-06-09 16:22:28 +0200 | [diff] [blame] | 203 | }; |
| 204 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 205 | /*! BSSGP paging information */ |
Harald Welte | 68b4f03 | 2010-06-09 16:22:28 +0200 | [diff] [blame] | 206 | struct bssgp_paging_info { |
Harald Welte | eb3ccf6 | 2011-11-25 08:15:42 +0100 | [diff] [blame] | 207 | enum bssgp_paging_mode mode; /*!< CS or PS paging */ |
| 208 | enum bssgp_paging_scope scope; /*!< bssgp_paging_scope */ |
| 209 | struct gprs_ra_id raid; /*!< RA Identifier */ |
| 210 | uint16_t bvci; /*!< BVCI */ |
Harald Welte | 85fc314 | 2011-11-25 08:58:40 +0100 | [diff] [blame] | 211 | char *imsi; /*!< IMSI, if any */ |
Harald Welte | eb3ccf6 | 2011-11-25 08:15:42 +0100 | [diff] [blame] | 212 | uint32_t *ptmsi; /*!< P-TMSI, if any */ |
| 213 | uint16_t drx_params; /*!< DRX parameters */ |
| 214 | uint8_t qos[3]; /*!< QoS parameters */ |
Harald Welte | 68b4f03 | 2010-06-09 16:22:28 +0200 | [diff] [blame] | 215 | }; |
| 216 | |
| 217 | /* Send a single GMM-PAGING.req to a given NSEI/NS-BVCI */ |
Harald Welte | de4599c | 2012-06-17 13:04:02 +0800 | [diff] [blame] | 218 | int bssgp_tx_paging(uint16_t nsei, uint16_t ns_bvci, |
| 219 | struct bssgp_paging_info *pinfo); |
Harald Welte | 68b4f03 | 2010-06-09 16:22:28 +0200 | [diff] [blame] | 220 | |
Harald Welte | bb82622 | 2012-09-07 10:22:01 +0200 | [diff] [blame] | 221 | void bssgp_fc_init(struct bssgp_flow_control *fc, |
| 222 | uint32_t bucket_size_max, uint32_t bucket_leak_rate, |
| 223 | uint32_t max_queue_depth, |
| 224 | int (*out_cb)(struct bssgp_flow_control *fc, struct msgb *msg, |
| 225 | uint32_t llc_pdu_len, void *priv)); |
| 226 | |
Harald Welte | d11c059 | 2012-09-06 21:57:11 +0200 | [diff] [blame] | 227 | /* input function of the flow control implementation, called first |
| 228 | * for the MM flow control, and then as the MM flow control output |
| 229 | * callback in order to perform BVC flow control */ |
| 230 | int bssgp_fc_in(struct bssgp_flow_control *fc, struct msgb *msg, |
| 231 | uint32_t llc_pdu_len, void *priv); |
| 232 | |
| 233 | /* Initialize the Flow Control parameters for a new MS according to |
| 234 | * default values for the BVC specified by BVCI and NSEI */ |
| 235 | int bssgp_fc_ms_init(struct bssgp_flow_control *fc_ms, uint16_t bvci, |
Harald Welte | bb82622 | 2012-09-07 10:22:01 +0200 | [diff] [blame] | 236 | uint16_t nsei, uint32_t max_queue_depth); |
Harald Welte | d11c059 | 2012-09-06 21:57:11 +0200 | [diff] [blame] | 237 | |
Harald Welte | e61d459 | 2022-11-03 11:05:58 +0100 | [diff] [blame] | 238 | void bssgp_flush_all_queues(void); |
Alexander Couzens | acc0a07 | 2018-08-07 11:22:28 +0200 | [diff] [blame] | 239 | void bssgp_fc_flush_queue(struct bssgp_flow_control *fc); |
| 240 | |
Harald Welte | fdc7388 | 2010-05-18 08:02:36 +0200 | [diff] [blame] | 241 | /* gprs_bssgp_vty.c */ |
Harald Welte | de4599c | 2012-06-17 13:04:02 +0800 | [diff] [blame] | 242 | int bssgp_vty_init(void); |
Harald Welte | fde19ed | 2020-12-07 21:43:51 +0100 | [diff] [blame] | 243 | void bssgp_set_log_ss(int ss) OSMO_DEPRECATED("Use DLBSSGP instead!\n"); |
Harald Welte | fdc7388 | 2010-05-18 08:02:36 +0200 | [diff] [blame] | 244 | |
Harald Welte | 15a3643 | 2012-06-17 12:16:31 +0800 | [diff] [blame] | 245 | int bssgp_prim_cb(struct osmo_prim_hdr *oph, void *ctx); |