blob: d1734ee5830ae58460960baee348f4133f4860c6 [file] [log] [blame]
Neels Hofmeyr17518fe2017-06-20 04:35:06 +02001/*! \file gprs_bssgp_bss.c
2 * GPRS BSSGP protocol implementation as per 3GPP TS 08.18. */
3/*
4 * (C) 2009-2017 by Harald Welte <laforge@gnumonks.org>
Harald Welte85fc3142011-11-25 08:58:40 +01005 *
6 * All Rights Reserved
7 *
Harald Weltee08da972017-11-13 01:00:26 +09008 * SPDX-License-Identifier: GPL-2.0+
9 *
Harald Welte85fc3142011-11-25 08:58:40 +010010 * This program is free software; you can redistribute it and/or modify
Harald Welte7fa89c22014-10-26 20:33:09 +010011 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
Harald Welte85fc3142011-11-25 08:58:40 +010013 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
Harald Welte7fa89c22014-10-26 20:33:09 +010018 * GNU General Public License for more details.
Harald Welte85fc3142011-11-25 08:58:40 +010019 *
Harald Welte7fa89c22014-10-26 20:33:09 +010020 * You should have received a copy of the GNU General Public License
Harald Welte85fc3142011-11-25 08:58:40 +010021 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 *
23 */
24
25#include <errno.h>
26#include <stdint.h>
27
Harald Welte85fc3142011-11-25 08:58:40 +010028#include <osmocom/core/msgb.h>
Harald Weltebfe62e52017-05-15 12:48:30 +020029#include <osmocom/core/byteswap.h>
Harald Welte85fc3142011-11-25 08:58:40 +010030#include <osmocom/core/rate_ctr.h>
31#include <osmocom/gsm/tlv.h>
32#include <osmocom/core/talloc.h>
Harald Welte73952e32012-06-16 14:59:56 +080033#include <osmocom/gprs/gprs_bssgp.h>
Harald Welte30fabdf2012-09-10 08:54:35 +020034#include <osmocom/gprs/gprs_bssgp_bss.h>
Harald Welte73952e32012-06-16 14:59:56 +080035#include <osmocom/gprs/gprs_ns.h>
Harald Welte85fc3142011-11-25 08:58:40 +010036
Alexander Couzens85a8fd32020-07-18 15:57:07 +020037#include "gprs_bssgp_internal.h"
Harald Weltecca49632012-06-16 17:45:59 +080038#include "common_vty.h"
Harald Welte85fc3142011-11-25 08:58:40 +010039
Jacob Erlbeckc1cb75e2015-06-18 13:21:30 +020040#define GSM_IMSI_LENGTH 17
41
Harald Welte85fc3142011-11-25 08:58:40 +010042uint8_t *bssgp_msgb_tlli_put(struct msgb *msg, uint32_t tlli)
43{
Harald Weltebfe62e52017-05-15 12:48:30 +020044 uint32_t _tlli = osmo_htonl(tlli);
Harald Welte85fc3142011-11-25 08:58:40 +010045 return msgb_tvlv_put(msg, BSSGP_IE_TLLI, 4, (uint8_t *) &_tlli);
46}
47
Maxf1ad60e2018-01-05 14:19:33 +010048uint8_t *bssgp_msgb_ra_put(struct msgb *msg, const struct gprs_ra_id *ra_id)
49{
50 struct gsm48_ra_id ra;
51
52 gsm48_encode_ra(&ra, ra_id);
53 return msgb_tvlv_put(msg, BSSGP_IE_ROUTEING_AREA, sizeof(ra), (const uint8_t *)&ra);
54}
55
Neels Hofmeyr87e45502017-06-20 00:17:59 +020056/*! GMM-SUSPEND.req (Chapter 10.3.6) */
Harald Welte85fc3142011-11-25 08:58:40 +010057int bssgp_tx_suspend(uint16_t nsei, uint32_t tlli,
58 const struct gprs_ra_id *ra_id)
59{
60 struct msgb *msg = bssgp_msgb_alloc();
61 struct bssgp_normal_hdr *bgph =
62 (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
Harald Welte85fc3142011-11-25 08:58:40 +010063
64 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP (BVCI=0) Tx SUSPEND (TLLI=0x%04x)\n",
65 tlli);
66 msgb_nsei(msg) = nsei;
67 msgb_bvci(msg) = 0; /* Signalling */
68 bgph->pdu_type = BSSGP_PDUT_SUSPEND;
69
70 bssgp_msgb_tlli_put(msg, tlli);
Maxf1ad60e2018-01-05 14:19:33 +010071 bssgp_msgb_ra_put(msg, ra_id);
Harald Welte85fc3142011-11-25 08:58:40 +010072
Alexander Couzens85a8fd32020-07-18 15:57:07 +020073 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +010074}
75
Neels Hofmeyr87e45502017-06-20 00:17:59 +020076/*! GMM-RESUME.req (Chapter 10.3.9) */
Harald Welte85fc3142011-11-25 08:58:40 +010077int bssgp_tx_resume(uint16_t nsei, uint32_t tlli,
78 const struct gprs_ra_id *ra_id, uint8_t suspend_ref)
79{
80 struct msgb *msg = bssgp_msgb_alloc();
81 struct bssgp_normal_hdr *bgph =
82 (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
Harald Welte85fc3142011-11-25 08:58:40 +010083
84 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP (BVCI=0) Tx RESUME (TLLI=0x%04x)\n",
85 tlli);
86 msgb_nsei(msg) = nsei;
87 msgb_bvci(msg) = 0; /* Signalling */
88 bgph->pdu_type = BSSGP_PDUT_RESUME;
89
90 bssgp_msgb_tlli_put(msg, tlli);
Maxf1ad60e2018-01-05 14:19:33 +010091 bssgp_msgb_ra_put(msg, ra_id);
Harald Welte85fc3142011-11-25 08:58:40 +010092
93 msgb_tvlv_put(msg, BSSGP_IE_SUSPEND_REF_NR, 1, &suspend_ref);
94
Alexander Couzens85a8fd32020-07-18 15:57:07 +020095 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +010096}
97
Neels Hofmeyr87e45502017-06-20 00:17:59 +020098/*! Transmit RA-CAPABILITY-UPDATE (10.3.3) */
Harald Welte85fc3142011-11-25 08:58:40 +010099int bssgp_tx_ra_capa_upd(struct bssgp_bvc_ctx *bctx, uint32_t tlli, uint8_t tag)
100{
101 struct msgb *msg = bssgp_msgb_alloc();
102 struct bssgp_normal_hdr *bgph =
103 (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
104
105 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP (BVCI=%u) Tx RA-CAPA-UPD (TLLI=0x%04x)\n",
106 bctx->bvci, tlli);
107
108 /* set NSEI and BVCI in msgb cb */
109 msgb_nsei(msg) = bctx->nsei;
110 msgb_bvci(msg) = bctx->bvci;
111
112 bgph->pdu_type = BSSGP_PDUT_RA_CAPA_UDPATE;
113 bssgp_msgb_tlli_put(msg, tlli);
114
115 msgb_tvlv_put(msg, BSSGP_IE_TAG, 1, &tag);
116
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200117 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +0100118}
119
120/* first common part of RADIO-STATUS */
121static struct msgb *common_tx_radio_status(struct bssgp_bvc_ctx *bctx)
122{
123 struct msgb *msg = bssgp_msgb_alloc();
124 struct bssgp_normal_hdr *bgph =
125 (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
126
127 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP (BVCI=%u) Tx RADIO-STATUS ",
128 bctx->bvci);
129
130 /* set NSEI and BVCI in msgb cb */
131 msgb_nsei(msg) = bctx->nsei;
132 msgb_bvci(msg) = bctx->bvci;
133
134 bgph->pdu_type = BSSGP_PDUT_RADIO_STATUS;
135
136 return msg;
137}
138
139/* second common part of RADIO-STATUS */
140static int common_tx_radio_status2(struct msgb *msg, uint8_t cause)
141{
142 msgb_tvlv_put(msg, BSSGP_IE_CAUSE, 1, &cause);
Max2c34ab42016-03-17 15:42:26 +0100143 LOGPC(DBSSGP, LOGL_NOTICE, "CAUSE=%s\n", bssgp_cause_str(cause));
Harald Welte85fc3142011-11-25 08:58:40 +0100144
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200145 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +0100146}
147
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200148/*! Transmit RADIO-STATUS for TLLI (10.3.5) */
Harald Welte85fc3142011-11-25 08:58:40 +0100149int bssgp_tx_radio_status_tlli(struct bssgp_bvc_ctx *bctx, uint8_t cause,
150 uint32_t tlli)
151{
152 struct msgb *msg = common_tx_radio_status(bctx);
153
154 if (!msg)
155 return -ENOMEM;
156 bssgp_msgb_tlli_put(msg, tlli);
157 LOGPC(DBSSGP, LOGL_NOTICE, "TLLI=0x%08x ", tlli);
158
159 return common_tx_radio_status2(msg, cause);
160}
161
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200162/*! Transmit RADIO-STATUS for TMSI (10.3.5) */
Harald Welte85fc3142011-11-25 08:58:40 +0100163int bssgp_tx_radio_status_tmsi(struct bssgp_bvc_ctx *bctx, uint8_t cause,
164 uint32_t tmsi)
165{
166 struct msgb *msg = common_tx_radio_status(bctx);
Harald Weltebfe62e52017-05-15 12:48:30 +0200167 uint32_t _tmsi = osmo_htonl(tmsi);
Harald Welte85fc3142011-11-25 08:58:40 +0100168
169 if (!msg)
170 return -ENOMEM;
171 msgb_tvlv_put(msg, BSSGP_IE_TMSI, 4, (uint8_t *)&_tmsi);
172 LOGPC(DBSSGP, LOGL_NOTICE, "TMSI=0x%08x ", tmsi);
173
174 return common_tx_radio_status2(msg, cause);
175}
176
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200177/*! Transmit RADIO-STATUS for IMSI (10.3.5) */
Harald Welte85fc3142011-11-25 08:58:40 +0100178int bssgp_tx_radio_status_imsi(struct bssgp_bvc_ctx *bctx, uint8_t cause,
179 const char *imsi)
180{
181 struct msgb *msg = common_tx_radio_status(bctx);
Harald Weltea13fb752020-06-16 08:44:42 +0200182 uint8_t mi[GSM48_MID_MAX_SIZE];
183 int imsi_len = gsm48_generate_mid_from_imsi(mi, imsi);
Harald Welte85fc3142011-11-25 08:58:40 +0100184
185 if (!msg)
186 return -ENOMEM;
Harald Weltea13fb752020-06-16 08:44:42 +0200187/* gsm48_generate_mid_from_imsi() is guaranteed to never return more than 11,
188 * but somehow gcc (8.2) is not smart enough to figure this out and claims that
189 * the memcpy in msgb_tvlv_put() below will cause and out-of-bounds access up to
190 * mi[131], which is wrong */
191#pragma GCC diagnostic push
192#pragma GCC diagnostic ignored "-Warray-bounds"
193 OSMO_ASSERT(imsi_len <= GSM48_MID_MAX_SIZE);
194 /* strip the MI type and length values (2 bytes) */
195 if (imsi_len > 2)
196 msgb_tvlv_put(msg, BSSGP_IE_IMSI, imsi_len-2, mi+2);
197#pragma GCC diagnostic pop
Harald Welte85fc3142011-11-25 08:58:40 +0100198 LOGPC(DBSSGP, LOGL_NOTICE, "IMSI=%s ", imsi);
199
200 return common_tx_radio_status2(msg, cause);
201}
202
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200203/*! Transmit FLUSH-LL-ACK (Chapter 10.4.2) */
Harald Welte85fc3142011-11-25 08:58:40 +0100204int bssgp_tx_flush_ll_ack(struct bssgp_bvc_ctx *bctx, uint32_t tlli,
205 uint8_t action, uint16_t bvci_new,
206 uint32_t num_octets)
207{
208 struct msgb *msg = bssgp_msgb_alloc();
209 struct bssgp_normal_hdr *bgph =
210 (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
Harald Weltebfe62e52017-05-15 12:48:30 +0200211 uint16_t _bvci_new = osmo_htons(bvci_new);
212 uint32_t _oct_aff = osmo_htonl(num_octets & 0xFFFFFF);
Harald Welte85fc3142011-11-25 08:58:40 +0100213
214 msgb_nsei(msg) = bctx->nsei;
215 msgb_bvci(msg) = 0; /* Signalling */
216 bgph->pdu_type = BSSGP_PDUT_FLUSH_LL_ACK;
217
218 bssgp_msgb_tlli_put(msg, tlli);
219 msgb_tvlv_put(msg, BSSGP_IE_FLUSH_ACTION, 1, &action);
220 if (action == 1) /* transferred */
221 msgb_tvlv_put(msg, BSSGP_IE_BVCI, 2, (uint8_t *) &_bvci_new);
222 msgb_tvlv_put(msg, BSSGP_IE_NUM_OCT_AFF, 3, (uint8_t *) &_oct_aff);
223
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200224 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +0100225}
226
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200227/*! Transmit LLC-DISCARDED (Chapter 10.4.3) */
Harald Welte85fc3142011-11-25 08:58:40 +0100228int bssgp_tx_llc_discarded(struct bssgp_bvc_ctx *bctx, uint32_t tlli,
229 uint8_t num_frames, uint32_t num_octets)
230{
231 struct msgb *msg = bssgp_msgb_alloc();
232 struct bssgp_normal_hdr *bgph =
233 (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
Harald Weltebfe62e52017-05-15 12:48:30 +0200234 uint16_t _bvci = osmo_htons(bctx->bvci);
235 uint32_t _oct_aff = osmo_htonl(num_octets & 0xFFFFFF);
Harald Welte85fc3142011-11-25 08:58:40 +0100236
237 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP (BVCI=%u) Tx LLC-DISCARDED "
238 "TLLI=0x%04x, FRAMES=%u, OCTETS=%u\n", bctx->bvci, tlli,
239 num_frames, num_octets);
240 msgb_nsei(msg) = bctx->nsei;
241 msgb_bvci(msg) = 0; /* Signalling */
242 bgph->pdu_type = BSSGP_PDUT_LLC_DISCARD;
243
244 bssgp_msgb_tlli_put(msg, tlli);
245
246 msgb_tvlv_put(msg, BSSGP_IE_LLC_FRAMES_DISCARDED, 1, &num_frames);
247 msgb_tvlv_put(msg, BSSGP_IE_BVCI, 2, (uint8_t *) &_bvci);
Andreas Eversbergaa5d0e82012-07-21 13:33:39 +0200248 msgb_tvlv_put(msg, BSSGP_IE_NUM_OCT_AFF, 3, ((uint8_t *) &_oct_aff) + 1);
Harald Welte85fc3142011-11-25 08:58:40 +0100249
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200250 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +0100251}
252
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200253/*! Transmit a BVC-BLOCK message (Chapter 10.4.8) */
Harald Welte85fc3142011-11-25 08:58:40 +0100254int bssgp_tx_bvc_block(struct bssgp_bvc_ctx *bctx, uint8_t cause)
255{
256 struct msgb *msg = bssgp_msgb_alloc();
257 struct bssgp_normal_hdr *bgph =
258 (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
Harald Weltebfe62e52017-05-15 12:48:30 +0200259 uint16_t _bvci = osmo_htons(bctx->bvci);
Harald Welte85fc3142011-11-25 08:58:40 +0100260
261 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP (BVCI=%u) Tx BVC-BLOCK "
Max2c34ab42016-03-17 15:42:26 +0100262 "CAUSE=%s\n", bctx->bvci, bssgp_cause_str(cause));
Harald Welte85fc3142011-11-25 08:58:40 +0100263
264 msgb_nsei(msg) = bctx->nsei;
265 msgb_bvci(msg) = 0; /* Signalling */
266 bgph->pdu_type = BSSGP_PDUT_BVC_BLOCK;
267
268 msgb_tvlv_put(msg, BSSGP_IE_BVCI, 2, (uint8_t *) &_bvci);
269 msgb_tvlv_put(msg, BSSGP_IE_CAUSE, 1, &cause);
270
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200271 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +0100272}
273
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200274/*! Transmit a BVC-UNBLOCK message (Chapter 10.4.10) */
Harald Welte85fc3142011-11-25 08:58:40 +0100275int bssgp_tx_bvc_unblock(struct bssgp_bvc_ctx *bctx)
276{
277 struct msgb *msg = bssgp_msgb_alloc();
278 struct bssgp_normal_hdr *bgph =
279 (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
Harald Weltebfe62e52017-05-15 12:48:30 +0200280 uint16_t _bvci = osmo_htons(bctx->bvci);
Harald Welte85fc3142011-11-25 08:58:40 +0100281
Harald Welte6a469e12019-02-19 11:07:50 +0100282 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP (BVCI=%u) Tx BVC-UNBLOCK\n", bctx->bvci);
Harald Welte85fc3142011-11-25 08:58:40 +0100283
284 msgb_nsei(msg) = bctx->nsei;
285 msgb_bvci(msg) = 0; /* Signalling */
286 bgph->pdu_type = BSSGP_PDUT_BVC_UNBLOCK;
287
288 msgb_tvlv_put(msg, BSSGP_IE_BVCI, 2, (uint8_t *) &_bvci);
289
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200290 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +0100291}
292
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200293/*! Transmit a BVC-RESET message (Chapter 10.4.12) */
Harald Welte2d3465f2020-06-26 15:13:19 +0200294int bssgp_tx_bvc_reset2(struct bssgp_bvc_ctx *bctx, uint16_t bvci, uint8_t cause, bool add_cell_id)
Harald Welte85fc3142011-11-25 08:58:40 +0100295{
296 struct msgb *msg = bssgp_msgb_alloc();
297 struct bssgp_normal_hdr *bgph =
298 (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
Harald Weltebfe62e52017-05-15 12:48:30 +0200299 uint16_t _bvci = osmo_htons(bvci);
Harald Welte85fc3142011-11-25 08:58:40 +0100300
301 LOGP(DBSSGP, LOGL_NOTICE, "BSSGP (BVCI=%u) Tx BVC-RESET "
Max2c34ab42016-03-17 15:42:26 +0100302 "CAUSE=%s\n", bvci, bssgp_cause_str(cause));
Harald Welte85fc3142011-11-25 08:58:40 +0100303
304 msgb_nsei(msg) = bctx->nsei;
305 msgb_bvci(msg) = 0; /* Signalling */
306 bgph->pdu_type = BSSGP_PDUT_BVC_RESET;
307
308 msgb_tvlv_put(msg, BSSGP_IE_BVCI, 2, (uint8_t *) &_bvci);
309 msgb_tvlv_put(msg, BSSGP_IE_CAUSE, 1, &cause);
Harald Welte2d3465f2020-06-26 15:13:19 +0200310 if (add_cell_id) {
Harald Welte85fc3142011-11-25 08:58:40 +0100311 uint8_t bssgp_cid[8];
312 bssgp_create_cell_id(bssgp_cid, &bctx->ra_id, bctx->cell_id);
313 msgb_tvlv_put(msg, BSSGP_IE_CELL_ID, sizeof(bssgp_cid), bssgp_cid);
314 }
315 /* Optional: Feature Bitmap */
316
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200317 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +0100318}
Harald Welte2d3465f2020-06-26 15:13:19 +0200319int bssgp_tx_bvc_reset(struct bssgp_bvc_ctx *bctx, uint16_t bvci, uint8_t cause)
320{
Harald Weltebd771a92020-10-04 21:42:38 +0200321 /* The Cell Identifier IE is mandatory in the BVC-RESET PDU sent from BSS to SGSN in order to reset a
322 * BVC corresponding to a PTP functional entity. The Cell Identifier IE shall not be used in any other
323 * BVC-RESET PDU. */
324 switch (bvci) {
325 case BVCI_SIGNALLING:
326 case BVCI_PTM:
327 return bssgp_tx_bvc_reset2(bctx, bvci, cause, false);
328 default:
329 return bssgp_tx_bvc_reset2(bctx, bvci, cause, true);
330 }
Harald Welte2d3465f2020-06-26 15:13:19 +0200331}
Harald Welte85fc3142011-11-25 08:58:40 +0100332
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200333/*! Transmit a FLOW_CONTROL-BVC (Chapter 10.4.4)
Harald Weltee92866b2012-09-10 08:56:04 +0200334 * \param[in] bctx BVC Context
Andreas Eversbergb8d18f32012-09-30 16:59:33 +0200335 * \param[in] tag Additional tag to identify acknowledge
Harald Weltee92866b2012-09-10 08:56:04 +0200336 * \param[in] bucket_size Maximum bucket size in octets
337 * \param[in] bucket_leak_rate Bucket leak rate in octets/sec
338 * \param[in] bmax_default_ms Maximum bucket size default for MS
339 * \param[in] r_default_ms Bucket leak rate default for MS in octets/sec
340 * \param[in] bucket_full_ratio Ratio (in percent) of queue filling
341 * \param[in] queue_delay_ms Average queuing delay in milliseconds
342 */
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200343int bssgp_tx_fc_bvc(struct bssgp_bvc_ctx *bctx, uint8_t tag,
Harald Weltee92866b2012-09-10 08:56:04 +0200344 uint32_t bucket_size, uint32_t bucket_leak_rate,
Jacob Erlbeck9385d1e2015-05-06 09:29:32 +0200345 uint32_t bmax_default_ms, uint32_t r_default_ms,
Harald Weltee92866b2012-09-10 08:56:04 +0200346 uint8_t *bucket_full_ratio, uint32_t *queue_delay_ms)
347{
348 struct msgb *msg;
349 struct bssgp_normal_hdr *bgph;
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200350 uint16_t e_bucket_size, e_leak_rate, e_bmax_default_ms, e_r_default_ms;
Harald Weltee92866b2012-09-10 08:56:04 +0200351 uint16_t e_queue_delay = 0; /* to make gcc happy */
352
353 if ((bucket_size / 100) > 0xffff)
354 return -EINVAL;
Harald Weltebfe62e52017-05-15 12:48:30 +0200355 e_bucket_size = osmo_htons(bucket_size / 100);
Harald Weltee92866b2012-09-10 08:56:04 +0200356
357 if ((bucket_leak_rate * 8 / 100) > 0xffff)
358 return -EINVAL;
Harald Weltebfe62e52017-05-15 12:48:30 +0200359 e_leak_rate = osmo_htons((bucket_leak_rate * 8) / 100);
Harald Weltee92866b2012-09-10 08:56:04 +0200360
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200361 if ((bmax_default_ms / 100) > 0xffff)
362 return -EINVAL;
Harald Weltebfe62e52017-05-15 12:48:30 +0200363 e_bmax_default_ms = osmo_htons(bmax_default_ms / 100);
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200364
Harald Weltee92866b2012-09-10 08:56:04 +0200365 if ((r_default_ms * 8 / 100) > 0xffff)
366 return -EINVAL;
Harald Weltebfe62e52017-05-15 12:48:30 +0200367 e_r_default_ms = osmo_htons((r_default_ms * 8) / 100);
Harald Weltee92866b2012-09-10 08:56:04 +0200368
369 if (queue_delay_ms) {
370 if ((*queue_delay_ms / 10) > 60000)
371 return -EINVAL;
372 else if (*queue_delay_ms == 0xFFFFFFFF)
373 e_queue_delay = 0xFFFF;
374 else
Harald Weltebfe62e52017-05-15 12:48:30 +0200375 e_queue_delay = osmo_htons(*queue_delay_ms / 10);
Harald Weltee92866b2012-09-10 08:56:04 +0200376 }
377
378 msg = bssgp_msgb_alloc();
379 bgph = (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
380 msgb_nsei(msg) = bctx->nsei;
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200381 msgb_bvci(msg) = bctx->bvci;
Harald Weltee92866b2012-09-10 08:56:04 +0200382 bgph->pdu_type = BSSGP_PDUT_FLOW_CONTROL_BVC;
383
384 msgb_tvlv_put(msg, BSSGP_IE_TAG, sizeof(tag), (uint8_t *)&tag);
385 msgb_tvlv_put(msg, BSSGP_IE_BVC_BUCKET_SIZE,
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200386 sizeof(e_bucket_size), (uint8_t *) &e_bucket_size);
Harald Weltee92866b2012-09-10 08:56:04 +0200387 msgb_tvlv_put(msg, BSSGP_IE_BUCKET_LEAK_RATE,
388 sizeof(e_leak_rate), (uint8_t *) &e_leak_rate);
389 msgb_tvlv_put(msg, BSSGP_IE_BMAX_DEFAULT_MS,
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200390 sizeof(e_bmax_default_ms),
391 (uint8_t *) &e_bmax_default_ms);
Harald Weltee92866b2012-09-10 08:56:04 +0200392 msgb_tvlv_put(msg, BSSGP_IE_R_DEFAULT_MS,
393 sizeof(e_r_default_ms), (uint8_t *) &e_r_default_ms);
394 if (bucket_full_ratio)
395 msgb_tvlv_put(msg, BSSGP_IE_BUCKET_FULL_RATIO,
396 1, bucket_full_ratio);
397 if (queue_delay_ms)
398 msgb_tvlv_put(msg, BSSGP_IE_BVC_MEASUREMENT,
399 sizeof(e_queue_delay),
400 (uint8_t *) &e_queue_delay);
401
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200402 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Weltee92866b2012-09-10 08:56:04 +0200403}
404
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200405/*! Transmit a FLOW_CONTROL-MS (Chapter 10.4.6)
Harald Weltee92866b2012-09-10 08:56:04 +0200406 * \param[in] bctx BVC Context
Andreas Eversbergb8d18f32012-09-30 16:59:33 +0200407 * \param[in] tlli TLLI to identify MS
408 * \param[in] tag Additional tag to identify acknowledge
Harald Weltee92866b2012-09-10 08:56:04 +0200409 * \param[in] ms_bucket_size Maximum bucket size in octets
410 * \param[in] bucket_leak_rate Bucket leak rate in octets/sec
411 * \param[in] bucket_full_ratio Ratio (in percent) of queue filling
412 */
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200413int bssgp_tx_fc_ms(struct bssgp_bvc_ctx *bctx, uint32_t tlli, uint8_t tag,
Harald Weltee92866b2012-09-10 08:56:04 +0200414 uint32_t ms_bucket_size, uint32_t bucket_leak_rate,
415 uint8_t *bucket_full_ratio)
416{
417 struct msgb *msg;
418 struct bssgp_normal_hdr *bgph;
419 uint16_t e_bucket_size, e_leak_rate;
420
421 if ((ms_bucket_size / 100) > 0xffff)
422 return -EINVAL;
423 e_bucket_size = ms_bucket_size / 100;
424
425 if ((bucket_leak_rate * 8 / 100) > 0xffff)
426 return -EINVAL;
427 e_leak_rate = (bucket_leak_rate * 8) / 100;
428
429 msg = bssgp_msgb_alloc();
430 bgph = (struct bssgp_normal_hdr *) msgb_put(msg, sizeof(*bgph));
431 msgb_nsei(msg) = bctx->nsei;
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200432 msgb_bvci(msg) = bctx->bvci;
Harald Weltee92866b2012-09-10 08:56:04 +0200433 bgph->pdu_type = BSSGP_PDUT_FLOW_CONTROL_MS;
434
Maxe29ec852018-01-05 14:30:22 +0100435 bssgp_msgb_tlli_put(msg, tlli);
Harald Weltee92866b2012-09-10 08:56:04 +0200436 msgb_tvlv_put(msg, BSSGP_IE_TAG, sizeof(tag), (uint8_t *)&tag);
437 msgb_tvlv_put(msg, BSSGP_IE_MS_BUCKET_SIZE,
438 sizeof(e_bucket_size), (uint8_t *) &e_bucket_size);
439 msgb_tvlv_put(msg, BSSGP_IE_BUCKET_LEAK_RATE,
440 sizeof(e_leak_rate), (uint8_t *) &e_leak_rate);
441 if (bucket_full_ratio)
442 msgb_tvlv_put(msg, BSSGP_IE_BUCKET_FULL_RATIO,
443 1, bucket_full_ratio);
444
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200445 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Weltee92866b2012-09-10 08:56:04 +0200446}
Harald Welte85fc3142011-11-25 08:58:40 +0100447
Neels Hofmeyr87e45502017-06-20 00:17:59 +0200448/*! RL-UL-UNITDATA.req (Chapter 10.2.2)
Andreas Eversbergb8d18f32012-09-30 16:59:33 +0200449 * \param[in] bctx BVC Context
450 * \param[in] tlli TLLI to identify MS
451 * \param[in] qos_profile Pointer to three octests of QoS profile
452 * \param[in] llc_pdu msgb pointer containing UL Unitdata IE payload
453 */
Harald Welte85fc3142011-11-25 08:58:40 +0100454int bssgp_tx_ul_ud(struct bssgp_bvc_ctx *bctx, uint32_t tlli,
455 const uint8_t *qos_profile, struct msgb *llc_pdu)
456{
457 struct msgb *msg = llc_pdu;
458 uint8_t bssgp_cid[8];
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200459 uint8_t bssgp_align[3] = {0, 0, 0};
Harald Welte85fc3142011-11-25 08:58:40 +0100460 struct bssgp_ud_hdr *budh;
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200461 int align = sizeof(*budh);
Harald Welte85fc3142011-11-25 08:58:40 +0100462
463 /* FIXME: Optional LSA Identifier List, PFI */
464
465 /* Cell Identifier */
466 bssgp_create_cell_id(bssgp_cid, &bctx->ra_id, bctx->cell_id);
Andreas Eversbergf44ed8c2012-09-23 06:05:20 +0200467 align += 2; /* add T+L */
468 align += sizeof(bssgp_cid);
469
470 /* First push alignment IE */
471 align += 2; /* add T+L */
472 align = (4 - align) & 3; /* how many octest are required to align? */
473 msgb_tvlv_push(msg, BSSGP_IE_ALIGNMENT, align, bssgp_align);
474
475 /* Push other IEs */
Harald Welte85fc3142011-11-25 08:58:40 +0100476 msgb_tvlv_push(msg, BSSGP_IE_CELL_ID, sizeof(bssgp_cid), bssgp_cid);
477
478 /* User Data Header */
479 budh = (struct bssgp_ud_hdr *) msgb_push(msg, sizeof(*budh));
Harald Weltebfe62e52017-05-15 12:48:30 +0200480 budh->tlli = osmo_htonl(tlli);
Harald Welte85fc3142011-11-25 08:58:40 +0100481 memcpy(budh->qos_profile, qos_profile, 3);
482 budh->pdu_type = BSSGP_PDUT_UL_UNITDATA;
483
484 /* set NSEI and BVCI in msgb cb */
485 msgb_nsei(msg) = bctx->nsei;
486 msgb_bvci(msg) = bctx->bvci;
487
488 rate_ctr_inc(&bctx->ctrg->ctr[BSSGP_CTR_PKTS_OUT]);
489 rate_ctr_add(&bctx->ctrg->ctr[BSSGP_CTR_BYTES_OUT], msg->len);
490
Alexander Couzens85a8fd32020-07-18 15:57:07 +0200491 return bssgp_ns_send(bssgp_ns_send_data, msg);
Harald Welte85fc3142011-11-25 08:58:40 +0100492}
493
494/* Parse a single GMM-PAGING.req to a given NSEI/NS-BVCI */
Harald Weltede4599c2012-06-17 13:04:02 +0800495int bssgp_rx_paging(struct bssgp_paging_info *pinfo,
496 struct msgb *msg)
Harald Welte85fc3142011-11-25 08:58:40 +0100497{
498 struct bssgp_normal_hdr *bgph =
499 (struct bssgp_normal_hdr *) msgb_bssgph(msg);
500 struct tlv_parsed tp;
501 uint8_t ra[6];
502 int rc, data_len;
503
504 memset(ra, 0, sizeof(ra));
505
506 data_len = msgb_bssgp_len(msg) - sizeof(*bgph);
507 rc = bssgp_tlv_parse(&tp, bgph->data, data_len);
508 if (rc < 0)
509 goto err_mand_ie;
510
511 switch (bgph->pdu_type) {
512 case BSSGP_PDUT_PAGING_PS:
513 pinfo->mode = BSSGP_PAGING_PS;
514 break;
515 case BSSGP_PDUT_PAGING_CS:
516 pinfo->mode = BSSGP_PAGING_CS;
517 break;
518 default:
519 return -EINVAL;
520 }
521
522 /* IMSI */
523 if (!TLVP_PRESENT(&tp, BSSGP_IE_IMSI))
524 goto err_mand_ie;
525 if (!pinfo->imsi)
Jacob Erlbeckc1cb75e2015-06-18 13:21:30 +0200526 pinfo->imsi = talloc_zero_size(pinfo, GSM_IMSI_LENGTH);
Harald Weltea13fb752020-06-16 08:44:42 +0200527 gsm48_mi_to_string(pinfo->imsi, GSM_IMSI_LENGTH,
528 TLVP_VAL(&tp, BSSGP_IE_IMSI),
529 TLVP_LEN(&tp, BSSGP_IE_IMSI));
Harald Welte85fc3142011-11-25 08:58:40 +0100530
531 /* DRX Parameters */
532 if (!TLVP_PRESENT(&tp, BSSGP_IE_DRX_PARAMS))
533 goto err_mand_ie;
Harald Weltebfe62e52017-05-15 12:48:30 +0200534 pinfo->drx_params = tlvp_val16be(&tp, BSSGP_IE_DRX_PARAMS);
Harald Welte85fc3142011-11-25 08:58:40 +0100535
536 /* Scope */
537 if (TLVP_PRESENT(&tp, BSSGP_IE_BSS_AREA_ID)) {
538 pinfo->scope = BSSGP_PAGING_BSS_AREA;
539 } else if (TLVP_PRESENT(&tp, BSSGP_IE_LOCATION_AREA)) {
540 pinfo->scope = BSSGP_PAGING_LOCATION_AREA;
541 memcpy(ra, TLVP_VAL(&tp, BSSGP_IE_LOCATION_AREA),
542 TLVP_LEN(&tp, BSSGP_IE_LOCATION_AREA));
543 gsm48_parse_ra(&pinfo->raid, ra);
544 } else if (TLVP_PRESENT(&tp, BSSGP_IE_ROUTEING_AREA)) {
545 pinfo->scope = BSSGP_PAGING_ROUTEING_AREA;
546 memcpy(ra, TLVP_VAL(&tp, BSSGP_IE_ROUTEING_AREA),
547 TLVP_LEN(&tp, BSSGP_IE_ROUTEING_AREA));
548 gsm48_parse_ra(&pinfo->raid, ra);
549 } else if (TLVP_PRESENT(&tp, BSSGP_IE_BVCI)) {
550 pinfo->scope = BSSGP_PAGING_BVCI;
Harald Weltebfe62e52017-05-15 12:48:30 +0200551 pinfo->bvci = tlvp_val16be(&tp, BSSGP_IE_BVCI);
Harald Welte85fc3142011-11-25 08:58:40 +0100552 } else
553 return -EINVAL;
554
555 /* QoS profile mandatory for PS */
556 if (pinfo->mode == BSSGP_PAGING_PS) {
557 if (!TLVP_PRESENT(&tp, BSSGP_IE_QOS_PROFILE))
558 goto err_cond_ie;
559 if (TLVP_LEN(&tp, BSSGP_IE_QOS_PROFILE) < 3)
560 goto err;
561
562 memcpy(&pinfo->qos, TLVP_VAL(&tp, BSSGP_IE_QOS_PROFILE),
563 3);
564 }
565
566 /* Optional (P-)TMSI */
567 if (TLVP_PRESENT(&tp, BSSGP_IE_TMSI) &&
Harald Welte6176b6e2016-11-11 15:10:33 +0100568 TLVP_LEN(&tp, BSSGP_IE_TMSI) >= 4) {
Harald Welte85fc3142011-11-25 08:58:40 +0100569 if (!pinfo->ptmsi)
570 pinfo->ptmsi = talloc_zero_size(pinfo, sizeof(uint32_t));
Harald Weltebfe62e52017-05-15 12:48:30 +0200571 *(pinfo->ptmsi) = osmo_load32be(TLVP_VAL(&tp, BSSGP_IE_TMSI));
Harald Welte6176b6e2016-11-11 15:10:33 +0100572 }
Harald Welte85fc3142011-11-25 08:58:40 +0100573
574 return 0;
575
576err_mand_ie:
577err_cond_ie:
578err:
579 /* FIXME */
580 return 0;
581}