blob: 75f75e17d6b45625d160547112e0881633a88d99 [file] [log] [blame]
Jacob Erlbecke04e0b02015-05-06 18:30:48 +02001/* gprs_ms.cpp
2 *
3 * Copyright (C) 2015 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.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
21
22#include "gprs_ms.h"
Max1187a772018-01-26 13:31:42 +010023#include <gprs_coding_scheme.h>
Jacob Erlbecka700dd92015-06-02 16:00:41 +020024#include "bts.h"
Jacob Erlbecke04e0b02015-05-06 18:30:48 +020025#include "tbf.h"
26#include "gprs_debug.h"
Jacob Erlbeckd4ad7312015-07-17 16:39:09 +020027#include "gprs_codel.h"
Jacob Erlbeck7c72aca2016-01-22 17:06:14 +010028#include "pcu_utils.h"
Jacob Erlbecke04e0b02015-05-06 18:30:48 +020029
Jacob Erlbeck8158ea72015-06-04 17:46:33 +020030#include <time.h>
31
Jacob Erlbecke04e0b02015-05-06 18:30:48 +020032extern "C" {
33 #include <osmocom/core/talloc.h>
34 #include <osmocom/core/utils.h>
Max9bbe1602016-07-18 12:50:18 +020035 #include <osmocom/gsm/protocol/gsm_04_08.h>
Max1187a772018-01-26 13:31:42 +010036 #include <osmocom/core/logging.h>
Max136ebcc2019-03-05 14:59:03 +010037 #include "coding_scheme.h"
Jacob Erlbecke04e0b02015-05-06 18:30:48 +020038}
39
Jacob Erlbeck1c3b8992015-08-14 16:01:36 +020040#define GPRS_CODEL_SLOW_INTERVAL_MS 4000
Jacob Erlbeckd4ad7312015-07-17 16:39:09 +020041
Jacob Erlbecke04e0b02015-05-06 18:30:48 +020042extern void *tall_pcu_ctx;
43
Jacob Erlbeck8158ea72015-06-04 17:46:33 +020044static int64_t now_msec()
45{
46 struct timespec ts;
47 clock_gettime(CLOCK_MONOTONIC, &ts);
48
49 return int64_t(ts.tv_sec) * 1000 + ts.tv_nsec / 1000000;
50}
51
Jacob Erlbecke04e0b02015-05-06 18:30:48 +020052struct GprsMsDefaultCallback: public GprsMs::Callback {
53 virtual void ms_idle(class GprsMs *ms) {
54 delete ms;
55 }
56 virtual void ms_active(class GprsMs *) {}
57};
58
59static GprsMsDefaultCallback gprs_default_cb;
60
Jacob Erlbeckd9e10242015-05-28 15:43:53 +020061GprsMs::Guard::Guard(GprsMs *ms) :
62 m_ms(ms ? ms->ref() : NULL)
Jacob Erlbecke04e0b02015-05-06 18:30:48 +020063{
Jacob Erlbecke04e0b02015-05-06 18:30:48 +020064}
65
66GprsMs::Guard::~Guard()
67{
68 if (m_ms)
69 m_ms->unref();
70}
71
Jacob Erlbeckb2439bb2015-07-13 14:23:32 +020072bool GprsMs::Guard::is_idle() const
73{
74 if (!m_ms)
75 return true;
76
77 return !m_ms->m_ul_tbf && !m_ms->m_dl_tbf && m_ms->m_ref == 1;
78}
79
Jacob Erlbeckd9e10242015-05-28 15:43:53 +020080void GprsMs::timeout(void *priv_)
81{
82 GprsMs *ms = static_cast<GprsMs *>(priv_);
83
84 LOGP(DRLCMAC, LOGL_INFO, "Timeout for MS object, TLLI = 0x%08x\n",
85 ms->tlli());
86
87 if (ms->m_timer.data) {
88 ms->m_timer.data = NULL;
89 ms->unref();
90 }
91}
92
Jacob Erlbeck17214bb2015-06-02 14:06:12 +020093GprsMs::GprsMs(BTS *bts, uint32_t tlli) :
94 m_bts(bts),
Jacob Erlbecke04e0b02015-05-06 18:30:48 +020095 m_cb(&gprs_default_cb),
96 m_ul_tbf(NULL),
97 m_dl_tbf(NULL),
98 m_tlli(tlli),
Jacob Erlbeck93990462015-05-15 15:50:43 +020099 m_new_ul_tlli(0),
100 m_new_dl_tlli(0),
Max9bbe1602016-07-18 12:50:18 +0200101 m_ta(GSM48_TA_INVALID),
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200102 m_ms_class(0),
Jacob Erlbeckc3c58042015-09-28 17:55:32 +0200103 m_egprs_ms_class(0),
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200104 m_is_idle(true),
Jacob Erlbeck53670862015-05-12 17:54:33 +0200105 m_ref(0),
Jacob Erlbeck25db7c62015-06-11 12:59:01 +0200106 m_list(this),
Jacob Erlbeck04a10862015-06-12 16:01:56 +0200107 m_delay(0),
Jacob Erlbeck23f93a12015-06-30 08:52:54 +0200108 m_nack_rate_dl(0),
109 m_reserved_dl_slots(0),
110 m_reserved_ul_slots(0),
Jacob Erlbeckd4ad7312015-07-17 16:39:09 +0200111 m_current_trx(NULL),
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100112 m_codel_state(NULL),
Maxa4de02d2019-03-13 16:35:09 +0100113 m_mode(GPRS),
sivasankarida7250a2016-12-16 12:57:18 +0530114 m_dl_ctrl_msg(0)
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200115{
Jacob Erlbeckd4ad7312015-07-17 16:39:09 +0200116 int codel_interval = LLC_CODEL_USE_DEFAULT;
117
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200118 LOGP(DRLCMAC, LOGL_INFO, "Creating MS object, TLLI = 0x%08x\n", tlli);
Jacob Erlbeckb0e5eaf2015-05-21 11:07:16 +0200119
120 m_imsi[0] = 0;
Jacob Erlbeckd9e10242015-05-28 15:43:53 +0200121 memset(&m_timer, 0, sizeof(m_timer));
122 m_timer.cb = GprsMs::timeout;
Jacob Erlbeck489a2b32015-05-28 19:07:01 +0200123 m_llc_queue.init();
Jacob Erlbecka700dd92015-06-02 16:00:41 +0200124
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100125 set_mode(m_mode);
Jacob Erlbeckd4ad7312015-07-17 16:39:09 +0200126
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100127 if (m_bts)
Jacob Erlbeckd4ad7312015-07-17 16:39:09 +0200128 codel_interval = m_bts->bts_data()->llc_codel_interval_msec;
Jacob Erlbeckd4ad7312015-07-17 16:39:09 +0200129
130 if (codel_interval) {
131 if (codel_interval == LLC_CODEL_USE_DEFAULT)
132 codel_interval = GPRS_CODEL_SLOW_INTERVAL_MS;
133 m_codel_state = talloc(this, struct gprs_codel);
134 gprs_codel_init(m_codel_state);
135 gprs_codel_set_interval(m_codel_state, codel_interval);
Jacob Erlbecka700dd92015-06-02 16:00:41 +0200136 }
Jacob Erlbeck8158ea72015-06-04 17:46:33 +0200137 m_last_cs_not_low = now_msec();
Oliver Smithcfb63212019-09-05 17:13:33 +0200138 app_info_pending = false;
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200139}
140
141GprsMs::~GprsMs()
142{
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200143 LListHead<gprs_rlcmac_tbf> *pos, *tmp;
144
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200145 LOGP(DRLCMAC, LOGL_INFO, "Destroying MS object, TLLI = 0x%08x\n", tlli());
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200146
Jacob Erlbeck23f93a12015-06-30 08:52:54 +0200147 set_reserved_slots(NULL, 0, 0);
148
Jacob Erlbeckd9e10242015-05-28 15:43:53 +0200149 if (osmo_timer_pending(&m_timer))
150 osmo_timer_del(&m_timer);
151
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200152 if (m_ul_tbf) {
153 m_ul_tbf->set_ms(NULL);
154 m_ul_tbf = NULL;
155 }
156
157 if (m_dl_tbf) {
158 m_dl_tbf->set_ms(NULL);
159 m_dl_tbf = NULL;
160 }
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200161
162 llist_for_each_safe(pos, tmp, &m_old_tbfs)
163 pos->entry()->set_ms(NULL);
164
Jacob Erlbeck17214bb2015-06-02 14:06:12 +0200165 m_llc_queue.clear(m_bts);
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200166}
167
168void* GprsMs::operator new(size_t size)
169{
170 static void *tall_ms_ctx = NULL;
171 if (!tall_ms_ctx)
172 tall_ms_ctx = talloc_named_const(tall_pcu_ctx, 0, __PRETTY_FUNCTION__);
173
174 return talloc_size(tall_ms_ctx, size);
175}
176
177void GprsMs::operator delete(void* p)
178{
179 talloc_free(p);
180}
181
Jacob Erlbeckd9e10242015-05-28 15:43:53 +0200182GprsMs *GprsMs::ref()
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200183{
184 m_ref += 1;
Jacob Erlbeckd9e10242015-05-28 15:43:53 +0200185 return this;
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200186}
187
188void GprsMs::unref()
189{
190 OSMO_ASSERT(m_ref >= 0);
191 m_ref -= 1;
192 if (m_ref == 0)
193 update_status();
194}
195
Jacob Erlbeckd9e10242015-05-28 15:43:53 +0200196void GprsMs::start_timer()
197{
198 if (m_delay == 0)
199 return;
200
201 if (!m_timer.data)
202 m_timer.data = ref();
203
204 osmo_timer_schedule(&m_timer, m_delay, 0);
205}
206
207void GprsMs::stop_timer()
208{
209 if (!m_timer.data)
210 return;
211
212 osmo_timer_del(&m_timer);
213 m_timer.data = NULL;
214 unref();
215}
216
Maxa4de02d2019-03-13 16:35:09 +0100217void GprsMs::set_mode(enum mcs_kind mode)
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100218{
219 m_mode = mode;
220
Jacob Erlbeck53bc1862016-01-18 17:23:09 +0100221 if (!m_bts)
222 return;
223
Holger Hans Peter Freyther99db40a2016-03-04 18:19:02 +0100224 switch (m_mode) {
Maxa4de02d2019-03-13 16:35:09 +0100225 case GPRS:
Max8a8e0fb2019-03-25 16:32:50 +0100226 if (!mcs_is_gprs(m_current_cs_ul)) {
Holger Hans Peter Freyther99db40a2016-03-04 18:19:02 +0100227 m_current_cs_ul = GprsCodingScheme::getGprsByNum(
228 m_bts->bts_data()->initial_cs_ul);
229 if (!m_current_cs_ul.isValid())
Maxbea2edb2019-03-06 17:04:59 +0100230 m_current_cs_ul = CS1;
Holger Hans Peter Freyther99db40a2016-03-04 18:19:02 +0100231 }
Max8a8e0fb2019-03-25 16:32:50 +0100232 if (!mcs_is_gprs(m_current_cs_dl)) {
Holger Hans Peter Freyther99db40a2016-03-04 18:19:02 +0100233 m_current_cs_dl = GprsCodingScheme::getGprsByNum(
234 m_bts->bts_data()->initial_cs_dl);
235 if (!m_current_cs_dl.isValid())
Maxbea2edb2019-03-06 17:04:59 +0100236 m_current_cs_dl = CS1;
Holger Hans Peter Freyther99db40a2016-03-04 18:19:02 +0100237 }
238 break;
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100239
Maxa4de02d2019-03-13 16:35:09 +0100240 case EGPRS_GMSK:
241 case EGPRS:
Max8a8e0fb2019-03-25 16:32:50 +0100242 if (!mcs_is_edge(m_current_cs_ul)) {
Holger Hans Peter Freyther99db40a2016-03-04 18:19:02 +0100243 m_current_cs_ul = GprsCodingScheme::getEgprsByNum(
244 m_bts->bts_data()->initial_mcs_ul);
Holger Hans Peter Freytherfd263b02016-03-04 18:24:50 +0100245 if (!m_current_cs_ul.isValid())
Maxbea2edb2019-03-06 17:04:59 +0100246 m_current_cs_ul = MCS1;
Holger Hans Peter Freyther99db40a2016-03-04 18:19:02 +0100247 }
Max8a8e0fb2019-03-25 16:32:50 +0100248 if (!mcs_is_edge(m_current_cs_dl)) {
Holger Hans Peter Freyther99db40a2016-03-04 18:19:02 +0100249 m_current_cs_dl = GprsCodingScheme::getEgprsByNum(
250 m_bts->bts_data()->initial_mcs_dl);
251 if (!m_current_cs_dl.isValid())
Maxbea2edb2019-03-06 17:04:59 +0100252 m_current_cs_dl = MCS1;
Holger Hans Peter Freyther99db40a2016-03-04 18:19:02 +0100253 }
254 break;
255 }
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100256}
257
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200258void GprsMs::attach_tbf(struct gprs_rlcmac_tbf *tbf)
259{
260 if (tbf->direction == GPRS_RLCMAC_DL_TBF)
Jacob Erlbeckaa9daa12015-12-28 18:49:12 +0100261 attach_dl_tbf(as_dl_tbf(tbf));
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200262 else
Jacob Erlbeckaa9daa12015-12-28 18:49:12 +0100263 attach_ul_tbf(as_ul_tbf(tbf));
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200264}
265
266void GprsMs::attach_ul_tbf(struct gprs_rlcmac_ul_tbf *tbf)
267{
268 if (m_ul_tbf == tbf)
269 return;
270
271 LOGP(DRLCMAC, LOGL_INFO, "Attaching TBF to MS object, TLLI = 0x%08x, TBF = %s\n",
272 tlli(), tbf->name());
273
274 Guard guard(this);
275
276 if (m_ul_tbf)
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200277 llist_add_tail(&m_ul_tbf->ms_list(), &m_old_tbfs);
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200278
279 m_ul_tbf = tbf;
Jacob Erlbeckd9e10242015-05-28 15:43:53 +0200280
281 if (tbf)
282 stop_timer();
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200283}
284
285void GprsMs::attach_dl_tbf(struct gprs_rlcmac_dl_tbf *tbf)
286{
287 if (m_dl_tbf == tbf)
288 return;
289
290 LOGP(DRLCMAC, LOGL_INFO, "Attaching TBF to MS object, TLLI = 0x%08x, TBF = %s\n",
291 tlli(), tbf->name());
292
293 Guard guard(this);
294
295 if (m_dl_tbf)
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200296 llist_add_tail(&m_dl_tbf->ms_list(), &m_old_tbfs);
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200297
298 m_dl_tbf = tbf;
Jacob Erlbeckd9e10242015-05-28 15:43:53 +0200299
300 if (tbf)
301 stop_timer();
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200302}
303
304void GprsMs::detach_tbf(gprs_rlcmac_tbf *tbf)
305{
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200306 if (tbf == static_cast<gprs_rlcmac_tbf *>(m_ul_tbf)) {
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200307 m_ul_tbf = NULL;
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200308 } else if (tbf == static_cast<gprs_rlcmac_tbf *>(m_dl_tbf)) {
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200309 m_dl_tbf = NULL;
Jacob Erlbeck6835cea2015-08-21 15:24:02 +0200310 } else {
311 bool found = false;
312
313 LListHead<gprs_rlcmac_tbf> *pos, *tmp;
314 llist_for_each_safe(pos, tmp, &m_old_tbfs) {
315 if (pos->entry() == tbf) {
316 llist_del(pos);
317 found = true;
318 break;
319 }
320 }
321
322 /* Protect against recursive calls via set_ms() */
323 if (!found)
324 return;
325 }
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200326
327 LOGP(DRLCMAC, LOGL_INFO, "Detaching TBF from MS object, TLLI = 0x%08x, TBF = %s\n",
328 tlli(), tbf->name());
329
Jacob Erlbeckfecece02015-05-08 12:13:08 +0200330 if (tbf->ms() == this)
331 tbf->set_ms(NULL);
332
Jacob Erlbeck23f93a12015-06-30 08:52:54 +0200333 if (!m_dl_tbf && !m_ul_tbf) {
334 set_reserved_slots(NULL, 0, 0);
335
336 if (tlli() != 0)
337 start_timer();
338 }
Jacob Erlbeckd9e10242015-05-28 15:43:53 +0200339
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200340 update_status();
341}
342
343void GprsMs::update_status()
344{
345 if (m_ref > 0)
346 return;
347
348 if (is_idle() && !m_is_idle) {
349 m_is_idle = true;
350 m_cb->ms_idle(this);
351 /* this can be deleted by now, do not access it */
352 return;
353 }
354
355 if (!is_idle() && m_is_idle) {
356 m_is_idle = false;
357 m_cb->ms_active(this);
358 }
359}
360
Jacob Erlbeckac289052015-08-14 12:50:54 +0200361void GprsMs::reset()
362{
363 LOGP(DRLCMAC, LOGL_INFO,
364 "Clearing MS object, TLLI: 0x%08x, IMSI: '%s'\n",
365 tlli(), imsi());
366
367 stop_timer();
368
369 m_tlli = 0;
370 m_new_dl_tlli = 0;
371 m_new_ul_tlli = 0;
372 m_imsi[0] = '\0';
373}
374
Jacob Erlbeck2b349b52015-08-18 11:55:03 +0200375void GprsMs::merge_old_ms(GprsMs *old_ms)
376{
377 if (old_ms == this)
378 return;
379
380 if (strlen(imsi()) == 0 && strlen(old_ms->imsi()) != 0)
381 set_imsi(old_ms->imsi());
382
383 if (!ms_class() && old_ms->ms_class())
384 set_ms_class(old_ms->ms_class());
385
Jacob Erlbecke0b21f42015-08-21 18:30:05 +0200386 m_llc_queue.move_and_merge(&old_ms->m_llc_queue);
387
Jacob Erlbeck2b349b52015-08-18 11:55:03 +0200388 old_ms->reset();
389}
390
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200391void GprsMs::set_tlli(uint32_t tlli)
392{
Jacob Erlbeck93990462015-05-15 15:50:43 +0200393 if (tlli == m_tlli || tlli == m_new_ul_tlli)
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200394 return;
395
Jacob Erlbeck93990462015-05-15 15:50:43 +0200396 if (tlli != m_new_dl_tlli) {
397 LOGP(DRLCMAC, LOGL_INFO,
398 "Modifying MS object, UL TLLI: 0x%08x -> 0x%08x, "
399 "not yet confirmed\n",
400 this->tlli(), tlli);
401 m_new_ul_tlli = tlli;
402 return;
403 }
404
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200405 LOGP(DRLCMAC, LOGL_INFO,
Jacob Erlbeck93990462015-05-15 15:50:43 +0200406 "Modifying MS object, TLLI: 0x%08x -> 0x%08x, "
407 "already confirmed partly\n",
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200408 m_tlli, tlli);
409
410 m_tlli = tlli;
Jacob Erlbeck93990462015-05-15 15:50:43 +0200411 m_new_dl_tlli = 0;
412 m_new_ul_tlli = 0;
413}
414
415bool GprsMs::confirm_tlli(uint32_t tlli)
416{
417 if (tlli == m_tlli || tlli == m_new_dl_tlli)
418 return false;
419
420 if (tlli != m_new_ul_tlli) {
421 /* The MS has not sent a message with the new TLLI, which may
422 * happen according to the spec [TODO: add reference]. */
423
424 LOGP(DRLCMAC, LOGL_INFO,
425 "The MS object cannot fully confirm an unexpected TLLI: 0x%08x, "
426 "partly confirmed\n", tlli);
427 /* Use the network's idea of TLLI as candidate, this does not
428 * change the result value of tlli() */
429 m_new_dl_tlli = tlli;
430 return false;
431 }
432
433 LOGP(DRLCMAC, LOGL_INFO,
434 "Modifying MS object, TLLI: 0x%08x confirmed\n", tlli);
435
436 m_tlli = tlli;
437 m_new_dl_tlli = 0;
438 m_new_ul_tlli = 0;
439
440 return true;
Jacob Erlbecke04e0b02015-05-06 18:30:48 +0200441}
Jacob Erlbeckb0e5eaf2015-05-21 11:07:16 +0200442
443void GprsMs::set_imsi(const char *imsi)
444{
445 if (!imsi) {
446 LOGP(DRLCMAC, LOGL_ERROR, "Expected IMSI!\n");
447 return;
448 }
449
450 if (imsi[0] && strlen(imsi) < 3) {
451 LOGP(DRLCMAC, LOGL_ERROR, "No valid IMSI '%s'!\n",
452 imsi);
453 return;
454 }
455
456 if (strcmp(imsi, m_imsi) == 0)
457 return;
458
459 LOGP(DRLCMAC, LOGL_INFO,
460 "Modifying MS object, TLLI = 0x%08x, IMSI '%s' -> '%s'\n",
461 tlli(), m_imsi, imsi);
462
463 strncpy(m_imsi, imsi, sizeof(m_imsi));
464 m_imsi[sizeof(m_imsi) - 1] = '\0';
465}
466
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200467void GprsMs::set_ta(uint8_t ta_)
468{
469 if (ta_ == m_ta)
470 return;
471
Max9bbe1602016-07-18 12:50:18 +0200472 if (gsm48_ta_is_valid(ta_)) {
473 LOGP(DRLCMAC, LOGL_INFO,
474 "Modifying MS object, TLLI = 0x%08x, TA %d -> %d\n",
475 tlli(), m_ta, ta_);
476 m_ta = ta_;
477 } else
478 LOGP(DRLCMAC, LOGL_NOTICE,
479 "MS object, TLLI = 0x%08x, invalid TA %d rejected (old "
480 "value %d kept)\n", tlli(), ta_, m_ta);
Jacob Erlbeck9200ce62015-05-22 17:48:04 +0200481}
482
Jacob Erlbeckbefc7602015-06-02 12:33:30 +0200483void GprsMs::set_ms_class(uint8_t ms_class_)
484{
485 if (ms_class_ == m_ms_class)
486 return;
487
488 LOGP(DRLCMAC, LOGL_INFO,
489 "Modifying MS object, TLLI = 0x%08x, MS class %d -> %d\n",
490 tlli(), m_ms_class, ms_class_);
491
492 m_ms_class = ms_class_;
493}
494
Jacob Erlbeckc3c58042015-09-28 17:55:32 +0200495void GprsMs::set_egprs_ms_class(uint8_t ms_class_)
496{
497 if (ms_class_ == m_egprs_ms_class)
498 return;
499
500 LOGP(DRLCMAC, LOGL_INFO,
501 "Modifying MS object, TLLI = 0x%08x, EGPRS MS class %d -> %d\n",
502 tlli(), m_egprs_ms_class, ms_class_);
503
504 m_egprs_ms_class = ms_class_;
505}
506
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200507void GprsMs::update_error_rate(gprs_rlcmac_tbf *tbf, int error_rate)
508{
509 struct gprs_rlcmac_bts *bts_data;
Jacob Erlbeck8158ea72015-06-04 17:46:33 +0200510 int64_t now;
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100511 GprsCodingScheme max_cs_dl = this->max_cs_dl();
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200512
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100513 OSMO_ASSERT(max_cs_dl);
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200514 bts_data = m_bts->bts_data();
515
516 if (error_rate < 0)
517 return;
518
Jacob Erlbeck8158ea72015-06-04 17:46:33 +0200519 now = now_msec();
520
Jacob Erlbeck94cde132015-06-09 09:44:36 +0200521 /* TODO: Check for TBF direction */
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200522 /* TODO: Support different CS values for UL and DL */
523
Jacob Erlbeck04a10862015-06-12 16:01:56 +0200524 m_nack_rate_dl = error_rate;
525
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200526 if (error_rate > bts_data->cs_adj_upper_limit) {
Max898dddb2019-03-12 15:50:57 +0100527 if (mcs_chan_code(m_current_cs_dl) > 0) {
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100528 m_current_cs_dl.dec(mode());
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200529 LOGP(DRLCMACDL, LOGL_INFO,
530 "MS (IMSI %s): High error rate %d%%, "
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100531 "reducing CS level to %s\n",
Max136ebcc2019-03-05 14:59:03 +0100532 imsi(), error_rate, mcs_name(m_current_cs_dl));
Jacob Erlbeck8158ea72015-06-04 17:46:33 +0200533 m_last_cs_not_low = now;
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200534 }
535 } else if (error_rate < bts_data->cs_adj_lower_limit) {
Jacob Erlbeckb33e6752015-06-04 19:04:30 +0200536 if (m_current_cs_dl < max_cs_dl) {
Jacob Erlbeck8158ea72015-06-04 17:46:33 +0200537 if (now - m_last_cs_not_low > 1000) {
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100538 m_current_cs_dl.inc(mode());
Jacob Erlbeckb33e6752015-06-04 19:04:30 +0200539
Jacob Erlbeck8158ea72015-06-04 17:46:33 +0200540 LOGP(DRLCMACDL, LOGL_INFO,
541 "MS (IMSI %s): Low error rate %d%%, "
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100542 "increasing DL CS level to %s\n",
543 imsi(), error_rate,
Max136ebcc2019-03-05 14:59:03 +0100544 mcs_name(m_current_cs_dl));
Jacob Erlbeck8158ea72015-06-04 17:46:33 +0200545 m_last_cs_not_low = now;
546 } else {
547 LOGP(DRLCMACDL, LOGL_DEBUG,
548 "MS (IMSI %s): Low error rate %d%%, "
549 "ignored (within blocking period)\n",
550 imsi(), error_rate);
551 }
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200552 }
553 } else {
554 LOGP(DRLCMACDL, LOGL_DEBUG,
555 "MS (IMSI %s): Medium error rate %d%%, ignored\n",
556 imsi(), error_rate);
Jacob Erlbeck8158ea72015-06-04 17:46:33 +0200557 m_last_cs_not_low = now;
Jacob Erlbeck1751c622015-06-04 12:12:32 +0200558 }
559}
Jacob Erlbecke4bcb622015-06-08 11:26:38 +0200560
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100561GprsCodingScheme GprsMs::max_cs_ul() const
Jacob Erlbecke4bcb622015-06-08 11:26:38 +0200562{
Jacob Erlbeck94cde132015-06-09 09:44:36 +0200563 struct gprs_rlcmac_bts *bts_data;
Jacob Erlbeck94cde132015-06-09 09:44:36 +0200564
565 OSMO_ASSERT(m_bts != NULL);
566 bts_data = m_bts->bts_data();
567
Max8a8e0fb2019-03-25 16:32:50 +0100568 if (mcs_is_gprs(m_current_cs_ul)) {
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100569 if (!bts_data->max_cs_ul)
Maxbea2edb2019-03-06 17:04:59 +0100570 return GprsCodingScheme(CS4);
Jacob Erlbeck94cde132015-06-09 09:44:36 +0200571
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100572 return GprsCodingScheme::getGprsByNum(bts_data->max_cs_ul);
Jacob Erlbeck94cde132015-06-09 09:44:36 +0200573 }
574
Max8a8e0fb2019-03-25 16:32:50 +0100575 if (!mcs_is_edge(m_current_cs_ul))
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100576 return GprsCodingScheme(); /* UNKNOWN */
577
578 if (bts_data->max_mcs_ul)
579 return GprsCodingScheme::getEgprsByNum(bts_data->max_mcs_ul);
580 else if (bts_data->max_cs_ul)
581 return GprsCodingScheme::getEgprsByNum(bts_data->max_cs_ul);
582
Maxbea2edb2019-03-06 17:04:59 +0100583 return GprsCodingScheme(MCS4);
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100584}
585
Maxbea2edb2019-03-06 17:04:59 +0100586void GprsMs::set_current_cs_dl(CodingScheme scheme)
Aravind Sirsikare8ccafc2016-07-13 11:37:47 +0530587{
588 m_current_cs_dl = scheme;
589}
590
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100591GprsCodingScheme GprsMs::max_cs_dl() const
592{
593 struct gprs_rlcmac_bts *bts_data;
594
595 OSMO_ASSERT(m_bts != NULL);
596 bts_data = m_bts->bts_data();
597
Max8a8e0fb2019-03-25 16:32:50 +0100598 if (mcs_is_gprs(m_current_cs_dl)) {
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100599 if (!bts_data->max_cs_dl)
Maxbea2edb2019-03-06 17:04:59 +0100600 return GprsCodingScheme(CS4);
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100601
602 return GprsCodingScheme::getGprsByNum(bts_data->max_cs_dl);
603 }
604
Max8a8e0fb2019-03-25 16:32:50 +0100605 if (!mcs_is_edge(m_current_cs_dl))
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100606 return GprsCodingScheme(); /* UNKNOWN */
607
608 if (bts_data->max_mcs_dl)
609 return GprsCodingScheme::getEgprsByNum(bts_data->max_mcs_dl);
610 else if (bts_data->max_cs_dl)
611 return GprsCodingScheme::getEgprsByNum(bts_data->max_cs_dl);
612
Maxbea2edb2019-03-06 17:04:59 +0100613 return GprsCodingScheme(MCS4);
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100614}
615
616void GprsMs::update_cs_ul(const pcu_l1_meas *meas)
617{
618 struct gprs_rlcmac_bts *bts_data;
619 GprsCodingScheme max_cs_ul = this->max_cs_ul();
620
621 int old_link_qual;
622 int low;
623 int high;
624 GprsCodingScheme new_cs_ul = m_current_cs_ul;
Max898dddb2019-03-12 15:50:57 +0100625 uint8_t current_cs = mcs_chan_code(m_current_cs_ul);
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100626
627 bts_data = m_bts->bts_data();
628
629 if (!max_cs_ul) {
Minh-Quang Nguyen1f189092017-08-16 09:50:06 -0400630 LOGP(DRLCMACMEAS, LOGL_ERROR,
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100631 "max_cs_ul cannot be derived (current UL CS: %s)\n",
Max136ebcc2019-03-05 14:59:03 +0100632 mcs_name(m_current_cs_ul));
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100633 return;
634 }
635
Maxfa3085b2019-03-07 11:46:43 +0100636 if (!m_current_cs_ul) {
637 LOGP(DRLCMACMEAS, LOGL_ERROR,
638 "Unable to update UL (M)CS because it's not set: %s\n",
Max136ebcc2019-03-05 14:59:03 +0100639 mcs_name(m_current_cs_ul));
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100640 return;
Maxfa3085b2019-03-07 11:46:43 +0100641 }
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100642
Maxfa3085b2019-03-07 11:46:43 +0100643 if (!meas->have_link_qual) {
644 LOGP(DRLCMACMEAS, LOGL_ERROR,
645 "Unable to update UL (M)CS %s because we don't have link quality measurements.\n",
Max136ebcc2019-03-05 14:59:03 +0100646 mcs_name(m_current_cs_ul));
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100647 return;
Maxfa3085b2019-03-07 11:46:43 +0100648 }
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100649
650 old_link_qual = meas->link_qual;
651
Max8a8e0fb2019-03-25 16:32:50 +0100652 if (mcs_is_gprs(m_current_cs_ul)) {
Max898dddb2019-03-12 15:50:57 +0100653 if (current_cs >= MAX_GPRS_CS)
654 current_cs = MAX_GPRS_CS - 1;
655 low = bts_data->cs_lqual_ranges[current_cs].low;
656 high = bts_data->cs_lqual_ranges[current_cs].high;
Max8a8e0fb2019-03-25 16:32:50 +0100657 } else if (mcs_is_edge(m_current_cs_ul)) {
Max898dddb2019-03-12 15:50:57 +0100658 if (current_cs >= MAX_EDGE_MCS)
659 current_cs = MAX_EDGE_MCS - 1;
660 low = bts_data->mcs_lqual_ranges[current_cs].low;
661 high = bts_data->mcs_lqual_ranges[current_cs].high;
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100662 } else {
Maxfa3085b2019-03-07 11:46:43 +0100663 LOGP(DRLCMACMEAS, LOGL_ERROR,
664 "Unable to update UL (M)CS because it's neither GPRS nor EDGE: %s\n",
Max136ebcc2019-03-05 14:59:03 +0100665 mcs_name(m_current_cs_ul));
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100666 return;
667 }
668
669 if (m_l1_meas.have_link_qual)
670 old_link_qual = m_l1_meas.link_qual;
671
672 if (meas->link_qual < low && old_link_qual < low)
673 new_cs_ul.dec(mode());
674 else if (meas->link_qual > high && old_link_qual > high &&
675 m_current_cs_ul < max_cs_ul)
676 new_cs_ul.inc(mode());
677
678 if (m_current_cs_ul != new_cs_ul) {
Minh-Quang Nguyen1f189092017-08-16 09:50:06 -0400679 LOGP(DRLCMACMEAS, LOGL_INFO,
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100680 "MS (IMSI %s): "
681 "Link quality %ddB (%ddB) left window [%d, %d], "
682 "modifying uplink CS level: %s -> %s\n",
683 imsi(), meas->link_qual, old_link_qual,
684 low, high,
Max136ebcc2019-03-05 14:59:03 +0100685 mcs_name(m_current_cs_ul), mcs_name(new_cs_ul));
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100686
687 m_current_cs_ul = new_cs_ul;
688 }
689}
690
691void GprsMs::update_l1_meas(const pcu_l1_meas *meas)
692{
693 unsigned i;
694
695 update_cs_ul(meas);
696
Jacob Erlbecke4bcb622015-06-08 11:26:38 +0200697 if (meas->have_rssi)
698 m_l1_meas.set_rssi(meas->rssi);
699 if (meas->have_bto)
700 m_l1_meas.set_bto(meas->bto);
701 if (meas->have_ber)
702 m_l1_meas.set_ber(meas->ber);
703 if (meas->have_link_qual)
704 m_l1_meas.set_link_qual(meas->link_qual);
Jacob Erlbeck51b11512015-06-11 16:54:50 +0200705
706 if (meas->have_ms_rx_qual)
707 m_l1_meas.set_ms_rx_qual(meas->ms_rx_qual);
708 if (meas->have_ms_c_value)
709 m_l1_meas.set_ms_c_value(meas->ms_c_value);
710 if (meas->have_ms_sign_var)
711 m_l1_meas.set_ms_sign_var(meas->ms_sign_var);
712
713 if (meas->have_ms_i_level) {
714 for (i = 0; i < ARRAY_SIZE(meas->ts); ++i) {
715 if (meas->ts[i].have_ms_i_level)
716 m_l1_meas.set_ms_i_level(i, meas->ts[i].ms_i_level);
717 else
718 m_l1_meas.ts[i].have_ms_i_level = 0;
719 }
720 }
Jacob Erlbecke4bcb622015-06-08 11:26:38 +0200721}
Jacob Erlbeck70b96aa2015-06-12 10:52:34 +0200722
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100723GprsCodingScheme GprsMs::current_cs_dl() const
Jacob Erlbeck70b96aa2015-06-12 10:52:34 +0200724{
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100725 GprsCodingScheme cs = m_current_cs_dl;
Jacob Erlbeck70b96aa2015-06-12 10:52:34 +0200726 size_t unencoded_octets;
727
728 if (!m_bts)
729 return cs;
730
731 unencoded_octets = m_llc_queue.octets();
732
733 /* If the DL TBF is active, add number of unencoded chunk octets */
734 if (m_dl_tbf)
Jacob Erlbeck14e26cb2016-02-03 15:26:29 +0100735 unencoded_octets += m_dl_tbf->m_llc.chunk_size();
Jacob Erlbeck70b96aa2015-06-12 10:52:34 +0200736
737 /* There are many unencoded octets, don't reduce */
738 if (unencoded_octets >= m_bts->bts_data()->cs_downgrade_threshold)
739 return cs;
740
741 /* RF conditions are good, don't reduce */
742 if (m_nack_rate_dl < m_bts->bts_data()->cs_adj_lower_limit)
743 return cs;
744
745 /* The throughput would probably be better if the CS level was reduced */
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100746 cs.dec(mode());
Jacob Erlbeck70b96aa2015-06-12 10:52:34 +0200747
748 /* CS-2 doesn't gain throughput with small packets, further reduce to CS-1 */
Maxbea2edb2019-03-06 17:04:59 +0100749 if (cs == GprsCodingScheme(CS2))
Jacob Erlbeckcb728902016-01-05 15:33:03 +0100750 cs.dec(mode());
Jacob Erlbeck70b96aa2015-06-12 10:52:34 +0200751
752 return cs;
753}
754
Jacob Erlbeck699b8dc2015-06-29 14:05:55 +0200755int GprsMs::first_common_ts() const
756{
757 if (m_dl_tbf)
758 return m_dl_tbf->first_common_ts;
759
760 if (m_ul_tbf)
761 return m_ul_tbf->first_common_ts;
762
763 return -1;
764}
765
Jacob Erlbeck617c7122015-06-30 09:18:30 +0200766uint8_t GprsMs::dl_slots() const
767{
768 uint8_t slots = 0;
769
770 if (m_dl_tbf)
771 slots |= m_dl_tbf->dl_slots();
772
773 if (m_ul_tbf)
774 slots |= m_ul_tbf->dl_slots();
775
776 return slots;
777}
778
779uint8_t GprsMs::ul_slots() const
780{
781 uint8_t slots = 0;
782
783 if (m_dl_tbf)
784 slots |= m_dl_tbf->ul_slots();
785
786 if (m_ul_tbf)
787 slots |= m_ul_tbf->ul_slots();
788
789 return slots;
790}
791
Jacob Erlbeck7c72aca2016-01-22 17:06:14 +0100792uint8_t GprsMs::current_pacch_slots() const
793{
794 uint8_t slots = 0;
795
796 bool is_dl_active = m_dl_tbf && m_dl_tbf->is_tfi_assigned();
797 bool is_ul_active = m_ul_tbf && m_ul_tbf->is_tfi_assigned();
798
799 if (!is_dl_active && !is_ul_active)
800 return 0;
801
802 /* see TS 44.060, 8.1.1.2.2 */
803 if (is_dl_active && !is_ul_active)
804 slots = m_dl_tbf->dl_slots();
805 else if (!is_dl_active && is_ul_active)
806 slots = m_ul_tbf->ul_slots();
807 else
808 slots = m_ul_tbf->ul_slots() & m_dl_tbf->dl_slots();
809
810 /* Assume a multislot class 1 device */
811 /* TODO: For class 2 devices, this could be removed */
812 slots = pcu_lsb(slots);
813
814 return slots;
815}
816
Jacob Erlbeck23f93a12015-06-30 08:52:54 +0200817void GprsMs::set_reserved_slots(gprs_rlcmac_trx *trx,
818 uint8_t ul_slots, uint8_t dl_slots)
819{
820 if (m_current_trx) {
821 m_current_trx->unreserve_slots(GPRS_RLCMAC_DL_TBF,
822 m_reserved_dl_slots);
823 m_current_trx->unreserve_slots(GPRS_RLCMAC_UL_TBF,
824 m_reserved_ul_slots);
825 m_reserved_dl_slots = 0;
826 m_reserved_ul_slots = 0;
827 }
828 m_current_trx = trx;
829 if (trx) {
830 m_reserved_dl_slots = dl_slots;
831 m_reserved_ul_slots = ul_slots;
832 m_current_trx->reserve_slots(GPRS_RLCMAC_DL_TBF,
833 m_reserved_dl_slots);
834 m_current_trx->reserve_slots(GPRS_RLCMAC_UL_TBF,
835 m_reserved_ul_slots);
836 }
837}
838
Jacob Erlbeckac89a552015-06-29 14:18:46 +0200839gprs_rlcmac_tbf *GprsMs::tbf(enum gprs_rlcmac_tbf_direction dir) const
840{
841 switch (dir) {
842 case GPRS_RLCMAC_DL_TBF: return m_dl_tbf;
843 case GPRS_RLCMAC_UL_TBF: return m_ul_tbf;
844 }
845
846 return NULL;
847}