blob: 0f87333af4caaa0525087056a3181e81b0a1e984 [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*! \file gprs_bssgp.h */
2
Sylvain Munaut12ba7782014-06-16 10:13:40 +02003#pragma once
Harald Welte9ba50052010-03-14 15:45:01 +08004
Harald Welte8f9a3ee2010-05-02 11:26:34 +02005#include <stdint.h>
Harald Welted11c0592012-09-06 21:57:11 +02006#include <osmocom/core/timer.h>
7#include <osmocom/core/linuxlist.h>
Harald Welte8f9a3ee2010-05-02 11:26:34 +02008
Harald Welte73952e32012-06-16 14:59:56 +08009#include <osmocom/gsm/gsm48.h>
Harald Welte15a36432012-06-17 12:16:31 +080010#include <osmocom/gsm/prim.h>
Harald Welte73952e32012-06-16 14:59:56 +080011
Harald Welte8648e492012-06-17 13:12:51 +080012#include <osmocom/gprs/protocol/gsm_08_18.h>
13
Harald Welteaf086782010-05-11 10:01:17 +020014/* gprs_bssgp_util.c */
15extern struct gprs_ns_inst *bssgp_nsi;
16struct msgb *bssgp_msgb_alloc(void);
Jacob Erlbeckf78ec5c2015-11-17 09:53:23 +010017struct msgb *bssgp_msgb_copy(const struct msgb *msg, const char *name);
Harald Welteaf086782010-05-11 10:01:17 +020018const char *bssgp_cause_str(enum gprs_bssgp_cause cause);
Maxc0d9a6c2016-03-09 12:29:23 +010019const char *bssgp_pdu_str(enum bssgp_pdu_type pdu);
Harald Welteaf086782010-05-11 10:01:17 +020020/* Transmit a simple response such as BLOCK/UNBLOCK/RESET ACK/NACK */
21int bssgp_tx_simple_bvci(uint8_t pdu_type, uint16_t nsei,
22 uint16_t bvci, uint16_t ns_bvci);
23/* Chapter 10.4.14: Status */
24int bssgp_tx_status(uint8_t cause, uint16_t *bvci, struct msgb *orig_msg);
25
Harald Welte15a36432012-06-17 12:16:31 +080026enum bssgp_prim {
27 PRIM_BSSGP_DL_UD,
28 PRIM_BSSGP_UL_UD,
29 PRIM_BSSGP_PTM_UD,
30
31 PRIM_BSSGP_GMM_SUSPEND,
32 PRIM_BSSGP_GMM_RESUME,
33 PRIM_BSSGP_GMM_PAGING,
34
35 PRIM_NM_FLUSH_LL,
36 PRIM_NM_LLC_DISCARDED,
37 PRIM_NM_BVC_RESET,
38 PRIM_NM_BVC_BLOCK,
39 PRIM_NM_BVC_UNBLOCK,
Jacob Erlbeck36153dc2015-03-17 10:21:17 +010040 PRIM_NM_STATUS,
Harald Welte15a36432012-06-17 12:16:31 +080041};
42
43struct osmo_bssgp_prim {
44 struct osmo_prim_hdr oph;
45
46 /* common fields */
47 uint16_t nsei;
48 uint16_t bvci;
49 uint32_t tlli;
50 struct tlv_parsed *tp;
51 struct gprs_ra_id *ra_id;
52
53 /* specific fields */
54 union {
55 struct {
Holger Hans Peter Freytherd296f422012-08-03 09:59:20 +020056 uint8_t suspend_ref;
Harald Welte15a36432012-06-17 12:16:31 +080057 } resume;
58 } u;
59};
60
Harald Welteaf086782010-05-11 10:01:17 +020061/* gprs_bssgp.c */
62
Neels Hofmeyr87e45502017-06-20 00:17:59 +020063/*! BSSGP flow control (SGSN side) According to Section 8.2 */
Harald Welted11c0592012-09-06 21:57:11 +020064struct bssgp_flow_control {
Harald Weltebb826222012-09-07 10:22:01 +020065 uint32_t bucket_size_max; /*!< maximum size of the bucket (octets) */
66 uint32_t bucket_leak_rate; /*!< leak rate of the bucket (octets/sec) */
Harald Welted11c0592012-09-06 21:57:11 +020067
68 uint32_t bucket_counter; /*!< number of tokens in the bucket */
69 struct timeval time_last_pdu; /*!< timestamp of last PDU sent */
70
71 /* the built-in queue */
Harald Weltebb826222012-09-07 10:22:01 +020072 uint32_t max_queue_depth; /*!< how many packets to queue (mgs) */
73 uint32_t queue_depth; /*!< current length of queue (msgs) */
Harald Welted11c0592012-09-06 21:57:11 +020074 struct llist_head queue; /*!< linked list of msgb's */
75 struct osmo_timer_list timer; /*!< timer-based dequeueing */
76
77 /*! callback to be called at output of flow control */
78 int (*out_cb)(struct bssgp_flow_control *fc, struct msgb *msg,
79 uint32_t llc_pdu_len, void *priv);
80};
81
Harald Weltea78b9c22010-05-17 23:02:42 +020082#define BVC_S_BLOCKED 0x0001
83
84/* The per-BTS context that we keep on the SGSN side of the BSSGP link */
85struct bssgp_bvc_ctx {
86 struct llist_head list;
87
Harald Welteeb3ccf62011-11-25 08:15:42 +010088 struct gprs_ra_id ra_id; /*!< parsed RA ID of the remote BTS */
89 uint16_t cell_id; /*!< Cell ID of the remote BTS */
Harald Weltea78b9c22010-05-17 23:02:42 +020090
91 /* NSEI and BVCI of underlying Gb link. Together they
92 * uniquely identify a link to a BTS (5.4.4) */
93 uint16_t bvci;
94 uint16_t nsei;
95
96 uint32_t state;
97
98 struct rate_ctr_group *ctrg;
99
Harald Welted8b47692012-09-07 11:29:32 +0200100 struct bssgp_flow_control *fc;
Harald Weltebb826222012-09-07 10:22:01 +0200101 /*! default maximum size of per-MS bucket in octets */
Harald Welted11c0592012-09-06 21:57:11 +0200102 uint32_t bmax_default_ms;
Harald Weltebb826222012-09-07 10:22:01 +0200103 /*! default bucket leak rate of per-MS bucket in octests/s */
Harald Welted11c0592012-09-06 21:57:11 +0200104 uint32_t r_default_ms;
105
Harald Weltea78b9c22010-05-17 23:02:42 +0200106 /* we might want to add this as a shortcut later, avoiding the NSVC
107 * lookup for every packet, similar to a routing cache */
108 //struct gprs_nsvc *nsvc;
109};
110extern struct llist_head bssgp_bvc_ctxts;
111/* Find a BTS Context based on parsed RA ID and Cell ID */
112struct bssgp_bvc_ctx *btsctx_by_raid_cid(const struct gprs_ra_id *raid, uint16_t cid);
113/* Find a BTS context based on BVCI+NSEI tuple */
114struct bssgp_bvc_ctx *btsctx_by_bvci_nsei(uint16_t bvci, uint16_t nsei);
Vadim Yanitskiy8eae2fc2019-11-09 01:45:11 +0700115/* Free a given BTS context */
116void bssgp_bvc_ctx_free(struct bssgp_bvc_ctx *ctx);
Harald Weltea78b9c22010-05-17 23:02:42 +0200117
Harald Welte85fc3142011-11-25 08:58:40 +0100118#define BVC_F_BLOCKED 0x0001
119
120enum bssgp_ctr {
121 BSSGP_CTR_PKTS_IN,
122 BSSGP_CTR_PKTS_OUT,
123 BSSGP_CTR_BYTES_IN,
124 BSSGP_CTR_BYTES_OUT,
125 BSSGP_CTR_BLOCKED,
126 BSSGP_CTR_DISCARDED,
Jacob Erlbeck36153dc2015-03-17 10:21:17 +0100127 BSSGP_CTR_STATUS,
Harald Welte85fc3142011-11-25 08:58:40 +0100128};
129
130
Pablo Neira Ayusoff663232011-03-22 16:47:59 +0100131#include <osmocom/gsm/tlv.h>
Harald Welte605ac5d2012-06-16 16:09:52 +0800132#include <osmocom/gprs/gprs_msgb.h>
Harald Welte3771d092010-04-30 20:26:32 +0200133
Harald Welte61112342010-05-13 19:25:59 +0200134/* BSSGP-UL-UNITDATA.ind */
Harald Weltede4599c2012-06-17 13:04:02 +0800135int bssgp_rcvmsg(struct msgb *msg);
Harald Welte61112342010-05-13 19:25:59 +0200136
137/* BSSGP-DL-UNITDATA.req */
Harald Welte8ef54d12012-06-17 09:31:16 +0800138struct bssgp_lv {
139 uint16_t len;
140 uint8_t *v;
141};
142/* parameters for BSSGP downlink userdata transmission */
143struct bssgp_dl_ud_par {
144 uint32_t *tlli;
145 char *imsi;
Harald Welted11c0592012-09-06 21:57:11 +0200146 struct bssgp_flow_control *fc;
Harald Welte8ef54d12012-06-17 09:31:16 +0800147 uint16_t drx_parms;
148 /* FIXME: priority */
149 struct bssgp_lv ms_ra_cap;
150 uint8_t qos_profile[3];
151};
Harald Weltede4599c2012-06-17 13:04:02 +0800152int bssgp_tx_dl_ud(struct msgb *msg, uint16_t pdu_lifetime,
153 struct bssgp_dl_ud_par *dup);
Harald Welte61112342010-05-13 19:25:59 +0200154
Harald Weltea2ca4ed2010-05-02 11:54:55 +0200155uint16_t bssgp_parse_cell_id(struct gprs_ra_id *raid, const uint8_t *buf);
Harald Welte85fc3142011-11-25 08:58:40 +0100156int bssgp_create_cell_id(uint8_t *buf, const struct gprs_ra_id *raid,
157 uint16_t cid);
Harald Welte9ba50052010-03-14 15:45:01 +0800158
Harald Welte3771d092010-04-30 20:26:32 +0200159/* Wrapper around TLV parser to parse BSSGP IEs */
Harald Welte8f9a3ee2010-05-02 11:26:34 +0200160static inline int bssgp_tlv_parse(struct tlv_parsed *tp, uint8_t *buf, int len)
Harald Welte3771d092010-04-30 20:26:32 +0200161{
162 return tlv_parse(tp, &tvlv_att_def, buf, len, 0, 0);
163}
164
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200165/*! BSSGP Paging mode */
Harald Welte68b4f032010-06-09 16:22:28 +0200166enum bssgp_paging_mode {
167 BSSGP_PAGING_PS,
168 BSSGP_PAGING_CS,
169};
170
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200171/*! BSSGP Paging scope */
Harald Welte68b4f032010-06-09 16:22:28 +0200172enum bssgp_paging_scope {
Harald Welteeb3ccf62011-11-25 08:15:42 +0100173 BSSGP_PAGING_BSS_AREA, /*!< all cells in BSS */
174 BSSGP_PAGING_LOCATION_AREA, /*!< all cells in LA */
175 BSSGP_PAGING_ROUTEING_AREA, /*!< all cells in RA */
176 BSSGP_PAGING_BVCI, /*!< one cell */
Harald Welte68b4f032010-06-09 16:22:28 +0200177};
178
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200179/*! BSSGP paging information */
Harald Welte68b4f032010-06-09 16:22:28 +0200180struct bssgp_paging_info {
Harald Welteeb3ccf62011-11-25 08:15:42 +0100181 enum bssgp_paging_mode mode; /*!< CS or PS paging */
182 enum bssgp_paging_scope scope; /*!< bssgp_paging_scope */
183 struct gprs_ra_id raid; /*!< RA Identifier */
184 uint16_t bvci; /*!< BVCI */
Harald Welte85fc3142011-11-25 08:58:40 +0100185 char *imsi; /*!< IMSI, if any */
Harald Welteeb3ccf62011-11-25 08:15:42 +0100186 uint32_t *ptmsi; /*!< P-TMSI, if any */
187 uint16_t drx_params; /*!< DRX parameters */
188 uint8_t qos[3]; /*!< QoS parameters */
Harald Welte68b4f032010-06-09 16:22:28 +0200189};
190
191/* Send a single GMM-PAGING.req to a given NSEI/NS-BVCI */
Harald Weltede4599c2012-06-17 13:04:02 +0800192int bssgp_tx_paging(uint16_t nsei, uint16_t ns_bvci,
193 struct bssgp_paging_info *pinfo);
Harald Welte68b4f032010-06-09 16:22:28 +0200194
Harald Weltebb826222012-09-07 10:22:01 +0200195void bssgp_fc_init(struct bssgp_flow_control *fc,
196 uint32_t bucket_size_max, uint32_t bucket_leak_rate,
197 uint32_t max_queue_depth,
198 int (*out_cb)(struct bssgp_flow_control *fc, struct msgb *msg,
199 uint32_t llc_pdu_len, void *priv));
200
Harald Welted11c0592012-09-06 21:57:11 +0200201/* input function of the flow control implementation, called first
202 * for the MM flow control, and then as the MM flow control output
203 * callback in order to perform BVC flow control */
204int bssgp_fc_in(struct bssgp_flow_control *fc, struct msgb *msg,
205 uint32_t llc_pdu_len, void *priv);
206
207/* Initialize the Flow Control parameters for a new MS according to
208 * default values for the BVC specified by BVCI and NSEI */
209int bssgp_fc_ms_init(struct bssgp_flow_control *fc_ms, uint16_t bvci,
Harald Weltebb826222012-09-07 10:22:01 +0200210 uint16_t nsei, uint32_t max_queue_depth);
Harald Welted11c0592012-09-06 21:57:11 +0200211
Alexander Couzensacc0a072018-08-07 11:22:28 +0200212void bssgp_flush_all_queues();
213void bssgp_fc_flush_queue(struct bssgp_flow_control *fc);
214
Harald Weltefdc73882010-05-18 08:02:36 +0200215/* gprs_bssgp_vty.c */
Harald Weltede4599c2012-06-17 13:04:02 +0800216int bssgp_vty_init(void);
217void bssgp_set_log_ss(int ss);
Harald Weltefdc73882010-05-18 08:02:36 +0200218
Harald Welte15a36432012-06-17 12:16:31 +0800219int bssgp_prim_cb(struct osmo_prim_hdr *oph, void *ctx);