blob: 7ecaae4db6451ee5aac13ced2580e85ce54467f9 [file] [log] [blame]
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +01001/* gprs_ms.c
2 *
3 * Copyright (C) 2015-2020 by Sysmocom s.f.m.c. GmbH
4 * Author: Jacob Erlbeck <jerlbeck@sysmocom.de>
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +010015 */
16
17
18#include "gprs_ms.h"
19#include "bts.h"
20#include "tbf.h"
21#include "tbf_ul.h"
22#include "gprs_debug.h"
23#include "gprs_codel.h"
24#include "pcu_utils.h"
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +010025#include "nacc_fsm.h"
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +020026#include "tbf_ul_ack_fsm.h"
Pau Espin Pedrol8abe13c2022-10-21 18:49:48 +020027#include "gprs_ms_storage.h"
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +010028
29#include <time.h>
30
31#include <osmocom/core/talloc.h>
32#include <osmocom/core/utils.h>
33#include <osmocom/core/timer.h>
34#include <osmocom/gsm/protocol/gsm_04_08.h>
35#include <osmocom/gsm/gsm48.h>
36#include <osmocom/core/logging.h>
Pau Espin Pedrolbed48cc2021-01-11 17:32:18 +010037#include <osmocom/core/stats.h>
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +010038#include "coding_scheme.h"
39
40#define GPRS_CODEL_SLOW_INTERVAL_MS 4000
41
42extern void *tall_pcu_ctx;
Pau Espin Pedrolbed48cc2021-01-11 17:32:18 +010043static unsigned int next_ms_ctr_group_id;
44
45static const struct rate_ctr_desc ms_ctr_description[] = {
46 [MS_CTR_DL_CTRL_MSG_SCHED] = { "ms:dl_ctrl_msg_sched", "Amount of DL CTRL messages scheduled" },
47};
48
Pau Espin Pedrolf5a251b2021-01-12 20:57:56 +010049static const struct rate_ctr_group_desc ms_ctrg_desc = {
Pau Espin Pedrolbed48cc2021-01-11 17:32:18 +010050 .group_name_prefix = "pcu:ms",
51 .group_description = "MS Statistics",
52 .class_id = OSMO_STATS_CLASS_SUBSCRIBER,
53 .num_ctr = ARRAY_SIZE(ms_ctr_description),
54 .ctr_desc = ms_ctr_description,
55};
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +010056
57static int64_t now_msec()
58{
59 struct timespec ts;
60 osmo_clock_gettime(CLOCK_MONOTONIC, &ts);
61
62 return (int64_t)(ts.tv_sec) * 1000 + ts.tv_nsec / 1000000;
63}
64
65void gprs_default_cb_ms_idle(struct GprsMs *ms)
66{
67 talloc_free(ms);
68}
69
70void gprs_default_cb_ms_active(struct GprsMs *ms)
71{
72 /* do nothing */
73}
74
75static struct gpr_ms_callback gprs_default_cb = {
76 .ms_idle = gprs_default_cb_ms_idle,
77 .ms_active = gprs_default_cb_ms_active,
78};
79
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +010080static void ms_release_timer_cb(void *data)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +010081{
82 struct GprsMs *ms = (struct GprsMs *) data;
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +010083 LOGPMS(ms, DRLCMAC, LOGL_INFO, "Release timer expired\n");
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +010084
85 if (ms->timer.data) {
86 ms->timer.data = NULL;
87 ms_unref(ms);
88 }
89}
90
Pau Espin Pedrol14beef62022-10-26 19:44:07 +020091static void ms_llc_timer_cb(void *_ms)
92{
93 struct GprsMs *ms = _ms;
94 struct gprs_rlcmac_dl_tbf *dl_tbf = ms_dl_tbf(ms);
95
96 if (!dl_tbf)
97 return;
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +020098 if (tbf_state(dl_tbf_as_tbf_const(dl_tbf)) != TBF_ST_FLOW)
Pau Espin Pedrol14beef62022-10-26 19:44:07 +020099 return;
100
Pau Espin Pedrolbd1f01f2022-10-27 15:19:39 +0200101 LOGPTBFDL(dl_tbf, LOGL_DEBUG, "LLC receive timeout, requesting DL ACK\n");
Pau Espin Pedrol14beef62022-10-26 19:44:07 +0200102
Pau Espin Pedrol8fa3e062022-10-28 17:38:52 +0200103 dl_tbf_request_dl_ack(dl_tbf);
Pau Espin Pedrol14beef62022-10-26 19:44:07 +0200104}
105
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100106static int ms_talloc_destructor(struct GprsMs *ms);
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100107struct GprsMs *ms_alloc(struct gprs_rlcmac_bts *bts, uint32_t tlli)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100108{
109 struct GprsMs *ms = talloc_zero(tall_pcu_ctx, struct GprsMs);
Pau Espin Pedrolb4987462022-04-01 17:21:08 +0200110 OSMO_ASSERT(bts);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100111
112 talloc_set_destructor(ms, ms_talloc_destructor);
113
114 ms->bts = bts;
115 ms->cb = gprs_default_cb;
116 ms->tlli = tlli;
117 ms->new_ul_tlli = GSM_RESERVED_TMSI;
118 ms->new_dl_tlli = GSM_RESERVED_TMSI;
119 ms->ta = GSM48_TA_INVALID;
120 ms->current_cs_ul = UNKNOWN;
121 ms->current_cs_dl = UNKNOWN;
122 ms->is_idle = true;
123 INIT_LLIST_HEAD(&ms->list);
124 INIT_LLIST_HEAD(&ms->old_tbfs);
125
126 int codel_interval = LLC_CODEL_USE_DEFAULT;
127
128 LOGP(DRLCMAC, LOGL_INFO, "Creating MS object, TLLI = 0x%08x\n", tlli);
129
130 ms->imsi[0] = '\0';
Pau Espin Pedrolc7802d92022-05-09 16:07:52 +0200131 osmo_timer_setup(&ms->timer, ms_release_timer_cb, NULL);
Pau Espin Pedrol6b1e9512022-04-04 13:45:56 +0200132 llc_queue_init(&ms->llc_queue, ms);
Pau Espin Pedrol14beef62022-10-26 19:44:07 +0200133 memset(&ms->llc_timer, 0, sizeof(ms->llc_timer));
134 osmo_timer_setup(&ms->llc_timer, ms_llc_timer_cb, ms);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100135
136 ms_set_mode(ms, GPRS);
137
Pau Espin Pedrolb4987462022-04-01 17:21:08 +0200138 codel_interval = the_pcu->vty.llc_codel_interval_msec;
Pau Espin Pedrol6b1e9512022-04-04 13:45:56 +0200139 if (codel_interval == LLC_CODEL_USE_DEFAULT)
140 codel_interval = GPRS_CODEL_SLOW_INTERVAL_MS;
141 llc_queue_set_codel_interval(&ms->llc_queue, codel_interval);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100142
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100143 ms->last_cs_not_low = now_msec();
144 ms->app_info_pending = false;
Pau Espin Pedrolbed48cc2021-01-11 17:32:18 +0100145
146 ms->ctrs = rate_ctr_group_alloc(ms, &ms_ctrg_desc, next_ms_ctr_group_id++);
147 if (!ms->ctrs)
148 goto free_ret;
149
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100150 return ms;
Pau Espin Pedrolbed48cc2021-01-11 17:32:18 +0100151free_ret:
152 talloc_free(ms);
153 return NULL;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100154}
155
156static int ms_talloc_destructor(struct GprsMs *ms)
157{
158 struct llist_item *pos, *tmp;
159
Pau Espin Pedrol11f01102021-03-03 20:37:38 +0100160 LOGPMS(ms, DRLCMAC, LOGL_INFO, "Destroying MS object\n");
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100161
162 ms_set_reserved_slots(ms, NULL, 0, 0);
163
Vadim Yanitskiye33c2362022-07-22 03:44:44 +0700164 osmo_timer_del(&ms->timer);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100165
166 if (ms->ul_tbf) {
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200167 tbf_set_ms(ul_tbf_as_tbf(ms->ul_tbf), NULL);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100168 ms->ul_tbf = NULL;
169 }
170
171 if (ms->dl_tbf) {
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200172 tbf_set_ms(dl_tbf_as_tbf(ms->dl_tbf), NULL);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100173 ms->dl_tbf = NULL;
174 }
175
176 llist_for_each_entry_safe(pos, tmp, &ms->old_tbfs, list) {
177 struct gprs_rlcmac_tbf *tbf = (struct gprs_rlcmac_tbf *)pos->entry;
178 tbf_set_ms(tbf, NULL);
179 }
180
181 llc_queue_clear(&ms->llc_queue, ms->bts);
Pau Espin Pedrol14beef62022-10-26 19:44:07 +0200182 osmo_timer_del(&ms->llc_timer);
Pau Espin Pedrolbed48cc2021-01-11 17:32:18 +0100183
184 if (ms->ctrs)
185 rate_ctr_group_free(ms->ctrs);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100186 return 0;
187}
188
189
190void ms_set_callback(struct GprsMs *ms, struct gpr_ms_callback *cb)
191{
192 if (cb)
193 ms->cb = *cb;
194 else
195 ms->cb = gprs_default_cb;
196}
197
198static void ms_update_status(struct GprsMs *ms)
199{
200 if (ms->ref > 0)
201 return;
202
203 if (ms_is_idle(ms) && !ms->is_idle) {
204 ms->is_idle = true;
205 ms->cb.ms_idle(ms);
206 /* this can be deleted by now, do not access it */
207 return;
208 }
209
210 if (!ms_is_idle(ms) && ms->is_idle) {
211 ms->is_idle = false;
212 ms->cb.ms_active(ms);
213 }
214}
215
216struct GprsMs *ms_ref(struct GprsMs *ms)
217{
218 ms->ref += 1;
219 return ms;
220}
221
222void ms_unref(struct GprsMs *ms)
223{
224 OSMO_ASSERT(ms->ref >= 0);
225 ms->ref -= 1;
226 if (ms->ref == 0)
227 ms_update_status(ms);
228}
229
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +0100230static void ms_release_timer_start(struct GprsMs *ms)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100231{
232 if (ms->delay == 0)
233 return;
234
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +0100235 LOGPMS(ms, DRLCMAC, LOGL_DEBUG, "Schedule MS release in %u secs\n", ms->delay);
236
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100237 if (!ms->timer.data)
238 ms->timer.data = ms_ref(ms);
239
240 osmo_timer_schedule(&ms->timer, ms->delay, 0);
241}
242
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +0100243static void ms_release_timer_stop(struct GprsMs *ms)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100244{
245 if (!ms->timer.data)
246 return;
247
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +0100248 LOGPMS(ms, DRLCMAC, LOGL_DEBUG, "Cancel scheduled MS release\n");
249
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100250 osmo_timer_del(&ms->timer);
251 ms->timer.data = NULL;
252 ms_unref(ms);
253}
254
255void ms_set_mode(struct GprsMs *ms, enum mcs_kind mode)
256{
257 ms->mode = mode;
258
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100259 switch (ms->mode) {
260 case GPRS:
261 if (!mcs_is_gprs(ms->current_cs_ul)) {
262 ms->current_cs_ul = mcs_get_gprs_by_num(
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100263 ms->bts->initial_cs_ul);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100264 if (!mcs_is_valid(ms->current_cs_ul))
265 ms->current_cs_ul = CS1;
266 }
267 if (!mcs_is_gprs(ms->current_cs_dl)) {
268 ms->current_cs_dl = mcs_get_gprs_by_num(
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100269 ms->bts->initial_cs_dl);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100270 if (!mcs_is_valid(ms->current_cs_dl))
271 ms->current_cs_dl = CS1;
272 }
273 break;
274
275 case EGPRS_GMSK:
Pau Espin Pedrol7bb8cd62021-01-25 15:08:35 +0100276 if (!mcs_is_edge_gmsk(ms->current_cs_ul)) {
277 ms->current_cs_ul = mcs_get_egprs_by_num(
278 ms->bts->initial_mcs_ul);
279 if (!mcs_is_valid(ms->current_cs_ul))
280 ms->current_cs_ul = MCS1;
281 }
282 if (!mcs_is_edge_gmsk(ms->current_cs_dl)) {
283 ms->current_cs_dl = mcs_get_egprs_by_num(
284 ms->bts->initial_mcs_dl);
285 if (!mcs_is_valid(ms->current_cs_dl))
286 ms->current_cs_dl = MCS1;
287 }
288 break;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100289 case EGPRS:
290 if (!mcs_is_edge(ms->current_cs_ul)) {
291 ms->current_cs_ul = mcs_get_egprs_by_num(
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100292 ms->bts->initial_mcs_ul);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100293 if (!mcs_is_valid(ms->current_cs_ul))
294 ms->current_cs_ul = MCS1;
295 }
296 if (!mcs_is_edge(ms->current_cs_dl)) {
297 ms->current_cs_dl = mcs_get_egprs_by_num(
Pau Espin Pedrol2182e622021-01-14 16:48:38 +0100298 ms->bts->initial_mcs_dl);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100299 if (!mcs_is_valid(ms->current_cs_dl))
300 ms->current_cs_dl = MCS1;
301 }
302 break;
303 }
304}
305
306static void ms_attach_ul_tbf(struct GprsMs *ms, struct gprs_rlcmac_ul_tbf *tbf)
307{
308 if (ms->ul_tbf == tbf)
309 return;
310
Pau Espin Pedrol11f01102021-03-03 20:37:38 +0100311 LOGPMS(ms, DRLCMAC, LOGL_INFO, "Attaching UL TBF: %s\n", tbf_name((struct gprs_rlcmac_tbf *)tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100312
313 ms_ref(ms);
314
315 if (ms->ul_tbf)
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200316 llist_add_tail(tbf_ms_list(ul_tbf_as_tbf(ms->ul_tbf)), &ms->old_tbfs);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100317
318 ms->ul_tbf = tbf;
319
320 if (tbf)
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +0100321 ms_release_timer_stop(ms);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100322
323 ms_unref(ms);
324}
325
326static void ms_attach_dl_tbf(struct GprsMs *ms, struct gprs_rlcmac_dl_tbf *tbf)
327{
328 if (ms->dl_tbf == tbf)
329 return;
330
Pau Espin Pedrol11f01102021-03-03 20:37:38 +0100331 LOGPMS(ms, DRLCMAC, LOGL_INFO, "Attaching DL TBF: %s\n", tbf_name((struct gprs_rlcmac_tbf *)tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100332
333 ms_ref(ms);
334
335 if (ms->dl_tbf)
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200336 llist_add_tail(tbf_ms_list(dl_tbf_as_tbf(ms->dl_tbf)), &ms->old_tbfs);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100337
338 ms->dl_tbf = tbf;
339
340 if (tbf)
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +0100341 ms_release_timer_stop(ms);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100342
343 ms_unref(ms);
344}
345
346void ms_attach_tbf(struct GprsMs *ms, struct gprs_rlcmac_tbf *tbf)
347{
Pau Espin Pedrolb5fece92021-08-23 16:58:04 +0200348 if (tbf_direction(tbf) == GPRS_RLCMAC_DL_TBF)
Pau Espin Pedrolcc30b052022-10-27 15:25:55 +0200349 ms_attach_dl_tbf(ms, tbf_as_dl_tbf(tbf));
Pau Espin Pedrolb5fece92021-08-23 16:58:04 +0200350 else
Pau Espin Pedrolcc30b052022-10-27 15:25:55 +0200351 ms_attach_ul_tbf(ms, tbf_as_ul_tbf(tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100352}
353
354void ms_detach_tbf(struct GprsMs *ms, struct gprs_rlcmac_tbf *tbf)
355{
356 if (tbf == (struct gprs_rlcmac_tbf *)(ms->ul_tbf)) {
357 ms->ul_tbf = NULL;
358 } else if (tbf == (struct gprs_rlcmac_tbf *)(ms->dl_tbf)) {
359 ms->dl_tbf = NULL;
360 } else {
361 bool found = false;
362
363 struct llist_item *pos, *tmp;
364 llist_for_each_entry_safe(pos, tmp, &ms->old_tbfs, list) {
365 struct gprs_rlcmac_tbf *tmp_tbf = (struct gprs_rlcmac_tbf *)pos->entry;
366 if (tmp_tbf == tbf) {
367 llist_del(&pos->list);
368 found = true;
369 break;
370 }
371 }
372
373 /* Protect against recursive calls via set_ms() */
374 if (!found)
375 return;
376 }
377
Pau Espin Pedrol11f01102021-03-03 20:37:38 +0100378 LOGPMS(ms, DRLCMAC, LOGL_INFO, "Detaching TBF: %s\n",
379 tbf_name(tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100380
381 if (tbf_ms(tbf) == ms)
382 tbf_set_ms(tbf, NULL);
383
384 if (!ms->dl_tbf && !ms->ul_tbf) {
385 ms_set_reserved_slots(ms, NULL, 0, 0);
Pau Espin Pedrol9935d0d2022-12-13 18:29:25 +0100386 ms->first_common_ts = NULL;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100387
388 if (ms_tlli(ms) != 0)
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +0100389 ms_release_timer_start(ms);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100390 }
391
392 ms_update_status(ms);
393}
394
395void ms_reset(struct GprsMs *ms)
396{
Pau Espin Pedrol11f01102021-03-03 20:37:38 +0100397 LOGPMS(ms, DRLCMAC, LOGL_INFO, "Clearing MS object\n");
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100398
Pau Espin Pedrol4fe09012021-03-03 17:30:50 +0100399 ms_release_timer_stop(ms);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100400
401 ms->tlli = GSM_RESERVED_TMSI;
402 ms->new_dl_tlli = ms->tlli;
403 ms->new_ul_tlli = ms->tlli;
404 ms->imsi[0] = '\0';
405}
406
Pau Espin Pedrol8abe13c2022-10-21 18:49:48 +0200407/* This function should be called on the MS object of a TBF each time an RLCMAC
408 * block is received for it with TLLI information.
409 * Besides updating the TLLI field on the MS object, it also seeks for other MS
410 * objects in the store and merges them into the current MS object. The MS
411 * duplication happened because we don't learn the TLLI of the created TBF until
412 * a later point. */
413void ms_update_announced_tlli(struct GprsMs *ms, uint32_t tlli)
414{
415 struct GprsMs *old_ms = NULL;
416
417 if (tlli == GSM_RESERVED_TMSI)
418 return;
419
420 /* When the TLLI does not match the ms, check if there is another
421 * MS object that belongs to that TLLI and if yes make sure one of them
422 * gets deleted. */
423 if (!ms_check_tlli(ms, tlli))
424 old_ms = ms_store_get_ms(bts_ms_store(ms->bts), tlli, GSM_RESERVED_TMSI, NULL);
425
426 ms_set_tlli(ms, tlli);
427
428 if (old_ms)
429 ms_merge_and_clear_ms(ms, old_ms);
430 /* old_ms may no longer be available here */
431}
432
Pau Espin Pedrol32416fd2022-10-31 12:55:03 +0100433/* Merge 'old_ms' object into 'ms' object.
434 * 'old_ms' may be freed during the call to this function, don't use the pointer to it afterwards */
435void ms_merge_and_clear_ms(struct GprsMs *ms, struct GprsMs *old_ms)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100436{
Pau Espin Pedrol32416fd2022-10-31 12:55:03 +0100437 char old_ms_name[128];
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100438 OSMO_ASSERT(old_ms != ms);
Pau Espin Pedrol32416fd2022-10-31 12:55:03 +0100439 ms_ref(old_ms);
440
441 ms_name_buf(old_ms, old_ms_name, sizeof(old_ms_name));
442
443 LOGPMS(ms, DRLCMAC, LOGL_INFO, "Merge MS: %s\n", old_ms_name);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100444
445 if (strlen(ms_imsi(ms)) == 0 && strlen(ms_imsi(old_ms)) != 0)
446 osmo_strlcpy(ms->imsi, ms_imsi(old_ms), sizeof(ms->imsi));
447
448 if (!ms_ms_class(ms) && ms_ms_class(old_ms))
449 ms_set_ms_class(ms, ms_ms_class(old_ms));
450
451 if (!ms_egprs_ms_class(ms) && ms_egprs_ms_class(old_ms))
452 ms_set_egprs_ms_class(ms, ms_egprs_ms_class(old_ms));
453
454 llc_queue_move_and_merge(&ms->llc_queue, &old_ms->llc_queue);
455
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100456 /* Clean up the old MS object */
457 /* TODO: Use timer? */
458 if (ms_ul_tbf(old_ms) && !tbf_timers_pending((struct gprs_rlcmac_tbf *)ms_ul_tbf(old_ms), T_MAX))
459 tbf_free((struct gprs_rlcmac_tbf *)ms_ul_tbf(old_ms));
460 if (ms_dl_tbf(old_ms) && !tbf_timers_pending((struct gprs_rlcmac_tbf *)ms_dl_tbf(old_ms), T_MAX))
461 tbf_free((struct gprs_rlcmac_tbf *)ms_dl_tbf(old_ms));
462
Pau Espin Pedrol32416fd2022-10-31 12:55:03 +0100463 ms_reset(old_ms);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100464
465 ms_unref(old_ms);
466}
467
Pau Espin Pedrol57843c52022-11-03 13:35:19 +0100468/* Apply changes to the TLLI directly, used interally by functions below: */
469static void ms_apply_tlli_change(struct GprsMs *ms, uint32_t tlli)
470{
471 ms->tlli = tlli;
472 ms->new_dl_tlli = GSM_RESERVED_TMSI;
473 ms->new_ul_tlli = GSM_RESERVED_TMSI;
474
475 /* Update TBF FSM names: */
476 if (ms->ul_tbf)
477 tbf_update_state_fsm_name(ul_tbf_as_tbf(ms->ul_tbf));
478 if (ms->dl_tbf)
479 tbf_update_state_fsm_name(dl_tbf_as_tbf(ms->dl_tbf));
480}
481
Pau Espin Pedrol0b5997e2022-10-21 14:10:41 +0200482/* Set/update the MS object TLLI based on knowledge gained from the MS side (Uplink direction) */
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100483void ms_set_tlli(struct GprsMs *ms, uint32_t tlli)
484{
485 if (tlli == ms->tlli || tlli == ms->new_ul_tlli)
486 return;
487
488 if (tlli != ms->new_dl_tlli) {
489 LOGP(DRLCMAC, LOGL_INFO,
490 "Modifying MS object, UL TLLI: 0x%08x -> 0x%08x, "
491 "not yet confirmed\n",
492 ms_tlli(ms), tlli);
493 ms->new_ul_tlli = tlli;
494 return;
495 }
496
497 LOGP(DRLCMAC, LOGL_INFO,
498 "Modifying MS object, TLLI: 0x%08x -> 0x%08x, "
499 "already confirmed partly\n",
500 ms->tlli, tlli);
501
Pau Espin Pedrol57843c52022-11-03 13:35:19 +0100502 ms_apply_tlli_change(ms, tlli);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100503}
504
Pau Espin Pedrol0b5997e2022-10-21 14:10:41 +0200505/* Set/update the MS object TLLI based on knowledge gained from the SGSN side (Downlink direction) */
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100506bool ms_confirm_tlli(struct GprsMs *ms, uint32_t tlli)
507{
508 if (tlli == ms->tlli || tlli == ms->new_dl_tlli)
509 return false;
510
511 if (tlli != ms->new_ul_tlli) {
512 /* The MS has not sent a message with the new TLLI, which may
513 * happen according to the spec [TODO: add reference]. */
514
515 LOGP(DRLCMAC, LOGL_INFO,
516 "The MS object cannot fully confirm an unexpected TLLI: 0x%08x, "
517 "partly confirmed\n", tlli);
518 /* Use the network's idea of TLLI as candidate, this does not
519 * change the result value of tlli() */
520 ms->new_dl_tlli = tlli;
521 return false;
522 }
523
524 LOGP(DRLCMAC, LOGL_INFO,
525 "Modifying MS object, TLLI: 0x%08x confirmed\n", tlli);
526
Pau Espin Pedrol57843c52022-11-03 13:35:19 +0100527 ms_apply_tlli_change(ms, tlli);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100528
529 return true;
530}
531
532void ms_set_imsi(struct GprsMs *ms, const char *imsi)
533{
534 if (!imsi) {
535 LOGP(DRLCMAC, LOGL_ERROR, "Expected IMSI!\n");
536 return;
537 }
538
539 if (imsi[0] && strlen(imsi) < 3) {
540 LOGP(DRLCMAC, LOGL_ERROR, "No valid IMSI '%s'!\n",
541 imsi);
542 return;
543 }
544
545 if (strcmp(imsi, ms->imsi) == 0)
546 return;
547
548 LOGP(DRLCMAC, LOGL_INFO,
549 "Modifying MS object, TLLI = 0x%08x, IMSI '%s' -> '%s'\n",
550 ms_tlli(ms), ms->imsi, imsi);
551
552 struct GprsMs *old_ms = bts_ms_by_imsi(ms->bts, imsi);
553 /* Check if we are going to store a different MS object with already
554 existing IMSI. This is probably a bug in code calling this function,
555 since it should take care of this explicitly */
556 if (old_ms) {
557 /* We cannot find ms->ms by IMSI since we know that it has a
558 * different IMSI */
559 OSMO_ASSERT(old_ms != ms);
560
561 LOGPMS(ms, DRLCMAC, LOGL_NOTICE,
562 "IMSI '%s' was already assigned to another "
563 "MS object: TLLI = 0x%08x, that IMSI will be removed\n",
564 imsi, ms_tlli(old_ms));
565
566 ms_merge_and_clear_ms(ms, old_ms);
Pau Espin Pedrolb8ff74b2022-10-31 12:58:46 +0100567 /* old_ms may no longer be available here */
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100568 }
569
Pau Espin Pedrol57843c52022-11-03 13:35:19 +0100570 /* Store the new IMSI: */
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100571 osmo_strlcpy(ms->imsi, imsi, sizeof(ms->imsi));
Pau Espin Pedrol57843c52022-11-03 13:35:19 +0100572
573 /* Update TBF FSM names: */
574 if (ms->ul_tbf)
575 tbf_update_state_fsm_name(ul_tbf_as_tbf(ms->ul_tbf));
576 if (ms->dl_tbf)
577 tbf_update_state_fsm_name(dl_tbf_as_tbf(ms->dl_tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100578}
579
580void ms_set_ta(struct GprsMs *ms, uint8_t ta_)
581{
582 if (ta_ == ms->ta)
583 return;
584
585 if (gsm48_ta_is_valid(ta_)) {
586 LOGP(DRLCMAC, LOGL_INFO,
587 "Modifying MS object, TLLI = 0x%08x, TA %d -> %d\n",
588 ms_tlli(ms), ms->ta, ta_);
589 ms->ta = ta_;
590 } else
591 LOGP(DRLCMAC, LOGL_NOTICE,
592 "MS object, TLLI = 0x%08x, invalid TA %d rejected (old "
593 "value %d kept)\n", ms_tlli(ms), ta_, ms->ta);
594}
595
596void ms_set_ms_class(struct GprsMs *ms, uint8_t ms_class_)
597{
598 if (ms_class_ == ms->ms_class)
599 return;
600
601 LOGP(DRLCMAC, LOGL_INFO,
602 "Modifying MS object, TLLI = 0x%08x, MS class %d -> %d\n",
603 ms_tlli(ms), ms->ms_class, ms_class_);
604
605 ms->ms_class = ms_class_;
606}
607
608void ms_set_egprs_ms_class(struct GprsMs *ms, uint8_t ms_class_)
609{
610 if (ms_class_ == ms->egprs_ms_class)
611 return;
612
613 LOGP(DRLCMAC, LOGL_INFO,
614 "Modifying MS object, TLLI = 0x%08x, EGPRS MS class %d -> %d\n",
615 ms_tlli(ms), ms->egprs_ms_class, ms_class_);
616
617 ms->egprs_ms_class = ms_class_;
618
619 if (!bts_max_mcs_ul(ms->bts) || !bts_max_mcs_dl(ms->bts)) {
620 LOGPMS(ms, DRLCMAC, LOGL_DEBUG,
621 "Avoid enabling EGPRS because use of MCS is disabled: ul=%u dl=%u\n",
622 bts_max_mcs_ul(ms->bts), bts_max_mcs_dl(ms->bts));
623 return;
624 }
625
626 if (mcs_is_edge_gmsk(mcs_get_egprs_by_num(bts_max_mcs_ul(ms->bts))) &&
627 mcs_is_edge_gmsk(mcs_get_egprs_by_num(bts_max_mcs_dl(ms->bts))) &&
628 ms_mode(ms) != EGPRS)
629 {
630 ms_set_mode(ms, EGPRS_GMSK);
631 } else {
632 ms_set_mode(ms, EGPRS);
633 }
634 LOGPMS(ms, DRLCMAC, LOGL_INFO, "Enabled EGPRS, mode %s\n", mode_name(ms_mode(ms)));
635}
636
637void ms_update_error_rate(struct GprsMs *ms, struct gprs_rlcmac_tbf *tbf, int error_rate)
638{
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100639 int64_t now;
640 enum CodingScheme max_cs_dl = ms_max_cs_dl(ms);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100641 OSMO_ASSERT(max_cs_dl);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100642
643 if (error_rate < 0)
644 return;
645
646 now = now_msec();
647
648 /* TODO: Check for TBF direction */
649 /* TODO: Support different CS values for UL and DL */
650
651 ms->nack_rate_dl = error_rate;
652
Pau Espin Pedrole8dcf642021-01-14 13:17:01 +0100653 if (error_rate > the_pcu->vty.cs_adj_upper_limit) {
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100654 if (mcs_chan_code(ms->current_cs_dl) > 0) {
655 mcs_dec_kind(&ms->current_cs_dl, ms_mode(ms));
656 LOGP(DRLCMACDL, LOGL_INFO,
657 "MS (IMSI %s): High error rate %d%%, "
658 "reducing CS level to %s\n",
659 ms_imsi(ms), error_rate, mcs_name(ms->current_cs_dl));
660 ms->last_cs_not_low = now;
661 }
Pau Espin Pedrole8dcf642021-01-14 13:17:01 +0100662 } else if (error_rate < the_pcu->vty.cs_adj_lower_limit) {
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100663 if (ms->current_cs_dl < max_cs_dl) {
664 if (now - ms->last_cs_not_low > 1000) {
665 mcs_inc_kind(&ms->current_cs_dl, ms_mode(ms));
666
667 LOGP(DRLCMACDL, LOGL_INFO,
668 "MS (IMSI %s): Low error rate %d%%, "
669 "increasing DL CS level to %s\n",
670 ms_imsi(ms), error_rate,
671 mcs_name(ms->current_cs_dl));
672 ms->last_cs_not_low = now;
673 } else {
674 LOGP(DRLCMACDL, LOGL_DEBUG,
675 "MS (IMSI %s): Low error rate %d%%, "
676 "ignored (within blocking period)\n",
677 ms_imsi(ms), error_rate);
678 }
679 }
680 } else {
681 LOGP(DRLCMACDL, LOGL_DEBUG,
682 "MS (IMSI %s): Medium error rate %d%%, ignored\n",
683 ms_imsi(ms), error_rate);
684 ms->last_cs_not_low = now;
685 }
686}
687
688enum CodingScheme ms_max_cs_ul(const struct GprsMs *ms)
689{
Pau Espin Pedrol201da4e2021-01-25 15:10:33 +0100690 enum CodingScheme cs;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100691 OSMO_ASSERT(ms->bts != NULL);
692
693 if (mcs_is_gprs(ms->current_cs_ul)) {
694 if (!bts_max_cs_ul(ms->bts)) {
695 return CS4;
696 }
697
698 return mcs_get_gprs_by_num(bts_max_cs_ul(ms->bts));
699 }
700
Pau Espin Pedrol201da4e2021-01-25 15:10:33 +0100701 cs = mcs_get_egprs_by_num(bts_max_mcs_ul(ms->bts));
702 if (ms_mode(ms) == EGPRS_GMSK && cs > MCS4)
703 cs = MCS4;
704 return cs;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100705}
706
707void ms_set_current_cs_dl(struct GprsMs *ms, enum CodingScheme scheme)
708{
709 ms->current_cs_dl = scheme;
710}
711
712enum CodingScheme ms_max_cs_dl(const struct GprsMs *ms)
713{
Pau Espin Pedrol201da4e2021-01-25 15:10:33 +0100714 enum CodingScheme cs;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100715 OSMO_ASSERT(ms->bts != NULL);
716
717 if (mcs_is_gprs(ms->current_cs_dl)) {
718 if (!bts_max_cs_dl(ms->bts)) {
719 return CS4;
720 }
721
722 return mcs_get_gprs_by_num(bts_max_cs_dl(ms->bts));
723 }
724
Pau Espin Pedrol201da4e2021-01-25 15:10:33 +0100725 cs = mcs_get_egprs_by_num(bts_max_mcs_dl(ms->bts));
726 if (ms_mode(ms) == EGPRS_GMSK && cs > MCS4)
727 cs = MCS4;
728 return cs;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100729}
730
731void ms_update_cs_ul(struct GprsMs *ms, const struct pcu_l1_meas *meas)
732{
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100733 enum CodingScheme max_cs_ul = ms_max_cs_ul(ms);
734
735 int old_link_qual;
736 int low;
737 int high;
738 enum CodingScheme new_cs_ul = ms->current_cs_ul;
739 uint8_t current_cs = mcs_chan_code(ms->current_cs_ul);
740
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100741 if (!max_cs_ul) {
742 LOGP(DRLCMACMEAS, LOGL_ERROR,
743 "max_cs_ul cannot be derived (current UL CS: %s)\n",
744 mcs_name(ms->current_cs_ul));
745 return;
746 }
747
748 if (!ms->current_cs_ul) {
749 LOGP(DRLCMACMEAS, LOGL_ERROR,
750 "Unable to update UL (M)CS because it's not set: %s\n",
751 mcs_name(ms->current_cs_ul));
752 return;
753 }
754
755 if (!meas->have_link_qual) {
756 LOGP(DRLCMACMEAS, LOGL_ERROR,
757 "Unable to update UL (M)CS %s because we don't have link quality measurements.\n",
758 mcs_name(ms->current_cs_ul));
759 return;
760 }
761
762 if (mcs_is_gprs(ms->current_cs_ul)) {
763 if (current_cs >= MAX_GPRS_CS)
764 current_cs = MAX_GPRS_CS - 1;
Pau Espin Pedrol54b159a2021-01-14 13:30:04 +0100765 low = the_pcu->vty.cs_lqual_ranges[current_cs].low;
766 high = the_pcu->vty.cs_lqual_ranges[current_cs].high;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100767 } else if (mcs_is_edge(ms->current_cs_ul)) {
768 if (current_cs >= MAX_EDGE_MCS)
769 current_cs = MAX_EDGE_MCS - 1;
Pau Espin Pedrol54b159a2021-01-14 13:30:04 +0100770 low = the_pcu->vty.mcs_lqual_ranges[current_cs].low;
771 high = the_pcu->vty.mcs_lqual_ranges[current_cs].high;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100772 } else {
773 LOGP(DRLCMACMEAS, LOGL_ERROR,
774 "Unable to update UL (M)CS because it's neither GPRS nor EDGE: %s\n",
775 mcs_name(ms->current_cs_ul));
776 return;
777 }
778
779 /* To avoid rapid changes of the coding scheme, we also take
780 * the old link quality value into account (if present). */
781 if (ms->l1_meas.have_link_qual)
782 old_link_qual = ms->l1_meas.link_qual;
783 else
784 old_link_qual = meas->link_qual;
785
786 if (meas->link_qual < low && old_link_qual < low)
787 mcs_dec_kind(&new_cs_ul, ms_mode(ms));
788 else if (meas->link_qual > high && old_link_qual > high &&
789 ms->current_cs_ul < max_cs_ul)
790 mcs_inc_kind(&new_cs_ul, ms_mode(ms));
791
792 if (ms->current_cs_ul != new_cs_ul) {
793 LOGPMS(ms, DRLCMACMEAS, LOGL_INFO,
794 "Link quality %ddB (old %ddB) left window [%d, %d], "
795 "modifying uplink CS level: %s -> %s\n",
796 meas->link_qual, old_link_qual,
797 low, high,
798 mcs_name(ms->current_cs_ul), mcs_name(new_cs_ul));
799
800 ms->current_cs_ul = new_cs_ul;
801 }
802}
803
804void ms_update_l1_meas(struct GprsMs *ms, const struct pcu_l1_meas *meas)
805{
806 unsigned i;
807
808 ms_update_cs_ul(ms, meas);
809
810 if (meas->have_rssi)
811 pcu_l1_meas_set_rssi(&ms->l1_meas, meas->rssi);
812 if (meas->have_bto)
813 pcu_l1_meas_set_bto(&ms->l1_meas, meas->bto);
814 if (meas->have_ber)
815 pcu_l1_meas_set_ber(&ms->l1_meas, meas->ber);
816 if (meas->have_link_qual)
817 pcu_l1_meas_set_link_qual(&ms->l1_meas, meas->link_qual);
818
819 if (meas->have_ms_rx_qual)
820 pcu_l1_meas_set_ms_rx_qual(&ms->l1_meas, meas->ms_rx_qual);
821 if (meas->have_ms_c_value)
822 pcu_l1_meas_set_ms_c_value(&ms->l1_meas, meas->ms_c_value);
823 if (meas->have_ms_sign_var)
824 pcu_l1_meas_set_ms_sign_var(&ms->l1_meas, meas->ms_sign_var);
825
826 if (meas->have_ms_i_level) {
827 for (i = 0; i < ARRAY_SIZE(meas->ts); ++i) {
828 if (meas->ts[i].have_ms_i_level)
829 pcu_l1_meas_set_ms_i_level(&ms->l1_meas, i, meas->ts[i].ms_i_level);
830 else
831 ms->l1_meas.ts[i].have_ms_i_level = 0;
832 }
833 }
834}
835
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100836/* req_mcs_kind acts as a set filter, where EGPRS means any and GPRS is the most restrictive */
837enum CodingScheme ms_current_cs_dl(const struct GprsMs *ms, enum mcs_kind req_mcs_kind)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100838{
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100839 enum CodingScheme orig_cs = ms->current_cs_dl;
840 struct gprs_rlcmac_bts *bts = ms->bts;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100841 size_t unencoded_octets;
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100842 enum CodingScheme cs;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100843
Pau Espin Pedrolfc464932021-01-25 12:05:32 +0100844 /* It could be that a TBF requests a GPRS CS despite the MS currently
845 being upgraded to EGPRS (hence reporting MCS). That could happen
846 because the TBF was created early in the process where we didn't have
847 yet enough information about the MS, and only AFTER it was created we
848 upgraded the MS to be EGPRS capable.
849 As a result, when the MS is queried for the target CS here, we could be
850 returning an MCS despite the current TBF being established as GPRS,
851 but we rather stick to the TBF type we assigned to the MS rather than
852 magically sending EGPRS data blocks to a GPRS TBF.
853 It could also be that the caller requests specific MCS kind
854 explicitly too due to scheduling restrictions (GPRS+EGPRS multiplexing). */
855 if (req_mcs_kind == EGPRS_GMSK && mcs_is_edge(orig_cs) && orig_cs > MCS4) {
856 cs = bts_cs_dl_is_supported(bts, MCS4) ? MCS4 :
857 bts_cs_dl_is_supported(bts, MCS3) ? MCS3 :
858 bts_cs_dl_is_supported(bts, MCS2) ? MCS2 :
859 MCS1;
860 } else if (req_mcs_kind == GPRS && mcs_is_edge(orig_cs)) { /* GPRS */
861 int i;
862 cs = orig_cs > MCS4 ? MCS4 : orig_cs;
863 cs -= (MCS1 - CS1); /* MCSx -> CSx */
864 /* Find suitable CS starting from equivalent MCS which is supported by BTS: */
865 for (i = mcs_chan_code(cs); !bts_cs_dl_is_supported(bts, CS1 + i); i--);
866 OSMO_ASSERT(i >= 0 && i <= 3); /* CS1 is always supported */
867 cs = CS1 + i;
868 } else {
869 cs = orig_cs;
870 }
871
872 if (orig_cs != cs)
873 LOGPMS(ms, DRLCMACDL, LOGL_INFO, "MS (mode=%s) suggests transmitting "
874 "DL %s, downgrade to %s in order to match TBF & scheduler requirements\n",
875 mode_name(ms_mode(ms)), mcs_name(orig_cs), mcs_name(cs));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100876
877 unencoded_octets = llc_queue_octets(&ms->llc_queue);
878
879 /* If the DL TBF is active, add number of unencoded chunk octets */
880 if (ms->dl_tbf)
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200881 unencoded_octets += llc_chunk_size(tbf_llc(dl_tbf_as_tbf(ms->dl_tbf)));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100882
883 /* There are many unencoded octets, don't reduce */
Pau Espin Pedrolad79b852021-01-14 13:20:55 +0100884 if (unencoded_octets >= the_pcu->vty.cs_downgrade_threshold)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100885 return cs;
886
887 /* RF conditions are good, don't reduce */
Pau Espin Pedrole8dcf642021-01-14 13:17:01 +0100888 if (ms->nack_rate_dl < the_pcu->vty.cs_adj_lower_limit)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100889 return cs;
890
891 /* The throughput would probably be better if the CS level was reduced */
892 mcs_dec_kind(&cs, ms_mode(ms));
893
894 /* CS-2 doesn't gain throughput with small packets, further reduce to CS-1 */
895 if (cs == CS2)
896 mcs_dec_kind(&cs, ms_mode(ms));
897
898 return cs;
899}
900
Pau Espin Pedrol9935d0d2022-12-13 18:29:25 +0100901struct gprs_rlcmac_pdch *ms_first_common_ts(const struct GprsMs *ms)
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100902{
Pau Espin Pedrol345d9ad2022-12-12 19:22:44 +0100903 return ms->first_common_ts;
904}
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100905
Pau Espin Pedrol9935d0d2022-12-13 18:29:25 +0100906void ms_set_first_common_ts(struct GprsMs *ms, struct gprs_rlcmac_pdch *pdch)
Pau Espin Pedrol345d9ad2022-12-12 19:22:44 +0100907{
Pau Espin Pedrol9935d0d2022-12-13 18:29:25 +0100908 OSMO_ASSERT(pdch);
909 ms->first_common_ts = pdch;
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100910}
911
912uint8_t ms_dl_slots(const struct GprsMs *ms)
913{
914 uint8_t slots = 0;
915
916 if (ms->dl_tbf)
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200917 slots |= tbf_dl_slots(dl_tbf_as_tbf(ms->dl_tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100918
919 if (ms->ul_tbf)
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200920 slots |= tbf_dl_slots(ul_tbf_as_tbf(ms->ul_tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100921
922 return slots;
923}
924
925uint8_t ms_ul_slots(const struct GprsMs *ms)
926{
927 uint8_t slots = 0;
928
929 if (ms->dl_tbf)
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200930 slots |= tbf_ul_slots(dl_tbf_as_tbf(ms->dl_tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100931
932 if (ms->ul_tbf)
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200933 slots |= tbf_ul_slots(ul_tbf_as_tbf(ms->ul_tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100934
935 return slots;
936}
937
938uint8_t ms_current_pacch_slots(const struct GprsMs *ms)
939{
940 uint8_t slots = 0;
941
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200942 bool is_dl_active = ms->dl_tbf && tbf_is_tfi_assigned(dl_tbf_as_tbf(ms->dl_tbf));
943 bool is_ul_active = ms->ul_tbf && tbf_is_tfi_assigned(ul_tbf_as_tbf(ms->ul_tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100944
945 if (!is_dl_active && !is_ul_active)
946 return 0;
947
948 /* see TS 44.060, 8.1.1.2.2 */
949 if (is_dl_active && !is_ul_active)
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200950 slots = tbf_dl_slots(dl_tbf_as_tbf(ms->dl_tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100951 else if (!is_dl_active && is_ul_active)
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200952 slots = tbf_ul_slots(ul_tbf_as_tbf(ms->ul_tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100953 else
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200954 slots = tbf_ul_slots(ul_tbf_as_tbf(ms->ul_tbf)) &
955 tbf_dl_slots(dl_tbf_as_tbf(ms->dl_tbf));
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100956
957 /* Assume a multislot class 1 device */
958 /* TODO: For class 2 devices, this could be removed */
959 slots = pcu_lsb(slots);
960
961 return slots;
962}
963
964void ms_set_reserved_slots(struct GprsMs *ms, struct gprs_rlcmac_trx *trx,
965 uint8_t ul_slots, uint8_t dl_slots)
966{
967 if (ms->current_trx) {
968 bts_trx_unreserve_slots(ms->current_trx, GPRS_RLCMAC_DL_TBF,
969 ms->reserved_dl_slots);
970 bts_trx_unreserve_slots(ms->current_trx, GPRS_RLCMAC_UL_TBF,
971 ms->reserved_ul_slots);
972 ms->reserved_dl_slots = 0;
973 ms->reserved_ul_slots = 0;
974 }
975 ms->current_trx = trx;
976 if (trx) {
977 ms->reserved_dl_slots = dl_slots;
978 ms->reserved_ul_slots = ul_slots;
979 bts_trx_reserve_slots(ms->current_trx, GPRS_RLCMAC_DL_TBF,
980 ms->reserved_dl_slots);
981 bts_trx_reserve_slots(ms->current_trx, GPRS_RLCMAC_UL_TBF,
982 ms->reserved_ul_slots);
983 }
984}
985
986struct gprs_rlcmac_tbf *ms_tbf(const struct GprsMs *ms, enum gprs_rlcmac_tbf_direction dir)
987{
988 switch (dir) {
Pau Espin Pedrol1e16e1d2022-10-27 15:40:20 +0200989 case GPRS_RLCMAC_DL_TBF: return dl_tbf_as_tbf(ms->dl_tbf);
990 case GPRS_RLCMAC_UL_TBF: return ul_tbf_as_tbf(ms->ul_tbf);
Pau Espin Pedrolda971ee2020-12-16 15:59:45 +0100991 }
992
993 return NULL;
994}
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +0100995
Pau Espin Pedrol3547d642022-10-21 15:00:08 +0200996const char *ms_name(const struct GprsMs *ms)
997{
998 static char _ms_name_buf[128];
999 return ms_name_buf(ms, _ms_name_buf, sizeof(_ms_name_buf));
1000}
1001
1002char *ms_name_buf(const struct GprsMs *ms, char *buf, unsigned int buf_size)
1003{
Pau Espin Pedrol94f82582022-11-03 14:16:17 +01001004 struct osmo_strbuf sb = { .buf = buf, .len = buf_size };
1005 uint32_t tlli = ms_tlli(ms);
1006
1007 OSMO_STRBUF_PRINTF(sb, "MS(");
1008 if (ms_imsi_is_valid(ms))
1009 OSMO_STRBUF_PRINTF(sb, "IMSI-%s:", ms_imsi(ms));
1010 if (tlli != GSM_RESERVED_TMSI)
1011 OSMO_STRBUF_PRINTF(sb, "TLLI-0x%08x:", tlli);
1012 OSMO_STRBUF_PRINTF(sb, "TA-%" PRIu8 ":MSCLS-%" PRIu8 "-%" PRIu8,
1013 ms_ta(ms), ms_ms_class(ms), ms_egprs_ms_class(ms));
1014 if (ms->ul_tbf)
1015 OSMO_STRBUF_PRINTF(sb, ":UL");
1016 if (ms->dl_tbf)
1017 OSMO_STRBUF_PRINTF(sb, ":DL");
1018
1019 OSMO_STRBUF_PRINTF(sb, ")");
Pau Espin Pedrol3547d642022-10-21 15:00:08 +02001020 return buf;
1021}
1022
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +01001023int ms_nacc_start(struct GprsMs *ms, Packet_Cell_Change_Notification_t *notif)
1024{
1025 if (!ms->nacc)
1026 ms->nacc = nacc_fsm_alloc(ms);
1027 if (!ms->nacc)
1028 return -EINVAL;
1029 return osmo_fsm_inst_dispatch(ms->nacc->fi, NACC_EV_RX_CELL_CHG_NOTIFICATION, notif);
1030}
1031
1032bool ms_nacc_rts(const struct GprsMs *ms)
1033{
1034 if (!ms->nacc)
1035 return false;
1036 if (ms->nacc->fi->state == NACC_ST_TX_NEIGHBOUR_DATA ||
1037 ms->nacc->fi->state == NACC_ST_TX_CELL_CHG_CONTINUE)
1038 return true;
1039 return false;
1040}
1041
Pau Espin Pedrol5ba3ef92022-12-12 18:02:25 +01001042struct msgb *ms_nacc_create_rlcmac_msg(struct GprsMs *ms, struct gprs_rlcmac_tbf *tbf,
1043 const struct gprs_rlcmac_pdch *pdch, uint32_t fn)
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +01001044{
1045 int rc;
1046 struct nacc_ev_create_rlcmac_msg_ctx data_ctx;
1047
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +01001048 data_ctx = (struct nacc_ev_create_rlcmac_msg_ctx) {
1049 .tbf = tbf,
Pau Espin Pedrol5ba3ef92022-12-12 18:02:25 +01001050 .pdch = pdch,
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +01001051 .fn = fn,
Pau Espin Pedrol952cb3d2021-02-01 14:52:48 +01001052 .msg = NULL,
1053 };
Pau Espin Pedrolc0a250d2021-01-21 18:46:13 +01001054
1055 rc = osmo_fsm_inst_dispatch(ms->nacc->fi, NACC_EV_CREATE_RLCMAC_MSG, &data_ctx);
1056 if (rc != 0 || !data_ctx.msg)
1057 return NULL;
1058 return data_ctx.msg;
1059}
Pau Espin Pedrol14beef62022-10-26 19:44:07 +02001060
1061static void ms_start_llc_timer(struct GprsMs *ms)
1062{
1063 if (the_pcu->vty.llc_idle_ack_csec > 0) {
1064 struct timespec tv;
1065 csecs_to_timespec(the_pcu->vty.llc_idle_ack_csec, &tv);
1066 osmo_timer_schedule(&ms->llc_timer, tv.tv_sec, tv.tv_nsec / 1000);
1067 }
1068}
1069
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001070/* Can we get to send a DL TBF ass to the MS? */
1071static bool ms_is_reachable_for_dl_ass(const struct GprsMs *ms)
1072{
1073 struct gprs_rlcmac_ul_tbf *ul_tbf = ms_ul_tbf(ms);
1074
1075 /* This function assumes it is called when no DL TBF is present */
1076 OSMO_ASSERT(!ms_dl_tbf(ms));
1077
1078 /* 3GPP TS 44.060 sec 7.1.3.1 Initiation of the Packet resource request procedure:
1079 * "Furthermore, the mobile station shall not respond to PACKET DOWNLINK ASSIGNMENT
1080 * or MULTIPLE TBF DOWNLINK ASSIGNMENT messages before contention resolution is
1081 * completed on the mobile station side." */
1082 /* The possible uplink TBF is used to trigger downlink assignment:
1083 * - If there is no uplink TBF the MS is potentially in packet idle mode
1084 * and hence assignment will be done over CCCH (PCH)
1085 * - If there's an uplink TBF but it is finished (waiting for last PKT
1086 * CTRL ACK after sending last Pkt UL ACK/NACK with FINAL_ACK=1, then we
1087 * have no ways to contact the MS right now. Assignment will be delayed
1088 * until PKT CTRL ACK is received and the TBF is released at the MS side
1089 * (then assignment goes through PCH).
1090 */
1091 if (!ul_tbf)
1092 return true;
1093 if (ul_tbf_contention_resolution_done(ul_tbf) &&
1094 !tbf_ul_ack_waiting_cnf_final_ack(ul_tbf))
1095 return true;
1096
1097 return false;
1098
1099}
1100
Pau Espin Pedrol94386132022-10-28 19:50:09 +02001101/* Alloc a UL TBF to be assigned over PACCH. Called when an MS requests to
1102 * create a new UL TBF during the end of life of a previous UL TBF (or an SBA).
1103 * In summary, this TBF is allocated as a consequence of receiving a "Pkt
1104 * Resource Req" or "Pkt Ctrl Ack" from the MS.
1105 * See TS 44.060 9.3.2.4.2 "Non-extended uplink TBF mode".
1106 */
1107struct gprs_rlcmac_ul_tbf *ms_new_ul_tbf_assigned_pacch(struct GprsMs *ms, int8_t use_trx)
1108{
1109 const bool single_slot = false;
1110 struct gprs_rlcmac_ul_tbf *ul_tbf;
1111
Pau Espin Pedrolbda7bb72022-10-31 14:33:09 +01001112 ul_tbf = ul_tbf_alloc(ms->bts, ms, use_trx, single_slot);
Pau Espin Pedrol94386132022-10-28 19:50:09 +02001113 if (!ul_tbf) {
1114 LOGPMS(ms, DTBF, LOGL_NOTICE, "No PDCH resource\n");
1115 /* Caller will most probably send a Imm Ass Reject after return */
1116 return NULL;
1117 }
1118 osmo_fsm_inst_dispatch(tbf_state_fi(ul_tbf_as_tbf(ul_tbf)), TBF_EV_ASSIGN_ADD_PACCH, NULL);
1119 /* Contention resolution is considered to be done since TLLI is known in MS */
1120 return ul_tbf;
1121}
1122
1123/* Alloc a UL TBF to be assigned over AGCH. Used by request of a "One phase
1124 * packet access", where MS requested only 1 PDCH TS (TS 44.018 Table 9.1.8.1). */
1125struct gprs_rlcmac_ul_tbf *ms_new_ul_tbf_assigned_agch(struct GprsMs *ms)
1126{
1127 const int8_t trx_no = -1;
1128 const bool single_slot = true;
1129 struct gprs_rlcmac_ul_tbf *ul_tbf;
1130
Pau Espin Pedrolbda7bb72022-10-31 14:33:09 +01001131 ul_tbf = ul_tbf_alloc(ms->bts, ms, trx_no, single_slot);
Pau Espin Pedrol94386132022-10-28 19:50:09 +02001132 if (!ul_tbf) {
1133 LOGP(DTBF, LOGL_NOTICE, "No PDCH resource for Uplink TBF\n");
1134 /* Caller will most probably send a Imm Ass Reject after return */
1135 return NULL;
1136 }
1137 osmo_fsm_inst_dispatch(tbf_state_fi(ul_tbf_as_tbf(ul_tbf)), TBF_EV_ASSIGN_ADD_CCCH, NULL);
1138 return ul_tbf;
1139}
1140
Pau Espin Pedrola621d592022-12-13 17:35:04 +01001141/* Create a temporary dummy TBF to Tx a ImmAssReject if allocating a new one during
1142 * packet resource Request failed. This is similar as ul_tbf_alloc() but without
1143 * calling tbf->setup() (in charge of TFI/USF allocation), and reusing resources
1144 * from Packet Resource Request we received. See TS 44.060 sec 7.1.3.2.1 */
1145struct gprs_rlcmac_ul_tbf *ms_new_ul_tbf_rejected_pacch(struct GprsMs *ms, struct gprs_rlcmac_pdch *pdch)
1146{
1147 struct gprs_rlcmac_ul_tbf *ul_tbf;
1148 ul_tbf = ul_tbf_alloc_rejected(ms->bts, ms, pdch);
1149 if (!ul_tbf)
1150 return NULL;
1151 osmo_fsm_inst_dispatch(tbf_state_fi(ul_tbf_as_tbf(ul_tbf)), TBF_EV_ASSIGN_ADD_PACCH, NULL);
1152 osmo_fsm_inst_dispatch(tbf_ul_ass_fi(ul_tbf_as_tbf(ul_tbf)), TBF_UL_ASS_EV_SCHED_ASS_REJ, NULL);
1153
1154 return ul_tbf;
1155}
1156
Pau Espin Pedrol091642a2022-10-28 18:01:31 +02001157/* A new DL-TBF is allocated and assigned through PACCH using "tbf".
1158 * "tbf" may be either a UL-TBF or a DL-TBF.
1159 * Note: This should be called only when MS is reachable, see ms_is_reachable_for_dl_ass().
1160 */
1161int ms_new_dl_tbf_assigned_on_pacch(struct GprsMs *ms, struct gprs_rlcmac_tbf *tbf)
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001162{
Pau Espin Pedrol091642a2022-10-28 18:01:31 +02001163 OSMO_ASSERT(tbf);
1164 const int8_t trx_no = tbf_get_trx(tbf)->trx_no;
1165 const bool single_slot = false;
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001166 struct gprs_rlcmac_dl_tbf *dl_tbf;
1167
Pau Espin Pedrol091642a2022-10-28 18:01:31 +02001168 dl_tbf = dl_tbf_alloc(ms->bts, ms, trx_no, single_slot);
1169 if (!dl_tbf) {
1170 LOGPMS(ms, DTBF, LOGL_NOTICE, "No PDCH resource\n");
1171 return -EBUSY;
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001172 }
1173
Pau Espin Pedrol091642a2022-10-28 18:01:31 +02001174 LOGPTBFDL(dl_tbf, LOGL_DEBUG, "[DOWNLINK] START (PACCH)\n");
1175 dl_tbf_trigger_ass_on_pacch(dl_tbf, tbf);
1176 return 0;
1177}
1178
1179/* A new DL-TBF is allocated and assigned through PCH.
1180 * Note: This should be called only when MS is reachable, see ms_is_reachable_for_dl_ass().
1181 */
1182int ms_new_dl_tbf_assigned_on_pch(struct GprsMs *ms)
1183{
1184 const int8_t trx_no = -1;
1185 const bool single_slot = true;
1186 struct gprs_rlcmac_dl_tbf *dl_tbf;
1187
1188 dl_tbf = dl_tbf_alloc(ms->bts, ms, trx_no, single_slot);
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001189 if (!dl_tbf) {
1190 LOGPMS(ms, DTBF, LOGL_NOTICE, "No PDCH resource\n");
1191 return -EBUSY;
1192 }
1193
Pau Espin Pedrol091642a2022-10-28 18:01:31 +02001194 LOGPTBFDL(dl_tbf, LOGL_DEBUG, "[DOWNLINK] START (PCH)\n");
1195 dl_tbf_trigger_ass_on_pch(dl_tbf);
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001196 return 0;
1197}
1198
Pau Espin Pedrol14beef62022-10-26 19:44:07 +02001199int ms_append_llc_dl_data(struct GprsMs *ms, uint16_t pdu_delay_csec, const uint8_t *data, uint16_t len)
1200{
1201 struct timespec expire_time;
1202 struct gprs_rlcmac_dl_tbf *dl_tbf;
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001203 int rc = 0;
Pau Espin Pedrol14beef62022-10-26 19:44:07 +02001204
1205 LOGPMS(ms, DTBFDL, LOGL_DEBUG, "appending %u bytes to DL LLC queue\n", len);
1206
1207 struct msgb *llc_msg = msgb_alloc(len, "llc_pdu_queue");
1208 if (!llc_msg)
1209 return -ENOMEM;
1210
1211 llc_queue_calc_pdu_lifetime(ms->bts, pdu_delay_csec, &expire_time);
1212 memcpy(msgb_put(llc_msg, len), data, len);
1213 llc_queue_enqueue(ms_llc_queue(ms), llc_msg, &expire_time);
1214 ms_start_llc_timer(ms);
1215
1216 dl_tbf = ms_dl_tbf(ms);
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001217 if (dl_tbf) {
1218 if (tbf_state(dl_tbf_as_tbf_const(dl_tbf)) == TBF_ST_WAIT_RELEASE) {
1219 LOGPTBFDL(dl_tbf, LOGL_DEBUG, "in WAIT RELEASE state (T3193), so reuse TBF\n");
Pau Espin Pedrol091642a2022-10-28 18:01:31 +02001220 rc = ms_new_dl_tbf_assigned_on_pacch(ms, dl_tbf_as_tbf(dl_tbf));
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001221 }
1222 } else {
1223 /* Check if we can create a DL TBF to start sending the enqueued
1224 * data. Otherwise it will be triggered later when it is reachable
1225 * again. */
Pau Espin Pedrol091642a2022-10-28 18:01:31 +02001226 if (ms_is_reachable_for_dl_ass(ms)) {
1227 if (ms_ul_tbf(ms))
1228 rc = ms_new_dl_tbf_assigned_on_pacch(ms, ul_tbf_as_tbf(ms_ul_tbf(ms)));
1229 else
1230 rc = ms_new_dl_tbf_assigned_on_pch(ms);
1231 }
Pau Espin Pedrol14beef62022-10-26 19:44:07 +02001232 }
Pau Espin Pedrol22b26d82022-10-26 15:44:14 +02001233 return rc;
Pau Espin Pedrol14beef62022-10-26 19:44:07 +02001234}